remotetemp 2.0.0.0

Functions

void remotetemp_cfg_setup (remotetemp_cfg_t *cfg)
 Config Object Initialization function.
 
REMOTETEMP_RETVAL remotetemp_init (remotetemp_t *ctx, remotetemp_cfg_t *cfg)
 Initialization function.
 
void remotetemp_default_cfg (remotetemp_t *ctx)
 Click Default Configuration function.
 
void remotetemp_generic_write (remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void remotetemp_generic_read (remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
uint8_t remotetemp_int_get (remotetemp_t *ctx)
 Getting state of INT pin.
 
uint8_t remotetemp_an_get (remotetemp_t *ctx)
 Getting state of AN pin.
 
uint8_t remotetemp_set_range (remotetemp_t *ctx, uint8_t range_setting)
 Setting temperature range.
 
void remotetemp_read (remotetemp_t *ctx, uint8_t register_address, uint8_t *read_buffer, uint8_t n_bytes)
 Reads register content.
 
void remotetemp_write (remotetemp_t *ctx, uint8_t register_address, uint8_t *register_values, uint8_t n_bytes)
 Setting register content.
 
void remotetemp_set_int_diode_high_limit (remotetemp_t *ctx, int16_t limit_value)
 Setting Internal diode high limit.
 
void remotetemp_set_int_diode_low_limit (remotetemp_t *ctx, int16_t limit_value)
 Setting Internal diode low limit.
 
void remotetemp_set_ext_diode_high_limit (remotetemp_t *ctx, int16_t limit_value, uint8_t diode)
 Setting external diodes high limit.
 
void remotetemp_set_ext_diode_low_limit (remotetemp_t *ctx, int16_t limit_value, uint8_t diode)
 Setting external diodes low limit.
 
void remotetemp_set_ext_diode_therm_limit (remotetemp_t *ctx, int16_t limit_value, uint8_t diode)
 Setting external diodes thermal limits.
 
void remotetemp_set_int_diode_therm_limit (remotetemp_t *ctx, int16_t limit_value)
 Setting internal diodes thermal limits.
 
float remotetemp_get_internal_diode (remotetemp_t *ctx)
 Getting internal diode temperature value.
 
float remotetemp_get_external_diode (remotetemp_t *ctx, uint8_t diode)
 Getting external diode temperature value.
 
float remotetemp_get_hottest_diode (remotetemp_t *ctx)
 Getting hottest diode temperature value.
 

Detailed Description

Function Documentation

◆ remotetemp_an_get()

uint8_t remotetemp_an_get ( remotetemp_t * ctx)

Getting state of AN pin.

Parameters
ctxClick object.
Returns
0 if AN pin is in LOW state.
1 if AN pin is in HIGH state.

@description This function gets state of AN pin.

◆ remotetemp_cfg_setup()

void remotetemp_cfg_setup ( remotetemp_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.

◆ remotetemp_default_cfg()

void remotetemp_default_cfg ( remotetemp_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for RemoteTemp click.

◆ remotetemp_generic_read()

void remotetemp_generic_read ( remotetemp_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ remotetemp_generic_write()

void remotetemp_generic_write ( remotetemp_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ remotetemp_get_external_diode()

float remotetemp_get_external_diode ( remotetemp_t * ctx,
uint8_t diode )

Getting external diode temperature value.

Parameters
ctxClick object.
diodeDiode number.
Returns
float - external diode temperature value

@description This function reads external diode registers and calculates temperature value.

◆ remotetemp_get_hottest_diode()

float remotetemp_get_hottest_diode ( remotetemp_t * ctx)

Getting hottest diode temperature value.

Parameters
ctxClick object.
Returns
float - hottest diode temperature value

@description This function reads hottest diode registers and calculates temperature value.

◆ remotetemp_get_internal_diode()

float remotetemp_get_internal_diode ( remotetemp_t * ctx)

Getting internal diode temperature value.

Parameters
ctxClick object.
Returns
float - internal diode temperature value

@description This function reads internal diode registers and calculates temperature value.

◆ remotetemp_init()

REMOTETEMP_RETVAL remotetemp_init ( remotetemp_t * ctx,
remotetemp_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ remotetemp_int_get()

uint8_t remotetemp_int_get ( remotetemp_t * ctx)

Getting state of INT pin.

Parameters
ctxClick object.
Returns
0 if INT pin is in LOW state.
1 if INT pin is in HIGH state.

@description This function gets state of INT pin.

◆ remotetemp_read()

void remotetemp_read ( remotetemp_t * ctx,
uint8_t register_address,
uint8_t * read_buffer,
uint8_t n_bytes )

Reads register content.

Parameters
ctxClick object.
register_addressSets temperature range.
read_bufferBuffer for storing register content.
n_bytesNumber of registers(bytes) to read.
Returns
none

@description This function reads content from register(s).

◆ remotetemp_set_ext_diode_high_limit()

void remotetemp_set_ext_diode_high_limit ( remotetemp_t * ctx,
int16_t limit_value,
uint8_t diode )

Setting external diodes high limit.

Parameters
ctxClick object.
limit_valueThreshold value.
diodeDiode number.
Returns
none

@description This function sets high threshold value for external diodes.

◆ remotetemp_set_ext_diode_low_limit()

void remotetemp_set_ext_diode_low_limit ( remotetemp_t * ctx,
int16_t limit_value,
uint8_t diode )

Setting external diodes low limit.

Parameters
ctxClick object.
limit_valueThreshold value.
diodeDiode number.
Returns
none

@description This function sets low threshold values for external diodes.

◆ remotetemp_set_ext_diode_therm_limit()

void remotetemp_set_ext_diode_therm_limit ( remotetemp_t * ctx,
int16_t limit_value,
uint8_t diode )

Setting external diodes thermal limits.

Parameters
ctxClick object.
limit_valueThreshold value.
diodeDiode number.
Returns
none

@description This function sets thermal threshold values for external diodes.

◆ remotetemp_set_int_diode_high_limit()

void remotetemp_set_int_diode_high_limit ( remotetemp_t * ctx,
int16_t limit_value )

Setting Internal diode high limit.

Parameters
ctxClick object.
limit_valueThreshold value.
Returns
none

@description This function sets high threshold value for internal diode.

◆ remotetemp_set_int_diode_low_limit()

void remotetemp_set_int_diode_low_limit ( remotetemp_t * ctx,
int16_t limit_value )

Setting Internal diode low limit.

Parameters
ctxClick object.
limit_valueThreshold value.
Returns
none

@description This function sets low threshold value for internal diode.

◆ remotetemp_set_int_diode_therm_limit()

void remotetemp_set_int_diode_therm_limit ( remotetemp_t * ctx,
int16_t limit_value )

Setting internal diodes thermal limits.

Parameters
ctxClick object.
limit_valueThreshold value.
Returns
none

@description This function sets thermal threshold value for internal diode.

◆ remotetemp_set_range()

uint8_t remotetemp_set_range ( remotetemp_t * ctx,
uint8_t range_setting )

Setting temperature range.

Parameters
ctxClick object.
range_settingSets temperature range.
Returns
0 for successful range parameter.
1 for invalid range parameter.

@description This function sets temperature range (( from 0 to 127 ) or ( from (-64) to 191 )).

◆ remotetemp_write()

void remotetemp_write ( remotetemp_t * ctx,
uint8_t register_address,
uint8_t * register_values,
uint8_t n_bytes )

Setting register content.

Parameters
ctxClick object.
register_addressAddress of the (first) register to write to.
register_valuesBuffer for storing register content.
n_bytesNumber of registers(bytes) to read.
Returns
none

@description This function writes content to register(s).