Difference between revisions of "Component: Switch (EB007) (E-blocks 1)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_switch_array_push_EB007.fcfx FC_Comp_Source_switch_array_push_EB007.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_switch_array_push_EB007.fcfx FC_Comp_Source_switch_array_push_EB007.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_switch_array_push_EB007.fcfx FC_Comp_Source_switch_array_push_EB007.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 44: | Line 48: | ||
==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;" | '''GetHandle''' | ||
| + | |- | ||
| + | | colspan="2" | Retrieves the object handle of the switch component at the given index. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | 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" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Count | ||
| + | |- | ||
| + | | colspan="2" | The number of LEDs in the array from 1 to 8. | ||
| + | |- | ||
| + | | 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 a single port for all LEDs - pins are allocated in sequence from pin 0 - 7 ...or choose 'Custom pins' to assign each switch individually. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-19-icon.png]] | ||
| + | | width="90%" | Port | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Debounce | ||
| + | |- | ||
| + | | colspan="2" | Time in milliseconds allowed for the pin to settle following a change of state. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 10:01, 27 January 2023
| Author | Matrix Ltd. |
| Version | 2.0 |
| Category | E-blocks 1 |
Contents
Switch component
An array of up to eight momentary push switches, each connected to a single pin of the specified port.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_switch_array_push_EB007.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_switch_array_push_EB007.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 |
|
|
GetHandle |
| Retrieves the object handle of the switch component at the given index. | |
| - BYTE
|
Index |
 - HANDLE
|
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 |
|
Count |
| The number of LEDs in the array from 1 to 8. | |
|
Connections |
|
|
Input Mode |
| Choose a single port for all LEDs - pins are allocated in sequence from pin 0 - 7 ...or choose 'Custom pins' to assign each switch individually. | |
|
Port |
|
Debounce |
| Time in milliseconds allowed for the pin to settle following a change of state. | |
==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 |
|
|
GetHandle |
| Retrieves the object handle of the switch component at the given index. | |
| - BYTE
|
Index |
| - HANDLE
|
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 |
|
|
Count |
| The number of LEDs in the array from 1 to 8. | |
|
|
Connections |
|
|
Input Mode |
| Choose a single port for all LEDs - pins are allocated in sequence from pin 0 - 7 ...or choose 'Custom pins' to assign each switch individually. | |
|
|
Port |
|
|
Debounce |
| Time in milliseconds allowed for the pin to settle following a change of state. | |
==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 |
|
|
GetHandle |
| Retrieves the object handle of the switch component at the given index. | |
| - BYTE
|
Index |
| - HANDLE
|
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 |
|
|
Count |
| The number of LEDs in the array from 1 to 8. | |
|
|
Connections |
|
|
Input Mode |
| Choose a single port for all LEDs - pins are allocated in sequence from pin 0 - 7 ...or choose 'Custom pins' to assign each switch individually. | |
|
|
Port |
|
|
Debounce |
| Time in milliseconds allowed for the pin to settle following a change of state. | |
==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 |
|
|
GetHandle |
| Retrieves the object handle of the switch component at the given index. | |
| - BYTE
|
Index |
| - HANDLE
|
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 |
|
|
Count |
| The number of LEDs in the array from 1 to 8. | |
|
|
Connections |
|
|
Input Mode |
| Choose a single port for all LEDs - pins are allocated in sequence from pin 0 - 7 ...or choose 'Custom pins' to assign each switch individually. | |
|
|
Port |
|
|
Debounce |
| Time in milliseconds allowed for the pin to settle following a change of state. | |
