Difference between revisions of "Component: Level (DSP Outputs)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_DSP_Level.fcfx FC_Comp_Source_DSP_Level.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Level.fcfx FC_Comp_Source_DSP_Level.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Level.fcfx FC_Comp_Source_DSP_Level.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 42: | Line 46: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 79: | Line 85: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| 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''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the lowest value from the last "Decay" number of buffers. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTrough''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the lowest value from the last "Decay" number of index locations. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverage''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the average from the last "Decay" number of index locations. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPeakArray''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the highest value from the last "Decay" number of buffers. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAverageArray''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the average from the last "Decay" number of buffers. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPeak''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the highest value from the last "Decay" number of index locations. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ResetRecords''' | ||
| + | |- | ||
| + | | colspan="2" | Allows the peak and trough to be reset back to default values. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | ResetPeak | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | ResetTrough | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Connect To | ||
| + | |- | ||
| + | | colspan="2" | DSP component with output buffer to collect our data from. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Decay on Peak/Trough | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Decay | ||
| + | |- | ||
| + | | colspan="2" | Configures how many buffers or values to allow a record to persist | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:20, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | DSP Outputs |
Contents
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.
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
|
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. | |
 - LONG
|
Return |
|
|
ReadAverage |
| Returns the average from the last "Decay" number of index locations. | |
| - LONG
|
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. | |
| - LONG
|
Return |
|
|
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 | |
==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. | |
| - LONG
|
Return |
|
|
ReadAverage |
| Returns the average from the last "Decay" number of index locations. | |
| - LONG
|
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. | |
| - LONG
|
Return |
|
|
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 | |
==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. | |
| - LONG
|
Return |
|
|
ReadAverage |
| Returns the average from the last "Decay" number of index locations. | |
| - LONG
|
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. | |
| - LONG
|
Return |
|
|
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 | |
