temphum6 2.0.0.0

Functions

void temphum6_cfg_setup (temphum6_cfg_t *cfg)
 Config Object Initialization function.
 
TEMPHUM6_RETVAL temphum6_init (temphum6_t *ctx, temphum6_cfg_t *cfg)
 Initialization function.
 
void temphum6_generic_write (temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void temphum6_generic_read (temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
void temphum6_reset (temphum6_t *ctx)
 Functions for reset device.
 
uint16_t temphum6_get_part_id (temphum6_t *ctx)
 Functions for get device PART ID.
 
void temphum6_run (temphum6_t *ctx)
 Functions for RUN measurement.
 
float temphum6_read_temperature (temphum6_t *ctx, uint8_t temp_in)
 Functions for read Temperature data.
 
float temphum6_read_relative_huminidy (temphum6_t *ctx)
 Functions for read Relative Huminidy data.
 

Detailed Description

Function Documentation

◆ temphum6_cfg_setup()

void temphum6_cfg_setup ( temphum6_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.

◆ temphum6_generic_read()

void temphum6_generic_read ( temphum6_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.

◆ temphum6_generic_write()

void temphum6_generic_write ( temphum6_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.

◆ temphum6_get_part_id()

uint16_t temphum6_get_part_id ( temphum6_t * ctx)

Functions for get device PART ID.

Parameters
ctxClick object.
Returns
16bit device part id

@description This function returns the device part id.

◆ temphum6_init()

TEMPHUM6_RETVAL temphum6_init ( temphum6_t * ctx,
temphum6_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ temphum6_read_relative_huminidy()

float temphum6_read_relative_huminidy ( temphum6_t * ctx)

Functions for read Relative Huminidy data.

Parameters
ctxClick object.
Returns
Relative Huminidy data in [RH]

@description This function returns read relative Humidity data.

◆ temphum6_read_temperature()

float temphum6_read_temperature ( temphum6_t * ctx,
uint8_t temp_in )

Functions for read Temperature data.

Parameters
ctxClick object.
temp_inTemperature in ... (FAHRENHEIT, KELVIN, CELSIUS)
Returns
Temperature data

@description This function returns read Temperature data.

◆ temphum6_reset()

void temphum6_reset ( temphum6_t * ctx)

Functions for reset device.

Parameters
ctxClick object.

@description This functions resets the device.

◆ temphum6_run()

void temphum6_run ( temphum6_t * ctx)

Functions for RUN measurement.

Parameters
ctxClick object.

@description The function sets the registers _TEMPHUM6_REG_SENS_RUN and _TEMPHUM6_REG_SENS_START.

   RUN   : ( _TEMPHUM6_HUM_RUN_SINGLE_SHOT_MODE | _TEMPHUM6_TEMP_RUN_SINGLE_SHOT_MODE )
   START : ( _TEMPHUM6_HUM_START_MEASUREMENT | _TEMPHUM6_TEMP_START_MEASUREMENT )