API Reference

qwiic_bme280

Python module for the qwiic bme280 sensor, which is part of the [SparkFun Qwiic Environmental Combo Breakout](https://www.sparkfun.com/products/14348)

This python package is a port of the existing [SparkFun BME280 Arduino Library](https://github.com/sparkfun/SparkFun_BME280_Arduino_Library)

This package can be used in conjunction with the overall [SparkFun qwiic Python Package](https://github.com/sparkfun/Qwiic_Py)

New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).

class qwiic_bme280.QwiicBme280(address=None, i2c_driver=None)[source]
Parameters:
  • address – The I2C address to use for the device. If not provided, the default address is used.
  • i2c_driver – An existing i2c driver object. If not provided a driver object is created.
Returns:

The BME280 device object.

Return type:

Object

altitude_feet

Return the current Altitude in feet

Returns:The current altitude in feets
Return type:float
altitude_meters

Return the current Altitude in meters

Returns:The current altitude in meters
Return type:float
begin()[source]

Initialize the operation of the BME280 module

Returns:Returns true of the initializtion was successful, otherwise False.
Return type:bool
check_sample_value(userValue)[source]

Validates an over sample value

Parameters:userValue – The oversample value to check. Allowed values are 0 to 16 These are used in the humidty, pressure, and temp oversample functions
Returns:Valid oversample value
Return type:int
connected

Determine if a BME280 device is conntected to the system..

Returns:True if the device is connected, otherwise False.
Return type:bool
dewpoint_celsius

Returns the Dew point in degrees C.

Returns:The current dewpoint in C.
Return type:float
dewpoint_fahrenheit

Returns the Dew point in degrees F.

Returns:The current dewpoint in F.
Return type:float
get_altitude_feet()[source]

Return the current Altitude in feet

Returns:The current altitude in feets
Return type:float
get_altitude_meters()[source]

Return the current Altitude in meters

Returns:The current altitude in meters
Return type:float
get_dewpoint_celsius()[source]

Returns the Dew point in degrees C.

Returns:The current dewpoint in C.
Return type:float
get_dewpoint_fahrenheit()[source]

Returns the Dew point in degrees F.

Returns:The current dewpoint in F.
Return type:float
get_mode()[source]

Returns the operational mode of the sensor.

Returns:The current operational mode
Return type:MODE_SLEEP, MODE_FORCED, or MODE_NORMAL
get_reference_pressure()[source]

Get the current reference pressure for the sensor.

Returns:The current reference pressure.
Return type:float
get_temperature_celsius()[source]
Returns temperature in DegC, resolution is 0.01 DegC. Output value of “5123” equals 51.23 DegC.
t_fine carries fine temperature as global value
Returns:The current temperature in C.
Return type:float
get_temperature_fahrenheit()[source]
Returns temperature in Deg F, resolution is 0.01 DegF. Output value of “5123” equals 51.23 DegF.
t_fine carries fine temperature as global value
Returns:The current temperature in F.
Return type:float
humidity

Returns humidity in %RH as unsigned 32 bit integer in Q22. 10 format (22 integer and 10 fractional bits). Output value of “47445” represents 47445/1024 = 46. 33 %RH

Returns:The current humidity value
Return type:float
is_connected()[source]

Determine if a BME280 device is conntected to the system..

Returns:True if the device is connected, otherwise False.
Return type:bool
is_measuring()[source]

Return if the sensor is measuring or not

Returns:True if the sensor is measuring, else False
Rvalue:boolean
mode

Returns the operational mode of the sensor.

Returns:The current operational mode
Return type:MODE_SLEEP, MODE_FORCED, or MODE_NORMAL
pressure

Returns pressure in Pa as unsigned 32 bit integer in Q24.8 format (24 integer bits and 8 fractional bits). Output value of “24674867” represents 24674867/256 = 96386.2 Pa = 963.862 hPa

Returns:Pressure in Pa
Return type:integer
read_humidity()[source]

Returns humidity in %RH as unsigned 32 bit integer in Q22. 10 format (22 integer and 10 fractional bits). Output value of “47445” represents 47445/1024 = 46. 33 %RH

Returns:The current humidity value
Return type:float
read_pressure()[source]

Returns pressure in Pa as unsigned 32 bit integer in Q24.8 format (24 integer bits and 8 fractional bits). Output value of “24674867” represents 24674867/256 = 96386.2 Pa = 963.862 hPa

Returns:Pressure in Pa
Return type:integer
reference_pressure

Get the current reference pressure for the sensor.

Returns:The current reference pressure.
Return type:float
reset()[source]

Resets the sensor. If called, the begin method must be called before using the sensor.

set_filter(filterSetting)[source]

Set the filter bits in the BME280s config register

Parameters:filterSetting – The filter bits for the BME280. Acceptable values 0 = filter off 1 = coefficients = 2 2 = coefficients = 4 3 = coefficients = 8 4 = coefficients = 16
Returns:No return value
set_humidity_oversample(overSampleAmount)[source]

Set the humidity oversample value

Parameters:overSampleAmount – The humidity oversample value. Acceptable values 0 = turns off humidity sensing 1 to 16 are valid over sampling values
Returns:No return value
set_mode(mode)[source]

Set the operational mode of the sensor.

Parameters:mode – One of the class constant values. MODE_SLEEP, MODE_FORCED, MODE_NORMAL
Returns:No return value
set_pressure_oversample(overSampleAmount)[source]

Set the pressure oversample value

Parameters:overSampleAmount – The pressure oversample value. Acceptable values 0 = turns off pressure sensing 1 to 16 are valid over sampling values
Returns:No return value
set_reference_pressure(refPressure)[source]

Sets the referance pressure for the sensor measurments.

Parameters:refPressure – The referance pressure to use.
Returns:No return value
set_standby_time(timeSetting)[source]

Set the standby bits in the BME280s config register

Parameters:timeSetting – The standby time bits - acceptable values 0 = 0.5ms 1 = 62.5ms 2 = 125ms 3 = 250ms 4 = 500ms 5 = 1000ms 6 = 10ms 7 = 20ms
Returns:No return value
set_tempature_oversample(overSampleAmount)[source]

Set the temperature oversample value

Parameters:overSampleAmount – The temperature oversample value. Acceptable values 0 = turns off temp sensing 1 to 16 are valid over sampling values
Returns:No return value
temperature_celsius
Returns temperature in DegC, resolution is 0.01 DegC. Output value of “5123” equals 51.23 DegC.
t_fine carries fine temperature as global value
Returns:The current temperature in C.
Return type:float
temperature_fahrenheit
Returns temperature in Deg F, resolution is 0.01 DegF. Output value of “5123” equals 51.23 DegF.
t_fine carries fine temperature as global value
Returns:The current temperature in F.
Return type:float