Difference between revisions of "Component: Level (DSP Outputs)"

Latest revision as of 10:26, 20 October 2023

Author	Matrix Ltd
Version	1.2
Category	DSP Outputs

Level component

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

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DSP_Level.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Level.fcfx

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.

Macro reference

ReadAverage

	ReadAverage
Returns the average from the last "Decay" number of index locations.
- LONG	Return

ReadAverageArray

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

ReadPeak

	ReadPeak
Returns the highest value from the last "Decay" number of index locations.
- LONG	Return

ReadPeakArray

	ReadPeakArray
Returns the highest value from the last "Decay" number of buffers.
- UINT	Return

ReadTrough

	ReadTrough
Returns the lowest value from the last "Decay" number of index locations.
- LONG	Return

ReadTroughArray

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

ResetRecords

	ResetRecords
Allows the peak and trough to be reset back to default values.
- BOOL	ResetPeak

- BOOL	ResetTrough

- 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

@@ Line 91: / Line 91: @@
 Average: Rolling average calculated from the values inside the buffer.
@@ Line 98: / Line 108: @@
 ==Macro reference==
-===ReadTroughArray===
+===ReadAverage===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTroughArray'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverage'''
 |-
-| colspan="2" | Returns the lowest value from the last "Decay" number of buffers.&nbsp;
+| colspan="2" | Returns the average from the last "Decay" number of index locations.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ReadTrough===
+===ReadAverageArray===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTrough'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverageArray'''
 |-
-| colspan="2" | Returns the lowest value from the last "Decay" number of index locations.&nbsp;
+| colspan="2" | Returns the average from the last "Decay" number of buffers.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ReadAverage===
+===ReadPeak===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverage'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPeak'''
 |-
-| colspan="2" | Returns the average from the last "Decay" number of index locations.&nbsp;
+| colspan="2" | Returns the highest value from the last "Decay" number of index locations.&nbsp;
 |-
 |-
@@ Line 154: / Line 164: @@
-===ReadAverageArray===
+===ReadTrough===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverageArray'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTrough'''
 |-
-| colspan="2" | Returns the average from the last "Decay" number of buffers.&nbsp;
+| colspan="2" | Returns the lowest value from the last "Decay" number of index locations.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ReadPeak===
+===ReadTroughArray===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPeak'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTroughArray'''
 |-
-| colspan="2" | Returns the highest value from the last "Decay" number of index locations.&nbsp;
+| colspan="2" | Returns the lowest value from the last "Decay" number of buffers.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 204: / Line 214: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}

Difference between revisions of "Component: Level (DSP Outputs)"

Latest revision as of 10:26, 20 October 2023

Contents