History

helgibbons a62c3f0e20 update readme		2022-12-01 17:49:53 +00:00
..
README.md	update readme	2022-12-01 17:49:53 +00:00
breakout_bme280.c	MicroPython: Shim MP_REGISTER_MODULE for >1.18 compat.	2022-06-14 12:08:47 +01:00
breakout_bme280.cpp	MicroPython: Drop redundant Print. Saves 4K.	2022-06-13 18:59:51 +01:00
breakout_bme280.h	MicroPython: Drop redundant Print. Saves 4K.	2022-06-13 18:59:51 +01:00
micropython.cmake	Add MicroPython bindings for BME280 and BMP280	2021-08-02 14:20:59 +01:00
micropython.mk	Add MicroPython bindings for BME280 and BMP280	2021-08-02 14:20:59 +01:00

README.md

BME280

Getting Started
Reading Temperature, Pressure and Humidity
Configuring The Sensor

Getting Started

Construct new PimoroniI2C and BreakoutBME280 instances:

from breakout_bme280 import BreakoutBME280
from pimoroni_i2c import PimoroniI2C

PINS_BREAKOUT_GARDEN = {"sda": 4, "scl": 5}
PINS_PICO_EXPLORER = {"sda": 20, "scl": 21}

i2c = PimoroniI2C(**PINS_BREAKOUT_GARDEN)
bme = BreakoutBME280(i2c)

Reading Temperature, Pressure and Humidity

The read method will return a tuple containing Temperature (degrees C), Pressure (Pa) and Humidity (RH %) values:

temperature, pressure, humidity = bme.read()

Configuring The Sensor

The configure method allows you to set up the oversampling, filtering and operation mode.

bme.configure(filter, standby_time, os_pressure, os_humidity, os_temp, mode)

The breakout_bme280 module includes constants for these:

Filter Settings

FILTER_COEFF_OFF
FILTER_COEFF_2
FILTER_COEFF_4
FILTER_COEFF_8
FILTER_COEFF_16

Oversampling Settings

NO_OVERSAMPLING
OVERSAMPLING_1X
OVERSAMPLING_2X
OVERSAMPLING_4X
OVERSAMPLING_8X
OVERSAMPLING_16X

Mode Settings

SLEEP_MODE
FORCED_MODE
NORMAL_MODE

Standby/Output Data Rate Settings

STANDBY_TIME_0_5_MS
STANDBY_TIME_62_5_MS
STANDBY_TIME_125_MS
STANDBY_TIME_250_MS
STANDBY_TIME_500_MS
STANDBY_TIME_1000_MS
STANDBY_TIME_2000_MS
STANDBY_TIME_4000_MS

Defaults

bme.configure(FILTER_COEFF_2, STANDBY_TIME_0_5_MS, OVERSAMPLING_16X, OVERSAMPLING_2X, OVERSAMPLING_1X)