Adafruit_BME680.h

Go to the documentation of this file.

#ifndef __BME680_H__
#define __BME680_H__

#include "Arduino.h"

#include "bme68x.h"
#include <Adafruit_I2CDevice.h>
#include <Adafruit_SPIDevice.h>
#include <Adafruit_Sensor.h>
#include <Wire.h>

#define BME68X_DEFAULT_ADDRESS (0x77)    
#define BME68X_DEFAULT_SPIFREQ (1000000) 

#define BME680_OS_16X BME68X_OS_16X   
#define BME680_OS_8X BME68X_OS_8X     
#define BME680_OS_4X BME68X_OS_4X     
#define BME680_OS_2X BME68X_OS_2X     
#define BME680_OS_1X BME68X_OS_1X     
#define BME680_OS_NONE BME68X_OS_NONE 

#define BME680_FILTER_SIZE_127                                                 \
  BME68X_FILTER_SIZE_127 
#define BME680_FILTER_SIZE_63                                                  \
  BME68X_FILTER_SIZE_63 
#define BME680_FILTER_SIZE_31                                                  \
  BME68X_FILTER_SIZE_31 
#define BME680_FILTER_SIZE_15                                                  \
  BME68X_FILTER_SIZE_15 
#define BME680_FILTER_SIZE_7                                                   \
  BME68X_FILTER_SIZE_7 
#define BME680_FILTER_SIZE_3                                                   \
  BME68X_FILTER_SIZE_3 
#define BME680_FILTER_SIZE_1                                                   \
  BME68X_FILTER_SIZE_1 
#define BME680_FILTER_SIZE_0                                                   \
  BME68X_FILTER_OFF 


class Adafruit_BME680 {
public:
  static constexpr int reading_not_started = -1;
  static constexpr int reading_complete = 0;

  Adafruit_BME680(TwoWire *theWire = &Wire);
  Adafruit_BME680(int8_t cspin, SPIClass *theSPI = &SPI);
  Adafruit_BME680(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin);

  bool begin(uint8_t addr = BME68X_DEFAULT_ADDRESS, bool initSettings = true);
  float readTemperature();
  float readPressure();
  float readHumidity();
  uint32_t readGas();
  float readAltitude(float seaLevel);

  bool setTemperatureOversampling(uint8_t os);
  bool setPressureOversampling(uint8_t os);
  bool setHumidityOversampling(uint8_t os);
  bool setIIRFilterSize(uint8_t fs);
  bool setGasHeater(uint16_t heaterTemp, uint16_t heaterTime);
  bool setODR(uint8_t odr);

  // Perform a reading in blocking mode.
  bool performReading();

  uint32_t beginReading();

  bool endReading();

  int remainingReadingMillis();

  float temperature;
  uint32_t pressure;
  float humidity;
  uint32_t gas_resistance;

private:
  Adafruit_I2CDevice *_i2cdev = NULL;
  Adafruit_SPIDevice *_spidev = NULL;
  TwoWire *_wire = NULL;

  int32_t _sensorID;
  uint32_t _meas_start = 0;
  uint16_t _meas_period = 0;

  struct bme68x_dev gas_sensor;
  struct bme68x_conf gas_conf;
  struct bme68x_heatr_conf gas_heatr_conf;
};

#endif