Difference between revisions of "Component: Thermistor (Environmental)"

Latest revision as of 14:41, 19 July 2024

Author	Matrix TSL
Version	2.0
Category	Environmental

Thermistor component

A generic thermistor component that can be used to simulate and create code for any thermistor with a known temperature/resistance curve. Thermistor is connected in a simple potential divider circuit - thermistor between ADC input and 0V, and a fixed resistor between ADC and the positive supply. Default calibration is for the EBM003 module.

Version information

Library Version, Component Version, Date, Author, Info
9, 2.0, 19-07-24, BR, Added compatibility for external ADC
9, 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

No additional examples

Macro reference

CalculateTemperature

	CalculateTemperature
Converts the input ADC value and returns the Temperature in tenths of degree C
- UINT	ADCValue
ADC Reading to be converted
- INT	Return

GetADCValue

	GetADCValue
Returns the Raw ADC value from the Analogue Channel
- UINT	Return

GetIntegerTemperature

	GetIntegerTemperature
Reads the ADC input and returns the calculated Temperature as Integer degrees C
- INT	Return

GetRealTemperature

	GetRealTemperature
Reads the ADC input and Returns the calculated Temperature as Float value in degrees C
- FLOAT	Return

SetADCValue

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

SetChannel

	SetChannel
Set the ADC Channel
- INT	ChannelID

- VOID	Return

SetMinMax

	SetMinMax
Set the minimum and maximum temperature values that can be shown and set on the thermometer readout.
- FLOAT	Min
Minimum Value
- FLOAT	Max
Maximum Value
- VOID	Return

SetTemperature

	SetTemperature
Sends the given temperature to the display, and calculates the internal values used by the simulated read macros.
- FLOAT	Temperature
Zero to one value - representing min-max of the sensor.
- VOID	Return

Property reference

	Properties
	ADC Properties
	ADC Configuration

	ADC Channel
Analogue Input Channel - Which pin is the analogue input connected to?
	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.
	Thermistor Properties
	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.
	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.
	-25C Thermistor Value
Value in Ohms of the Thermistor at -25 deg C
	0C Thermistor Value
Value in Ohms of the Thermistor at 0 deg C
	25C Thermistor Value
Value in Ohms of the Thermistor at 25 deg C
	50C Thermistor Value
Value in Ohms of the Thermistor at 50 deg C
	75C Thermistor Value
Value in Ohms of the Thermistor at 75 deg C
	100C Thermistor Value
Value in Ohms of the Thermistor at 100 deg C
	125C Thermistor Value
Value in Ohms of the Thermistor at 125 deg C
	Simulation
	Label
A text label to help you identify the component on the panel.
	Min. Temp.
Minimum termperature that can be set or displayed on the thermometer slider.
	Max. Temp.
Maximum termperature that can be set or displayed on the thermometer slider.
	Scale divisions
Number of numbered divisions shown on the thermometer scale.

Component Source Code

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

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

@@ Line 5: / Line 5: @@
 |-
 | width="20%" style="color:gray;" | Version
-| 1.1
+| 2.0
 |-
 | width="20%" style="color:gray;" | Category
@@ Line 15: / Line 15: @@
 A generic thermistor component that can be used to simulate and create code for any thermistor with a known temperature/resistance curve.  Thermistor is connected in a simple potential divider circuit - thermistor between ADC input and 0V, and a fixed resistor between ADC and the positive supply.  Default calibration is for the EBM003 module.
-==Component Source Code==
+==Version information==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Thermistor.fcfx FC_Comp_Source_Thermistor.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Thermistor.fcfx FC_Comp_Source_Thermistor.fcfx]
+ Library Version, Component Version, Date, Author, Info
+, 2.0, 19-07-24, BR, Added compatibility for external ADC
+, 2.0, 19-07-24, BR, Allowed full bit depth usage of the internal ADC
 ==Detailed description==
@@ Line 144: / Line 144: @@
 |-
 | 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''
+|}
+===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''
 |}
@@ Line 221: / Line 240: @@
 | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | ADC Properties
 |-
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | ADC Configuration
+|-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
 | width="90%" | ADC Channel
 |-
-| colspan="2" | 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 between the ADC pin and +V.&nbsp;
+| colspan="2" | Analogue Input Channel - Which pin is the analogue input connected to?&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
@@ Line 231: / Line 255: @@
 |-
 | 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-21-icon.png]]
-| width="90%" | ADC Bit Resolution
-|-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
@@ Line 320: / Line 339: @@
 | colspan="2" | Number of numbered divisions shown on the thermometer scale.&nbsp;
 |}
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Thermistor.fcfx FC_Comp_Source_Thermistor.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Thermistor.fcfx FC_Comp_Source_Thermistor.fcfx]