Component: Level (DSP Outputs): Difference between revisions

Latest revision as of 14:22, 13 July 2026

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 96: / Line 108: @@
 ==Macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadAverage===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTroughArray'''
+| width="90%" class="mtx-class-macrohead" | '''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''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadAverageArray===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTrough'''
+| width="90%" class="mtx-class-macrohead" | '''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''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadPeak===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverage'''
+| width="90%" class="mtx-class-macrohead" | '''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 135: / Line 150: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadPeakArray===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPeakArray'''
+| width="90%" class="mtx-class-macrohead" | '''ReadPeakArray'''
 |-
 | colspan="2" | Returns the highest value from the last "Decay" number of buffers.&nbsp;
@@ Line 148: / Line 164: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadTrough===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverageArray'''
+| width="90%" class="mtx-class-macrohead" | '''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''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadTroughArray===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPeak'''
+| width="90%" class="mtx-class-macrohead" | '''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''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ResetRecords===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ResetRecords'''
+| width="90%" class="mtx-class-macrohead" | '''ResetRecords'''
 |-
 | colspan="2" | Allows the peak and trough to be reset back to default values.&nbsp;
@@ Line 195: / Line 214: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)