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

Latest revision as of 08:48, 21 June 2024

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

@@ 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.
-==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 40: / Line 46: @@
 ==Examples==
@@ Line 59: / Line 75: @@
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable 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;" | '''GetValue'''
-|-
-| colspan="2" | Gets 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" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
+==Macro reference==
+===FlashRx===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 92: / Line 103: @@
+===FlashTx===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 105: / Line 117: @@
+===GetLinkHandle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 123: / Line 136: @@
+===GetValue===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 136: / Line 150: @@
 | 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="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;" | '''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;
@@ Line 146: / Line 174: @@
+===SetLinkHandle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 169: / Line 198: @@
+===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;" | '''SetConsoleHandle'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
+|-
+| colspan="2" | Sets the value of one of the Sliders / Text fields.&nbsp;
+|-
 |-
-| 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" | Range: 0 to (Value Count - 1)&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | Handle
+| width="90%" | Value
 |-
 | colspan="2" | &nbsp;
@@ Line 185: / Line 220: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 200: / Line 233: @@
 | 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="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]]
@@ Line 274: / Line 312: @@
 | 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]

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

Latest revision as of 08:48, 21 June 2024

Contents