Jump to content

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

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
XML import - Pre 8.0 release
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| Matrix Ltd.
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 2.0 (Release)
| 2.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| E-blocks 1
| 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: [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]
==Detailed description==






==[[File:Component Icon 4772ea31_c5fb_4ac1_8aef_c9385a0e9a53.png|Image]] Switch (EB007) component==
An array of up to eight momentary push switches, each connected to a single pin of the specified port.


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


:''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==


===GetHandle===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetHandle'''
|-
| colspan="2" | Retrieves the object handle of the switch component at the given index.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


==Simulation macro reference==


''This component does not contain any simulation macros''
===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''
|}




==Property reference==
===ReadState===
<span style="font-weight: normal;"><u>Input Mode</u></span>
{| 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''
|}


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


Choose how your switches are connected.
===WaitUntilHigh===
{| 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''
|}


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


Custom = Individual pin by pin connections
===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''
|}


<span style="font-weight: normal;"><u>Port</u></span>


This property is of type ''Digital port byte'' and can be referenced with the variable name ''PortByte''.
==Property reference==


''<span style="color:red;">No additional information</span>''
{| 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" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Count
|-
| colspan="2" | The number of LEDs in the array from 1 to 8.&nbsp;
|-
| 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 a single port for all LEDs - pins are allocated in sequence from pin 0 - 7 ...or choose 'Custom pins' to assign each switch individually.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
| width="90%" | Port
|-
| colspan="2" | &nbsp;
|-
| 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.&nbsp;
|}

Latest revision as of 14:37, 13 July 2026

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

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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Switch_(EB007)_(E-blocks_1)&oldid=48277"