Jump to content

Component: Switch Rotary Two State (Switch): Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Switch_Rotary.fcfx FC_Comp_Source_Switch_Rotary.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Switch_Rotary.fcfx FC_Comp_Source_temp/Switch_Rotary.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Switch_Rotary.fcfx FC_Comp_Source_Switch_Rotary.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Switch_Rotary.fcfx FC_Comp_Source_temp/Switch_Rotary.fcfx]


==Detailed description==
==Detailed description==
Line 52: Line 52:


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




Line 73: Line 75:




===WaitUntilHigh===
===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%" | bState
|-
|-
| 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 87: Line 94:




===SetState===
===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%" | bState
|-
|-
| 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

Revision as of 12:03, 3 February 2023

Author Matrix TSL
Version 1.0
Category Switch


Switch Rotary Two State component

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/Switch_Rotary.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/Switch_Rotary.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples




Macro reference

ReadState

ReadState
Reads the button state as 0 for released or 1 for pressed Performs debounce if required 
- BYTE Return


SetState

SetState
Sets the switch to be on or off. 
- BOOL bState
The new state of the switch (true=on, false=off) 
- VOID Return


WaitUntilHigh

WaitUntilHigh
Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity 
- VOID Return


WaitUntilLow

WaitUntilLow
Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity 
- VOID Return



Property reference

Properties
Connection
 
Show Connection Label
 
Show Pin Value
 
Component Label
 
Polarity
 
Debounce
 
Latching
 
Appearance
Style
 
Style
 
Type