|
1 | 1 | # Adafruit BME280 Library [](https://github.com/adafruit/Adafruit_BME280_Library/actions)[](http://adafruit.github.io/Adafruit_BME280_Library/html/index.html)
|
2 | 2 |
|
| 3 | + |
3 | 4 | <a href="http://www.adafruit.com/products/2652"><img src="./assets/board.jpg" width="500"/></a>
|
4 | 5 |
|
5 | 6 | This is a library for the Adafruit BME280 Humidity, Barometric Pressure + Temp sensor
|
6 | 7 |
|
7 | 8 | Designed specifically to work with the Adafruit BME280 Breakout
|
8 | 9 | * http://www.adafruit.com/products/2652
|
9 | 10 |
|
10 |
| -These sensors use I2C or SPI to communicate, up to 4 pins are required to interface |
| 11 | +Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit! |
| 12 | + |
| 13 | +# Installation |
| 14 | +To install, use the Arduino Library Manager and search for "Adafruit BME280" and install the library. |
| 15 | + |
| 16 | +## Dependencies |
| 17 | + * [Adafruit Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor) |
| 18 | + |
| 19 | +# Contributing |
| 20 | + |
| 21 | +Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit_PM25AQI/blob/master/CODE_OF_CONDUCT.md>) |
| 22 | +before contributing to help this project stay welcoming. |
| 23 | + |
| 24 | +## Documentation and doxygen |
| 25 | +Documentation is produced by doxygen. Contributions should include documentation for any new code added. |
| 26 | + |
| 27 | +Some examples of how to use doxygen can be found in these guide pages: |
| 28 | + |
| 29 | +https://learn.adafruit.com/the-well-automated-arduino-library/doxygen |
| 30 | + |
| 31 | +https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips |
11 | 32 |
|
12 |
| -Use of this library also requires [Adafruit_Sensor](https://github.com/adafruit/Adafruit_Sensor) |
13 |
| -to be installed on your local system. |
| 33 | +## Formatting and clang-format |
| 34 | +This library uses [`clang-format`](https://releases.llvm.org/download.html) to standardize the formatting of `.cpp` and `.h` files. |
| 35 | +Contributions should be formatted using `clang-format`: |
14 | 36 |
|
15 |
| -Adafruit invests time and resources providing this open source code, |
16 |
| -please support Adafruit and open-source hardware by purchasing |
17 |
| -products from Adafruit! |
| 37 | +The `-i` flag will make the changes to the file. |
| 38 | +```bash |
| 39 | +clang-format -i *.cpp *.h |
| 40 | +``` |
| 41 | +If you prefer to make the changes yourself, running `clang-format` without the `-i` flag will print out a formatted version of the file. You can save this to a file and diff it against the original to see the changes. |
18 | 42 |
|
19 |
| -Check out the links above for our tutorials and wiring diagrams |
| 43 | +Note that the formatting output by `clang-format` is what the automated formatting checker will expect. Any diffs from this formatting will result in a failed build until they are addressed. Using the `-i` flag is highly recommended. |
20 | 44 |
|
21 |
| -Written by Limor Fried/Ladyada for Adafruit Industries. |
22 |
| -BSD license, all text above must be included in any redistribution |
| 45 | +### clang-format resources |
| 46 | + * [Binary builds and source available on the LLVM downloads page](https://releases.llvm.org/download.html) |
| 47 | + * [Documentation and IDE integration](https://clang.llvm.org/docs/ClangFormat.html) |
23 | 48 |
|
24 |
| -To download. click the DOWNLOAD ZIP button, rename the uncompressed folder Adafruit_BME280. |
25 |
| -Check that the Adafruit_BME280 folder contains Adafruit_BME280.cpp and Adafruit_BME280.h |
| 49 | +## About this Driver |
| 50 | +Written by Ladyada for Adafruit Industries. |
26 | 51 |
|
27 |
| -Place the Adafruit_BME280 library folder your arduinosketchfolder/libraries/ folder. |
28 |
| -You may need to create the libraries subfolder if its your first library. Restart the IDE. |
| 52 | +BSD license, check license.txt for more information |
29 | 53 |
|
30 |
| -We also have a great tutorial on Arduino library installation at: |
31 |
| -http://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use |
| 54 | +All text above must be included in any redistribution |
0 commit comments