Complete rewrite of the library with modular structure.

This commit is contained in:
Achim
2024-02-03 10:46:26 +07:00
parent d0e9d729a5
commit 990f2482bb
278 changed files with 54881 additions and 5058 deletions

View File

@ -1,8 +1,41 @@
AirGradient Arduino Library for ESP8266 (Wemos D1 MINI)
AirGradient Arduino Library for ESP8266 (Wemos D1 MINI) and ESP32 (ESP32-C3 Mini)
=====================================================================================================
Build your own low cost air quality sensor with optional display measuring PM2.5, CO2, Temperature and Humidity.
This is the code for the AirGradient open-source indoor and outdoor air quality monitors with ESP8266 / ESP32-C3 Microcontrollers.
This library makes it easy to read the sensor data from the Plantower PMS5003 PM2.5 sensor, the Senseair S8 and the SHT30/31 Temperature and Humidity sensor. Visit our DIY section for detailed build instructions and PCB layout.
More information on the air quality monitors and kits are available here:
Indoor Monitor: [https://www.airgradient.com/indoor/](https://www.airgradient.com/indoor/)
Outdoor Monitor: [https://www.airgradient.com/outdoor/](https://www.airgradient.com/outdoor/)
https://www.airgradient.com/open-airgradient/instructions/
This library supports the following sensor modules:
- Plantower PMS5003
- Plantower PMS5003T
- SenseAir S8
- Sensirion SGP41
- Sensirion SHT40
## Important information
Make sure you have exactly the versions of libraries and boards installed as described in the comment section of the example files.
If you have an older version of the AirGradient PCB not mentioned in the example files, please downgrade this library to version 2.4.15 to support these legacy boards.
## Help & Support
If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).
## The following libraries have been integrated into this library for ease of use
- [Adafruit BusIO](https://github.com/adafruit/Adafruit_BusIO)
- [Adafruit NeoPixel](https://github.com/adafruit/Adafruit_NeoPixel)
- [Adafruit SH110X](https://github.com/adafruit/Adafruit_SH110X)
- [Adafruit SSD1306 Wemos Mini OLED](https://github.com/stblassitude/Adafruit_SSD1306_Wemos_OLED)
- [Adafruit GFX Library](https://github.com/adafruit/Adafruit-GFX-Library)
- [Sensirion Gas Index Algorithm](https://github.com/Sensirion/arduino-gas-index-algorithm)
- [Sensirion Core](https://github.com/Sensirion/arduino-core/)
- [Sensirion I2C SGP41](https://github.com/Sensirion/arduino-i2c-sgp41)
- [Sensirion I2C SHT4x](https://github.com/Sensirion/arduino-i2c-sht4x)
- [PMS](https://github.com/fu-hsi/pms)
## License
CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License