View source for Component: Switch (Controls)


==Switch component==
A 2d switch component.


==Detailed description==

''No detailed description exists yet for this component''

==Examples==


Here is an example Flowcode program to read the value of a switch.

{{Fcfile|Switch.fcfx|Switch}}

Here is a schematic of how to connect a basic switch to a microcontroller pin.

[[File:switchschematic.jpg]]

The polarity setting in switch properties determines how the corresponding bit in the input variable responds when the switch changes state. 

This applies only when using switch functions and not when using input command icons.


*Active High Polarity

When the switch is closed, the voltage on the pin transitions from 0V to the positive supply voltage (either 3.3V or 5V, depending on the microcontroller).

As a result, the corresponding bit in the input variable changes from 0 to 1.

A pull-down resistor is required to ensure the pin stays at 0V when the switch is open.

If using two resistors (as shown in the image above), they provide protection in case the pin is mistakenly set as an output while the switch is pressed.


*Active Low Polarity

When the switch is closed, the voltage on the pin transitions from the positive supply voltage to 0V.

The corresponding bit in the input variable changes from 0 to 1.

A pull-up resistor is required to ensure the pin stays at the positive supply voltage when the switch is open.

If using two resistors(as shown in the image above), they provide protection if the pin is mistakenly set as an output while the switch is pressed.



There are some differences depending on the type of switch you have, the above states assume a generic push to make type switch, however a push to break type switch would have reversed logic and a toggle switch can work well with either setup.


The resistors are required for correct operation because when a microcontroller's input pin is essentially connected to nothing it will pick up noise in the environment and provide inconsistent readings.

This state is referred to as floating i.e. the pin is floating. To test this remove the resistors (if possible) and touch the unconnected pin with your finger the output LED from the example file above will toggle on and off at high speed.


Any values of resistor can be used but it is important to keep the smaller resistor at least 10X smaller then the larger resistor to ensure that the pressed state provides at least 0.91% of the required pressed state voltage. 

For example a active high switch circuit using 1K and 10K resistors should pull up to about 4.54V when the switch is pressed.

(5V / 11K) * 10K = 4.54545V

==Downloadable macro reference==

{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetState'''
|-
| colspan="2" | Reads the state of the switch (true = on, false = off)&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''
|}


{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetState'''
|-
| colspan="2" | Sets the switch to be on or off.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The new state of the switch (true=on, false=off)&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="mtx-class-macrotable wikitable"
|-
| 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-12-icon.png]]
| width="90%" | State
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections''' 
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations''' 
|-
|}