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

	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.
	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