Component: Switch User Images (Switch)

Author	Matrix TSL
Version	6.0
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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ReadState

	ReadState
Reads the button state as 0 for released or 1 for pressed Performs debounce if required
- BYTE	Return

SetState

	SetState
Sets the switch to be on or off.
- BOOL	State
The new state of the switch (true=on, false=off)
- VOID	Return

WaitUntilHigh

	WaitUntilHigh
Waits until the switch is in state 'high' The interpretation of 'high' depends on the polarity
- VOID	Return

WaitUntilLow

	WaitUntilLow
Waits until the switch is in state 'low' The interpretation of 'high' depends on the polarity
- VOID	Return

Property reference

	Properties
	Function
	Simulation Only

	Switch Settings
	Connection
The chip pin to which the switch connects.
	Polarity
Set the polarity of states sent to the chip pin. 'Active High' -> Pressed = Set, Released = Clear 'Active Low' -> Pressed = Clear, Released = Set
	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.
	Latching
Determines if the simulated switch maintains its state or revers back to the default state when not clicked.
	Label
	Component Label

	Component label position

	Label Colour

	Show Connection Label

	Show Pin Value

	Pin label position

	Images
	Image On

	FilenameOn

	Image Off

	FilenameOff