Jump to content

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

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
Created page with "{| width="50%" |- | width="20%" style="color: gray;" | Author | Matrix TSL |- | width="20%" style="color: gray;" | Version | ..."
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{| width="50%"
{| style="width:50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| 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
| 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, 8.0, 02-04-25, MW, ESP32 compile fail. Added .Retun to ReadState function
9, 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.


==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''
::The switch to read the status of.


''No detailed description exists yet for this component''


'''Return value'''
==Examples==


:[[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.


'''Parameters'''
''<span style="color:red;">No additional examples</span>''


:&apos;&apos;This macro has no parameters&apos;&apos;




&apos;&apos;&apos;Return value&apos;&apos;&apos;


:[[Variable Types|BYTE]] : One bit per switch in the array.




===&lt;span style=&quot;font-weight: normal;&quot;&gt;&lt;u&gt;&lt;tt&gt;WaitUntilLow&lt;/tt&gt;&lt;/u&gt;&lt;/span&gt;===
Pause the program until the switch at the given index is turned on.


&apos;&apos;&apos;Parameters&apos;&apos;&apos;


:[[Variable Types|BYTE]] &apos;&apos;Index&apos;&apos;
::Index of the switch  to wait for.




&apos;&apos;&apos;Return value&apos;&apos;&apos;


:&apos;&apos;This call does not return a value&apos;&apos;


==Macro reference==


===ReadAll===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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==


&apos;&apos;This component does not contain any simulation macros&apos;&apos;
===ReadState===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




==Property reference==
===WaitUntilHigh===
&lt;span style=&quot;font-weight: normal;&quot;&gt;&lt;u&gt;Input Mode&lt;/u&gt;&lt;/span&gt;
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


This property is of type &apos;&apos;Fixed list of ints&apos;&apos; and can be referenced with the variable name &apos;&apos;port&apos;&apos;.


Choose how your switches are connected.
===WaitUntilLow===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X


Custom = Individual pin by pin connections
==Property reference==
 
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" class="mtx-class-macrohead" | '''Properties'''
|-
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | 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;
|}


&lt;span style=&quot;font-weight: normal;&quot;&gt;&lt;u&gt;Port&lt;/u&gt;&lt;/span&gt;
==Component Source Code==


This property is of type &apos;&apos;Digital port byte&apos;&apos; and can be referenced with the variable name &apos;&apos;PortByte&apos;&apos;.
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EB_Switch_BL0145.fcfx FC_Comp_Source_EB_Switch_BL0145.fcfx]


&apos;&apos;&lt;span style=&quot;color:red;&quot;&gt;No additional information&lt;/span&gt;&apos;&apos;
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EB_Switch_BL0145.fcfx FC_Comp_Source_EB_Switch_BL0145.fcfx]

Latest revision as of 14:37, 13 July 2026

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
8, 8.0, 02-04-25, MW, ESP32 compile fail. Added .Retun to ReadState function
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_EB_Switch_BL0145.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_EB_Switch_BL0145.fcfx

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Switch_(BL0145)_(E-blocks_2)&oldid=48352"