Difference between revisions of "Component: On / Off Indicator (Digital Indicator )"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Indicator.fcsx FC_Comp_Source_Indicator.fcsx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Indicator.fcsx FC_Comp_Source_Indicator.fcsx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Indicator.fcsx FC_Comp_Source_Indicator.fcsx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 44: | Line 46: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 61: | Line 65: | ||
==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;" | '''GetSwitch''' | ||
| + | |- | ||
| + | | colspan="2" | Reads back the status of the indicator | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | 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;" | '''SwitchOn''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the indicator to the On state. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''Switch''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the indicator to the value dictated by the State parameter | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | State | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SwitchOff''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the indicator to the Off state. | ||
| + | |- | ||
| + | |- | ||
| + | | 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%" | Indicator Type | ||
| + | |- | ||
| + | | colspan="2" | Controls the shape of the indicator object on the panel | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Style | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | On Colour | ||
| + | |- | ||
| + | | colspan="2" | Colour of the indicator when switched on | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Auto Off Colour | ||
| + | |- | ||
| + | | colspan="2" | Controls if an off colour is automatically assigned for you. Yes - Generate automatic off colour No - User can set their own off colour | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Off Colour | ||
| + | |- | ||
| + | | colspan="2" | Colour of the indicator when switched off | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Show Label | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | ||
| + | | width="90%" | Text | ||
| + | |- | ||
| + | | colspan="2" | Text to display | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | ||
| + | | width="90%" | Text Colour | ||
| + | |- | ||
| + | | colspan="2" | Specifies the font colour for the item | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | ||
| + | | width="90%" | Background Colour | ||
| + | |- | ||
| + | | colspan="2" | Specifies the background colour value | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-3-icon.png]] | ||
| + | | width="90%" | Font | ||
| + | |- | ||
| + | | colspan="2" | Specifies the font style for the item | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Scale | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Bold | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Placement | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Spacing | ||
| + | |- | ||
| + | | colspan="2" | Distance between the label and the indicator | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:57, 27 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Digital Indicator |
Contents
On / Off Indicator component
A simple component to create an on / off type indicator on the panel.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Indicator.fcsx
Please click here to view the component source code (Beta): FC_Comp_Source_Indicator.fcsx
Detailed description
No detailed description exists yet for this component
Examples
No examples here yet
Macro reference
|
GetSwitch |
| Reads back the status of the indicator | |
 - BOOL
|
Return |
|
|
SwitchOn |
| Sets the indicator to the On state. | |
 - VOID
|
Return |
|
|
Switch |
| Sets the indicator to the value dictated by the State parameter | |
| - BOOL
|
State |
| - VOID
|
Return |
|
|
SwitchOff |
| Sets the indicator to the Off state. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Indicator Type |
| Controls the shape of the indicator object on the panel | |
|
|
Style |
|
On Colour |
| Colour of the indicator when switched on | |
|
Auto Off Colour |
| Controls if an off colour is automatically assigned for you. Yes - Generate automatic off colour No - User can set their own off colour | |
|
|
Off Colour |
| Colour of the indicator when switched off | |
|
|
Show Label |
|
Label |
|
Text |
| Text to display | |
|
Text Colour |
| Specifies the font colour for the item | |
|
|
Background Colour |
| Specifies the background colour value | |
|
Font |
| Specifies the font style for the item | |
|
Scale |
|
|
Bold |
|
|
Placement |
|
|
Spacing |
| Distance between the label and the indicator | |
==Macro reference==
|
|
GetSwitch |
| Reads back the status of the indicator | |
| - BOOL
|
Return |
|
|
SwitchOn |
| Sets the indicator to the On state. | |
| - VOID
|
Return |
|
|
Switch |
| Sets the indicator to the value dictated by the State parameter | |
| - BOOL
|
State |
| - VOID
|
Return |
|
|
SwitchOff |
| Sets the indicator to the Off state. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Indicator Type |
| Controls the shape of the indicator object on the panel | |
|
|
Style |
|
|
On Colour |
| Colour of the indicator when switched on | |
|
|
Auto Off Colour |
| Controls if an off colour is automatically assigned for you. Yes - Generate automatic off colour No - User can set their own off colour | |
|
|
Off Colour |
| Colour of the indicator when switched off | |
|
|
Show Label |
|
|
Label |
|
|
Text |
| Text to display | |
|
|
Text Colour |
| Specifies the font colour for the item | |
|
|
Background Colour |
| Specifies the background colour value | |
|
|
Font |
| Specifies the font style for the item | |
|
|
Scale |
|
|
Bold |
|
|
Placement |
|
|
Spacing |
| Distance between the label and the indicator | |
==Macro reference==
|
|
GetSwitch |
| Reads back the status of the indicator | |
| - BOOL
|
Return |
|
|
SwitchOn |
| Sets the indicator to the On state. | |
| - VOID
|
Return |
|
|
Switch |
| Sets the indicator to the value dictated by the State parameter | |
| - BOOL
|
State |
| - VOID
|
Return |
|
|
SwitchOff |
| Sets the indicator to the Off state. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Indicator Type |
| Controls the shape of the indicator object on the panel | |
|
|
Style |
|
|
On Colour |
| Colour of the indicator when switched on | |
|
|
Auto Off Colour |
| Controls if an off colour is automatically assigned for you. Yes - Generate automatic off colour No - User can set their own off colour | |
|
|
Off Colour |
| Colour of the indicator when switched off | |
|
|
Show Label |
|
|
Label |
|
|
Text |
| Text to display | |
|
|
Text Colour |
| Specifies the font colour for the item | |
|
|
Background Colour |
| Specifies the background colour value | |
|
|
Font |
| Specifies the font style for the item | |
|
|
Scale |
|
|
Bold |
|
|
Placement |
|
|
Spacing |
| Distance between the label and the indicator | |
==Macro reference==
|
|
GetSwitch |
| Reads back the status of the indicator | |
| - BOOL
|
Return |
|
|
SwitchOn |
| Sets the indicator to the On state. | |
| - VOID
|
Return |
|
|
Switch |
| Sets the indicator to the value dictated by the State parameter | |
| - BOOL
|
State |
| - VOID
|
Return |
|
|
SwitchOff |
| Sets the indicator to the Off state. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Indicator Type |
| Controls the shape of the indicator object on the panel | |
|
|
Style |
|
|
On Colour |
| Colour of the indicator when switched on | |
|
|
Auto Off Colour |
| Controls if an off colour is automatically assigned for you. Yes - Generate automatic off colour No - User can set their own off colour | |
|
|
Off Colour |
| Colour of the indicator when switched off | |
|
|
Show Label |
|
|
Label |
|
|
Text |
| Text to display | |
|
|
Text Colour |
| Specifies the font colour for the item | |
|
|
Background Colour |
| Specifies the background colour value | |
|
|
Font |
| Specifies the font style for the item | |
|
|
Scale |
|
|
Bold |
|
|
Placement |
|
|
Spacing |
| Distance between the label and the indicator | |
