Skip to main content

Python library for the BME680 temperature, humidity and gas sensor

Project description

BME680

Build Status Coverage Status PyPi Package Python Versions

https://shop.pimoroni.com/products/bme680

The state-of-the-art BME680 breakout lets you measure temperature, pressure, humidity, and indoor air quality.

Installing

Full install (recommended):

We've created an easy installation script that will install all pre-requisites and get your BME680 up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal on your Raspberry Pi desktop, as illustrated below:

Finding the terminal

In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:

git clone https://github.com/pimoroni/bme680-python
cd bme680-python
./install.sh

Note Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:

source ~/.virtualenvs/pimoroni/bin/activate

Development:

If you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so:

git clone https://github.com/pimoroni/bme680-python
cd bme680-python
./install.sh --unstable

In all cases you will have to enable the i2c bus:

sudo raspi-config nonint do_i2c 0

Documentation & Support

2.0.0

  • Repackage to hatch/pyproject.toml
  • Drop Python 2.7 support
  • Switch from smbu2 to smbus2

1.1.1

  • New: constants to clarify heater on/off states

1.1.0

  • New: support for BME688 "high" gas resistance variant
  • New: set/get gas heater disable bit
  • Enhancement: fail with descriptive RuntimeError when chip is not detected

1.0.5

  • New: set_temp_offset to calibrate temperature offset in degrees C

1.0.4

  • Fix to range_sw_err for extremely high gas readings
  • Convert to unsigned int to fix negative gas readings

1.0.3

  • Merged temperature compensation fix from Bosch's BME680_driver 3.5.3

1.0.2

  • Fixed set_gas_heater_temperature to avoid i2c TypeError

1.0.1

  • Added Manifest to Python package

1.0.0

  • Initial release

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page