View source for Component: Switch User Images (Switch)

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 7.0
|-
| width="20%" style="color:gray;" | Category
| Switch
|}


==Switch User Images component==
A simple digital push switch allowing latched and none latched operation. In embedded mode displays the connecting pin and pin status. The on and off states of the switch are shown using user supplied images allowing customised switches to be created.

==Version information==

 Library Version, Component Version, Date, Author, Info
 5, 5.0, 23-09-24, MW, Fixed a bug to  make sure switch starts in the off position
 5, 5.0, 23-09-24, MW, Added option for simulation only
 5, 5.0, 23-09-24, MW, Fixed a bug preventing custom lable posistion from updating on the fly
 5, 5.0, 23-09-24, MW, Fixed connection lable so show correct polariy within array
 5, 5.0, 15-04-25, MW, Modified switch to show correct value for off when stating and stopping simulation
 5, 5.0, 16-04-25, MW, Fixed a bug where Pin x and  y lables remained visisble when supposed to be hidden
 5, 5.0, 01-05-25, MW, Adjusted pin and component labels and bounds to decrease overall bounds size
 5, 5.0, 01-05-25, MW, Changed labels so don't interact and change switch state
 5, 5.0, 01-05-25, MW, Corrected pin label properties
 5, 5.0, 01-05-25, MW, Added option to hide label
 5, 5.0, 01-05-25, MW, Fixed SameAsHandle label to update on rename event
 6, 0.0, 01-05-25, MW, Changed switch properties to stop greying out
 7, 7.0, 10-03-26, ST, Updated for v11.0.1 mouse event change

==Detailed description==













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

==Examples==













''<span style="color:red;">No additional examples</span>''











==Macro reference==

===ReadState===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadState'''
|-
| colspan="2" | Reads the button state as 0 for released or 1 for pressed Performs debounce if required&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''
|}


===SetState===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetState'''
|-
| colspan="2" | Sets the switch to be on or off.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | State
|-
| 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''
|}


===WaitUntilHigh===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''WaitUntilHigh'''
|-
| colspan="2" | Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity&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''
|}


===WaitUntilLow===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''WaitUntilLow'''
|-
| colspan="2" | Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity&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" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" class="mtx-class-macrohead" | '''Properties''' 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Function
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulation Only
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Switch Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Connection
|-
| colspan="2" | The chip pin to which the switch connects.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Polarity
|-
| colspan="2" | Set the polarity of states sent to the chip pin. 'Active High' -> Pressed = Set, Released = Clear 'Active Low' -> Pressed = Clear, Released = Set&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Debounce
|-
| colspan="2" | 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.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Latching
|-
| colspan="2" | Determines if the simulated switch maintains its state or revers back to the default state when not clicked.&nbsp;
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Component Label
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Component label position
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Label Colour
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Connection Label
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Pin Value
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Pin label position
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Images
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Image On
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
| width="90%" | FilenameOn
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Image Off
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
| width="90%" | FilenameOff
|-
| colspan="2" | &nbsp;
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Switch_User_Images_2dgi.fcfx FC_Comp_Source_Switch_User_Images_2dgi.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Switch_User_Images_2dgi.fcfx FC_Comp_Source_Switch_User_Images_2dgi.fcfx]