Jump to content

Component: Sensor Library Component (Misc): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,425 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(17 intermediate revisions by 2 users 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.


==Component Source Code==
==Detailed description==
 
 
 
 
 
 
 
 
 
 


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_SensorComponent.fcfx FC_Comp_Source_SensorComponent.fcfx]


==Detailed description==




Line 38: Line 46:


==Examples==
==Examples==




Line 55: Line 75:
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===FlashRx===
{| 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;" | '''GetValue'''
| width="90%" class="mtx-class-macrohead" | '''FlashRx'''
|-
|-
| colspan="2" | Gets the value of one of the Sliders / Text fields.&nbsp;
| colspan="2" | Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" | Index
|-
| colspan="2" | Range: 0 to (Value Count - 1)&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===FlashTx===
{| 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;" | '''FlashRx'''
| width="90%" class="mtx-class-macrohead" | '''FlashTx'''
|-
|-
| colspan="2" | Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
| colspan="2" | Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
|-
|-
|-
|-
Line 88: Line 117:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetLinkHandle===
{| 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;" | '''FlashTx'''
| width="90%" class="mtx-class-macrohead" | '''GetLinkHandle'''
|-
|-
| colspan="2" | Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
| colspan="2" | Gets the handle of the source object we are pointing to. Returns 0 for not valid.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
|-
| colspan="2" | 0=Source, 1=Reference&nbsp;
|-
|-
| 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-h32-icon.png]] - HANDLE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetValue===
{| 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;" | '''SetValue'''
| width="90%" class="mtx-class-macrohead" | '''GetValue'''
|-
|-
| colspan="2" | Sets the value of one of the Sliders / Text fields.&nbsp;
| colspan="2" | Gets the value of one of the Sliders / Text fields.&nbsp;
|-
|-
|-
|-
Line 114: Line 150:
| colspan="2" | Range: 0 to (Value Count - 1)&nbsp;
| colspan="2" | Range: 0 to (Value Count - 1)&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===SetConsoleHandle===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetConsoleHandle'''
|-
| colspan="2" | Sets the link to the component console allowing for click through and for  panel console viewer linkage.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Handle
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 124: Line 174:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetLinkHandle===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetLinkHandle'''
|-
| colspan="2" | Sets the handle of the source object we are pointing to. &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetConsoleHandle'''
|-
|-
| colspan="2" | Sets the link to the component console allowing for click through and for  panel console viewer linkage.&nbsp;
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
|-
| colspan="2" | 0=Source, 1=Reference&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
Line 142: Line 198:




===SetValue===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetValue'''
|-
| colspan="2" | Sets the value of one of the Sliders / Text fields.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Range: 0 to (Value Count - 1)&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| 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==
==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'''  
|-
|-
|-
|-
Line 155: Line 233:
| width="90%" | Title
| width="90%" | Title
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Component main title, shown in the middle of the library component.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Name
|-
| colspan="2" | Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Peripheral
| width="90%" | Peripheral
|-
|-
| colspan="2" | Text to display&nbsp;
| colspan="2" | Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
Line 166: Line 249:
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Source Icon
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Line 171: Line 258:
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Reference Icon
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Output Icon
| width="90%" | Output Icon
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | LinkTo
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 187: Line 283:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Value 0
| width="90%" class="mtx-class-propfolder" | Value 0
|-
|-
|-
|-
Line 216: Line 312:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|}
|}
==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 14:37, 13 July 2026

Author MatrixTSL
Version 1.0
Category Misc


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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Sensor_Library_Component_(Misc)&oldid=48405"