Difference between revisions of "Component: Switch Push Button Dummy (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Switch_Push_Button_2dgi_no_port_dummy.fcfx FC_Comp_Source_Switch_Push_Button_2dgi_no_port_dummy.fcfx] |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 40: | Line 42: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 73: | Line 77: | ||
==Macro reference== | ==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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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="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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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-7-icon.png]] | ||
| + | | width="90%" | Latching | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | ||
| + | | width="90%" | Label Colour | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-12-icon.png]] | ||
| + | | width="90%" | Type | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | On Label | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Off Label | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:17, 20 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Misc |
Contents
Switch Push Button Dummy component
A simple push switch allowing latched and none latched operation. For componets like keypad.
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_Switch_Push_Button_2dgi_no_port_dummy.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Simple example showing how to use the translation component when designing multi-language user interfaces.
Clicking the buttons on the keypad selects the active language.
1=English
2=French
3=German
Macro reference
|
ReadState |
| Reads the button state as 0 for released or 1 for pressed Performs debounce if required | |
 - BYTE
|
Return |
|
|
WaitUntilHigh |
| Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity | |
 - VOID
|
Return |
|
|
SetState |
| Sets the switch to be on or off. | |
 - BOOL
|
State |
| The new state of the switch (true=on, false=off) | |
| - VOID
|
Return |
|
|
WaitUntilLow |
| Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Switch Settings |
|
Latching |
|
|
Label |
|
Component Label |
|
Label Colour |
|
|
Appearance |
|
|
Style |
|
Type |
|
On Label |
|
|
Off Label |
==Macro reference==
|
|
ReadState |
| Reads the button state as 0 for released or 1 for pressed Performs debounce if required | |
| - BYTE
|
Return |
|
|
WaitUntilHigh |
| Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity | |
| - VOID
|
Return |
|
|
SetState |
| Sets the switch to be on or off. | |
| - BOOL
|
State |
| The new state of the switch (true=on, false=off) | |
| - VOID
|
Return |
|
|
WaitUntilLow |
| Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Switch Settings |
|
|
Latching |
|
|
Label |
|
|
Component Label |
|
|
Label Colour |
|
|
Appearance |
|
|
Style |
|
|
Type |
|
|
On Label |
|
|
Off Label |
