sparkfun BME280 Breakout Board User Guide

SparkFun BME280 Breakout 
Hookup Guide

CONTRIBUTORS:  MTAYLOR

Introduction

The BME280 Breakout Board is the easy way to measure pressure and humidity, and without taking up a lot of room. It gives you easy to solder 0.1″ headers, runs I2C or SPI, takes measurements at less than 1mA and idles less than 5uA (yes, microamps!).
The BME280 can be used to take pressure, humidity, and temperature readings. Use the data to get relative altitude changes, or absolute altitude if the locally reported barometric pressure is known.

The BME280 Breakout Board.

Ranges:

• Temp: ­40C to 85C
• Humidity: 0 ­ 100% RH, =­3% from 20­80%
• Pressure: 30,000Pa to 110,000Pa, relative accuracy of 12Pa, absolute accuracy of 100Pa
• Altitude: 0 to 30,000 ft (9.2 km), relative accuracy of 3.3 ft (1 m) at sea level, 6.6 (2 m) at 30,000 ft.

Covered In This Tutorial

This tutorial gives you all you need to get going with the BME280. First we’ll take a look at the IC and hardware, then we’ll use the SparkFun BME280 Arduino library to get data out of it by SPI or I2C.
The tutorial is split into the following pages:

• BME280 Hardware Overview – Basic information about the hardware.
• Assembly – Connect to the BME280 by I2C or SPI
• Installing the Arduino Library – How to get it
• Using the Arduino Library – explains the user API
• Theory and Example Data – Showcase of the examples included with the library.
• Resources and Going Further – Links to the datasheet and application notes, plus inspirational projects

Required Materials
Get the datasheet and application notes now. Keep a copy to refer to once you get off the charted path.

• Bosch BME280 Datasheet

This tutorial explains how to use the BME280 Breakout Board with an Redbeard (or Arduino). To follow along, you’ll need the following materials:

• BME280 Breakout Board
• Arduino UNO, Redbeard, or another Arduino compatible board
• Straight Male Headers – Or wire. Something to connect between the breakout and a breadboard.
• Breadboard – Any size (even mini) should do.
• M/M Jumper Wires – To connect between Arduino and breadboard.
• Logic Level Converter – To shift SPI levels from 5v to 3.3v.

The BME280 is a 3.3V device! Supplying voltages greater than ~3.6V can permanently damage the IC. As long as your Arduino has a 3.3V supply output, and you’re OK with using I² C, you shouldn’t need any extra level shifting. But if you want to use SPI, you may need a Logic Level Converter.
If you use a 3.3V­based micro – like the Arduino Pro 3.3V or 3.3V Pro Mini – there is no need for level shifting.

Suggested Reading

Connection of the BME280 uses some basic concepts shared by a lot of our products. If you want to get more familiar with these basic tasks, these articles can help you out.

• Serial Peripheral Interface (SPI)
• Interact Communication (I² C)
• Logic Levels
• Bidirectional Level Shifter Hookup Guide

If the concepts of pressure are weighing on you, check out these links.

• (external) Air Pressure Altitude Calculator – Play around to get a feel for what the pressures are at different altitudes.
• Wikipedia: Atmospheric pressure – Has a nice equation for conversion of pressure and altitude (referenced for library code).
• MPL3115a2­pressure­sensor­hookup­guide – pressure­vs­altimeter­setting – Confused why the reading pressure doesn’t match the reported pressure from your local weather station? Read this section.

Hardware Overview

The Front Side
The BME280 Breakout board has 10 pins, but no more than 6 are used at a single time.

Use one header for I2C connections, or the other for SPI connections – no need to use both!
The left side of the board are power, ground, and I² C pins.

The remaining pins are broken out on the other side. These pins break out SPI functionality and have another power and ground.

The Back Side
Select)On the other side of the board you’ll find all the configuration jumpers. Pull­ups can be left connected even when using SPI mode, so you’ll probably never have to touch these. If you do, here’s what they’re for.

Assembly

Attaching the headers
The board comes without headers. Regular wires can be soldered in, but for a more configurable breadboard experience you may want to attach headers.For generic operation solder both headers (left). If you only need I² C (middle), or SPI (right), only attach those headers.
I²C Connection
The sensor pulls the I²C lines to 3.3V, so they can be directly connect to the redboard’s A4/A5 pins, or the SDA/SCL pins (as long as they’re configured by Wire). Make sure to power the sensor from 3.3v!
The power and ground pins are connected, so you only need to connect to one side.
Diagram showing I2C connection to the BME280. You could also use the dedicated SDA and SCL lines found on most Arduino boards.

SPI Connection

The SPI connection isn’t quite straightforward when connected to a Red Board. The Logic Level Converter is required to bridge between the 3.3v requirement of the BME280 and the 5v IO of the Red Board. 3.3v microcontrollers such as the fabulous Teensy 3.2 can be directly connected.

Installing the Arduino Library

We’ve created an Arduino library to get the BME280 operational with Arduino IDE compatible boards.
Before we get in to what the library does, obtain a copy of it.
Download the GitHub repository
Visit the GitHub repository to download the most recent version of the library, or click the link below:
DOWNLOAD THE SPARKFUN BME280 ARDUINO LIBRARY
Use the library manager / install in the Arduino IDE
For help installing the library, check out our How To Install An Arduino Library tutorial.
If you don’t end up using the manger, you’ll need to move the SparkFun_BME280_Arduino_Library
folder into a libraries folder within your Arduino sketchbook.

Functions of the Arduino Library

The basic library has the following parts
Construction
Example:
BME280 mySensor;
In the global scope, construct your sensor object (such as  mySensor  or  pressureSensorA ) without arguments.
Object parameters and setup()
Rather that passing a bunch of data to the constructor, configuration is accomplished by setting the values of the BME280 type in the  setup()  function. They are exposed by being  public:  so use the myName.aVarable = some Value;  syntax.
Settable variables of the class BME280:

An example configuration  setup()

begin();
In the above example, begin is used to start the sensor. Begin takes no arguments and returns ID word.
The basic routine it follows is like this:

• Starts up the wiring library if necessary, though  #include “Wire’s”  and  #include “Sigh”  may be needed in your sketch.
• Configures the CS pin as output if necessary.
• Concatenates the calibration words as specified by Bosch.
• Applies user settings to the configuration registers in the BME280.
• Returns the ID register (should read 0x60).

To use it, call  mySensor. Begin();  or assign the output to something like uint8_t myReturnedValue = mySensor. Begin();
.begin() Needs to be run once during the setup, or after any settings have been modified.
Additionally, your sketch should wait for greater than 2 ms before you take data in order to let the sensor’s configuration take place.
reset()
Send the reset word to the BME280. Afterwards, you’ll have to run begin() again.
Reset takes no arguments and returns void.
read Tamp()
Use to get the temperature in Celsius, as a float. Takes no arguments and returns a floating point.
example:  float Mylar = mySensor.readTempC();
readTempF()
Use to get the temperature in Fahrenheit, as a float. Takes no arguments.
example:  float Mylar = mySensor.readTempC();
readFloatPressure()
Use to get pressure in units of kilopascals, as a float. Takes no arguments.
example:  float Mylar = mySensor. ReadFloatPressure();
readFloatAltitudeMeters()
Use to get altitude in units of meters, as a float. This function calculates based off the measured
pressure. Takes no arguments.
example:  float myVar = mySensor.readFloatAltitudeMeters();
readFloatAltitudeFeet()
Use to get altitude in units of feet, as a float. This function calculates based off the measured pressure.
Takes no arguments.
example:  float myVar = mySensor.readFloatAltitudeFeet();
readFloatHumidity()
Use to get humidity in % relative, as a float. Takes no arguments.
example:  float myVar = mySensor.readFloatHumidity();

Example Sketches

The examples are selectable from the drop­down menu in the Arduino IDE, or they will run stand­alone if you put the contents of the libraries /src directory in with the example.ino file.
All of the examples default to 57600 baud.
I2C_and_SPI_Multisensor.ino
This example configures one BME280 on the SPI bus and another on the I2C bus. Then it gets the data and outputs from both sensors every second. If you only have 1 sensor connected the other channel reports garbage, so this can be a good troubleshooting and starting place.
Example output – shown is the configuration plus the first 3 sample readings

CSV_Output.ino
If you want to use the BME280 to record data as a function of time, this example is for you! It outputs text as CSV (comma separated vales) that can be copy pasted into a textile or spreadsheet app for graphing.
A note on accuracy: This sketch use “delay(50);” to wait 50ms between reads. The units of the ‘sample’ column are in (50ms + time­to­read) periods.In order to demonstrate the operation, the BME280 is connected with fine hookup wires that are then placed in a bottle and pressurized with breath.
Data is collected from the event, and then a graph is made. To do this, the un­needed columns were deleted, and the pressure was scaled to kPa.

Example graph of pressure and humidity ­ shown after the data was loaded into OpenOffice Calc
I2C_ReadAllData.ino
Here’s an example that prints out the registers as well as the internally concatenated calibration words. It can be used to check the state of the BME280 after a particular configuration or can be implanted in your own sketch where you need to debug.

Example output – shows the full contents of memory, even those not specified in the datasheet
I2C_DeltaAltitude.ino
This example allows you to take measurements of change in altitude. It configures the BME280 with a lot of oversampling and also uses a software filter giving accurate but slow performance.
The sketch uses an additional button to zero the altitude. Push and hold until the average reaches zero.

After the sensor was zeroed out on the floor and moved to a desk Hight, the output displays the rough height of the desk!
Product Video Sketches
The library also has a subfolder in the examples folder that contains the sketches used in the product video. They’re modifications of the basic examples with a LCD added on. They are not covered by this tutorial.

Resources and Going Further

Resources

• BME280 Product GitHub Repository – Your revision controlled source for all things BME280. Here you’ll find our most up-to-date hardware layouts and code.
• Bosch BME280 Datasheet – This datasheet covers everything in one handy document.

Going Further
Hopefully this guide has gotten your BME280 operational. What will it become? Weather monitoring?
Flight control on a quadcopter? Terrarium climate control?
To get you thinking, here are a few articles to browse.

• Weather Ballooning in the White Mountains
• SparkFun Data Service
• Enginursday: These Are Not the Drones You’re Looking For

Let us know what your BME280 becomes!
Check out these other great weather related tutorials.

TMP006 Hookup Guide
How to get started reading temperature with the TMP006 sensor.MS5803­14BA Pressure Sensor Hookup Guide
Breakout of MS5803­14BA Pressure Sensor

MPL3115A2 Pressure Sensor Hookup Guide
Getting started with this amazing barometric pressure sensor.

BMP180 Barometric Pressure Sensor
Hookup
The BMP180 is a barometric pressure sensor, this tutorial tells you how to use it.

https://learn.sparkfun.com/tutorials/sparkfun­bme280­breakout­hookup­guide?
_ga=1.102657217.1980810861.1447671424