Difference between revisions of "Component: Switch User Images (Switch)"

From Flowcode Help
Jump to navigationJump to search
 
(3 intermediate revisions by the same user not shown)
Line 52: Line 52:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 57: Line 65:
 
==Macro reference==
 
==Macro reference==
  
 +
===ReadState===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 70: Line 79:
  
  
 +
===SetState===
 
{| 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;" | '''WaitUntilHigh'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetState'''
 +
|-
 +
| colspan="2" | Sets the switch to be on or off.&nbsp;
 +
|-
 
|-
 
|-
−
| colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&nbsp;
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 
|-
 
|-
 +
| colspan="2" | The new state of the switch (true=on, false=off)&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-void-icon.png]] - VOID
Line 83: Line 98:
  
  
 +
===WaitUntilHigh===
 
{| 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;" | '''SetState'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitUntilHigh'''
−
|-
 
−
| colspan="2" | Sets the switch to be on or off.&nbsp;
 
 
|-
 
|-
 +
| colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
−
| width="90%" | State
 
−
|-
 
−
| colspan="2" | The new state of the switch (true=on, false=off)&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-void-icon.png]] - VOID
Line 101: Line 112:
  
  
 +
===WaitUntilLow===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 112: Line 124:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 13:12, 7 February 2023

Author MatrixTSL
Version 1.0
Category Switch


Switch User Images component

A simple digital push switch allowing latched and none latched operation. In embedded mode displays the connecting pin and pin status. The on and off states of the switch are shown using user supplied images allowing customised switches to be created.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Switch_User_Images_2dgi.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Switch_User_Images_2dgi.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

ReadState

Fc9-comp-macro.png ReadState
Reads the button state as 0 for released or 1 for pressed Performs debounce if required 
Fc9-u8-icon.png - BYTE Return


SetState

Fc9-comp-macro.png SetState
Sets the switch to be on or off. 
Fc9-bool-icon.png - BOOL State
The new state of the switch (true=on, false=off) 
Fc9-void-icon.png - VOID Return


WaitUntilHigh

Fc9-comp-macro.png WaitUntilHigh
Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity 
Fc9-void-icon.png - VOID Return


WaitUntilLow

Fc9-comp-macro.png WaitUntilLow
Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Switch Settings
Fc9-type-5-icon.png Connection
 
Fc9-type-16-icon.png Polarity
 
Fc9-type-14-icon.png Debounce
 
Fc9-type-7-icon.png Latching
 
Fc9-conn-icon.png Label
Fc9-type-16-icon.png Component Label
 
Fc9-type-2-icon.png Label Colour
 
Fc9-type-7-icon.png Show Connection Label
 
Fc9-type-7-icon.png Show Pin Value
 
Fc9-type-21-icon.png Label Spacing
 
Fc9-conn-icon.png Appearance
Fc9-type-13-icon.png FilenameOff
 
Fc9-type-13-icon.png FilenameOn
 
Fc9-type-7-icon.png Draw Thumb
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Switch_User_Images_(Switch)&oldid=38348"