thermo17 2.0.0.0
Public function

Functions

void thermo17_cfg_setup (thermo17_cfg_t *cfg)
 Config Object Initialization function.
 
THERMO17_RETVAL thermo17_init (thermo17_t *ctx, thermo17_cfg_t *cfg)
 Initialization function.
 
void thermo17_generic_write (thermo17_t *ctx, uint8_t reg_adr, uint8_t write_data)
 Generic write function.
 
uint8_t thermo17_generic_read (thermo17_t *ctx, uint8_t reg_adr)
 Generic read function.
 
float thermo17_read_temp (thermo17_t *ctx, uint8_t temp_macro)
 Function for reading temperature.
 
uint8_t thermo17_get_int_status (thermo17_t *ctx)
 Checks status of int pin.
 
uint8_t thermo17_get_an_status (thermo17_t *ctx)
 Checks status of an pin.
 

Detailed Description

Function Documentation

◆ thermo17_cfg_setup()

void thermo17_cfg_setup ( thermo17_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.

◆ thermo17_generic_read()

uint8_t thermo17_generic_read ( thermo17_t * ctx,
uint8_t reg_adr )

Generic read function.

Parameters
ctxClick object.
reg_adrRegister address.
Returns
Returns read data

@description This function reads data from the desired register.

◆ thermo17_generic_write()

void thermo17_generic_write ( thermo17_t * ctx,
uint8_t reg_adr,
uint8_t write_data )

Generic write function.

Parameters
ctxClick object.
reg_adrRegister address.
write_dataData to be written.

@description This function writes data to the desired register.

◆ thermo17_get_an_status()

uint8_t thermo17_get_an_status ( thermo17_t * ctx)

Checks status of an pin.

Parameters
ctxClick object.
Returns
0 or 1.

@description This function returns the state of the an pin.

◆ thermo17_get_int_status()

uint8_t thermo17_get_int_status ( thermo17_t * ctx)

Checks status of int pin.

Parameters
ctxClick object.
Returns
0 or 1.

@description This function returns the state of the int pin.

◆ thermo17_init()

THERMO17_RETVAL thermo17_init ( thermo17_t * ctx,
thermo17_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ thermo17_read_temp()

float thermo17_read_temp ( thermo17_t * ctx,
uint8_t temp_macro )

Function for reading temperature.

Parameters
ctxClick object.
temp_macroTemperature macro ( THERMO17_TEMPERATURE_LOCAL or THERMO17_TEMPERATURE_REMOTE ).
Returns
Returns read data or THERMO17_ERROR if temp_macro is wrong

@description This function reads data from the local or remote registers.