View source for Component: Switch Rotary 0 - 1 (Switch)

From Flowcode Help

← Component: Switch Rotary 0 - 1 (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 | Matrix TSL |- | width="20%" style="color:gray;" | Version | 6.0 |- | width="20%" style="color:gray;" | Category | Switch |} ==Switch Rotary 0 - 1 component== A simple digital rotary switch allowing latched and none latched operation. In embedded mode displays the connecting pin and pin status. ==Version information== Library Version, Component Version, Date, Author, Info 6, 6.0, 23-09-24, MW, Fixed a bug to make sure switch starts in the off position 6, 6.0, 23-09-24, MW, Added option for simulation only 6, 6.0, 23-09-24, MW, Fixed a bug preventing custom lable posistion from updating on the fly ==Detailed description== ''No detailed description exists yet for this component'' ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Macro reference== ===ReadState=== {| 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'' |} ===SetState=== {| 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'' |} ===WaitUntilHigh=== {| 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'' |} ===WaitUntilLow=== {| 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;" | Function |- |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Simulation Only |- | colspan="2" | &nbsp; |- | 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" | The chip pin to which the switch connects.&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Polarity |- | colspan="2" | Set the polarity of states sent to the chip pin. 'Active High' -> Pressed = Set, Released = Clear 'Active Low' -> Pressed = Clear, Released = Set&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Debounce |- | colspan="2" | Sets the time in milliseconds to allow a pin change to settle into a stable state. NB) Debouncing is only used when reading the button state using the component macros. Chip pins are NOT debounced.&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Latching |- | colspan="2" | Determines if the simulated switch maintains its state or revers back to the default state when not clicked.&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-16-icon.png]] | width="90%" | Component label position |- | 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-16-icon.png]] | width="90%" | Pin label position |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Set X Postion |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Set Y Postion |- | 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-16-icon.png]] | width="90%" | Style |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-12-icon.png]] | width="90%" | Type |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | On Label |- | colspan="2" | &nbsp; |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | Off Label |- | colspan="2" | &nbsp; |} ==Component Source Code== Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Switch_Rotary_0_-_1_2dgi.fcfx FC_Comp_Source_Switch_Rotary_0_-_1_2dgi.fcfx] Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Switch_Rotary_0_-_1_2dgi.fcfx FC_Comp_Source_Switch_Rotary_0_-_1_2dgi.fcfx]

Return to Component: Switch Rotary 0 - 1 (Switch).