Introduction¶

I2C and SPI driver for the Bosch BME280 Temperature, Humidity, and Barometric Pressure sensor

Installation and Dependencies¶

This driver depends on:

Please ensure that the driver and all dependencies are available on the CircuitPython filesystem. This can be most easily achieved by downloading and installing the latest Adafruit library and driver bundle on your device.

Installing from PyPI¶

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-bme280

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-bme280

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-bme280

Usage Example¶

import board
import digitalio
import busio
import time
import adafruit_bme280

# Create library object using our Bus I2C port
i2c = busio.I2C(board.SCL, board.SDA)
bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)

# OR create library object using our Bus SPI port
#spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
#bme_cs = digitalio.DigitalInOut(board.D10)
#bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, bme_cs)

# change this to match the location's pressure (hPa) at sea level
bme280.sea_level_pressure = 1013.25

while True:
    print("\nTemperature: %0.1f C" % bme280.temperature)
    print("Humidity: %0.1f %%" % bme280.humidity)
    print("Pressure: %0.1f hPa" % bme280.pressure)
    print("Altitude = %0.2f meters" % bme280.altitude)
    time.sleep(2)

Contributing¶

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation¶

For information on building library documentation, please check out this guide.

Table of Contents¶

Simple test¶

Ensure your device works with this simple test.

examples/bme280_simpletest.py¶

import time

import board
import busio
import adafruit_bme280

# Create library object using our Bus I2C port
i2c = busio.I2C(board.SCL, board.SDA)
bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)

# OR create library object using our Bus SPI port
# spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
# bme_cs = digitalio.DigitalInOut(board.D10)
# bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, bme_cs)

# change this to match the location's pressure (hPa) at sea level
bme280.sea_level_pressure = 1013.25

while True:
    print("\nTemperature: %0.1f C" % bme280.temperature)
    print("Humidity: %0.1f %%" % bme280.humidity)
    print("Pressure: %0.1f hPa" % bme280.pressure)
    print("Altitude = %0.2f meters" % bme280.altitude)
    time.sleep(2)

`adafruit_bme280` - Adafruit BME280 - Temperature, Humidity & Barometic Pressure Sensor¶

CircuitPython driver from BME280 Temperature, Humidity and Barometic Pressure sensor

Author(s): ladyada

class adafruit_bme280.Adafruit_BME280[source]¶

Driver from BME280 Temperature, Humidity and Barometic Pressure sensor

altitude¶: The altitude based on current pressure versus the sea level pressure (sea_level_pressure) - which you must enter ahead of time)

humidity¶: The relative humidity in RH % returns None if humidity measurement is disabled

iir_filter¶: Controls the time constant of the IIR filter Allowed values are the constants IIR_FILTER_*

measurement_time_max¶: Maximum time in milliseconds required to complete a measurement in normal mode

measurement_time_typical¶: Typical time in milliseconds required to complete a measurement in normal mode

mode¶: Operation mode Allowed values are the constants MODE_*

overscan_humidity¶: Humidity Oversampling Allowed values are the constants OVERSCAN_*

overscan_pressure¶: Pressure Oversampling Allowed values are the constants OVERSCAN_*

overscan_temperature¶: Temperature Oversampling Allowed values are the constants OVERSCAN_*

pressure¶: The compensated pressure in hectoPascals. returns None if pressure measurement is disabled

sea_level_pressure = None¶: Pressure in hectoPascals at sea level. Used to calibrate altitude.

standby_period¶: Control the inactive period when in Normal mode Allowed standby periods are the constants STANDBY_TC_*

temperature¶: The compensated temperature in degrees celsius.

class adafruit_bme280.Adafruit_BME280_I2C(i2c, address=<sphinx.ext.autodoc.importer._MockObject object>)[source]¶: Driver for BME280 connected over I2C

class adafruit_bme280.Adafruit_BME280_SPI(spi, cs, baudrate=100000)[source]¶: Driver for BME280 connected over SPI