Merge pull request #303 from airgradienthq/fix/ce-tvoc

Fix incorrect TVOC / NOx values when when network option is cellular

Author: samuelbles07

examples/OneOpenAir/OneOpenAir.ino

@@ -117,7 +117,7 @@ enum NetworkOption {
 };
 NetworkOption networkOption;
 TaskHandle_t handleNetworkTask = NULL;
-static bool otaInProgress = false;
+static bool firmwareUpdateInProgress = false;
 
 static uint32_t factoryBtnPressTime = 0;
 static AgFirmwareMode fwMode = FW_MODE_I_9PSL;
@@ -318,8 +318,8 @@ void loop() {
   // Schedule to feed external watchdog
   watchdogFeedSchedule.run();
 
-  if (otaInProgress) {
-    // OTA currently in progress, temporarily disable running sensor schedules
+  if (firmwareUpdateInProgress) {
+    // Firmare update currently in progress, temporarily disable running sensor schedules
     delay(10000);
     return;
   }
@@ -562,43 +562,43 @@ void checkForFirmwareUpdate(void) {
     agOta = new AirgradientOTACellular(cellularCard);
   }
 
-  // Indicate main task that ota is performing
-  Serial.println("Check for firmware update, disabling main task");
-  otaInProgress = true;
-  if (configuration.hasSensorSGP && networkOption == UseCellular) {
-    // Only for cellular because it can disturb i2c line
-    Serial.println("Disable SGP41 task for cellular OTA");
-    ag->sgp41.end();
-  }
+  // Indicate main task that firmware update is in progress
+  firmwareUpdateInProgress = true;
 
   agOta->setHandlerCallback(otaHandlerCallback);
   agOta->updateIfAvailable(ag->deviceId().c_str(), GIT_VERSION);
 
-  // Only goes to this line if OTA is not success
+  // Only goes to this line if firmware update is not success
   // Handled by otaHandlerCallback
 
-  otaInProgress = false;
-  if (configuration.hasSensorSGP && networkOption == UseCellular) {
-    // Re-start SGP41 task
-    if (!sgp41Init()) {
-      Serial.println("Failed re-start SGP41 task");
-    }
-  }
+  // Indicate main task that firmware update finish
+  firmwareUpdateInProgress = false;
 
   delete agOta;
   Serial.println();
 }
 
 void otaHandlerCallback(AirgradientOTA::OtaResult result, const char *msg) {
   switch (result) {
-  case AirgradientOTA::Starting:
+  case AirgradientOTA::Starting: {
+    Serial.println("Firmware update starting...");
+    if (configuration.hasSensorSGP && networkOption == UseCellular) {
+      // Temporary pause SGP41 task while cellular firmware update is in progress
+      ag->sgp41.pause();
+    }
     displayExecuteOta(result, fwNewVersion, 0);
     break;
+  }
   case AirgradientOTA::InProgress:
     Serial.printf("OTA progress: %s\n", msg);
     displayExecuteOta(result, "", std::stoi(msg));
     break;
   case AirgradientOTA::Failed:
+      displayExecuteOta(result, "", 0);
+      if (configuration.hasSensorSGP && networkOption == UseCellular) {
+        ag->sgp41.resume();
+      }
+      break;
   case AirgradientOTA::Skipped:
   case AirgradientOTA::AlreadyUpToDate:
     displayExecuteOta(result, "", 0);
@@ -665,7 +665,11 @@ static void displayExecuteOta(AirgradientOTA::OtaResult result, String msg, int
       }
       delay(1000);
     }
-    oledDisplay.setAirGradient(0);
+
+    if (ag->isOne()) {
+      oledDisplay.setAirGradient(0);
+      oledDisplay.setBrightness(0);
+    }
     break;
   }
   default:
@@ -1548,10 +1552,7 @@ void restartIfCeClientIssueOverTwoHours() {
 
 void networkingTask(void *args) {
   // OTA check on boot
-#ifdef ESP8266
-  // ota not supported
-#else
-  // because cellular it takes too long, watchdog triggered
+#ifndef ESP8266
   checkForFirmwareUpdate();
   checkForUpdateSchedule.update(); 
 #endif

src/Libraries/airgradient-ota

@@ -131,6 +131,22 @@ void Sgp41::handle(void) {
 }
 
 #else
+
+void Sgp41::pause() {
+  onPause = true;
+  Serial.println("Pausing SGP41 handler task");
+  // Set latest value to invalid
+  tvocRaw = utils::getInvalidVOC();
+  tvoc = utils::getInvalidVOC();
+  noxRaw = utils::getInvalidNOx();
+  nox = utils::getInvalidNOx();
+} 
+
+void Sgp41::resume() {
+  onPause = false;
+  Serial.println("Resuming SGP41 handler task");
+}
+
 /**
  * @brief Handle the sensor conditioning and run time udpate value, This method
  * must not call, it's called on private task
@@ -152,6 +168,11 @@ void Sgp41::_handle(void) {
   uint16_t srawVoc, srawNox;
   for (;;) {
     vTaskDelay(pdMS_TO_TICKS(1000));
+
+    if (onPause) {
+      continue;
+    }
+
     if (getRawSignal(srawVoc, srawNox)) {
       tvocRaw = srawVoc;
       noxRaw = srawNox;

src/Sgp41/Sgp41.cpp

@@ -18,6 +18,10 @@ class Sgp41 {
   bool begin(TwoWire &wire, Stream &stream);
   void handle(void);
 #else
+  /* pause _handle task to read sensor */
+  void pause();
+  /* resume _handle task to read sensor */
+  void resume();
   void _handle(void);
 #endif
   void end(void);
@@ -32,6 +36,7 @@ class Sgp41 {
   int getTvocLearningOffset(void);
 
 private:
+  bool onPause = false;
   bool onConditioning = true;
   bool ready = false;
   bool _isBegin = false;