Merge pull request #278 from airgradienthq/feat/disable-cloud

Fully disable cloud connection to airgradient server option
This commit is contained in:
Samuel Siburian
2025-02-06 10:13:50 +07:00
committed by GitHub
14 changed files with 284 additions and 171 deletions

View File

@@ -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}` | | `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}` | | `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}` | | `tvocLearningOffset` | Set VOC learning gain offset. | Number | 0-720 (default 12) | `{"tvocLearningOffset": 12}` |
| `offlineMode` | Set monitor to run without WiFi. | Boolean | `false`: Disabled (default) <br> `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) <br> `true`: with compensate | `{"monitorDisplayCompensatedValues": false }` | | `monitorDisplayCompensatedValues` | Set the display show the PM value with/without compensate value (only on [3.1.9]()) | Boolean | `false`: Without compensate (default) <br> `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_ | | `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` : 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 #### Corrections

View File

@@ -149,9 +149,12 @@ void setup() {
initMqtt(); initMqtt();
sendDataToAg(); sendDataToAg();
apiClient.fetchServerConfiguration(); if (configuration.getConfigurationControl() !=
ConfigurationControl::ConfigurationControlLocal) {
apiClient.fetchServerConfiguration();
}
configSchedule.update(); configSchedule.update();
if (apiClient.isFetchConfigureFailed()) { if (apiClient.isFetchConfigurationFailed()) {
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
stateMachine.displayHandle( stateMachine.displayHandle(
@@ -415,6 +418,14 @@ static void failedHandler(String msg) {
} }
static void configurationUpdateSchedule(void) { 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.resetFetchConfigurationStatus();
return;
}
if (apiClient.fetchServerConfiguration()) { if (apiClient.fetchServerConfiguration()) {
configUpdateHandle(); configUpdateHandle();
} }
@@ -472,7 +483,7 @@ static void appDispHandler(void) {
if (configuration.isOfflineMode() == false) { if (configuration.isOfflineMode() == false) {
if (wifiConnector.isConnected() == false) { if (wifiConnector.isConnected() == false) {
state = AgStateMachineWiFiLost; state = AgStateMachineWiFiLost;
} else if (apiClient.isFetchConfigureFailed()) { } else if (apiClient.isFetchConfigurationFailed()) {
state = AgStateMachineSensorConfigFailed; state = AgStateMachineSensorConfigFailed;
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
@@ -521,17 +532,21 @@ static void sendDataToServer(void) {
int bootCount = measurements.bootCount() + 1; int bootCount = measurements.bootCount() + 1;
measurements.setBootCount(bootCount); measurements.setBootCount(bootCount);
/** Ignore send data to server if postToAirGradient disabled */ if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) {
if (configuration.isPostDataToAirGradient() == false || Serial.println("Skipping transmission of data to AG server. Either mode is offline "
configuration.isOfflineMode()) { "or post data to server disabled");
return;
}
if (wifiConnector.isConnected() == false) {
Serial.println("WiFi not connected, skipping data transmission to AG server");
return; return;
} }
String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration); String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration);
if (apiClient.postToServer(syncData)) { if (apiClient.postToServer(syncData)) {
Serial.println(); Serial.println();
Serial.println( Serial.println("Online mode and isPostToAirGradient = true");
"Online mode and isPostToAirGradient = true: watchdog reset");
Serial.println(); Serial.println();
} }
} }

View File

@@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) {
"1 if the AirGradient device was able to successfully fetch its " "1 if the AirGradient device was able to successfully fetch its "
"configuration from the server", "configuration from the server",
"gauge"); "gauge");
add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1");
add_metric( add_metric(
"post_ok", "post_ok",

View File

@@ -149,9 +149,12 @@ void setup() {
initMqtt(); initMqtt();
sendDataToAg(); sendDataToAg();
apiClient.fetchServerConfiguration(); if (configuration.getConfigurationControl() !=
ConfigurationControl::ConfigurationControlLocal) {
apiClient.fetchServerConfiguration();
}
configSchedule.update(); configSchedule.update();
if (apiClient.isFetchConfigureFailed()) { if (apiClient.isFetchConfigurationFailed()) {
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
stateMachine.displayHandle( stateMachine.displayHandle(
@@ -467,6 +470,14 @@ static void failedHandler(String msg) {
} }
static void configurationUpdateSchedule(void) { 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.resetFetchConfigurationStatus();
return;
}
if (apiClient.fetchServerConfiguration()) { if (apiClient.fetchServerConfiguration()) {
configUpdateHandle(); configUpdateHandle();
} }
@@ -524,7 +535,7 @@ static void appDispHandler(void) {
if (configuration.isOfflineMode() == false) { if (configuration.isOfflineMode() == false) {
if (wifiConnector.isConnected() == false) { if (wifiConnector.isConnected() == false) {
state = AgStateMachineWiFiLost; state = AgStateMachineWiFiLost;
} else if (apiClient.isFetchConfigureFailed()) { } else if (apiClient.isFetchConfigurationFailed()) {
state = AgStateMachineSensorConfigFailed; state = AgStateMachineSensorConfigFailed;
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
@@ -573,17 +584,21 @@ static void sendDataToServer(void) {
int bootCount = measurements.bootCount() + 1; int bootCount = measurements.bootCount() + 1;
measurements.setBootCount(bootCount); measurements.setBootCount(bootCount);
/** Ignore send data to server if postToAirGradient disabled */ if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) {
if (configuration.isPostDataToAirGradient() == false || Serial.println("Skipping transmission of data to AG server. Either mode is offline "
configuration.isOfflineMode()) { "or post data to server disabled");
return;
}
if (wifiConnector.isConnected() == false) {
Serial.println("WiFi not connected, skipping data transmission to AG server");
return; return;
} }
String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration); String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration);
if (apiClient.postToServer(syncData)) { if (apiClient.postToServer(syncData)) {
Serial.println(); Serial.println();
Serial.println( Serial.println("Online mode and isPostToAirGradient = true");
"Online mode and isPostToAirGradient = true: watchdog reset");
Serial.println(); Serial.println();
} }
} }

View File

@@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) {
"1 if the AirGradient device was able to successfully fetch its " "1 if the AirGradient device was able to successfully fetch its "
"configuration from the server", "configuration from the server",
"gauge"); "gauge");
add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1");
add_metric( add_metric(
"post_ok", "post_ok",

View File

@@ -176,9 +176,12 @@ void setup() {
initMqtt(); initMqtt();
sendDataToAg(); sendDataToAg();
apiClient.fetchServerConfiguration(); if (configuration.getConfigurationControl() !=
ConfigurationControl::ConfigurationControlLocal) {
apiClient.fetchServerConfiguration();
}
configSchedule.update(); configSchedule.update();
if (apiClient.isFetchConfigureFailed()) { if (apiClient.isFetchConfigurationFailed()) {
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
stateMachine.displayHandle( stateMachine.displayHandle(
@@ -507,6 +510,14 @@ static void failedHandler(String msg) {
} }
static void configurationUpdateSchedule(void) { 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.resetFetchConfigurationStatus();
return;
}
if (apiClient.fetchServerConfiguration()) { if (apiClient.fetchServerConfiguration()) {
configUpdateHandle(); configUpdateHandle();
} }
@@ -564,7 +575,7 @@ static void appDispHandler(void) {
if (configuration.isOfflineMode() == false) { if (configuration.isOfflineMode() == false) {
if (wifiConnector.isConnected() == false) { if (wifiConnector.isConnected() == false) {
state = AgStateMachineWiFiLost; state = AgStateMachineWiFiLost;
} else if (apiClient.isFetchConfigureFailed()) { } else if (apiClient.isFetchConfigurationFailed()) {
state = AgStateMachineSensorConfigFailed; state = AgStateMachineSensorConfigFailed;
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
@@ -614,17 +625,21 @@ static void sendDataToServer(void) {
int bootCount = measurements.bootCount() + 1; int bootCount = measurements.bootCount() + 1;
measurements.setBootCount(bootCount); measurements.setBootCount(bootCount);
/** Ignore send data to server if postToAirGradient disabled */ if (configuration.isOfflineMode() || !configuration.isPostDataToAirGradient()) {
if (configuration.isPostDataToAirGradient() == false || Serial.println("Skipping transmission of data to AG server. Either mode is offline "
configuration.isOfflineMode()) { "or post data to server disabled");
return;
}
if (wifiConnector.isConnected() == false) {
Serial.println("WiFi not connected, skipping data transmission to AG server");
return; return;
} }
String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration); String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), ag, configuration);
if (apiClient.postToServer(syncData)) { if (apiClient.postToServer(syncData)) {
Serial.println(); Serial.println();
Serial.println( Serial.println("Online mode and isPostToAirGradient = true");
"Online mode and isPostToAirGradient = true: watchdog reset");
Serial.println(); Serial.println();
} }
} }

View File

@@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) {
"1 if the AirGradient device was able to successfully fetch its " "1 if the AirGradient device was able to successfully fetch its "
"configuration from the server", "configuration from the server",
"gauge"); "gauge");
add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1");
add_metric( add_metric(
"post_ok", "post_ok",

View File

@@ -96,6 +96,7 @@ static bool ledBarButtonTest = false;
static String fwNewVersion; static String fwNewVersion;
static void boardInit(void); static void boardInit(void);
static void initializeNetwork(void);
static void failedHandler(String msg); static void failedHandler(String msg);
static void configurationUpdateSchedule(void); static void configurationUpdateSchedule(void);
static void updateDisplayAndLedBar(void); static void updateDisplayAndLedBar(void);
@@ -111,7 +112,7 @@ static void factoryConfigReset(void);
static void wdgFeedUpdate(void); static void wdgFeedUpdate(void);
static void ledBarEnabledUpdate(void); static void ledBarEnabledUpdate(void);
static bool sgp41Init(void); static bool sgp41Init(void);
static void firmwareCheckForUpdate(void); static void checkForFirmwareUpdate(void);
static void otaHandlerCallback(OtaHandler::OtaState state, String mesasge); static void otaHandlerCallback(OtaHandler::OtaState state, String mesasge);
static void displayExecuteOta(OtaHandler::OtaState state, String msg, int processing); static void displayExecuteOta(OtaHandler::OtaState state, String msg, int processing);
static int calculateMaxPeriod(int updateInterval); static int calculateMaxPeriod(int updateInterval);
@@ -126,7 +127,7 @@ AgSchedule pmsSchedule(SENSOR_PM_UPDATE_INTERVAL, updatePm);
AgSchedule tempHumSchedule(SENSOR_TEMP_HUM_UPDATE_INTERVAL, tempHumUpdate); AgSchedule tempHumSchedule(SENSOR_TEMP_HUM_UPDATE_INTERVAL, tempHumUpdate);
AgSchedule tvocSchedule(SENSOR_TVOC_UPDATE_INTERVAL, updateTvoc); AgSchedule tvocSchedule(SENSOR_TVOC_UPDATE_INTERVAL, updateTvoc);
AgSchedule watchdogFeedSchedule(60000, wdgFeedUpdate); AgSchedule watchdogFeedSchedule(60000, wdgFeedUpdate);
AgSchedule checkForUpdateSchedule(FIRMWARE_CHECK_FOR_UPDATE_MS, firmwareCheckForUpdate); AgSchedule checkForUpdateSchedule(FIRMWARE_CHECK_FOR_UPDATE_MS, checkForFirmwareUpdate);
void setup() { void setup() {
/** Serial for print debug message */ /** Serial for print debug message */
@@ -208,51 +209,11 @@ void setup() {
connectToWifi = true; connectToWifi = true;
} }
// Initialize networking configuration
if (connectToWifi) { if (connectToWifi) {
apiClient.begin(); initializeNetwork();
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();
}
}
}
} }
/** Set offline mode without saving, cause wifi is not configured */ /** Set offline mode without saving, cause wifi is not configured */
if (wifiConnector.hasConfigurated() == false) { if (wifiConnector.hasConfigurated() == false) {
Serial.println("Set offline mode cause wifi is not configurated"); Serial.println("Set offline mode cause wifi is not configurated");
@@ -503,17 +464,23 @@ static bool sgp41Init(void) {
return false; return false;
} }
static void firmwareCheckForUpdate(void) { static void checkForFirmwareUpdate(void) {
Serial.println(); Serial.println();
Serial.println("firmwareCheckForUpdate:"); Serial.print("checkForFirmwareUpdate: ");
if (wifiConnector.isConnected()) { if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled()) {
Serial.println("firmwareCheckForUpdate: Perform"); Serial.println("mode is offline or cloud connection disabled, ignored");
otaHandler.setHandlerCallback(otaHandlerCallback); return;
otaHandler.updateFirmwareIfOutdated(ag->deviceId());
} else {
Serial.println("firmwareCheckForUpdate: Ignored");
} }
if (!wifiConnector.isConnected()) {
Serial.println("wifi not connected, ignored");
return;
}
Serial.println("perform");
otaHandler.setHandlerCallback(otaHandlerCallback);
otaHandler.updateFirmwareIfOutdated(ag->deviceId());
Serial.println(); Serial.println();
} }
@@ -870,7 +837,77 @@ static void failedHandler(String msg) {
} }
} }
void initializeNetwork() {
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 if configured
initMqtt();
// Ignore the rest if cloud connection to AirGradient is disabled
if (configuration.isCloudConnectionDisabled()) {
return;
}
// Initialize api client
apiClient.begin();
// Send data for the first time to AG server at boot
sendDataToAg();
// OTA check
#ifdef ESP8266
// ota not supported
#else
checkForFirmwareUpdate();
checkForUpdateSchedule.update();
#endif
apiClient.fetchServerConfiguration();
configSchedule.update();
if (apiClient.isFetchConfigurationFailed()) {
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) { 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.resetFetchConfigurationStatus();
return;
}
if (apiClient.fetchServerConfiguration()) { if (apiClient.fetchServerConfiguration()) {
configUpdateHandle(); configUpdateHandle();
} }
@@ -968,10 +1005,20 @@ static void updateDisplayAndLedBar(void) {
return; return;
} }
AgStateMachineState state = AgStateMachineNormal;
if (wifiConnector.isConnected() == false) { if (wifiConnector.isConnected() == false) {
state = AgStateMachineWiFiLost; stateMachine.displayHandle(AgStateMachineWiFiLost);
} else if (apiClient.isFetchConfigureFailed()) { 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.isFetchConfigurationFailed()) {
state = AgStateMachineSensorConfigFailed; state = AgStateMachineSensorConfigFailed;
if (apiClient.isNotAvailableOnDashboard()) { if (apiClient.isNotAvailableOnDashboard()) {
stateMachine.displaySetAddToDashBoard(); stateMachine.displaySetAddToDashBoard();
@@ -1139,16 +1186,22 @@ static void sendDataToServer(void) {
int bootCount = measurements.bootCount() + 1; int bootCount = measurements.bootCount() + 1;
measurements.setBootCount(bootCount); measurements.setBootCount(bootCount);
/** Ignore send data to server if postToAirGradient disabled */ if (configuration.isOfflineMode() || configuration.isCloudConnectionDisabled() ||
if (configuration.isPostDataToAirGradient() == false || configuration.isOfflineMode()) { !configuration.isPostDataToAirGradient()) {
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;
}
if (wifiConnector.isConnected() == false) {
Serial.println("WiFi not connected, skipping data transmission to AG server");
return; return;
} }
String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), *ag, configuration); String syncData = measurements.toString(false, fwMode, wifiConnector.RSSI(), *ag, configuration);
if (apiClient.postToServer(syncData)) { if (apiClient.postToServer(syncData)) {
Serial.println(); Serial.println();
Serial.println( Serial.println("Online mode and isPostToAirGradient = true");
"Online mode and isPostToAirGradient = true: watchdog reset");
Serial.println(); Serial.println();
} }

View File

@@ -43,7 +43,7 @@ String OpenMetrics::getPayload(void) {
"1 if the AirGradient device was able to successfully fetch its " "1 if the AirGradient device was able to successfully fetch its "
"configuration from the server", "configuration from the server",
"gauge"); "gauge");
add_metric_point("", apiClient.isFetchConfigureFailed() ? "0" : "1"); add_metric_point("", apiClient.isFetchConfigurationFailed() ? "0" : "1");
add_metric( add_metric(
"post_ok", "post_ok",

View File

@@ -34,17 +34,6 @@ void AgApiClient::begin(void) {
* @return false Failure * @return false Failure
*/ */
bool AgApiClient::fetchServerConfiguration(void) { 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:" + String uri = apiRoot + "/sensors/airgradient:" +
ag->deviceId() + "/one/config"; ag->deviceId() + "/one/config";
@@ -115,15 +104,6 @@ bool AgApiClient::fetchServerConfiguration(void) {
* @return false Failure * @return false Failure
*/ */
bool AgApiClient::postToServer(String data) { 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"; String uri = apiRoot + "/sensors/airgradient:" + ag->deviceId() + "/measures";
#ifdef ESP8266 #ifdef ESP8266
HTTPClient client; HTTPClient client;
@@ -175,7 +155,12 @@ bool AgApiClient::postToServer(String data) {
* @return true Success * @return true Success
* @return false Failure * @return false Failure
*/ */
bool AgApiClient::isFetchConfigureFailed(void) { return getConfigFailed; } bool AgApiClient::isFetchConfigurationFailed(void) { return getConfigFailed; }
/**
* @brief Reset status of get configuration from AirGradient cloud
*/
void AgApiClient::resetFetchConfigurationStatus(void) { getConfigFailed = false; }
/** /**
* @brief Get failed status when post data to AirGradient cloud * @brief Get failed status when post data to AirGradient cloud

View File

@@ -40,7 +40,8 @@ public:
void begin(void); void begin(void);
bool fetchServerConfiguration(void); bool fetchServerConfiguration(void);
bool postToServer(String data); bool postToServer(String data);
bool isFetchConfigureFailed(void); bool isFetchConfigurationFailed(void);
void resetFetchConfigurationStatus(void);
bool isPostToServerFailed(void); bool isPostToServerFailed(void);
bool isNotAvailableOnDashboard(void); bool isNotAvailableOnDashboard(void);
void setAirGradient(AirGradient *ag); void setAirGradient(AirGradient *ag);

View File

@@ -47,6 +47,7 @@ JSON_PROP_DEF(mqttBrokerUrl);
JSON_PROP_DEF(temperatureUnit); JSON_PROP_DEF(temperatureUnit);
JSON_PROP_DEF(configurationControl); JSON_PROP_DEF(configurationControl);
JSON_PROP_DEF(postDataToAirGradient); JSON_PROP_DEF(postDataToAirGradient);
JSON_PROP_DEF(disableCloudConnection);
JSON_PROP_DEF(ledBarBrightness); JSON_PROP_DEF(ledBarBrightness);
JSON_PROP_DEF(displayBrightness); JSON_PROP_DEF(displayBrightness);
JSON_PROP_DEF(co2CalibrationRequested); JSON_PROP_DEF(co2CalibrationRequested);
@@ -66,6 +67,7 @@ JSON_PROP_DEF(corrections);
#define jprop_temperatureUnit_default "c" #define jprop_temperatureUnit_default "c"
#define jprop_configurationControl_default String(CONFIGURATION_CONTROL_NAME[ConfigurationControl::ConfigurationControlBoth]) #define jprop_configurationControl_default String(CONFIGURATION_CONTROL_NAME[ConfigurationControl::ConfigurationControlBoth])
#define jprop_postDataToAirGradient_default true #define jprop_postDataToAirGradient_default true
#define jprop_disableCloudConnection_default false
#define jprop_ledBarBrightness_default 100 #define jprop_ledBarBrightness_default 100
#define jprop_displayBrightness_default 100 #define jprop_displayBrightness_default 100
#define jprop_offlineMode_default false #define jprop_offlineMode_default false
@@ -272,6 +274,7 @@ void Configuration::defaultConfig(void) {
jconfig[jprop_configurationControl] = jprop_configurationControl_default; jconfig[jprop_configurationControl] = jprop_configurationControl_default;
jconfig[jprop_pmStandard] = jprop_pmStandard_default; jconfig[jprop_pmStandard] = jprop_pmStandard_default;
jconfig[jprop_temperatureUnit] = jprop_temperatureUnit_default; jconfig[jprop_temperatureUnit] = jprop_temperatureUnit_default;
jconfig[jprop_disableCloudConnection] = jprop_disableCloudConnection_default;
jconfig[jprop_postDataToAirGradient] = jprop_postDataToAirGradient_default; jconfig[jprop_postDataToAirGradient] = jprop_postDataToAirGradient_default;
if (ag->isOne()) { if (ag->isOne()) {
jconfig[jprop_ledBarBrightness] = jprop_ledBarBrightness_default; jconfig[jprop_ledBarBrightness] = jprop_ledBarBrightness_default;
@@ -1036,20 +1039,20 @@ void Configuration::toConfig(const char *buf) {
} }
bool changed = false; bool changed = false;
bool isInvalid = false; bool isConfigFieldInvalid = false;
/** Validate country */ /** Validate country */
if (JSON.typeof_(jconfig[jprop_country]) != "string") { if (JSON.typeof_(jconfig[jprop_country]) != "string") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
String country = jconfig[jprop_country]; String country = jconfig[jprop_country];
if (country.length() != 2) { if (country.length() != 2) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_country] = jprop_country_default; jconfig[jprop_country] = jprop_country_default;
changed = true; changed = true;
logInfo("toConfig: country changed"); logInfo("toConfig: country changed");
@@ -1057,17 +1060,17 @@ void Configuration::toConfig(const char *buf) {
/** validate: PM standard */ /** validate: PM standard */
if (JSON.typeof_(jconfig[jprop_pmStandard]) != "string") { if (JSON.typeof_(jconfig[jprop_pmStandard]) != "string") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
String standard = jconfig[jprop_pmStandard]; String standard = jconfig[jprop_pmStandard];
if (standard != getPMStandardString(true) && if (standard != getPMStandardString(true) &&
standard != getPMStandardString(false)) { standard != getPMStandardString(false)) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_pmStandard] = jprop_pmStandard_default; jconfig[jprop_pmStandard] = jprop_pmStandard_default;
changed = true; changed = true;
logInfo("toConfig: pmStandard changed"); logInfo("toConfig: pmStandard changed");
@@ -1075,18 +1078,18 @@ void Configuration::toConfig(const char *buf) {
/** validate led bar mode */ /** validate led bar mode */
if (JSON.typeof_(jconfig[jprop_ledBarMode]) != "string") { if (JSON.typeof_(jconfig[jprop_ledBarMode]) != "string") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
String mode = jconfig[jprop_ledBarMode]; String mode = jconfig[jprop_ledBarMode];
if (mode != getLedBarModeName(LedBarMode::LedBarModeCO2) && if (mode != getLedBarModeName(LedBarMode::LedBarModeCO2) &&
mode != getLedBarModeName(LedBarMode::LedBarModeOff) && mode != getLedBarModeName(LedBarMode::LedBarModeOff) &&
mode != getLedBarModeName(LedBarMode::LedBarModePm)) { mode != getLedBarModeName(LedBarMode::LedBarModePm)) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_ledBarMode] = jprop_ledBarMode_default; jconfig[jprop_ledBarMode] = jprop_ledBarMode_default;
changed = true; changed = true;
logInfo("toConfig: ledBarMode changed"); logInfo("toConfig: ledBarMode changed");
@@ -1094,11 +1097,11 @@ void Configuration::toConfig(const char *buf) {
/** validate abcday */ /** validate abcday */
if (JSON.typeof_(jconfig[jprop_abcDays]) != "number") { if (JSON.typeof_(jconfig[jprop_abcDays]) != "number") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_abcDays] = jprop_abcDays_default; jconfig[jprop_abcDays] = jprop_abcDays_default;
changed = true; changed = true;
logInfo("toConfig: abcDays changed"); logInfo("toConfig: abcDays changed");
@@ -1106,16 +1109,16 @@ void Configuration::toConfig(const char *buf) {
/** validate tvoc learning offset */ /** validate tvoc learning offset */
if (JSON.typeof_(jconfig[jprop_tvocLearningOffset]) != "number") { if (JSON.typeof_(jconfig[jprop_tvocLearningOffset]) != "number") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
int value = jconfig[jprop_tvocLearningOffset]; int value = jconfig[jprop_tvocLearningOffset];
if (value < 0) { if (value < 0) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_tvocLearningOffset] = jprop_tvocLearningOffset_default; jconfig[jprop_tvocLearningOffset] = jprop_tvocLearningOffset_default;
changed = true; changed = true;
logInfo("toConfig: tvocLearningOffset changed"); logInfo("toConfig: tvocLearningOffset changed");
@@ -1123,16 +1126,16 @@ void Configuration::toConfig(const char *buf) {
/** validate nox learning offset */ /** validate nox learning offset */
if (JSON.typeof_(jconfig[jprop_noxLearningOffset]) != "number") { if (JSON.typeof_(jconfig[jprop_noxLearningOffset]) != "number") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
int value = jconfig[jprop_noxLearningOffset]; int value = jconfig[jprop_noxLearningOffset];
if (value < 0) { if (value < 0) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_noxLearningOffset] = jprop_noxLearningOffset_default; jconfig[jprop_noxLearningOffset] = jprop_noxLearningOffset_default;
changed = true; changed = true;
logInfo("toConfig: noxLearningOffset changed"); logInfo("toConfig: noxLearningOffset changed");
@@ -1140,11 +1143,11 @@ void Configuration::toConfig(const char *buf) {
/** validate mqtt broker */ /** validate mqtt broker */
if (JSON.typeof_(jconfig[jprop_mqttBrokerUrl]) != "string") { if (JSON.typeof_(jconfig[jprop_mqttBrokerUrl]) != "string") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
if (isInvalid) { if (isConfigFieldInvalid) {
changed = true; changed = true;
jconfig[jprop_mqttBrokerUrl] = jprop_mqttBrokerUrl_default; jconfig[jprop_mqttBrokerUrl] = jprop_mqttBrokerUrl_default;
logInfo("toConfig: mqttBroker changed"); logInfo("toConfig: mqttBroker changed");
@@ -1152,24 +1155,36 @@ void Configuration::toConfig(const char *buf) {
/** Validate temperature unit */ /** Validate temperature unit */
if (JSON.typeof_(jconfig[jprop_temperatureUnit]) != "string") { if (JSON.typeof_(jconfig[jprop_temperatureUnit]) != "string") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
String unit = jconfig[jprop_temperatureUnit]; String unit = jconfig[jprop_temperatureUnit];
if (unit != "c" && unit != "f") { if (unit != "c" && unit != "f") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_temperatureUnit] = jprop_temperatureUnit_default; jconfig[jprop_temperatureUnit] = jprop_temperatureUnit_default;
changed = true; changed = true;
logInfo("toConfig: temperatureUnit changed"); logInfo("toConfig: temperatureUnit changed");
} }
/** validate disableCloudConnection configuration */
if (JSON.typeof_(jconfig[jprop_disableCloudConnection]) != "boolean") {
isConfigFieldInvalid = true;
} else {
isConfigFieldInvalid = false;
}
if (isConfigFieldInvalid) {
jconfig[jprop_disableCloudConnection] = jprop_disableCloudConnection_default;
changed = true;
logInfo("toConfig: disableCloudConnection changed");
}
/** validate configuration control */ /** validate configuration control */
if (JSON.typeof_(jprop_configurationControl) != "string") { if (JSON.typeof_(jprop_configurationControl) != "string") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
String ctrl = jconfig[jprop_configurationControl]; String ctrl = jconfig[jprop_configurationControl];
if (ctrl != String(CONFIGURATION_CONTROL_NAME if (ctrl != String(CONFIGURATION_CONTROL_NAME
@@ -1178,12 +1193,12 @@ void Configuration::toConfig(const char *buf) {
[ConfigurationControl::ConfigurationControlLocal]) && [ConfigurationControl::ConfigurationControlLocal]) &&
ctrl != String(CONFIGURATION_CONTROL_NAME ctrl != String(CONFIGURATION_CONTROL_NAME
[ConfigurationControl::ConfigurationControlCloud])) { [ConfigurationControl::ConfigurationControlCloud])) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_configurationControl] =jprop_configurationControl_default; jconfig[jprop_configurationControl] =jprop_configurationControl_default;
changed = true; changed = true;
logInfo("toConfig: configurationControl changed"); logInfo("toConfig: configurationControl changed");
@@ -1191,11 +1206,11 @@ void Configuration::toConfig(const char *buf) {
/** Validate post to airgradient cloud */ /** Validate post to airgradient cloud */
if (JSON.typeof_(jconfig[jprop_postDataToAirGradient]) != "boolean") { if (JSON.typeof_(jconfig[jprop_postDataToAirGradient]) != "boolean") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_postDataToAirGradient] = jprop_postDataToAirGradient_default; jconfig[jprop_postDataToAirGradient] = jprop_postDataToAirGradient_default;
changed = true; changed = true;
logInfo("toConfig: postToAirGradient changed"); logInfo("toConfig: postToAirGradient changed");
@@ -1203,16 +1218,16 @@ void Configuration::toConfig(const char *buf) {
/** validate led bar brightness */ /** validate led bar brightness */
if (JSON.typeof_(jconfig[jprop_ledBarBrightness]) != "number") { if (JSON.typeof_(jconfig[jprop_ledBarBrightness]) != "number") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
int value = jconfig[jprop_ledBarBrightness]; int value = jconfig[jprop_ledBarBrightness];
if (value < 0 || value > 100) { if (value < 0 || value > 100) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_ledBarBrightness] = jprop_ledBarBrightness_default; jconfig[jprop_ledBarBrightness] = jprop_ledBarBrightness_default;
changed = true; changed = true;
logInfo("toConfig: ledBarBrightness changed"); logInfo("toConfig: ledBarBrightness changed");
@@ -1220,16 +1235,16 @@ void Configuration::toConfig(const char *buf) {
/** Validate display brightness */ /** Validate display brightness */
if (JSON.typeof_(jconfig[jprop_displayBrightness]) != "number") { if (JSON.typeof_(jconfig[jprop_displayBrightness]) != "number") {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
int value = jconfig[jprop_displayBrightness]; int value = jconfig[jprop_displayBrightness];
if (value < 0 || value > 100) { if (value < 0 || value > 100) {
isInvalid = true; isConfigFieldInvalid = true;
} else { } else {
isInvalid = false; isConfigFieldInvalid = false;
} }
} }
if (isInvalid) { if (isConfigFieldInvalid) {
jconfig[jprop_displayBrightness] = jprop_displayBrightness_default; jconfig[jprop_displayBrightness] = jprop_displayBrightness_default;
changed = true; changed = true;
logInfo("toConfig: displayBrightness changed"); logInfo("toConfig: displayBrightness changed");
@@ -1334,6 +1349,17 @@ void Configuration::setOfflineModeWithoutSave(bool offline) {
_offlineMode = 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 Configuration::isLedBarModeChanged(void) {
bool changed = _ledBarModeChanged; bool changed = _ledBarModeChanged;
_ledBarModeChanged = false; _ledBarModeChanged = false;

View File

@@ -94,6 +94,8 @@ public:
bool isOfflineMode(void); bool isOfflineMode(void);
void setOfflineMode(bool offline); void setOfflineMode(bool offline);
void setOfflineModeWithoutSave(bool offline); void setOfflineModeWithoutSave(bool offline);
bool isCloudConnectionDisabled(void);
void setDisableCloudConnection(bool disable);
bool isLedBarModeChanged(void); bool isLedBarModeChanged(void);
bool isMonitorDisplayCompensatedValues(void); bool isMonitorDisplayCompensatedValues(void);
bool isPMCorrectionChanged(void); bool isPMCorrectionChanged(void);

View File

@@ -81,16 +81,15 @@ bool WifiConnector::connect(void) {
// ssid = "AG-" + String(ESP.getChipId(), HEX); // ssid = "AG-" + String(ESP.getChipId(), HEX);
WIFI()->setConfigPortalTimeout(WIFI_CONNECT_COUNTDOWN_MAX); WIFI()->setConfigPortalTimeout(WIFI_CONNECT_COUNTDOWN_MAX);
WiFiManagerParameter postToAg("chbPostToAg", WiFiManagerParameter disableCloud("chbPostToAg", "Prevent Connection to AirGradient Server", "T",
"Prevent Connection to AirGradient Server", "T", 2, "type=\"checkbox\" ", WFM_LABEL_AFTER);
2, "type=\"checkbox\" ", WFM_LABEL_AFTER); WIFI()->addParameter(&disableCloud);
WIFI()->addParameter(&postToAg); WiFiManagerParameter disableCloudInfo(
WiFiManagerParameter postToAgInfo(
"<p>Prevent connection to the AirGradient Server. Important: Only enable " "<p>Prevent connection to the AirGradient Server. Important: Only enable "
"it if you are sure you don't want to use any AirGradient cloud " "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 " "features. As a result you will not receive automatic firmware updates, "
"and your data will not reach the AirGradient dashboard.</p>"); "configuration settings from cloud and the measure data will not reach the AirGradient dashboard.</p>");
WIFI()->addParameter(&postToAgInfo); WIFI()->addParameter(&disableCloudInfo);
WIFI()->autoConnect(ssid.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT); WIFI()->autoConnect(ssid.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT);
@@ -174,12 +173,11 @@ bool WifiConnector::connect(void) {
logInfo("WiFi Connected: " + WiFi.SSID() + " IP: " + localIpStr()); logInfo("WiFi Connected: " + WiFi.SSID() + " IP: " + localIpStr());
if (hasPortalConfig) { if (hasPortalConfig) {
String result = String(postToAg.getValue()); String result = String(disableCloud.getValue());
logInfo("Setting postToAirGradient set from " + logInfo("Setting disableCloudConnection set from " +
String(config.isPostDataToAirGradient() ? "True" : "False") + String(config.isCloudConnectionDisabled() ? "True" : "False") + String(" to ") +
String(" to ") + String(result != "T" ? "True" : "False") + String(result == "T" ? "True" : "False") + String(" successful"));
String(" successful")); config.setDisableCloudConnection(result == "T");
config.setPostToAirGradient(result != "T");
} }
hasPortalConfig = false; hasPortalConfig = false;
} }