Merge pull request #173 from airgradienthq/develop

Next version 3.1.3

docs/local-server.md

@@ -17,62 +17,66 @@ With the path "/measures/current" you can get the current air quality data.
 
 http://airgradient_ecda3b1eaaaf.local/measures/current
 
-“ecda3b1eaaaf” being the serial number of your monitor
+“ecda3b1eaaaf” being the serial number of your monitor.
 
 You get the following response:
-~~~ 
-{"wifi":-46,
-"serialno":"ecda3b1eaaaf",
-"rco2":447,
-"pm01":3,
-"pm02":7,
-"pm10":8,
-"pm003Count":442,
-"atmp":25.87,
-"rhum":43,
-"tvocIndex":100,
-"tvoc_raw":33051,
-"noxIndex":1,
-"nox_raw":16307,
-"boot":6,
-"ledMode":"pm",
-"firmwareVersion":"3.0.10beta",
-"fwMode":"I-9PSL"}
-~~~ 
+```json 
+{
+  "wifi": -46,
+  "serialno": "ecda3b1eaaaf",
+  "rco2": 447,
+  "pm01": 3,
+  "pm02": 7,
+  "pm10": 8,
+  "pm003Count": 442,
+  "atmp": 25.87,
+  "rhum": 43,
+  "tvocIndex": 100,
+  "tvoc_raw": 33051,
+  "noxIndex": 1,
+  "nox_raw": 16307,
+  "boot": 6,
+  "ledMode": "pm",
+  "firmwareVersion": "3.0.10beta",
+  "fwMode": "I-9PSL"
+}
+```
 
-|Properties|Type|Explanation|
-|-|-|-|
-|serialno|String| Serial Number of the monitor|
-|wifi|Number| WiFi signal strength|
-|pm01, pm02, pm10|Number| PM1, PM2.5 and PM10 in ug/m3|
-|rco2|Number| CO2 in ppm|
-|pm003Count|Number| Particle count per dL|
-|atmp|Number| Temperature in Degrees Celcius|
-|rhum|Number| Relative Humidity|
-|tvocIndex|Number| Senisiron VOC Index|
-|tvoc_raw|Number| VOC raw value|
-|noxIndex|Number| Senisirion NOx Index|
-|nox_raw|Number| NOx raw value|
-|boot|Number| Counts every measurement cycle. Low boot counts indicate restarts.|
-|ledMode|String| Current configuration of the LED mode|
-|firmwareVersion|String| Current firmware version|
-|fwMode|String| Current model name|
+| Properties       | Type   | Explanation                                                        |
+|------------------|--------|--------------------------------------------------------------------|
+| serialno         | String | Serial Number of the monitor                                       |
+| wifi             | Number | WiFi signal strength                                               |
+| pm01, pm02, pm10 | Number | PM1, PM2.5 and PM10 in ug/m3                                       |
+| rco2             | Number | CO2 in ppm                                                         |
+| pm003Count       | Number | Particle count per dL                                              |
+| atmp             | Number | Temperature in Degrees Celcius                                     |
+| rhum             | Number | Relative Humidity                                                  |
+| tvocIndex        | Number | Senisiron VOC Index                                                |
+| tvoc_raw         | Number | VOC raw value                                                      |
+| noxIndex         | Number | Senisirion NOx Index                                               |
+| nox_raw          | Number | NOx raw value                                                      |
+| boot             | Number | Counts every measurement cycle. Low boot counts indicate restarts. |
+| ledMode          | String | Current configuration of the LED mode                              |
+| firmwareVersion  | String | Current firmware version                                           |
+| fwMode           | String | Current model name                                                 |
 
 #### Get Configuration Parameters (GET)
 With the path "/config" you can get the current configuration.
-~~~ 
-{"country":"US",
-"pmStandard":"ugm3",
-"ledBarMode":"pm",
-"displayMode":"on",
-"abcDays":30,
-"tvocLearningOffset":12,
-"noxLearningOffset":12,
-"mqttBrokerUrl":"",
-"temperatureUnit":"f",
-"configurationControl":"both",
-"postDataToAirGradient":true}
-~~~ 
+```json 
+{
+  "country": "US",
+  "pmStandard": "ugm3",
+  "ledBarMode": "pm",
+  "displayMode": "on",
+  "abcDays": 30,
+  "tvocLearningOffset": 12,
+  "noxLearningOffset": 12,
+  "mqttBrokerUrl": "",
+  "temperatureUnit": "f",
+  "configurationControl": "both",
+  "postDataToAirGradient": true
+}
+```
 
 #### Set Configuration Parameters (PUT)
 
@@ -82,24 +86,24 @@ Example to force CO2 calibration
 
  ```curl -X PUT -H "Content-Type: application/json" -d '{"co2CalibrationRequested":true}' http://airgradient_84fce612eff4.local/config ```
 
-Example to set monitor to Celcius
+Example to set monitor to Celsius
 
  ```curl -X PUT -H "Content-Type: application/json" -d '{"temperatureUnit":"c"}' http://airgradient_84fce612eff4.local/config ```
 
 #### Avoiding Conflicts with Configuration on AirGradient Server
-If the monitor is setup on the AirGradient dashboard, it will also receive configurations from there. In case you do not want this, please set "configurationControl" to local. In case you set it to cloud and want to change it to local, you need to make a factory reset. 
+If the monitor is set up on the AirGradient dashboard, it will also receive configurations from there. In case you do not want this, please set `configurationControl` to `local`. In case you set it to `cloud` and want to change it to `local`, you need to make a factory reset. 
 
 #### Configuration Parameters (GET/PUT)
 
-|Properties|Type|Accepted Values|Example|
-|-|-|-|-|
-|country|String| Country code as [ALPHA-2 notation](https://www.iban.com/country-codes) |  {"country": "TH"}|
-|pmStandard|String|ugm3 : ug/m3 <br> usaqi: USAQI |  {"pmStandard": "ugm3"}|
-|ledBarMode|String|co2: LED bar displays CO2 <br> pm: LED bar displays PM <br> off: Turn off LED bar |  {"ledBarMode": "off"}|
-|abcDays|Number|Number of days for CO2 automatic baseline balibration. Maximum 200 days. Default 8 days. |  {"abcDays": 8}|
-|mqttBrokerUrl|String|MQTT broker URL. |  {"mqttBrokerUrl":"mqtt://192.168.0.18:1883"} |
-|temperatureUnit|String|c or C: Degree Celsius °C <br>f or F: Degree Fahrenheit °F |  {"temperatureUnit": "c"}|
-|configurationControl|String|both : Accept local and cloud configuration <br>local : Accept only local configuration  <br>cloud : Accept only cloud configuration |  {"configurationControl": "both"}|
-|postDataToAirGradient|Boolean|Send data to AirGradient cloud: <br>true : Enabled <br>false: Disabled |  {"postDataToAirGradient": true}|
-|co2CalibrationRequested|Boolean|Trigger CO2 calibration (400ppm) on monitor:<br>true : Calibration will be triggered |  {"co2CalibrationRequested": true}|
-|ledBarTestRequested|Boolean|Test LED bar:<br> true : LEDs will run test sequence |  {"ledBarTestRequested": true}|
+| Properties              | Description                                            | Type    | Accepted Values                                                                                                                         | Example                                       |
+|-------------------------|:-------------------------------------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
+| country                 | Country where the device is.                           | String  | Country code as [ALPHA-2 notation](https://www.iban.com/country-codes)                                                                  | {"country": "TH"}                             |
+| pmStandard              | Particle matter standard used on the display.          | String  | `ugm3`: ug/m3 <br> `us-aqi`: USAQI                                                                                                      | {"pmStandard": "ugm3"}                        |
+| ledBarMode              | Mode in which the led bar can be set.                  | String  | `co2`: LED bar displays CO2 <br>`pm`: LED bar displays PM <br>`off`: Turn off LED bar                                                   | {"ledBarMode": "off"}                         |
+| abcDays                 | Number of days for CO2 automatic baseline calibration. | Number  | Maximum 200 days. Default 8 days.                                                                                                       | {"abcDays": 8}                                |
+| mqttBrokerUrl           | MQTT broker URL.                                       | String  |                                                                                                                                         | {"mqttBrokerUrl": "mqtt://192.168.0.18:1883"} |
+| temperatureUnit         | Temperature unit shown on the display.                 | String  | `c` or `C`: Degree Celsius °C <br>`f` or `F`: Degree Fahrenheit °F                                                                      | {"temperatureUnit": "c"}                      |
+| configurationControl    | The configuration source of the device.                | String  | `both`: Accept local and cloud configuration <br>`local`: Accept only local configuration  <br>`cloud`: Accept only cloud configuration | {"configurationControl": "both"}              |
+| postDataToAirGradient   | Send data to AirGradient cloud.                        | Boolean | `true`: Enabled <br>`false`: Disabled                                                                                                   | {"postDataToAirGradient": true}               |
+| co2CalibrationRequested | Can be set to trigger a calibration.                   | Boolean | `true`: CO2 calibration (400ppm) will be triggered                                                                                      | {"co2CalibrationRequested": true}             |
+| ledBarTestRequested     | Can be set to trigger a test.                          | Boolean | `true` : LEDs will run test sequence                                                                                                    | {"ledBarTestRequested": true}                 |

examples/BASIC/BASIC.ino

@@ -41,7 +41,7 @@ CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
 #define LED_BAR_COUNT_INIT_VALUE (-1)        /** */
 #define LED_BAR_ANIMATION_PERIOD 100         /** ms */
 #define DISP_UPDATE_INTERVAL 5000            /** ms */
-#define SERVER_CONFIG_UPDATE_INTERVAL 30000  /** ms */
+#define SERVER_CONFIG_SYNC_INTERVAL 60000    /** ms */
 #define SERVER_SYNC_INTERVAL 60000           /** ms */
 #define SENSOR_CO2_CALIB_COUNTDOWN_MAX 5     /** sec */
 #define SENSOR_TVOC_UPDATE_INTERVAL 1000     /** ms */
@@ -82,7 +82,7 @@ bool hasSensorPMS = true;
 bool hasSensorSHT = true;
 int pmFailCount = 0;
 int getCO2FailCount = 0;
-AgSchedule configSchedule(SERVER_CONFIG_UPDATE_INTERVAL,
+AgSchedule configSchedule(SERVER_CONFIG_SYNC_INTERVAL,
                           updateServerConfiguration);
 AgSchedule serverSchedule(SERVER_SYNC_INTERVAL, sendDataToServer);
 AgSchedule dispSchedule(DISP_UPDATE_INTERVAL, dispHandler);
@@ -224,7 +224,7 @@ static void failedHandler(String msg) {
 static void executeCo2Calibration(void) {
   /** Count down for co2CalibCountdown secs */
   for (int i = 0; i < SENSOR_CO2_CALIB_COUNTDOWN_MAX; i++) {
-    displayShowText("CO2 calib", "after",
+    displayShowText("CO2 calib.", "after",
                     String(SENSOR_CO2_CALIB_COUNTDOWN_MAX - i) + " sec");
     delay(1000);
   }
@@ -232,16 +232,16 @@ static void executeCo2Calibration(void) {
   if (ag.s8.setBaselineCalibration()) {
     displayShowText("Calib", "success", "");
     delay(1000);
-    displayShowText("Wait for", "finish", "...");
+    displayShowText("Wait to", "complete", "...");
     int count = 0;
     while (ag.s8.isBaseLineCalibrationDone() == false) {
       delay(1000);
       count++;
     }
-    displayShowText("Finish", "after", String(count) + " sec");
+    displayShowText("Finished", "after", String(count) + " sec");
     delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
   } else {
-    displayShowText("Calib", "failure!!!", "");
+    displayShowText("Calibration", "failure", "");
     delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
   }
 }

examples/OneOpenAir/OneOpenAir.ino

@@ -55,7 +55,7 @@ CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
 
 #define LED_BAR_ANIMATION_PERIOD 100         /** ms */
 #define DISP_UPDATE_INTERVAL 2500            /** ms */
-#define SERVER_CONFIG_UPDATE_INTERVAL 15000  /** ms */
+#define SERVER_CONFIG_SYNC_INTERVAL 60000    /** ms */
 #define SERVER_SYNC_INTERVAL 60000           /** ms */
 #define MQTT_SYNC_INTERVAL 60000             /** ms */
 #define SENSOR_CO2_CALIB_COUNTDOWN_MAX 5     /** sec */
@@ -64,6 +64,7 @@ CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
 #define SENSOR_PM_UPDATE_INTERVAL 2000       /** ms */
 #define SENSOR_TEMP_HUM_UPDATE_INTERVAL 2000 /** ms */
 #define DISPLAY_DELAY_SHOW_CONTENT_MS 2000   /** ms */
+#define FIRMWARE_CHECK_FOR_UPDATE_MS (60*60*1000)   /** ms */
 
 /** I2C define */
 #define I2C_SDA_PIN 7
@@ -113,12 +114,13 @@ static void factoryConfigReset(void);
 static void wdgFeedUpdate(void);
 static void ledBarEnabledUpdate(void);
 static bool sgp41Init(void);
+static void firmwareCheckForUpdate(void);
 static void otaHandlerCallback(OtaState state, String mesasge);
 static void displayExecuteOta(OtaState state, String msg,
                               int processing);
 
 AgSchedule dispLedSchedule(DISP_UPDATE_INTERVAL, oledDisplayLedBarSchedule);
-AgSchedule configSchedule(SERVER_CONFIG_UPDATE_INTERVAL,
+AgSchedule configSchedule(SERVER_CONFIG_SYNC_INTERVAL,
                           configurationUpdateSchedule);
 AgSchedule agApiPostSchedule(SERVER_SYNC_INTERVAL, sendDataToServer);
 AgSchedule co2Schedule(SENSOR_CO2_UPDATE_INTERVAL, co2Update);
@@ -126,6 +128,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);
 
 void setup() {
   /** Serial for print debug message */
@@ -152,8 +155,6 @@ void setup() {
   }
   Serial.println("Detected " + ag->getBoardName());
 
-  /** Init sensor */
-  boardInit();
   configuration.setAirGradient(ag);
   oledDisplay.setAirGradient(ag);
   stateMachine.setAirGradient(ag);
@@ -162,20 +163,12 @@ void setup() {
   openMetrics.setAirGradient(ag);
   localServer.setAirGraident(ag);
 
+  /** Init sensor */
+  boardInit();
+
   /** Connecting wifi */
   bool connectToWifi = false;
   if (ag->isOne()) {
-    if (ledBarButtonTest) {
-      stateMachine.executeLedBarPowerUpTest();
-      if (ag->button.getState() == PushButton::BUTTON_PRESSED) {
-        WiFi.begin("airgradient", "cleanair");
-        Serial.println("WiFi Credential reset to factory defaults");
-        ESP.restart();
-      }
-    } else {
-      ledBarEnabledUpdate();
-    }
-
     /** Show message confirm offline mode, should me perform if LED bar button
      * test pressed */
     if (ledBarButtonTest == false) {
@@ -219,15 +212,18 @@ void setup() {
         #ifdef ESP8266
           // ota not supported
         #else
-          // otaHandler.updateFirmwareIfOutdated(ag->deviceId());
+          firmwareCheckForUpdate();
+          checkForUpdateSchedule.update();
         #endif
 
         apiClient.fetchServerConfiguration();
         configSchedule.update();
         if (apiClient.isFetchConfigureFailed()) {
           if (ag->isOne()) {
-            stateMachine.displayHandle(
-                AgStateMachineWiFiOkServerOkSensorConfigFailed);
+            if (apiClient.isNotAvailableOnDashboard()) {
+              stateMachine.displayHandle(
+                  AgStateMachineWiFiOkServerOkSensorConfigFailed);
+            }
           }
           stateMachine.handleLeds(
               AgStateMachineWiFiOkServerOkSensorConfigFailed);
@@ -235,6 +231,13 @@ void setup() {
         } else {
           ledBarEnabledUpdate();
         }
+      } else {
+        if (wifiConnector.isConfigurePorttalTimeout()) {
+          oledDisplay.showRebooting();
+          delay(2500);
+          oledDisplay.setText("", "", "");
+          ESP.restart();
+        }
       }
     }
   }
@@ -304,6 +307,9 @@ void loop() {
 
   /** check that local configura changed then do some action */
   configUpdateHandle();
+
+  /** Firmware check for update handle */
+  checkForUpdateSchedule.run();
 }
 
 static void co2Update(void) {
@@ -412,6 +418,7 @@ static void factoryConfigReset(void) {
             }
 
             /** Reset WIFI */
+            WiFi.enableSTA(true);   // Incase offline mode
             WiFi.disconnect(true, true);
 
             /** Reset local config */
@@ -423,6 +430,7 @@ static void factoryConfigReset(void) {
               Serial.println("Factory reset successful");
             }
             delay(3000);
+            oledDisplay.setText("","","");
             ESP.restart();
           }
         }
@@ -459,9 +467,10 @@ static void ledBarEnabledUpdate(void) {
     if ((brightness == 0) || (configuration.getLedBarMode() == LedBarModeOff)) {
       ag->ledBar.setEnable(false);
     } else {
-      ag->ledBar.setBrighness(brightness);
+      ag->ledBar.setBrightness(brightness);
       ag->ledBar.setEnable(configuration.getLedBarMode() != LedBarModeOff);
     }
+     ag->ledBar.show();
   }
 }
 
@@ -479,7 +488,22 @@ static bool sgp41Init(void) {
   return false;
 }
 
+static void firmwareCheckForUpdate(void) {
+  Serial.println();
+  Serial.println("firmwareCheckForUpdate:");
+
+  if (wifiConnector.isConnected()) {
+    Serial.println("firmwareCheckForUpdate: Perform");
+    otaHandler.setHandlerCallback(otaHandlerCallback);
+    otaHandler.updateFirmwareIfOutdated(ag->deviceId());
+  } else {
+    Serial.println("firmwareCheckForUpdate: Ignored");
+  }
+  Serial.println();
+}
+
 static void otaHandlerCallback(OtaState state, String mesasge) {
+  Serial.println("OTA message: " + mesasge);
   switch (state) {
   case OtaState::OTA_STATE_BEGIN:
     displayExecuteOta(state, fwNewVersion, 0);
@@ -502,7 +526,7 @@ static void displayExecuteOta(OtaState state, String msg, int processing) {
   switch (state) {
   case OtaState::OTA_STATE_BEGIN: {
     if (ag->isOne()) {
-      oledDisplay.showNewFirmwareVersion(msg);
+      oledDisplay.showFirmwareUpdateVersion(msg);
     } else {
       Serial.println("New firmware: " + msg);
     }
@@ -511,7 +535,7 @@ static void displayExecuteOta(OtaState state, String msg, int processing) {
   }
   case OtaState::OTA_STATE_FAIL: {
     if (ag->isOne()) {
-      oledDisplay.showNewFirmwareFailed();
+      oledDisplay.showFirmwareUpdateFailed();
     } else {
       Serial.println("Error: Firmware update: failed");
     }
@@ -519,9 +543,29 @@ static void displayExecuteOta(OtaState state, String msg, int processing) {
     delay(2500);
     break;
   }
+  case OtaState::OTA_STATE_SKIP: {
+    if (ag->isOne()) {
+      oledDisplay.showFirmwareUpdateSkipped();
+    } else {
+      Serial.println("Firmware update: Skipped");
+    }
+
+    delay(2500);
+    break;
+  }
+  case OtaState::OTA_STATE_UP_TO_DATE: {
+    if (ag->isOne()) {
+      oledDisplay.showFirmwareUpdateUpToDate();
+    } else {
+      Serial.println("Firmware update: up to date");
+    }
+
+    delay(2500);
+    break;
+  }
   case OtaState::OTA_STATE_PROCESSING: {
     if (ag->isOne()) {
-      oledDisplay.showNewFirmwareUpdating(String(processing));
+      oledDisplay.showFirmwareUpdateProgress(processing);
     } else {
       Serial.println("Firmware update: " + String(processing) + String("%"));
     }
@@ -537,13 +581,14 @@ static void displayExecuteOta(OtaState state, String msg, int processing) {
       while (i != 0) {
         i = i - 1;
         if (ag->isOne()) {
-          oledDisplay.showNewFirmwareSuccess(String(i));
+          oledDisplay.showFirmwareUpdateSuccess(i);
         } else {
           Serial.println("Rebooting... " + String(i));
         }
         
         delay(1000);
       }
+      oledDisplay.setBrightness(0);
       esp_restart();
     }
     break;
@@ -615,6 +660,41 @@ static void oneIndoorInit(void) {
   ag->button.begin();
   ag->watchdog.begin();
 
+  /** Run LED test on start up if button pressed */
+  oledDisplay.setText("Press now for", "LED test", "");
+  ledBarButtonTest = false;
+  uint32_t stime = millis();
+  while (true) {
+    if (ag->button.getState() == ag->button.BUTTON_PRESSED) {
+      ledBarButtonTest = true;
+      stateMachine.executeLedBarPowerUpTest();
+      break;
+    }
+    delay(1);
+    uint32_t ms = (uint32_t)(millis() - stime);
+    if (ms >= 3000) {
+      break;
+    }
+  }
+
+  /** Check for button to reset WiFi connecto to "airgraident" after test LED
+   * bar */
+  if (ledBarButtonTest) {
+    if (ag->button.getState() == ag->button.BUTTON_PRESSED) {
+      WiFi.begin("airgradient", "cleanair");
+      oledDisplay.setText("Configure WiFi", "connect to", "\'airgradient\'");
+      delay(2500);
+      oledDisplay.setText("Rebooting...", "","");
+      delay(2500);
+      oledDisplay.setText("","","");
+      ESP.restart();
+    }
+  }
+  ledBarEnabledUpdate();
+
+  /** Show message init sensor */
+  oledDisplay.setText("Sensor", "initializing...", "");
+
   /** Init sensor SGP41 */
   if (sgp41Init() == false) {
     dispSensorNotFound("SGP41");
@@ -641,22 +721,6 @@ static void oneIndoorInit(void) {
 
     dispSensorNotFound("PMS");
   }
-
-  /** Run LED test on start up */
-  oledDisplay.setText("Press now for", "LED test", "");
-  ledBarButtonTest = false;
-  uint32_t stime = millis();
-  while (true) {
-    if (ag->button.getState() == ag->button.BUTTON_PRESSED) {
-      ledBarButtonTest = true;
-      break;
-    }
-    delay(1);
-    uint32_t ms = (uint32_t)(millis() - stime);
-    if (ms >= 3000) {
-      break;
-    }
-  }
 }
 static void openAirInit(void) {
   configuration.hasSensorSHT = false;
@@ -804,10 +868,6 @@ static void configUpdateHandle() {
     return;
   }
 
-  if (ag->isOne()) {
-    ledBarEnabledUpdate();
-    stateMachine.executeLedBarTest();
-  }
   stateMachine.executeCo2Calibration();
 
   String mqttUri = configuration.getMqttBrokerUri();
@@ -843,39 +903,36 @@ static void configUpdateHandle() {
 
   if (ag->isOne()) {
     if (configuration.isLedBarBrightnessChanged()) {
-      ag->ledBar.setBrighness(configuration.getLedBarBrightness());
-      Serial.println("Set 'LedBarBrightness' brightness: " +
-                     String(configuration.getLedBarBrightness()));
+      if (configuration.getLedBarBrightness() == 0) {
+        ag->ledBar.setEnable(false);
+      } else {
+        if (configuration.getLedBarMode() != LedBarMode::LedBarModeOff) {
+          ag->ledBar.setEnable(true);
+        }
+        ag->ledBar.setBrightness(configuration.getLedBarBrightness());
+      }
+      ag->ledBar.show();
     }
+
+    if (configuration.isLedBarModeChanged()) {
+      if (configuration.getLedBarBrightness() == 0) {
+        ag->ledBar.setEnable(false);
+      } else {
+        if(configuration.getLedBarMode() == LedBarMode::LedBarModeOff) {
+          ag->ledBar.setEnable(false);
+        } else {
+          ag->ledBar.setEnable(true);
+          ag->ledBar.setBrightness(configuration.getLedBarBrightness());
+        }
+      }
+      ag->ledBar.show();
+    }
+
     if (configuration.isDisplayBrightnessChanged()) {
       oledDisplay.setBrightness(configuration.getDisplayBrightness());
-      Serial.println("Set 'DisplayBrightness' brightness: " +
-                     String(configuration.getDisplayBrightness()));
-    }
-  }
-
-  fwNewVersion = configuration.newFirmwareVersion();
-  if (fwNewVersion.length()) {
-    bool doOta = false;
-    if (measurements.otaBootCount == 0) {
-      doOta = true;
-      Serial.println("First OTA");
-    } else {
-      if ((measurements.bootCount - measurements.otaBootCount) >= 30) {
-        doOta = true;
-      } else {
-        Serial.println(
-            "OTA ignore, try again next " +
-            String(30 - (measurements.bootCount - measurements.otaBootCount)) +
-            String(" boots"));
-      }
     }
 
-    if (doOta) {
-      measurements.otaBootCount = measurements.bootCount;
-      otaHandler.setHandlerCallback(otaHandlerCallback);
-      otaHandler.updateFirmwareIfOutdated(ag->deviceId());
-    }
+    stateMachine.executeLedBarTest();
   }
 
   appDispHandler();

examples/OneOpenAir/OtaHandler.h

@@ -18,6 +18,8 @@ enum OtaUpdateOutcome {
 enum OtaState {
   OTA_STATE_BEGIN,
   OTA_STATE_FAIL,
+  OTA_STATE_SKIP,
+  OTA_STATE_UP_TO_DATE,
   OTA_STATE_PROCESSING,
   OTA_STATE_SUCCESS
 };
@@ -40,13 +42,22 @@ public:
     config.url = urlAsChar;
     OtaUpdateOutcome ret = attemptToPerformOta(&config);
     Serial.println(ret);
-    if (ret == OtaUpdateOutcome::UPDATE_PERFORMED) {
-      if (this->callback) {
+    if (this->callback) {
+      switch (ret) {
+      case OtaUpdateOutcome::UPDATE_PERFORMED:
         this->callback(OtaState::OTA_STATE_SUCCESS, "");
-      }
-    } else {
-      if(this->callback) {
+        break;
+      case OtaUpdateOutcome::UDPATE_SKIPPED:
+        this->callback(OtaState::OTA_STATE_SKIP, "");
+        break;
+      case OtaUpdateOutcome::ALREADY_UP_TO_DATE:
+        this->callback(OtaState::OTA_STATE_UP_TO_DATE, "");
+        break;
+      case OtaUpdateOutcome::UPDATE_FAILED:
         this->callback(OtaState::OTA_STATE_FAIL, "");
+        break;
+      default:
+        break;
       }
     }
   }
@@ -127,6 +138,9 @@ private:
       int data_read =
           esp_http_client_read(client, upgrade_data_buf, OTA_BUF_SIZE);
       if (data_read == 0) {
+        if (this->callback) {
+          this->callback(OtaState::OTA_STATE_PROCESSING, String(100));
+        }
         Serial.println("Connection closed, all data received");
         break;
       }

library.properties

@@ -1,5 +1,5 @@
 name=AirGradient Air Quality Sensor
-version=3.1.0-beta.1
+version=3.1.3
 author=AirGradient <support@airgradient.com>
 maintainer=AirGradient <support@airgradient.com>
 sentence=ESP32-C3 / ESP8266 library for air quality monitor measuring PM, CO2, Temperature, TVOC and Humidity with OLED display.

src/AgApiClient.cpp

@@ -69,11 +69,17 @@ bool AgApiClient::fetchServerConfiguration(void) {
   if (retCode != 200) {
     client.end();
     getConfigFailed = true;
+
+    /** Return code 400 mean device not setup on cloud. */
+    if (retCode == 400) {
+      notAvailableOnDashboard = true;
+    }
     return false;
   }
 
   /** clear failed */
   getConfigFailed = false;
+  notAvailableOnDashboard = false;
 
   /** Get response string */
   String respContent = client.getString();
@@ -144,6 +150,17 @@ bool AgApiClient::isFetchConfigureFailed(void) { return getConfigFailed; }
  */
 bool AgApiClient::isPostToServerFailed(void) { return postToServerFailed; }
 
+/**
+ * @brief Get status device has available on dashboard or not. should get after
+ * fetch configuration return failed
+ *
+ * @return true
+ * @return false
+ */
+bool AgApiClient::isNotAvailableOnDashboard(void) {
+  return notAvailableOnDashboard;
+}
+
 void AgApiClient::setAirGradient(AirGradient *ag) { this->ag = ag; }
 
 /**

src/AgApiClient.h

@@ -23,6 +23,7 @@ private:
 
   bool getConfigFailed;
   bool postToServerFailed;
+  bool notAvailableOnDashboard = false; // Device not setup on Airgradient cloud dashboard.
 
 public:
   AgApiClient(Stream &stream, Configuration &config);
@@ -33,6 +34,7 @@ public:
   bool postToServer(String data);
   bool isFetchConfigureFailed(void);
   bool isPostToServerFailed(void);
+  bool isNotAvailableOnDashboard(void);
   void setAirGradient(AirGradient *ag);
   bool sendPing(int rssi, int bootCount);
 };

src/AgConfigure.cpp

@@ -372,6 +372,7 @@ bool Configuration::parse(String data, bool isLocal) {
     }
   }
 
+  _ledBarModeChanged = false;
   if (JSON.typeof_(root[jprop_ledBarMode]) == "string") {
     String mode = root[jprop_ledBarMode];
     if (mode == getLedBarModeName(LedBarMode::LedBarModeCO2) ||
@@ -380,6 +381,7 @@ bool Configuration::parse(String data, bool isLocal) {
       String oldMode = jconfig[jprop_ledBarMode];
       if (mode != oldMode) {
         jconfig[jprop_ledBarMode] = mode;
+        _ledBarModeChanged = true;
         changed = true;
       }
     } else {
@@ -559,6 +561,7 @@ bool Configuration::parse(String data, bool isLocal) {
     }
   }
 
+  ledBarBrightnessChanged = false;
   if (JSON.typeof_(root[jprop_ledBarBrightness]) == "number") {
     int value = root[jprop_ledBarBrightness];
     int oldValue = jconfig[jprop_ledBarBrightness];
@@ -628,7 +631,6 @@ bool Configuration::parse(String data, bool isLocal) {
     saveConfig();
     printConfig();
   } else {
-    logInfo("Update ignored due to local unofficial changes");
     if (ledBarTestRequested || co2CalibrationRequested) {
       udpated = true;
     }
@@ -1148,6 +1150,12 @@ void Configuration::setOfflineModeWithoutSave(bool offline) {
   _offlineMode = offline;
 }
 
+bool Configuration::isLedBarModeChanged(void) { 
+  bool changed = _ledBarModeChanged;
+  _ledBarModeChanged = false;
+  return changed;
+}
+
 bool Configuration::isDisplayBrightnessChanged(void) {
   bool changed = displayBrightnessChanged;
   displayBrightnessChanged = false;

src/AgConfigure.h

@@ -18,6 +18,7 @@ private:
   bool displayBrightnessChanged = false;
   String otaNewFirmwareVersion;
   bool _offlineMode = false;
+  bool _ledBarModeChanged = false;
 
   AirGradient* ag;
 
@@ -80,6 +81,7 @@ public:
   bool isOfflineMode(void);
   void setOfflineMode(bool offline);
   void setOfflineModeWithoutSave(bool offline);
+  bool isLedBarModeChanged(void);
 };
 
 #endif /** _AG_CONFIG_H_ */

src/AgOledDisplay.cpp

@@ -330,7 +330,7 @@ void OledDisplay::setBrightness(int percent) {
   }
 }
 
-void OledDisplay::showNewFirmwareVersion(String version) {
+void OledDisplay::showFirmwareUpdateVersion(String version) {
   if (isDisplayOff) {
     return;
   }
@@ -344,7 +344,7 @@ void OledDisplay::showNewFirmwareVersion(String version) {
   } while (DISP()->nextPage());
 }
 
-void OledDisplay::showNewFirmwareUpdating(String percent) {
+void OledDisplay::showFirmwareUpdateProgress(int percent) {
   if (isDisplayOff) {
     return;
   }
@@ -353,11 +353,11 @@ void OledDisplay::showNewFirmwareUpdating(String percent) {
   do {
     DISP()->setFont(u8g2_font_t0_16_tf);
     setCentralText(20, "Firmware Update");
-    setCentralText(50, String("Updating... ") + percent + String("%"));
+    setCentralText(50, String("Updating... ") + String(percent) + String("%"));
   } while (DISP()->nextPage());
 }
 
-void OledDisplay::showNewFirmwareSuccess(String count) {
+void OledDisplay::showFirmwareUpdateSuccess(int count) {
   if (isDisplayOff) {
     return;
   }
@@ -367,11 +367,11 @@ void OledDisplay::showNewFirmwareSuccess(String count) {
     DISP()->setFont(u8g2_font_t0_16_tf);
     setCentralText(20, "Firmware Update");
     setCentralText(40, "Success");
-    setCentralText(60, String("Rebooting... ") + count);
+    setCentralText(60, String("Rebooting... ") + String(count));
   } while (DISP()->nextPage());
 }
 
-void OledDisplay::showNewFirmwareFailed(void) {
+void OledDisplay::showFirmwareUpdateFailed(void) {
   if (isDisplayOff) {
     return;
   }
@@ -380,7 +380,43 @@ void OledDisplay::showNewFirmwareFailed(void) {
   do {
     DISP()->setFont(u8g2_font_t0_16_tf);
     setCentralText(20, "Firmware Update");
-    setCentralText(40, "Failed");
-    setCentralText(60, String("Retry after 24h"));
+    setCentralText(40, "fail, will retry");
+    // setCentralText(60, "will retry");
+  } while (DISP()->nextPage());
+}
+
+void OledDisplay::showFirmwareUpdateSkipped(void) {
+  if (isDisplayOff) {
+    return;
+  }
+
+  DISP()->firstPage();
+  do {
+    DISP()->setFont(u8g2_font_t0_16_tf);
+    setCentralText(20, "Firmware Update");
+    setCentralText(40, "skipped");
+  } while (DISP()->nextPage());
+}
+
+void OledDisplay::showFirmwareUpdateUpToDate(void) {
+  if (isDisplayOff) {
+    return;
+  }
+
+  DISP()->firstPage();
+  do {
+    DISP()->setFont(u8g2_font_t0_16_tf);
+    setCentralText(20, "Firmware Update");
+    setCentralText(40, "up to date");
+  } while (DISP()->nextPage());
+}
+
+void OledDisplay::showRebooting(void) {
+  DISP()->firstPage();
+  do {
+    DISP()->setFont(u8g2_font_t0_16_tf);
+    // setCentralText(20, "Firmware Update");
+    setCentralText(40, "Rebooting...");
+    // setCentralText(60, String("Retry after 24h"));
   } while (DISP()->nextPage());
 }

src/AgOledDisplay.h

@@ -36,10 +36,13 @@ public:
   void showDashboard(void);
   void showDashboard(const char *status);
   void setBrightness(int percent);
-  void showNewFirmwareVersion(String version);
-  void showNewFirmwareUpdating(String percent);
-  void showNewFirmwareSuccess(String count);
-  void showNewFirmwareFailed(void);
+  void showFirmwareUpdateVersion(String version);
+  void showFirmwareUpdateProgress(int percent);
+  void showFirmwareUpdateSuccess(int count);
+  void showFirmwareUpdateFailed(void);
+  void showFirmwareUpdateSkipped(void);
+  void showFirmwareUpdateUpToDate(void);
+  void showRebooting(void);
 };
 
 #endif /** _AG_OLED_DISPLAY_H_ */

src/AgValue.cpp

@@ -173,6 +173,7 @@ String Measurements::toString(bool localServer, AgFirmwareMode fwMode, int rssi,
       root["noxRaw"] = this->NOxRaw;
     }
   }
+  root["boot"] = bootCount;
   root["bootCount"] = bootCount;
 
   if (localServer) {

src/AgValue.h

@@ -69,7 +69,6 @@ public:
   int countPosition;
   const int targetCount = 20;
   int bootCount;
-  int otaBootCount;
 
   String toString(bool isLocal, AgFirmwareMode fwMode, int rssi, void* _ag, void* _config);
 };

src/AgWiFiConnector.cpp

@@ -53,6 +53,7 @@ bool WifiConnector::connect(void) {
   WIFI()->setAPCallback([this](WiFiManager *obj) { _wifiApCallback(); });
   WIFI()->setSaveConfigCallback([this]() { _wifiSaveConfig(); });
   WIFI()->setSaveParamsCallback([this]() { _wifiSaveParamCallback(); });
+  WIFI()->setConfigPortalTimeoutCallback([this](){});
   if (ag->isOne()) {
     disp.setText("Connecting to", "WiFi", "...");
   } else {
@@ -245,6 +246,7 @@ void WifiConnector::_wifiSaveParamCallback(void) {
 bool WifiConnector::_wifiConfigPortalActive(void) {
   return WIFI()->getConfigPortalActive();
 }
+void WifiConnector::_wifiTimeoutCallback(void) { connectorTimeout = true; }
 #endif
 /**
  * @brief Process WiFiManager connection
@@ -352,3 +354,11 @@ bool WifiConnector::hasConfigurated(void) {
   }
   return true;
 }
+
+/**
+ * @brief Get WiFi connection porttal timeout.
+ * 
+ * @return true 
+ * @return false 
+ */
+bool WifiConnector::isConfigurePorttalTimeout(void) { return connectorTimeout; }

src/AgWiFiConnector.h

@@ -24,6 +24,7 @@ private:
   bool hasConfig;
   uint32_t lastRetry;
   bool hasPortalConfig = false;
+  bool connectorTimeout = false;
 
   bool wifiClientConnected(void);
 
@@ -44,6 +45,7 @@ public:
   void _wifiSaveConfig(void);
   void _wifiSaveParamCallback(void);
   bool _wifiConfigPortalActive(void);
+  void _wifiTimeoutCallback(void);
 #endif
   void _wifiProcess();
   bool isConnected(void);
@@ -51,6 +53,7 @@ public:
   int RSSI(void);
   String localIpStr(void);
   bool hasConfigurated(void);
+  bool isConfigurePorttalTimeout(void);
 };
 
 #endif /** _AG_WIFI_CONNECTOR_H_ */

src/Main/LedBar.cpp

@@ -64,7 +64,7 @@ void LedBar::setColor(uint8_t red, uint8_t green, uint8_t blue, int ledNum) {
  *
  * @param brightness Brightness (0 - 100)%
  */
-void LedBar::setBrighness(uint8_t brightness) {
+void LedBar::setBrightness(uint8_t brightness) {
   if (this->isBegin() == false) {
     return;
   }

src/Main/LedBar.h

@@ -19,7 +19,7 @@ public:
   void begin(void);
   void setColor(uint8_t red, uint8_t green, uint8_t blue, int ledNum);
   void setColor(uint8_t red, uint8_t green, uint8_t blue);
-  void setBrighness(uint8_t brightness);
+  void setBrightness(uint8_t brightness);
   int getNumberOfLeds(void);
   void show(void);
   void clear(void);