Difference between revisions of "Component: Thermistor (EBM003) (EBM Modules)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(5 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.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| EBM Modules
 
| EBM Modules
 
|}
 
|}
  
  
 +
==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.  The component is also used with the EBM003 module, in which case the extra circuitry is already included.  Default calibration is for the EBM003 module.
  
−
==[[File:Component Icon 2f3dd5e3_b652_4045_9ab9_10d49440e5cd.png|Image]] Thermistor (EBM003) component==
+
==Component Pack==
−
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.  The component is also used with the EBM003 module, in which
 
−
case the extra circuitry is already included.  Default calibration is for the EBM003 module.
 
  
−
==Examples==
+
SENSORS
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==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''
  
 +
==Examples==
  
−
'''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'''
 
  
−
:[[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'''
+
''<span style="color:red;">No additional examples</span>''
  
−
:''This macro has no parameters''
 
  
 +
==Downloadable macro reference==
  
−
'''Return value'''
+
{| 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''
 +
|}
  
−
:[[Variable Types|UINT]]
 
  
 +
{| 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''
 +
|}
  
  
−
==Simulation 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;" | '''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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>SetChannel</tt></u></span>===
 
−
Set the ADC Channel
 
  
−
'''Parameters'''
+
{| 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" | Sends the given temperature to the display, and calculates the internal values used by the simulated read macros.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Temperature
 +
|-
 +
| colspan="2" | Zero to one value - representing min-max of the sensor.&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''
 +
|}
  
−
:[[Variable Types|INT]] ''ChannelID''
 
  
 +
{| 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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
===<span style="font-weight: normal;"><u><tt>SetMinMax</tt></u></span>===
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetADCValue'''
−
Set the minimum and maximum temperature values that can be shown and set on the thermometer readout.
+
|-
−
 
+
| colspan="2" | Returns the Raw ADC value from the Analogue Channel&nbsp;
−
'''Parameters'''
+
|-
−
 
+
|-
−
:[[Variable Types|FLOAT]] ''Min''
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
−
::Minimum Value
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
:[[Variable Types|FLOAT]] ''Max''
 
−
::Maximum Value
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetTemperature</tt></u></span>===
 
−
Sends the given temperature to the display, and calculates the internal values used by the simulated read macros.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|FLOAT]] ''Temperature''
 
−
::Zero to one value - representing min-max of the sensor.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 131: Line 147:
  
 
==Property reference==
 
==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''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
The ADC channel to which the thermistor circuit is connected.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
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.
+
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
−
 
+
| width="90%" | ADC Channel
−
<span style="font-weight: normal;"><u>Wiring</u></span>
+
|-
−
 
+
| 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;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Thermistor_base1::Wiring''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Specifies the arrangement of the Thermistor and Fixed Resistor.
+
| 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;
−
 
+
|-
−
Pull Down - Thermistor connected between ADC pin and GND, fixed resistor between ADC pin and VCC.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Wiring
−
Pull Up - Thermistor connected between ADC pin and VCC, fixed resistor between ADC pin and GND.
+
|-
−
 
+
| 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;
−
<span style="font-weight: normal;"><u>ADC Bit Resolution</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 ''ADC_BITS''.
+
| width="90%" | ADC Bit Resolution
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Resistor Value
−
<span style="font-weight: normal;"><u>Resistor 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 ''RESISTOR''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Value in Ohms of the pullup series resistor.  i.e. The resistor is connected between the ADC pin and the
+
| width="90%" | -25C Thermistor Value
−
 
+
|-
−
positive supply rail.
+
| colspan="2" | Value in Ohms of the Thermistor at -25 deg C&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>-25C Thermistor Value</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | 0C Thermistor Value
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''M25''.
+
|-
−
 
+
| colspan="2" | Value in Ohms of the Thermistor at 0 deg C&nbsp;
−
Value in Ohms of the Thermistor at -25 deg C
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
<span style="font-weight: normal;"><u>0C Thermistor Value</u></span>
+
| width="90%" | 25C Thermistor Value
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P0''.
+
| colspan="2" | Value in Ohms of the Thermistor at 25 deg C&nbsp;
−
 
+
|-
−
Value in Ohms of the Thermistor at 0 deg C
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | 50C Thermistor Value
−
<span style="font-weight: normal;"><u>25C Thermistor Value</u></span>
+
|-
−
 
+
| colspan="2" | Value in Ohms of the Thermistor at 50 deg C&nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P25''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Value in Ohms of the Thermistor at 25 deg C
+
| width="90%" | 75C Thermistor Value
−
 
+
|-
−
<span style="font-weight: normal;"><u>50C Thermistor Value</u></span>
+
| colspan="2" | Value in Ohms of the Thermistor at 75 deg C&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P50''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | 100C Thermistor Value
−
Value in Ohms of the Thermistor at 50 deg C
+
|-
−
 
+
| colspan="2" | Value in Ohms of the Thermistor at 100 deg C&nbsp;
−
<span style="font-weight: normal;"><u>75C 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 ''P75''.
+
| width="90%" | 125C Thermistor Value
−
 
+
|-
−
Value in Ohms of the Thermistor at 75 deg C
+
| colspan="2" | Value in Ohms of the Thermistor at 125 deg C&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>100C Thermistor Value</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P100''.
+
|-
−
 
+
|-
−
Value in Ohms of the Thermistor at 100 deg C
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Label
−
<span style="font-weight: normal;"><u>125C Thermistor Value</u></span>
+
|-
−
 
+
| colspan="2" | A text label to help you identify the component on the panel.&nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''P125''.
+
|}
−
 
 
−
Value in Ohms of the Thermistor at 125 deg C
 
−
 
 
−
<span style="font-weight: normal;"><u>Label</u></span>
 
−
 
 
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
 
−
 
 
−
A text label to help you identify the component on the panel.
 
−
 
 
−
<span style="font-weight: normal;"><u>Min. Temp.</u></span>
 
−
 
 
−
This property is of type ''Floating point'' and can be referenced with the variable name ''min_temp''.
 
−
 
 
−
Minimum termperature that can be set or displayed on the thermometer slider.
 
−
 
 
−
<span style="font-weight: normal;"><u>Max. Temp.</u></span>
 
−
 
 
−
This property is of type ''Floating point'' and can be referenced with the variable name ''max_temp''.
 
−
 
 
−
Maximum termperature that can be set or displayed on the thermometer slider.
 
−
 
 
−
<span style="font-weight: normal;"><u>Scale divisions</u></span>
 
−
 
 
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''scale_divisions''.
 
−
 
 
−
Number of numbered divisions shown on the thermometer scale.
 

Latest revision as of 17:23, 9 November 2022

Author Matrix TSL
Version 1.1
Category EBM Modules


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. The component is also used with the EBM003 module, in which case the extra circuitry is already included. Default calibration is for the EBM003 module.

Component Pack

SENSORS

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

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


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


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


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


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


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



Property reference

Fc9-prop-icon.png Properties
Fc9-type-6-icon.png ADC Channel
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. 
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 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 ADC Bit Resolution
 
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 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
A text label to help you identify the component on the panel. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Thermistor_(EBM003)_(EBM_Modules)&oldid=28771"