View source for Component: Hall Effect Analog (Sensors)

From Flowcode Help

← Component: Hall Effect Analog (Sensors)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| width="50%" |- | width="20%" style="color: gray;" | Author | Matrix Ltd |- | width="20%" style="color: gray;" | Version | 1.1 (Release) |- | width="20%" style="color: gray;" | Category | Sensors |} ==[[File:Component Icon c14492da_a844_40e6_ae29_50e58864b237.png|Image]] Hall Effect Analog component== Simple analogue hall effect triggered by the proximity of another object. ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Downloadable macro reference== ===<span style="font-weight: normal;"><u><tt>ReadProximityByte</tt></u></span>=== 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. '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>ReadProximityFloat</tt></u></span>=== 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. '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|FLOAT]] ===<span style="font-weight: normal;"><u><tt>ReadProximityInt</tt></u></span>=== 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. '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|UINT]] ==Simulation macro reference== ===<span style="font-weight: normal;"><u><tt>SetTarget</tt></u></span>=== 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!! '''Parameters''' :[[Variable Types|HANDLE]] ''Target'' ::The object to test for collision with. '''Return value''' :''This call does not return a value'' ==Property reference== <span style="font-weight: normal;"><u>Analog Pin</u></span> This property is of type ''Single analog pin'' and can be referenced with the variable name ''AnPin''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Polarity</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''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 <span style="font-weight: normal;"><u>VRef voltage</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''adc_base1::vrefvol''. 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 <span style="font-weight: normal;"><u>VRef option</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''adc_base1::vrefop''. 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. <span style="font-weight: normal;"><u>Conversion speed</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''adc_base1::convspd''. 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. <span style="font-weight: normal;"><u>Acquisition cycles</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''adc_base1::actime''. Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. <span style="font-weight: normal;"><u>Magnet Object</u></span> This property is of type ''Panel object'' and can be referenced with the variable name ''target''. Select an object from the panel to act as the magnet that triggers the reed switch. <span style="font-weight: normal;"><u>Range</u></span> This property is of type ''Floating point'' and can be referenced with the variable name ''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. <span style="font-weight: normal;"><u>Timer Interval (ms)</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''timer_int''. Time in milliseconds between testing for proximity. Small time = Greater CPU load Large time = More like to miss activation if it is very brief. <span style="font-weight: normal;"><u>Scope Traces</u></span> This property is of type ''True or false'' and can be referenced with the variable name ''adc_base1::ScopeTraces''. Selects if the scope traces are automatically generated or not

Return to Component: Hall Effect Analog (Sensors).