Skip to content

Commit

Permalink
updated documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
achim committed Jul 29, 2022
1 parent b9a968e commit ee40b60
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Build your own low cost air quality sensor with optional display measuring PM2.5

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.

https://www.airgradient.com/diy/
https://www.airgradient.com/open-airgradient/instructions/
6 changes: 3 additions & 3 deletions examples/C02_SIMPLE/C02_SIMPLE.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This is the code for the AirGradient DIY Air Quality Sensor with an ESP8266 Micr
It is a high quality sensor showing PM2.5, CO2, Temperature and Humidity on a small display and can send data over Wifi.
For build instructions please visit https://www.airgradient.com/diy/
For build instructions please visit https://www.airgradient.com/open-airgradient/instructions/
Compatible with the following sensors:
SenseAir S8 (CO2 Sensor)
Expand All @@ -13,9 +13,9 @@ Please install ESP8266 board manager (tested with version 3.0.0)
If you have any questions please visit our forum at https://forum.airgradient.com/
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
Kits with all required components are available at https://www.airgradient.com/diyshop/
Kits with all required components are available at https://www.airgradient.com/open-airgradient/shop/
MIT License
*/
Expand Down
2 changes: 1 addition & 1 deletion examples/CO2_TRAFFIC_LIGHT/CO2_TRAFFIC_LIGHT_SIMPLE.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Please install the following libraries:
If you have any questions please visit our forum at https://forum.airgradient.com/
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
MIT License
*/
Expand Down
2 changes: 1 addition & 1 deletion examples/DIY_BASIC/DIY_BASIC.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Please set in the code below the configuration parameters.
If you have any questions please visit our forum at https://forum.airgradient.com/
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
MIT License
Expand Down
2 changes: 1 addition & 1 deletion examples/DIY_PRO/DIY_PRO.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Please set in the code below the configuration parameters.
If you have any questions please visit our forum at https://forum.airgradient.com/
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
MIT License
Expand Down
5 changes: 2 additions & 3 deletions examples/MINI_DISPLAY/MINI_DISPLAY.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ It can be configures to show the outside air quality as well as one indoor locat
For build instructions please visit
https://www.airgradient.com/resources/airgradient-diy-display/
https://www.airgradient.com/open-airgradient/blog/airgradient-diy-display/
The codes needs the following libraries installed:
"WifiManager by tzapu, tablatronix" tested with Version 2.0.5-alpha
Expand All @@ -20,7 +19,7 @@ If you have any questions please visit our forum at https://forum.airgradient.co
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
MIT License
*/
Expand Down
6 changes: 3 additions & 3 deletions examples/PM2_SIMPLE/PM2_SIMPLE.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This is the code for the AirGradient DIY Air Quality Sensor with an ESP8266 Micr
It is a high quality sensor showing PM2.5, CO2, Temperature and Humidity on a small display and can send data over Wifi.
For build instructions please visit https://www.airgradient.com/diy/
For build instructions please visit https://www.airgradient.com/open-airgradient/instructions/
Compatible with the following sensors:
Plantower PMS5003 (Fine Particle Sensor)
Expand All @@ -13,9 +13,9 @@ Please install ESP8266 board manager (tested with version 3.0.0)
If you have any questions please visit our forum at https://forum.airgradient.com/
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
Kits with all required components are available at https://www.airgradient.com/diyshop/
Kits with all required components are available at https://www.airgradient.com/open-airgradient/shop/
MIT License
*/
Expand Down
6 changes: 3 additions & 3 deletions examples/SHT_SIMPLE/SHT_SIMPLE.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ This is the code for the AirGradient DIY Air Quality Sensor with an ESP8266 Micr
It is a high quality sensor showing PM2.5, CO2, Temperature and Humidity on a small display and can send data over Wifi.
For build instructions please visit https://www.airgradient.com/diy/
For build instructions please visit https://www.airgradient.com/open-airgradient/instructions/
Compatible with the following sensors:
SHT30/31 (Temperature/Humidity Sensor)
Please install ESP8266 board manager (tested with version 3.0.0)
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
Kits with all required components are available at https://www.airgradient.com/diyshop/
Kits with all required components are available at https://www.airgradient.com/open-airgradient/shop/
If you have any questions please visit our forum at https://forum.airgradient.com/
Expand Down
8 changes: 4 additions & 4 deletions examples/TVOC/TVOC.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ This is the code for the AirGradient DIY Air Quality Sensor with an ESP8266 Micr
It is a high quality sensor showing PM2.5, CO2, Temperature and Humidity on a small display and can send data over Wifi.
For build instructions please visit https://www.airgradient.com/diy/
For build instructions please visit https://www.airgradient.com/open-airgradient/instructions/
Instructions on using the TVOC sensor (SGP30) instead of the Temperature / Humidity sensor (SHT3x).
https://www.airgradient.com/resources/tvoc-on-airgradient-diy-sensor/
https://www.airgradient.com/open-airgradient/instructions/tvoc-on-airgradient-diy-sensor/
The codes needs the following libraries installed:
"WifiManager by tzapu, tablatronix" tested with Version 2.0.3-alpha
"ESP8266 and ESP32 OLED driver for SSD1306 displays by ThingPulse, Fabrice Weinberg" tested with Version 4.1.0
"SGP30" by Rob Tillaart tested with Version 0.1.4
Configuration:
Please set in the code below which sensor you are using and if you want to connect it to WiFi.
Set in the code below which sensor you are using and if you want to connect it to WiFi.
If you have any questions please visit our forum at https://forum.airgradient.com/
If you are a school or university contact us for a free trial on the AirGradient platform.
https://www.airgradient.com/schools/
https://www.airgradient.com/
MIT License
*/
Expand Down
6 changes: 3 additions & 3 deletions library.properties
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=AirGradient Air Quality Sensor
version=1.5.0
version=2.0.0
author=AirGradient <support@airgradient.com>
maintainer=AirGradient <support@airgradient.com>
sentence=ESP8266 library for an air quality sensor featuring PM2.5, CO2, Temperature and Humidity with OLED display.
paragraph=The library is very robust and works with the Plantower PMS5003 particle sensor, the Senseair S8 CO2 sensor and the SHT30/31 sensor for humidity and temperature. You can also connect an OLED display or send the air quality data to the AirGradient platform or any other backend.
paragraph=The library is very robust and works with the Plantower PMS5003 particle sensor, the Senseair S8 CO2 sensor and the SHT30/31 sensor for humidity and temperature. You can also connect an OLED display or send the air quality data to the AirGradient platform or any other backend. Kits with all components including a nice enclosure are available in our online shop.
category=Sensors
url=https://github.com/airgradienthq/arduino
url=https://www.airgradient.com/open-airgradient/instructions/
architectures=*
2 changes: 1 addition & 1 deletion readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Build your own low cost air quality sensor with optional display measuring PM2.5

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.

https://www.airgradient.com/diy/
https://www.airgradient.com/open-airgradient/instructions/

0 comments on commit ee40b60

Please sign in to comment.