Component: Hall Effect Analog (Magnetic): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (15 intermediate revisions by 2 users not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_HallEffect_Analog.fcfx FC_Comp_Source_HallEffect_Analog.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_HallEffect_Analog.fcfx FC_Comp_Source_HallEffect_Analog.fcfx] | |||
==Detailed description== | ==Detailed description== | ||
| Line 36: | Line 50: | ||
==Examples== | ==Examples== | ||
| Line 53: | Line 79: | ||
{| class="wikitable | |||
==Macro reference== | |||
===ReadProximityByte=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadProximityByte''' | ||
|- | |- | ||
| colspan="2" | Get the current proximity reading as a digital value from 0 to 255. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | | colspan="2" | Get the current proximity reading as a digital value from 0 to 255. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | ||
| Line 86: | Line 105: | ||
{| class="wikitable | ===ReadProximityFloat=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadProximityFloat''' | ||
|- | |- | ||
| colspan="2" | Get the current proximity as an analogue value from 0.0 to 1.0. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | | colspan="2" | Get the current proximity as an analogue value from 0.0 to 1.0. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | ||
| Line 99: | Line 119: | ||
{| class="wikitable | ===ReadProximityInt=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadProximityInt''' | ||
|- | |- | ||
| colspan="2" | Get the current proximity as a digital value, 10 bit or 12 bit based on your ADC capabilities. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | | colspan="2" | Get the current proximity as a digital value, 10 bit or 12 bit based on your ADC capabilities. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | ||
| Line 112: | Line 133: | ||
===SetTarget=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''SetTarget''' | |||
|- | |||
| colspan="2" | 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!! | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Target | |||
|- | |||
| colspan="2" | The object to test for collision with. | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 136: | Line 174: | ||
| colspan="2" | The 'Polarity' property will affect whether the signal increases of decreases as the proximity increases. Rising - Increases signal as proximity increases Falling - Decreases signal as proximity increases | | colspan="2" | The 'Polarity' property will affect whether the signal increases of decreases as the proximity increases. Rising - Increases signal as proximity increases Falling - Decreases signal as proximity increases | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | ADC Properties | ||
|- | |- | ||
|- | |- | ||
| Line 160: | Line 198: | ||
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. | | colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Magnetic |
Hall Effect Analog component
Simple analogue hall effect triggered by the proximity of another object.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_HallEffect_Analog.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_HallEffect_Analog.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
ReadProximityByte
|
ReadProximityByte |
| Get the current proximity reading as a digital value from 0 to 255. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | |
 - BYTE
|
Return |
ReadProximityFloat
|
|
ReadProximityFloat |
| Get the current proximity as an analogue value from 0.0 to 1.0. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | |
 - FLOAT
|
Return |
ReadProximityInt
|
|
ReadProximityInt |
| Get the current proximity as a digital value, 10 bit or 12 bit based on your ADC capabilities. The 'Polarity' property will affect whether the signal increases or decreases as the proximity increases. | |
 - UINT
|
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 |
Property reference
|
Properties |
|
Connections |
|
Analog Pin |
|
Polarity |
| The 'Polarity' property will affect whether the signal increases of decreases as the proximity increases. Rising - Increases signal as proximity increases Falling - Decreases signal as proximity increases | |
|
|
ADC Properties |
|
VRef voltage |
| Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V | |
|
|
VRef option |
| Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. | |
|
|
Conversion speed |
| Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. | |
|
|
Acquisition cycles |
| Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. | |
|
|
Simulation |
|
Magnet Object |
| Select an object from the panel to act as the magnet that triggers the reed switch. | |
|
Range |
| Distance within which the sensor begins to be activated. NB) This is measured between the centre of the proximity sensor 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. | |
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |