Jump to content

Component: Level (DSP Outputs): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,425 edits
No edit summary
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(4 intermediate revisions by 2 users not shown)
Line 91: Line 91:


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




Line 107: Line 109:


===ReadAverage===
===ReadAverage===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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" | '''ReadAverage'''
|-
|-
| colspan="2" | Returns the average from the last "Decay" number of index locations. 
| colspan="2" | Returns the average from the last "Decay" number of index locations. 
Line 121: Line 123:


===ReadAverageArray===
===ReadAverageArray===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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" | '''ReadAverageArray'''
|-
|-
| colspan="2" | Returns the average from the last "Decay" number of buffers. 
| colspan="2" | Returns the average from the last "Decay" number of buffers. 
Line 135: Line 137:


===ReadPeak===
===ReadPeak===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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" | '''ReadPeak'''
|-
|-
| colspan="2" | Returns the highest value from the last "Decay" number of index locations. 
| colspan="2" | Returns the highest value from the last "Decay" number of index locations. 
Line 149: Line 151:


===ReadPeakArray===
===ReadPeakArray===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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. 
| colspan="2" | Returns the highest value from the last "Decay" number of buffers. 
Line 163: Line 165:


===ReadTrough===
===ReadTrough===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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" | '''ReadTrough'''
|-
|-
| colspan="2" | Returns the lowest value from the last "Decay" number of index locations. 
| colspan="2" | Returns the lowest value from the last "Decay" number of index locations. 
Line 177: Line 179:


===ReadTroughArray===
===ReadTroughArray===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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" | '''ReadTroughArray'''
|-
|-
| colspan="2" | Returns the lowest value from the last "Decay" number of buffers. 
| colspan="2" | Returns the lowest value from the last "Decay" number of buffers. 
Line 191: Line 193:


===ResetRecords===
===ResetRecords===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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. 
| colspan="2" | Allows the peak and trough to be reset back to default values. 
Line 216: Line 218:
==Property reference==
==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'''  
|-
|-
|-
|-

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 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Level_(DSP_Outputs)&oldid=46253"