driver_sgp41.h

Go to the documentation of this file.

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



typedef struct sgp41_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_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);         
    void (*delay_ms)(uint32_t ms);                                             
    void (*debug_print)(const char *const fmt, ...);                           
    uint8_t inited;                                                            
} sgp41_handle_t;

typedef struct sgp41_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;           
} sgp41_info_t;



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

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

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

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

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

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

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



uint8_t sgp41_info(sgp41_info_t *info);

uint8_t sgp41_init(sgp41_handle_t *handle);

uint8_t sgp41_deinit(sgp41_handle_t *handle);

uint8_t sgp41_get_execute_conditioning(sgp41_handle_t *handle, uint16_t *sraw_voc);

uint8_t sgp41_get_measure_raw(sgp41_handle_t *handle, uint16_t raw_humidity, uint16_t raw_temperature,
                              uint16_t *sraw_voc, uint16_t *sraw_nox);

uint8_t sgp41_get_measure_raw_without_compensation(sgp41_handle_t *handle, uint16_t *sraw_voc, uint16_t *sraw_nox);

uint8_t sgp41_humidity_convert_to_register(sgp41_handle_t *handle, float rh, uint16_t *reg);

uint8_t sgp41_temperature_convert_to_register(sgp41_handle_t *handle, float temp, uint16_t *reg);

uint8_t sgp41_get_measure_test(sgp41_handle_t *handle, uint16_t *result);

uint8_t sgp41_soft_reset(sgp41_handle_t *handle);

uint8_t sgp41_turn_heater_off(sgp41_handle_t *handle);

uint8_t sgp41_get_serial_id(sgp41_handle_t *handle, uint16_t id[3]);



uint8_t sgp41_set_reg(sgp41_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);

uint8_t sgp41_get_reg(sgp41_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif