Public function

Functions
void	thermo_cfg_setup (thermo_cfg_t *cfg)
	Config Object Initialization function.
THERMO_RETVAL	thermo_init (thermo_t *ctx, thermo_cfg_t *cfg)
	Initialization function.
uint32_t	thermo_read_data (thermo_t *ctx)
	Read data from sensor function.
float	thermo_get_temperature (thermo_t *ctx)
	Get thermocouple temperature function.
float	thermo_get_junction_temperature (thermo_t *ctx)
	Get reference junction temperature function.
uint8_t	thermo_check_fault (thermo_t *ctx)
	Check fault states function.
uint8_t	thermo_short_circuited_vcc (thermo_t *ctx)
	Check short-circuited to Vcc function.
uint8_t	thermo_short_circuited_gnd (thermo_t *ctx)
	Check short-circuited to GND function.
uint8_t	thermo_check_connections (thermo_t *ctx)
	Check connections fault function.

Detailed Description

Function Documentation

thermo_cfg_setup()

void thermo_cfg_setup

(

thermo_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

thermo_check_connections()

uint8_t thermo_check_connections

(

thermo_t *

ctx

)

Check connections fault function.

Parameters

thermo

Click object.

Returns

• 0 : OK
• 1 : ERROR ( when the thermocouple is open (no connections) );

@description Function check connections fault of MAX31855 sensor on Thermo click board.

thermo_check_fault()

uint8_t thermo_check_fault

(

thermo_t *

ctx

)

Check fault states function.

Parameters

thermo

Click object.

Returns

• 0 : OK
• 1 : ERROR ( when any of the SCV, SCG, or OC faults are active );

@description Function checks fault states of MAX31855 sensor on Thermo click board.

thermo_get_junction_temperature()

float thermo_get_junction_temperature

(

thermo_t *

ctx

)

Get reference junction temperature function.

Parameters

thermo

Click object.

Returns

float reference junction temperature in degree Celsius [ �C ]

@description Function get reference junction temperature data from MAX31855 sensor on Thermo click board and convert to float value of reference junction temperature in degree Celsius [ �C ].

thermo_get_temperature()

float thermo_get_temperature

(

thermo_t *

ctx

)

Get thermocouple temperature function.

Parameters

thermo

Click object.

Returns

float thermocouple temperature in degree Celsius [ �C ]

@description Function gets thermocouple temperature data from MAX31855 sensor on Thermo click board and convert to float value of thermocouple temperature in degree Celsius [ �C ].

thermo_init()

THERMO_RETVAL thermo_init	(	thermo_t *	ctx,
		thermo_cfg_t *	cfg )

Initialization function.

Parameters

thermo	Click object.
cfg	Click configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

thermo_read_data()

uint32_t thermo_read_data

(

thermo_t *

ctx

)

Read data from sensor function.

Parameters

thermo

Click object.

Returns

32-bit read sensor data

@description Function reads the 32-bit of data from the MAX31855 sensor on Thermo click board.

thermo_short_circuited_gnd()

uint8_t thermo_short_circuited_gnd

(

thermo_t *

ctx

)

Check short-circuited to GND function.

Parameters

thermo

Click object.

Returns

• 0 : OK
• 1 : ERROR ( when the thermocouple is short-circuited to GND );

@description Function check fault states of short-circuited to GND of MAX31855 sensor on Thermo click board.

thermo_short_circuited_vcc()

uint8_t thermo_short_circuited_vcc

(

thermo_t *

ctx

)

Check short-circuited to Vcc function.

Parameters

thermo

Click object.

Returns

• 0 : OK
• 1 : ERROR ( when the thermocouple is short-circuited to VCC );

@description Function check fault states of short-circuited to Vcc of MAX31855 sensor on Thermo click board.