Difference between revisions of "Component: Switch (BL0145) (E-blocks 2)"

Latest revision as of 08:58, 9 June 2025

Author	Matrix TSL
Version	8.8
Category	E-blocks 2

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.

Version information

Library Version, Component Version, Date, Author, Info
9, 8.0, 08-05-25, BR, Added autodetect port on Ev_PostInitialise

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

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
	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

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

Difference between revisions of "Component: Switch (BL0145) (E-blocks 2)"

Latest revision as of 08:58, 9 June 2025

Contents

Switch component

Version information

Detailed description

Examples

Macro reference

ReadAll

ReadState

WaitUntilHigh

WaitUntilLow

Property reference

Component Source Code

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | Matrix TSL
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 1.0 (Release)
+| 8.8
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | Category
 | E-blocks 2
 |}
+==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.
+==Version information==
+ Library Version, Component Version, Date, Author, Info
+, 8.0, 08-05-25, BR, Added autodetect port on Ev_PostInitialise
+==Detailed description==
-==[[File:Component Icon b3a7287a_4070_49d1_9122_bf6169f67cd1.png|Image]] Switch (BL0145) 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.
-There are component macros to read the state of all switches at once or just one of the switches. You can also use macros to tell the program to wait until a certain switch is pressed. When reading the state of a certain switch you are asked to input the index value of that switch (0-7), the index values are displayed below the switches on the E-blocks 2 board.
-Make sure the switch panel is connected to the correct port in flowcode corresponding to the port on your E-blocks 2 upstream board.
-==Examples==
-''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>ReadState</tt></u></span>===
-Read the state of the switch at the given index.
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Index''
+''No detailed description exists yet for this component''
-::The switch to read the status of.
+==Examples==
-'''Return value'''
-:[[Variable Types|BOOL]] : Key state - true = on, false = off
-===<span style="font-weight: normal;"><u><tt>WaitUntilHigh</tt></u></span>===
-Pause the program until the switch at the given index is turned on.
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Index''
-::Index of the switch to wait for.
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>ReadAll</tt></u></span>===
-Reads all of the switches at once, returning a byte containing one bit per
-switch.
+''<span style="color:red;">No additional examples</span>''
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|BYTE]] : One bit per switch in the array.
-===<span style="font-weight: normal;"><u><tt>WaitUntilLow</tt></u></span>===
-Pause the program until the switch at the given index is turned on.
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Index''
-::Index of the switch  to wait for.
-'''Return value'''
-:''This call does not return a value''
+==Macro reference==
+===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;" | '''ReadAll'''
+|-
+| colspan="2" | Reads all of the switches at once, returning a byte containing one bit per switch.&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''
+|}
-==Simulation 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" | Read the state of the switch at the given index.&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-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-''This component does not contain any simulation macros''
+===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" | Pause the program until the switch at the given index is turned on.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[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''
+|}
-==Property reference==
-<span style="font-weight: normal;"><u>Input Mode</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''port''.
+===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" | Pause the program until the switch at the given index is turned on.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[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''
+|}
-Choose how your switches are connected.
-PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X
+==Property reference==
-Custom = Individual pin by pin connections
+{| 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
+| width="90%" | Port
+|-
+| colspan="2" | &nbsp;
+|}
-<span style="font-weight: normal;"><u>Port</u></span>
+==Component Source Code==
-This property is of type ''Digital port byte'' and can be referenced with the variable name ''PortByte''.
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx FC_Comp_Source_EBlocks2_Switch_BL0145.fcfx]
-''<span style="color:red;">No additional information</span>''
+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]