Merge pull request #345 from airgradienthq/feat/print-s8-info

Print S8 sensor information

.github/workflows/check.yml

@@ -1,5 +1,36 @@
 on: [push, pull_request]
 jobs:
+  trailing-whitespace:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4.2.2
+        with:
+          fetch-depth: 0
+      - name: Check for trailing whitespace
+        run: |
+          set -u
+
+          # Don't enforce checks on vendored libraries.
+          readonly EXCLUDED_DIR='src/Libraries'
+
+          has_trailing_whitespace=false
+
+          while read -r line; do
+            if grep \
+              "\s$" \
+              --line-number \
+              --with-filename \
+              --binary-files=without-match \
+              "${line}"; then
+              has_trailing_whitespace=true
+            fi
+          done < <(git ls-files | grep --invert-match "^${EXCLUDED_DIR}/")
+
+          if [ "$has_trailing_whitespace" = true ]; then
+            echo "ERROR: Found trailing whitespace"
+            exit 1
+          fi
+
   compile:
     strategy:
       fail-fast: false

README.md

@@ -20,13 +20,32 @@ Make sure you have exactly the versions of libraries and boards installed as des
 
 If you have an older version of the AirGradient PCB not mentioned in the example files, please downgrade this library to version 2.4.15 to support these legacy boards.
 
+### Release Process
+
+Releases published on GitHub are **not immediately deployed to all devices in the market**. Each release first goes through internal testing, including limited deployments in select locations to verify stability and functionality.
+
+If the tests pass, the firmware is then made available for:
+- **FOTA (Firmware Over-The-Air) updates** from AirGradient dashboard
+- **Manual flashing** via [Airgradient](https://www.airgradient.com/documentation/firmwares/) website
+
+Each GitHub release note will also include the planned rollout date for wider availability.
+
 ## Help & Support
 
 If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).
 
-## Documentation
+## Development
 
-Local server API documentation is available in [/docs/local-server.md](/docs/local-server.md) and AirGradient server API on [https://api.airgradient.com/public/docs/api/v1/](https://api.airgradient.com/public/docs/api/v1/).
+* See [compilation instructions](/docs/howto-compile.md) for details about how to customize AirGradient's firmware and flash it to your device.
+
+## Over the air (OTA) updates
+
+* See the [OTA Updates documentation](/docs/ota-updates.md) for details about how AirGradient monitors receive over the air updates.
+
+## API documentation
+
+* [Local server API documentation](/docs/local-server.md)
+* [AirGradient Cloud server API documentation](https://api.airgradient.com/public/docs/api/v1/).
 
 ## The following libraries have been integrated into this library for ease of use
 

docs/howto-compile.md

@@ -90,7 +90,7 @@ Choose based on how python installed on your machine. But most user, using `apt`
 
 ## How to contribute
 
-The instructions above are the instructions for how to build an official release of the AirGradient firmware using the Arduino IDE. If you intend to make changes that will you intent to contribute back to the main project, instead of installing the AirGradient library, check out the repo at `Documents/Arduino/libraries` (for Windows and Mac), or `~/Arduino/Libraries` (Linux). If you installed the library, you can remove it from the library manager in the Arduino IDE, or just delete the directory.
+The instructions above are the instructions for how to build an official release of the AirGradient firmware using the Arduino IDE. If you intend to make changes which you plan to contribute back to the main project, instead of installing the AirGradient library, check out the repository at Documents/Arduino/libraries (for Windows and Mac) or ~/Arduino/libraries (for Linux). If you installed the library, you can remove it from the library manager in the Arduino IDE, or just delete the directory.
 
 **NOTE:** When cloning the repository, for version >= 3.3.0 it has submodule, please use `--recursive` flag like this: `git clone --recursive https://github.com/airgradienthq/arduino.git AirGradient_Air_Quality_Sensor`
 
@@ -100,6 +100,3 @@ There are 2 environment options to compile this project, PlatformIO and ArduinoI
 
 - For PlatformIO, it should work out of the box
 - For arduino, files in `src` folder and also from `Examples` can be modified at `Documents/Arduino/libraries` for Windows and Mac, and `~/Arduino/Libraries` for Linux
-
-
-

docs/local-server.md

@@ -106,7 +106,6 @@ Compensated values apply correction algorithms to make the sensor values more ac
     "pm02": {
       "correctionAlgorithm": "epa_2021",
       "slr": {}
-      }
     }
   }
 }

examples/BASIC/BASIC.ino

@@ -294,7 +294,7 @@ static bool sgp41Init(void) {
     configuration.hasSensorSGP = true;
     return true;
   } else {
-    Serial.println("Init SGP41 failuire");
+    Serial.println("Init SGP41 failure");
     configuration.hasSensorSGP = false;
   }
   return false;

examples/DiyProIndoorV3_3/DiyProIndoorV3_3.ino

@@ -351,7 +351,7 @@ static bool sgp41Init(void) {
     configuration.hasSensorSGP = true;
     return true;
   } else {
-    Serial.println("Init SGP41 failuire");
+    Serial.println("Init SGP41 failure");
     configuration.hasSensorSGP = false;
   }
   return false;

examples/DiyProIndoorV4_2/DiyProIndoorV4_2.ino

@@ -374,7 +374,7 @@ static bool sgp41Init(void) {
     configuration.hasSensorSGP = true;
     return true;
   } else {
-    Serial.println("Init SGP41 failuire");
+    Serial.println("Init SGP41 failure");
     configuration.hasSensorSGP = false;
   }
   return false;

examples/OneOpenAir/OneOpenAir.ino

@@ -193,6 +193,7 @@ void setup() {
 
   /** Initialize local configure */
   configuration.begin();
+  configuration.setConfigurationUpdatedCallback(configUpdateHandle);
 
   /** Init I2C */
   Wire.begin(I2C_SDA_PIN, I2C_SCL_PIN);
@@ -270,6 +271,7 @@ void setup() {
 
     Serial.println("Display brightness: " + String(configuration.getDisplayBrightness()));
     oledDisplay.setBrightness(configuration.getDisplayBrightness());
+    delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
   }
 
 
@@ -369,8 +371,11 @@ void loop() {
   /** factory reset handle */
   factoryConfigReset();
 
-  /** check that local configuration changed then do some action */
+  if (configuration.isCommandRequested()) {
-  configUpdateHandle();
+    // Each state machine already has an independent request command check
+    stateMachine.executeCo2Calibration();
+    stateMachine.executeLedBarTest();
+  }
 }
 
 static void co2Update(void) {
@@ -554,7 +559,7 @@ static bool sgp41Init(void) {
     configuration.hasSensorSGP = true;
     return true;
   } else {
-    Serial.println("Init SGP41 failuire");
+    Serial.println("Init SGP41 failure");
     configuration.hasSensorSGP = false;
   }
   return false;
@@ -570,7 +575,7 @@ void checkForFirmwareUpdate(void) {
   if (networkOption == UseWifi) {
     agOta = new AirgradientOTAWifi;
   } else {
-    agOta = new AirgradientOTACellular(cellularCard);
+    agOta = new AirgradientOTACellular(cellularCard, agClient->getICCID());
   }
 
   // Indicate main task that firmware update is in progress
@@ -947,6 +952,8 @@ static void boardInit(void) {
     } else {
       Serial.println("Set S8 AbcDays failure");
     }
+
+    ag->s8.printInformation();
   }
 
   localServer.setFwMode(fwMode);
@@ -1038,10 +1045,17 @@ void initializeNetwork() {
       return;
     }
 
-    // Send data for the first time to AG server at boot 
+    // Send data for the first time to AG server at boot only if postDataToAirgradient is enabled
-    sendDataToAg();
+    if (configuration.isPostDataToAirGradient()) {
+      sendDataToAg();
+    }
   }
 
+  // Skip fetch configuration if configuration control is set to "local" only
+  if (configuration.getConfigurationControl() == ConfigurationControl::ConfigurationControlLocal) {
+    ledBarEnabledUpdate();
+    return;
+  }
 
   std::string config = agClient->httpFetchConfig();
   configSchedule.update();
@@ -1073,8 +1087,8 @@ static void configurationUpdateSchedule(void) {
   }
 
   std::string config = agClient->httpFetchConfig();
-  if (agClient->isLastFetchConfigSucceed() && configuration.parse(config.c_str(), false)) {
+  if (agClient->isLastFetchConfigSucceed()) {
-    configUpdateHandle();
+    configuration.parse(config.c_str(), false);
   }
 }
 
@@ -1083,8 +1097,6 @@ static void configUpdateHandle() {
     return;
   }
 
-  stateMachine.executeCo2Calibration();
-
   String mqttUri = configuration.getMqttBrokerUri();
   if (mqttClient.isCurrentUri(mqttUri) == false) {
     mqttClient.end();
@@ -1156,11 +1168,6 @@ static void configUpdateHandle() {
     if (configuration.isDisplayBrightnessChanged()) {
       oledDisplay.setBrightness(configuration.getDisplayBrightness());
     }
-
-    stateMachine.executeLedBarTest();
-  }
-  else if(ag->isOpenAir()) {
-    stateMachine.executeLedBarTest();
   }
 
   // Update display and led bar notification based on updated configuration
@@ -1428,13 +1435,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);
 }
 
@@ -1655,11 +1666,11 @@ void networkingTask(void *args) {
 
     // Run scheduler
     networkSignalCheckSchedule.run();
-    configSchedule.run();
     transmissionSchedule.run();
+    configSchedule.run();
     checkForUpdateSchedule.run();
 
-    delay(1000);
+    delay(50);
   }
 
   vTaskDelete(handleNetworkTask);

examples/OneOpenAir/OpenMetrics.cpp

@@ -202,14 +202,14 @@ String OpenMetrics::getPayload(void) {
     }
     if (utils::isValidNOx(nox)) {
       add_metric("nox_index",
-                 "The processed Nitrous Oxide (NOx) index as measured by the "
+                 "The processed Nitrogen Oxide (NOx) index as measured by the "
                  "AirGradient SGP sensor",
                  "gauge");
       add_metric_point("", String(nox));
     }
     if (utils::isValidNOx(noxRaw)) {
       add_metric("nox_raw",
-                 "The raw input value to the Nitrous Oxide (NOx) index as "
+                 "The raw input value to the Nitrogen Oxide (NOx) index as "
                  "measured by the AirGradient SGP sensor",
                  "gauge");
       add_metric_point("", String(noxRaw));

library.properties

@@ -1,5 +1,5 @@
 name=AirGradient Air Quality Sensor
-version=3.3.7
+version=3.3.9
 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/AgConfigure.cpp

@@ -456,6 +456,10 @@ bool Configuration::begin(void) {
   return true;
 }
 
+void Configuration::setConfigurationUpdatedCallback(ConfigurationUpdatedCallback_t callback) {
+  _callback = callback;
+}
+
 /**
  * @brief Parse JSON configura string to local configure
  *
@@ -951,15 +955,18 @@ bool Configuration::parse(String data, bool isLocal) {
     changed = true;
   }
 
+  if (ledBarTestRequested || co2CalibrationRequested) {
+    commandRequested = true;
+    updated = true;
+  }
+
   if (changed) {
     updated = true;
     saveConfig();
     printConfig();
-  } else {
+    _callback();
-    if (ledBarTestRequested || co2CalibrationRequested) {
-      updated = true;
-    }
   }
+
   return true;
 }
 
@@ -1159,6 +1166,12 @@ bool Configuration::isUpdated(void) {
   return updated;
 }
 
+bool Configuration::isCommandRequested(void) {
+  bool oldState = this->commandRequested;
+  this->commandRequested = false;
+  return oldState;
+}
+
 String Configuration::jsonTypeInvalidMessage(String name, String type) {
   return "'" + name + "' type is invalid, expecting '" + type + "'";
 }

src/AgConfigure.h

@@ -28,6 +28,7 @@ private:
   bool co2CalibrationRequested;
   bool ledBarTestRequested;
   bool updated;
+  bool commandRequested = false;
   String failedMessage;
   bool _noxLearnOffsetChanged;
   bool _tvocLearningOffsetChanged;
@@ -70,6 +71,9 @@ public:
   bool hasSensorSGP = true;
   bool hasSensorSHT = true;
 
+  typedef void (*ConfigurationUpdatedCallback_t)();
+  void setConfigurationUpdatedCallback(ConfigurationUpdatedCallback_t callback);
+
   bool begin(void);
   bool parse(String data, bool isLocal);
   String toString(void);
@@ -90,6 +94,7 @@ public:
   void reset(void);
   String getModel(void);
   bool isUpdated(void);
+  bool isCommandRequested(void);
   String getFailedMesage(void);
   void setPostToAirGradient(bool enable);
   bool noxLearnOffsetChanged(void);
@@ -116,6 +121,8 @@ public:
   PMCorrection getPMCorrection(void);
   TempHumCorrection getTempCorrection(void);
   TempHumCorrection getHumCorrection(void);
+private:
+  ConfigurationUpdatedCallback_t _callback;
 };
 
 #endif /** _AG_CONFIG_H_ */

src/AgSchedule.cpp

@@ -8,8 +8,8 @@ AgSchedule::~AgSchedule() {}
 void AgSchedule::run(void) {
   uint32_t ms = (uint32_t)(millis() - count);
   if (ms >= period) {
-    handler();
     count = millis();
+    handler();
   }
 }
 

src/AgStateMachine.cpp

@@ -11,8 +11,8 @@
 
 #define RGB_COLOR_R 255, 0, 0   /** Red */
 #define RGB_COLOR_G 0, 255, 0   /** Green */
-#define RGB_COLOR_Y 255, 150, 0 /** Yellow */
+#define RGB_COLOR_Y 255, 255, 0 /** Yellow */
-#define RGB_COLOR_O 255, 40, 0  /** Orange */
+#define RGB_COLOR_O 255, 128, 0 /** Orange */
 #define RGB_COLOR_P 180, 0, 255 /** Purple */
 #define RGB_COLOR_CLEAR 0, 0, 0 /** No color */
 

src/AgValue.cpp

@@ -656,59 +656,59 @@ void Measurements::printCurrentPMAverage(int ch) {
   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");
+    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");
+    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");
+    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");
+    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");
+    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");
+    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");
+    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");
+    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");
+    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");
+    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");
+      Serial.printf("[%d] Particle Count 5.0 = -\n", ch);
     }
   }
 
@@ -716,7 +716,7 @@ void Measurements::printCurrentPMAverage(int ch) {
     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");
+      Serial.printf("[%d] Particle Count 10 = -\n", ch);
     }
   }
 }

src/AirGradient.h

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

src/MqttClient.cpp

@@ -260,13 +260,14 @@ bool MqttClient::connect(String id) {
   connected = false;
   if (user.isEmpty()) {
     logInfo("Connect without auth");
-    if(CLIENT()->connect(id.c_str())) {
+    connected = CLIENT()->connect(id.c_str());
-      connected = true;
+  } else {
-    }
+    logInfo("Connect with auth");
-    return connected;
+    connected = CLIENT()->connect(id.c_str(), user.c_str(), password.c_str());
   }
-  return CLIENT()->connect(id.c_str(), user.c_str(), password.c_str());
+  return connected;
 }
+
 void MqttClient::handle(void) {
   if (isBegin == false) {
     return;

src/S8/S8.cpp

@@ -835,3 +835,13 @@ bool S8::setAbcPeriod(int hours) {
  * @return int Hour
  */
 int S8::getAbcPeriod(void) { return getCalibPeriodABC(); }
+
+
+void S8::printInformation(void) {
+  Serial.print("S8 type ID: 0x");
+  Serial.println(getSensorTypeId(), HEX);
+  Serial.print("S8 serial number: 0x");
+  Serial.println(getSensorId(), HEX);
+  Serial.print("S8 memory map version: 0x");
+  Serial.println(getMemoryMapVersion(), HEX);
+}

src/S8/S8.h

@@ -80,6 +80,7 @@ public:
   bool isBaseLineCalibrationDone(void);
   bool setAbcPeriod(int hours);
   int getAbcPeriod(void);
+  void printInformation(void);
 
 private:
   /** Variables */