BME68X Environmental Sensor

From Waveshare Wiki
Jump to: navigation, search
BME680 Environmental Sensor
BME680 Environmental Sensor.jpg
BME688 Environmental Sensor
BME680 Environmental Sensor.jpg

I2C, SPI
{{{name3}}}

{{{name4}}}

{{{name5}}}

{{{name6}}}

Overview

Introduction

The BME68X Environmental Sensor is a four-in-one environmental sensor that can measure temperature, humidity, barometric pressure, and air quality. It is compact, low power, and suitable for smart homes, mobile application environment monitoring, wearable devices, etc.

Feature

  • Onboard BME68X sensor to measure temperature, humidity, barometric pressure, and gas.
  • Supports I2C communication, I2C address configurable, with I2C bus cascading support.
  • Supports SPI communication, enabled via CS pin (I2C bus by default).
  • Onboard voltage translator, compatible with 3.3V/5V level.
  • Comes with online development resources and manual (examples for Raspberry Pi / Raspberry Pi Pico / Arduino / ESP32).

Specifications

Model BME280 BME680 BME688
Function Barometric pressure, Environmental temperature, Relative humidity Barometric pressure, Environmental temperature, Relative humidity, VOC gas change detection (supports IAQ calculation in combination with the software package) Similar to BME680,

Suitable for detecting various additional gases (such as VSC, carbon monoxide, hydrogen, etc.)
Multiple gas discrimination
Artificial intelligence (requires secondary development by the user)

Communication Interface I2C and SPI
Temperature Measuring Range -40~85°C
Temperature Measuring Accuracy ±1.0℃ (0~65℃) ±0.5℃ (0~65℃)
Humidity Measuring Range 0~100% r.H.
Humidity Measuring Accuracy ±3% r.H.
Barometric Pressure Measurement Range 300~1100 hPa
Barometric Pressure Measurement Accuracy ±1.0hPa (0~65℃) ±0.6hPa (0~65℃)
IAQ Measuring Range Not support 0~500 IAQ
(The sensor outputs changes in resistance due to VOC gas, and the Bosch BSEC library is required to output IAQ.)
Dimensions 27mm × 20mm
The BME680 and BME688 sensors contain a mini MOX sensor. The heated metal oxide changes its resistance according to the concentration of volatile organic compounds (VOC) in the air, making it capable of detecting gases and alcohols such as ethanol, alcohol, and carbon monoxide, and measuring air quality. It provides a resistance value (Gas resistance in the figure), which represents the total VOC content, but cannot differentiate between different gases or alcohols. To convert this value to an IAQ air quality index, it is necessary to use the official BSEC software library (which is not open-source). Bosch imposes certain restrictions and licensing requirements on the use of this software library, and users are advised to study the details of its use and integration according to their specific needs.

Interface Definition

BME680 Environmental Sensor02.png

I2C SPI
Pins Description Pins Description
VCC Power Input VCC Power Input
GND Ground GND Ground
SDA Data Pin MOSI SPI Data Input
SCL I2C Clock Pin SCK SPI Clock Input
ADDR Address chip selection (high level by default):
high level, the address is 0x77
low level, the address is 0x76		 MISO SPI data output
CS NC CS SPI chip selection, low active

Working with Raspberry Pi

Hardware Connection

BME680 Raspberry Pi 01.jpg
The above figure is connected to the I2C interface as an example as a demonstration, where the ADDR pin can be used to set the I2C address of the sensor, the default non-connected I2C address is 0x77, if the ADDR is connected to GND, the I2C address is 0x76.
If you want to connect Raspberry Pi through the SPI interface for communication, please refer to the following table for connection.

I2C SPI
Pins Raspberry Pin Pins Raspberry Pin
VCC 3.3V /5V VCC 3.3V /5V
GND GND GND GND
SDA SDA.1 MOSI MOSI
SCL SCL.1 SCK SCLK
ADDR NC/GND MISO MISO
CS NC CS 27(wiringPi)

Software Config

Enable I2C/SPI Interface

  • Execute the following commands to configure the Raspberry Pi:
sudo raspi-config
  • Choose Interfacing Options -> I2C -> yes to enable I2C kernel driver.
  • Choose Interfacing Options -> SPI -> yes to enable SPI kernel driver.
  • Save, exit, and then reboot the Raspberry Pi:
sudo reboot
  • After rebooting, run the commands to view. Check whether the I2C and SPI modules are enabled.
lsmod
  • The following print message will be available.

BME280-Environmental-Sensor-user-manual-3.png

  • If i2c_bcm2835 and spi_bcm2835 are displayed then the I2C, SPI module is booted.
  • Connect the BME68x module to the Raspberry Pi as described in the previous I2C bus interface instructions.
  • The default I2C device address of the BME68x module is 0x77, if ADDR is grounded, the device address will be changed to 0x76.
  • Install the i2c-tools tool to confirm.
sudo apt-get install i2c-tools
  • Query connected I2C devices
i2cdetect -y 1
  • The following message will be printed.

BME680 Raspberry Pi 05.png

  • If 77 is displayed then the BME68x module is successfully connected to the Raspberry Pi successfully.
  • If the ADDR is connected to GND then 76 is printed.

BME680 Raspberry Pi 06.png
Note: The above test ensures that there are no devices on the I2C bus that have the same address as the device. If the above test is successful, the I2C module is loaded successfully, and the BME68x module is successfully connected to the Raspberry Pi. In addition, the BME68x module supports the SPI driver, and you can refer to the SPI interface description section to connect the BME68x to the Raspberry Pi.

Download Example Demo

  • Download the example demo, decompress, and modify the file permissions.
cd ~
wget https://files.waveshare.com/upload/4/49/BME68X_Environmental_Sensor_code.zip
unzip BME68X_Environmental_Sensor_code.zip
sudo chmod -R 777 BME68X_Environmental_Sensor_code

C

Demo

  • After connecting the hardware as shown above and configuring the software properly.
  • If I2C driver is used: first determine the I2C device address, BME68x module default I2C device address is 0x77, if the ADDR pin is grounded (or short the pad marked ADDR silkscreen on the PCB), then its I2C device address changes to 0x76.
  • Enter BME68X_Environmental_Sensor_code/RaspberryPi/C:
cd BME68X_Environmental_Sensor_code/RaspberryPi/C
  • Open main.c file:
nano main.c
  • Make sure the USEIIC macro in main.c is defined as 1 to adopt the I2C driver.

BME68X Raspberry I2C.png

  • Also check the I2C device address in main.c to make sure it is the same as the current BME68x module device address (default I2C device address is 0x77 (BME68X_I2C_ADDR_HIGH). If ADDR is grounded then its device address is 0x76 (BME68X_I2C_ADDR_HIGH)).

BME68X Raspberry I2C add.png

  • If SPI driver is used: wire the BME68x module according to the SPI bus wiring in the interface description and change the USEIIC macro definition in the main.c file to 0.

BME68X Raspberry SPI.png

  • Save and exit the editor, then recompile.
sudo make clean
sudo make
  • Run:
sudo ./bme68x
  • The following data will be displayed.

BME68X Raspberry Data.png

  • From left to right, the temperature (°C), barometric pressure (hPa), relative humidity (%RH), and gas resistance (ohms) measured by the BME68x are displayed. If the data is not displayed successfully, or if the data is not displayed properly, please check the connection, communication method, and device address for errors.

Python

  • Python demo only has I2C mode.

Install Function Library

sudo pip3 install bme680

Demo

  • Enter the example demo file:
cd BME68X_Environmental_Sensor_code/RaspberryPi/Python/examples
  • Run the demo:
sudo python3 read-all.py
  • The demo will print a series of module information, from left to right, the temperature (°C), barometric pressure (hPa), relative humidity (%RH), and gas resistance (ohms) measured by the BME68x are displayed. If the data is not displayed successfully, or if the data is not displayed properly, please check the connection, the communication method, and the device address for errors.

BME68X Raspberry Python.png

Working with Arduino

Install Library

The library for the BME68x sensor can be downloaded from the library manager of the Arduino IDE:

  • Open Arduino IDE 2.0.
  • Open the "Library Manager" option in the left toolbar and search for BME68x.

BME680 Arduino01.png

Hardware Connection

I2C Interface SPI Interface
Pins Arduino Pin Pins Arduino Pin
VCC 3.3V /5V VCC 3.3V /5V
GND GND GND GND
SDA SDA MOSI D11
SCL SCL SCK D13
ADDR NC/GND MISO D12
CS NC CS D10

Demo

SPI

  • The default communication method of this demo is SPI, refer to the table above to connect the module to the development board (this demo uses Arduino Uno).
  • Click File -> examples -> BME68x Sensor library -> forced_mode to open the sample demo.
  • Connect the development board to the computer (this demo uses Arduino uno), click Tools->Development Board, select the corresponding development board, click: Tools->Port select the corresponding port.
  • Click on the upload button to compile and upload the demo to see the development board and wait for a successful upload.
  • Click on Tools -> Serial Monitor, which shows from left to right the temperature (°C), barometric pressure (hPa), relative humidity (%RH), altitude (m), and gas resistance (ohms) measured by the BME68x sensor.

BME680 SPI Demo01.png

  • If the data is not displayed successfully, or if the data is not displayed normally, please check the connection, communication method, and device address for errors.

I2C

  • If you want to change the communication way to I2C, you should modify the hardware connection according to the I2C.
  • Modify the main demo according to the following figure.
  • Compile and upload the demo, and open SSCOM. From left to right, the temperature (°C), barometric pressure (hPa), relative humidity (%RH), altitude (m), and gas resistance (ohms) measured by the BME68x sensor are shown.

BME680 SPI Demo02.png

Working with Raspberry Pi Pico

Set up Environment

This tutorial uses Thonny for code testing, click to download the relevant IDE and install it, then open Thonny.

  • Please refer to the official documentation to set up the python environment, in Thonny: Tools -> Options -> Interprete select the Raspberry Pi Pico device, as shown in the following figure:

Pico-GPS-002.jpg

Download the Demo

1. Download the demo.
2. Unzip the sample demo.
3. Open Thonny, and check whether it is connected to the pico. Then, open the unpacked demo path in the upper left corner, right-click on the pico folder, and select Upload, as shown in the picture.

Raspberry Pico BME680.02.png

Hardware Connection

I2C Interface
Pins Pico Pin
VCC 3.3V /5V
GND GND
SDA GP6
SCL GP7
ADDR NC/GND
CS NC

Demo

1. Open Thonny IDE, choose the pico directory, and double-click to open the read-all.py file. The demo is shown below:
Raspberry Pico BME680.03.png

Working with ESP32

Install ESP32 Plug-in in Arduino IDE

1. Open Arduino IDE, click "File" at the upper left corner, and choose "Preferences".

L76K GPS Module ESP32202.png

2. Add the following link to the Additional Development Board Manager URL and click OK.
https://dl.espressif.com/dl/package_esp32_index.json

L76K GPS Module ESP32203.png
Note: If you already have the ESP8266 board URL, you can separate the URLs with commas like this:

https://dl.espressif.com/dl/package_esp32_index.json，http://arduino.esp8266.com/stable/package_esp8266com_index.json
3. Download the package and copy the packages file to the following path:
C:\Users\xutong\AppData\Local\Arduino15

L76K GPS Module ESP32204.jpg
Note: Replace the username: xutong with your own username.

Install Library

The library for the BME68x sensor can be downloaded from the library manager of the Arduino IDE:

  • Open Arduino IDE 2.0.
  • Open the "Library Manager" option in the left toolbar and search for BME68x.

BME680 Arduino01.png

Hardware Connection

I2C Interface SPI Interface
Pins ESP32 Pin Pins ESP32 Pin
VCC 3.3V /5V VCC 3.3V /5V
GND GND GND GND
SDA P21 MOSI P23
SCL P22 SCK P18
ADDR NC/GND MISO P19
CS NC CS P15

Demo

SPI

  • The default communication method of this demo is SPI, refer to the table above to connect the module to the development board.
  • Click on: File -> Examples -> BME68x Sensor library -> forced_mode to open the sample demo.
  • Connect the development board to the computer, click Tools->Development Board, select the corresponding development board, and click: Tools -> Port to select the corresponding port.
  • Click the upload button to compile and upload the demo to the watch development board and wait for a successful upload.
  • Click on Tools -> Serial Monitor, which shows from left to right the temperature (°C), barometric pressure (hPa), relative humidity (%RH), altitude (m), and gas resistance (ohms) measured by the BME68x sensor.

BME680 Environmental Sensor library.png

  • If the data is not displayed successfully, or if the data is not displayed properly, please check the connection, communication method, and device address for errors.

I2C

  • If you need to modify the communication mode to I2C, first modify the hardware connection according to the I2C mode.
  • Refer to the following diagram, and modify the original main demo;
  • Compile and upload the demo, open the serial monitor, which from left to right shows the temperature (°C), barometric pressure (hPa), relative humidity (%RH), altitude (m), and gas resistance (ohms) measured by the BME68x sensor.

BME680 I2C04.png

Resource

Document

Demo

Software

Related Resource

Support



Technical Support

If you need technical support or have any feedback/review, please click the Submit Now button to submit a ticket, Our support team will check and reply to you within 1 to 2 working days. Please be patient as we make every effort to help you to resolve the issue.
Working Time: 9 AM - 6 PM GMT+8 (Monday to Friday)

Retrieved from "https://www.waveshare.com/w/index.php?title=BME680_Environmental_Sensor&oldid=90022"