Difference between revisions of "Component: Switch User Images (Switch)"
From Flowcode Help
Jump to navigationJump to search| (8 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Switch_User_Images_2dgi.fcfx FC_Comp_Source_Switch_User_Images_2dgi.fcfx] |
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Switch_User_Images_2dgi.fcfx FC_Comp_Source_Switch_User_Images_2dgi.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 26: | Line 38: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 31: | Line 53: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===ReadState=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 46: | 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetState''' |
| + | |- | ||
| + | | colspan="2" | Sets the switch to be on or off. | ||
|- | |- | ||
| − | |||
|- | |- | ||
| + | | 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) | ||
|- | |- | ||
| 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 59: | 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitUntilHigh''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | |||
|- | |- | ||
| 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 77: | Line 112: | ||
| + | ===WaitUntilLow=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 88: | 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 |
Contents
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
|
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
|
State |
| 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 |
|
Switch Settings |
|
Connection |
|
Polarity |
|
Debounce |
|
Latching |
|
|
Label |
|
|
Component Label |
|
Label Colour |
|
|
Show Connection Label |
|
|
Show Pin Value |
|
Label Spacing |
|
|
Appearance |
|
FilenameOff |
|
|
FilenameOn |
|
|
Draw Thumb |
