Component: Offset (DSP)

Author	Matrix Ltd
Version	1.1
Category	DSP

Offset component

Allows the values in a single buffer to be offset uniformly. Functions include: Add, Subtract

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	Calculate
Performs the selected offset on a value from the input buffer and passes to the output buffer.
- VOID	Return

	CalculateArray
Performs the selected offset on an entire buffer.
- VOID	Return

	SetOffset
Sets the Offset to be used when calling the calculate function.
[[File:]] -	Offset
- VOID	Return

	ResetRecords
Allows the peak and trough to be reset back to default values.
[[File:]] -	ResetPeak
[[File:]] -	ResetTrough
- VOID	Return

	ReceiveString
Gets a string from the receive buffer
- UINT	MaxChars
- UINT	Timeout
Time in milliseconds to wait for data
- STRING	Return

	Initialise
Initialises the UART component pins ready to send and receive data
- VOID	Return

	ReceiveString
Receives a string of bytes and returns the number of bytes received.
- STRING	StringData
- UINT	NumBytes
Maximum number of bytes to try and receive
- UINT	Timeout
Max amount of time in ms to wait between bytes
- BYTE	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

	SetLEDState
Sets the state of a single LED
- BYTE	Port
0 = PortA, 1 = PortB
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
- VOID	Return

	GetRxIdent
Gets the Rx ID as a Integer Standard and Extended IDs.
- BYTE	Buffer
- ULONG	Return

	Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
- VOID	Return

Property reference

	Properties
	Connect To
DSP component with output buffer to collect our data from.
	Buffer Size
Number of individual elements the buffer can store, default 1.
	Buffer Type
Sets the buffer data type.
	Offset Type
Defines the type of calculation performed on the input buffer to obtain the output value. A left shift is essentially an optimised multiply with the multiplier being the 2^scaler A right shift is essentially an optimised divide with the divider being the 2^scaler
	Rollover
Allow the output buffer to rollover. For example 128 + 128 = 256 which would equate to 0 using an 8-bit buffer with rollover enabled. With rollover disabled the output would be set to 255 which is the max representable value.
	Initial Offset
	Connections
	Simulations