driver_htu31d.h

Go to the documentation of this file.

 
#ifndef DRIVER_HTU31D_H
#define DRIVER_HTU31D_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    HTU31D_ADDR_PIN_LOW  = (0x40 << 1),        
    HTU31D_ADDR_PIN_HIGH = (0x41 << 1),        
} htu31d_addr_pin_t;

typedef enum
{
    HTU31D_HUMIDITY_OSR_VERY_HIGH = 3,        
    HTU31D_HUMIDITY_OSR_HIGH      = 2,        
    HTU31D_HUMIDITY_OSR_MIDDLE    = 1,        
    HTU31D_HUMIDITY_OSR_LOW       = 0,        
} htu31d_humidity_osr_t;

typedef enum
{
    HTU31D_TEMPERATURE_OSR_VERY_HIGH = 3,        
    HTU31D_TEMPERATURE_OSR_HIGH      = 2,        
    HTU31D_TEMPERATURE_OSR_MIDDLE    = 1,        
    HTU31D_TEMPERATURE_OSR_LOW       = 0,        
} htu31d_temperature_osr_t;

typedef enum
{
    HTU31D_DIAGNOSTIC_NVM_ERROR                 = (1 << 7),        
    HTU31D_DIAGNOSTIC_HUMIDITY_UNDER_OVERRUN    = (1 << 6),        
    HTU31D_DIAGNOSTIC_HUMIDITY_HIGH_ERROR       = (1 << 5),        
    HTU31D_DIAGNOSTIC_HUMIDITY_LOW_ERROR        = (1 << 4),        
    HTU31D_DIAGNOSTIC_TEMPERATURE_UNDER_OVERRUN = (1 << 3),        
    HTU31D_DIAGNOSTIC_TEMPERATURE_HIGH_ERROR    = (1 << 2),        
    HTU31D_DIAGNOSTIC_TEMPERATURE_LOW_ERROR     = (1 << 1),        
    HTU31D_DIAGNOSTIC_HEATER_ON                 = (1 << 0),        
} htu31d_diagnostic_t;

typedef struct htu31d_handle_s
{
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t iic_addr;                                                                   
    uint8_t inited;                                                                     
    uint8_t humidity_osr;                                                               
    uint8_t temperature_osr;                                                            
} htu31d_handle_t;

typedef struct htu31d_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} htu31d_info_t;



#define DRIVER_HTU31D_LINK_INIT(HANDLE, STRUCTURE)               memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_HTU31D_LINK_IIC_INIT(HANDLE, FUC)                 (HANDLE)->iic_init = FUC

#define DRIVER_HTU31D_LINK_IIC_DEINIT(HANDLE, FUC)               (HANDLE)->iic_deinit = FUC

#define DRIVER_HTU31D_LINK_IIC_WRITE(HANDLE, FUC)                (HANDLE)->iic_write = FUC

#define DRIVER_HTU31D_LINK_IIC_READ(HANDLE, FUC)                 (HANDLE)->iic_read = FUC

#define DRIVER_HTU31D_LINK_DELAY_MS(HANDLE, FUC)                 (HANDLE)->delay_ms = FUC

#define DRIVER_HTU31D_LINK_DEBUG_PRINT(HANDLE, FUC)              (HANDLE)->debug_print = FUC



uint8_t htu31d_info(htu31d_info_t *info);

uint8_t htu31d_set_addr_pin(htu31d_handle_t *handle, htu31d_addr_pin_t addr_pin);

uint8_t htu31d_get_addr_pin(htu31d_handle_t *handle, htu31d_addr_pin_t *addr_pin);

uint8_t htu31d_init(htu31d_handle_t *handle);

uint8_t htu31d_deinit(htu31d_handle_t *handle);

uint8_t htu31d_set_humidity_osr(htu31d_handle_t *handle, htu31d_humidity_osr_t osr);

uint8_t htu31d_get_humidity_osr(htu31d_handle_t *handle, htu31d_humidity_osr_t *osr);

uint8_t htu31d_set_temperature_osr(htu31d_handle_t *handle, htu31d_temperature_osr_t osr);

uint8_t htu31d_get_temperature_osr(htu31d_handle_t *handle, htu31d_temperature_osr_t *osr);

uint8_t htu31d_read_temperature_humidity(htu31d_handle_t *handle,
                                         uint16_t *temperature_raw, float *temperature_s,
                                         uint16_t *humidity_raw, float *humidity_s
                                        );

uint8_t htu31d_read_humidity(htu31d_handle_t *handle, uint16_t *humidity_raw, float *humidity_s);

uint8_t htu31d_soft_reset(htu31d_handle_t *handle);

uint8_t htu31d_set_heater_on(htu31d_handle_t *handle);

uint8_t htu31d_set_heater_off(htu31d_handle_t *handle);

uint8_t htu31d_get_serial_number(htu31d_handle_t *handle, uint8_t number[3]);

uint8_t htu31d_get_diagnostic(htu31d_handle_t *handle, uint8_t *diagnostic);



uint8_t htu31d_set_reg(htu31d_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t htu31d_get_reg(htu31d_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif