Difference between revisions of "Component: Switch base (Inputs)"

From Flowcode Help
Jump to navigationJump to search
(XML import of component help)
(XML import of only descriptive example files)
Line 28: Line 28:
 
{| class="wikitable" width="50%"
 
{| class="wikitable" width="50%"
 
|+|-
 
|+|-
−
|[[File:Component Icon c6c91999_1fe0_414e_b6aa_0a7ddc9a6417.png|Image]] Toggle Metal PCB
+
|[[File:Component Icon a31b1f0a_4221_490d_ae25_027868688f0b.png|Image]] Basic Switch
−
|Miniature toggle switch with metal tang. Pins for PCB mounting.
+
|Simple push button switch with LED indicator.
 +
Momentary or latching action can be chosen in the properties.
 +
|-
 +
|[[File:Component Icon aba70ed4_4d0c_47e1_90c7_bfda5262eec3.png|Image]] Dashboard Button
 +
|Simple momentary push-button using the Matrix dashboard theme.
 +
|-
 +
|[[File:Component Icon ddad9cb9_122d_4f29_aaa9_233d3a967ca8.png|Image]] Dashboard Switch
 +
|Simple latching slide switch using the default Matrix dashboard theme.
 +
|-
 +
|[[File:Component Icon fc04a65f_f03d_40c8_9f69_0d23d2daac29.png|Image]] PCB Switch
 +
|Simple tactile PCB switch for PCB mounting.  Approx. 12 * 12mm.
 +
Color and operation can be set from properties.
 
|-
 
|-
 
|[[File:Component Icon 26732594_ad79_472f_80ff_95d365b3b252.png|Image]] Push Click PCB
 
|[[File:Component Icon 26732594_ad79_472f_80ff_95d365b3b252.png|Image]] Push Click PCB
 
|Surface mount click switch, standard 6mm square size.
 
|Surface mount click switch, standard 6mm square size.
 +
|-
 +
|[[File:Component Icon 5c1da48f_ce54_4622_bdd9_fc812e373696.png|Image]] Push Round Panel
 +
|Large round push switchwith chrome bezel  for panel mounting.
 
|-
 
|-
 
|[[File:Component Icon 42cb88b2_e965_4a49_893c_64eb001fc861.png|Image]] Rocker Neon
 
|[[File:Component Icon 42cb88b2_e965_4a49_893c_64eb001fc861.png|Image]] Rocker Neon
 
|Rocker switch with indicator lamp and properties for changing the colours of each part.
 
|Rocker switch with indicator lamp and properties for changing the colours of each part.
−
|-
 
−
|[[File:Component Icon ddad9cb9_122d_4f29_aaa9_233d3a967ca8.png|Image]] Dashboard Switch
 
−
|Simple latching slide switch using the default Matrix dashboard theme.
 
 
|-
 
|-
 
|[[File:Component Icon 7a287a58_cba5_42ad_b8a5_58694d7f678a.png|Image]] Slide PCB Submin
 
|[[File:Component Icon 7a287a58_cba5_42ad_b8a5_58694d7f678a.png|Image]] Slide PCB Submin
 
|Subminiature slide switch with black tang, PCB mount.
 
|Subminiature slide switch with black tang, PCB mount.
 
|-
 
|-
−
|[[File:Component Icon 5c1da48f_ce54_4622_bdd9_fc812e373696.png|Image]] Push Round Panel
+
|[[File:Component Icon c6c91999_1fe0_414e_b6aa_0a7ddc9a6417.png|Image]] Toggle Metal PCB
−
|Large round push switchwith chrome bezel for panel mounting.
+
|Miniature toggle switch with metal tang. Pins for PCB mounting.
−
|-
 
−
|[[File:Component Icon aba70ed4_4d0c_47e1_90c7_bfda5262eec3.png|Image]] Dashboard Button
 
−
|Simple momentary push-button using the Matrix dashboard theme.
 
 
|-
 
|-
 
|[[File:Component Icon e8f04af0_03d9_4b1c_83d3_9d0b1dc0f80a.png|Image]] Toggle Metal Panel
 
|[[File:Component Icon e8f04af0_03d9_4b1c_83d3_9d0b1dc0f80a.png|Image]] Toggle Metal Panel
 
|Miniature toggle switch with metal tamg - solder lugs and nut for panel mounting.
 
|Miniature toggle switch with metal tamg - solder lugs and nut for panel mounting.
−
|-
 
−
|[[File:Component Icon fc04a65f_f03d_40c8_9f69_0d23d2daac29.png|Image]] PCB Switch
 
−
|Simple tactile PCB switch for PCB mounting.  Approx. 12 * 12mm.
 
−
Color and operation can be set from properties.
 
−
|-
 
−
|[[File:Component Icon a31b1f0a_4221_490d_ae25_027868688f0b.png|Image]] Basic Switch
 
−
|Simple push button switch with LED indicator.
 
−
Momentary or latching action can be chosen in the properties.
 
 
|}
 
|}
  
 
==Examples==
 
==Examples==
−
The following files provide examples of how to use this component:
+
''<span style="color:red;">No additional examples</span>''
−
 
 
−
[[Media:Example_Switch Array TEST.fcfx|Switch Array TEST.fcfx]]
 
−
 
 
−
[[Media:Example_Simple Motor TEST.fcfx|Simple Motor TEST.fcfx]]
 
  
−
[[Media:Example_Collision Detector Test.fcfx|Collision Detector Test.fcfx]]
 
  
 
==Downloadable macro reference==
 
==Downloadable macro reference==

Revision as of 15:18, 12 November 2013


Author Matrix Ltd
Version 1.1
Category Inputs


Image Switch base component

Base single pin switch with no graphical interface Suitable for building your own switches with custom graphics. If the parent component has properties 'pin', 'polarity', 'debounce' and/or 'operation', they will automatically be forwarded to the base component.


This component can be used as a base to create child components

The following components all inherit the traits of Switch base:

-
Image Basic Switch Simple push button switch with LED indicator.

Momentary or latching action can be chosen in the properties.

Image Dashboard Button Simple momentary push-button using the Matrix dashboard theme.
Image Dashboard Switch Simple latching slide switch using the default Matrix dashboard theme.
Image PCB Switch Simple tactile PCB switch for PCB mounting. Approx. 12 * 12mm.

Color and operation can be set from properties.

Image Push Click PCB Surface mount click switch, standard 6mm square size.
Image Push Round Panel Large round push switchwith chrome bezel for panel mounting.
Image Rocker Neon Rocker switch with indicator lamp and properties for changing the colours of each part.
Image Slide PCB Submin Subminiature slide switch with black tang, PCB mount.
Image Toggle Metal PCB Miniature toggle switch with metal tang. Pins for PCB mounting.
Image Toggle Metal Panel Miniature toggle switch with metal tamg - solder lugs and nut for panel mounting.

Examples

No additional examples


Downloadable macro reference

ReadState

Reads the button state as 0 for released or 1 for pressed

Performs debounce if required

Parameters

This macro has no parameters


Return value

BYTE


WaitUntilHigh

Waits until the switch is in state 'high'

The interpretation of 'high' depends on the polarity

Parameters

This macro has no parameters


Return value

This call does not return a value


WaitUntilLow

Waits until the switch is in state 'low'

The interpretation of 'high' depends on the polarity

Parameters

This macro has no parameters


Return value

This call does not return a value


Simulation macro reference

This component does not contain any simulation macros


Property reference

Connection

This property is of type Single digital pin and can be referenced with the variable name pin.

The chip pin to which the switch connects.

Polarity

This property is of type Fixed list of ints and can be referenced with the variable name polarity.

Set the polarity of states sent to the chip pin.

'Active High' -> Pressed = On, Released = Off

'Active Low' -> Pressed = Off, Released = On

Debounce (ms)

This property is of type Signed integer and can be referenced with the variable name 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.

Moving part

This property is of type Panel object and can be referenced with the variable name target.

Sets a panel object or group to be the moving part of the switch model.

Make sure that the object is in the 'Off' position at the time of linking.

Pivot object

This property is of type Panel object and can be referenced with the variable name pivot.

When using the 'Rotary' switch type, the 'Moving part' will rotate about the object set here.

The moving part will rotate around its own axes if this property is left 'Unconnected'.

Type

This property is of type Fixed list of ints and can be referenced with the variable name movetype.

Sets whether the motion of the 'Moving part' will be 'Push/Slide' (linear motion) or

'Rotary' (e.g. toggle switches).

Operation

This property is of type Fixed list of ints and can be referenced with the variable name operation.

'Latching' = click to trun on, click again to turn off.

'Momentary' = click to turn on, release to turn off.

Axis

This property is of type Fixed list of ints and can be referenced with the variable name axis.

For 'Push/Slide' switches, the axis that the 'Moving part' will move along.

For 'Rotary' switches, the axis around which 'Moving part' will rotate.

Movement

This property is of type Floating point and can be referenced with the variable name move.

For 'Push/Slide' switches, the distance (in local units) to move along the axis.

For 'Rotary' switches, the angle (in degrees) to rotate around the axis.

Notify on change

This property is of type True or false and can be referenced with the variable name notify.

When enabled, a 'System.User' event will be sent for each change of switch state.

The event is sent to the 'parent' component in which this 'Swict base' instance is used.

Retrieved from "https://www.matrixtsl.com/wikiv6/index.php?title=Component:_Switch_base_(Inputs)&oldid=12948"