Difference between revisions of "Component: Switch (BL0145) (E-blocks 2)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 28: | Line 32: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 38: | Line 44: | ||
==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" | Read the state of the switch at the given index. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | The switch to read the status of. | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | 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" | Pause the program until the switch at the given index is turned on. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | Index of the switch to wait for. | ||
| + | |- | ||
| + | | 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;" | '''ReadAll''' | ||
| + | |- | ||
| + | | colspan="2" | Reads all of the switches at once, returning a byte containing one bit per switch. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''WaitUntilLow''' | ||
| + | |- | ||
| + | | colspan="2" | Pause the program until the switch at the given index is turned on. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | Index of the switch to wait for. | ||
| + | |- | ||
| + | | 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;" | Connections | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Input Mode | ||
| + | |- | ||
| + | | colspan="2" | Choose how your switches are connected. PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X Custom = Individual pin by pin connections | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-19-icon.png]] | ||
| + | | width="90%" | Port | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:21, 20 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | E-blocks 2 |
Contents
Switch component
A set of 8 push switches that can be connected to an E-blocks 2 upstream board via a port connector. Switches are wired in an active high configuration.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
ReadState |
| Read the state of the switch at the given index. | |
 - BYTE
|
Index |
| The switch to read the status of. | |
 - BOOL
|
Return |
|
|
WaitUntilHigh |
| Pause the program until the switch at the given index is turned on. | |
| - BYTE
|
Index |
| Index of the switch to wait for. | |
 - VOID
|
Return |
|
|
ReadAll |
| Reads all of the switches at once, returning a byte containing one bit per switch. | |
| - BYTE
|
Return |
|
|
WaitUntilLow |
| Pause the program until the switch at the given index is turned on. | |
| - BYTE
|
Index |
| Index of the switch to wait for. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Connections |
|
Input Mode |
| Choose how your switches are connected. PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X Custom = Individual pin by pin connections | |
|
Port |
==Macro reference==
|
|
ReadState |
| Read the state of the switch at the given index. | |
| - BYTE
|
Index |
| The switch to read the status of. | |
| - BOOL
|
Return |
|
|
WaitUntilHigh |
| Pause the program until the switch at the given index is turned on. | |
| - BYTE
|
Index |
| Index of the switch to wait for. | |
| - VOID
|
Return |
|
|
ReadAll |
| Reads all of the switches at once, returning a byte containing one bit per switch. | |
| - BYTE
|
Return |
|
|
WaitUntilLow |
| Pause the program until the switch at the given index is turned on. | |
| - BYTE
|
Index |
| Index of the switch to wait for. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Connections |
|
|
Input Mode |
| Choose how your switches are connected. PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X Custom = Individual pin by pin connections | |
|
|
Port |
==Macro reference==
|
|
ReadState |
| Read the state of the switch at the given index. | |
| - BYTE
|
Index |
| The switch to read the status of. | |
| - BOOL
|
Return |
|
|
WaitUntilHigh |
| Pause the program until the switch at the given index is turned on. | |
| - BYTE
|
Index |
| Index of the switch to wait for. | |
| - VOID
|
Return |
|
|
ReadAll |
| Reads all of the switches at once, returning a byte containing one bit per switch. | |
| - BYTE
|
Return |
|
|
WaitUntilLow |
| Pause the program until the switch at the given index is turned on. | |
| - BYTE
|
Index |
| Index of the switch to wait for. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Connections |
|
|
Input Mode |
| Choose how your switches are connected. PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X Custom = Individual pin by pin connections | |
|
|
Port |
