Difference between revisions of "Component: Switch Array (Push) 2D (Switches)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Switch_Array_Push_2dgi.fcfx FC_Comp_Source_Switch_Array_Push_2dgi.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Switch_Array_Push_2dgi.fcfx FC_Comp_Source_Switch_Array_Push_2dgi.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_2dgi.fcfx FC_Comp_Source_Switch_Array_Push_2dgi.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_2dgi.fcfx FC_Comp_Source_Switch_Array_Push_2dgi.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 32: Line 34:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 42: Line 46:
  
 
==Macro reference==
 
==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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | The switch to read the status of. 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Index of the switch to wait for. 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Index of the switch  to wait for. 
 +
|-
 +
| 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==
 +
 +
{| 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;" | Switch Settings
 +
|-
 +
|-
 +
| 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. 
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
 +
| width="90%" | Port
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Polarity
 +
|-
 +
| colspan="2" | Active High = LEDs light when the chosen chip pin is ON Active Low = LEDs light when the chosen chip pin is OFF 
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Operation
 +
|-
 +
| colspan="2" | Sets whether switches toggle or are press/release. NB) This option can only be set when the original target includes this option. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Component Label
 +
|-
 +
| colspan="2" | Allows you to add your own label to each switch. If Same as Handle is selected then all custom text will be erased. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| colspan="2" | Colour of the port and pin labels 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show Connection Label
 +
|-
 +
| colspan="2" | Enable or disable the pin values underneath each switch  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show Pin Value
 +
|-
 +
| colspan="2" | Enable or disable the pin level (GND or VCC) underneath each switch  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Switch layout
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Distance between switches
 +
|-
 +
| colspan="2" | Set distance betwwn each switch. Default = 55 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:59, 27 January 2023

Author MatrixTSL
Version 1.0
Category Switches


Switch Array (Push) 2D component

An array of up to eight slide switches. In embedded mode each switch is 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_2dgi.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Fc9-comp-macro.png ReadState
Read the state of the switch at the given index. 
Fc9-u8-icon.png - BYTE Index
The switch to read the status of. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png WaitUntilHigh
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAll
Reads all of the switches at once, returning a byte containing one bit per switch. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png WaitUntilLow
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Switch Settings
Fc9-type-16-icon.png Count
The number of LEDs in the array from 1 to 8. 
Fc9-type-16-icon.png 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. 
Fc9-type-19-icon.png Port
 
Fc9-type-16-icon.png Polarity
Active High = LEDs light when the chosen chip pin is ON Active Low = LEDs light when the chosen chip pin is OFF 
Fc9-type-14-icon.png Debounce
Time in milliseconds allowed for the pin to settle following a change of state. 
Fc9-type-16-icon.png Operation
Sets whether switches toggle or are press/release. NB) This option can only be set when the original target includes this option. 
Fc9-conn-icon.png Label
Fc9-type-16-icon.png Component Label
Allows you to add your own label to each switch. If Same as Handle is selected then all custom text will be erased. 
Fc9-type-1-icon.png Label colour
Colour of the port and pin labels 
Fc9-type-7-icon.png Show Connection Label
Enable or disable the pin values underneath each switch  
Fc9-type-7-icon.png Show Pin Value
Enable or disable the pin level (GND or VCC) underneath each switch  
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Switch layout
 
Fc9-type-21-icon.png Distance between switches
Set distance betwwn each switch. Default = 55 

==Macro reference==

Fc9-comp-macro.png ReadState
Read the state of the switch at the given index. 
Fc9-u8-icon.png - BYTE Index
The switch to read the status of. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png WaitUntilHigh
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAll
Reads all of the switches at once, returning a byte containing one bit per switch. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png WaitUntilLow
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Switch Settings
Fc9-type-16-icon.png Count
The number of LEDs in the array from 1 to 8. 
Fc9-type-16-icon.png 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. 
Fc9-type-19-icon.png Port
 
Fc9-type-16-icon.png Polarity
Active High = LEDs light when the chosen chip pin is ON Active Low = LEDs light when the chosen chip pin is OFF 
Fc9-type-14-icon.png Debounce
Time in milliseconds allowed for the pin to settle following a change of state. 
Fc9-type-16-icon.png Operation
Sets whether switches toggle or are press/release. NB) This option can only be set when the original target includes this option. 
Fc9-conn-icon.png Label
Fc9-type-16-icon.png Component Label
Allows you to add your own label to each switch. If Same as Handle is selected then all custom text will be erased. 
Fc9-type-1-icon.png Label colour
Colour of the port and pin labels 
Fc9-type-7-icon.png Show Connection Label
Enable or disable the pin values underneath each switch  
Fc9-type-7-icon.png Show Pin Value
Enable or disable the pin level (GND or VCC) underneath each switch  
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Switch layout
 
Fc9-type-21-icon.png Distance between switches
Set distance betwwn each switch. Default = 55 

==Macro reference==

Fc9-comp-macro.png ReadState
Read the state of the switch at the given index. 
Fc9-u8-icon.png - BYTE Index
The switch to read the status of. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png WaitUntilHigh
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAll
Reads all of the switches at once, returning a byte containing one bit per switch. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png WaitUntilLow
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Switch Settings
Fc9-type-16-icon.png Count
The number of LEDs in the array from 1 to 8. 
Fc9-type-16-icon.png 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. 
Fc9-type-19-icon.png Port
 
Fc9-type-16-icon.png Polarity
Active High = LEDs light when the chosen chip pin is ON Active Low = LEDs light when the chosen chip pin is OFF 
Fc9-type-14-icon.png Debounce
Time in milliseconds allowed for the pin to settle following a change of state. 
Fc9-type-16-icon.png Operation
Sets whether switches toggle or are press/release. NB) This option can only be set when the original target includes this option. 
Fc9-conn-icon.png Label
Fc9-type-16-icon.png Component Label
Allows you to add your own label to each switch. If Same as Handle is selected then all custom text will be erased. 
Fc9-type-1-icon.png Label colour
Colour of the port and pin labels 
Fc9-type-7-icon.png Show Connection Label
Enable or disable the pin values underneath each switch  
Fc9-type-7-icon.png Show Pin Value
Enable or disable the pin level (GND or VCC) underneath each switch  
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Switch layout
 
Fc9-type-21-icon.png Distance between switches
Set distance betwwn each switch. Default = 55 

==Macro reference==

Fc9-comp-macro.png ReadState
Read the state of the switch at the given index. 
Fc9-u8-icon.png - BYTE Index
The switch to read the status of. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png WaitUntilHigh
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAll
Reads all of the switches at once, returning a byte containing one bit per switch. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png WaitUntilLow
Pause the program until the switch at the given index is turned on. 
Fc9-u8-icon.png - BYTE Index
Index of the switch to wait for. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Switch Settings
Fc9-type-16-icon.png Count
The number of LEDs in the array from 1 to 8. 
Fc9-type-16-icon.png 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. 
Fc9-type-19-icon.png Port
 
Fc9-type-16-icon.png Polarity
Active High = LEDs light when the chosen chip pin is ON Active Low = LEDs light when the chosen chip pin is OFF 
Fc9-type-14-icon.png Debounce
Time in milliseconds allowed for the pin to settle following a change of state. 
Fc9-type-16-icon.png Operation
Sets whether switches toggle or are press/release. NB) This option can only be set when the original target includes this option. 
Fc9-conn-icon.png Label
Fc9-type-16-icon.png Component Label
Allows you to add your own label to each switch. If Same as Handle is selected then all custom text will be erased. 
Fc9-type-1-icon.png Label colour
Colour of the port and pin labels 
Fc9-type-7-icon.png Show Connection Label
Enable or disable the pin values underneath each switch  
Fc9-type-7-icon.png Show Pin Value
Enable or disable the pin level (GND or VCC) underneath each switch  
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Switch layout
 
Fc9-type-21-icon.png Distance between switches
Set distance betwwn each switch. Default = 55 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Switch_Array_(Push)_2D_(Switches)&oldid=34533"