Public function

Functions
void	thermostat_cfg_setup (thermostat_cfg_t *cfg)
	Config Object Initialization function.
THERMOSTAT_RETVAL	thermostat_init (thermostat_t *ctx, thermostat_cfg_t *cfg)
	Initialization function.
void	thermostat_generic_write (thermostat_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	thermostat_generic_read (thermostat_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	thermostat_write_data (thermostat_t *ctx, uint8_t reg_address, uint16_t write_data)
	Generic write 16-bit data function.
uint16_t	thermostat_read_data (thermostat_t *ctx, uint8_t reg_address)
	Generic read 16-bit data function.
float	thermostat_get_temperature (thermostat_t *ctx)
	Get temperature in degrees Celsius.
float	thermostat_convert_fahrenheit (thermostat_t *ctx, float temp_celsius)
	Convert temperature in degrees Celsius to Fahrenheit.
void	thermostat_set_configuration (thermostat_t *ctx, uint16_t config_value)
	Set configuration function.
void	thermostat_set_temp_hyst (thermostat_t *ctx, int8_t temp_hyst)
	Set temperature hysterezis function.
void	thermostat_set_temp_ref (thermostat_t *ctx, int8_t temp_ref)
	Set referent temperature function.
void	thermostat_soft_reset (thermostat_t *ctx)
	Soft reset function.
void	thermostat_switch_on (thermostat_t *ctx)
	Set on thermal switch function.
void	thermostat_switch_off (thermostat_t *ctx)
	Set off thermal switch function.
void	thermostat_enable (thermostat_t *ctx)
	Thermostat enabled function.
void	thermostat_disable (thermostat_t *ctx)
	Thermostat disabled function.

Detailed Description

Function Documentation

thermostat_cfg_setup()

void thermostat_cfg_setup

(

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

thermostat_convert_fahrenheit()

float thermostat_convert_fahrenheit	(	thermostat_t *	ctx,
		float	temp_celsius )

Convert temperature in degrees Celsius to Fahrenheit.

Parameters

ctx	Click object.
temp_celsius	Temperature in celsius.

@description This function convert temperature in degrees Celsius to Fahrenheit.

thermostat_disable()

void thermostat_disable

(

thermostat_t *

ctx

)

Thermostat disabled function.

Parameters

ctx	Click object.

@description This function disabled thermostat

thermostat_enable()

void thermostat_enable

(

thermostat_t *

ctx

)

Thermostat enabled function.

Parameters

ctx	Click object.

@description This function enables thermostat.

thermostat_generic_read()

void thermostat_generic_read	(	thermostat_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf.
len	Number of the bytes to be read

@description This function reads data from the desired register.

thermostat_generic_write()

void thermostat_generic_write	(	thermostat_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

thermostat_get_temperature()

float thermostat_get_temperature

(

thermostat_t *

ctx

)

Get temperature in degrees Celsius.

Parameters

ctx	Click object.

@description This function get temperature in degrees Celsius.

thermostat_init()

THERMOSTAT_RETVAL thermostat_init	(	thermostat_t *	ctx,
		thermostat_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

thermostat_read_data()

uint16_t thermostat_read_data	(	thermostat_t *	ctx,
		uint8_t	reg_address )

Generic read 16-bit data function.

Parameters

ctx	Click object.
reg	Register address.

@description This function generic read 16-bit data.

thermostat_set_configuration()

void thermostat_set_configuration	(	thermostat_t *	ctx,
		uint16_t	config_value )

Set configuration function.

Parameters

ctx	Click object.
config_value	Configuration value.

@description This function set configuration value.

thermostat_set_temp_hyst()

void thermostat_set_temp_hyst	(	thermostat_t *	ctx,
		int8_t	temp_hyst )

Set temperature hysterezis function.

Parameters

ctx	Click object.
temp_hyst	Temperature hysterezis.

@description This function set temperature hysterezis.

thermostat_set_temp_ref()

void thermostat_set_temp_ref	(	thermostat_t *	ctx,
		int8_t	temp_ref )

Set referent temperature function.

Parameters

ctx	Click object.
temp_ref	Referent temperature.

@description This function set referent temperature.

thermostat_soft_reset()

void thermostat_soft_reset

(

thermostat_t *

ctx

)

Soft reset function.

Parameters

ctx	Click object.

@description This function enables soft reset.

thermostat_switch_off()

void thermostat_switch_off

(

thermostat_t *

ctx

)

Set off thermal switch function.

Parameters

ctx	Click object.

@description This function set off thermal switch.

thermostat_switch_on()

void thermostat_switch_on

(

thermostat_t *

ctx

)

Set on thermal switch function.

Parameters

ctx	Click object.

@description This function set on thermal switch.

thermostat_write_data()

void thermostat_write_data	(	thermostat_t *	ctx,
		uint8_t	reg_address,
		uint16_t	write_data )

Generic write 16-bit data function.

Parameters

ctx	Click object.
reg	Register address.
write_data	Data for write.

@description This function generic write 16-bit data.