ESP32 BME688 Environmental Sensor

🛠️ BME688 Environmental Sensor Troubleshooting

This guide outlines a systematic approach to troubleshoot and resolve common problems with the . Start by confirming that the hardware connections are correct, as wiring mistakes are the most frequent cause of issues. If you are sure the connections are correct, follow the below steps to debug common issues.

💻 Library Not Found Error

❌ Sensor Initialization Failure

⚠️ Incorrect or Inconsistent Readings

💻 Code Examples

Below you can find code examples of BME688 Environmental Sensor with ESP32 in several frameworks:

• Arduino IDE
• ESP-IDF
• ESPHome
• PlatformIO

If you encounter issues while using the BME688 Environmental Sensor, check the Common Issues Troubleshooting Guide.

ESP32 BME688 Arduino IDE Code Example

Example in Arduino IDE

Fill in your main Arduino IDE sketch file with the following code to use the BME688 Environmental Sensor:

#include <Wire.h>
#include <Adafruit_Sensor.h>
#include "Adafruit_BME680.h"

#define SEALEVELPRESSURE_HPA (1013.25)

Adafruit_BME680 bme;

void setup() {
  Serial.begin(115200);
  if (!bme.begin()) {
    Serial.println("Could not find a valid BME680 sensor, check wiring!");
    while (1);
  }
  bme.setTemperatureOversampling(BME680_OS_8X);
  bme.setHumidityOversampling(BME680_OS_2X);
  bme.setPressureOversampling(BME680_OS_4X);
  bme.setIIRFilterSize(BME680_FILTER_SIZE_3);
  bme.setGasHeater(320, 150); // 320°C for 150 ms
}

void loop() {
  if (!bme.performReading()) {
    Serial.println("Failed to perform reading :(");
    return;
  }
  Serial.print("Temperature = ");
  Serial.print(bme.temperature);
  Serial.println(" *C");

  Serial.print("Pressure = ");
  Serial.print(bme.pressure / 100.0);
  Serial.println(" hPa");

  Serial.print("Humidity = ");
  Serial.print(bme.humidity);
  Serial.println(" %");

  Serial.print("Gas = ");
  Serial.print(bme.gas_resistance / 1000.0);
  Serial.println(" KOhms");

  delay(2000);
}

This Arduino code initializes the BME688 sensor using the Adafruit BME680 library, which is compatible with the BME688. The sensor is configured for temperature, humidity, pressure, and gas readings with specific oversampling and filtering settings. The gas heater is set to 320°C for 150 milliseconds to ensure accurate detection of volatile organic compounds (VOCs) and other gases. The sensor data is read in the loop function and printed to the Serial Monitor every two seconds.

Connect your ESP32 to your computer via a USB cable, Ensure the correct Board and Port are selected under Tools, Click the "Upload" button in the Arduino IDE to compile and upload the code to your ESP32.

ESP32 BME688 ESP-IDF Code Example

Example in Espressif IoT Framework (ESP-IDF)

If you're using ESP-IDF to work with the BME688 Environmental Sensor, here's how you can set it up and read data from the sensor. Fill in this code in the main ESP-IDF file:

#include "bme688.h"
#include "esp_log.h"

#define I2C_MASTER_SCL_IO 22
#define I2C_MASTER_SDA_IO 21
#define I2C_MASTER_FREQ_HZ 100000
#define BME688_ADDR 0x76

static const char *TAG = "BME688";

void app_main() {
    ESP_LOGI(TAG, "Initializing BME688...");
    bme688_dev dev;
    bme688_init(&dev, I2C_MASTER_SCL_IO, I2C_MASTER_SDA_IO, I2C_MASTER_FREQ_HZ, BME688_ADDR);

    while (1) {
        bme688_data data;
        bme688_read(&dev, &data);
        ESP_LOGI(TAG, "Temperature: %.2f°C", data.temperature);
        ESP_LOGI(TAG, "Pressure: %.2f hPa", data.pressure);
        ESP_LOGI(TAG, "Humidity: %.2f %%", data.humidity);
        ESP_LOGI(TAG, "Gas Resistance: %.2f KOhms", data.gas_resistance / 1000.0);
        vTaskDelay(2000 / portTICK_PERIOD_MS);
    }
}

This ESP-IDF code configures the ESP32 to interface with the BME688 sensor over I²C. The bme688_init function initializes the sensor, and bme688_read fetches temperature, humidity, pressure, and gas resistance readings, which are logged to the console every two seconds.

Update the I2C pins (I2C_MASTER_SDA_IO and I2C_MASTER_SCL_IO) to match your ESP32 hardware setup, Use idf.py build to compile the project, Use idf.py flash to upload the code to your ESP32.

ESP32 BME688 ESPHome Code Example

Example in ESPHome (Home Assistant)

Fill in this configuration in your ESPHome YAML configuration file (example.yml) to integrate the BME688 Environmental Sensor

sensor:
  - platform: bme680
    temperature:
      name: "BME688 Temperature"
    pressure:
      name: "BME688 Pressure"
    humidity:
      name: "BME688 Humidity"
    gas_resistance:
      name: "BME688 Gas Resistance"
    address: 0x76

This ESPHome configuration integrates the BME688 sensor, allowing it to report temperature, pressure, humidity, and gas resistance values. The default I²C address of 0x76 is used.

Upload this code to your ESP32 using the ESPHome dashboard or the esphome run command.

ESP32 BME688 PlatformIO Code Example

Example in PlatformIO Framework

For PlatformIO, make sure to configure the platformio.ini file with the appropriate environment and libraries, and then proceed with the code.

Configure platformio.ini

First, your platformio.ini should look like below. You might need to include some libraries as shown. Make sure to change the board to your ESP32:

[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps = 
    adafruit/Adafruit BME680 Library
    wire
monitor_speed = 115200

ESP32 BME688 PlatformIO Example Code

Write this code in your PlatformIO project under the src/main.cpp file to use the BME688 Environmental Sensor:

#include <Wire.h>
#include "Adafruit_BME680.h"

Adafruit_BME680 bme;

void setup() {
  Serial.begin(115200);
  if (!bme.begin()) {
    Serial.println("Could not find a valid BME688 sensor, check wiring!");
    while (1);
  }
}

void loop() {
  Serial.print("Temperature: ");
  Serial.print(bme.readTemperature());
  Serial.println(" *C");

  Serial.print("Pressure: ");
  Serial.print(bme.readPressure() / 100.0);
  Serial.println(" hPa");

  Serial.print("Humidity: ");
  Serial.print(bme.readHumidity());
  Serial.println(" %");

  Serial.print("Gas Resistance: ");
  Serial.print(bme.readGas() / 1000.0);
  Serial.println(" KOhms");
  delay(2000);
}

This PlatformIO code configures the BME688 sensor using the Adafruit BME680 library. It reads and prints temperature, pressure, humidity, and gas resistance values to the Serial Monitor every two seconds.

Upload the code to your ESP32 using the PlatformIO "Upload" button in your IDE or the pio run --target upload command.