Component: Switch Push Button (Switch)

From Flowcode Help
Jump to navigationJump to search
Author Matrix TSL
Version 20.0
Category Switch


Switch Push Button component

A simple digital push switch allowing latched and none latched operation. In embedded mode displays the connecting pin and pin status.

Version information

Library Version, Component Version, Date, Author, Info
15, 15.0, 30-07-24, MW, Fixed a bug to make sure switch starts in the off position
17, 17.0, 16-04-25, MW, Fixed a bug that made boundary height too large
17, 17.0, 16-04-25, MW, Fixed a bug where Pin x and  y lables remained visisble when supposed to be hidden
17, 17.0, 16-04-25, MW, Fixed a bug when sim stopped Switch changed from on to off, but pin remained at VCC
18, 18.0, 01-05-25, MW, Adjusted pin and component labels and bounds to decrease overall bounds size
18, 18.0, 01-05-25, MW, Changed labels so don't interact and change switch state
19, 19.0, 01-05-25, BR, Added option to hide label
19, 19.0, 01-05-25, BR, Fixed SameAsHandle label to update on rename event
20, 0.0, 14-05-25, MW, Changed Switch properties, so it does not grey out

Detailed description

No detailed description exists yet for this component

Examples

Here is an example Flowcode program to read the value of a switch. FC6 Icon.png Switch

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

Switchschematic.jpg

The active high circuit will pass a logical 0 to the input pin when the switch is not pressed and a logical 1 when the switch is pressed.

The active low circuit will pass a logical 1 to the input pin when the switch is not pressed and a logical 0 when 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

Note: if you want to use switch functions e.g. Active Low or debounce ,you must use the ReadState function and not use just an input.

Macro reference

ReadState

Fc9-comp-macro.png ReadState
Reads the button state as 0 for released or 1 for pressed Performs debounce if required 
Fc9-u8-icon.png - BYTE Return


SetState

Fc9-comp-macro.png SetState
Sets the switch to be on or off. 
Fc9-bool-icon.png - BOOL State
The new state of the switch (true=on, false=off) 
Fc9-void-icon.png - VOID Return


WaitUntilHigh

Fc9-comp-macro.png WaitUntilHigh
Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity 
Fc9-void-icon.png - VOID Return


WaitUntilLow

Fc9-comp-macro.png WaitUntilLow
Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Function
Fc9-type-7-icon.png Simulation Only
 
Fc9-conn-icon.png Switch Settings
Fc9-type-5-icon.png Connection
The chip pin to which the switch connects. 
Fc9-type-16-icon.png Polarity
Set the polarity of states sent to the chip pin. 'Active High' -> Pressed = Set, Released = Clear 'Active Low' -> Pressed = Clear, Released = Set 
Fc9-type-14-icon.png Debounce
Sets the time in milliseconds to allow a pin change to settle into a stable state. NB) Debouncing is only used when reading the button state using the component macros. Chip pins are NOT debounced. 
Fc9-type-7-icon.png Latching
Determines if the simulated switch maintains its state or revers back to the default state when not clicked. 
Fc9-conn-icon.png Label
Fc9-type-16-icon.png Component Label
 
Fc9-type-16-icon.png Component label position
 
Fc9-type-2-icon.png Label Colour
 
Fc9-type-7-icon.png Show Connection Label
 
Fc9-type-7-icon.png Show Pin Value
 
Fc9-type-16-icon.png Pin label position
 
Fc9-conn-icon.png Appearance
Fc9-type-16-icon.png Style
 
Fc9-type-12-icon.png Type
 
Fc9-type-10-icon.png On Label
 
Fc9-type-10-icon.png Off Label
 

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Switch_Push_Button_2dgi.fcfx

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