Difference between revisions of "Component: Hall Effect Analog (Magnetic)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_HallEffect_Analog.fcfx FC_Comp_Source_HallEffect_Analog.fcfx]
+
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]
 
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 46: Line 48:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 72: Line 76:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| 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" | [[File:Fc9-type-6-icon.png]]
 +
| width="90%" | Analog Pin
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Polarity
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | ADC Properties
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | VRef voltage
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | VRef option
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Conversion speed
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Acquisition cycles
 +
|-
 +
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 +
| width="90%" | Magnet Object
 +
|-
 +
| colspan="2" | Select an object from the panel to act as the magnet that triggers the reed switch. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Range
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Timer Interval (ms)
 +
|-
 +
| colspan="2" | Time in milliseconds between testing for proximity. Small time = Greater CPU load Large time = More like to miss activation if it is very brief. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Scope Traces
 +
|-
 +
| colspan="2" | Selects if the scope traces are automatically generated or not 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:57, 27 January 2023

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

Fc9-comp-macro.png 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!! 
Fc9-h32-icon.png - HANDLE Target
The object to test for collision with. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-6-icon.png Analog Pin
 
Fc9-type-16-icon.png 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 
Fc9-conn-icon.png ADC Properties
Fc9-type-14-icon.png 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  
Fc9-type-16-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-14-icon.png Acquisition cycles
Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
Fc9-conn-icon.png Simulation
Fc9-type-17-icon.png Magnet Object
Select an object from the panel to act as the magnet that triggers the reed switch. 
Fc9-type-15-icon.png 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. 
Fc9-type-21-icon.png 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. 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 

==Macro reference==

Fc9-comp-macro.png 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!! 
Fc9-h32-icon.png - HANDLE Target
The object to test for collision with. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-6-icon.png Analog Pin
 
Fc9-type-16-icon.png 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 
Fc9-conn-icon.png ADC Properties
Fc9-type-14-icon.png 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  
Fc9-type-16-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-14-icon.png Acquisition cycles
Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
Fc9-conn-icon.png Simulation
Fc9-type-17-icon.png Magnet Object
Select an object from the panel to act as the magnet that triggers the reed switch. 
Fc9-type-15-icon.png 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. 
Fc9-type-21-icon.png 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. 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 

==Macro reference==

Fc9-comp-macro.png 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!! 
Fc9-h32-icon.png - HANDLE Target
The object to test for collision with. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-6-icon.png Analog Pin
 
Fc9-type-16-icon.png 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 
Fc9-conn-icon.png ADC Properties
Fc9-type-14-icon.png 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  
Fc9-type-16-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-14-icon.png Acquisition cycles
Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
Fc9-conn-icon.png Simulation
Fc9-type-17-icon.png Magnet Object
Select an object from the panel to act as the magnet that triggers the reed switch. 
Fc9-type-15-icon.png 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. 
Fc9-type-21-icon.png 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. 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 

==Macro reference==

Fc9-comp-macro.png 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!! 
Fc9-h32-icon.png - HANDLE Target
The object to test for collision with. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-6-icon.png Analog Pin
 
Fc9-type-16-icon.png 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 
Fc9-conn-icon.png ADC Properties
Fc9-type-14-icon.png 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  
Fc9-type-16-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-14-icon.png Acquisition cycles
Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
Fc9-conn-icon.png Simulation
Fc9-type-17-icon.png Magnet Object
Select an object from the panel to act as the magnet that triggers the reed switch. 
Fc9-type-15-icon.png 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. 
Fc9-type-21-icon.png 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. 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Hall_Effect_Analog_(Magnetic)&oldid=34257"