temphum7  2.0.0.0
Functions

Functions

void temphum7_cfg_setup (temphum7_cfg_t *cfg)
 Config Object Initialization function. More...
 
TEMPHUM7_RETVAL temphum7_init (temphum7_t *ctx, temphum7_cfg_t *cfg)
 Initialization function. More...
 
void temphum7_default_cfg (temphum7_t *ctx)
 Click Default Configuration function. More...
 
void temphum7_generic_write (temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void temphum7_generic_read (temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
float temphum7_get_relative_humidity (temphum7_t *ctx, uint8_t mode_data)
 Relative humidity. More...
 
float temphum7_get_temperature (temphum7_t *ctx, uint8_t mode_data)
 Temerature. More...
 
void temphum7_get_electronic_serial_number (temphum7_t *ctx, uint8_t *esn_buffer)
 Electronic serial number. More...
 
uint8_t temphum7_get_firmware_revision (temphum7_t *ctx)
 Firmware revision. More...
 
float temphum7_get_heater_current (temphum7_t *ctx)
 Heater current. More...
 
void temphum7_reset (temphum7_t *ctx)
 Reset. More...
 

Detailed Description

Function Documentation

◆ temphum7_cfg_setup()

void temphum7_cfg_setup ( temphum7_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.

◆ temphum7_default_cfg()

void temphum7_default_cfg ( temphum7_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for TempHum7 click.

Note
Default configuration note.
   Set register : TEMPHUM7_WRITE_RHT_USER_REGISTER_1
   Data : TEMPHUM7_RESOLUTION_12_BIT

◆ temphum7_generic_read()

void temphum7_generic_read ( temphum7_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.

◆ temphum7_generic_write()

void temphum7_generic_write ( temphum7_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.

◆ temphum7_get_electronic_serial_number()

void temphum7_get_electronic_serial_number ( temphum7_t ctx,
uint8_t *  esn_buffer 
)

Electronic serial number.

Parameters
ctxClick object.
esn_bufferBuffer.

@description This function get electronical serial number.

◆ temphum7_get_firmware_revision()

uint8_t temphum7_get_firmware_revision ( temphum7_t ctx)

Firmware revision.

Parameters
ctxClick object.

@description This function get firmware revision.

◆ temphum7_get_heater_current()

float temphum7_get_heater_current ( temphum7_t ctx)

Heater current.

Parameters
ctxClick object.

@description This function get heater current.

◆ temphum7_get_relative_humidity()

float temphum7_get_relative_humidity ( temphum7_t ctx,
uint8_t  mode_data 
)

Relative humidity.

Parameters
ctxClick object.
mode_dataMode data.

@description This function get relative humidity.

◆ temphum7_get_temperature()

float temphum7_get_temperature ( temphum7_t ctx,
uint8_t  mode_data 
)

Temerature.

Parameters
ctxClick object.
mode_dataMode data.

@description This function get temperature.

◆ temphum7_init()

TEMPHUM7_RETVAL temphum7_init ( temphum7_t ctx,
temphum7_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ temphum7_reset()

void temphum7_reset ( temphum7_t ctx)

Reset.

Parameters
ctxClick object.

@description This function is reset.