ccs811.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include <stdint.h>
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C"
{
#endif

#define CCS811_I2C_ADDRESS_1    (0x5A)  
#define CCS811_I2C_ADDRESS_2    (0x5B)

#define CCS811_ECO2_RANGE_MIN   (400)   
#define CCS811_ECO2_RANGE_MAX   (8192)  
#define CCS811_TVOC_RANGE_MIN   (0)     
#define CCS811_TVOC_RANGE_MAX   (1187)  

typedef enum {
    CCS811_OK,                   
    CCS811_ERROR_I2C,            
    CCS811_ERROR_NO_DEV,         
    CCS811_ERROR_NO_APP,         
    CCS811_ERROR_NO_NEW_DATA,    
    CCS811_ERROR_NO_IAQ_DATA,    
    CCS811_ERROR_WRITE_REG_INV,  
    CCS811_ERROR_READ_REG_INV,   
    CCS811_ERROR_MEASMODE_INV,   
    CCS811_ERROR_THRESH_INV,     
    CCS811_ERROR_MAX_RESISTANCE, 
    CCS811_ERROR_HEATER_FAULT,   
    CCS811_ERROR_HEATER_SUPPLY,  
    CCS811_ERROR_NO_INT_PIN,     
    CCS811_ERROR_NO_WAKE_PIN,    
    CCS811_ERROR_NO_RESET_PIN,   
    CCS811_ERROR_NOT_SUPPORTED,  
} ccs811_error_codes_t;

typedef enum {
    CCS811_MODE_IDLE  = 0, 
    CCS811_MODE_1S    = 1, 
    CCS811_MODE_10S   = 2, 
    CCS811_MODE_60S   = 3, 
    CCS811_MODE_250MS = 4  
} ccs811_mode_t;

typedef enum {
    CCS811_INT_NONE = 0,    
    CCS811_INT_DATA_READY,  
    CCS811_INT_THRESHOLD,   
} ccs811_int_mode_t;

typedef struct {
 
    i2c_t   i2c_dev;            
    uint8_t i2c_addr;           
    ccs811_mode_t mode;         
#if MODULE_CCS811_FULL || DOXYGEN
    gpio_t  int_pin;            
    ccs811_int_mode_t int_mode; 
#endif
    gpio_t  wake_pin;           
    gpio_t  reset_pin;          
} ccs811_params_t;

typedef struct {
    ccs811_params_t params;     
} ccs811_t;

int ccs811_init (ccs811_t *dev, const ccs811_params_t *params);

int ccs811_read_iaq (const ccs811_t *dev,
                     uint16_t *iaq_tvoc, uint16_t *iaq_eco2,
                     uint16_t *raw_i, uint16_t *raw_v);
 
#if MODULE_CCS811_FULL || DOXYGEN

int ccs811_read_ntc (const ccs811_t *dev, uint32_t r_ref, uint32_t *r_ntc);
 
#endif /* MODULE_CCS811_FULL || DOXYGEN */

int ccs811_data_ready (const ccs811_t *dev);

int ccs811_power_down (ccs811_t *dev);

int ccs811_power_up (ccs811_t *dev);

int ccs811_set_mode (ccs811_t *dev, ccs811_mode_t mode);
 
#if MODULE_CCS811_FULL || DOXYGEN
int ccs811_set_int_mode (ccs811_t *dev, ccs811_int_mode_t mode);

int ccs811_set_environmental_data (const ccs811_t *dev,
                                   int16_t temp, int16_t hum);

int ccs811_set_eco2_thresholds (const ccs811_t *dev,
                                uint16_t low, uint16_t high, uint8_t hyst);

int ccs811_get_baseline (const ccs811_t *dev, uint16_t *baseline);

int ccs811_set_baseline (const ccs811_t *dev, uint16_t baseline);
#endif /* MODULE_CCS811_FULL || DOXYGEN */
 
#ifdef __cplusplus
}
#endif