Difference between revisions of "Component: Thermocouple (MAX31855) (Environmental)"
(XML import) |
|||
| Line 21: | Line 21: | ||
==Examples== | ==Examples== | ||
| − | |||
| + | Example program showing how to use the Thermocouple component. | ||
| + | {{Fcfile|MAX31855_Example.fcfx|MAX31855_Example}} | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
Revision as of 12:00, 25 February 2020
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | Environmental |
Contents
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.
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.
Parameters
- This macro has no parameters
Return value
ReadReference_Float
Returns the reference temperature from the last sample as a floating point value in Degrees C.
Parameters
- This macro has no parameters
Return value
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
Parameters
- This macro has no parameters
Return value
ReadThermocouple_Int
Returns the thermocouple temperature from the last sample as an integer value in Degrees C.
Parameters
- This macro has no parameters
Return value
ReadThermocouple_Float
Returns the thermocouple temperature from the last sample as a floating point value in Degrees C.
Parameters
- This macro has no parameters
Return value
Initialise
Configures the SPI bus ready for communications.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Thermocouple Type
This property is of type Fixed list of ints and can be referenced with the variable name ThermocoupleType.
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.
Channel
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::CHANNEL.
SPI Channel selector
Prescale
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::PR_SCALE.
Prescale option selector
MOSI Remap Pin
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::MOSIPins.
Select which the target pin to assign the MOSI hardware pin functionality.
MOSI
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::MOSI.
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
MISO Remap Pin
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::MISOPins.
Select which the target pin to assign the MISO hardware pin functionality.
MISO
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::MISO.
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
CLK Remap Pin
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::CLKPins.
Select which the target pin to assign the CLK hardware pin functionality.
CLK
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::CLK.
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
CS / SS
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::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.
Simulate Comms
This property is of type True or false and can be referenced with the variable name SimComms.
No additional information
Console Data
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
Scope Traces
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
Injector
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::Injector.
No additional information
