Component: Offset (DSP)

Offset component

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

No detailed description exists yet for this component

No additional examples

	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

	ReadAverageArray
Returns the average from the last "Decay" number of buffers.
- UINT	Return

	ReadPeak
Returns the highest value from the last "Decay" number of index locations.
[[File:]] -	Return

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

[[File:]] -	ResetTrough

- VOID	Return

	GetReplyByte
Reads a single byte from the last reply. Each reply contains 4 bytes starting with the command code.
- BYTE	Index
Range: 0-3 / 0=Command, 1=Feedback, 2=Data MSB, 3=Data LSB
- BYTE	Return

	SkipTrack
Jump to the next or previous track
[[File:]] -	Direction
0=Next, 1=Previous
- VOID	Return

	PlayTrack
Plays track from the selected folder. MP3 & Advert folder track numbers should be 4 characters long e.g. 0001 any name.mp3, Other folder track numbers should be 3 characters long e.g. 001 Any name.mp3, Root the Track played in placement order.
- BYTE	Directory
0=Root, 1=Folder "01" - 99=Folder "99", 100=MP3, 101=Advert
- UINT	Track
Track number 1="001.MP3" / "0001.MP3", 100="100.MP3" / "0100.MP3"
- VOID	Return

	Initialise
Sets up the UART and does some housekeeping. Must be called before calling any of the other component macros.
- VOID	Return

	ReadAnalogAsInt
Reads one of the analogue components as an Integer value
- BYTE	Channel
0 = LDR, 1 = POT
[[File:]] -	Return

	RemapCharacter
Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters. The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.
- BYTE	RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1)
- BYTE	SearchCharacter
Character to look for a replace
- BYTE	ReplacementCharacter
New character value to use in place of the search character.
- VOID	Return

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

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

	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