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

Latest revision as of 17:23, 9 November 2022

Author	Matrix TSL
Version	1.0
Category	Environmental

Thermocouple 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 Pack

SENSORS

Detailed description

No detailed description exists yet for this component

Examples

Example program showing how to use the Thermocouple component. MAX31855_Example

Downloadable macro reference

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

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

	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

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

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

	Initialise
Configures the SPI bus ready for communications.
- VOID	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 17:23, 9 November 2022

Contents

Thermocouple component

Component Pack

Detailed description

Examples

Downloadable macro reference

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 TSL
 |-
-| 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
 | Environmental
 |}
+==Thermocouple 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.
-==[[File:Component Icon 97e631c7_51d9_4482_9b65_481b390a686d.png|Image]] Thermocouple (MAX31855) component==
+==Component Pack==
-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.
-==Examples==
+SENSORS
-Example program showing how to use the Thermocouple component.
+==Detailed description==
-{{Fcfile|MAX31855_Example.fcfx|MAX31855_Example}}
-==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>ReadReference_Int</tt></u></span>===
-Returns the reference temperature from the last sample as an integer value in Degrees C.
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|INT]]
-===<span style="font-weight: normal;"><u><tt>ReadReference_Float</tt></u></span>===
-Returns the reference temperature from the last sample as a floating point 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>Sample</tt></u></span>===
-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
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|BYTE]]
-===<span style="font-weight: normal;"><u><tt>ReadThermocouple_Int</tt></u></span>===
+Example program showing how to use the Thermocouple component.
-Returns the thermocouple temperature from the last sample as an integer value in Degrees C.
+{{Fcfile|MAX31855_Example.fcfx|MAX31855_Example}}
-'''Parameters'''
+==Downloadable macro reference==
-:''This macro has no 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;" | '''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''
+|}
-'''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;" | '''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''
+|}
-:[[Variable Types|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'''
+|-
+| 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''
+|}
-===<span style="font-weight: normal;"><u><tt>ReadThermocouple_Float</tt></u></span>===
-Returns the thermocouple temperature from the last sample as a floating point value in Degrees C.
-'''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;" | '''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''
+|}
-:''This macro has no parameters''
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-'''Return value'''
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-:[[Variable Types|FLOAT]]
+| 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;
-===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
+|-
-Configures the SPI bus ready for communications.
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-'''Parameters'''
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-:''This macro has no parameters''
-'''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]]
+| 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''
+|}
-==Simulation macro reference==
-''This component does not contain any simulation macros''
 ==Property reference==
-<span style="font-weight: normal;"><u>Thermocouple Type</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ThermocoupleType''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-Specified at the end of the MAX part number MAX31855X where X is the Thermocouple type.
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-Selects which type of thermocouple the IC works with.
+|-
+|-
-<span style="font-weight: normal;"><u>Channel</u></span>
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Thermocouple Properties
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::CHANNEL''.
+|-
+|-
-SPI Channel selector
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Thermocouple Type
-<span style="font-weight: normal;"><u>Prescale</u></span>
+|-
+| 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;
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::PR_SCALE''.
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-Prescale option selector
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Properties
+|-
-<span style="font-weight: normal;"><u>MOSI Remap Pin</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::MOSIPins''.
+| width="90%" | Channel
+|-
-Select which the target pin to assign the MOSI hardware pin functionality.
+| colspan="2" | SPI Channel selector&nbsp;
+|-
-<span style="font-weight: normal;"><u>MOSI</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Prescale
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MOSI''.
+|-
+| colspan="2" | Prescale option selector&nbsp;
-SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-<span style="font-weight: normal;"><u>MISO Remap Pin</u></span>
+| width="90%" | MOSI
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::MISOPins''.
+| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
+|-
-Select which the target pin to assign the MISO hardware pin functionality.
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | MISO
-<span style="font-weight: normal;"><u>MISO</u></span>
+|-
+| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MISO''.
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
+| width="90%" | CLK
+|-
-<span style="font-weight: normal;"><u>CLK Remap Pin</u></span>
+| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::CLKPins''.
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | CS / SS
-Select which the target pin to assign the CLK hardware pin functionality.
+|-
+| 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;
-<span style="font-weight: normal;"><u>CLK</u></span>
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::CLK''.
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+|-
-SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
-<span style="font-weight: normal;"><u>CS / SS</u></span>
+| width="90%" | Simulate Comms
+|-
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::SS''.
+| colspan="2" | &nbsp;
+|}
-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.
-<span style="font-weight: normal;"><u>Simulate Comms</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''SimComms''.
-''<span style="color:red;">No additional information</span>''
-<span style="font-weight: normal;"><u>Console Data</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ConsoleData''.
-Selects if the console data is automatically generated or not
-<span style="font-weight: normal;"><u>Scope Traces</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ScopeTraces''.
-Selects if the scope traces are automatically generated or not
-<span style="font-weight: normal;"><u>Injector</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::Injector''.
-''<span style="color:red;">No additional information</span>''