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

Revision as of 11:57, 3 November 2023

Author	Matrix
Version	1.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.

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

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. EBM003 Example

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

SetChannel

	SetChannel
Set the ADC Channel
- INT	ChannelID

- VOID	Return

SetTemperature

	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.
- FLOAT	Temperature
The temperature in C - restricted to -25 to +125 range
- VOID	Return

Property reference

	Properties
	ADC Channel
Analogue Input Channel - Which pin is the analogue input connected to?
	ADC Bit Resolution

	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.
	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

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

Revision as of 11:57, 3 November 2023

Contents

Thermistor Template component

Component Source Code

Detailed description

Examples

Macro reference

CalculateTemperature

GetADCValue

GetIntegerTemperature

GetRealTemperature

SetChannel

SetTemperature

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | Matrix
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 1.0 (Release)
+| 1.0
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | 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.
-==[[File:Component Icon bd7d5205_c2eb_48b1_8a37_f967f349965f.png|Image]] Thermistor Template component==
+==Component Source Code==
-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.
-==Examples==
+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]
-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==
+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]
-===<span style="font-weight: normal;"><u><tt>GetIntegerTemperature</tt></u></span>===
+==Detailed description==
-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''
-'''Return value'''
-:[[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'''
+''No detailed description exists yet for this component''
-:[[Variable Types|UINT]] ''ADCValue''
+==Examples==
-::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]]
-==Simulation macro reference==
-===<span style="font-weight: normal;"><u><tt>SetChannel</tt></u></span>===
-Set the ADC Channel
-'''Parameters'''
-:[[Variable Types|INT]] ''ChannelID''
+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}}
-'''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
-'''Return value'''
-:''This call does not return a value''
+==Macro reference==
-==Property reference==
+===CalculateTemperature===
-<span style="font-weight: normal;"><u>ADC Channel</u></span>
+{| 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 property is of type ''Single analog pin'' and can be referenced with the variable name ''CHANNEL''.
-The ADC channel to which the thermistor circuit is connected.
+===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''
+|}
-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.
+===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''
+|}
-<span style="font-weight: normal;"><u>Wiring</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Wiring''.
+===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''
+|}
-Specifies the arrangement of the Thermistor and Fixed Resistor.
+===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''
+|}
-Pull Down - Thermistor connected between ADC pin and GND, fixed resistor between ADC pin and VCC.
+===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''
+|}
-Pull Up - Thermistor connected between ADC pin and VCC, fixed resistor between ADC pin and GND.
-<span style="font-weight: normal;"><u>ADC Bit Resolution</u></span>
+==Property reference==
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ADC_BITS''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
-<span style="font-weight: normal;"><u>Resistor Value</u></span>
+| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
+| width="90%" | ADC Channel
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RESISTOR''.
+|-
+| colspan="2" | Analogue Input Channel - Which pin is the analogue input connected to?&nbsp;
-Value in Ohms of the pullup series resistor.  i.e. The resistor is connected between the ADC pin and the
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-positive supply rail.
+| width="90%" | ADC Bit Resolution
+|-
-<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-16-icon.png]]
+| width="90%" | VRef option
-Value in Ohms of the Thermistor at -25 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>0C 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 ''P0''.
+| width="90%" | Conversion speed
+|-
-Value in Ohms of the Thermistor at 0 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>25C 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 ''P25''.
+|-
+| 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 25 deg C
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-<span style="font-weight: normal;"><u>50C Thermistor Value</u></span>
+| width="90%" | Wiring
+|-
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P50''.
+| 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 50 deg C
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+| width="90%" | Resistor Value
-<span style="font-weight: normal;"><u>75C 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 ''P75''.
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-Value in Ohms of the Thermistor at 75 deg C
+| width="90%" | -25C Thermistor Value
+|-
-<span style="font-weight: normal;"><u>100C Thermistor Value</u></span>
+| colspan="2" | Value in Ohms of the Thermistor at -25 deg C&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]]
+| width="90%" | 0C Thermistor Value
-Value in Ohms of the Thermistor at 100 deg C
+|-
+| colspan="2" | Value in Ohms of the Thermistor at 0 deg C&nbsp;
-<span style="font-weight: normal;"><u>125C Thermistor Value</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P125''.
+| width="90%" | 25C Thermistor Value
+|-
-Value in Ohms of the Thermistor at 125 deg C
+| 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;
+|}