Difference between revisions of "Component: Thermistor (EBM003) (EBM Modules)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM003v1.fcfx FC_Comp_Source_EBM003v1.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM003v1.fcfx FC_Comp_Source_EBM003v1.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM003v1.fcfx FC_Comp_Source_EBM003v1.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 42: | Line 46: | ||
==Macro reference== | ==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;" | '''GetIntegerTemperature''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the ADC input and returns the calculated Temperature as Integer degrees C | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | ChannelID | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | ADCValue | ||
| + | |- | ||
| + | | colspan="2" | ADC Reading to be converted | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| 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%" | 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. | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Wiring | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | ADC Bit Resolution | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Resistor Value | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Label | ||
| + | |- | ||
| + | | colspan="2" | A text label to help you identify the component on the panel. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:55, 27 January 2023
| Author | Matrix TSL |
| Version | 1.1 |
| Category | EBM Modules |
Contents
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 Source Code
Please click here to download the component source project: FC_Comp_Source_EBM003v1.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_EBM003v1.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
GetIntegerTemperature |
| Reads the ADC input and returns the calculated Temperature as Integer degrees C | |
 - INT
|
Return |
|
|
SetChannel |
| Set the ADC Channel | |
| - INT
|
ChannelID |
 - VOID
|
Return |
|
|
GetRealTemperature |
| Reads the ADC input and Returns the calculated Temperature as Float value in degrees C | |
 - FLOAT
|
Return |
|
|
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 |
|
|
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 |
| Returns the Raw ADC value from the Analogue Channel | |
| - UINT
|
Return |
Property reference
|
Properties |
|
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. | |
|
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. | |
|
|
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. | |
|
ADC Bit Resolution |
|
|
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. | |
==Macro reference==
|
|
GetIntegerTemperature |
| Reads the ADC input and returns the calculated Temperature as Integer degrees C | |
| - INT
|
Return |
|
|
SetChannel |
| Set the ADC Channel | |
| - INT
|
ChannelID |
| - VOID
|
Return |
|
|
GetRealTemperature |
| Reads the ADC input and Returns the calculated Temperature as Float value in degrees C | |
| - FLOAT
|
Return |
|
|
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 |
|
|
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 |
| Returns the Raw ADC value from the Analogue Channel | |
| - UINT
|
Return |
Property reference
|
|
Properties |
|
|
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. | |
|
|
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. | |
|
|
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. | |
|
|
ADC Bit Resolution |
|
|
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. | |
==Macro reference==
|
|
GetIntegerTemperature |
| Reads the ADC input and returns the calculated Temperature as Integer degrees C | |
| - INT
|
Return |
|
|
SetChannel |
| Set the ADC Channel | |
| - INT
|
ChannelID |
| - VOID
|
Return |
|
|
GetRealTemperature |
| Reads the ADC input and Returns the calculated Temperature as Float value in degrees C | |
| - FLOAT
|
Return |
|
|
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 |
|
|
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 |
| Returns the Raw ADC value from the Analogue Channel | |
| - UINT
|
Return |
Property reference
|
|
Properties |
|
|
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. | |
|
|
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. | |
|
|
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. | |
|
|
ADC Bit Resolution |
|
|
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. | |
==Macro reference==
|
|
GetIntegerTemperature |
| Reads the ADC input and returns the calculated Temperature as Integer degrees C | |
| - INT
|
Return |
|
|
SetChannel |
| Set the ADC Channel | |
| - INT
|
ChannelID |
| - VOID
|
Return |
|
|
GetRealTemperature |
| Reads the ADC input and Returns the calculated Temperature as Float value in degrees C | |
| - FLOAT
|
Return |
|
|
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 |
|
|
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 |
| Returns the Raw ADC value from the Analogue Channel | |
| - UINT
|
Return |
Property reference
|
|
Properties |
|
|
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. | |
|
|
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. | |
|
|
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. | |
|
|
ADC Bit Resolution |
|
|
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. | |
