thermostat3  2.0.0.0
Functions

Functions

void thermostat3_cfg_setup (thermostat3_cfg_t *cfg)
 Config Object Initialization function. More...
 
THERMOSTAT_RETVAL thermostat3_init (thermostat3_t *ctx, thermostat3_cfg_t *cfg)
 Initialization function. More...
 
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. More...
 
float thermostat3_get_internal_temperature (temp_vals_t *tmp, uint8_t temp_in)
 Junction (Internal) Temperature. More...
 
float thermostat3_get_thermocouple_temperature (temp_vals_t *tmp, uint8_t temp_in)
 Thermocouple Temperature (K probe) More...
 
uint8_t thermostat3_get_fault_data (temp_vals_t *tmp, uint8_t err)
 Fault data value. More...
 
void thermostat3_relay_control (thermostat3_t *ctx, uint8_t relay_pos)
 Relay Control. More...
 

Detailed Description

Function Documentation

◆ thermostat3_cfg_setup()

void thermostat3_cfg_setup ( thermostat3_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick 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
errFault error (ACTIVE FAULT, SCV, SCG, OC or all-Error)
ctxClick 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_inTemperature in (CELSIUS, KELVIN or FAHRENHEIT)
ctxClick 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_inTemperature in (CELSIUS, KELVIN or FAHRENHEIT)
ctxClick 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
thermostat3Click object.
cfgClick 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
ctxClick object.
tmpTemperature 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_posRelay (ON or OFF state)
ctxClick object.

@description This function enables control of the relay.