Nahrát soubory do 'src'
This commit is contained in:
parent
efcb66b5ba
commit
e675a504db
675
src/Adafruit_BME680.cpp
Normal file
675
src/Adafruit_BME680.cpp
Normal file
@ -0,0 +1,675 @@
|
|||||||
|
/*!
|
||||||
|
* @file Adafruit_BME680.cpp
|
||||||
|
*
|
||||||
|
* @mainpage Adafruit BME680 temperature, humidity, barometric pressure and gas sensor driver
|
||||||
|
*
|
||||||
|
* @section intro_sec Introduction
|
||||||
|
*
|
||||||
|
* This is the documentation for Adafruit's BME680 driver for the
|
||||||
|
* Arduino platform. It is designed specifically to work with the
|
||||||
|
* Adafruit BME680 breakout: https://www.adafruit.com/products/3660
|
||||||
|
*
|
||||||
|
* These sensors use I2C to communicate, 2 pins (SCL+SDA) are required
|
||||||
|
* to interface with the breakout.
|
||||||
|
*
|
||||||
|
* Adafruit invests time and resources providing this open source code,
|
||||||
|
* please support Adafruit and open-source hardware by purchasing
|
||||||
|
* products from Adafruit!
|
||||||
|
*
|
||||||
|
* @section author Author
|
||||||
|
*
|
||||||
|
* Written by Ladyada for Adafruit Industries.
|
||||||
|
*
|
||||||
|
* @section license License
|
||||||
|
*
|
||||||
|
* BSD license, all text here must be included in any redistribution.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "Arduino.h"
|
||||||
|
#include "Adafruit_BME680.h"
|
||||||
|
|
||||||
|
//#define BME680_DEBUG
|
||||||
|
|
||||||
|
///! These SPI pins must be global in order to work with underlying library
|
||||||
|
int8_t _BME680_SoftwareSPI_MOSI; ///< Global SPI MOSI pin
|
||||||
|
int8_t _BME680_SoftwareSPI_MISO; ///< Global SPI MISO pin
|
||||||
|
int8_t _BME680_SoftwareSPI_SCK; ///< Globak SPI Clock pin
|
||||||
|
|
||||||
|
// Our hardware interface functions
|
||||||
|
static int8_t i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len);
|
||||||
|
static int8_t i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len);
|
||||||
|
static int8_t spi_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len);
|
||||||
|
static int8_t spi_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len);
|
||||||
|
static uint8_t spi_transfer(uint8_t x);
|
||||||
|
static void delay_msec(uint32_t ms);
|
||||||
|
|
||||||
|
/***************************************************************************
|
||||||
|
PUBLIC FUNCTIONS
|
||||||
|
***************************************************************************/
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Instantiates sensor with Hardware SPI or I2C.
|
||||||
|
@param cspin SPI chip select. If not passed in, I2C will be used
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
Adafruit_BME680::Adafruit_BME680(int8_t cspin)
|
||||||
|
: _cs(cspin)
|
||||||
|
, _meas_start(0)
|
||||||
|
, _meas_period(0)
|
||||||
|
{
|
||||||
|
_BME680_SoftwareSPI_MOSI = -1;
|
||||||
|
_BME680_SoftwareSPI_MISO = -1;
|
||||||
|
_BME680_SoftwareSPI_SCK = -1;
|
||||||
|
_filterEnabled = _tempEnabled = _humEnabled = _presEnabled = _gasEnabled = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Instantiates sensor with Software (bit-bang) SPI.
|
||||||
|
@param cspin SPI chip select
|
||||||
|
@param mosipin SPI MOSI (Data from microcontroller to sensor)
|
||||||
|
@param misopin SPI MISO (Data to microcontroller from sensor)
|
||||||
|
@param sckpin SPI Clock
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
Adafruit_BME680::Adafruit_BME680(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin)
|
||||||
|
: _cs(cspin)
|
||||||
|
, _meas_start(0)
|
||||||
|
, _meas_period(0)
|
||||||
|
{
|
||||||
|
_BME680_SoftwareSPI_MOSI = mosipin;
|
||||||
|
_BME680_SoftwareSPI_MISO = misopin;
|
||||||
|
_BME680_SoftwareSPI_SCK = sckpin;
|
||||||
|
_filterEnabled = _tempEnabled = _humEnabled = _presEnabled = _gasEnabled = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Initializes the sensor
|
||||||
|
|
||||||
|
Hardware ss initialized, verifies it is in the I2C or SPI bus, then reads
|
||||||
|
calibration data in preparation for sensor reads.
|
||||||
|
|
||||||
|
@param addr Optional parameter for the I2C address of BME680. Default is 0x77
|
||||||
|
@param initSettings Optional parameter for initializing the sensor settings.
|
||||||
|
Default is true.
|
||||||
|
@return True on sensor initialization success. False on failure.
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
bool Adafruit_BME680::begin(uint8_t addr, bool initSettings) {
|
||||||
|
_i2caddr = addr;
|
||||||
|
|
||||||
|
if (_cs == -1) {
|
||||||
|
// i2c
|
||||||
|
Wire.begin();
|
||||||
|
|
||||||
|
gas_sensor.dev_id = addr;
|
||||||
|
gas_sensor.intf = BME680_I2C_INTF;
|
||||||
|
gas_sensor.read = &i2c_read;
|
||||||
|
gas_sensor.write = &i2c_write;
|
||||||
|
} else {
|
||||||
|
digitalWrite(_cs, HIGH);
|
||||||
|
pinMode(_cs, OUTPUT);
|
||||||
|
|
||||||
|
if (_BME680_SoftwareSPI_SCK == -1) {
|
||||||
|
// hardware SPI
|
||||||
|
SPI.begin();
|
||||||
|
} else {
|
||||||
|
// software SPI
|
||||||
|
pinMode(_BME680_SoftwareSPI_SCK, OUTPUT);
|
||||||
|
pinMode(_BME680_SoftwareSPI_MOSI, OUTPUT);
|
||||||
|
pinMode(_BME680_SoftwareSPI_MISO, INPUT);
|
||||||
|
}
|
||||||
|
|
||||||
|
gas_sensor.dev_id = _cs;
|
||||||
|
gas_sensor.intf = BME680_SPI_INTF;
|
||||||
|
gas_sensor.read = &spi_read;
|
||||||
|
gas_sensor.write = &spi_write;
|
||||||
|
}
|
||||||
|
|
||||||
|
gas_sensor.delay_ms = delay_msec;
|
||||||
|
|
||||||
|
int8_t rslt = bme680_init(&gas_sensor);
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("Result: "); Serial.println(rslt);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
if (rslt != BME680_OK)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("T1 = "); Serial.println(gas_sensor.calib.par_t1);
|
||||||
|
Serial.print("T2 = "); Serial.println(gas_sensor.calib.par_t2);
|
||||||
|
Serial.print("T3 = "); Serial.println(gas_sensor.calib.par_t3);
|
||||||
|
Serial.print("P1 = "); Serial.println(gas_sensor.calib.par_p1);
|
||||||
|
Serial.print("P2 = "); Serial.println(gas_sensor.calib.par_p2);
|
||||||
|
Serial.print("P3 = "); Serial.println(gas_sensor.calib.par_p3);
|
||||||
|
Serial.print("P4 = "); Serial.println(gas_sensor.calib.par_p4);
|
||||||
|
Serial.print("P5 = "); Serial.println(gas_sensor.calib.par_p5);
|
||||||
|
Serial.print("P6 = "); Serial.println(gas_sensor.calib.par_p6);
|
||||||
|
Serial.print("P7 = "); Serial.println(gas_sensor.calib.par_p7);
|
||||||
|
Serial.print("P8 = "); Serial.println(gas_sensor.calib.par_p8);
|
||||||
|
Serial.print("P9 = "); Serial.println(gas_sensor.calib.par_p9);
|
||||||
|
Serial.print("P10 = "); Serial.println(gas_sensor.calib.par_p10);
|
||||||
|
Serial.print("H1 = "); Serial.println(gas_sensor.calib.par_h1);
|
||||||
|
Serial.print("H2 = "); Serial.println(gas_sensor.calib.par_h2);
|
||||||
|
Serial.print("H3 = "); Serial.println(gas_sensor.calib.par_h3);
|
||||||
|
Serial.print("H4 = "); Serial.println(gas_sensor.calib.par_h4);
|
||||||
|
Serial.print("H5 = "); Serial.println(gas_sensor.calib.par_h5);
|
||||||
|
Serial.print("H6 = "); Serial.println(gas_sensor.calib.par_h6);
|
||||||
|
Serial.print("H7 = "); Serial.println(gas_sensor.calib.par_h7);
|
||||||
|
Serial.print("G1 = "); Serial.println(gas_sensor.calib.par_gh1);
|
||||||
|
Serial.print("G2 = "); Serial.println(gas_sensor.calib.par_gh2);
|
||||||
|
Serial.print("G3 = "); Serial.println(gas_sensor.calib.par_gh3);
|
||||||
|
Serial.print("G1 = "); Serial.println(gas_sensor.calib.par_gh1);
|
||||||
|
Serial.print("G2 = "); Serial.println(gas_sensor.calib.par_gh2);
|
||||||
|
Serial.print("G3 = "); Serial.println(gas_sensor.calib.par_gh3);
|
||||||
|
Serial.print("Heat Range = "); Serial.println(gas_sensor.calib.res_heat_range);
|
||||||
|
Serial.print("Heat Val = "); Serial.println(gas_sensor.calib.res_heat_val);
|
||||||
|
Serial.print("SW Error = "); Serial.println(gas_sensor.calib.range_sw_err);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
if (initSettings) {
|
||||||
|
setTemperatureOversampling(BME680_OS_8X);
|
||||||
|
setHumidityOversampling(BME680_OS_2X);
|
||||||
|
setPressureOversampling(BME680_OS_4X);
|
||||||
|
setIIRFilterSize(BME680_FILTER_SIZE_3);
|
||||||
|
setGasHeater(320, 150); // 320*C for 150 ms
|
||||||
|
} else {
|
||||||
|
setGasHeater(0, 0);
|
||||||
|
}
|
||||||
|
// don't do anything till we request a reading
|
||||||
|
gas_sensor.power_mode = BME680_FORCED_MODE;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Performs a reading and returns the ambient temperature.
|
||||||
|
@return Temperature in degrees Centigrade
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
float Adafruit_BME680::readTemperature(void) {
|
||||||
|
performReading();
|
||||||
|
return temperature;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Performs a reading and returns the barometric pressure.
|
||||||
|
@return Barometic pressure in Pascals
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
float Adafruit_BME680::readPressure(void) {
|
||||||
|
performReading();
|
||||||
|
return pressure;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Performs a reading and returns the relative humidity.
|
||||||
|
@return Relative humidity as floating point
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
float Adafruit_BME680::readHumidity(void) {
|
||||||
|
performReading();
|
||||||
|
return humidity;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Calculates the resistance of the MOX gas sensor.
|
||||||
|
@return Resistance in Ohms
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
uint32_t Adafruit_BME680::readGas(void) {
|
||||||
|
performReading();
|
||||||
|
return gas_resistance;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Calculates the altitude (in meters).
|
||||||
|
|
||||||
|
Reads the current atmostpheric pressure (in hPa) from the sensor and calculates
|
||||||
|
via the provided sea-level pressure (in hPa).
|
||||||
|
|
||||||
|
@param seaLevel Sea-level pressure in hPa
|
||||||
|
@return Altitude in meters
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
float Adafruit_BME680::readAltitude(float seaLevel)
|
||||||
|
{
|
||||||
|
// Equation taken from BMP180 datasheet (page 16):
|
||||||
|
// http://www.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf
|
||||||
|
|
||||||
|
// Note that using the equation from wikipedia can give bad results
|
||||||
|
// at high altitude. See this thread for more information:
|
||||||
|
// http://forums.adafruit.com/viewtopic.php?f=22&t=58064
|
||||||
|
|
||||||
|
float atmospheric = readPressure() / 100.0F;
|
||||||
|
return 44330.0 * (1.0 - pow(atmospheric / seaLevel, 0.1903));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Performs a full reading of all 4 sensors in the BME680.
|
||||||
|
|
||||||
|
Assigns the internal Adafruit_BME680#temperature, Adafruit_BME680#pressure, Adafruit_BME680#humidity
|
||||||
|
and Adafruit_BME680#gas_resistance member variables
|
||||||
|
|
||||||
|
@return True on success, False on failure
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
bool Adafruit_BME680::performReading(void) {
|
||||||
|
return endReading();
|
||||||
|
}
|
||||||
|
|
||||||
|
unsigned long Adafruit_BME680::beginReading(void) {
|
||||||
|
if (_meas_start != 0) {
|
||||||
|
/* A measurement is already in progress */
|
||||||
|
return _meas_start + _meas_period;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint8_t set_required_settings = 0;
|
||||||
|
int8_t rslt;
|
||||||
|
|
||||||
|
/* Select the power mode */
|
||||||
|
/* Must be set before writing the sensor configuration */
|
||||||
|
gas_sensor.power_mode = BME680_FORCED_MODE;
|
||||||
|
|
||||||
|
/* Set the required sensor settings needed */
|
||||||
|
if (_tempEnabled)
|
||||||
|
set_required_settings |= BME680_OST_SEL;
|
||||||
|
if (_humEnabled)
|
||||||
|
set_required_settings |= BME680_OSH_SEL;
|
||||||
|
if (_presEnabled)
|
||||||
|
set_required_settings |= BME680_OSP_SEL;
|
||||||
|
if (_filterEnabled)
|
||||||
|
set_required_settings |= BME680_FILTER_SEL;
|
||||||
|
if (_gasEnabled)
|
||||||
|
set_required_settings |= BME680_GAS_SENSOR_SEL;
|
||||||
|
|
||||||
|
/* Set the desired sensor configuration */
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.println("Setting sensor settings");
|
||||||
|
#endif
|
||||||
|
rslt = bme680_set_sensor_settings(set_required_settings, &gas_sensor);
|
||||||
|
if (rslt != BME680_OK)
|
||||||
|
return 0;
|
||||||
|
|
||||||
|
/* Set the power mode */
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.println("Setting power mode");
|
||||||
|
#endif
|
||||||
|
rslt = bme680_set_sensor_mode(&gas_sensor);
|
||||||
|
if (rslt != BME680_OK)
|
||||||
|
return 0;
|
||||||
|
|
||||||
|
/* Get the total measurement duration so as to sleep or wait till the
|
||||||
|
* measurement is complete */
|
||||||
|
uint16_t meas_period;
|
||||||
|
bme680_get_profile_dur(&meas_period, &gas_sensor);
|
||||||
|
_meas_start = millis();
|
||||||
|
_meas_period = meas_period;
|
||||||
|
return _meas_start + _meas_period;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool Adafruit_BME680::endReading(void) {
|
||||||
|
unsigned long meas_end = beginReading();
|
||||||
|
if (meas_end == 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
int remaining_millis = remainingReadingMillis();
|
||||||
|
if (remaining_millis > 0) {
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("Waiting (ms) "); Serial.println(remaining_millis);
|
||||||
|
#endif
|
||||||
|
delay(static_cast<unsigned int>(remaining_millis) * 2); /* Delay till the measurement is ready */
|
||||||
|
}
|
||||||
|
_meas_start = 0; /* Allow new measurement to begin */
|
||||||
|
_meas_period = 0;
|
||||||
|
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("t_fine = "); Serial.println(gas_sensor.calib.t_fine);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
struct bme680_field_data data;
|
||||||
|
|
||||||
|
//Serial.println("Getting sensor data");
|
||||||
|
int8_t rslt = bme680_get_sensor_data(&data, &gas_sensor);
|
||||||
|
if (rslt != BME680_OK)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (_tempEnabled) {
|
||||||
|
//Serial.print("Temp: "); Serial.println(data.temperature / 100.0, 2);
|
||||||
|
temperature = data.temperature / 100.0;
|
||||||
|
} else {
|
||||||
|
temperature = NAN;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_humEnabled) {
|
||||||
|
//Serial.print("Hum: "); Serial.println(data.humidity / 1000.0, 2);
|
||||||
|
humidity = data.humidity / 1000.0;
|
||||||
|
} else {
|
||||||
|
humidity = NAN;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_presEnabled) {
|
||||||
|
//Serial.print("Pres: "); Serial.println(data.pressure, 2);
|
||||||
|
pressure = data.pressure;
|
||||||
|
} else {
|
||||||
|
pressure = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Avoid using measurements from an unstable heating setup */
|
||||||
|
if (_gasEnabled) {
|
||||||
|
if (data.status & BME680_HEAT_STAB_MSK) {
|
||||||
|
//Serial.print("Gas resistance: "); Serial.println(data.gas_resistance);
|
||||||
|
gas_resistance = data.gas_resistance;
|
||||||
|
} else {
|
||||||
|
gas_resistance = 0;
|
||||||
|
//Serial.println("Gas reading unstable!");
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
gas_resistance = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
int Adafruit_BME680::remainingReadingMillis(void)
|
||||||
|
{
|
||||||
|
if (_meas_start != 0) {
|
||||||
|
/* A measurement is already in progress */
|
||||||
|
int remaing_time = (millis() - _meas_start) - (int)_meas_period;
|
||||||
|
return remaing_time < 0 ? reading_complete : remaing_time;
|
||||||
|
}
|
||||||
|
return reading_not_started;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Enable and configure gas reading + heater
|
||||||
|
@param heaterTemp Desired temperature in degrees Centigrade
|
||||||
|
@param heaterTime Time to keep heater on in milliseconds
|
||||||
|
@return True on success, False on failure
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
bool Adafruit_BME680::setGasHeater(uint16_t heaterTemp, uint16_t heaterTime) {
|
||||||
|
gas_sensor.gas_sett.heatr_temp = heaterTemp;
|
||||||
|
gas_sensor.gas_sett.heatr_dur = heaterTime;
|
||||||
|
|
||||||
|
if ( (heaterTemp == 0) || (heaterTime == 0) ) {
|
||||||
|
// disabled!
|
||||||
|
gas_sensor.gas_sett.heatr_ctrl = BME680_DISABLE_HEATER;
|
||||||
|
gas_sensor.gas_sett.run_gas = BME680_DISABLE_GAS_MEAS;
|
||||||
|
_gasEnabled = false;
|
||||||
|
} else {
|
||||||
|
gas_sensor.gas_sett.heatr_ctrl = BME680_ENABLE_HEATER;
|
||||||
|
gas_sensor.gas_sett.run_gas = BME680_ENABLE_GAS_MEAS;
|
||||||
|
_gasEnabled = true;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Setter for Temperature oversampling
|
||||||
|
@param oversample Oversampling setting, can be BME680_OS_NONE (turn off Temperature reading),
|
||||||
|
BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X
|
||||||
|
@return True on success, False on failure
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
|
||||||
|
bool Adafruit_BME680::setTemperatureOversampling(uint8_t oversample) {
|
||||||
|
if (oversample > BME680_OS_16X) return false;
|
||||||
|
|
||||||
|
gas_sensor.tph_sett.os_temp = oversample;
|
||||||
|
|
||||||
|
if (oversample == BME680_OS_NONE)
|
||||||
|
_tempEnabled = false;
|
||||||
|
else
|
||||||
|
_tempEnabled = true;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Setter for Humidity oversampling
|
||||||
|
@param oversample Oversampling setting, can be BME680_OS_NONE (turn off Humidity reading),
|
||||||
|
BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X
|
||||||
|
@return True on success, False on failure
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
|
||||||
|
bool Adafruit_BME680::setHumidityOversampling(uint8_t oversample) {
|
||||||
|
if (oversample > BME680_OS_16X) return false;
|
||||||
|
|
||||||
|
gas_sensor.tph_sett.os_hum = oversample;
|
||||||
|
|
||||||
|
if (oversample == BME680_OS_NONE)
|
||||||
|
_humEnabled = false;
|
||||||
|
else
|
||||||
|
_humEnabled = true;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Setter for Pressure oversampling
|
||||||
|
@param oversample Oversampling setting, can be BME680_OS_NONE (turn off Pressure reading),
|
||||||
|
BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X
|
||||||
|
@return True on success, False on failure
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
bool Adafruit_BME680::setPressureOversampling(uint8_t oversample) {
|
||||||
|
if (oversample > BME680_OS_16X) return false;
|
||||||
|
|
||||||
|
gas_sensor.tph_sett.os_pres = oversample;
|
||||||
|
|
||||||
|
if (oversample == BME680_OS_NONE)
|
||||||
|
_presEnabled = false;
|
||||||
|
else
|
||||||
|
_presEnabled = true;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Setter for IIR filter.
|
||||||
|
@param filtersize Size of the filter (in samples). Can be BME680_FILTER_SIZE_0 (no filtering), BME680_FILTER_SIZE_1, BME680_FILTER_SIZE_3, BME680_FILTER_SIZE_7, BME680_FILTER_SIZE_15, BME680_FILTER_SIZE_31, BME680_FILTER_SIZE_63, BME680_FILTER_SIZE_127
|
||||||
|
@return True on success, False on failure
|
||||||
|
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
bool Adafruit_BME680::setIIRFilterSize(uint8_t filtersize) {
|
||||||
|
if (filtersize > BME680_FILTER_SIZE_127) return false;
|
||||||
|
|
||||||
|
gas_sensor.tph_sett.filter = filtersize;
|
||||||
|
|
||||||
|
if (filtersize == BME680_FILTER_SIZE_0)
|
||||||
|
_filterEnabled = false;
|
||||||
|
else
|
||||||
|
_filterEnabled = true;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Reads 8 bit values over I2C
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
int8_t i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) {
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("\tI2C $"); Serial.print(reg_addr, HEX); Serial.print(" => ");
|
||||||
|
#endif
|
||||||
|
|
||||||
|
Wire.beginTransmission((uint8_t)dev_id);
|
||||||
|
Wire.write((uint8_t)reg_addr);
|
||||||
|
Wire.endTransmission();
|
||||||
|
if (len != Wire.requestFrom((uint8_t)dev_id, (byte)len)) {
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("Failed to read "); Serial.print(len); Serial.print(" bytes from "); Serial.println(dev_id, HEX);
|
||||||
|
#endif
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
while (len--) {
|
||||||
|
*reg_data = (uint8_t)Wire.read();
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", ");
|
||||||
|
#endif
|
||||||
|
reg_data++;
|
||||||
|
}
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.println("");
|
||||||
|
#endif
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Writes 8 bit values over I2C
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
int8_t i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) {
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("\tI2C $"); Serial.print(reg_addr, HEX); Serial.print(" <= ");
|
||||||
|
#endif
|
||||||
|
Wire.beginTransmission((uint8_t)dev_id);
|
||||||
|
Wire.write((uint8_t)reg_addr);
|
||||||
|
while (len--) {
|
||||||
|
Wire.write(*reg_data);
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", ");
|
||||||
|
#endif
|
||||||
|
reg_data++;
|
||||||
|
}
|
||||||
|
Wire.endTransmission();
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.println("");
|
||||||
|
#endif
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Reads 8 bit values over SPI
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
static int8_t spi_read(uint8_t cspin, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) {
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("\tSPI $"); Serial.print(reg_addr, HEX); Serial.print(" => ");
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// If hardware SPI we should use transactions!
|
||||||
|
if (_BME680_SoftwareSPI_SCK == -1) {
|
||||||
|
SPI.beginTransaction(SPISettings(BME680_DEFAULT_SPIFREQ, MSBFIRST, SPI_MODE0));
|
||||||
|
}
|
||||||
|
|
||||||
|
digitalWrite(cspin, LOW);
|
||||||
|
|
||||||
|
spi_transfer(reg_addr | 0x80);
|
||||||
|
|
||||||
|
while (len--) {
|
||||||
|
*reg_data = spi_transfer(0x00);
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", ");
|
||||||
|
#endif
|
||||||
|
reg_data++;
|
||||||
|
}
|
||||||
|
|
||||||
|
digitalWrite(cspin, HIGH);
|
||||||
|
|
||||||
|
if (_BME680_SoftwareSPI_SCK == -1) {
|
||||||
|
SPI.endTransaction();
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.println("");
|
||||||
|
#endif
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**************************************************************************/
|
||||||
|
/*!
|
||||||
|
@brief Writes 8 bit values over SPI
|
||||||
|
*/
|
||||||
|
/**************************************************************************/
|
||||||
|
static int8_t spi_write(uint8_t cspin, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) {
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("\tSPI $"); Serial.print(reg_addr, HEX); Serial.print(" <= ");
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// If hardware SPI we should use transactions!
|
||||||
|
if (_BME680_SoftwareSPI_SCK == -1) {
|
||||||
|
SPI.beginTransaction(SPISettings(BME680_DEFAULT_SPIFREQ, MSBFIRST, SPI_MODE0));
|
||||||
|
}
|
||||||
|
|
||||||
|
digitalWrite(cspin, LOW);
|
||||||
|
|
||||||
|
spi_transfer(reg_addr);
|
||||||
|
while (len--) {
|
||||||
|
spi_transfer(*reg_data);
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", ");
|
||||||
|
#endif
|
||||||
|
reg_data++;
|
||||||
|
}
|
||||||
|
|
||||||
|
digitalWrite(cspin, HIGH);
|
||||||
|
|
||||||
|
if (_BME680_SoftwareSPI_SCK == -1) {
|
||||||
|
SPI.endTransaction();
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef BME680_DEBUG
|
||||||
|
Serial.println("");
|
||||||
|
#endif
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
static uint8_t spi_transfer(uint8_t x) {
|
||||||
|
if (_BME680_SoftwareSPI_SCK == -1)
|
||||||
|
return SPI.transfer(x);
|
||||||
|
|
||||||
|
// software spi
|
||||||
|
//Serial.println("Software SPI");
|
||||||
|
uint8_t reply = 0;
|
||||||
|
for (int i=7; i>=0; i--) {
|
||||||
|
reply <<= 1;
|
||||||
|
digitalWrite(_BME680_SoftwareSPI_SCK, LOW);
|
||||||
|
digitalWrite(_BME680_SoftwareSPI_MOSI, x & (1<<i));
|
||||||
|
digitalWrite(_BME680_SoftwareSPI_SCK, HIGH);
|
||||||
|
if (digitalRead(_BME680_SoftwareSPI_MISO))
|
||||||
|
reply |= 1;
|
||||||
|
}
|
||||||
|
return reply;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
static void delay_msec(uint32_t ms){
|
||||||
|
delay(ms);
|
||||||
|
}
|
||||||
145
src/Adafruit_BME680.h
Normal file
145
src/Adafruit_BME680.h
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
/*!
|
||||||
|
* @file Adafruit_BME680.h
|
||||||
|
*
|
||||||
|
* Adafruit BME680 temperature, humidity, barometric pressure and gas sensor driver
|
||||||
|
*
|
||||||
|
* This is the documentation for Adafruit's BME680 driver for the
|
||||||
|
* Arduino platform. It is designed specifically to work with the
|
||||||
|
* Adafruit BME680 breakout: https://www.adafruit.com/products/3660
|
||||||
|
*
|
||||||
|
* These sensors use I2C to communicate, 2 pins (SCL+SDA) are required
|
||||||
|
* to interface with the breakout.
|
||||||
|
*
|
||||||
|
* Adafruit invests time and resources providing this open source code,
|
||||||
|
* please support Adafruit and open-source hardware by purchasing
|
||||||
|
* products from Adafruit!
|
||||||
|
*
|
||||||
|
* Written by Ladyada for Adafruit Industries.
|
||||||
|
*
|
||||||
|
* BSD license, all text here must be included in any redistribution.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef __BME680_H__
|
||||||
|
#define __BME680_H__
|
||||||
|
|
||||||
|
#if defined(ARDUINO) && (ARDUINO >= 100)
|
||||||
|
#include "Arduino.h"
|
||||||
|
#else
|
||||||
|
#include "WProgram.h"
|
||||||
|
#endif
|
||||||
|
#include <Wire.h>
|
||||||
|
#include <SPI.h>
|
||||||
|
#include <Adafruit_Sensor.h>
|
||||||
|
#include <Wire.h>
|
||||||
|
#include "bme680.h"
|
||||||
|
|
||||||
|
|
||||||
|
/*=========================================================================
|
||||||
|
I2C ADDRESS/BITS
|
||||||
|
-----------------------------------------------------------------------*/
|
||||||
|
#define BME680_DEFAULT_ADDRESS (0x77) ///< The default I2C address
|
||||||
|
/*=========================================================================*/
|
||||||
|
#define BME680_DEFAULT_SPIFREQ (1000000) ///< The default SPI Clock speed
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
class Adafruit_BME680_Unified : public Adafruit_Sensor
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
Adafruit_BME680_Unified(int32_t sensorID = -1);
|
||||||
|
|
||||||
|
bool begin(uint8_t addr = BME680_DEFAULT_ADDRESS, bool initSettings = true);
|
||||||
|
void getTemperature(float *temp);
|
||||||
|
void getPressure(float *pressure);
|
||||||
|
float pressureToAltitude(float seaLevel, float atmospheric, float temp);
|
||||||
|
float seaLevelForAltitude(float altitude, float atmospheric, float temp);
|
||||||
|
void getEvent(sensors_event_t*);
|
||||||
|
void getSensor(sensor_t*);
|
||||||
|
|
||||||
|
private:
|
||||||
|
uint8_t _i2c_addr;
|
||||||
|
int32_t _sensorID;
|
||||||
|
};
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Adafruit_BME680 Class for both I2C and SPI usage.
|
||||||
|
* Wraps the Bosch library for Arduino usage
|
||||||
|
*/
|
||||||
|
|
||||||
|
class Adafruit_BME680
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
/// Value returned by remainingReadingMillis indicating no asynchronous reading has been initiated by beginReading.
|
||||||
|
static constexpr int reading_not_started = -1;
|
||||||
|
/// Value returned by remainingReadingMillis indicating asynchronous reading is complete and calling endReading will not block.
|
||||||
|
static constexpr int reading_complete = 0;
|
||||||
|
|
||||||
|
Adafruit_BME680(int8_t cspin = -1);
|
||||||
|
Adafruit_BME680(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin);
|
||||||
|
|
||||||
|
bool begin(uint8_t addr = BME680_DEFAULT_ADDRESS, bool initSettings = true);
|
||||||
|
float readTemperature(void);
|
||||||
|
float readPressure(void);
|
||||||
|
float readHumidity(void);
|
||||||
|
uint32_t readGas(void);
|
||||||
|
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);
|
||||||
|
|
||||||
|
/// Perform a reading in blocking mode.
|
||||||
|
bool performReading(void);
|
||||||
|
|
||||||
|
/** @brief Begin an asynchronous reading.
|
||||||
|
* @return When the reading would be ready as absolute time in millis().
|
||||||
|
*/
|
||||||
|
unsigned long beginReading(void);
|
||||||
|
|
||||||
|
/** @brief End an asynchronous reading.
|
||||||
|
* @return Whether success.
|
||||||
|
*
|
||||||
|
* If the asynchronous reading is still in progress, block until it ends.
|
||||||
|
* If no asynchronous reading has started, this is equivalent to performReading().
|
||||||
|
*/
|
||||||
|
bool endReading(void);
|
||||||
|
|
||||||
|
/** @brief Get remaining time for an asynchronous reading.
|
||||||
|
* @return Remaining millis until endReading will not block if invoked.
|
||||||
|
*
|
||||||
|
* If the asynchronous reading is still in progress, how many millis until its completion.
|
||||||
|
* If the asynchronous reading is completed, 0.
|
||||||
|
* If no asynchronous reading has started, -1 or Adafruit_BME680::reading_not_started.
|
||||||
|
*
|
||||||
|
* Does not block.
|
||||||
|
*/
|
||||||
|
int remainingReadingMillis(void);
|
||||||
|
|
||||||
|
/// Temperature (Celsius) assigned after calling performReading() or endReading()
|
||||||
|
float temperature;
|
||||||
|
/// Pressure (Pascals) assigned after calling performReading() or endReading()
|
||||||
|
uint32_t pressure;
|
||||||
|
/// Humidity (RH %) assigned after calling performReading() or endReading()
|
||||||
|
float humidity;
|
||||||
|
/// Gas resistor (ohms) assigned after calling performReading() or endReading()
|
||||||
|
uint32_t gas_resistance;
|
||||||
|
private:
|
||||||
|
|
||||||
|
bool _filterEnabled, _tempEnabled, _humEnabled, _presEnabled, _gasEnabled;
|
||||||
|
uint8_t _i2caddr;
|
||||||
|
int32_t _sensorID;
|
||||||
|
int8_t _cs;
|
||||||
|
unsigned long _meas_start;
|
||||||
|
uint16_t _meas_period;
|
||||||
|
|
||||||
|
uint8_t spixfer(uint8_t x);
|
||||||
|
|
||||||
|
struct bme680_dev gas_sensor;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif
|
||||||
1367
src/bme680.c
Normal file
1367
src/bme680.c
Normal file
File diff suppressed because it is too large
Load Diff
1
src/gitignore
Normal file
1
src/gitignore
Normal file
@ -0,0 +1 @@
|
|||||||
|
*~
|
||||||
26
src/travis.yml
Normal file
26
src/travis.yml
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
language: c
|
||||||
|
sudo: false
|
||||||
|
|
||||||
|
# Blacklist
|
||||||
|
branches:
|
||||||
|
except:
|
||||||
|
- gh-pages
|
||||||
|
|
||||||
|
env:
|
||||||
|
global:
|
||||||
|
- PRETTYNAME="Adafruit BME680 Arduino Library"
|
||||||
|
- DOXYFILE=$TRAVIS_BUILD_DIR/Doxyfile
|
||||||
|
|
||||||
|
before_install:
|
||||||
|
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
|
||||||
|
|
||||||
|
install:
|
||||||
|
- arduino --install-library "Adafruit Unified Sensor","Adafruit GFX Library","Adafruit SSD1306"
|
||||||
|
|
||||||
|
script:
|
||||||
|
- build_main_platforms
|
||||||
|
|
||||||
|
# Generate and deploy documentation
|
||||||
|
after_success:
|
||||||
|
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/library_check.sh)
|
||||||
|
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/doxy_gen_and_deploy.sh)
|
||||||
Loading…
Reference in New Issue
Block a user