OpenMQTTGateway/main/sensorBME280.cpp

/*
  OpenMQTTGateway Addon  - ESP8266 or Arduino program for home automation

   Act as a gateway between your 433mhz, infrared IR, BLE, LoRa signal and one interface like an MQTT broker
   Send and receiving command by MQTT

   This is the Climate Addon:
   - Measures Temperature, Humidity and Pressure
   - Generates Values for: Temperature in degrees C and F, Humidity in %, Pressure in Pa, Altitude in Meter and Feet
   - Required Hardware Module: Bosch BME280/BMP280
   - Required Library: SparkFun BME280 Library v1.1.0 by Marshall Taylor

   Connection Schemata:
   --------------------

   BME280/BMP280 ------> ESP8266
   =====================================================
   Vcc ----------------> 5V/3.3V    (5V or 3.3V depends on the BME280/BMP280 board variant)
   GND ----------------> GND
   SCL ----------------> D1
   SDA ----------------> D2

    Copyright: (c) Hans-Juergen Dinges

    This file is part of OpenMQTTGateway.

    OpenMQTTGateway is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenMQTTGateway is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "User_config.h"

#ifdef ZsensorBME280
#  include <stdint.h>

#  include "SparkFunBME280.h"
#  include "TheengsCommon.h"
#  include "Wire.h" // Library for communication with I2C / TWI devices
#  include "config_BME280.h"

//Time used to wait for an interval before resending measured values
static unsigned long timebme280 = 0;
static int BME280_i2c_addr = BME280_I2C_ADDR; // Default I2C address for BME280 is 0x76, for BMP280 is 0x77
static BME280 mySensor;

void setupZsensorBME280() {
  // Allow custom pins on ESP Platforms
  Wire.begin(BME280_PIN_SDA, BME280_PIN_SCL);

  mySensor.settings.commInterface = I2C_MODE;
  mySensor.settings.I2CAddress = BME280_i2c_addr;
  THEENGS_LOG_NOTICE(F("Setup BME280/BMP280 on address: %X" CR), BME280_i2c_addr);
  //***Operation settings*****************************//

  // runMode Setting - Values:
  // -------------------------
  //  0, Sleep mode
  //  1 or 2, Forced mode
  //  3, Normal mode
  mySensor.settings.runMode = 3; //Normal mode

  // tStandby Setting - Values:
  // --------------------------
  //  0, 0.5ms
  //  1, 62.5ms
  //  2, 125ms
  //  3, 250ms
  //  4, 500ms
  //  5, 1000ms
  //  6, 10ms
  //  7, 20ms
  mySensor.settings.tStandby = 1;

  // Filter can be off or number of FIR coefficients - Values:
  // ---------------------------------------------------------
  //  0, filter off
  //  1, coefficients = 2
  //  2, coefficients = 4
  //  3, coefficients = 8
  //  4, coefficients = 16
  mySensor.settings.filter = 4;

  // tempOverSample - Values:
  // ------------------------
  //  0, skipped
  //  1 through 5, oversampling *1, *2, *4, *8, *16 respectively
  mySensor.settings.tempOverSample = BME280TemperatureOversample;

  // pressOverSample - Values:
  // -------------------------
  //  0, skipped
  //  1 through 5, oversampling *1, *2, *4, *8, *16 respectively
  mySensor.settings.pressOverSample = BME280PressureOversample;

  // humidOverSample - Values:
  // -------------------------
  //  0, skipped
  //  1 through 5, oversampling *1, *2, *4, *8, *16 respectively
  mySensor.settings.humidOverSample = BME280HumidityOversample;

  // tempCorrection - Correction in celcius of temperature reported by BME280/BMP280 sensor. Both Celcius and Farenheit temperatures are adjusted.
  // -------------------------
  // Value is a float
  // ie Compiler Directive '-DBME280Correction=-3.4'
  mySensor.settings.tempCorrection = BME280Correction;

  delay(10); // Gives the Sensor enough time to turn on (The BME280/BMP280 requires 2ms to start up)

  int ret = mySensor.begin();
  if (ret == 0x60) {
    THEENGS_LOG_NOTICE(F("Bosch BME280 successfully initialized: %X" CR), ret);
  } else if (ret == 0x58) {
    THEENGS_LOG_NOTICE(F("Bosch BMP280 successfully initialized: %X" CR), ret);
  } else {
    THEENGS_LOG_NOTICE(F("Bosch BME280/BMP280 failed: %X" CR), ret);
  }
}

void MeasureTempHumAndPressure() {
  if (millis() > (timebme280 + TimeBetweenReadingbme280)) {
    timebme280 = millis();
    static float persisted_bme_tempc;
    static float persisted_bme_tempf;
    static float persisted_bme_hum;
    static float persisted_bme_pa;
    static float persisted_bme_altim;
    static float persisted_bme_altift;

    float BmeTempC = mySensor.readTempC();
    float BmeTempF = mySensor.readTempF();
    float BmeHum = mySensor.readFloatHumidity();
    float BmePa = mySensor.readFloatPressure();
    float BmeAltiM = mySensor.readFloatAltitudeMeters();
    float BmeAltiFt = mySensor.readFloatAltitudeFeet();

    // Check if reads failed and exit early (to try again).
    if (isnan(BmeTempC) || isnan(BmeTempF) || isnan(BmeHum) || isnan(BmePa) || isnan(BmeAltiM) || isnan(BmeAltiFt)) {
      THEENGS_LOG_ERROR(F("Failed to read from BME280/BMP280!" CR));
    } else {
      THEENGS_LOG_TRACE(F("Creating BME280/BMP280 buffer" CR));
      StaticJsonDocument<JSON_MSG_BUFFER> BME280dataBuffer;
      JsonObject BME280data = BME280dataBuffer.to<JsonObject>();
      // Generate Temperature in degrees C
      if (BmeTempC != persisted_bme_tempc || bme280_always) {
        BME280data["tempc"] = (float)BmeTempC;
      } else {
        THEENGS_LOG_TRACE(F("Same Degrees C don't send it" CR));
      }

      // Generate Temperature in degrees F
      if (BmeTempF != persisted_bme_tempf || bme280_always) {
        BME280data["tempf"] = (float)BmeTempF;
      } else {
        THEENGS_LOG_TRACE(F("Same Degrees F don't send it" CR));
      }

      // Generate Humidity in percent
      if (BmeHum != persisted_bme_hum || bme280_always) {
        BME280data["hum"] = (float)BmeHum;
      } else {
        THEENGS_LOG_TRACE(F("Same Humidity don't send it" CR));
      }

      // Generate Pressure in Pa
      if (BmePa != persisted_bme_pa || bme280_always) {
        BME280data["pa"] = (float)BmePa;
      } else {
        THEENGS_LOG_TRACE(F("Same Pressure don't send it" CR));
      }

      // Generate Altitude in Meter
      if (BmeAltiM != persisted_bme_altim || bme280_always) {
        THEENGS_LOG_TRACE(F("Sending Altitude Meter to MQTT" CR));
        BME280data["altim"] = (float)BmeAltiM;
      } else {
        THEENGS_LOG_TRACE(F("Same Altitude Meter don't send it" CR));
      }

      // Generate Altitude in Feet
      if (BmeAltiFt != persisted_bme_altift || bme280_always) {
        BME280data["altift"] = (float)BmeAltiFt;
      } else {
        THEENGS_LOG_TRACE(F("Same Altitude Feet don't send it" CR));
      }
      BME280data["origin"] = BMETOPIC;
      enqueueJsonObject(BME280data);
    }

    persisted_bme_tempc = BmeTempC;
    persisted_bme_tempf = BmeTempF;
    persisted_bme_hum = BmeHum;
    persisted_bme_pa = BmePa;
    persisted_bme_altim = BmeAltiM;
    persisted_bme_altift = BmeAltiFt;
  }
}

#endif