Difference between revisions of "Component: Thermocouple (MAX31855) (Environmental)"

Latest revision as of 13:13, 7 February 2023

Author	Matrix TSL
Version	1.0
Category	Environmental

Thermocouple (MAX31855) component

Component to interface the MAX31855 IC from MAXIM. Uses a standard 3-wire SPI interface to connect to the IC and collect the temperature. IC available in different versions to suit different thermocouple types.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Example program showing how to use the Thermocouple component. MAX31855_Example

Macro reference

Initialise

	Initialise
Configures the SPI bus ready for communications.
- VOID	Return

ReadReference_Float

	ReadReference_Float
Returns the reference temperature from the last sample as a floating point value in Degrees C.
- FLOAT	Return

ReadReference_Int

	ReadReference_Int
Returns the reference temperature from the last sample as an integer value in Degrees C.
- INT	Return

ReadThermocouple_Float

	ReadThermocouple_Float
Returns the thermocouple temperature from the last sample as a floating point value in Degrees C.
- FLOAT	Return

ReadThermocouple_Int

	ReadThermocouple_Int
Returns the thermocouple temperature from the last sample as an integer value in Degrees C.
- INT	Return

Sample

	Sample
Reads the memory of the MAX31855 IC and checks for errors. Must be called before any of the Read functions. Returns: 0=OK, 1=Open Circuit, 2=Short GND, 3=Short VCC
- BYTE	Return

Property reference

	Properties
	Thermocouple Properties
	Thermocouple Type
Specified at the end of the MAX part number MAX31855X where X is the Thermocouple type. Selects which type of thermocouple the IC works with.
	SPI Properties
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulate Comms

Difference between revisions of "Component: Thermocouple (MAX31855) (Environmental)"

Latest revision as of 13:13, 7 February 2023

Contents

Thermocouple (MAX31855) component

Component Source Code

Detailed description

Examples

Macro reference

Initialise

ReadReference_Float

ReadReference_Int

ReadThermocouple_Float

ReadThermocouple_Int

Sample

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 16: / Line 16: @@
 ==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ThermocoupleMAX31855.fcfx FC_Comp_Source_ThermocoupleMAX31855.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ThermocoupleMAX31855.fcfx FC_Comp_Source_ThermocoupleMAX31855.fcfx]
 ==Detailed description==
@@ Line 59: / Line 67: @@
-Example program showing how to use the Thermocouple component.
-{{Fcfile|MAX31855_Example.fcfx|MAX31855_Example}}
-==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;" | '''ReadReference_Int'''
-|-
-| colspan="2" | Returns the reference temperature from the last sample as an integer value in 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''
-|}
-{| 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;" | '''ReadReference_Float'''
-|-
-| colspan="2" | Returns the reference temperature from the last sample as a floating point 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''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+Example program showing how to use the Thermocouple component.
-|-
+{{Fcfile|MAX31855_Example.fcfx|MAX31855_Example}}
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Sample'''
-|-
-| colspan="2" | Reads the memory of the MAX31855 IC and checks for errors. Must be called before any of the Read functions. Returns: 0=OK, 1=Open Circuit, 2=Short GND, 3=Short VCC&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| 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;" | '''ReadThermocouple_Int'''
-|-
-| colspan="2" | Returns the thermocouple temperature from the last sample as an integer value in 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''
-|}
-{| 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;" | '''ReadThermocouple_Float'''
-|-
-| colspan="2" | Returns the thermocouple temperature from the last sample as a floating point 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''
-|}
-{| 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;" | '''Initialise'''
-|-
-| colspan="2" | Configures the SPI bus ready for communications.&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==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
-|-
-| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Thermocouple Properties
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-| width="90%" | Thermocouple Type
-|-
-| colspan="2" | Specified at the end of the MAX part number MAX31855X where X is the Thermocouple type. Selects which type of thermocouple the IC works with.&nbsp;
-|-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Properties
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-| width="90%" | Channel
-|-
-| colspan="2" | SPI Channel selector&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-| width="90%" | Prescale
-|-
-| colspan="2" | Prescale option selector&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | MOSI
-|-
-| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | MISO
-|-
-| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | CLK
-|-
-| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | CS / SS
-|-
-| colspan="2" | Chip Select / Slave Select Pin  Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. &nbsp;
-|-
-| 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-7-icon.png]]
-| width="90%" | Simulate Comms
-|-
-| colspan="2" | &nbsp;
-|}==Macro reference==
+===Initialise===
 {| 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;" | '''ReadReference_Int'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Returns the reference temperature from the last sample as an integer value in Degrees C.&nbsp;
+| colspan="2" | Configures the SPI bus ready for communications.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+| 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''
 |}
+===ReadReference_Float===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 231: / Line 116: @@
+===ReadReference_Int===
 {| 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;" | '''Sample'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadReference_Int'''
 |-
-| colspan="2" | Reads the memory of the MAX31855 IC and checks for errors. Must be called before any of the Read functions. Returns: 0=OK, 1=Open Circuit, 2=Short GND, 3=Short VCC&nbsp;
+| colspan="2" | Returns the reference temperature from the last sample as an integer value in Degrees C.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
+===ReadThermocouple_Float===
 {| 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;" | '''ReadThermocouple_Int'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadThermocouple_Float'''
 |-
-| colspan="2" | Returns the thermocouple temperature from the last sample as an integer value in Degrees C.&nbsp;
+| colspan="2" | Returns the thermocouple temperature from the last sample as a floating point value in Degrees C.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+| 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''
 |}
+===ReadThermocouple_Int===
 {| 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;" | '''ReadThermocouple_Float'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadThermocouple_Int'''
 |-
-| colspan="2" | Returns the thermocouple temperature from the last sample as a floating point value in Degrees C.&nbsp;
+| colspan="2" | Returns the thermocouple temperature from the last sample as an integer value in Degrees C.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| 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''
 |}
+===Sample===
 {| 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;" | '''Initialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Sample'''
 |-
-| colspan="2" | Configures the SPI bus ready for communications.&nbsp;
+| colspan="2" | Reads the memory of the MAX31855 IC and checks for errors. Must be called before any of the Read functions. Returns: 0=OK, 1=Open Circuit, 2=Short GND, 3=Short VCC&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}