Component: Level (DSP)

Author	Matrix Ltd
Version	1.2
Category	DSP

Level component

Allows for detection and collection of peaks, troughs and averages.

Detailed description

No detailed description exists yet for this component

Examples

Here is a basic example of the Level component. The example collects the max, min and average readings from the buffer and displays them on the LCD display.

Level

The values in the buffer are defined using the InputADC component.

Min: Minimum (smallest) value read from the buffer.

Max: Maximum (largest) value read from the buffer.

Average: Rolling average calculated from the values inside the buffer.

Downloadable macro reference

	ReadTroughArray
Returns the lowest value from the last "Decay" number of buffers.
- UINT	Return

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

	ReadAverage
Returns the average from the last "Decay" number of index locations.
[[File:]] -	Return

	ReadPeakArray
Returns the highest value from the last "Decay" number of buffers.
- UINT	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

	SetLEDState
Sets the state of a single LED
- BYTE	Port
0 = PortA, 1 = PortB
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
- VOID	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.
	Decay on Peak/Trough
Yes - The Peak and Trough value will only be maintained for the decay number of buffers. No - The record Peak and Trough values will be maintained until reset.
	Decay
Configures how many buffers or values to allow a record to persist
	Connections
	Simulations