From ee40b60aad2b5bb11bb6ed1ddc2f49512d83ce9f Mon Sep 17 00:00:00 2001 From: achim Date: Fri, 29 Jul 2022 16:26:06 +0200 Subject: [PATCH] updated documentations --- README.md | 2 +- examples/C02_SIMPLE/C02_SIMPLE.ino | 6 +++--- examples/CO2_TRAFFIC_LIGHT/CO2_TRAFFIC_LIGHT_SIMPLE.ino | 2 +- examples/DIY_BASIC/DIY_BASIC.ino | 2 +- examples/DIY_PRO/DIY_PRO.ino | 2 +- examples/MINI_DISPLAY/MINI_DISPLAY.ino | 5 ++--- examples/PM2_SIMPLE/PM2_SIMPLE.ino | 6 +++--- examples/SHT_SIMPLE/SHT_SIMPLE.ino | 6 +++--- examples/TVOC/TVOC.ino | 8 ++++---- library.properties | 6 +++--- readme.txt | 2 +- 11 files changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d1049030..0d1a16e1 100644 --- a/README.md +++ b/README.md @@ -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/ diff --git a/examples/C02_SIMPLE/C02_SIMPLE.ino b/examples/C02_SIMPLE/C02_SIMPLE.ino index 027662f4..eef1f85b 100644 --- a/examples/C02_SIMPLE/C02_SIMPLE.ino +++ b/examples/C02_SIMPLE/C02_SIMPLE.ino @@ -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) @@ -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 */ diff --git a/examples/CO2_TRAFFIC_LIGHT/CO2_TRAFFIC_LIGHT_SIMPLE.ino b/examples/CO2_TRAFFIC_LIGHT/CO2_TRAFFIC_LIGHT_SIMPLE.ino index ce63d93e..59480e86 100644 --- a/examples/CO2_TRAFFIC_LIGHT/CO2_TRAFFIC_LIGHT_SIMPLE.ino +++ b/examples/CO2_TRAFFIC_LIGHT/CO2_TRAFFIC_LIGHT_SIMPLE.ino @@ -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 */ diff --git a/examples/DIY_BASIC/DIY_BASIC.ino b/examples/DIY_BASIC/DIY_BASIC.ino index 86c6ea81..d615de13 100644 --- a/examples/DIY_BASIC/DIY_BASIC.ino +++ b/examples/DIY_BASIC/DIY_BASIC.ino @@ -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 diff --git a/examples/DIY_PRO/DIY_PRO.ino b/examples/DIY_PRO/DIY_PRO.ino index 778e60b9..027c54a6 100644 --- a/examples/DIY_PRO/DIY_PRO.ino +++ b/examples/DIY_PRO/DIY_PRO.ino @@ -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 diff --git a/examples/MINI_DISPLAY/MINI_DISPLAY.ino b/examples/MINI_DISPLAY/MINI_DISPLAY.ino index f1b067bd..130984e6 100644 --- a/examples/MINI_DISPLAY/MINI_DISPLAY.ino +++ b/examples/MINI_DISPLAY/MINI_DISPLAY.ino @@ -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 @@ -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 */ diff --git a/examples/PM2_SIMPLE/PM2_SIMPLE.ino b/examples/PM2_SIMPLE/PM2_SIMPLE.ino index 990dbdb8..3c2f58d9 100644 --- a/examples/PM2_SIMPLE/PM2_SIMPLE.ino +++ b/examples/PM2_SIMPLE/PM2_SIMPLE.ino @@ -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) @@ -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 */ diff --git a/examples/SHT_SIMPLE/SHT_SIMPLE.ino b/examples/SHT_SIMPLE/SHT_SIMPLE.ino index 261ff060..fc97fc6f 100644 --- a/examples/SHT_SIMPLE/SHT_SIMPLE.ino +++ b/examples/SHT_SIMPLE/SHT_SIMPLE.ino @@ -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: SHT30/31 (Temperature/Humidity Sensor) @@ -11,9 +11,9 @@ 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/ diff --git a/examples/TVOC/TVOC.ino b/examples/TVOC/TVOC.ino index 6fdfc4d1..4d59236c 100644 --- a/examples/TVOC/TVOC.ino +++ b/examples/TVOC/TVOC.ino @@ -3,11 +3,11 @@ 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 @@ -15,12 +15,12 @@ The codes needs the following libraries installed: "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 */ diff --git a/library.properties b/library.properties index a633f0c9..82dc7731 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=AirGradient Air Quality Sensor -version=1.5.0 +version=2.0.0 author=AirGradient maintainer=AirGradient 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=* diff --git a/readme.txt b/readme.txt index d1049030..0d1a16e1 100644 --- a/readme.txt +++ b/readme.txt @@ -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/