Jump to content

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

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import - Pre 8.0 release
 
No edit summary
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==
==[[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.
An array of up to eight momentary push switches, each connected to a single pin of the specified port.


==Examples==
==Component Source Code==
''<span style="color:red;">No additional examples</span>''


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_switch_array_push_EB007.fcfx FC_Comp_Source_switch_array_push_EB007.fcfx]


==Downloadable macro reference==
==Detailed description==


===<span style="font-weight: normal;"><u><tt>ReadState</tt></u></span>===
''No detailed description exists yet for this component''
Read the state of the switch at the given index.


'''Parameters'''
==Examples==


:[[Variable Types|BYTE]] ''Index''
::The switch to read the status of.


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


'''Return value'''


:[[Variable Types|BOOL]] : Key state - true = on, false = off
==Downloadable 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.&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''
|}


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


:[[Variable Types|BYTE]] ''Index''
::Index of the switch to wait for.


{| 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''
|}


'''Return value'''


:''This call does not return a value''
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
===<span style="font-weight: normal;"><u><tt>ReadAll</tt></u></span>===
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHandle'''
Reads all of the switches at once, returning a byte containing one bit per
|-
 
| colspan="2" | Retrieves the object handle of the switch component at the given index.&nbsp;
switch.
|-
 
|-
'''Parameters'''
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Index
:''This macro has no parameters''
|-
 
| colspan="2" | &nbsp;
 
|-
'''Return value'''
| 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''
:[[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''




{| 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''
|}


==Simulation macro reference==


''This component does not contain any simulation macros''




==Property reference==
==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''.
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
Choose how your switches are connected.
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
PORT = Single port byte for all switches - pins are allocated in sequence from pin 0 - X
|-
 
|-
Custom = Individual pin by pin connections
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Count
<span style="font-weight: normal;"><u>Port</u></span>
|-
 
| colspan="2" | The number of LEDs in the array from 1 to 8.&nbsp;
This property is of type ''Digital port byte'' and can be referenced with the variable name ''PortByte''.
|-
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
''<span style="color:red;">No additional information</span>''
| 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.&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;
|}

Revision as of 14:44, 16 January 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 for the component source code: FC_Comp_Source_switch_array_push_EB007.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


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