Component: Switch (EB007) (E-blocks 1): Difference between revisions

Revision as of 12:04, 3 February 2023

Author	Matrix Ltd.
Version	2.0
Category	E-blocks 1

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_temp/switch_array_push_EB007.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/switch_array_push_EB007.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetHandle

	GetHandle
Retrieves the object handle of the switch component at the given index.
- BYTE	Index

- HANDLE	Return

ReadAll

	ReadAll
Reads all of the switches at once, returning a byte containing one bit per switch.
- BYTE	Return

ReadState

	ReadState
Read the state of the switch at the given index.
- BYTE	Index
The switch to read the status of.
- BOOL	Return

WaitUntilHigh

	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

WaitUntilLow

	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.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/switch_array_push_EB007.fcfx FC_Comp_Source_temp/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_temp/switch_array_push_EB007.fcfx FC_Comp_Source_temp/switch_array_push_EB007.fcfx]
 ==Detailed description==
@@ Line 49: / Line 49: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 57: / Line 59: @@
 ==Macro reference==
-===ReadState===
+===GetHandle===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHandle'''
 |-
-| colspan="2" | Read the state of the switch at the given index.&nbsp;
+| colspan="2" | Retrieves the object handle of the switch component at the given index.&nbsp;
 |-
 |-
@@ Line 69: / Line 71: @@
 | width="90%" | Index
 |-
-| colspan="2" | The switch to read the status of.&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| 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''
 |}
-===WaitUntilHigh===
+===ReadAll===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAll'''
 |-
-| colspan="2" | Pause the program until the switch at the given index is turned on.&nbsp;
+| colspan="2" | Reads all of the switches at once, returning a byte containing one bit per switch.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
-|-
-| colspan="2" | Index of the switch to wait for.&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''
 |}
-===ReadAll===
+===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;" | '''ReadAll'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadState'''
+|-
+| colspan="2" | Read the state of the switch at the given index.&nbsp;
+|-
 |-
-| colspan="2" | Reads all of the switches at once, returning a byte containing one bit per switch.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Index
 |-
+| colspan="2" | The switch to read the status of.&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
-===GetHandle===
+===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;" | '''GetHandle'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitUntilHigh'''
 |-
-| colspan="2" | Retrieves the object handle of the switch component at the given index.&nbsp;
+| colspan="2" | Pause the program until the switch at the given index is turned on.&nbsp;
 |-
 |-
@@ Line 121: / Line 123: @@
 | width="90%" | Index
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Index of the switch to wait for.&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| 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''
 |}

Wiki bot (talk | contribs)