Provides an Arduino library for reading and interpreting Bosch BME280 data over I2C, SPI or Sw SPI. Additional environment calculation functions are provided. ESP and BRZO are now supported.
-
- BME280I2C(const BME280I2C::Settings& settings)
- BME280Spi(const BME280Spi::Settings& settings)
- BME280SpiSw(const BME280SpiSw::Settings& settings)
- bool begin()
- void setSettings(const Settings& settings)
- const Settings& getSettings() const
- float temp(TempUnit unit)
- float pres(PresUnit unit)
- float hum()
- void read(float& pressure, float& temp, float& humidity, TempUnit tempUnit, PresUnit presUnit)
- uint8_t chipID()
Reads temperature, humidity, and pressure. Calculates altitude and dew point. Provides functions for english and metric. Also reads pressure in Pa, hPa, inHg, atm, bar, torr, N/m^2 and psi.
To use this library download the zip file, uncompress it to a folder named BME280. Move the folder to {Arduino Path}/libraries.
Include the library at the top of your Arduino script. #include <BME280>
Create a global or local variable. BME280 bme
In your start up call bme.begin().
Read the temperature, humidity, pressure, altitude and/or dew point.
float pres, temp, hum
bme.read(pres, temp, hum)
or
temp = bme.temp()
hum = bme.hum()
pres = bme.pres()
- TempUnit_Celsius
- TempUnit_Fahrenheit
- PresUnit_Pa
- PresUnit_hPa
- PresUnit_inHg
- PresUnit_atm
- PresUnit_bar
- PresUnit_torr
- PresUnit_psi
- OSR_X1
- OSR_X2
- OSR_X4
- OSR_X8
- OSR_X16
- Mode_Sleep
- Mode_Forced
- Mode_Normal
- StandbyTime_500us
- StandbyTime_62500us
- StandbyTime_125ms
- StandbyTime_250ms
- StandbyTime_50ms
- StandbyTime_1000ms
- StandbyTime_10ms
- StandbyTime_20ms
- Filter_Off
- Filter_1
- Filter_2
- Filter_4
- Filter_8
- Filter_16
* Temperature Oversampling Rate (tempOSR): OSR Enum, default = OSR_X1
* Humidity Oversampling Rate (humOSR): OSR Enum, default = OSR_X1
* Pressure Oversampling Rate (presOSR): OSR Enum, default = OSR_X1
* Mode (mode): Mode Enum, default = Mode_Forced
* Standby Time (standbyTime): StandbyTime Enum, default = StandbyTime_1000ms
* Filter (filter): Filter Enum, default = Filter_Off
* SPI Enable: SpiEnable Enum, default = false
values: true = enable, false = disable
- Includes all fields in BME280 settings.
* BME 280 Address (bme280Addr): uint8_t, default = 0x76
- Includes all fields in BME280 settings.
* SPI Chip Select Pin (spiCsPin): uint8_t
values: Any pin 0-31
- Includes all fields in BME280 settings.
* SPI Chip Select Pin (spiCsPin): uint8_t
values: Any pin 0-31
* SPI Master Out Slave In Pin (spiMosiPin): uint8_t
values: Any pin 0-31
* SPI Master In Slave Out Pin (spiMisoPin): uint8_t
values: Any pin 0-31
* SPI Serial Clock Pin (spiSckPin): uint8_t
values: Any pin 0-31
Constructor used to create the I2C Bme class. All parameters have default values.
Constructor used to create the Spi Bme class. All parameters have default values except chip select.
Constructor used to create the software Spi Bme class. All parameters have default values except chip select, mosi, miso and sck.
Method used at start up to initialize the class. Starts the I2C or SPI interface. Can be called again to re-initialize the mode settings.
* return: bool, true = success, false = failure (no device found)
Method to set the sensor settings.
Method to get the sensor settings.
Read the temperature from the BME280 and return a float. Return: float = temperature
* unit: tempUnit, default = TempUnit_Celsius
Read the pressure from the BME280 and return a float with the specified unit. Return: float = pressure
* unit: uint8_t, default = PresUnit_Pa
Read the humidity from the BME280 and return a percentage as a float. * return: float = percent relative humidity
Read the data from the BME280 with the specified units. Return: None, however, pressure, temp and humidity are changed.
* Pressure: float, reference
values: reference to storage float for pressure
* Temperature: float, reference
values: reference to storage float for temperature
* Humidity: float, reference
values: reference to storage float for humidity
* tempUnit: tempUnit, default = TempUnit_Celsius
* presUnit: uint8_t, default = PresUnit_Pa
Returns the chip identification number.
* return: uint8_t 0x60 = BME ID, 0x58 = BMP ID
Calculate the altitude based on the pressure with the specified units. Return: float = altitude
* Pressure: float, unit = Pa
values: any float
* Metric: bool, default = true
values: true = meters, false = feet
* Sea Level Pressure: float, unit = Pa, default = 101325
values: any float
Convert current pressure to sea-level pressure, returns Altitude (in meters), temperature in Celsius
Return: The equivalent pressure at sea level.
* alitude: float
values: meters
* temp: float
values: celsius
* hum: float
Calculate the dew point based on the temperature and humidity with the specified units. Return: float = dew point
* Temperature: float, unit = Celsius if metric is true, Fahrenheit if metric is false
values: any float
* Humidity: float, unit = % relative humidity
values: any float
* Metric: bool, default = true
values: true = return degrees Celsius, false = return degrees Fahrenheit
- Fork the project.
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request.
- Jan 1, 2016 - Version 1.0.0 released
- Sep 19, 2016 - Version 2.0.0 released (Restructure for I2C and SPI)
- Nov 21, 2016 - Version 2.0.1 released (Set mode support)
- Dec 19, 2016 - Version 2.1.0 released (Support for SPI)
- Dec 21, 2016 - Version 2.1.1 released (Fixing compilation errors)
- Feb 17, 2017 - Version 2.1.2 released (Docs)
- Sept 9, 2017 - Version 2.1.3 released (Formatting, reorg)
- Sept 13, 2017 - Version 2.1.4 released (Examples update, bug fixes)
- Oct 7, 2017 - Version 2.2.0 released (Enums, begin restructure)
- Oct 10, 2017 - Version 2.2.1 released (Bug fixes)
Written by Tyler Glenn, 2016.
Special thanks to Mike Glenn for editing and reviewing the code.
GNU GPL, see License.txt