Difference between revisions of "Component: Thermistor Template (Sensors)"

From Flowcode Help
Jump to navigationJump to search
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix
 
| Matrix
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 2.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Sensors
 
| Sensors
 
|}
 
|}
  
  
 +
==Thermistor Template component==
 +
Base component for creating thermistors.  Has no GUI - this would be added by concrete examples using this basem which may or may not expose the propertes.
  
−
==[[File:Component Icon bd7d5205_c2eb_48b1_8a37_f967f349965f.png|Image]] Thermistor Template component==
+
==Version information==
−
Base component for creating thermistors.  Has no GUI - this would be added by concrete
 
−
examples using this basem which may or may not expose the propertes.
 
  
−
This component can be used as a base to create ''child'' components
+
Library Version, Component Version, Date, Author, Info
 +
5, 2.0, 19-07-24, BR, Added compatibility for external ADC
 +
5, 2.0, 19-07-24, BR, Allowed full bit depth usage of the internal ADC
  
−
[[File:Component Icon 2f3dd5e3_b652_4045_9ab9_10d49440e5cd.png|Image]] The component [[Component: ID 2f3dd5e3_b652_4045_9ab9_10d49440e5cd|Thermistor]] is inherited from this.
+
==Detailed description==
  
−
==Examples==
 
−
This example simply reads the value from the thermistor sensor component and outputs the value to an LCD as a temperature in degrees C.
 
  
−
{{Fcfile|EBM003 - Test Program.fcfx|EBM003 Example}}
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetIntegerTemperature</tt></u></span>===
 
−
Reads the ADC input and returns the calculated Temperature as Integer degrees C
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|INT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetRealTemperature</tt></u></span>===
 
−
Reads the ADC input and Returns the calculated Temperature as Float value in degrees C
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>CalculateTemperature</tt></u></span>===
 
−
Converts the input ADC value and returns the Temperature in tenths of degree C
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''ADCValue''
 
−
::ADC Reading to be converted
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|INT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetADCValue</tt></u></span>===
 
−
Returns the Raw ADC value from the Analogue Channel
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|UINT]]
 
  
 +
This example simply reads the value from the thermistor sensor component and outputs the value to an LCD as a temperature in degrees C.
 +
{{Fcfile|EBM003 - Test Program.fcfx|EBM003 Example}}
  
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>SetChannel</tt></u></span>===
 
−
Set the ADC Channel
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|INT]] ''ChannelID''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetTemperature</tt></u></span>===
 
−
Simulation macro that sets the internal ADC value to the appropriate value for a given temperature.  This allows all internal systems of the sensor to be simulated.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Temperature''
 
−
::The temperature in C - restricted to -25 to +125 range
 
  
 +
==Macro reference==
  
−
'''Return value'''
+
===CalculateTemperature===
 +
{| 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;" | '''CalculateTemperature'''
 +
|-
 +
| colspan="2" | Converts the input ADC value and returns the Temperature in tenths of degree C&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | ADCValue
 +
|-
 +
| colspan="2" | ADC Reading to be converted&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:''This call does not return a value''
 
  
 +
===GetADCValue===
 +
{| 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;" | '''GetADCValue'''
 +
|-
 +
| colspan="2" | Returns the Raw ADC value from the Analogue Channel&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
  
 +
===GetIntegerTemperature===
 +
{| 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;" | '''GetIntegerTemperature'''
 +
|-
 +
| colspan="2" | Reads the ADC input and returns the calculated Temperature as Integer degrees C&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>ADC Channel</u></span>
 
  
−
This property is of type ''Single analog pin'' and can be referenced with the variable name ''CHANNEL''.
+
===GetRealTemperature===
 +
{| 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;" | '''GetRealTemperature'''
 +
|-
 +
| colspan="2" | Reads the ADC input and Returns the calculated Temperature as Float value in degrees C&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''
 +
|}
  
−
The ADC channel to which the thermistor circuit is connected.
 
  
−
It is assumed that the thermistor is connected between the ADC pin and 0V, with a fixed resistor connected
+
===SetADCValue===
 +
{| 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;" | '''SetADCValue'''
 +
|-
 +
| colspan="2" | Used to set the ADC value when an external ADC is being used.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | AdcValue
 +
|-
 +
| colspan="2" | Value of the external ADC. e.g. 0-255 for an 8-bit ADC&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
between the ADC pin and +V.
 
  
−
<span style="font-weight: normal;"><u>ADC Bit Resolution</u></span>
+
===SetChannel===
 +
{| 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;" | '''SetChannel'''
 +
|-
 +
| colspan="2" | Set the ADC Channel&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | ChannelID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ADC_BITS''.
 
  
−
''<span style="color:red;">No additional information</span>''
+
===SetTemperature===
 +
{| 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;" | '''SetTemperature'''
 +
|-
 +
| colspan="2" | Simulation macro that sets the internal ADC value to the appropriate value for a given temperature.  This allows all internal systems of the sensor to be simulated.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Temperature
 +
|-
 +
| colspan="2" | The temperature in C - restricted to -25 to +125 range&nbsp;
 +
|-
 +
| 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==
  
−
<span style="font-weight: normal;"><u>Resistor Value</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RESISTOR''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Value in Ohms of the pullup series resistor.  i.e. The resistor is connected between the ADC pin and the
+
|-
−
 
+
|-
−
positive supply rail.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | ADC Configuration
−
<span style="font-weight: normal;"><u>-25C Thermistor Value</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''M25''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
−
Value in Ohms of the Thermistor at -25 deg C
+
| width="90%" | ADC Channel
−
 
+
|-
−
<span style="font-weight: normal;"><u>0C Thermistor Value</u></span>
+
| colspan="2" | Analogue Input Channel - Which pin is the analogue input connected to?&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P0''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | VRef option
−
Value in Ohms of the Thermistor at 0 deg C
+
|-
−
 
+
| 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;
−
<span style="font-weight: normal;"><u>25C Thermistor Value</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P25''.
+
| width="90%" | Conversion speed
−
 
+
|-
−
Value in Ohms of the Thermistor at 25 deg C
+
| 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;
−
 
+
|-
−
<span style="font-weight: normal;"><u>50C Thermistor Value</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Acquisition cycles
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P50''.
+
|-
−
 
+
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample.&nbsp;
−
Value in Ohms of the Thermistor at 50 deg C
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>75C Thermistor Value</u></span>
+
| width="90%" | Wiring
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P75''.
+
| colspan="2" | Specifies the arrangement of the Thermistor and Fixed Resistor.  Pull Down - Thermistor connected between ADC pin and GND, fixed resistor between ADC pin and VCC. Pull Up - Thermistor connected between ADC pin and VCC, fixed resistor between ADC pin and GND.&nbsp;
−
 
+
|-
−
Value in Ohms of the Thermistor at 75 deg C
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Resistor Value
−
<span style="font-weight: normal;"><u>100C Thermistor Value</u></span>
+
|-
−
 
+
| colspan="2" | Value in Ohms of the pullup series resistor.  i.e. The resistor is connected between the ADC pin and the positive supply rail.&nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P100''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Value in Ohms of the Thermistor at 100 deg C
+
| width="90%" | -25C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at -25 deg C&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | 0C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at 0 deg C&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | 25C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at 25 deg C&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | 50C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at 50 deg C&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | 75C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at 75 deg C&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | 100C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at 100 deg C&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | 125C Thermistor Value
 +
|-
 +
| colspan="2" | Value in Ohms of the Thermistor at 125 deg C&nbsp;
 +
|}
  
−
<span style="font-weight: normal;"><u>125C Thermistor Value</u></span>
+
==Component Source Code==
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P125''.
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Thermistor_base.fcfx FC_Comp_Source_Thermistor_base.fcfx]
  
−
Value in Ohms of the Thermistor at 125 deg C
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Thermistor_base.fcfx FC_Comp_Source_Thermistor_base.fcfx]

Latest revision as of 14:41, 19 July 2024

Author Matrix
Version 2.0
Category Sensors


Thermistor Template component

Base component for creating thermistors. Has no GUI - this would be added by concrete examples using this basem which may or may not expose the propertes.

Version information

Library Version, Component Version, Date, Author, Info
5, 2.0, 19-07-24, BR, Added compatibility for external ADC
5, 2.0, 19-07-24, BR, Allowed full bit depth usage of the internal ADC

Detailed description

No detailed description exists yet for this component

Examples

This example simply reads the value from the thermistor sensor component and outputs the value to an LCD as a temperature in degrees C. FC6 Icon.png EBM003 Example







Macro reference

CalculateTemperature

Fc9-comp-macro.png CalculateTemperature
Converts the input ADC value and returns the Temperature in tenths of degree C 
Fc9-u16-icon.png - UINT ADCValue
ADC Reading to be converted 
Fc9-s16-icon.png - INT Return


GetADCValue

Fc9-comp-macro.png GetADCValue
Returns the Raw ADC value from the Analogue Channel 
Fc9-u16-icon.png - UINT Return


GetIntegerTemperature

Fc9-comp-macro.png GetIntegerTemperature
Reads the ADC input and returns the calculated Temperature as Integer degrees C 
Fc9-s16-icon.png - INT Return


GetRealTemperature

Fc9-comp-macro.png GetRealTemperature
Reads the ADC input and Returns the calculated Temperature as Float value in degrees C 
Fc9-f32-icon.png - FLOAT Return


SetADCValue

Fc9-comp-macro.png SetADCValue
Used to set the ADC value when an external ADC is being used. 
Fc9-u16-icon.png - UINT AdcValue
Value of the external ADC. e.g. 0-255 for an 8-bit ADC 
Fc9-void-icon.png - VOID Return


SetChannel

Fc9-comp-macro.png SetChannel
Set the ADC Channel 
Fc9-s16-icon.png - INT ChannelID
 
Fc9-void-icon.png - VOID Return


SetTemperature

Fc9-comp-macro.png SetTemperature
Simulation macro that sets the internal ADC value to the appropriate value for a given temperature. This allows all internal systems of the sensor to be simulated. 
Fc9-f32-icon.png - FLOAT Temperature
The temperature in C - restricted to -25 to +125 range 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png ADC Configuration
 
Fc9-type-6-icon.png ADC Channel
Analogue Input Channel - Which pin is the analogue input connected to? 
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-type-16-icon.png Wiring
Specifies the arrangement of the Thermistor and Fixed Resistor. Pull Down - Thermistor connected between ADC pin and GND, fixed resistor between ADC pin and VCC. Pull Up - Thermistor connected between ADC pin and VCC, fixed resistor between ADC pin and GND. 
Fc9-type-21-icon.png Resistor Value
Value in Ohms of the pullup series resistor. i.e. The resistor is connected between the ADC pin and the positive supply rail. 
Fc9-type-21-icon.png -25C Thermistor Value
Value in Ohms of the Thermistor at -25 deg C 
Fc9-type-21-icon.png 0C Thermistor Value
Value in Ohms of the Thermistor at 0 deg C 
Fc9-type-21-icon.png 25C Thermistor Value
Value in Ohms of the Thermistor at 25 deg C 
Fc9-type-21-icon.png 50C Thermistor Value
Value in Ohms of the Thermistor at 50 deg C 
Fc9-type-21-icon.png 75C Thermistor Value
Value in Ohms of the Thermistor at 75 deg C 
Fc9-type-21-icon.png 100C Thermistor Value
Value in Ohms of the Thermistor at 100 deg C 
Fc9-type-21-icon.png 125C Thermistor Value
Value in Ohms of the Thermistor at 125 deg C 

Component Source Code

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

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Thermistor_Template_(Sensors)&oldid=40935"