driver_ccs811.h

Go to the documentation of this file.

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



typedef enum
{
    CCS811_ADDRESS_GND = (0x5A << 1),        
    CCS811_ADDRESS_VCC = (0x5B << 1),        
} ccs811_address_t;

typedef enum
{
    CCS811_BOOL_FALSE = 0x00,        
    CCS811_BOOL_TRUE  = 0x01,        
} ccs811_bool_t;

typedef enum
{
    CCS811_MODE_IDLE                     = 0x00,        
    CCS811_MODE_CONSTANT_POWER           = 0x01,        
    CCS811_MODE_PULSE_HEATING            = 0x02,        
    CCS811_MODE_LOW_POWER_PULSE_HEATING  = 0x03,        
    CCS811_MODE_HIGH_CONSTANT_POWER      = 0x04,        
} ccs811_mode_t;

typedef enum
{
    CCS811_STATUS_FW_MODE    = (1 << 7),        
    CCS811_STATUS_APP_VALID  = (1 << 4),        
    CCS811_STATUS_DATA_READY = (1 << 3),        
    CCS811_STATUS_ERROR      = (1 << 0),        
} ccs811_status_t;

typedef enum
{
    CCS811_INTERRUPT_READY     = 0x03,        
    CCS811_INTERRUPT_THRESHOLD = 0x02,        
} ccs811_interrupt;

typedef enum
{
    CCS811_ERROR_WRITE_REG_INVALID = (1 << 0),        
    CCS811_ERROR_READ_REG_INVALID  = (1 << 1),        
    CCS811_ERROR_MEASMODE_INVALID  = (1 << 2),        
    CCS811_ERROR_MAX_RESISTANCE    = (1 << 3),        
    CCS811_ERROR_HEATER_FAULT      = (1 << 4),        
    CCS811_ERROR_HEATER_SUPPLY     = (1 << 5),        
} ccs811_error_t;

typedef struct ccs811_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);         
    uint8_t (*gpio_wake_init)(void);                                                    
    uint8_t (*gpio_wake_deinit)(void);                                                  
    uint8_t (*gpio_wake_write)(uint8_t level);                                          
    uint8_t (*gpio_reset_init)(void);                                                   
    uint8_t (*gpio_reset_deinit)(void);                                                 
    uint8_t (*gpio_reset_write)(uint8_t level);                                         
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t (*bin_read_init)(char *name, uint32_t *size);                               
    uint8_t (*bin_read)(uint32_t addr, uint16_t size, uint8_t *buffer);                 
    uint8_t (*bin_read_deinit)(void);                                                   
    uint8_t inited;                                                                     
    uint8_t iic_addr;                                                                   
    uint8_t buf[256];                                                                   
} ccs811_handle_t;

typedef struct ccs811_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;           
} ccs811_info_t;



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

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

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

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

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

#define DRIVER_CCS811_LINK_GPIO_WAKE_INIT(HANDLE, FUC)       (HANDLE)->gpio_wake_init = FUC

#define DRIVER_CCS811_LINK_GPIO_WAKE_DEINIT(HANDLE, FUC)     (HANDLE)->gpio_wake_deinit = FUC

#define DRIVER_CCS811_LINK_GPIO_WAKE_WRITE(HANDLE, FUC)      (HANDLE)->gpio_wake_write = FUC

#define DRIVER_CCS811_LINK_GPIO_RESET_INIT(HANDLE, FUC)      (HANDLE)->gpio_reset_init = FUC

#define DRIVER_CCS811_LINK_GPIO_RESET_DEINIT(HANDLE, FUC)    (HANDLE)->gpio_reset_deinit = FUC

#define DRIVER_CCS811_LINK_GPIO_RESET_WRITE(HANDLE, FUC)     (HANDLE)->gpio_reset_write = FUC

#define DRIVER_CCS811_LINK_BIN_READ_INIT(HANDLE, FUC)        (HANDLE)->bin_read_init = FUC

#define DRIVER_CCS811_LINK_BIN_READ_DEINIT(HANDLE, FUC)      (HANDLE)->bin_read_deinit = FUC

#define DRIVER_CCS811_LINK_BIN_READ(HANDLE, FUC)             (HANDLE)->bin_read = FUC

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

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



uint8_t ccs811_info(ccs811_info_t *info);

uint8_t ccs811_set_addr_pin(ccs811_handle_t *handle, ccs811_address_t addr_pin);

uint8_t ccs811_get_addr_pin(ccs811_handle_t *handle, ccs811_address_t *addr_pin);

uint8_t ccs811_init(ccs811_handle_t *handle);

uint8_t ccs811_deinit(ccs811_handle_t *handle);

uint8_t ccs811_read(ccs811_handle_t *handle, uint16_t *eco2_ppm, uint16_t *tvoc_ppb, uint16_t *raw);

uint8_t ccs811_get_raw_data(ccs811_handle_t *handle, uint16_t *raw, uint8_t *ua, uint16_t *adc_raw, float *adc_v);

uint8_t ccs811_get_status(ccs811_handle_t *handle, uint8_t *status);

uint8_t ccs811_set_mode(ccs811_handle_t *handle, ccs811_mode_t mode);

uint8_t ccs811_get_mode(ccs811_handle_t *handle, ccs811_mode_t *mode);

uint8_t ccs811_set_interrupt_data_ready(ccs811_handle_t *handle, ccs811_bool_t enable);

uint8_t ccs811_get_interrupt_data_ready(ccs811_handle_t *handle, ccs811_bool_t *enable);

uint8_t ccs811_set_interrupt_threshold(ccs811_handle_t *handle, ccs811_bool_t enable);

uint8_t ccs811_get_interrupt_threshold(ccs811_handle_t *handle, ccs811_bool_t *enable);

uint8_t ccs811_set_environment_data(ccs811_handle_t *handle, uint16_t humidity_raw, uint16_t temperature_raw);

uint8_t ccs811_set_eco2_threshold(ccs811_handle_t *handle, uint16_t low_medium_ppm, uint16_t medium_high_ppm, uint8_t hysteresis);

uint8_t ccs811_set_baseline(ccs811_handle_t *handle, uint16_t baseline);

uint8_t ccs811_get_baseline(ccs811_handle_t *handle, uint16_t *baseline);

uint8_t ccs811_get_error_id(ccs811_handle_t *handle, uint8_t *id);

uint8_t ccs811_get_hardware_id(ccs811_handle_t *handle, uint8_t *id);

uint8_t ccs811_get_hardware_version(ccs811_handle_t *handle, uint8_t *version);

uint8_t ccs811_get_firmware_bootloader_version(ccs811_handle_t *handle, uint8_t *major, uint8_t *minor, uint8_t *trivial);

uint8_t ccs811_get_firmware_application_version(ccs811_handle_t *handle, uint8_t *major, uint8_t *minor, uint8_t *trivial);

uint8_t ccs811_soft_reset(ccs811_handle_t *handle);

uint8_t ccs811_wake_up(ccs811_handle_t *handle, ccs811_bool_t enable);

uint8_t ccs811_hard_reset(ccs811_handle_t *handle);

uint8_t ccs811_environment_humidity_convert_to_register(ccs811_handle_t *handle, float humidity, uint16_t *reg);

uint8_t ccs811_environment_humidity_convert_to_data(ccs811_handle_t *handle, uint16_t reg, float *humidity);

uint8_t ccs811_environment_temperature_convert_to_register(ccs811_handle_t *handle, float temperature, uint16_t *reg);

uint8_t ccs811_environment_temperature_convert_to_data(ccs811_handle_t *handle, uint16_t reg, float *temperature);



uint8_t ccs811_app_erase(ccs811_handle_t *handle);

uint8_t ccs811_app_verify(ccs811_handle_t *handle);

uint8_t ccs811_app_start(ccs811_handle_t *handle);

uint8_t ccs811_app_program(ccs811_handle_t *handle, uint8_t *rom, uint32_t len);

uint8_t ccs811_app_firmware_init(ccs811_handle_t *handle);

uint8_t ccs811_app_firmware_update(ccs811_handle_t *handle, char *path);



uint8_t ccs811_set_reg(ccs811_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t ccs811_get_reg(ccs811_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif