Difference between revisions of "Component: Rotary Switch (Switch)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(11 intermediate revisions by the same user 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 TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Switch
 
| Switch
 
|}
 
|}
  
  
 +
==Rotary Switch component==
 +
A standard rotary switch with 4 digital outputs and 10 or 16 discrete positions.
 +
 +
==Component Source Code==
  
==[[File:Component Icon 9306f758_06af_49f8_8b09_d10d2b4374dd.png|Image]] Rotary Switch component==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_RotarySwitch10-16.fcfx FC_Comp_Source_RotarySwitch10-16.fcfx]
A standard rotary switch with 4 digital outputs and 10 or 16 discrete positions.
 
  
==Examples==
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_RotarySwitch10-16.fcfx FC_Comp_Source_RotarySwitch10-16.fcfx]
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
==Downloadable macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>GetPosition</tt></u></span>===
 
Reads the current position of the rotary switch.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
  
==Simulation macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>SetPosition</tt></u></span>===
 
Sets the current position of the rotary switch.
 
  
'''Parameters'''
 
  
:[[Variable Types|BYTE]] ''Position''
 
  
  
'''Return value'''
+
''No detailed description exists yet for this component''
  
:''This call does not return a value''
+
==Examples==
  
  
  
  
==Property reference==
 
<span style="font-weight: normal;"><u>Num Positions</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumPositions''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
  
<span style="font-weight: normal;"><u>Common Type</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Common''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
  
<span style="font-weight: normal;"><u>Pin 1</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin1''.
 
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''
  
  
  
<span style="font-weight: normal;"><u>Pin 2</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin2''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
  
<span style="font-weight: normal;"><u>Pin 4</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin4''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
 +
==Macro reference==
  
<span style="font-weight: normal;"><u>Pin 8</u></span>
+
===GetPosition===
 +
{| 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;" | '''GetPosition'''
 +
|-
 +
| colspan="2" | Reads the current position of the rotary 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''
 +
|}
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin8''.
 
  
''<span style="color:red;">No additional information</span>''
+
===SetPosition===
 +
{| 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;" | '''SetPosition'''
 +
|-
 +
| colspan="2" | Sets the current position of the rotary switch.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Position
 +
|-
 +
| colspan="2" | &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''
 +
|}
 +
 
 +
 
 +
==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" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Num Positions
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Common Type
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pins
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Pin 1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Pin 2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Pin 4
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Pin 8
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:12, 7 February 2023

Author Matrix TSL
Version 1.0
Category Switch


Rotary Switch component

A standard rotary switch with 4 digital outputs and 10 or 16 discrete positions.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_RotarySwitch10-16.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_RotarySwitch10-16.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

GetPosition

Fc9-comp-macro.png GetPosition
Reads the current position of the rotary switch. 
Fc9-u8-icon.png - BYTE Return


SetPosition

Fc9-comp-macro.png SetPosition
Sets the current position of the rotary switch. 
Fc9-u8-icon.png - BYTE Position
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Num Positions
 
Fc9-type-16-icon.png Common Type
 
Fc9-conn-icon.png Pins
Fc9-type-5-icon.png Pin 1
 
Fc9-type-5-icon.png Pin 2
 
Fc9-type-5-icon.png Pin 4
 
Fc9-type-5-icon.png Pin 8