Public function

Functions
void	thermostat3_cfg_setup (thermostat3_cfg_t *cfg)
	Config Object Initialization function.
THERMOSTAT_RETVAL	thermostat3_init (thermostat3_t *ctx, thermostat3_cfg_t *cfg)
	Initialization function.
void	thermostat3_generic_read (thermostat3_t *ctx, uint8_t *read_buff)
void	thermostat3_process (thermostat3_t *ctx, temp_vals_t *tmp)
	Thermostat Process Read data.
float	thermostat3_get_internal_temperature (temp_vals_t *tmp, uint8_t temp_in)
	Junction (Internal) Temperature.
float	thermostat3_get_thermocouple_temperature (temp_vals_t *tmp, uint8_t temp_in)
	Thermocouple Temperature (K probe)
uint8_t	thermostat3_get_fault_data (temp_vals_t *tmp, uint8_t err)
	Fault data value.
void	thermostat3_relay_control (thermostat3_t *ctx, uint8_t relay_pos)
	Relay Control.

Detailed Description

Function Documentation

thermostat3_cfg_setup()

void thermostat3_cfg_setup

(

thermostat3_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.

thermostat3_generic_read()

void thermostat3_generic_read	(	thermostat3_t *	ctx,
		uint8_t *	read_buff )

thermostat3_get_fault_data()

uint8_t thermostat3_get_fault_data	(	temp_vals_t *	tmp,
		uint8_t	err )

Fault data value.

Parameters

err	Fault error (ACTIVE FAULT, SCV, SCG, OC or all-Error)
ctx	Click object.

Returns

Fault Error status (1 - ERROR, 0 - OK) or 4-bit data (all Error status)

@description This function returns Fault data Value.

thermostat3_get_internal_temperature()

float thermostat3_get_internal_temperature	(	temp_vals_t *	tmp,
		uint8_t	temp_in )

Junction (Internal) Temperature.

Parameters

temp_in	Temperature in (CELSIUS, KELVIN or FAHRENHEIT)
ctx	Click object.

Returns

Temperature data

@description This function returns 12-Bit Internal Temperature Data

thermostat3_get_thermocouple_temperature()

float thermostat3_get_thermocouple_temperature	(	temp_vals_t *	tmp,
		uint8_t	temp_in )

Thermocouple Temperature (K probe)

Parameters

temp_in	Temperature in (CELSIUS, KELVIN or FAHRENHEIT)
ctx	Click object.

Returns

Fault Error status (1 - ERROR, 0 - OK) or 4-bit data (all Error status)

@description This function returns 14-Bit Thermocouple Temperature Data

thermostat3_init()

THERMOSTAT_RETVAL thermostat3_init	(	thermostat3_t *	ctx,
		thermostat3_cfg_t *	cfg )

Initialization function.

Parameters

thermostat3	Click object.
cfg	Click configuration structure.

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

thermostat3_process()

void thermostat3_process	(	thermostat3_t *	ctx,
		temp_vals_t *	tmp )

Thermostat Process Read data.

Parameters

ctx	Click object.
tmp	Temperature click object

@description This function must be constantly called in the task. The function continuously reads data from the SPI lines and parses the read data.

thermostat3_relay_control()

void thermostat3_relay_control	(	thermostat3_t *	ctx,
		uint8_t	relay_pos )

Relay Control.

Parameters

relay_pos	Relay (ON or OFF state)
ctx	Click object.

@description This function enables control of the relay.