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

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;...")
 
 
(8 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Switch_Array_Slide_2dgi.fcfx FC_Comp_Source_Switch_Array_Slide_2dgi.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Switch_Array_Slide_2dgi.fcfx FC_Comp_Source_Switch_Array_Slide_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_Slide_2dgi.fcfx FC_Comp_Source_Switch_Array_Slide_2dgi.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
''No detailed description exists yet for this component''
 
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
−
==Downloadable macro reference==
 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===GetHandle===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadState'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHandle'''
 
|-
 
|-
−
| colspan="2" | Read the state of the switch at the given index.&nbsp;
+
| colspan="2" | Retrieves the object handle of the switch component at the given index.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 40: Line 73:
 
| width="90%" | Index
 
| width="90%" | Index
 
|-
 
|-
−
| colspan="2" | The switch to read the status of.&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===ReadAll===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitUntilHigh'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAll'''
 
|-
 
|-
−
| colspan="2" | Pause the program until the switch at the given index is turned on.&nbsp;
+
| colspan="2" | Reads all of the switches at once, returning a byte containing one bit per switch.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===ReadState===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAll'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadState'''
 +
|-
 +
| colspan="2" | Read the state of the switch at the given index.&nbsp;
 +
|-
 
|-
 
|-
−
| colspan="2" | Reads all of the switches at once, returning a byte containing one bit per switch.&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-u8-icon.png]] - BYTE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===WaitUntilHigh===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHandle'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitUntilHigh'''
 
|-
 
|-
−
| colspan="2" | Retrieves the object handle of the switch component at the given index.&nbsp;
+
| colspan="2" | Pause the program until the switch at the given index is turned on.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 89: Line 125:
 
| width="90%" | Index
 
| width="90%" | Index
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | Index of the switch to wait for.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===WaitUntilLow===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 112: Line 149:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 13:12, 7 February 2023

Author MatrixTSL
Version 1.0
Category Switches


Switch Array (Slide) 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_Slide_2dgi.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

GetHandle

Fc9-comp-macro.png GetHandle
Retrieves the object handle of the switch component at the given index. 
Fc9-u8-icon.png - BYTE Index
 
Fc9-h32-icon.png - HANDLE Return


ReadAll

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


ReadState

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


WaitUntilHigh

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


WaitUntilLow

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 = 50 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Switch_Array_(Slide)_2D_(Switches)&oldid=38341"