Difference between revisions of "Component: Reed Switch (Magnetic)"
From Flowcode Help
Jump to navigationJump to search| Line 57: | Line 57: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| + | |||
| + | |||
| Line 63: | Line 65: | ||
==Macro reference== | ==Macro reference== | ||
| + | ===ReadState=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 76: | Line 79: | ||
| + | ===SetTarget=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 94: | Line 98: | ||
| + | ===WaitUntilHigh=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 107: | Line 112: | ||
| + | ===WaitUntilLow=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Revision as of 11:52, 3 February 2023
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | Magnetic |
Contents
Reed Switch component
Simple on off switch triggered by the proximity of another object.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Reed_Switch.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Reed_Switch.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
ReadState
|
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
|
|
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
|
|
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
|
|
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 receive the switch status. | |
|
Polarity |
| Select the pin state that will indicate that an object has been detected. | |
|
|
Simulation |
|
Magnet Object |
| Select an object from the panel to act as the magnet that triggers the reed switch. | |
|
Range |
| Distance within which the switch is activated. NB) This is measured between the centre of the proximity switch and the centre of the target object. | |
|
Timer Interval (ms) |
| Time in milliseconds between testing for proximity. Small time = Greater CPU load Large time = More like to miss activation if it is very brief. | |
