malokhvii-eduard/arduino-bme280

💧 Arduino library for Bosch Sensortec BME280 – combined temperature, pressure, humidity sensor. The library allows using the sensor over I2C or SPI on any board that supports Arduino.

💧 Arduino library for Bosch Sensortec BME280

The library allows using the sensor over I2C or SPI on any board that supports Arduino.

🎉 Features

• 🚀 Easy to use
• 🗜️ Zero dependencies
• ⚙️ I2C or SPI
• 🧪 100% code coverage
• ⚗️ Tested on: Arduino Uno, Arduino Nano, NodeMCU, Wemos D1

✨ Getting Started

📦 Installation

👉 PlatformIO

Run pio lib install "malokhvii-eduard/arduino-bme280" or declare in platformio.ini configuration file using lib_deps option. Enjoy! 🎉👍

👉 Arduino IDE (Library Manager)

Go to the Arduino IDE and click Tools > Manage Libraries. In the library manager dialogue that opens, enter search query Bme280. Afterward, find a library Bme280 by Eduard Malokhvii and click Install. Enjoy! 🎉👍

👉 Arduino IDE (Manual)

Download Bme280.zip from release assets. Once downloaded, go to the Arduino IDE and click Sketch > Include Library > Add .zip Library. In the file dialogue that opens, locate your downloaded ZIP file. Afterward, you should receive a Library Added message just above the debug window. Enjoy! 🎉👍

👀 Usage

There are various examples to demonstrate usage of the library. The examples are listed below:

• TwoWire.ino – read temperature, pressure, humidity over I2C
• FourWire.ino – read temperature, pressure, humidity over SPI
• Settings.ino – set different settings

❓ FAQs

🙋‍♂️ In which units temperature, pressure, humidity are measured?

👉 The temperature is measured in degrees Celsius (symbol: °C). The pressure is measured in pascals (symbol: Pa). The humidity is measured in percentages (symbol: %).

🙋‍♂️ What settings are used by default?

👉 The default settings are:

• mode – Bme280Mode::Normal
• temperature oversampling – Bme280Oversampling::X16
• pressure oversampling – Bme280Oversampling::X16
• humidity oversampling – Bme280Oversampling::X16
• filter – Bme280Filter::Off
• standby time – Bme280StandbyTime::Ms0_5

🙋‍♂️ Are there any settings presets out-of-the-box?

👉 Yes. There are some settings presets out-of-the-box according to the recomendations in the datasheet. You can create settings preset by call one of factory methods in Bme280Settings. The factory methods are listed below:

• Bme280Settings::indoor()
• Bme280Settings::weatherMonitoring()
• Bme280Settings::gaming()
• Bme280Settings::humiditySensing()

🙋‍♂️ How to off one of any measurements?

👉 Assign Bme280Oversampling::Off to an oversampling in settings.

🙋‍♂️ How does it work?

👉 You can explore unit tests to see the behavior of all library members.

🛠️ Tech Stack

✍️ Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/awesome-feature)
3. Commit your Changes (git commit -m 'Add awesome feature')
4. Push to the Branch (git push origin feature/awesome-feature)
5. Open a Pull Request

💖 Like this project?

Leave a ⭐ if you think this project is cool or useful for you.

⚠️ License

arduino-bme280 is licenced under the MIT License. See the LICENSE for more information.

arduino-bme280's Issues

Feature request: check if sensor is present

Hello,
using BME280 in I2C with ESP32. Arduino IDE 1.8.19, latest Arduino-ESP32 core (2.0.14).

Even if no sensor is attached I can call sensor.begin(), setSettings(), getTemperature() etc.: I can't seem to have a way to tell if a sensor is actually present/working.

It would be nice to have for, example, begin() returning false if the BME280 is not attached or not responding.
Or maybe it already works this way, but I cannot find the API documentation so I don't know if begin() returns something.

Thanks for reading.

Set a specific (setting) parameter, starting from a factory preset

Hello, thanks for the library.

Let's say I want to set the BME280 in Forced mode, while all other settings I would take from the "indoor" preset.
How would I do that, is there an example? Only found examples about enabling one of the presets (Settings.ino) as is.
Thanks

Code is locked in setup if sensor is not present at boot time

Hi!

I just used this library and if sensor is not connected at boot time, then program stays in setup in an infinite loop.

void setup() {
  Serial.begin(9600);
  Wire.begin(D2, D1);

  Serial.println();

  sensor.begin(Bme280TwoWireAddress::Primary);  <---- here
  sensor.setSettings(Bme280Settings::indoor());
}

Bme280.cpp:

  while (isImUpdate()) {   <--- because of this
    delay(20);
  }

I fixed it by changing with:

 isImUpdate();

Is this code lock done intentionally or is it just a mistake?

Thank you, regards,
Peter