Difference between revisions of "Component: On / Off Indicator (Digital Indicator )"

From Flowcode Help
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 22: Line 22:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 62: Line 64:
  
  
−
No examples here yet
 
  
−
==Macro reference==
 
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
No examples here yet
−
|-
 
−
| 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;"
+
==Macro reference==
−
|-
 
−
| 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==
 
  
 +
===GetSwitch===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 221: Line 94:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===Switch===
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 252: Line 113:
  
  
 +
===SwitchOff===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 265: Line 127:
  
  
−
 
+
===SwitchOn===
−
 
 
−
==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;"
 
−
|-
 
−
| 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;"
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 516: Line 139:
 
| 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;"
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
−
 
  
  

Latest revision as of 13:11, 7 February 2023

Author Matrix TSL
Version 1.0
Category Digital Indicator


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

Fc9-comp-macro.png GetSwitch
Reads back the status of the indicator 
Fc9-bool-icon.png - BOOL Return


Switch

Fc9-comp-macro.png Switch
Sets the indicator to the value dictated by the State parameter 
Fc9-bool-icon.png - BOOL State
 
Fc9-void-icon.png - VOID Return


SwitchOff

Fc9-comp-macro.png SwitchOff
Sets the indicator to the Off state. 
Fc9-void-icon.png - VOID Return


SwitchOn

Fc9-comp-macro.png SwitchOn
Sets the indicator to the On state. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Indicator Type
Controls the shape of the indicator object on the panel 
Fc9-type-16-icon.png Style
 
Fc9-type-1-icon.png On Colour
Colour of the indicator when switched on 
Fc9-type-7-icon.png 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 
Fc9-type-1-icon.png Off Colour
Colour of the indicator when switched off 
Fc9-type-7-icon.png Show Label
 
Fc9-conn-icon.png Label
Fc9-type-11-icon.png Text
Text to display 
Fc9-type-2-icon.png Text Colour
Specifies the font colour for the item 
Fc9-type-2-icon.png Background Colour
Specifies the background colour value 
Fc9-type-3-icon.png Font
Specifies the font style for the item 
Fc9-type-15-icon.png Scale
 
Fc9-type-7-icon.png Bold
 
Fc9-type-16-icon.png Placement
 
Fc9-type-15-icon.png Spacing
Distance between the label and the indicator 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_On_/_Off_Indicator_(Digital_Indicator_)&oldid=38081"