From 4af77d532ed38e852c4baaec07272c9e5b61afea Mon Sep 17 00:00:00 2001 From: Phat Nguyen Date: Sat, 20 Jul 2024 09:39:29 +0700 Subject: [PATCH 1/4] Update local-server.md Quote properties name --- docs/local-server.md | 74 ++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/local-server.md b/docs/local-server.md index 925117f..7092b35 100644 --- a/docs/local-server.md +++ b/docs/local-server.md @@ -47,27 +47,27 @@ You get the following response: | Properties | Type | Explanation | |------------------|--------|--------------------------------------------------------------------| -| serialno | String | Serial Number of the monitor | -| wifi | Number | WiFi signal strength | -| pm01 | Number | PM1 in ug/m3 | -| pm02 | Number | PM2.5 in ug/m3 | -| pm10 | Number | PM10 in ug/m3 | -| pm02Compensated | Number | PM2.5 in ug/m3 with correction applied (from fw version 3.1.4 onwards) | -| rco2 | Number | CO2 in ppm | -| pm003Count | Number | Particle count per dL | -| atmp | Number | Temperature in Degrees Celsius | -| atmpCompensated | Number | Temperature in Degrees Celsius with correction applied | -| rhum | Number | Relative Humidity | -| rhumCompensated | Number | Relative Humidity with correction applied | -| tvocIndex | Number | Senisiron VOC Index | -| tvocRaw | Number | VOC raw value | -| noxIndex | Number | Senisirion NOx Index | -| noxRaw | Number | NOx raw value | -| boot | Number | Counts every measurement cycle. Low boot counts indicate restarts. | -| bootCount | Number | Same as boot property. Required for Home Assistant compatability. Will be depreciated. | -| ledMode | String | Current configuration of the LED mode | -| firmware | String | Current firmware version | -| model | String | Current model name | +| `serialno` | String | Serial Number of the monitor | +| `wifi` | Number | WiFi signal strength | +| `pm01` | Number | PM1 in ug/m3 | +| `pm02` | Number | PM2.5 in ug/m3 | +| `pm10` | Number | PM10 in ug/m3 | +| `pm02Compensated` | Number | PM2.5 in ug/m3 with correction applied (from fw version 3.1.4 onwards) | +| `rco2` | Number | CO2 in ppm | +| `pm003Count` | Number | Particle count per dL | +| `atmp` | Number | Temperature in Degrees Celsius | +| `atmpCompensated` | Number | Temperature in Degrees Celsius with correction applied | +| `rhum` | Number | Relative Humidity | +| `rhumCompensated` | Number | Relative Humidity with correction applied | +| `tvocIndex` | Number | Senisiron VOC Index | +| `tvocRaw` | Number | VOC raw value | +| `noxIndex` | Number | Senisirion NOx Index | +| `noxRaw` | Number | NOx raw value | +| `boot` | Number | Counts every measurement cycle. Low boot counts indicate restarts. | +| `bootCount` | Number | Same as boot property. Required for Home Assistant compatability. Will be depreciated. | +| `ledMode` | String | Current configuration of the LED mode | +| `firmware` | String | Current firmware version | +| `model` | String | Current model name | Compensated values apply correction algorithms to make the sensor values more accurate. Temperature and relative humidity correction is only applied on the outdoor monitor Open Air but the properties _compensated will still be send also for the indoor monitor AirGradient ONE. @@ -108,19 +108,19 @@ If the monitor is set up on the AirGradient dashboard, it will also receive conf | Properties | Description | Type | Accepted Values | Example | |-------------------------|:-------------------------------------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| country | Country where the device is. | String | Country code as [ALPHA-2 notation](https://www.iban.com/country-codes) | {"country": "TH"} | -| model | Hardware identifier (only GET). | String | I-9PSL-DE | {"model": "I-9PSL-DE"} | -| pmStandard | Particle matter standard used on the display. | String | `ugm3`: ug/m3
`us-aqi`: USAQI | {"pmStandard": "ugm3"} | -| ledBarMode | Mode in which the led bar can be set. | String | `co2`: LED bar displays CO2
`pm`: LED bar displays PM
`off`: Turn off LED bar | {"ledBarMode": "off"} | -| displayBrightness | Brightness of the Display. | Number | 0-100 | {"displayBrightness": 50} | -| ledBarBrightness | Brightness of the LEDBar. | Number | 0-100 | {"ledBarBrightness": 40} | -| abcDays | Number of days for CO2 automatic baseline calibration. | Number | Maximum 200 days. Default 8 days. | {"abcDays": 8} | -| mqttBrokerUrl | MQTT broker URL. | String | | {"mqttBrokerUrl": "mqtt://192.168.0.18:1883"} | -| temperatureUnit | Temperature unit shown on the display. | String | `c` or `C`: Degree Celsius °C
`f` or `F`: Degree Fahrenheit °F | {"temperatureUnit": "c"} | -| configurationControl | The configuration source of the device. | String | `both`: Accept local and cloud configuration
`local`: Accept only local configuration
`cloud`: Accept only cloud configuration | {"configurationControl": "both"} | -| postDataToAirGradient | Send data to AirGradient cloud. | Boolean | `true`: Enabled
`false`: Disabled | {"postDataToAirGradient": true} | -| co2CalibrationRequested | Can be set to trigger a calibration. | Boolean | `true`: CO2 calibration (400ppm) will be triggered | {"co2CalibrationRequested": true} | -| ledBarTestRequested | Can be set to trigger a test. | Boolean | `true` : LEDs will run test sequence | {"ledBarTestRequested": true} | -| noxLearningOffset | Set NOx learning gain offset. | Number | 0-720 (default 12) | {"noxLearningOffset": 12} | -| tvocLearningOffset | Set VOC learning gain offset. | Number | 0-720 (default 12) | {"tvocLearningOffset": 12} | -| offlineMode | Set monitor to run without WiFi. | Boolean | `false`: Disabled (default)
`true`: Enabled | {"offlineMode": true} | +| `country` | Country where the device is. | String | Country code as [ALPHA-2 notation](https://www.iban.com/country-codes) | {"country": "TH"} | +| `model` | Hardware identifier (only GET). | String | I-9PSL-DE | {"model": "I-9PSL-DE"} | +| `pmStandard` | Particle matter standard used on the display. | String | `ugm3`: ug/m3
`us-aqi`: USAQI | {"pmStandard": "ugm3"} | +| `ledBarMode` | Mode in which the led bar can be set. | String | `co2`: LED bar displays CO2
`pm`: LED bar displays PM
`off`: Turn off LED bar | {"ledBarMode": "off"} | +| `displayBrightness` | Brightness of the Display. | Number | 0-100 | {"displayBrightness": 50} | +| `ledBarBrightness` | Brightness of the LEDBar. | Number | 0-100 | {"ledBarBrightness": 40} | +| `abcDays` | Number of days for CO2 automatic baseline calibration. | Number | Maximum 200 days. Default 8 days. | {"abcDays": 8} | +| `mqttBrokerUrl` | MQTT broker URL. | String | | {"mqttBrokerUrl": "mqtt://192.168.0.18:1883"} | +| `temperatureUnit` | Temperature unit shown on the display. | String | `c` or `C`: Degree Celsius °C
`f` or `F`: Degree Fahrenheit °F | {"temperatureUnit": "c"} | +| `configurationControl` | The configuration source of the device. | String | `both`: Accept local and cloud configuration
`local`: Accept only local configuration
`cloud`: Accept only cloud configuration | {"configurationControl": "both"} | +| `postDataToAirGradient` | Send data to AirGradient cloud. | Boolean | `true`: Enabled
`false`: Disabled | {"postDataToAirGradient": true} | +| `co2CalibrationRequested` | Can be set to trigger a calibration. | Boolean | `true`: CO2 calibration (400ppm) will be triggered | {"co2CalibrationRequested": true} | +| `ledBarTestRequested` | Can be set to trigger a test. | Boolean | `true` : LEDs will run test sequence | {"ledBarTestRequested": true} | +| `noxLearningOffset` | Set NOx learning gain offset. | Number | 0-720 (default 12) | {"noxLearningOffset": 12} | +| `tvocLearningOffset` | Set VOC learning gain offset. | Number | 0-720 (default 12) | {"tvocLearningOffset": 12} | +| `offlineMode` | Set monitor to run without WiFi. | Boolean | `false`: Disabled (default)
`true`: Enabled | {"offlineMode": true} | From b5cced40d2643e4b04c58b15825e7d885819bfea Mon Sep 17 00:00:00 2001 From: AirGradient <68736665+airgradienthq@users.noreply.github.com> Date: Wed, 7 Aug 2024 11:05:39 +0700 Subject: [PATCH 2/4] Update local-server.md --- docs/local-server.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/local-server.md b/docs/local-server.md index 7092b35..9bb9bcc 100644 --- a/docs/local-server.md +++ b/docs/local-server.md @@ -101,6 +101,9 @@ Example to set monitor to Celsius ```curl -X PUT -H "Content-Type: application/json" -d '{"temperatureUnit":"c"}' http://airgradient_84fce612eff4.local/config ``` + If you use command prompt on Windows, you need to escape the quotes: + -d "{\"param\":\"value\"}" + #### Avoiding Conflicts with Configuration on AirGradient Server If the monitor is set up on the AirGradient dashboard, it will also receive configurations from there. In case you do not want this, please set `configurationControl` to `local`. In case you set it to `cloud` and want to change it to `local`, you need to make a factory reset. From dc261f668dae55ec64829cccddaccb825bd24402 Mon Sep 17 00:00:00 2001 From: AirGradient <68736665+airgradienthq@users.noreply.github.com> Date: Wed, 7 Aug 2024 11:08:48 +0700 Subject: [PATCH 3/4] Update local-server.md II --- docs/local-server.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/local-server.md b/docs/local-server.md index 9bb9bcc..1daede0 100644 --- a/docs/local-server.md +++ b/docs/local-server.md @@ -102,7 +102,8 @@ Example to set monitor to Celsius ```curl -X PUT -H "Content-Type: application/json" -d '{"temperatureUnit":"c"}' http://airgradient_84fce612eff4.local/config ``` If you use command prompt on Windows, you need to escape the quotes: - -d "{\"param\":\"value\"}" + + ``` -d "{\"param\":\"value\"}" ``` #### Avoiding Conflicts with Configuration on AirGradient Server If the monitor is set up on the AirGradient dashboard, it will also receive configurations from there. In case you do not want this, please set `configurationControl` to `local`. In case you set it to `cloud` and want to change it to `local`, you need to make a factory reset. From 186f0d27abd28985ce3f18d9003d5e237ba1d15c Mon Sep 17 00:00:00 2001 From: Phat Nguyen Date: Fri, 23 Aug 2024 08:59:28 +0700 Subject: [PATCH 4/4] Update version --- library.properties | 2 +- src/AirGradient.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index a1065af..40d9338 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=AirGradient Air Quality Sensor -version=3.1.4 +version=3.1.5 author=AirGradient maintainer=AirGradient sentence=ESP32-C3 / ESP8266 library for air quality monitor measuring PM, CO2, Temperature, TVOC and Humidity with OLED display. diff --git a/src/AirGradient.h b/src/AirGradient.h index 6285f0d..9e1d220 100644 --- a/src/AirGradient.h +++ b/src/AirGradient.h @@ -15,7 +15,7 @@ #include "Main/utils.h" #ifndef GIT_VERSION -#define GIT_VERSION "3.1.4" +#define GIT_VERSION "3.1.5-snapshot" #endif /**