From c5c0dae4bb89cbc0dcdcad802f4a28e6626e1462 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Sat, 25 Jan 2025 01:51:20 +0700 Subject: [PATCH 01/13] Add config to disableCloudConnection functions --- src/AgConfigure.cpp | 26 ++++++++++++++++++++++++++ src/AgConfigure.h | 2 ++ 2 files changed, 28 insertions(+) diff --git a/src/AgConfigure.cpp b/src/AgConfigure.cpp index 57e864b..25d0f5d 100644 --- a/src/AgConfigure.cpp +++ b/src/AgConfigure.cpp @@ -47,6 +47,7 @@ JSON_PROP_DEF(mqttBrokerUrl); JSON_PROP_DEF(temperatureUnit); JSON_PROP_DEF(configurationControl); JSON_PROP_DEF(postDataToAirGradient); +JSON_PROP_DEF(disableCloudConnection); JSON_PROP_DEF(ledBarBrightness); JSON_PROP_DEF(displayBrightness); JSON_PROP_DEF(co2CalibrationRequested); @@ -66,6 +67,7 @@ JSON_PROP_DEF(corrections); #define jprop_temperatureUnit_default "c" #define jprop_configurationControl_default String(CONFIGURATION_CONTROL_NAME[ConfigurationControl::ConfigurationControlBoth]) #define jprop_postDataToAirGradient_default true +#define jprop_disableCloudConnection_default false #define jprop_ledBarBrightness_default 100 #define jprop_displayBrightness_default 100 #define jprop_offlineMode_default false @@ -272,6 +274,7 @@ void Configuration::defaultConfig(void) { jconfig[jprop_configurationControl] = jprop_configurationControl_default; jconfig[jprop_pmStandard] = jprop_pmStandard_default; jconfig[jprop_temperatureUnit] = jprop_temperatureUnit_default; + jconfig[jprop_disableCloudConnection] = jprop_disableCloudConnection_default; jconfig[jprop_postDataToAirGradient] = jprop_postDataToAirGradient_default; if (ag->isOne()) { jconfig[jprop_ledBarBrightness] = jprop_ledBarBrightness_default; @@ -1167,6 +1170,18 @@ void Configuration::toConfig(const char *buf) { logInfo("toConfig: temperatureUnit changed"); } + /** validate disableCloudConnection configuration */ + if (JSON.typeof_(jconfig[jprop_disableCloudConnection]) != "boolean") { + isInvalid = true; + } else { + isInvalid = false; + } + if (isInvalid) { + jconfig[jprop_disableCloudConnection] = jprop_disableCloudConnection_default; + changed = true; + logInfo("toConfig: disableCloudConnection changed"); + } + /** validate configuration control */ if (JSON.typeof_(jprop_configurationControl) != "string") { isInvalid = true; @@ -1334,6 +1349,17 @@ void Configuration::setOfflineModeWithoutSave(bool offline) { _offlineMode = offline; } +bool Configuration::isCloudConnectionDisabled(void) { + bool disabled = jconfig[jprop_disableCloudConnection]; + return disabled; +} + +void Configuration::setDisableCloudConnection(bool disable) { + logInfo("Set DisableCloudConnection to " + String(disable ? "True" : "False")); + jconfig[jprop_disableCloudConnection] = disable; + saveConfig(); +} + bool Configuration::isLedBarModeChanged(void) { bool changed = _ledBarModeChanged; _ledBarModeChanged = false; diff --git a/src/AgConfigure.h b/src/AgConfigure.h index 1cca028..b909e4a 100644 --- a/src/AgConfigure.h +++ b/src/AgConfigure.h @@ -94,6 +94,8 @@ public: bool isOfflineMode(void); void setOfflineMode(bool offline); void setOfflineModeWithoutSave(bool offline); + bool isCloudConnectionDisabled(void); + void setDisableCloudConnection(bool disable); bool isLedBarModeChanged(void); bool isMonitorDisplayCompensatedValues(void); bool isPMCorrectionChanged(void); From 32c78f601826bb55d6581bc9384795ffe6c697ca Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Sat, 25 Jan 2025 03:01:32 +0700 Subject: [PATCH 02/13] Apply disableCloudConnection fetch configuration, post data and ota will be ignored --- examples/OneOpenAir/OneOpenAir.ino | 165 +++++++++++++++++++---------- src/AgApiClient.cpp | 25 +---- src/AgApiClient.h | 1 + src/AgWiFiConnector.cpp | 22 ++-- 4 files changed, 124 insertions(+), 89 deletions(-) diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index ee4b680..e51f933 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -96,6 +96,7 @@ static bool ledBarButtonTest = false; static String fwNewVersion; static void boardInit(void); +static void initiateNetwork(void); static void failedHandler(String msg); static void configurationUpdateSchedule(void); static void updateDisplayAndLedBar(void); @@ -208,51 +209,11 @@ void setup() { connectToWifi = true; } + // Initiate networking configuration if (connectToWifi) { - apiClient.begin(); - - if (wifiConnector.connect()) { - if (wifiConnector.isConnected()) { - mdnsInit(); - localServer.begin(); - initMqtt(); - sendDataToAg(); - - #ifdef ESP8266 - // ota not supported - #else - firmwareCheckForUpdate(); - checkForUpdateSchedule.update(); - #endif - - apiClient.fetchServerConfiguration(); - configSchedule.update(); - if (apiClient.isFetchConfigureFailed()) { - if (ag->isOne()) { - if (apiClient.isNotAvailableOnDashboard()) { - stateMachine.displaySetAddToDashBoard(); - stateMachine.displayHandle( - AgStateMachineWiFiOkServerOkSensorConfigFailed); - } else { - stateMachine.displayClearAddToDashBoard(); - } - } - stateMachine.handleLeds( - AgStateMachineWiFiOkServerOkSensorConfigFailed); - delay(DISPLAY_DELAY_SHOW_CONTENT_MS); - } else { - ledBarEnabledUpdate(); - } - } else { - if (wifiConnector.isConfigurePorttalTimeout()) { - oledDisplay.showRebooting(); - delay(2500); - oledDisplay.setText("", "", ""); - ESP.restart(); - } - } - } + initiateNetwork(); } + /** Set offline mode without saving, cause wifi is not configured */ if (wifiConnector.hasConfigurated() == false) { Serial.println("Set offline mode cause wifi is not configurated"); @@ -506,15 +467,21 @@ static bool sgp41Init(void) { static void firmwareCheckForUpdate(void) { Serial.println(); - Serial.println("firmwareCheckForUpdate:"); + Serial.print("firmwareCheckForUpdate: "); - if (wifiConnector.isConnected()) { - Serial.println("firmwareCheckForUpdate: Perform"); - otaHandler.setHandlerCallback(otaHandlerCallback); - otaHandler.updateFirmwareIfOutdated(ag->deviceId()); - } else { - Serial.println("firmwareCheckForUpdate: Ignored"); + if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled()) { + Serial.println("mode is offline or cloud connection disabled, ignored"); + return; } + + if (!wifiConnector.isConnected()) { + Serial.println("wifi not connected, ignored"); + return; + } + + Serial.println("perform"); + otaHandler.setHandlerCallback(otaHandlerCallback); + otaHandler.updateFirmwareIfOutdated(ag->deviceId()); Serial.println(); } @@ -871,7 +838,75 @@ static void failedHandler(String msg) { } } +void initiateNetwork() { + + if (!wifiConnector.connect()) { + Serial.println("Cannot initiate wifi connection"); + return; + } + + if (!wifiConnector.isConnected()) { + Serial.println("Failed connect to WiFi"); + if (wifiConnector.isConfigurePorttalTimeout()) { + oledDisplay.showRebooting(); + delay(2500); + oledDisplay.setText("", "", ""); + ESP.restart(); + } + + // Directly return because the rest of the function applied if wifi is connect only + return; + } + + // Initiate local network configuration + mdnsInit(); + localServer.begin(); + // Apply mqtt connection + initMqtt(); + + // Ignore the rest if cloud connection to AirGradient is disabled + if (configuration.isCloudConnectionDisabled()) { + return; + } + + // Send ping to aigradient server + sendDataToAg(); + +// OTA check +#ifdef ESP8266 +// ota not supported +#else + firmwareCheckForUpdate(); + checkForUpdateSchedule.update(); +#endif + + apiClient.fetchServerConfiguration(); + configSchedule.update(); + if (apiClient.isFetchConfigureFailed()) { + if (ag->isOne()) { + if (apiClient.isNotAvailableOnDashboard()) { + stateMachine.displaySetAddToDashBoard(); + stateMachine.displayHandle(AgStateMachineWiFiOkServerOkSensorConfigFailed); + } else { + stateMachine.displayClearAddToDashBoard(); + } + } + stateMachine.handleLeds(AgStateMachineWiFiOkServerOkSensorConfigFailed); + delay(DISPLAY_DELAY_SHOW_CONTENT_MS); + } else { + ledBarEnabledUpdate(); + } +} + static void configurationUpdateSchedule(void) { + if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled() || + configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { + Serial.println("Ignore fetch server configuration. Either mode is offline or cloud connection " + "disabled or configurationControl set to local"); + apiClient.resetFetchConfigureState(); + return; + } + if (apiClient.fetchServerConfiguration()) { configUpdateHandle(); } @@ -969,10 +1004,20 @@ static void updateDisplayAndLedBar(void) { return; } - AgStateMachineState state = AgStateMachineNormal; if (wifiConnector.isConnected() == false) { - state = AgStateMachineWiFiLost; - } else if (apiClient.isFetchConfigureFailed()) { + stateMachine.displayHandle(AgStateMachineWiFiLost); + stateMachine.handleLeds(AgStateMachineWiFiLost); + } + + if (configuration.isCloudConnectionDisabled()) { + // Ignore API related check since cloud is disabled + stateMachine.displayHandle(AgStateMachineNormal); + stateMachine.handleLeds(AgStateMachineNormal); + return; + } + + AgStateMachineState state = AgStateMachineNormal; + if (apiClient.isFetchConfigureFailed()) { state = AgStateMachineSensorConfigFailed; if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); @@ -1140,16 +1185,22 @@ static void sendDataToServer(void) { int bootCount = measurements.bootCount() + 1; measurements.setBootCount(bootCount); - /** Ignore send data to server if postToAirGradient disabled */ - if (configuration.isPostDataToAirGradient() == false || configuration.isOfflineMode()) { + if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled() || + !configuration.isPostDataToAirGradient()) { + Serial.println("Ignore send data to server. Either mode is offline or cloud connection is " + "disabled or post data to server disabled"); + return; + } + + if (wifiConnector.isConnected() == false) { + Serial.println("WiFi not connected, skip post data to server"); return; } String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), *ag, configuration); if (apiClient.postToServer(syncData)) { Serial.println(); - Serial.println( - "Online mode and isPostToAirGradient = true: watchdog reset"); + Serial.println("Online mode and isPostToAirGradient = true"); Serial.println(); } diff --git a/src/AgApiClient.cpp b/src/AgApiClient.cpp index 8de2596..8984d1d 100644 --- a/src/AgApiClient.cpp +++ b/src/AgApiClient.cpp @@ -34,17 +34,6 @@ void AgApiClient::begin(void) { * @return false Failure */ bool AgApiClient::fetchServerConfiguration(void) { - if (config.getConfigurationControl() == - ConfigurationControl::ConfigurationControlLocal || - config.isOfflineMode()) { - logWarning("Ignore fetch server configuration"); - - // Clear server configuration failed flag, cause it's ignore but not - // really failed - getConfigFailed = false; - return false; - } - String uri = apiRoot + "/sensors/airgradient:" + ag->deviceId() + "/one/config"; @@ -114,15 +103,6 @@ bool AgApiClient::fetchServerConfiguration(void) { * @return false Failure */ bool AgApiClient::postToServer(String data) { - if (config.isPostDataToAirGradient() == false) { - logWarning("Ignore post data to server"); - return true; - } - - if (WiFi.isConnected() == false) { - return false; - } - String uri = apiRoot + "/sensors/airgradient:" + ag->deviceId() + "/measures"; #ifdef ESP8266 HTTPClient client; @@ -175,6 +155,11 @@ bool AgApiClient::postToServer(String data) { */ bool AgApiClient::isFetchConfigureFailed(void) { return getConfigFailed; } +/** + * @brief Reset getConfigFailed state to false + */ +void AgApiClient::resetFetchConfigureState(void) { getConfigFailed = false; } + /** * @brief Get failed status when post data to AirGradient cloud * diff --git a/src/AgApiClient.h b/src/AgApiClient.h index 9f39ceb..edb30c5 100644 --- a/src/AgApiClient.h +++ b/src/AgApiClient.h @@ -41,6 +41,7 @@ public: bool fetchServerConfiguration(void); bool postToServer(String data); bool isFetchConfigureFailed(void); + void resetFetchConfigureState(void); bool isPostToServerFailed(void); bool isNotAvailableOnDashboard(void); void setAirGradient(AirGradient *ag); diff --git a/src/AgWiFiConnector.cpp b/src/AgWiFiConnector.cpp index 66fa34d..c566a07 100644 --- a/src/AgWiFiConnector.cpp +++ b/src/AgWiFiConnector.cpp @@ -81,16 +81,15 @@ bool WifiConnector::connect(void) { // ssid = "AG-" + String(ESP.getChipId(), HEX); WIFI()->setConfigPortalTimeout(WIFI_CONNECT_COUNTDOWN_MAX); - WiFiManagerParameter postToAg("chbPostToAg", - "Prevent Connection to AirGradient Server", "T", - 2, "type=\"checkbox\" ", WFM_LABEL_AFTER); - WIFI()->addParameter(&postToAg); - WiFiManagerParameter postToAgInfo( + WiFiManagerParameter disableCloud("chbPostToAg", "Prevent Connection to AirGradient Server", "T", + 2, "type=\"checkbox\" ", WFM_LABEL_AFTER); + WIFI()->addParameter(&disableCloud); + WiFiManagerParameter disableCloudInfo( "

Prevent connection to the AirGradient Server. Important: Only enable " "it if you are sure you don't want to use any AirGradient cloud " "features. As a result you will not receive automatic firmware updates " "and your data will not reach the AirGradient dashboard.

"); - WIFI()->addParameter(&postToAgInfo); + WIFI()->addParameter(&disableCloudInfo); WIFI()->autoConnect(ssid.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT); @@ -174,12 +173,11 @@ bool WifiConnector::connect(void) { logInfo("WiFi Connected: " + WiFi.SSID() + " IP: " + localIpStr()); if (hasPortalConfig) { - String result = String(postToAg.getValue()); - logInfo("Setting postToAirGradient set from " + - String(config.isPostDataToAirGradient() ? "True" : "False") + - String(" to ") + String(result != "T" ? "True" : "False") + - String(" successful")); - config.setPostToAirGradient(result != "T"); + String result = String(disableCloud.getValue()); + logInfo("Setting disableCloudConnection set from " + + String(config.isCloudConnectionDisabled() ? "True" : "False") + String(" to ") + + String(result == "T" ? "True" : "False") + String(" successful")); + config.setDisableCloudConnection(result == "T"); } hasPortalConfig = false; } From 1537d5d480aeb1a32ed22415a6fa7245ffa67cd5 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Sat, 25 Jan 2025 03:10:31 +0700 Subject: [PATCH 03/13] Update docs Notes about offlineMode and disableCloudConnection --- docs/local-server.md | 5 ++++- src/AgWiFiConnector.cpp | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/local-server.md b/docs/local-server.md index f56d7f1..07e6dd3 100644 --- a/docs/local-server.md +++ b/docs/local-server.md @@ -154,11 +154,14 @@ If the monitor is set up on the AirGradient dashboard, it will also receive the | `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}` | | `monitorDisplayCompensatedValues` | Set the display show the PM value with/without compensate value (only on [3.1.9]()) | Boolean | `false`: Without compensate (default)
`true`: with compensate | `{"monitorDisplayCompensatedValues": false }` | | `corrections` | Sets correction options to display and measurement values on local server response. (version >= [3.1.11]()) | Object | _see corrections section_ | _see corrections section_ | +**Notes** + +- `offlineMode` : device will disable all network operation, and only show measurements on display and ledbar; Read-Only; change can be apply using reset button on boot. +- `disableCloudConnection` : disable every request to airgradient server, means feature like post data to airgradient dashboard, configure from cloud and firmware update are disabled. This configuration override `configurationControl` and `postDataToAirGradient`; Read-Only; change can be apply from wifi setup webpage. #### Corrections diff --git a/src/AgWiFiConnector.cpp b/src/AgWiFiConnector.cpp index c566a07..ec10975 100644 --- a/src/AgWiFiConnector.cpp +++ b/src/AgWiFiConnector.cpp @@ -88,7 +88,7 @@ bool WifiConnector::connect(void) { "

Prevent connection to the AirGradient Server. Important: Only enable " "it if you are sure you don't want to use any AirGradient cloud " "features. As a result you will not receive automatic firmware updates " - "and your data will not reach the AirGradient dashboard.

"); + "configure from cloud and your data will not reach the AirGradient dashboard.

"); WIFI()->addParameter(&disableCloudInfo); WIFI()->autoConnect(ssid.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT); From c8f0e6a0d2688e676e06fe52b39384a0d4595ac3 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Sat, 25 Jan 2025 04:08:17 +0700 Subject: [PATCH 04/13] Update diy samples That accomodate ApiClient changes Fix apiClient begin on OneOpenAir --- examples/BASIC/BASIC.ino | 27 ++++++++++++++----- .../DiyProIndoorV3_3/DiyProIndoorV3_3.ino | 27 ++++++++++++++----- .../DiyProIndoorV4_2/DiyProIndoorV4_2.ino | 27 ++++++++++++++----- examples/OneOpenAir/OneOpenAir.ino | 7 +++-- 4 files changed, 68 insertions(+), 20 deletions(-) diff --git a/examples/BASIC/BASIC.ino b/examples/BASIC/BASIC.ino index 97105fb..eccbcc5 100644 --- a/examples/BASIC/BASIC.ino +++ b/examples/BASIC/BASIC.ino @@ -149,7 +149,10 @@ void setup() { initMqtt(); sendDataToAg(); - apiClient.fetchServerConfiguration(); + if (configuration.getConfigurationControl() != + ConfigurationControl::ConfigurationControlLocal) { + apiClient.fetchServerConfiguration(); + } configSchedule.update(); if (apiClient.isFetchConfigureFailed()) { if (apiClient.isNotAvailableOnDashboard()) { @@ -415,6 +418,14 @@ static void failedHandler(String msg) { } static void configurationUpdateSchedule(void) { + if (configuration.isOfflineMode() || + configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { + Serial.println("Ignore fetch server configuration. Either mode is offline " + "or configurationControl set to local"); + apiClient.resetFetchConfigureState(); + return; + } + if (apiClient.fetchServerConfiguration()) { configUpdateHandle(); } @@ -521,17 +532,21 @@ static void sendDataToServer(void) { int bootCount = measurements.bootCount() + 1; measurements.setBootCount(bootCount); - /** Ignore send data to server if postToAirGradient disabled */ - if (configuration.isPostDataToAirGradient() == false || - configuration.isOfflineMode()) { + if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) { + Serial.println("Ignore send data to server. Either mode is offline " + "or post data to server disabled"); + return; + } + + if (wifiConnector.isConnected() == false) { + Serial.println("WiFi not connected, skip post data to server"); return; } String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration); if (apiClient.postToServer(syncData)) { Serial.println(); - Serial.println( - "Online mode and isPostToAirGradient = true: watchdog reset"); + Serial.println("Online mode and isPostToAirGradient = true"); Serial.println(); } } diff --git a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino index bd19b86..509a8c5 100644 --- a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino +++ b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino @@ -149,7 +149,10 @@ void setup() { initMqtt(); sendDataToAg(); - apiClient.fetchServerConfiguration(); + if (configuration.getConfigurationControl() != + ConfigurationControl::ConfigurationControlLocal) { + apiClient.fetchServerConfiguration(); + } configSchedule.update(); if (apiClient.isFetchConfigureFailed()) { if (apiClient.isNotAvailableOnDashboard()) { @@ -467,6 +470,14 @@ static void failedHandler(String msg) { } static void configurationUpdateSchedule(void) { + if (configuration.isOfflineMode() || + configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { + Serial.println("Ignore fetch server configuration. Either mode is offline " + "or configurationControl set to local"); + apiClient.resetFetchConfigureState(); + return; + } + if (apiClient.fetchServerConfiguration()) { configUpdateHandle(); } @@ -573,17 +584,21 @@ static void sendDataToServer(void) { int bootCount = measurements.bootCount() + 1; measurements.setBootCount(bootCount); - /** Ignore send data to server if postToAirGradient disabled */ - if (configuration.isPostDataToAirGradient() == false || - configuration.isOfflineMode()) { + if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) { + Serial.println("Ignore send data to server. Either mode is offline " + "or post data to server disabled"); + return; + } + + if (wifiConnector.isConnected() == false) { + Serial.println("WiFi not connected, skip post data to server"); return; } String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration); if (apiClient.postToServer(syncData)) { Serial.println(); - Serial.println( - "Online mode and isPostToAirGradient = true: watchdog reset"); + Serial.println("Online mode and isPostToAirGradient = true"); Serial.println(); } } diff --git a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino index f29c2cf..08f0551 100644 --- a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino +++ b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino @@ -176,7 +176,10 @@ void setup() { initMqtt(); sendDataToAg(); - apiClient.fetchServerConfiguration(); + if (configuration.getConfigurationControl() != + ConfigurationControl::ConfigurationControlLocal) { + apiClient.fetchServerConfiguration(); + } configSchedule.update(); if (apiClient.isFetchConfigureFailed()) { if (apiClient.isNotAvailableOnDashboard()) { @@ -507,6 +510,14 @@ static void failedHandler(String msg) { } static void configurationUpdateSchedule(void) { + if (configuration.isOfflineMode() || + configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { + Serial.println("Ignore fetch server configuration. Either mode is offline " + "or configurationControl set to local"); + apiClient.resetFetchConfigureState(); + return; + } + if (apiClient.fetchServerConfiguration()) { configUpdateHandle(); } @@ -614,17 +625,21 @@ static void sendDataToServer(void) { int bootCount = measurements.bootCount() + 1; measurements.setBootCount(bootCount); - /** Ignore send data to server if postToAirGradient disabled */ - if (configuration.isPostDataToAirGradient() == false || - configuration.isOfflineMode()) { + if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) { + Serial.println("Ignore send data to server. Either mode is offline " + "or post data to server disabled"); + return; + } + + if (wifiConnector.isConnected() == false) { + Serial.println("WiFi not connected, skip post data to server"); return; } String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration); if (apiClient.postToServer(syncData)) { Serial.println(); - Serial.println( - "Online mode and isPostToAirGradient = true: watchdog reset"); + Serial.println("Online mode and isPostToAirGradient = true"); Serial.println(); } } diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index e51f933..82d941f 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -861,7 +861,7 @@ void initiateNetwork() { // Initiate local network configuration mdnsInit(); localServer.begin(); - // Apply mqtt connection + // Apply mqtt connection if configured initMqtt(); // Ignore the rest if cloud connection to AirGradient is disabled @@ -869,7 +869,10 @@ void initiateNetwork() { return; } - // Send ping to aigradient server + // Initialize api client + apiClient.begin(); + + // Send ping to airgradient server sendDataToAg(); // OTA check From f0c4df42b70b06ae08efc89d20df80adc8db9599 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Sun, 26 Jan 2025 13:02:42 +0700 Subject: [PATCH 05/13] Fix wording on local-server --- docs/local-server.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/local-server.md b/docs/local-server.md index 07e6dd3..5e5f233 100644 --- a/docs/local-server.md +++ b/docs/local-server.md @@ -160,8 +160,8 @@ If the monitor is set up on the AirGradient dashboard, it will also receive the **Notes** -- `offlineMode` : device will disable all network operation, and only show measurements on display and ledbar; Read-Only; change can be apply using reset button on boot. -- `disableCloudConnection` : disable every request to airgradient server, means feature like post data to airgradient dashboard, configure from cloud and firmware update are disabled. This configuration override `configurationControl` and `postDataToAirGradient`; Read-Only; change can be apply from wifi setup webpage. +- `offlineMode` : device will disable all network operation, and only show measurements on display and ledbar; Read-Only; Change can be apply using reset button on boot. +- `disableCloudConnection` : disable every request to AirGradient server, means features like post data to AirGradient server, configuration from AirGradient server and automatic firmware updates are disabled. This configuration overrides `configurationControl` and `postDataToAirGradient`; Read-Only; Change can be apply from wifi setup webpage. #### Corrections From 3e48a562e7ac33f7518612a1e63d50fe0565bc37 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Sun, 26 Jan 2025 22:50:17 +0700 Subject: [PATCH 06/13] Change comment of sendDataToAg function call --- examples/OneOpenAir/OneOpenAir.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index 82d941f..18e9887 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -872,7 +872,7 @@ void initiateNetwork() { // Initialize api client apiClient.begin(); - // Send ping to airgradient server + // Check and process if AirGradient server is reachable sendDataToAg(); // OTA check From 0e41b2d630dc5367b1fc96db0e54ee42ac232941 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Thu, 30 Jan 2025 10:01:15 +0700 Subject: [PATCH 07/13] Rename function from initiateNetwork to initializeNetwork --- examples/OneOpenAir/OneOpenAir.ino | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index 18e9887..df247bf 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -96,7 +96,7 @@ static bool ledBarButtonTest = false; static String fwNewVersion; static void boardInit(void); -static void initiateNetwork(void); +static void initializeNetwork(void); static void failedHandler(String msg); static void configurationUpdateSchedule(void); static void updateDisplayAndLedBar(void); @@ -209,9 +209,9 @@ void setup() { connectToWifi = true; } - // Initiate networking configuration + // Initialize networking configuration if (connectToWifi) { - initiateNetwork(); + initializeNetwork(); } /** Set offline mode without saving, cause wifi is not configured */ @@ -838,8 +838,7 @@ static void failedHandler(String msg) { } } -void initiateNetwork() { - +void initializeNetwork() { if (!wifiConnector.connect()) { Serial.println("Cannot initiate wifi connection"); return; From 84a358291b29eda16b268a14f12b549f97b708a4 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Thu, 30 Jan 2025 14:23:39 +0700 Subject: [PATCH 08/13] Rename function from configure to configuration --- examples/BASIC/BASIC.ino | 6 +++--- examples/BASIC/OpenMetrics.cpp | 2 +- examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino | 6 +++--- examples/DiyProIndoorV3_3/OpenMetrics.cpp | 2 +- examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino | 6 +++--- examples/DiyProIndoorV4_2/OpenMetrics.cpp | 2 +- examples/OneOpenAir/OneOpenAir.ino | 6 +++--- examples/OneOpenAir/OpenMetrics.cpp | 2 +- src/AgApiClient.cpp | 6 +++--- src/AgApiClient.h | 4 ++-- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/examples/BASIC/BASIC.ino b/examples/BASIC/BASIC.ino index eccbcc5..cf65775 100644 --- a/examples/BASIC/BASIC.ino +++ b/examples/BASIC/BASIC.ino @@ -154,7 +154,7 @@ void setup() { apiClient.fetchServerConfiguration(); } configSchedule.update(); - if (apiClient.isFetchConfigureFailed()) { + if (apiClient.isFetchConfigurationFailed()) { if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); stateMachine.displayHandle( @@ -422,7 +422,7 @@ static void configurationUpdateSchedule(void) { configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { Serial.println("Ignore fetch server configuration. Either mode is offline " "or configurationControl set to local"); - apiClient.resetFetchConfigureState(); + apiClient.resetFetchConfigurationStatus(); return; } @@ -483,7 +483,7 @@ static void appDispHandler(void) { if (configuration.isOfflineMode() == false) { if (wifiConnector.isConnected() == false) { state = AgStateMachineWiFiLost; - } else if (apiClient.isFetchConfigureFailed()) { + } else if (apiClient.isFetchConfigurationFailed()) { state = AgStateMachineSensorConfigFailed; if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); diff --git a/examples/BASIC/OpenMetrics.cpp b/examples/BASIC/OpenMetrics.cpp index c8395c0..9b92fbe 100644 --- a/examples/BASIC/OpenMetrics.cpp +++ b/examples/BASIC/OpenMetrics.cpp @@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) { "1 if the AirGradient device was able to successfully fetch its " "configuration from the server", "gauge"); - add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); + add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1"); add_metric( "post_ok", diff --git a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino index 509a8c5..171d69d 100644 --- a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino +++ b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino @@ -154,7 +154,7 @@ void setup() { apiClient.fetchServerConfiguration(); } configSchedule.update(); - if (apiClient.isFetchConfigureFailed()) { + if (apiClient.isFetchConfigurationFailed()) { if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); stateMachine.displayHandle( @@ -474,7 +474,7 @@ static void configurationUpdateSchedule(void) { configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { Serial.println("Ignore fetch server configuration. Either mode is offline " "or configurationControl set to local"); - apiClient.resetFetchConfigureState(); + apiClient.resetFetchConfigurationStatus(); return; } @@ -535,7 +535,7 @@ static void appDispHandler(void) { if (configuration.isOfflineMode() == false) { if (wifiConnector.isConnected() == false) { state = AgStateMachineWiFiLost; - } else if (apiClient.isFetchConfigureFailed()) { + } else if (apiClient.isFetchConfigurationFailed()) { state = AgStateMachineSensorConfigFailed; if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); diff --git a/examples/DiyProIndoorV3_3/OpenMetrics.cpp b/examples/DiyProIndoorV3_3/OpenMetrics.cpp index 8ec9d2f..dadb8b1 100644 --- a/examples/DiyProIndoorV3_3/OpenMetrics.cpp +++ b/examples/DiyProIndoorV3_3/OpenMetrics.cpp @@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) { "1 if the AirGradient device was able to successfully fetch its " "configuration from the server", "gauge"); - add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); + add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1"); add_metric( "post_ok", diff --git a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino index 08f0551..f837481 100644 --- a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino +++ b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino @@ -181,7 +181,7 @@ void setup() { apiClient.fetchServerConfiguration(); } configSchedule.update(); - if (apiClient.isFetchConfigureFailed()) { + if (apiClient.isFetchConfigurationFailed()) { if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); stateMachine.displayHandle( @@ -514,7 +514,7 @@ static void configurationUpdateSchedule(void) { configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { Serial.println("Ignore fetch server configuration. Either mode is offline " "or configurationControl set to local"); - apiClient.resetFetchConfigureState(); + apiClient.resetFetchConfigurationStatus(); return; } @@ -575,7 +575,7 @@ static void appDispHandler(void) { if (configuration.isOfflineMode() == false) { if (wifiConnector.isConnected() == false) { state = AgStateMachineWiFiLost; - } else if (apiClient.isFetchConfigureFailed()) { + } else if (apiClient.isFetchConfigurationFailed()) { state = AgStateMachineSensorConfigFailed; if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); diff --git a/examples/DiyProIndoorV4_2/OpenMetrics.cpp b/examples/DiyProIndoorV4_2/OpenMetrics.cpp index c8395c0..9b92fbe 100644 --- a/examples/DiyProIndoorV4_2/OpenMetrics.cpp +++ b/examples/DiyProIndoorV4_2/OpenMetrics.cpp @@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) { "1 if the AirGradient device was able to successfully fetch its " "configuration from the server", "gauge"); - add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); + add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1"); add_metric( "post_ok", diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index df247bf..9dff24e 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -884,7 +884,7 @@ void initializeNetwork() { apiClient.fetchServerConfiguration(); configSchedule.update(); - if (apiClient.isFetchConfigureFailed()) { + if (apiClient.isFetchConfigurationFailed()) { if (ag->isOne()) { if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); @@ -905,7 +905,7 @@ static void configurationUpdateSchedule(void) { configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) { Serial.println("Ignore fetch server configuration. Either mode is offline or cloud connection " "disabled or configurationControl set to local"); - apiClient.resetFetchConfigureState(); + apiClient.resetFetchConfigurationStatus(); return; } @@ -1019,7 +1019,7 @@ static void updateDisplayAndLedBar(void) { } AgStateMachineState state = AgStateMachineNormal; - if (apiClient.isFetchConfigureFailed()) { + if (apiClient.isFetchConfigurationFailed()) { state = AgStateMachineSensorConfigFailed; if (apiClient.isNotAvailableOnDashboard()) { stateMachine.displaySetAddToDashBoard(); diff --git a/examples/OneOpenAir/OpenMetrics.cpp b/examples/OneOpenAir/OpenMetrics.cpp index fa59444..e366ea4 100644 --- a/examples/OneOpenAir/OpenMetrics.cpp +++ b/examples/OneOpenAir/OpenMetrics.cpp @@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) { "1 if the AirGradient device was able to successfully fetch its " "configuration from the server", "gauge"); - add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); + add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1"); add_metric( "post_ok", diff --git a/src/AgApiClient.cpp b/src/AgApiClient.cpp index 8984d1d..5869566 100644 --- a/src/AgApiClient.cpp +++ b/src/AgApiClient.cpp @@ -153,12 +153,12 @@ bool AgApiClient::postToServer(String data) { * @return true Success * @return false Failure */ -bool AgApiClient::isFetchConfigureFailed(void) { return getConfigFailed; } +bool AgApiClient::isFetchConfigurationFailed(void) { return getConfigFailed; } /** - * @brief Reset getConfigFailed state to false + * @brief Reset status of get configuration from AirGradient cloud */ -void AgApiClient::resetFetchConfigureState(void) { getConfigFailed = false; } +void AgApiClient::resetFetchConfigurationStatus(void) { getConfigFailed = false; } /** * @brief Get failed status when post data to AirGradient cloud diff --git a/src/AgApiClient.h b/src/AgApiClient.h index edb30c5..7ee8734 100644 --- a/src/AgApiClient.h +++ b/src/AgApiClient.h @@ -40,8 +40,8 @@ public: void begin(void); bool fetchServerConfiguration(void); bool postToServer(String data); - bool isFetchConfigureFailed(void); - void resetFetchConfigureState(void); + bool isFetchConfigurationFailed(void); + void resetFetchConfigurationStatus(void); bool isPostToServerFailed(void); bool isNotAvailableOnDashboard(void); void setAirGradient(AirGradient *ag); From b75e40b8000f51792986f23142b02df4330906f8 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Thu, 30 Jan 2025 15:09:27 +0700 Subject: [PATCH 09/13] Rename variable for readability --- src/AgConfigure.cpp | 98 ++++++++++++++++++++++----------------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/src/AgConfigure.cpp b/src/AgConfigure.cpp index 25d0f5d..9267141 100644 --- a/src/AgConfigure.cpp +++ b/src/AgConfigure.cpp @@ -1039,20 +1039,20 @@ void Configuration::toConfig(const char *buf) { } bool changed = false; - bool isInvalid = false; + bool isConfigFieldInvalid = false; /** Validate country */ if (JSON.typeof_(jconfig[jprop_country]) != "string") { - isInvalid = true; + isConfigFieldInvalid = true; } else { String country = jconfig[jprop_country]; if (country.length() != 2) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_country] = jprop_country_default; changed = true; logInfo("toConfig: country changed"); @@ -1060,17 +1060,17 @@ void Configuration::toConfig(const char *buf) { /** validate: PM standard */ if (JSON.typeof_(jconfig[jprop_pmStandard]) != "string") { - isInvalid = true; + isConfigFieldInvalid = true; } else { String standard = jconfig[jprop_pmStandard]; if (standard != getPMStandardString(true) && standard != getPMStandardString(false)) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_pmStandard] = jprop_pmStandard_default; changed = true; logInfo("toConfig: pmStandard changed"); @@ -1078,18 +1078,18 @@ void Configuration::toConfig(const char *buf) { /** validate led bar mode */ if (JSON.typeof_(jconfig[jprop_ledBarMode]) != "string") { - isInvalid = true; + isConfigFieldInvalid = true; } else { String mode = jconfig[jprop_ledBarMode]; if (mode != getLedBarModeName(LedBarMode::LedBarModeCO2) && mode != getLedBarModeName(LedBarMode::LedBarModeOff) && mode != getLedBarModeName(LedBarMode::LedBarModePm)) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_ledBarMode] = jprop_ledBarMode_default; changed = true; logInfo("toConfig: ledBarMode changed"); @@ -1097,11 +1097,11 @@ void Configuration::toConfig(const char *buf) { /** validate abcday */ if (JSON.typeof_(jconfig[jprop_abcDays]) != "number") { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_abcDays] = jprop_abcDays_default; changed = true; logInfo("toConfig: abcDays changed"); @@ -1109,16 +1109,16 @@ void Configuration::toConfig(const char *buf) { /** validate tvoc learning offset */ if (JSON.typeof_(jconfig[jprop_tvocLearningOffset]) != "number") { - isInvalid = true; + isConfigFieldInvalid = true; } else { int value = jconfig[jprop_tvocLearningOffset]; if (value < 0) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_tvocLearningOffset] = jprop_tvocLearningOffset_default; changed = true; logInfo("toConfig: tvocLearningOffset changed"); @@ -1126,16 +1126,16 @@ void Configuration::toConfig(const char *buf) { /** validate nox learning offset */ if (JSON.typeof_(jconfig[jprop_noxLearningOffset]) != "number") { - isInvalid = true; + isConfigFieldInvalid = true; } else { int value = jconfig[jprop_noxLearningOffset]; if (value < 0) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_noxLearningOffset] = jprop_noxLearningOffset_default; changed = true; logInfo("toConfig: noxLearningOffset changed"); @@ -1143,11 +1143,11 @@ void Configuration::toConfig(const char *buf) { /** validate mqtt broker */ if (JSON.typeof_(jconfig[jprop_mqttBrokerUrl]) != "string") { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } - if (isInvalid) { + if (isConfigFieldInvalid) { changed = true; jconfig[jprop_mqttBrokerUrl] = jprop_mqttBrokerUrl_default; logInfo("toConfig: mqttBroker changed"); @@ -1155,16 +1155,16 @@ void Configuration::toConfig(const char *buf) { /** Validate temperature unit */ if (JSON.typeof_(jconfig[jprop_temperatureUnit]) != "string") { - isInvalid = true; + isConfigFieldInvalid = true; } else { String unit = jconfig[jprop_temperatureUnit]; if (unit != "c" && unit != "f") { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_temperatureUnit] = jprop_temperatureUnit_default; changed = true; logInfo("toConfig: temperatureUnit changed"); @@ -1172,11 +1172,11 @@ void Configuration::toConfig(const char *buf) { /** validate disableCloudConnection configuration */ if (JSON.typeof_(jconfig[jprop_disableCloudConnection]) != "boolean") { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_disableCloudConnection] = jprop_disableCloudConnection_default; changed = true; logInfo("toConfig: disableCloudConnection changed"); @@ -1184,7 +1184,7 @@ void Configuration::toConfig(const char *buf) { /** validate configuration control */ if (JSON.typeof_(jprop_configurationControl) != "string") { - isInvalid = true; + isConfigFieldInvalid = true; } else { String ctrl = jconfig[jprop_configurationControl]; if (ctrl != String(CONFIGURATION_CONTROL_NAME @@ -1193,12 +1193,12 @@ void Configuration::toConfig(const char *buf) { [ConfigurationControl::ConfigurationControlLocal]) && ctrl != String(CONFIGURATION_CONTROL_NAME [ConfigurationControl::ConfigurationControlCloud])) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_configurationControl] =jprop_configurationControl_default; changed = true; logInfo("toConfig: configurationControl changed"); @@ -1206,11 +1206,11 @@ void Configuration::toConfig(const char *buf) { /** Validate post to airgradient cloud */ if (JSON.typeof_(jconfig[jprop_postDataToAirGradient]) != "boolean") { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_postDataToAirGradient] = jprop_postDataToAirGradient_default; changed = true; logInfo("toConfig: postToAirGradient changed"); @@ -1218,16 +1218,16 @@ void Configuration::toConfig(const char *buf) { /** validate led bar brightness */ if (JSON.typeof_(jconfig[jprop_ledBarBrightness]) != "number") { - isInvalid = true; + isConfigFieldInvalid = true; } else { int value = jconfig[jprop_ledBarBrightness]; if (value < 0 || value > 100) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_ledBarBrightness] = jprop_ledBarBrightness_default; changed = true; logInfo("toConfig: ledBarBrightness changed"); @@ -1235,16 +1235,16 @@ void Configuration::toConfig(const char *buf) { /** Validate display brightness */ if (JSON.typeof_(jconfig[jprop_displayBrightness]) != "number") { - isInvalid = true; + isConfigFieldInvalid = true; } else { int value = jconfig[jprop_displayBrightness]; if (value < 0 || value > 100) { - isInvalid = true; + isConfigFieldInvalid = true; } else { - isInvalid = false; + isConfigFieldInvalid = false; } } - if (isInvalid) { + if (isConfigFieldInvalid) { jconfig[jprop_displayBrightness] = jprop_displayBrightness_default; changed = true; logInfo("toConfig: displayBrightness changed"); From afd498074baa1d1b94673f4ff85e457a8a577e04 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Wed, 5 Feb 2025 10:43:56 +0700 Subject: [PATCH 10/13] Fix grammar error --- docs/local-server.md | 2 +- examples/BASIC/BASIC.ino | 2 +- examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino | 2 +- examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino | 2 +- examples/OneOpenAir/OneOpenAir.ino | 2 +- src/AgWiFiConnector.cpp | 4 ++-- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/local-server.md b/docs/local-server.md index 5e5f233..b79020b 100644 --- a/docs/local-server.md +++ b/docs/local-server.md @@ -160,7 +160,7 @@ If the monitor is set up on the AirGradient dashboard, it will also receive the **Notes** -- `offlineMode` : device will disable all network operation, and only show measurements on display and ledbar; Read-Only; Change can be apply using reset button on boot. +- `offlineMode` : the device will disable all network operation, and only show measurements on the display and ledbar; Read-Only; Change can be apply using reset button on boot. - `disableCloudConnection` : disable every request to AirGradient server, means features like post data to AirGradient server, configuration from AirGradient server and automatic firmware updates are disabled. This configuration overrides `configurationControl` and `postDataToAirGradient`; Read-Only; Change can be apply from wifi setup webpage. #### Corrections diff --git a/examples/BASIC/BASIC.ino b/examples/BASIC/BASIC.ino index cf65775..94a7fe0 100644 --- a/examples/BASIC/BASIC.ino +++ b/examples/BASIC/BASIC.ino @@ -539,7 +539,7 @@ static void sendDataToServer(void) { } if (wifiConnector.isConnected() == false) { - Serial.println("WiFi not connected, skip post data to server"); + Serial.println("WiFi not connected, skipping data transmission to AG server"); return; } diff --git a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino index 171d69d..4969af8 100644 --- a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino +++ b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino @@ -591,7 +591,7 @@ static void sendDataToServer(void) { } if (wifiConnector.isConnected() == false) { - Serial.println("WiFi not connected, skip post data to server"); + Serial.println("WiFi not connected, skipping data transmission to AG server"); return; } diff --git a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino index f837481..e3db76e 100644 --- a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino +++ b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino @@ -632,7 +632,7 @@ static void sendDataToServer(void) { } if (wifiConnector.isConnected() == false) { - Serial.println("WiFi not connected, skip post data to server"); + Serial.println("WiFi not connected, skipping data transmission to AG server"); return; } diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index f797ed6..976c6ac 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -1194,7 +1194,7 @@ static void sendDataToServer(void) { } if (wifiConnector.isConnected() == false) { - Serial.println("WiFi not connected, skip post data to server"); + Serial.println("WiFi not connected, skipping data transmission to AG server"); return; } diff --git a/src/AgWiFiConnector.cpp b/src/AgWiFiConnector.cpp index ec10975..a8e2c7f 100644 --- a/src/AgWiFiConnector.cpp +++ b/src/AgWiFiConnector.cpp @@ -87,8 +87,8 @@ bool WifiConnector::connect(void) { WiFiManagerParameter disableCloudInfo( "

Prevent connection to the AirGradient Server. Important: Only enable " "it if you are sure you don't want to use any AirGradient cloud " - "features. As a result you will not receive automatic firmware updates " - "configure from cloud and your data will not reach the AirGradient dashboard.

"); + "features. As a result you will not receive automatic firmware updates, " + "configuration settings from cloud and the measure data will not reach the AirGradient dashboard.

"); WIFI()->addParameter(&disableCloudInfo); WIFI()->autoConnect(ssid.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT); From 29d701780a5389e3af53893db5905c687f37fd11 Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Wed, 5 Feb 2025 11:37:16 +0700 Subject: [PATCH 11/13] Improve logging --- examples/BASIC/BASIC.ino | 2 +- examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino | 2 +- examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino | 2 +- examples/OneOpenAir/OneOpenAir.ino | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/BASIC/BASIC.ino b/examples/BASIC/BASIC.ino index 94a7fe0..6b4e476 100644 --- a/examples/BASIC/BASIC.ino +++ b/examples/BASIC/BASIC.ino @@ -533,7 +533,7 @@ static void sendDataToServer(void) { measurements.setBootCount(bootCount); if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) { - Serial.println("Ignore send data to server. Either mode is offline " + Serial.println("Skipping transmission of data to AG server. Either mode is offline " "or post data to server disabled"); return; } diff --git a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino index 4969af8..53b0ac8 100644 --- a/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino +++ b/examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino @@ -585,7 +585,7 @@ static void sendDataToServer(void) { measurements.setBootCount(bootCount); if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) { - Serial.println("Ignore send data to server. Either mode is offline " + Serial.println("Skipping transmission of data to AG server. Either mode is offline " "or post data to server disabled"); return; } diff --git a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino index e3db76e..bd485aa 100644 --- a/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino +++ b/examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino @@ -626,7 +626,7 @@ static void sendDataToServer(void) { measurements.setBootCount(bootCount); if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) { - Serial.println("Ignore send data to server. Either mode is offline " + Serial.println("Skipping transmission of data to AG server. Either mode is offline " "or post data to server disabled"); return; } diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index 976c6ac..d3c66f4 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -464,9 +464,9 @@ static bool sgp41Init(void) { return false; } -static void firmwareCheckForUpdate(void) { +static void checkForFirmwareUpdate(void) { Serial.println(); - Serial.print("firmwareCheckForUpdate: "); + Serial.print("checkForFirmwareUpdate: "); if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled()) { Serial.println("mode is offline or cloud connection disabled, ignored"); @@ -870,7 +870,7 @@ void initializeNetwork() { // Initialize api client apiClient.begin(); - // Check and process if AirGradient server is reachable + // Send data for the first time to airgradient at boot sendDataToAg(); // OTA check @@ -1188,7 +1188,7 @@ static void sendDataToServer(void) { if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled() || !configuration.isPostDataToAirGradient()) { - Serial.println("Ignore send data to server. Either mode is offline or cloud connection is " + Serial.println("Skipping transmission of data to AG server. Either mode is offline or cloud connection is " "disabled or post data to server disabled"); return; } From bd9dbec663e231ca0aa0c86a0ca8f17cfc6bd2de Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Wed, 5 Feb 2025 13:46:10 +0700 Subject: [PATCH 12/13] Rename functions --- examples/OneOpenAir/OneOpenAir.ino | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index d3c66f4..4714765 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -112,7 +112,7 @@ static void factoryConfigReset(void); static void wdgFeedUpdate(void); static void ledBarEnabledUpdate(void); static bool sgp41Init(void); -static void firmwareCheckForUpdate(void); +static void checkForFirmwareUpdate(void); static void otaHandlerCallback(OtaHandler::OtaState state, String mesasge); static void displayExecuteOta(OtaHandler::OtaState state, String msg, int processing); static int calculateMaxPeriod(int updateInterval); @@ -127,7 +127,7 @@ AgSchedule pmsSchedule(SENSOR_PM_UPDATE_INTERVAL, updatePm); AgSchedule tempHumSchedule(SENSOR_TEMP_HUM_UPDATE_INTERVAL, tempHumUpdate); AgSchedule tvocSchedule(SENSOR_TVOC_UPDATE_INTERVAL, updateTvoc); AgSchedule watchdogFeedSchedule(60000, wdgFeedUpdate); -AgSchedule checkForUpdateSchedule(FIRMWARE_CHECK_FOR_UPDATE_MS, firmwareCheckForUpdate); +AgSchedule checkForUpdateSchedule(FIRMWARE_CHECK_FOR_UPDATE_MS, checkForFirmwareUpdate); void setup() { /** Serial for print debug message */ @@ -877,7 +877,7 @@ void initializeNetwork() { #ifdef ESP8266 // ota not supported #else - firmwareCheckForUpdate(); + checkForFirmwareUpdate(); checkForUpdateSchedule.update(); #endif From 0e26aa1b5d04a0d2e9962a1f3a0dc6df0f33243d Mon Sep 17 00:00:00 2001 From: samuelbles07 Date: Wed, 5 Feb 2025 14:06:33 +0700 Subject: [PATCH 13/13] Improve comments --- examples/OneOpenAir/OneOpenAir.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/OneOpenAir/OneOpenAir.ino b/examples/OneOpenAir/OneOpenAir.ino index 4714765..ca411b1 100644 --- a/examples/OneOpenAir/OneOpenAir.ino +++ b/examples/OneOpenAir/OneOpenAir.ino @@ -870,7 +870,7 @@ void initializeNetwork() { // Initialize api client apiClient.begin(); - // Send data for the first time to airgradient at boot + // Send data for the first time to AG server at boot sendDataToAg(); // OTA check