Prepare release 3.3.8

if pms value invalid show the channel

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "src/Libraries/airgradient-client"]
 	path = src/Libraries/airgradient-client
-	url = git@github.com:airgradienthq/airgradient-client.git
+	url = ../../airgradienthq/airgradient-client.git
 [submodule "src/Libraries/airgradient-ota"]
 	path = src/Libraries/airgradient-ota
-	url = git@github.com:airgradienthq/airgradient-ota.git
+	url = ../../airgradienthq/airgradient-ota.git

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;
@@ -143,6 +143,7 @@ static void updatePm(void);
 static void sendDataToServer(void);
 static void tempHumUpdate(void);
 static void co2Update(void);
+static void printMeasurements();
 static void mdnsInit(void);
 static void createMqttTask(void);
 static void initMqtt(void);
@@ -172,6 +173,7 @@ AgSchedule tvocSchedule(SENSOR_TVOC_UPDATE_INTERVAL, updateTvoc);
 AgSchedule watchdogFeedSchedule(60000, wdgFeedUpdate);
 AgSchedule checkForUpdateSchedule(FIRMWARE_CHECK_FOR_UPDATE_MS, checkForFirmwareUpdate);
 AgSchedule networkSignalCheckSchedule(10000, networkSignalCheck);
+AgSchedule printMeasurementsSchedule(6000, printMeasurements);
 
 void setup() {
   /** Serial for print debug message */
@@ -210,7 +212,7 @@ void setup() {
   oledDisplay.setAirGradient(ag);
   stateMachine.setAirGradient(ag);
   wifiConnector.setAirGradient(ag);
-  openMetrics.setAirGradient(ag, agClient);
+  openMetrics.setAirGradient(ag);
   localServer.setAirGraident(ag);
   measurements.setAirGradient(ag);
 
@@ -218,9 +220,6 @@ void setup() {
   boardInit();
   setMeasurementMaxPeriod();
 
-  // Comment below line to disable debug measurement readings
-  measurements.setDebug(true);
-
   bool connectToNetwork = true;
   if (ag->isOne()) { // Offline mode only available for indoor monitor
     /** Show message confirm offline mode, should me perform if LED bar button
@@ -271,6 +270,7 @@ void setup() {
 
     Serial.println("Display brightness: " + String(configuration.getDisplayBrightness()));
     oledDisplay.setBrightness(configuration.getDisplayBrightness());
+    delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
   }
 
 
@@ -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;
   }
@@ -352,7 +352,7 @@ void loop() {
       static bool pmsConnected = false;
       if (pmsConnected != ag->pms5003.connected()) {
         pmsConnected = ag->pms5003.connected();
-        Serial.printf("PMS sensor %s ", pmsConnected?"connected":"removed");
+        Serial.printf("PMS sensor %s \n", pmsConnected?"connected":"removed");
       }
     }
   } else {
@@ -364,6 +364,9 @@ void loop() {
     }
   }
 
+  /* Run measurement schedule */
+  printMeasurementsSchedule.run();
+
   /** factory reset handle */
   factoryConfigReset();
 
@@ -385,6 +388,10 @@ static void co2Update(void) {
   }
 }
 
+void printMeasurements() {
+  measurements.printCurrentAverage();
+}
+
 static void mdnsInit(void) {
   if (!MDNS.begin(localServer.getHostname().c_str())) {
     Serial.println("Init mDNS failed");
@@ -555,6 +562,11 @@ static bool sgp41Init(void) {
 }
 
 void checkForFirmwareUpdate(void) {
+  if (configuration.isCloudConnectionDisabled()) {
+    Serial.println("Cloud connection is disabled, skip firmware update");
+    return;
+  }
+
   AirgradientOTA *agOta;
   if (networkOption == UseWifi) {
     agOta = new AirgradientOTAWifi;
@@ -562,28 +574,25 @@ 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
+  String httpDomain = configuration.getHttpDomain();
+  if (httpDomain != "") {
+    Serial.printf("httpDomain configuration available, start OTA with custom domain\n",
+                  httpDomain.c_str());
+    agOta->updateIfAvailable(ag->deviceId().c_str(), GIT_VERSION, httpDomain.c_str());
+  } else {
+    agOta->updateIfAvailable(ag->deviceId().c_str(), GIT_VERSION);
+  }
+
+  // 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();
@@ -591,14 +600,25 @@ void checkForFirmwareUpdate(void) {
 
 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 +685,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:
@@ -977,6 +1001,9 @@ void initializeNetwork() {
     ESP.restart();
   }
 
+  // Provide openmetrics to have access to last transmission result 
+  openMetrics.setAirgradientClient(agClient);
+
   if (networkOption == UseCellular) {
     // Disabling it again
     agSerial->setDebug(false);
@@ -1402,13 +1429,17 @@ void postUsingCellular(bool forcePost) {
 
   // Post success, remove the data that previously sent from queue
   xSemaphoreTake(mutexMeasurementCycleQueue, portMAX_DELAY);
-  measurementCycleQueue.erase(measurementCycleQueue.begin(),
-                              measurementCycleQueue.begin() + queueSize);
 
   if (measurementCycleQueue.capacity() > RESERVED_MEASUREMENT_CYCLE_CAPACITY) {
     Serial.println("measurementCycleQueue capacity more than reserved space, resizing..");
-    measurementCycleQueue.resize(RESERVED_MEASUREMENT_CYCLE_CAPACITY);
+    std::vector<Measurements::Measures> tmp;
+    tmp.reserve(RESERVED_MEASUREMENT_CYCLE_CAPACITY);
+    measurementCycleQueue.swap(tmp);
+  } else {
+    // If not more than the capacity, then just clear all the values
+    measurementCycleQueue.clear();
   }
+
   xSemaphoreGive(mutexMeasurementCycleQueue);
 }
 
@@ -1547,30 +1578,29 @@ void restartIfCeClientIssueOverTwoHours() {
 }
 
 void networkingTask(void *args) {
-  // OTA check on boot
-#ifdef ESP8266
-  // ota not supported
-#else
-  // because cellular it takes too long, watchdog triggered
-  checkForFirmwareUpdate();
-  checkForUpdateSchedule.update(); 
+  // If cloud connection enabled, run first transmission to server at boot
+  if (configuration.isCloudConnectionDisabled() == false) {
+    // OTA check on boot
+#ifndef ESP8266
+    checkForFirmwareUpdate();
+    checkForUpdateSchedule.update();
 #endif
 
-  // Because cellular interval is longer, needs to send first measures cycle on
-  // boot to indicate that its online
-  if (networkOption == UseCellular) {
-    Serial.println("Prepare first measures cycle to send on boot for 20s");
-    delay(20000);
-    networkSignalCheck();
-    newMeasurementCycle();
-    postUsingCellular(true);
-    measurementSchedule.update();
+    // Because cellular interval is longer, needs to send first measures cycle on
+    // boot to indicate that its online
+    if (networkOption == UseCellular) {
+      Serial.println("Prepare first measures cycle to send on boot for 20s");
+      delay(20000);
+      networkSignalCheck();
+      newMeasurementCycle();
+      postUsingCellular(true);
+      measurementSchedule.update();
+    }
+    // Reset scheduler
+    configSchedule.update();
+    transmissionSchedule.update();
   }
 
-  // Reset scheduler
-  configSchedule.update();
-  transmissionSchedule.update();
-
   while (1) {
     // Handle reconnection based on mode
     if (networkOption == UseWifi) {
@@ -1625,7 +1655,7 @@ void networkingTask(void *args) {
     // If connection to AirGradient server disable don't run config and transmission schedule
     if (configuration.isCloudConnectionDisabled()) {
       delay(1000);
-      return;
+      continue;
     }
 
     // Run scheduler

examples/OneOpenAir/OpenMetrics.cpp

@@ -6,8 +6,11 @@ OpenMetrics::OpenMetrics(Measurements &measure, Configuration &config,
 
 OpenMetrics::~OpenMetrics() {}
 
-void OpenMetrics::setAirGradient(AirGradient *ag, AirgradientClient *client) { 
+void OpenMetrics::setAirGradient(AirGradient *ag) { 
   this->ag = ag; 
+}
+
+void OpenMetrics::setAirgradientClient(AirgradientClient *client) {
   this->agClient = client;
 }
 

examples/OneOpenAir/OpenMetrics.h

@@ -19,7 +19,8 @@ public:
   OpenMetrics(Measurements &measure, Configuration &config,
               WifiConnector &wifiConnector);
   ~OpenMetrics();
-  void setAirGradient(AirGradient *ag, AirgradientClient *client);
+  void setAirGradient(AirGradient *ag);
+  void setAirgradientClient(AirgradientClient *client);
   const char *getApiContentType(void);
   const char* getApi(void);
   String getPayload(void);

library.properties

@@ -1,5 +1,5 @@
 name=AirGradient Air Quality Sensor
-version=3.3.5
+version=3.3.8
 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/AgValue.cpp

@@ -5,7 +5,7 @@
 #include <cmath>
 #include <sstream>
 
-#define json_prop_pmFirmware     "firmware"
+#define json_prop_pmFirmware "firmware"
 #define json_prop_pm01Ae "pm01"
 #define json_prop_pm25Ae "pm02"
 #define json_prop_pm10Ae "pm10"
@@ -33,7 +33,7 @@ Measurements::Measurements(Configuration &config) : config(config) {
 #ifndef ESP8266
   _resetReason = (int)ESP_RST_UNKNOWN;
 #endif
-  
+
   /* Set invalid value for each measurements as default value when initialized*/
   _temperature[0].update.avg = utils::getInvalidTemperature();
   _temperature[1].update.avg = utils::getInvalidTemperature();
@@ -51,7 +51,7 @@ Measurements::Measurements(Configuration &config) : config(config) {
   _pm_05_pc[1].update.avg = utils::getInvalidPmValue();
   _pm_5_pc[0].update.avg = utils::getInvalidPmValue();
   _pm_5_pc[1].update.avg = utils::getInvalidPmValue();
-  
+
   _pm_01[0].update.avg = utils::getInvalidPmValue();
   _pm_01_sp[0].update.avg = utils::getInvalidPmValue();
   _pm_01_pc[0].update.avg = utils::getInvalidPmValue();
@@ -76,6 +76,86 @@ Measurements::Measurements(Configuration &config) : config(config) {
 
 void Measurements::setAirGradient(AirGradient *ag) { this->ag = ag; }
 
+void Measurements::printCurrentAverage() {
+  Serial.println();
+  if (config.hasSensorS8) {
+    if (utils::isValidCO2(_co2.update.avg)) {
+      Serial.printf("CO2 = %.2f ppm\n", _co2.update.avg);
+    } else {
+      Serial.printf("CO2 = -\n");
+    }
+  }
+
+  if (config.hasSensorSHT) {
+    if (utils::isValidTemperature(_temperature[0].update.avg)) {
+      Serial.printf("Temperature = %.2f C\n", _temperature[0].update.avg);
+    } else {
+      Serial.printf("Temperature = -\n");
+    }
+    if (utils::isValidHumidity(_humidity[0].update.avg)) {
+      Serial.printf("Relative Humidity = %.2f\n", _humidity[0].update.avg);
+    } else {
+      Serial.printf("Relative Humidity = -\n");
+    }
+  }
+
+  if (config.hasSensorSGP) {
+    if (utils::isValidVOC(_tvoc.update.avg)) {
+      Serial.printf("TVOC Index = %.1f\n", _tvoc.update.avg);
+    } else {
+      Serial.printf("TVOC Index = -\n");
+    }
+    if (utils::isValidVOC(_tvoc_raw.update.avg)) {
+      Serial.printf("TVOC Raw = %.1f\n", _tvoc_raw.update.avg);
+    } else {
+      Serial.printf("TVOC Raw = -\n");
+    }
+    if (utils::isValidNOx(_nox.update.avg)) {
+      Serial.printf("NOx Index = %.1f\n", _nox.update.avg);
+    } else {
+      Serial.printf("NOx Index = -\n");
+    }
+    if (utils::isValidNOx(_nox_raw.update.avg)) {
+      Serial.printf("NOx Raw = %.1f\n", _nox_raw.update.avg);
+    } else {
+      Serial.printf("NOx Raw = -\n");
+    }
+  }
+
+  if (config.hasSensorPMS1) {
+    printCurrentPMAverage(1);
+    if (!config.hasSensorSHT) {
+      if (utils::isValidTemperature(_temperature[0].update.avg)) {
+        Serial.printf("[1] Temperature = %.2f C\n", _temperature[0].update.avg);
+      } else {
+        Serial.printf("[1] Temperature = -\n");
+      }
+      if (utils::isValidHumidity(_humidity[0].update.avg)) {
+        Serial.printf("[1] Relative Humidity = %.2f\n", _humidity[0].update.avg);
+      } else {
+        Serial.printf("[1] Relative Humidity = -\n");
+      }
+    }
+  }
+  if (config.hasSensorPMS2) {
+    printCurrentPMAverage(2);
+    if (!config.hasSensorSHT) {
+      if (utils::isValidTemperature(_temperature[1].update.avg)) {
+        Serial.printf("[2] Temperature = %.2f C\n", _temperature[1].update.avg);
+      } else {
+        Serial.printf("[2] Temperature = -\n");
+      }
+      if (utils::isValidHumidity(_humidity[1].update.avg)) {
+        Serial.printf("[2] Relative Humidity = %.2f\n", _humidity[1].update.avg);
+      } else {
+        Serial.printf("[2] Relative Humidity = -\n");
+      }
+    }
+  }
+
+  Serial.println();
+}
+
 void Measurements::maxPeriod(MeasurementType type, int max) {
   switch (type) {
   case Temperature:
@@ -570,6 +650,77 @@ String Measurements::measurementTypeStr(MeasurementType type) {
   return str;
 }
 
+void Measurements::printCurrentPMAverage(int ch) {
+  int idx = ch - 1;
+
+  if (utils::isValidPm(_pm_01[idx].update.avg)) {
+    Serial.printf("[%d] Atmospheric PM 1.0 = %.2f ug/m3\n", ch, _pm_01[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Atmospheric PM 1.0 = -\n", ch);
+  }
+  if (utils::isValidPm(_pm_25[idx].update.avg)) {
+    Serial.printf("[%d] Atmospheric PM 2.5 = %.2f ug/m3\n", ch, _pm_25[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Atmospheric PM 2.5 = -\n", ch);
+  }
+  if (utils::isValidPm(_pm_10[idx].update.avg)) {
+    Serial.printf("[%d] Atmospheric PM 10 = %.2f ug/m3\n", ch, _pm_10[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Atmospheric PM 10 = -\n", ch);
+  }
+  if (utils::isValidPm(_pm_01_sp[idx].update.avg)) {
+    Serial.printf("[%d] Standard Particle PM 1.0 = %.2f ug/m3\n", ch, _pm_01_sp[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Standard Particle PM 1.0 = -\n", ch);
+  }
+  if (utils::isValidPm(_pm_25_sp[idx].update.avg)) {
+    Serial.printf("[%d] Standard Particle PM 2.5 = %.2f ug/m3\n", ch, _pm_25_sp[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Standard Particle PM 2.5 = -\n", ch);
+  }
+  if (utils::isValidPm(_pm_10_sp[idx].update.avg)) {
+    Serial.printf("[%d] Standard Particle PM 10 = %.2f ug/m3\n", ch, _pm_10_sp[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Standard Particle PM 10 = -\n", ch);
+  }
+  if (utils::isValidPm03Count(_pm_03_pc[idx].update.avg)) {
+    Serial.printf("[%d] Particle Count 0.3 = %.1f\n", ch, _pm_03_pc[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Particle Count 0.3 = -\n", ch);
+  }
+  if (utils::isValidPm03Count(_pm_05_pc[idx].update.avg)) {
+    Serial.printf("[%d] Particle Count 0.5 = %.1f\n", ch, _pm_05_pc[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Particle Count 0.5 = -\n", ch);
+  }
+  if (utils::isValidPm03Count(_pm_01_pc[idx].update.avg)) {
+    Serial.printf("[%d] Particle Count 1.0 = %.1f\n", ch, _pm_01_pc[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Particle Count 1.0 = -\n", ch);
+  }
+  if (utils::isValidPm03Count(_pm_25_pc[idx].update.avg)) {
+    Serial.printf("[%d] Particle Count 2.5 = %.1f\n", ch, _pm_25_pc[idx].update.avg);
+  } else {
+    Serial.printf("[%d] Particle Count 2.5 = -\n", ch);
+  }
+
+  if (_pm_5_pc[idx].listValues.empty() == false) {
+    if (utils::isValidPm03Count(_pm_5_pc[idx].update.avg)) {
+      Serial.printf("[%d] Particle Count 5.0 = %.1f\n", ch, _pm_5_pc[idx].update.avg);
+    } else {
+      Serial.printf("[%d] Particle Count 5.0 = -\n", ch);
+    }
+  }
+
+  if (_pm_10_pc[idx].listValues.empty() == false) {
+    if (utils::isValidPm03Count(_pm_10_pc[idx].update.avg)) {
+      Serial.printf("[%d] Particle Count 10 = %.1f\n", ch, _pm_10_pc[idx].update.avg);
+    } else {
+      Serial.printf("[%d] Particle Count 10 = -\n", ch);
+    }
+  }
+}
+
 void Measurements::validateChannel(int ch) {
   if (ch != 1 && ch != 2) {
     Serial.printf("ERROR! Channel %d is undefined. Only channel 1 or 2 is the optional value!", ch);

src/AgValue.h

@@ -88,6 +88,8 @@ public:
     PM10_PC, // Particle 10 count
   };
 
+  void printCurrentAverage();
+
   /**
    * @brief Set each MeasurementType maximum period length for moving average
    *
@@ -258,6 +260,8 @@ private:
    */
   void validateChannel(int ch);
 
+  void printCurrentPMAverage(int ch);
+
   JSONVar buildOutdoor(bool localServer, AgFirmwareMode fwMode);
   JSONVar buildIndoor(bool localServer);
   JSONVar buildPMS(int ch, bool allCh, bool withTempHum, bool compensate);

src/AirGradient.h

@@ -15,7 +15,7 @@
 #include "Main/utils.h"
 
 #ifndef GIT_VERSION
-#define GIT_VERSION "3.3.5-snap"
+#define GIT_VERSION "3.3.8-snap"
 #endif
 
 

src/Sgp41/Sgp41.cpp

@@ -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.h

@@ -18,6 +18,10 @@ public:
   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 @@ public:
   int getTvocLearningOffset(void);
 
 private:
+  bool onPause = false;
   bool onConditioning = true;
   bool ready = false;
   bool _isBegin = false;