bme680.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019 Mesotic SAS
 * SPDX-FileCopyrightText: 2020 Gunar Schorcht
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "periph/i2c.h"
#include "periph/spi.h"
 
#ifdef MODULE_BME680_FP
#define BME680_FLOAT_POINT_COMPENSATION
#endif
 
#include "bme680_hal.h"
#include "bme680_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define BME680_I2C_ADDR_1   (0x76)

#define BME680_I2C_ADDR_2   (0x77)

#define BME680_SENSOR(d)    (*((struct bme680_dev *)d))

enum {
    BME680_NULL_PTR     = -1,   
    BME680_COM_FAILED   = -2,   
    BME680_NO_DEV       = -3,   
    BME680_INVALID      = -4,   
    BME680_NO_NEW_DATA  = -5,   
};
 
#ifdef DOXYGEN
typedef struct bme680_field_data {
    uint8_t status;     
    uint8_t gas_index;  
    uint8_t meas_index; 
#ifndef MODULE_BME680_FP
    int16_t temperature;        
    uint32_t pressure;          
    uint32_t humidity;          
    uint32_t gas_resistance;    
#else /* MODULE_BME680_FP */
    float temperature;          
    float pressure;             
    float humidity;             
    float gas_resistance;       
#endif /* MODULE_BME680_FP */
};
 
#endif /* DOXYGEN */

typedef struct bme680_field_data bme680_field_data_t;

typedef struct bme680_dev bme680_dev_t;

typedef struct {
    i2c_t dev;                    
    uint8_t addr;                 
} bme680_intf_i2c_t;

typedef struct {
    spi_t dev;                  
    gpio_t nss_pin;             
} bme680_intf_spi_t;

typedef union {
    bme680_intf_i2c_t i2c;        
    bme680_intf_spi_t spi;        
} bme680_intf_t;

typedef struct {
    uint8_t ifsel;              
    uint8_t temp_os;            
    uint8_t hum_os;             
    uint8_t pres_os;            
    uint8_t filter;             
    uint8_t gas_measure;        
    uint16_t heater_dur;        
    uint16_t heater_temp;       
    uint8_t power_mode;         
    uint8_t settings;           
    bme680_intf_t intf;         
} bme680_params_t;

typedef struct {
    struct bme680_dev sensor; 
    bme680_intf_t intf;       
} bme680_t;

extern bme680_t *bme680_devs[];

extern unsigned int bme680_devs_numof;

int bme680_init(bme680_t *dev, const bme680_params_t *params);

int bme680_force_measurement(bme680_t *dev);

int bme680_get_duration(bme680_t* dev);

int bme680_get_data(bme680_t* dev, bme680_field_data_t *data);

int bme680_set_ambient_temp(bme680_t* dev, int8_t temp);
 
#ifdef __cplusplus
}
#endif