Difference between revisions of "Component: Reed Switch (Magnetic)"

Latest revision as of 13:12, 7 February 2023

Simple on off switch triggered by the proximity of another object.

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

No detailed description exists yet for this component

No additional examples

	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

	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.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Reed_Switch.fcfx FC_Comp_Source_Reed_Switch.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Reed_Switch.fcfx FC_Comp_Source_Reed_Switch.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Reed_Switch.fcfx FC_Comp_Source_Reed_Switch.fcfx]
 ==Detailed description==
@@ Line 30: / Line 40: @@
 ==Examples==
@@ Line 39: / Line 57: @@
 ''<span style="color:red;">No additional examples</span>''
 ==Macro reference==
+===ReadState===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 56: / Line 85: @@
+===SetTarget===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 74: / Line 104: @@
+===WaitUntilHigh===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 87: / Line 118: @@
+===WaitUntilLow===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 98: / Line 130: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}