temphum14 2.0.0.0
temphum14.h File Reference

This file contains API for Temp Hum 14 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  temphum14_t
 Temp Hum 14 Click context object. More...
 
struct  temphum14_cfg_t
 Temp Hum 14 Click configuration object. More...
 
struct  temphum14_diagn_t
 

Macros

#define TEMPHUM14_I2C_SLAVE_ADDR_GND   0x40
 Temp Hum 14 description register.
 
#define TEMPHUM14_I2C_SLAVE_ADDR_VCC   0x41
 
#define TEMPHUM14_CMD_RESET   0x1E
 Temp Hum 14 device commands.
 
#define TEMPHUM14_CMD_HEATER_ON   0x04
 
#define TEMPHUM14_CMD_HEATER_OFF   0x02
 
#define TEMPHUM14_CMD_READ_T_AND_RH   0x00
 
#define TEMPHUM14_CMD_READ_RH   0x10
 
#define TEMPHUM14_CMD_CONVERSION   0x40
 
#define TEMPHUM14_CMD_READ_DIAGNOSTIC   0x08
 
#define TEMPHUM14_CMD_READ_SERIAL_NUMBER   0x0A
 
#define TEMPHUM14_CONVERSION_HUM_OSR_0_007   0x18
 Temp Hum 14 device conversion settings.
 
#define TEMPHUM14_CONVERSION_HUM_OSR_0_010   0x10
 
#define TEMPHUM14_CONVERSION_HUM_OSR_0_014   0x08
 
#define TEMPHUM14_CONVERSION_HUM_OSR_0_020   0x00
 
#define TEMPHUM14_CONVERSION_TEMP_0_012   0x06
 
#define TEMPHUM14_CONVERSION_TEMP_0_016   0x04
 
#define TEMPHUM14_CONVERSION_TEMP_0_025   0x02
 
#define TEMPHUM14_CONVERSION_TEMP_0_040   0x00
 
#define TEMPHUM14_BIT_MASK_HUM_OSR   0x18
 Temp Hum 14 device bit mask settings.
 
#define TEMPHUM14_BIT_MASK_TEMP_OSR   0x06
 
#define TEMPHUM14_HEATER_DISABLE   0x00
 Temp Hum 14 device heater turning settings.
 
#define TEMPHUM14_HEATER_ENABLE   0x01
 
#define TEMPHUM14_STATUS_OFF   0x00
 Temp Hum 14 device status on and off.
 
#define TEMPHUM14_STATUS_ON   0x01
 
#define TEMPHUM14_CALC_16_BIT_DIVIDER   65535.0
 Temp Hum 14 device calculation settings.
 
#define TEMPHUM14_CALC_TEMP_MULTI_FACT   165.000
 
#define TEMPHUM14_CALC_TEMP_SUB_FACT   40.0000
 
#define TEMPHUM14_CALC_HUM_MULTI_FACT   100.000
 
#define TEMPHUM14_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  temphum14_return_value_t { TEMPHUM14_OK = 0 , TEMPHUM14_ERROR = -1 }
 Temp Hum 14 Click return value data. More...
 

Functions

void temphum14_cfg_setup (temphum14_cfg_t *cfg)
 Temp Hum 14 configuration object setup function.
 
err_t temphum14_init (temphum14_t *ctx, temphum14_cfg_t *cfg)
 Temp Hum 14 initialization function.
 
err_t temphum14_generic_write (temphum14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 Temp Hum 14 I2C writing function.
 
err_t temphum14_generic_read (temphum14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 Temp Hum 14 I2C reading function.
 
void temphum14_hw_reset (temphum14_t *ctx)
 HW reset function.
 
void temphum14_set_cmd (temphum14_t *ctx, uint8_t cmd)
 Send command function.
 
void temphum14_set_conversion (temphum14_t *ctx, uint8_t hum_osr, uint8_t temp_osr)
 Set conversion function.
 
void temphum14_read_t_and_rh (temphum14_t *ctx, uint8_t *p_rx_data)
 Read temperature and humidity data function.
 
void temphum14_get_temp_and_hum (temphum14_t *ctx, float *temp, float *hum)
 Get temperature and humidity data function.
 
void temphum14_read_rh (temphum14_t *ctx, uint8_t *p_rx_data)
 Read humidity data function.
 
float temphum14_get_hum (temphum14_t *ctx)
 Get humidity data function.
 
void temphum14_soft_reset (temphum14_t *ctx)
 Soft reset function.
 
void temphum14_set_heater (temphum14_t *ctx, uint8_t en_heater)
 Enable heater function.
 
void temphum14_get_diagnostic (temphum14_t *ctx, temphum14_diagn_t *diag_data)
 Get diagnostic status function.
 
uint32_t temphum14_get_serial_number (temphum14_t *ctx)
 Get serial number function.
 

Detailed Description

This file contains API for Temp Hum 14 Click Driver.

Enumeration Type Documentation

◆ temphum14_return_value_t

Temp Hum 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
TEMPHUM14_OK 
TEMPHUM14_ERROR