Difference between revisions of "Component: Switch (Microswitch) (Switch)"
From Flowcode Help
Jump to navigationJump to search (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray...") |
|||
| Line 15: | Line 15: | ||
Industry standard V3 size microswitch fitter with a roller arm - activated by other panel objects coming into contact with the roller. Changes the state of a chip pin, and sends a simulation notification message when its state changes. | Industry standard V3 size microswitch fitter with a roller arm - activated by other panel objects coming into contact with the roller. Changes the state of a chip pin, and sends a simulation notification message when its state changes. | ||
| − | ==Component | + | ==Component Source Code== |
| − | + | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_sw_micro_roller.fcfx FC_Comp_Source_sw_micro_roller.fcfx] | |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| Line 96: | Line 100: | ||
|- | |- | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |
| − | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | |
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="background-color:# | ||
| − | | width="90%" style="background-color:# | ||
|- | |- | ||
|- | |- | ||
| Line 115: | Line 114: | ||
| colspan="2" | The state that the pin should take when the switch is pressed. | | colspan="2" | The state that the pin should take when the switch is pressed. | ||
|- | |- | ||
| − | | width="10%" align="center" style="background-color:# | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" style="background-color:# | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation |
|- | |- | ||
|- | |- | ||
| Line 128: | Line 127: | ||
|- | |- | ||
| colspan="2" | Time in milliseconds between collision scans. Small time = Greater CPU load Large time = More like to miss brief collisions. | | colspan="2" | Time in milliseconds between collision scans. Small time = Greater CPU load Large time = More like to miss brief collisions. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Notification | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Notify | ||
| + | |- | ||
| + | | colspan="2" | Whether to send a notification event to the component's parent. When enabled, set a message ID below to aid identification of events. Data will be one or zero, representing the microswitch state. | ||
|} | |} | ||
Revision as of 17:54, 9 November 2022
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | Switch |
Contents
Switch (Microswitch) component
Industry standard V3 size microswitch fitter with a roller arm - activated by other panel objects coming into contact with the roller. Changes the state of a chip pin, and sends a simulation notification message when its state changes.
Component Source Code
Please click here for the component source code: FC_Comp_Source_sw_micro_roller.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
ReadState |
| Get the current collision state. The 'Polarity' property will affect whether a collision is represented by a high or low state. | |
 - BYTE
|
Return |
|
|
SetTarget |
| Set the object that you want to test for collision with. If this is not called, or is called with handle = 0, collisions will be tested against every panel object that has 'Solid' status. NB) Specifying an object will save CPU power!! | |
 - HANDLE
|
Target |
| The object to test for collision with. | |
 - VOID
|
Return |
|
|
WaitUntilHigh |
| Pause the program until the detector goes high. 'Polarity' will affect whether high value represents a collision or separation. NB) In simulation, only use this macro if testing for collision with animated or timer driven objects!! | |
| - VOID
|
Return |
|
|
WaitUntilLow |
| Pause the program until the detector goes low. 'Polarity' will affect whether low value represents a collision or separation. NB) In simulation, only use this macro if testing for collision with animated or timer driven objects!! | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Connections |
|
Pin |
| The chip pin that will change state when the switch is activated. | |
|
Polarity |
| The state that the pin should take when the switch is pressed. | |
|
|
Simulation |
|
Target Object |
| Choose a specific other object to test for collision with. If left unconnected, the test object will be tested against every object on the panel. Choose a specific object to check against wherever possible - checking all objects requires much more time and computing power! | |
|
Timer Interval (ms) |
| Time in milliseconds between collision scans. Small time = Greater CPU load Large time = More like to miss brief collisions. | |
|
|
Notification |
|
Notify |
| Whether to send a notification event to the component's parent. When enabled, set a message ID below to aid identification of events. Data will be one or zero, representing the microswitch state. | |
