temphum5 2.0.0.0

Functions

void temphum5_cfg_setup (temphum5_cfg_t *cfg)
 Config Object Initialization function.
 
TEMPHUM5_RETVAL temphum5_init (temphum5_t *ctx, temphum5_cfg_t *cfg)
 Initialization function.
 
void temphum5_generic_write (temphum5_t *ctx, uint8_t cmd)
 Generic write function.
 
void temphum5_generic_read (temphum5_t *ctx, uint8_t *data_out)
 Generic read function.
 
uint8_t temphum5_start_measurement (temphum5_t *ctx)
 Functions for start measurement.
 
float temphum5_get_temperature (temphum5_t *ctx, uint8_t temp_in)
 Functions for read Temperature data.
 
float temphum5_get_humidity (temphum5_t *ctx)
 Functions for read Relative Huminidy data.
 
uint8_t temphum5_get_alarm (temphum5_t *ctx, uint8_t alarm)
 Functions for get output Alarm.
 

Detailed Description

Function Documentation

◆ temphum5_cfg_setup()

void temphum5_cfg_setup ( temphum5_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.

◆ temphum5_generic_read()

void temphum5_generic_read ( temphum5_t * ctx,
uint8_t * data_out )

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.

◆ temphum5_generic_write()

void temphum5_generic_write ( temphum5_t * ctx,
uint8_t cmd )

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.

◆ temphum5_get_alarm()

uint8_t temphum5_get_alarm ( temphum5_t * ctx,
uint8_t alarm )

Functions for get output Alarm.

Parameters
ctxClick object.
alarmOutput Alarm (HIGH or LOW)

@description The alarm is set by default and it is not possible to change it

◆ temphum5_get_humidity()

float temphum5_get_humidity ( temphum5_t * ctx)

Functions for read Relative Huminidy data.

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

◆ temphum5_get_temperature()

float temphum5_get_temperature ( temphum5_t * ctx,
uint8_t temp_in )

Functions for read Temperature data.

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

◆ temphum5_init()

TEMPHUM5_RETVAL temphum5_init ( temphum5_t * ctx,
temphum5_cfg_t * cfg )

Initialization function.

Parameters
temphum5Click object.
cfgClick configuration structure.

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

◆ temphum5_start_measurement()

uint8_t temphum5_start_measurement ( temphum5_t * ctx)

Functions for start measurement.

Parameters
ctxClick object.
Returns
Modul status
Note
  Status:
    - Normal Operation, Valid Data that has not been fetched since the last measurement cycle.
    - Stale Data: Data that has already been fetched since the last measurement cycle, or
                  data fetched before the first measurement has been completed.
    - Device in Command Mode - Command Mode is used for programming the sensor.
*