View source for Component: Switch User Images (Switch)

From Flowcode Help

← Component: Switch User Images (Switch)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;" | 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: [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== ''No detailed description exists yet for this component'' ==Examples== ''<span style="color:red;">No additional examples</span>'' ==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;" | '''ReadState''' |- | colspan="2" | Reads the button state as 0 for released or 1 for pressed Performs debounce if required&nbsp; |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | 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;" | '''WaitUntilHigh''' |- | colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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;" | '''SetState''' |- | colspan="2" | Sets the switch to be on or off.&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="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;" | '''WaitUntilLow''' |- | colspan="2" | Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Switch Settings |- |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | Connection |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Polarity |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Debounce |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Latching |- | colspan="2" | &nbsp; |- | 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-16-icon.png]] | width="90%" | Component Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Label Colour |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Connection Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Pin Value |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Label Spacing |- | colspan="2" | &nbsp; |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance |- |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOff |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOn |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Draw Thumb |- | colspan="2" | &nbsp; |}==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;" | '''ReadState''' |- | colspan="2" | Reads the button state as 0 for released or 1 for pressed Performs debounce if required&nbsp; |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | 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;" | '''WaitUntilHigh''' |- | colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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;" | '''SetState''' |- | colspan="2" | Sets the switch to be on or off.&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="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;" | '''WaitUntilLow''' |- | colspan="2" | Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Switch Settings |- |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | Connection |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Polarity |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Debounce |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Latching |- | colspan="2" | &nbsp; |- | 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-16-icon.png]] | width="90%" | Component Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Label Colour |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Connection Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Pin Value |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Label Spacing |- | colspan="2" | &nbsp; |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance |- |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOff |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOn |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Draw Thumb |- | colspan="2" | &nbsp; |}==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;" | '''ReadState''' |- | colspan="2" | Reads the button state as 0 for released or 1 for pressed Performs debounce if required&nbsp; |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | 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;" | '''WaitUntilHigh''' |- | colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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;" | '''SetState''' |- | colspan="2" | Sets the switch to be on or off.&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="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;" | '''WaitUntilLow''' |- | colspan="2" | Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Switch Settings |- |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | Connection |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Polarity |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Debounce |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Latching |- | colspan="2" | &nbsp; |- | 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-16-icon.png]] | width="90%" | Component Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Label Colour |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Connection Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Pin Value |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Label Spacing |- | colspan="2" | &nbsp; |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance |- |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOff |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOn |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Draw Thumb |- | colspan="2" | &nbsp; |}==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;" | '''ReadState''' |- | colspan="2" | Reads the button state as 0 for released or 1 for pressed Performs debounce if required&nbsp; |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | 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;" | '''WaitUntilHigh''' |- | colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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;" | '''SetState''' |- | colspan="2" | Sets the switch to be on or off.&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="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;" | '''WaitUntilLow''' |- | colspan="2" | Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity&nbsp; |- |- | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Switch Settings |- |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | Connection |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Polarity |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Debounce |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Latching |- | colspan="2" | &nbsp; |- | 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-16-icon.png]] | width="90%" | Component Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Label Colour |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Connection Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Pin Value |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Label Spacing |- | colspan="2" | &nbsp; |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance |- |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOff |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | FilenameOn |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Draw Thumb |- | colspan="2" | &nbsp; |}

Return to Component: Switch User Images (Switch).