mirror of https://github.com/arendst/Tasmota.git
50 lines
2.6 KiB
Markdown
50 lines
2.6 KiB
Markdown
|
# Adafruit PM2.5 Air Quality sensor [](https://github.com/adafruit/Adafruit_PM25AQI/actions)[](http://adafruit.github.io/Adafruit_PM25AQI/html/index.html)
|
||
|
|
|
||
|
|
This is the Adafruit PM25AQI Arduino Library for Arduino
|
||
|
|
Tested and works great with the Adafruit PM2.5 Air Quality Sensor and Breadboard Adapter Kit
|
||
|
|
|
||
|
|
[<img src="https://cdn-shop.adafruit.com/1200x900/3686-10.jpg" width="500px">](https://www.adafruit.com/products/3686)
|
||
|
|
|
||
|
|
Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!
|
||
|
|
|
||
|
|
# Installation
|
||
|
|
To install, use the Arduino Library Manager and search for "Adafruit PM25 AQI" and install the library.
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
* [Adafruit BusIO](https://github.com/adafruit/Adafruit_BusIO)
|
||
|
|
|
||
|
|
# Contributing
|
||
|
|
|
||
|
|
Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit_PM25AQI/blob/master/CODE_OF_CONDUCT.md>)
|
||
|
|
before contributing to help this project stay welcoming.
|
||
|
|
|
||
|
|
## Documentation and doxygen
|
||
|
|
Documentation is produced by doxygen. Contributions should include documentation for any new code added.
|
||
|
|
|
||
|
|
Some examples of how to use doxygen can be found in these guide pages:
|
||
|
|
|
||
|
|
https://learn.adafruit.com/the-well-automated-arduino-library/doxygen
|
||
|
|
|
||
|
|
https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips
|
||
|
|
|
||
|
|
## Formatting and clang-format
|
||
|
|
This library uses [`clang-format`](https://releases.llvm.org/download.html) to standardize the formatting of `.cpp` and `.h` files.
|
||
|
|
Contributions should be formatted using `clang-format`:
|
||
|
|
|
||
|
|
The `-i` flag will make the changes to the file.
|
||
|
|
```bash
|
||
|
|
clang-format -i *.cpp *.h
|
||
|
|
```
|
||
|
|
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.
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### clang-format resources
|
||
|
|
* [Binary builds and source available on the LLVM downloads page](https://releases.llvm.org/download.html)
|
||
|
|
* [Documentation and IDE integration](https://clang.llvm.org/docs/ClangFormat.html)
|
||
|
|
|
||
|
|
## About this Driver
|
||
|
|
Written by Ladyada for Adafruit Industries.
|
||
|
|
BSD license, check license.txt for more information
|
||
|
|
All text above must be included in any redistribution
|