Difference between revisions of "Component: Temperature Infrared (Grove 101020062) (Environmental)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Environmental
 
| Environmental
 
|}
 
|}
 +
 +
 +
==Temperature Infrared (Grove 101020062) component==
 +
The Grove Infrared Temperature Sensor allows none contact measurement of temperatures ranging from -10 to 100 degrees C.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GroveIRTemp.fcfx FC_Comp_Source_GroveIRTemp.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_GroveIRTemp.fcfx FC_Comp_Source_GroveIRTemp.fcfx]
 +
 +
==Detailed description==
 +
 +
 +
 +
  
  
  
−
==[[File:Component Icon 05acf53c_0b2e_4d26_8d5d_f112d4ce4c68.png|Image]] Temperature Infrared (Grove 101020062) component==
 
−
The Grove Infrared Temperature Sensor allows none contact measurement of temperatures
 
−
ranging from -10 to 100 degrees C.
 
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>MeasureSurTemp</tt></u></span>===
 
−
Measures the surrounding ambient temperature,
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>MeasureObjectTemp</tt></u></span>===
 
−
Measures the temperature of the targetted object
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Ambient Pin (SUR)</u></span>
 
  
−
This property is of type ''Single analog pin'' and can be referenced with the variable name ''resADC::channel''.
 
  
−
Analogue input channel - which pin is the analogue input conected to?
 
  
−
<span style="font-weight: normal;"><u>Object Pin (OBJ)</u></span>
 
  
−
This property is of type ''Single analog pin'' and can be referenced with the variable name ''objADC::channel''.
 
  
−
Analogue input channel - which pin is the analogue input conected to?
 
  
−
<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 ''resADC::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 ''resADC::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 ''resADC::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.
+
''<span style="color:red;">No additional examples</span>''
  
−
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 ''resADC::actime''.
 
  
−
Number of micro seconds to wait for the ACD input to charge before starting the analogue sample.
 
  
−
<span style="font-weight: normal;"><u>Temperature Calibration</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''TempCalib''.
 
  
−
Ambient temperature calibration value
 
  
−
<span style="font-weight: normal;"><u>Temperature Range</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''TempRange''.
 
  
−
Map of temperature-voltage according to sensor datasheet.
 
  
−
10 is the temperature step when sensor and object distance is 9CM.
 
  
−
<span style="font-weight: normal;"><u>Offset Voltage</u></span>
+
==Macro reference==
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''OffsetVoltage''.
+
===MeasureObjectTemp===
 +
{| 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;" | '''MeasureObjectTemp'''
 +
|-
 +
| colspan="2" | Measures the temperature of the targetted object&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
Voltage of mid level voltage after 5-10 mins to bring the sensor to ambient.
 
  
−
<span style="font-weight: normal;"><u>Number of Samples</u></span>
+
===MeasureSurTemp===
 +
{| 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;" | '''MeasureSurTemp'''
 +
|-
 +
| colspan="2" | Measures the surrounding ambient temperature,&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumSamples''.
 
  
−
Number of samples to take to average out each reading.
+
==Property reference==
  
−
Default 10.
+
{| 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" | [[File:Fc9-type-6-icon.png]]
 +
| width="90%" | Ambient Pin (SUR)
 +
|-
 +
| colspan="2" | Analogue input channel - which pin is the analogue input conected to?&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
 +
| width="90%" | Object Pin (OBJ)
 +
|-
 +
| colspan="2" | Analogue input channel - which pin is the analogue input conected to?&nbsp;
 +
|-
 +
| 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 &nbsp;
 +
|-
 +
| 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. &nbsp;
 +
|-
 +
| 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. &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Acquisition cycles
 +
|-
 +
| colspan="2" | Number of micro seconds to wait for the ACD input to charge before starting the analogue sample.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced Settings
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Temperature Calibration
 +
|-
 +
| colspan="2" | Ambient temperature calibration value&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Temperature Range
 +
|-
 +
| colspan="2" | Map of temperature-voltage according to sensor datasheet.  10 is the temperature step when sensor and object distance is 9CM.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Offset Voltage
 +
|-
 +
| colspan="2" | Voltage of mid level voltage after 5-10 mins to bring the sensor to ambient.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Number of Samples
 +
|-
 +
| colspan="2" | Number of samples to take to average out each reading. Default 10.&nbsp;
 +
|}

Latest revision as of 13:10, 7 February 2023

Author Matrix TSL
Version 1.2
Category Environmental


Temperature Infrared (Grove 101020062) component

The Grove Infrared Temperature Sensor allows none contact measurement of temperatures ranging from -10 to 100 degrees C.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_GroveIRTemp.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_GroveIRTemp.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

MeasureObjectTemp

Fc9-comp-macro.png MeasureObjectTemp
Measures the temperature of the targetted object 
Fc9-f32-icon.png - FLOAT Return


MeasureSurTemp

Fc9-comp-macro.png MeasureSurTemp
Measures the surrounding ambient temperature, 
Fc9-f32-icon.png - FLOAT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-6-icon.png Ambient Pin (SUR)
Analogue input channel - which pin is the analogue input conected to? 
Fc9-type-6-icon.png Object Pin (OBJ)
Analogue input channel - which pin is the analogue input conected to? 
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 ACD input to charge before starting the analogue sample. 
Fc9-conn-icon.png Advanced Settings
Fc9-type-15-icon.png Temperature Calibration
Ambient temperature calibration value 
Fc9-type-15-icon.png Temperature Range
Map of temperature-voltage according to sensor datasheet. 10 is the temperature step when sensor and object distance is 9CM. 
Fc9-type-15-icon.png Offset Voltage
Voltage of mid level voltage after 5-10 mins to bring the sensor to ambient. 
Fc9-type-21-icon.png Number of Samples
Number of samples to take to average out each reading. Default 10. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Temperature_Infrared_(Grove_101020062)_(Environmental)&oldid=38057"