Difference between revisions of "Component: Sensor Library Component (Misc)"
From Flowcode Help
Jump to navigationJump to search| (12 intermediate revisions by the same user not shown) | |||
| Line 15: | Line 15: | ||
A simple library component designed to create a panel presence for any components that have a numerical value and associated slider, for example a sensor. Compatible with linking icons. | A simple library component designed to create a panel presence for any components that have a numerical value and associated slider, for example a sensor. Compatible with linking icons. | ||
| − | == | + | ==Detailed description== |
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| − | |||
| − | |||
| Line 36: | Line 46: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 51: | Line 75: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===FlashRx=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FlashRx''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up. |
|- | |- | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===FlashTx=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FlashTx''' |
|- | |- | ||
| − | | colspan="2" | Flashes the | + | | colspan="2" | Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up. |
|- | |- | ||
|- | |- | ||
| Line 84: | Line 117: | ||
| + | ===GetLinkHandle=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLinkHandle''' |
| + | |- | ||
| + | | colspan="2" | Gets the handle of the source object we are pointing to. Returns 0 for not valid. | ||
| + | |- | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| + | | width="90%" | Index | ||
|- | |- | ||
| + | | colspan="2" | 0=Source, 1=Reference | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===GetValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Gets the value of one of the Sliders / Text fields. |
|- | |- | ||
|- | |- | ||
| Line 110: | Line 150: | ||
| colspan="2" | Range: 0 to (Value Count - 1) | | colspan="2" | Range: 0 to (Value Count - 1) | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===SetConsoleHandle=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 138: | Line 174: | ||
| − | + | ===SetLinkHandle=== | |
| − | |||
| − | == | ||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| − | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9- | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLinkHandle''' |
|- | |- | ||
| + | | colspan="2" | Sets the handle of the source object we are pointing to. | ||
|- | |- | ||
| − | |||
| − | |||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| + | | width="90%" | Index | ||
|- | |- | ||
| − | | | + | | colspan="2" | 0=Source, 1=Reference |
| − | |||
|- | |- | ||
| − | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| − | + | | width="90%" | Handle | |
| − | | width="10%" align="center" | [[File:Fc9- | ||
| − | | width="90%" | | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID |
| − | | width="90%" | | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' |
| + | |} | ||
| + | |||
| + | |||
| + | ===SetValue=== | ||
| + | {| 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;" | '''SetValue''' | ||
|- | |- | ||
| − | | | + | | colspan="2" | Sets the value of one of the Sliders / Text fields. |
| − | |||
|- | |- | ||
| − | |||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| − | | width="90%" | | + | | width="90%" | Index |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Range: 0 to (Value Count - 1) |
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| − | | width="90%" | | + | | width="90%" | Value |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID |
| − | | width="90%" | | + | | 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-11-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | ||
| − | | width="90%" | | + | | width="90%" | Title |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Component main title, shown in the middle of the library component. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | ||
| − | | width="90%" | | + | | width="90%" | Name |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | ||
| − | | width="90%" | | + | | width="90%" | Peripheral |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer. |
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] |
| − | | width="90%" | | + | | width="90%" | Show Comms Indicators |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" | | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Source Icon |
|- | |- | ||
| − | |||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| − | | width="90%" | | + | | width="90%" | Input Icon |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" | | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Reference Icon |
|- | |- | ||
| − | |||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| − | | width="90%" | | + | | width="90%" | Output Icon |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| − | | width="90%" | | + | | width="90%" | LinkTo |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| − | | width="90%" | | + | | width="90%" | Num Decimal Places |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| − | | width="90%" | | + | | width="90%" | Value Count |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" | | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Value 0 |
|- | |- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | ||
| Line 402: | Line 311: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| + | |||
| + | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_SensorComponent.fcfx FC_Comp_Source_SensorComponent.fcfx] | ||
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_SensorComponent.fcfx FC_Comp_Source_SensorComponent.fcfx] | ||
Latest revision as of 08:48, 21 June 2024
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Misc |
Contents
Sensor Library Component component
A simple library component designed to create a panel presence for any components that have a numerical value and associated slider, for example a sensor. Compatible with linking icons.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
FlashRx
|
FlashRx |
| Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up. | |
 - VOID
|
Return |
FlashTx
|
|
FlashTx |
| Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up. | |
| - VOID
|
Return |
GetLinkHandle
|
|
GetLinkHandle |
| Gets the handle of the source object we are pointing to. Returns 0 for not valid. | |
 - BYTE
|
Index |
| 0=Source, 1=Reference | |
 - HANDLE
|
Return |
GetValue
|
|
GetValue |
| Gets the value of one of the Sliders / Text fields. | |
| - BYTE
|
Index |
| Range: 0 to (Value Count - 1) | |
 - FLOAT
|
Return |
SetConsoleHandle
|
|
SetConsoleHandle |
| Sets the link to the component console allowing for click through and for panel console viewer linkage. | |
| - HANDLE
|
Handle |
| - VOID
|
Return |
SetLinkHandle
|
|
SetLinkHandle |
| Sets the handle of the source object we are pointing to. | |
| - BYTE
|
Index |
| 0=Source, 1=Reference | |
| - HANDLE
|
Handle |
| - VOID
|
Return |
SetValue
|
|
SetValue |
| Sets the value of one of the Sliders / Text fields. | |
| - BYTE
|
Index |
| Range: 0 to (Value Count - 1) | |
| - FLOAT
|
Value |
| - VOID
|
Return |
Property reference
|
Properties |
|
Title |
| Component main title, shown in the middle of the library component. | |
|
|
Name |
| Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event. | |
|
|
Peripheral |
| Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer. | |
|
Show Comms Indicators |
|
Source Icon |
|
Input Icon |
|
|
Reference Icon |
|
|
Output Icon |
|
|
LinkTo |
|
Num Decimal Places |
|
|
Value Count |
|
|
Value 0 |
|
|
Label |
|
MaxValue |
|
|
MinValue |
|
|
Major Tick |
|
|
Minor Tick |
Component Source Code
Please click here to download the component source project: FC_Comp_Source_SensorComponent.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_SensorComponent.fcfx
