driver_sht2x.h

Go to the documentation of this file.

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



typedef enum
{
    SHT2X_BOOL_FALSE = 0x00,        
    SHT2X_BOOL_TRUE  = 0x01,        
} sht2x_bool_t;

typedef enum  
{
    SHT35_STATUS_VDD_OVER_2P25V = 0,        
    SHT35_STATUS_VDD_LESS_2P25V = 1,        
} sht2x_status_t;

typedef enum
{
    SHT2X_MODE_HOLD_MASTER    = 0x00,        
    SHT2X_MODE_NO_HOLD_MASTER = 0x01,        
} sht2x_mode_t;

typedef enum  
{
    SHT2X_RESOLUTION_RH_12BIT_T_14BIT = 0x00,        
    SHT2X_RESOLUTION_RH_8BIT_T_12BIT  = 0x01,        
    SHT2X_RESOLUTION_RH_10BIT_T_13BIT = 0x02,        
    SHT2X_RESOLUTION_RH_11BIT_T_11BIT = 0x03,        
} sht2x_resolution_t;

typedef struct sht2x_handle_s
{
    uint8_t (*iic_init)(void);                                                                     
    uint8_t (*iic_deinit)(void);                                                                   
    uint8_t (*iic_write_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);                            
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);                   
    uint8_t (*iic_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);                             
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);                    
    uint8_t (*iic_read_with_wait)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);          
    uint8_t (*iic_read_address16)(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t len);         
    void (*delay_ms)(uint32_t ms);                                                                 
    void (*debug_print)(const char *const fmt, ...);                                               
    uint8_t resolution;                                                                            
    uint8_t mode;                                                                                  
    uint8_t inited;                                                                                
} sht2x_handle_t;

typedef struct sht2x_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;           
} sht2x_info_t;



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

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

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

#define DRIVER_SHT2X_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)     (HANDLE)->iic_write_cmd = FUC

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

#define DRIVER_SHT2X_LINK_IIC_READ_COMMAND(HANDLE, FUC)      (HANDLE)->iic_read_cmd = FUC

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

#define DRIVER_SHT2X_LINK_IIC_READ_WITH_WAIT(HANDLE, FUC)    (HANDLE)->iic_read_with_wait = FUC

#define DRIVER_SHT2X_LINK_IIC_READ_ADDRESS16(HANDLE, FUC)    (HANDLE)->iic_read_address16 = FUC

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

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



uint8_t sht2x_info(sht2x_info_t *info);

uint8_t sht2x_init(sht2x_handle_t *handle);

uint8_t sht2x_deinit(sht2x_handle_t *handle);

uint8_t sht2x_read(sht2x_handle_t *handle, uint16_t *temperature_raw, float *temperature_s,
                   uint16_t *humidity_raw, float *humidity_s);

uint8_t sht2x_set_mode(sht2x_handle_t *handle, sht2x_mode_t mode);

uint8_t sht2x_get_mode(sht2x_handle_t *handle, sht2x_mode_t *mode);

uint8_t sht2x_soft_reset(sht2x_handle_t *handle);

uint8_t sht2x_set_resolution(sht2x_handle_t *handle, sht2x_resolution_t resolution);

uint8_t sht2x_get_resolution(sht2x_handle_t *handle, sht2x_resolution_t *resolution);

uint8_t sht2x_set_heater(sht2x_handle_t *handle, sht2x_bool_t enable);

uint8_t sht2x_get_heater(sht2x_handle_t *handle, sht2x_bool_t *enable);

uint8_t sht2x_set_disable_otp_reload(sht2x_handle_t *handle, sht2x_bool_t enable);

uint8_t sht2x_get_disable_otp_reload(sht2x_handle_t *handle, sht2x_bool_t *enable);

uint8_t sht2x_get_status(sht2x_handle_t *handle, sht2x_status_t *status);

uint8_t sht2x_get_serial_number(sht2x_handle_t *handle, uint8_t sn[8]);



uint8_t sht2x_set_reg(sht2x_handle_t *handle, uint8_t reg, uint8_t *data, uint16_t len);

uint8_t sht2x_get_reg(sht2x_handle_t *handle, uint8_t reg, uint8_t *data, uint16_t len);

uint8_t sht2x_get_reg16(sht2x_handle_t *handle, uint16_t reg, uint8_t *data, uint16_t len);

uint8_t sht2x_set_cmd(sht2x_handle_t *handle, uint8_t *data, uint16_t len);

uint8_t sht2x_get_cmd(sht2x_handle_t *handle, uint8_t *data, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif