Merge pull request #88 from airgradienthq/develop

Bugfix and add example

.github/workflows/check.yml

@@ -0,0 +1,61 @@
+on: [push, pull_request]
+jobs:
+  compile:
+    strategy:
+      fail-fast: false
+      matrix:
+        example:
+          - "BASIC"
+          - "ONE"
+          - "Open_Air"
+          - "TestCO2"
+          - "TestPM"
+          - "TestSht"
+          - "OneOpenAir"
+        fqbn:
+          - "esp8266:esp8266:d1_mini"
+          - "esp32:esp32:esp32c3"
+        include:
+          - fqbn: "esp8266:esp8266:d1_mini"
+            core: "esp8266:esp8266@3.1.2"
+            core_url: "https://arduino.esp8266.com/stable/package_esp8266com_index.json"
+          - fqbn: "esp32:esp32:esp32c3"
+            board_options: "JTAGAdapter=default,CDCOnBoot=cdc,PartitionScheme=default,CPUFreq=160,FlashMode=qio,FlashFreq=80,FlashSize=4M,UploadSpeed=921600,DebugLevel=verbose,EraseFlash=none"
+            core: "esp32:esp32@2.0.11"
+        exclude:
+          - example: "BASIC"
+            fqbn: "esp32:esp32:esp32c3"
+          - example: "ONE"
+            fqbn: "esp8266:esp8266:d1_mini"
+          - example: "Open_Air"
+            fqbn: "esp8266:esp8266:d1_mini"
+          - example: "OneOpenAir"
+            fqbn: "esp8266:esp8266:d1_mini"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run:
+          curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh |
+          sh -s 0.35.3
+      - run: bin/arduino-cli --verbose core install '${{ matrix.core }}'
+          --additional-urls '${{ matrix.core_url }}'
+      - run: bin/arduino-cli --verbose lib install
+          WiFiManager@2.0.16-rc.2
+          Arduino_JSON@0.2.0
+          U8g2@2.34.22
+      # In some cases, actions/checkout@v4 will check out a detached HEAD; for
+      # example, this happens on pull request events, where an hypothetical
+      # PR merge commit is checked out. This tends to confuse
+      # `arduino-cli lib install --git-url`, making it fail with errors such as:
+      #   Error installing Git Library: Library install failed: object not found
+      # Create and check out a dummy branch to work around this issue.
+      - run: git checkout -b check
+      - run: bin/arduino-cli --verbose lib install --git-url .
+        env:
+          ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL: "true"
+      - run: bin/arduino-cli --verbose compile 'examples/${{ matrix.example }}'
+          --fqbn '${{ matrix.fqbn }}' --board-options '${{ matrix.board_options }}'
+      # TODO: at this point it would be a good idea to run some smoke tests on
+      # the resulting image (e.g. that it boots successfully and sends metrics)
+      # but that would either require a high fidelity device emulator, or a
+      # "hardware lab" runner that is directly connected to a relevant device.

.gitignore

@@ -0,0 +1,3 @@
+*.DS_Store
+build
+.vscode

README.md

@@ -34,8 +34,7 @@ If you have any questions or problems, check out [our forum](https://forum.airgr
 - [Sensirion Gas Index Algorithm](https://github.com/Sensirion/arduino-gas-index-algorithm)
 - [Sensirion Core](https://github.com/Sensirion/arduino-core/)
 - [Sensirion I2C SGP41](https://github.com/Sensirion/arduino-i2c-sgp41)
-- [Sensirion I2C SHT4x](https://github.com/Sensirion/arduino-i2c-sht4x)
-- [PMS](https://github.com/fu-hsi/pms)
+- [Sensirion I2C SHT](https://github.com/Sensirion/arduino-sht)
 
 ## License
 CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License

examples/BASIC/BASIC.ino

@@ -0,0 +1,759 @@
+/*
+This is the code for the AirGradient DIY BASIC Air Quality Monitor with an D1
+ESP8266 Microcontroller.
+
+It is an air quality monitor for PM2.5, CO2, Temperature and Humidity with a
+small display and can send data over Wifi.
+
+Open source air quality monitors and kits are available:
+Indoor Monitor: https://www.airgradient.com/indoor/
+Outdoor Monitor: https://www.airgradient.com/outdoor/
+
+Build Instructions:
+https://www.airgradient.com/documentation/diy-v4/
+
+Following libraries need to be installed:
+“WifiManager by tzapu, tablatronix” tested with version 2.0.16-rc.2
+"Arduino_JSON" by Arduino version 0.2.0
+"U8g2" by oliver version 2.34.22
+
+Please make sure you have esp8266 board manager installed. Tested with
+version 3.1.2.
+
+Set board to "LOLIN(WEMOS) D1 R2 & mini"
+
+Configuration parameters, e.g. Celsius / Fahrenheit or PM unit (US AQI vs ug/m3)
+can be set through the AirGradient dashboard.
+
+If you have any questions please visit our forum at
+https://forum.airgradient.com/
+
+CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
+
+*/
+
+#include <AirGradient.h>
+#include <Arduino_JSON.h>
+#include <ESP8266HTTPClient.h>
+#include <ESP8266WiFi.h>
+#include <WiFiClient.h>
+#include <WiFiManager.h>
+
+#define WIFI_CONNECT_COUNTDOWN_MAX 180       /** sec */
+#define WIFI_CONNECT_RETRY_MS 10000          /** ms */
+#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_SYNC_INTERVAL 60000           /** ms */
+#define SENSOR_CO2_CALIB_COUNTDOWN_MAX 5     /** sec */
+#define SENSOR_TVOC_UPDATE_INTERVAL 1000     /** ms */
+#define SENSOR_CO2_UPDATE_INTERVAL 5000      /** ms */
+#define SENSOR_PM_UPDATE_INTERVAL 5000       /** ms */
+#define SENSOR_TEMP_HUM_UPDATE_INTERVAL 2000 /** ms */
+#define DISPLAY_DELAY_SHOW_CONTENT_MS 2000   /** ms */
+#define WIFI_HOTSPOT_PASSWORD_DEFAULT                                          \
+  "cleanair" /** default WiFi AP password                                      \
+              */
+
+/**
+ * @brief Use use LED bar state
+ */
+typedef enum {
+  UseLedBarOff, /** Don't use LED bar */
+  UseLedBarPM,  /** Use LED bar for PMS */
+  UseLedBarCO2, /** Use LED bar for CO2 */
+} UseLedBar;
+
+/**
+ * @brief Schedule handle with timing period
+ *
+ */
+class AgSchedule {
+public:
+  AgSchedule(int period, void (*handler)(void))
+      : period(period), handler(handler) {}
+  void run(void) {
+    uint32_t ms = (uint32_t)(millis() - count);
+    if (ms >= period) {
+      /** Call handler */
+      handler();
+
+      // Serial.printf("[AgSchedule] handle 0x%08x, period: %d(ms)\r\n",
+      //               (unsigned int)handler, period);
+
+      /** Update period time */
+      count = millis();
+    }
+  }
+
+private:
+  void (*handler)(void);
+  int period;
+  int count;
+};
+
+/**
+ * @brief AirGradient server configuration and sync data
+ *
+ */
+class AgServer {
+public:
+  void begin(void) {
+    inF = false;
+    inUSAQI = false;
+    configFailed = false;
+    serverFailed = false;
+    memset(models, 0, sizeof(models));
+    memset(mqttBroker, 0, sizeof(mqttBroker));
+  }
+
+  /**
+   * @brief Get server configuration
+   *
+   * @param id Device ID
+   * @return true Success
+   * @return false Failure
+   */
+  bool fetchServerConfiguration(String id) {
+    String uri =
+        "http://hw.airgradient.com/sensors/airgradient:" + id + "/one/config";
+
+    /** Init http client */
+    WiFiClient wifiClient;
+    HTTPClient client;
+    if (client.begin(wifiClient, uri) == false) {
+      configFailed = true;
+      return false;
+    }
+
+    /** Get */
+    int retCode = client.GET();
+    if (retCode != 200) {
+      client.end();
+      configFailed = true;
+      return false;
+    }
+
+    /** clear failed */
+    configFailed = false;
+
+    /** Get response string */
+    String respContent = client.getString();
+    client.end();
+    Serial.println("Get server config: " + respContent);
+
+    /** Parse JSON */
+    JSONVar root = JSON.parse(respContent);
+    if (JSON.typeof(root) == "undefined") {
+      /** JSON invalid */
+      return false;
+    }
+
+    /** Get "country" */
+    if (JSON.typeof_(root["country"]) == "string") {
+      String country = root["country"];
+      if (country == "US") {
+        inF = true;
+      } else {
+        inF = false;
+      }
+    }
+
+    /** Get "pmStandard" */
+    if (JSON.typeof_(root["pmStandard"]) == "string") {
+      String standard = root["pmStandard"];
+      if (standard == "ugm3") {
+        inUSAQI = false;
+      } else {
+        inUSAQI = true;
+      }
+    }
+
+    /** Get "co2CalibrationRequested" */
+    if (JSON.typeof_(root["co2CalibrationRequested"]) == "boolean") {
+      co2Calib = root["co2CalibrationRequested"];
+    }
+
+    /** Get "ledBarMode" */
+    if (JSON.typeof_(root["ledBarMode"]) == "string") {
+      String mode = root["ledBarMode"];
+      if (mode == "co2") {
+        ledBarMode = UseLedBarCO2;
+      } else if (mode == "pm") {
+        ledBarMode = UseLedBarPM;
+      } else if (mode == "off") {
+        ledBarMode = UseLedBarOff;
+      } else {
+        ledBarMode = UseLedBarOff;
+      }
+    }
+
+    /** Get model */
+    if (JSON.typeof_(root["model"]) == "string") {
+      String model = root["model"];
+      if (model.length()) {
+        int len =
+            model.length() < sizeof(models) ? model.length() : sizeof(models);
+        memset(models, 0, sizeof(models));
+        memcpy(models, model.c_str(), len);
+      }
+    }
+
+    /** Get "mqttBrokerUrl" */
+    if (JSON.typeof_(root["mqttBrokerUrl"]) == "string") {
+      String mqtt = root["mqttBrokerUrl"];
+      if (mqtt.length()) {
+        int len = mqtt.length() < sizeof(mqttBroker) ? mqtt.length()
+                                                     : sizeof(mqttBroker);
+        memset(mqttBroker, 0, sizeof(mqttBroker));
+        memcpy(mqttBroker, mqtt.c_str(), len);
+      }
+    }
+
+    /** Get 'abcDays' */
+    if (JSON.typeof_(root["abcDays"]) == "number") {
+      co2AbcCalib = root["abcDays"];
+    } else {
+      co2AbcCalib = -1;
+    }
+
+    /** Show configuration */
+    showServerConfig();
+
+    return true;
+  }
+
+  bool postToServer(String id, String payload) {
+    /**
+     * @brief Only post data if WiFi is connected
+     */
+    if (WiFi.isConnected() == false) {
+      return false;
+    }
+
+    Serial.printf("Post payload: %s\r\n", payload.c_str());
+
+    String uri =
+        "http://hw.airgradient.com/sensors/airgradient:" + id + "/measures";
+
+    WiFiClient wifiClient;
+    HTTPClient client;
+    if (client.begin(wifiClient, uri.c_str()) == false) {
+      return false;
+    }
+    client.addHeader("content-type", "application/json");
+    int retCode = client.POST(payload);
+    client.end();
+
+    if ((retCode == 200) || (retCode == 429)) {
+      serverFailed = false;
+      return true;
+    } else {
+      Serial.printf("Post response failed code: %d\r\n", retCode);
+    }
+    serverFailed = true;
+    return false;
+  }
+
+  /**
+   * @brief Get temperature configuration unit
+   *
+   * @return true F unit
+   * @return false C Unit
+   */
+  bool isTemperatureUnitF(void) { return inF; }
+
+  /**
+   * @brief Get PMS standard unit
+   *
+   * @return true USAQI
+   * @return false ugm3
+   */
+  bool isPMSinUSAQI(void) { return inUSAQI; }
+
+  /**
+   * @brief Get status of get server configuration is failed
+   *
+   * @return true Failed
+   * @return false Success
+   */
+  bool isConfigFailed(void) { return configFailed; }
+
+  /**
+   * @brief Get status of post server configuration is failed
+   *
+   * @return true Failed
+   * @return false Success
+   */
+  bool isServerFailed(void) { return serverFailed; }
+
+  /**
+   * @brief Get request calibration CO2
+   *
+   * @return true Requested. If result = true, it's clear after function call
+   * @return false Not-requested
+   */
+  bool isCo2Calib(void) {
+    bool ret = co2Calib;
+    if (ret) {
+      co2Calib = false;
+    }
+    return ret;
+  }
+
+  /**
+   * @brief Get the Co2 auto calib period
+   *
+   * @return int  days, -1 if invalid.
+   */
+  int getCo2AbcDaysConfig(void) { return co2AbcCalib; }
+
+  /**
+   * @brief Get device configuration model name
+   *
+   * @return String Model name, empty string if server failed
+   */
+  String getModelName(void) { return String(models); }
+
+  /**
+   * @brief Get mqttBroker url
+   *
+   * @return String Broker url, empty if server failed
+   */
+  String getMqttBroker(void) { return String(mqttBroker); }
+
+  /**
+   * @brief Show server configuration parameter
+   */
+  void showServerConfig(void) {
+    Serial.println("Server configuration: ");
+    Serial.printf("             inF: %s\r\n", inF ? "true" : "false");
+    Serial.printf("         inUSAQI: %s\r\n", inUSAQI ? "true" : "false");
+    Serial.printf("    useRGBLedBar: %d\r\n", (int)ledBarMode);
+    Serial.printf("           Model: %s\r\n", models);
+    Serial.printf("     Mqtt Broker: %s\r\n", mqttBroker);
+    Serial.printf(" S8 calib period: %d\r\n", co2AbcCalib);
+  }
+
+  /**
+   * @brief Get server config led bar mode
+   *
+   * @return UseLedBar
+   */
+  UseLedBar getLedBarMode(void) { return ledBarMode; }
+
+private:
+  bool inF;             /** Temperature unit, true: F, false: C */
+  bool inUSAQI;         /** PMS unit, true: USAQI, false: ugm3 */
+  bool configFailed;    /** Flag indicate get server configuration failed */
+  bool serverFailed;    /** Flag indicate post data to server failed */
+  bool co2Calib;        /** Is co2Ppmcalibration requset */
+  int co2AbcCalib = -1; /** update auto calibration number of day */
+  UseLedBar ledBarMode = UseLedBarCO2; /** */
+  char models[20];                     /** */
+  char mqttBroker[256];                /** */
+};
+AgServer agServer;
+
+/** Create airgradient instance for 'DIY_BASIC' board */
+AirGradient ag = AirGradient(DIY_BASIC);
+
+static int co2Ppm = -1;
+static int pm25 = -1;
+static float temp = -1001;
+static int hum = -1;
+static long val;
+static String wifiSSID = "";
+static bool wifiHasConfig = false; /** */
+
+static void boardInit(void);
+static void failedHandler(String msg);
+static void co2Calibration(void);
+static void updateServerConfiguration(void);
+static void co2Update(void);
+static void pmUpdate(void);
+static void tempHumUpdate(void);
+static void sendDataToServer(void);
+static void dispHandler(void);
+static String getDevId(void);
+static void updateWiFiConnect(void);
+static void showNr(void);
+
+bool hasSensorS8 = true;
+bool hasSensorPMS = true;
+bool hasSensorSHT = true;
+int pmFailCount = 0;
+int getCO2FailCount = 0;
+AgSchedule configSchedule(SERVER_CONFIG_UPDATE_INTERVAL,
+                          updateServerConfiguration);
+AgSchedule serverSchedule(SERVER_SYNC_INTERVAL, sendDataToServer);
+AgSchedule dispSchedule(DISP_UPDATE_INTERVAL, dispHandler);
+AgSchedule co2Schedule(SENSOR_CO2_UPDATE_INTERVAL, co2Update);
+AgSchedule pmsSchedule(SENSOR_PM_UPDATE_INTERVAL, pmUpdate);
+AgSchedule tempHumSchedule(SENSOR_TEMP_HUM_UPDATE_INTERVAL, tempHumUpdate);
+
+void setup() {
+  Serial.begin(115200);
+  showNr();
+
+  /** Init I2C */
+  Wire.begin(ag.getI2cSdaPin(), ag.getI2cSclPin());
+  delay(1000);
+
+  /** Board init */
+  boardInit();
+
+  /** Init AirGradient server */
+  agServer.begin();
+
+  /** Show boot display */
+  displayShowText("DIY basic", "Lib:" + ag.getVersion(), "");
+  delay(2000);
+
+  /** WiFi connect */
+  connectToWifi();
+  if (WiFi.status() == WL_CONNECTED) {
+    wifiHasConfig = true;
+    sendPing();
+
+    agServer.fetchServerConfiguration(getDevId());
+    if (agServer.isCo2Calib()) {
+      co2Calibration();
+    }
+  }
+
+  /** Show serial number display */
+  ag.display.clear();
+  ag.display.setCursor(1, 1);
+  ag.display.setText("Warm Up");
+  ag.display.setCursor(1, 15);
+  ag.display.setText("Serial#");
+  ag.display.setCursor(1, 29);
+  String id = getNormalizedMac();
+  Serial.println("Device id: " + id);
+  String id1 = id.substring(0, 9);
+  String id2 = id.substring(9, 12);
+  ag.display.setText("\'" + id1);
+  ag.display.setCursor(1, 40);
+  ag.display.setText(id2 + "\'");
+  ag.display.show();
+
+  delay(5000);
+}
+
+void loop() {
+  configSchedule.run();
+  serverSchedule.run();
+  dispSchedule.run();
+  if (hasSensorS8) {
+    co2Schedule.run();
+  }
+  if (hasSensorPMS) {
+    pmsSchedule.run();
+  }
+  if (hasSensorSHT) {
+    tempHumSchedule.run();
+  }
+
+  updateWiFiConnect();
+
+  /** Read PMS on loop */
+  ag.pms5003.handle();
+}
+
+static void sendPing() {
+  JSONVar root;
+  root["wifi"] = WiFi.RSSI();
+  root["boot"] = 0;
+
+  // delay(1500);
+  if (agServer.postToServer(getDevId(), JSON.stringify(root))) {
+    // Ping Server succses
+  } else {
+    // Ping server failed
+  }
+  // delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
+}
+
+void displayShowText(String ln1, String ln2, String ln3) {
+  char buf[9];
+  ag.display.clear();
+
+  ag.display.setCursor(1, 1);
+  ag.display.setText(ln1);
+  ag.display.setCursor(1, 19);
+  ag.display.setText(ln2);
+  ag.display.setCursor(1, 37);
+  ag.display.setText(ln3);
+
+  ag.display.show();
+  delay(100);
+}
+
+// Wifi Manager
+void connectToWifi() {
+  WiFiManager wifiManager;
+  wifiSSID = "AG-" + String(ESP.getChipId(), HEX);
+  wifiManager.setConfigPortalBlocking(false);
+  wifiManager.setConfigPortalTimeout(WIFI_CONNECT_COUNTDOWN_MAX);
+  wifiManager.autoConnect(wifiSSID.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT);
+
+  uint32_t lastTime = millis();
+  int count = WIFI_CONNECT_COUNTDOWN_MAX;
+  displayShowText(String(WIFI_CONNECT_COUNTDOWN_MAX) + " sec",
+                  "SSID:", wifiSSID);
+  while (wifiManager.getConfigPortalActive()) {
+    wifiManager.process();
+    uint32_t ms = (uint32_t)(millis() - lastTime);
+    if (ms >= 1000) {
+      lastTime = millis();
+      displayShowText(String(count) + " sec", "SSID:", wifiSSID);
+      count--;
+
+      // Timeout
+      if (count == 0) {
+        break;
+      }
+    }
+  }
+  if (!WiFi.isConnected()) {
+    displayShowText("Booting", "offline", "mode");
+    Serial.println("failed to connect and hit timeout");
+    delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
+  }
+}
+
+static void boardInit(void) {
+  /** Init SHT sensor */
+  if (ag.sht.begin(Wire) == false) {
+    hasSensorSHT = false;
+    Serial.println("SHT sensor not found");
+  }
+
+  /** CO2 init */
+  if (ag.s8.begin(&Serial) == false) {
+    Serial.println("CO2 S8 snsor not found");
+    hasSensorS8 = false;
+  }
+
+  /** PMS init */
+  if (ag.pms5003.begin(&Serial) == false) {
+    Serial.println("PMS sensor not found");
+    hasSensorPMS = false;
+  }
+
+  /** Display init */
+  ag.display.begin(Wire);
+  ag.display.setTextColor(1);
+  ag.display.clear();
+  ag.display.show();
+  delay(100);
+}
+
+static void failedHandler(String msg) {
+  while (true) {
+    Serial.println(msg);
+    delay(1000);
+  }
+}
+
+static void co2Calibration(void) {
+  /** Count down for co2CalibCountdown secs */
+  for (int i = 0; i < SENSOR_CO2_CALIB_COUNTDOWN_MAX; i++) {
+    displayShowText("CO2 calib", "after",
+                    String(SENSOR_CO2_CALIB_COUNTDOWN_MAX - i) + " sec");
+    delay(1000);
+  }
+
+  if (ag.s8.setBaselineCalibration()) {
+    displayShowText("Calib", "success", "");
+    delay(1000);
+    displayShowText("Wait for", "finish", "...");
+    int count = 0;
+    while (ag.s8.isBaseLineCalibrationDone() == false) {
+      delay(1000);
+      count++;
+    }
+    displayShowText("Finish", "after", String(count) + " sec");
+    delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
+  } else {
+    displayShowText("Calib", "failure!!!", "");
+    delay(DISPLAY_DELAY_SHOW_CONTENT_MS);
+  }
+}
+
+static void updateServerConfiguration(void) {
+  if (agServer.fetchServerConfiguration(getDevId())) {
+    if (agServer.isCo2Calib()) {
+      if (hasSensorS8) {
+        co2Calibration();
+      } else {
+        Serial.println("CO2 S8 not available, calib ignored");
+      }
+    }
+    if (agServer.getCo2AbcDaysConfig() > 0) {
+      if (hasSensorS8) {
+        int newHour = agServer.getCo2AbcDaysConfig() * 24;
+        Serial.printf("abcDays config: %d days(%d hours)\r\n",
+                      agServer.getCo2AbcDaysConfig(), newHour);
+        int curHour = ag.s8.getAbcPeriod();
+        Serial.printf("Current config: %d (hours)\r\n", curHour);
+        if (curHour == newHour) {
+          Serial.println("set 'abcDays' ignored");
+        } else {
+          if (ag.s8.setAbcPeriod(agServer.getCo2AbcDaysConfig() * 24) ==
+              false) {
+            Serial.println("Set S8 abcDays period calib failed");
+          } else {
+            Serial.println("Set S8 abcDays period calib success");
+          }
+        }
+      } else {
+        Serial.println("CO2 S8 not available, set 'abcDays' ignored");
+      }
+    }
+  }
+}
+
+static void co2Update() {
+  int value = ag.s8.getCo2();
+  if (value >= 0) {
+    co2Ppm = value;
+    getCO2FailCount = 0;
+    Serial.printf("CO2 index: %d\r\n", co2Ppm);
+  } else {
+    getCO2FailCount++;
+    Serial.printf("Get CO2 failed: %d\r\n", getCO2FailCount);
+    if (getCO2FailCount >= 3) {
+      co2Ppm = -1;
+    }
+  }
+}
+
+void pmUpdate() {
+  if (ag.pms5003.isFailed() == false) {
+    pm25 = ag.pms5003.getPm25Ae();
+    Serial.printf("PMS2.5: %d\r\n", pm25);
+    pmFailCount = 0;
+  } else {
+    Serial.printf("PM read failed, %d", pmFailCount);
+    pmFailCount++;
+    if (pmFailCount >= 3) {
+      pm25 = -1;
+    }
+  }
+}
+
+static void tempHumUpdate() {
+  if (ag.sht.measure()) {
+    temp = ag.sht.getTemperature();
+    hum = ag.sht.getRelativeHumidity();
+    Serial.printf("Temperature: %0.2f\r\n", temp);
+    Serial.printf("   Humidity: %d\r\n", hum);
+  } else {
+    Serial.println("Meaure SHT failed");
+  }
+}
+
+static void sendDataToServer() {
+  JSONVar root;
+  root["wifi"] = WiFi.RSSI();
+  if (co2Ppm >= 0) {
+    root["rco2"] = co2Ppm;
+  }
+  if (pm25 >= 0) {
+    root["pm02"] = pm25;
+  }
+  if (temp > -1001) {
+    root["atmp"] = ag.round2(temp);
+  }
+  if (hum >= 0) {
+    root["rhum"] = hum;
+  }
+
+  if (agServer.postToServer(getDevId(), JSON.stringify(root)) == false) {
+    Serial.println("Post to server failed");
+  }
+}
+
+static void dispHandler() {
+  String ln1 = "";
+  String ln2 = "";
+  String ln3 = "";
+
+  if (agServer.isPMSinUSAQI()) {
+    if (pm25 < 0) {
+      ln1 = "AQI: -";
+    } else {
+      ln1 = "AQI:" + String(ag.pms5003.convertPm25ToUsAqi(pm25));
+    }
+  } else {
+    if (pm25 < 0) {
+      ln1 = "PM :- ug";
+
+    } else {
+      ln1 = "PM :" + String(pm25) + " ug";
+    }
+  }
+  if (co2Ppm > -1001) {
+    ln2 = "CO2:" + String(co2Ppm);
+  } else {
+    ln2 = "CO2: -";
+  }
+
+  String _hum = "-";
+  if (hum > 0) {
+    _hum = String(hum);
+  }
+
+  String _temp = "-";
+
+  if (agServer.isTemperatureUnitF()) {
+    if (temp > -1001) {
+      _temp = String((temp * 9 / 5) + 32).substring(0, 4);
+    }
+    ln3 = _temp + " " + _hum + "%";
+  } else {
+    if (temp > -1001) {
+      _temp = String(temp).substring(0, 4);
+    }
+    ln3 = _temp + " " + _hum + "%";
+  }
+  displayShowText(ln1, ln2, ln3);
+}
+
+static String getDevId(void) { return getNormalizedMac(); }
+
+/**
+ * @brief WiFi reconnect handler
+ */
+static void updateWiFiConnect(void) {
+  static uint32_t lastRetry;
+  if (wifiHasConfig == false) {
+    return;
+  }
+  if (WiFi.isConnected()) {
+    lastRetry = millis();
+    return;
+  }
+  uint32_t ms = (uint32_t)(millis() - lastRetry);
+  if (ms >= WIFI_CONNECT_RETRY_MS) {
+    lastRetry = millis();
+    WiFi.reconnect();
+
+    Serial.printf("Re-Connect WiFi\r\n");
+  }
+}
+
+static void showNr(void) {
+  Serial.println();
+  Serial.println("Serial nr: " + getDevId());
+}
+
+String getNormalizedMac() {
+  String mac = WiFi.macAddress();
+  mac.replace(":", "");
+  mac.toLowerCase();
+  return mac;
+}

examples/BASIC_v4/BASIC_v4.ino

@@ -1,460 +0,0 @@
-/*
-This is the code for the AirGradient DIY BASIC Air Quality Monitor with an D1 ESP8266 Microcontroller.
-
-It is an air quality monitor for PM2.5, CO2, Temperature and Humidity with a small display and can send data over Wifi.
-
-Open source air quality monitors and kits are available:
-Indoor Monitor: https://www.airgradient.com/indoor/
-Outdoor Monitor: https://www.airgradient.com/outdoor/
-
-Build Instructions:
-https://www.airgradient.com/documentation/diy-v4/
-
-Following libraries need to be installed:
-“WifiManager by tzapu, tablatronix” tested with version 2.0.16-rc.2
-"Arduino_JSON" by Arduino version 0.2.0
-"U8g2" by oliver version 2.34.22
-
-Please make sure you have esp8266 board manager installed. Tested with version 3.1.2.
-
-Set board to "LOLIN(WEMOS) D1 R2 & mini"
-
-Configuration parameters, e.g. Celsius / Fahrenheit or PM unit (US AQI vs ug/m3) can be set through the AirGradient dashboard.
-
-If you have any questions please visit our forum at
-https://forum.airgradient.com/
-
-CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
-
-*/
-
-#include <AirGradient.h>
-#include <Arduino_JSON.h>
-#include <ESP8266HTTPClient.h>
-#include <ESP8266WiFi.h>
-#include <U8g2lib.h>
-#include <WiFiClient.h>
-#include <WiFiManager.h>
-
-typedef struct {
-  bool inF;             /** Temperature unit */
-  bool inUSAQI;         /** PMS standard */
-  uint8_t ledBarMode;   /** @ref UseLedBar*/
-  char model[16];       /** Model string value, Just define, don't know how much
-                        memory usage */
-  char mqttBroker[128]; /** Mqtt broker link */
-  uint32_t _check;      /** Checksum configuration data */
-} ServerConfig_t;
-static ServerConfig_t serverConfig;
-
-AirGradient ag = AirGradient(BOARD_DIY_BASIC_KIT);
-
-// CONFIGURATION START
-
-// set to the endpoint you would like to use
-String APIROOT = "http://hw.airgradient.com/";
-
-String wifiApPass = "cleanair";
-
-// set to true if you want to connect to wifi. You have 60 seconds to connect.
-// Then it will go into an offline mode.
-boolean connectWIFI = true;
-
-// CONFIGURATION END
-
-unsigned long currentMillis = 0;
-
-const int oledInterval = 5000;
-unsigned long previousOled = 0;
-bool co2CalibrationRequest = false;
-uint32_t serverConfigLoadTime = 0;
-String HOSTPOT = "";
-
-const int sendToServerInterval = 60000;
-const int pollServerConfigInterval = 30000;
-const int co2CalibCountdown = 5; /** Seconds */
-unsigned long previoussendToServer = 0;
-
-const int co2Interval = 5000;
-unsigned long previousCo2 = 0;
-int Co2 = 0;
-
-const int pm25Interval = 5000;
-unsigned long previousPm25 = 0;
-int pm25 = 0;
-
-const int tempHumInterval = 2500;
-unsigned long previousTempHum = 0;
-float temp = 0;
-int hum = 0;
-long val;
-
-void failedHandler(String msg);
-void boardInit(void);
-void getServerConfig(void);
-void co2Calibration(void);
-
-void setup() {
-  Serial.begin(115200);
-
-  /** Init I2C */
-  Wire.begin(ag.getI2cSdaPin(), ag.getI2cSclPin());
-
-  /** Board init */
-  boardInit();
-
-  /** Show boot display */
-  displayShowText("Basic v4", "Lib:" + ag.getVersion(), "");
-  delay(2000);
-
-  if (connectWIFI) {
-    connectToWifi();
-  }
-
-  /** Show display */
-  displayShowText("Warm Up", "Serial#", String(ESP.getChipId(), HEX));
-  delay(10000);
-
-  getServerConfig();
-}
-
-void loop() {
-  currentMillis = millis();
-  updateOLED();
-  updateCo2();
-  updatePm25();
-  updateTempHum();
-  sendToServer();
-  getServerConfig();
-}
-
-void updateCo2() {
-  if (currentMillis - previousCo2 >= co2Interval) {
-    previousCo2 += co2Interval;
-    Co2 = ag.s8.getCo2();
-    Serial.println(String(Co2));
-  }
-}
-
-void updatePm25() {
-  if (currentMillis - previousPm25 >= pm25Interval) {
-    previousPm25 += pm25Interval;
-    if (ag.pms5003.readData()) {
-      pm25 = ag.pms5003.getPm25Ae();
-      Serial.printf("PM25: %d\r\n", pm25);
-    }
-  }
-}
-
-void updateTempHum() {
-  if (currentMillis - previousTempHum >= tempHumInterval) {
-    previousTempHum += tempHumInterval;
-
-    /** Get temperature and humidity */
-    temp = ag.sht.getTemperature();
-    hum = ag.sht.getRelativeHumidity();
-
-    /** Print debug message */
-    Serial.printf("SHT Humidity: %d%, Temperature: %0.2f\r\n", hum, temp);
-  }
-}
-
-void updateOLED() {
-  if (currentMillis - previousOled >= oledInterval) {
-    previousOled += oledInterval;
-
-    String ln1;
-    String ln2;
-    String ln3;
-
-    if (serverConfig.inUSAQI) {
-      ln1 = "AQI:" + String(ag.pms5003.convertPm25ToUsAqi(pm25));
-    } else {
-      ln1 = "PM :" + String(pm25) + " ug";
-    }
-    ln2 = "CO2:" + String(Co2);
-
-    if (serverConfig.inF) {
-      ln3 =
-          String((temp * 9 / 5) + 32).substring(0, 4) + " " + String(hum) + "%";
-    } else {
-      ln3 = String(temp).substring(0, 4) + " " + String(hum) + "%";
-    }
-    displayShowText(ln1, ln2, ln3);
-  }
-}
-
-void displayShowText(String ln1, String ln2, String ln3) {
-  char buf[9];
-  ag.display.clear();
-
-  ag.display.setCursor(1, 1);
-  ag.display.setText(ln1);
-  ag.display.setCursor(1, 19);
-  ag.display.setText(ln2);
-  ag.display.setCursor(1, 37);
-  ag.display.setText(ln3);
-
-  ag.display.show();
-}
-
-void sendToServer() {
-  if (currentMillis - previoussendToServer >= sendToServerInterval) {
-    previoussendToServer += sendToServerInterval;
-
-    String payload = "{\"wifi\":" + String(WiFi.RSSI()) +
-                     (Co2 < 0 ? "" : ", \"rco2\":" + String(Co2)) +
-                     (pm25 < 0 ? "" : ", \"pm02\":" + String(pm25)) +
-                     ", \"atmp\":" + String(temp) +
-                     (hum < 0 ? "" : ", \"rhum\":" + String(hum)) + "}";
-
-    if (WiFi.status() == WL_CONNECTED) {
-      Serial.println(payload);
-      String POSTURL = APIROOT +
-                       "sensors/airgradient:" + String(ESP.getChipId(), HEX) +
-                       "/measures";
-      Serial.println(POSTURL);
-      WiFiClient client;
-      HTTPClient http;
-      http.begin(client, POSTURL);
-      http.addHeader("content-type", "application/json");
-      int httpCode = http.POST(payload);
-      String response = http.getString();
-      Serial.println(httpCode);
-      Serial.println(response);
-      http.end();
-    } else {
-      Serial.println("WiFi Disconnected");
-    }
-  }
-}
-
-// Wifi Manager
-void connectToWifi() {
-  WiFiManager wifiManager;
-  // WiFi.disconnect(); //to delete previous saved hotspot
-  String HOTSPOT = "AG-" + String(ESP.getChipId(), HEX);
-  // displayShowText("Connect", "AG-", String(ESP.getChipId(), HEX));
-  delay(2000);
-  // wifiManager.setTimeout(90);
-  wifiManager.setConfigPortalBlocking(false);
-  wifiManager.setConfigPortalTimeout(180);
-  wifiManager.autoConnect(HOTSPOT.c_str(), wifiApPass.c_str());
-
-  uint32_t lastTime = millis();
-  int count = 179;
-  displayShowText("180 sec", "SSID:",HOTSPOT);
-  while (wifiManager.getConfigPortalActive()) {
-    wifiManager.process();
-    uint32_t ms = (uint32_t)(millis() - lastTime);
-    if (ms >= 1000) {
-      lastTime = millis();
-      displayShowText(String(count) +  " sec", "SSID:",HOTSPOT);
-      count--;
-
-      // Timeout
-      if (count == 0) {
-        break;
-      }
-    }
-  }
-  if (!WiFi.isConnected()) {
-    displayShowText("Booting", "offline", "mode");
-    Serial.println("failed to connect and hit timeout");
-    delay(6000);
-  }
-}
-
-void failedHandler(String msg) {
-  while (true) {
-    Serial.println(msg);
-    delay(1000);
-  }
-}
-
-void boardInit(void) {
-  /** Init SHT sensor */
-  if (ag.sht.begin(Wire) == false) {
-    failedHandler("SHT init failed");
-  }
-
-  /** CO2 init */
-  if (ag.s8.begin(&Serial) == false) {
-    failedHandler("SenseAirS8 init failed");
-  }
-
-  /** PMS init */
-  if (ag.pms5003.begin(&Serial) == false) {
-    failedHandler("PMS5003 init failed");
-  }
-
-  /** Display init */
-  ag.display.begin(Wire);
-  ag.display.setTextColor(1);
-}
-
-void showConfig(void) {
-  Serial.println("Server configuration: ");
-  Serial.printf("         inF: %s\r\n", serverConfig.inF ? "true" : "false");
-  Serial.printf("     inUSAQI: %s\r\n",
-                serverConfig.inUSAQI ? "true" : "false");
-  Serial.printf("useRGBLedBar: %d\r\n", (int)serverConfig.ledBarMode);
-  Serial.printf("       Model: %.*s\r\n", sizeof(serverConfig.model),
-                serverConfig.model);
-  Serial.printf(" Mqtt Broker: %.*s\r\n", sizeof(serverConfig.mqttBroker),
-                serverConfig.mqttBroker);
-}
-
-void updateServerConfigLoadTime(void) {
-  serverConfigLoadTime = millis();
-  if (serverConfigLoadTime == 0) {
-    serverConfigLoadTime = 1;
-  }
-}
-
-void getServerConfig(void) {
-  /** Only trigger load configuration again after pollServerConfigInterval sec
-   */
-  if (serverConfigLoadTime) {
-    uint32_t ms = (uint32_t)(millis() - serverConfigLoadTime);
-    if (ms < pollServerConfigInterval) {
-      return;
-    }
-  }
-
-  updateServerConfigLoadTime();
-
-  Serial.println("Trigger load server configuration");
-  if (WiFi.status() != WL_CONNECTED) {
-    Serial.println(
-        "Ignore get server configuration because WIFI not connected");
-    return;
-  }
-
-  // WiFiClient wifiClient;
-  HTTPClient httpClient;
-
-  String getUrl = "http://hw.airgradient.com/sensors/airgradient:" +
-                  String(ESP.getChipId(), HEX) + "/one/config";
-  Serial.println("HttpClient get: " + getUrl);
-  WiFiClient client;
-  if (httpClient.begin(client, getUrl) == false) {
-    Serial.println("HttpClient init failed");
-    updateServerConfigLoadTime();
-    return;
-  }
-
-  int respCode = httpClient.GET();
-
-  /** get failure */
-  if (respCode != 200) {
-    Serial.printf("HttpClient get failed: %d\r\n", respCode);
-    updateServerConfigLoadTime();
-    return;
-  }
-
-  String respContent = httpClient.getString();
-  Serial.println("Server config: " + respContent);
-
-  /** Parse JSON */
-  JSONVar root = JSON.parse(respContent);
-  if (JSON.typeof_(root) == "undefined") {
-    Serial.println("Server configura JSON invalid");
-    updateServerConfigLoadTime();
-    return;
-  }
-
-  /** Get "country" */
-  bool inF = serverConfig.inF;
-  if (JSON.typeof_(root["country"]) == "string") {
-    String country = root["country"];
-    if (country == "US") {
-      inF = true;
-    } else {
-      inF = false;
-    }
-  }
-
-  /** Get "pmStandard" */
-  bool inUSAQI = serverConfig.inUSAQI;
-  if (JSON.typeof_(root["pmStandard"]) == "string") {
-    String standard = root["pmStandard"];
-    if (standard == "ugm3") {
-      inUSAQI = false;
-    } else {
-      inUSAQI = true;
-    }
-  }
-
-  /** Get CO2 "co2CalibrationRequested" */
-  co2CalibrationRequest = false;
-  if (JSON.typeof_(root["co2CalibrationRequested"]) == "boolean") {
-    co2CalibrationRequest = root["co2CalibrationRequested"];
-  }
-
-  /** get "model" */
-  String model = "";
-  if (JSON.typeof_(root["model"]) == "string") {
-    String _model = root["model"];
-    model = _model;
-  }
-
-  /** get "mqttBrokerUrl" */
-  String mqtt = "";
-  if (JSON.typeof_(root["mqttBrokerUrl"]) == "string") {
-    String _mqtt = root["mqttBrokerUrl"];
-    mqtt = _mqtt;
-  }
-
-  if (inF != serverConfig.inF) {
-    serverConfig.inF = inF;
-  }
-  if (inUSAQI != serverConfig.inUSAQI) {
-    serverConfig.inUSAQI = inUSAQI;
-  }
-  if (model.length()) {
-    if (model != String(serverConfig.model)) {
-      memset(serverConfig.model, 0, sizeof(serverConfig.model));
-      memcpy(serverConfig.model, model.c_str(), model.length());
-    }
-  }
-  if (mqtt.length()) {
-    if (mqtt != String(serverConfig.mqttBroker)) {
-      memset(serverConfig.mqttBroker, 0, sizeof(serverConfig.mqttBroker));
-      memcpy(serverConfig.mqttBroker, mqtt.c_str(), mqtt.length());
-    }
-  }
-
-  /** Show server configuration */
-  showConfig();
-
-  /** Calibration */
-  if (co2CalibrationRequest) {
-    co2Calibration();
-  }
-}
-
-void co2Calibration(void) {
-  /** Count down for co2CalibCountdown secs */
-  for (int i = 0; i < co2CalibCountdown; i++) {
-    displayShowText("CO2 calib", "after",
-                    String(co2CalibCountdown - i) + " sec");
-    delay(1000);
-  }
-
-  if (ag.s8.setBaselineCalibration()) {
-    displayShowText("Calib", "success", "");
-    delay(1000);
-    displayShowText("Wait for", "finish", "...");
-    int count = 0;
-    while (ag.s8.isBaseLineCalibrationDone() == false) {
-      delay(1000);
-      count++;
-    }
-    displayShowText("Finish", "after", String(count) + " sec");
-    delay(2000);
-  } else {
-    displayShowText("Calib", "failure!!!", "");
-    delay(2000);
-  }
-}

examples/Open_Air_O-1PST/Open_Air_O-1PST.ino

@@ -1,687 +0,0 @@
-/*
-This is the code for the AirGradient Open Air open-source hardware outdoor Air Quality Monitor with an ESP32-C3 Microcontroller.
-
-It is an air quality monitor for PM2.5, CO2, TVOCs, NOx, Temperature and Humidity and can send data over Wifi.
-
-Open source air quality monitors and kits are available:
-Indoor Monitor: https://www.airgradient.com/indoor/
-Outdoor Monitor: https://www.airgradient.com/outdoor/
-
-Build Instructions: https://www.airgradient.com/documentation/open-air-pst-kit-1-3/
-
-The codes needs the following libraries installed:
-“WifiManager by tzapu, tablatronix” tested with version 2.0.16-rc.2
-"Arduino_JSON" by Arduino Version 0.2.0
-
-Please make sure you have esp32 board manager installed. Tested with version 2.0.11.
-
-Important flashing settings:
-- Set board to "ESP32C3 Dev Module"
-- Enable "USB CDC On Boot"
-- Flash frequency "80Mhz"
-- Flash mode "QIO"
-- Flash size "4MB"
-- Partition scheme "Default 4MB with spiffs (1.2MB APP/1,5MB SPIFFS)"
-- JTAG adapter "Disabled"
-
-If you have any questions please visit our forum at
-https://forum.airgradient.com/
-
-CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
-
-*/
-
-#include <AirGradient.h>
-#include <Arduino_JSON.h>
-#include <HTTPClient.h>
-#include <HardwareSerial.h>
-#include <WiFiManager.h>
-#include <Wire.h>
-
-/**
- *
- * @brief Application state machine state
- *
- */
-enum {
-  APP_SM_WIFI_MANAGER_MODE,           /** In WiFi Manger Mode */
-  APP_SM_WIFI_MAMAGER_PORTAL_ACTIVE,  /** WiFi Manager has connected to mobile
-                                         phone */
-  APP_SM_WIFI_MANAGER_STA_CONNECTING, /** After SSID and PW entered and OK
-                                        clicked, connection to WiFI network is
-                                        attempted*/
-  APP_SM_WIFI_MANAGER_STA_CONNECTED,  /** Connecting to WiFi worked */
-  APP_SM_WIFI_OK_SERVER_CONNECTING,   /** Once connected to WiFi an attempt to
-                                         reach the server is performed */
-  APP_SM_WIFI_OK_SERVER_CONNNECTED,   /** Server is reachable, all fine */
-  /** Exceptions during WIFi Setup */
-  APP_SM_WIFI_MANAGER_CONNECT_FAILED,   /** Cannot connect to WiFi (e.g. wrong
-                                            password, WPA Enterprise etc.) */
-  APP_SM_WIFI_OK_SERVER_CONNECT_FAILED, /** Connected to WiFi but server not
-                                          reachable, e.g. firewall block/
-                                          whitelisting needed etc. */
-  APP_SM_WIFI_OK_SERVER_OK_SENSOR_CONFIG_FAILED, /** Server reachable but sensor
-                                                   not configured correctly*/
-
-  /** During Normal Operation */
-  APP_SM_WIFI_LOST, /** Connection to WiFi network failed credentials incorrect
-                       encryption not supported etc. */
-  APP_SM_SERVER_LOST, /** Connected to WiFi network but the server cannot be
-                         reached through the internet, e.g. blocked by firewall
-                       */
-  APP_SM_SENSOR_CONFIG_FAILED, /** Server is reachable but there is some
-                                  configuration issue to be fixed on the server
-                                  side */
-  APP_SM_NORMAL,
-};
-
-#define DEBUG true
-
-#define WIFI_CONNECT_COUNTDOWN_MAX 180 /** sec */
-#define WIFI_HOTSPOT_PASSWORD_DEFAULT "cleanair"
-
-AirGradient ag(BOARD_OUTDOOR_MONITOR_V1_3);
-
-// time in seconds needed for NOx conditioning
-uint16_t conditioning_s = 10;
-
-String APIROOT = "http://hw.airgradient.com/";
-
-typedef struct {
-  bool inF;             /** Temperature unit */
-  bool inUSAQI;         /** PMS standard */
-  uint8_t ledBarMode;   /** @ref UseLedBar*/
-  char model[16];       /** Model string value, Just define, don't know how much
-                        memory usage */
-  char mqttBroker[128]; /** Mqtt broker link */
-  uint32_t _check;      /** Checksum configuration data */
-} ServerConfig_t;
-static ServerConfig_t serverConfig;
-
-// set to true if you want to connect to wifi. You have 60 seconds to connect.
-// Then it will go into an offline mode.
-boolean connectWIFI = true;
-
-static int ledSmState = APP_SM_NORMAL;
-static bool serverFailed = false;
-static bool configFailed = false;
-static bool wifiHasConfig = false;
-
-int loopCount = 0;
-
-WiFiManager wifiManager; /** wifi manager instance */
-
-unsigned long currentMillis = 0;
-
-const int oledInterval = 5000;
-unsigned long previousOled = 0;
-
-const int sendToServerInterval = 60000;
-const int pollServerConfigInterval = 30000;
-const int co2CalibCountdown = 5; /** Seconds */
-unsigned long previoussendToServer = 0;
-
-const int tvocInterval = 1000;
-unsigned long previousTVOC = 0;
-int TVOC = -1;
-int NOX = -1;
-
-const int co2Interval = 5000;
-unsigned long previousCo2 = 0;
-int Co2 = 0;
-
-const int pmInterval = 5000;
-unsigned long previousPm = 0;
-int pm25 = -1;
-int pm01 = -1;
-int pm10 = -1;
-int pm03PCount = -1;
-float temp;
-int hum;
-
-bool co2CalibrationRequest = false;
-uint32_t serverConfigLoadTime = 0;
-String HOTSPOT = "";
-
-// const int tempHumInterval = 2500;
-// unsigned long previousTempHum = 0;
-
-void boardInit(void);
-void failedHandler(String msg);
-void getServerConfig(void);
-void co2Calibration(void);
-
-void setup() {
-  if (DEBUG) {
-    Serial.begin(115200);
-  }
-
-  /** Board init */
-  boardInit();
-
-  delay(500);
-
-  countdown(3);
-
-  if (connectWIFI) {
-    connectToWifi();
-  }
-
-  if (WiFi.status() == WL_CONNECTED) {
-    sendPing();
-    Serial.println(F("WiFi connected!"));
-    Serial.println("IP address: ");
-    Serial.println(WiFi.localIP());
-  }
-
-  getServerConfig();
-  if (configFailed) {
-    ledSmHandler(APP_SM_SENSOR_CONFIG_FAILED);
-    delay(5000);
-  }
-
-  ledSmHandler(APP_SM_NORMAL);
-}
-
-void loop() {
-  currentMillis = millis();
-  updateTVOC();
-  updateCo2();
-  updatePm();
-  sendToServer();
-  getServerConfig();
-}
-
-void updateTVOC() {
-  delay(1000);
-
-  if (currentMillis - previousTVOC >= tvocInterval) {
-    previousTVOC += tvocInterval;
-    TVOC = ag.sgp41.getTvocIndex();
-    NOX = ag.sgp41.getNoxIndex();
-  }
-}
-
-void updateCo2() {
-  if (currentMillis - previousCo2 >= co2Interval) {
-    previousCo2 += co2Interval;
-    Co2 = ag.s8.getCo2();
-    Serial.printf("CO2: %d\r\n", Co2);
-  }
-}
-
-void updatePm() {
-  if (currentMillis - previousPm >= pmInterval) {
-    previousPm += pmInterval;
-    if (ag.pms5003t_1.readData()) {
-      pm01 = ag.pms5003t_1.getPm01Ae();
-      pm25 = ag.pms5003t_1.getPm25Ae();
-      pm10 = ag.pms5003t_1.getPm10Ae();
-      pm03PCount = ag.pms5003t_1.getPm03ParticleCount();
-      temp = ag.pms5003t_1.getTemperature();
-      hum = ag.pms5003t_1.getRelativeHumidity();
-    }
-  }
-}
-
-void sendPing() {
-  String payload =
-      "{\"wifi\":" + String(WiFi.RSSI()) + ", \"boot\":" + loopCount + "}";
-  if (postToServer(payload)) {
-    ledSmHandler(APP_SM_WIFI_OK_SERVER_CONNNECTED);
-  } else {
-    ledSmHandler(APP_SM_WIFI_OK_SERVER_CONNECT_FAILED);
-  }
-  delay(5000);
-}
-
-bool postToServer(String &payload) {
-  String POSTURL = APIROOT +
-                   "sensors/airgradient:" + String(getNormalizedMac()) +
-                   "/measures";
-  WiFiClient client;
-  HTTPClient http;
-
-  ag.statusLed.setOn();
-
-  http.begin(client, POSTURL);
-  http.addHeader("content-type", "application/json");
-  int httpCode = http.POST(payload);
-  Serial.printf("Post to %s, %d\r\n", POSTURL.c_str(), httpCode);
-  http.end();
-
-  ag.statusLed.setOff();
-
-  return (httpCode == 200);
-}
-
-void sendToServer() {
-  if (currentMillis - previoussendToServer >= sendToServerInterval) {
-    previoussendToServer += sendToServerInterval;
-    String payload =
-        "{\"wifi\":" + String(WiFi.RSSI()) +
-        (Co2 < 0 ? "" : ", \"rco2\":" + String(Co2)) +
-        (pm01 < 0 ? "" : ", \"pm01\":" + String(pm01)) +
-        (pm25 < 0 ? "" : ", \"pm02\":" + String(pm25)) +
-        (pm10 < 0 ? "" : ", \"pm10\":" + String(pm10)) +
-        (pm03PCount < 0 ? "" : ", \"pm003_count\":" + String(pm03PCount)) +
-        (TVOC < 0 ? "" : ", \"tvoc_index\":" + String(TVOC)) +
-        (NOX < 0 ? "" : ", \"nox_index\":" + String(NOX)) +
-        ", \"atmp\":" + String(temp) +
-        (hum < 0 ? "" : ", \"rhum\":" + String(hum)) +
-        ", \"boot\":" + loopCount + "}";
-
-    if (WiFi.status() == WL_CONNECTED) {
-      postToServer(payload);
-      resetWatchdog();
-      loopCount++;
-    } else {
-      Serial.println("WiFi Disconnected");
-    }
-  }
-}
-
-void countdown(int from) {
-  debug("\n");
-  while (from > 0) {
-    debug(String(from--));
-    debug(" ");
-    delay(1000);
-  }
-  debug("\n");
-}
-
-void resetWatchdog() {
-  Serial.println("Watchdog reset");
-  ag.watchdog.reset();
-}
-
-bool wifiMangerClientConnected(void) {
-  return WiFi.softAPgetStationNum() ? true : false;
-}
-
-// Wifi Manager
-void connectToWifi() {
-  HOTSPOT = "airgradient-" + String(getNormalizedMac());
-
-  wifiManager.setConfigPortalBlocking(false);
-  wifiManager.setTimeout(WIFI_CONNECT_COUNTDOWN_MAX);
-
-  wifiManager.setAPCallback([](WiFiManager *obj) {
-    /** This callback if wifi connnected failed and try to start configuration
-     * portal */
-    ledSmState = APP_SM_WIFI_MANAGER_MODE;
-  });
-  wifiManager.setSaveConfigCallback([]() {
-    /** Wifi connected save the configuration */
-    ledSmHandler(APP_SM_WIFI_MANAGER_STA_CONNECTED);
-  });
-  wifiManager.setSaveParamsCallback([]() {
-    /** Wifi set connect: ssid, password */
-    ledSmHandler(APP_SM_WIFI_MANAGER_STA_CONNECTING);
-  });
-  wifiManager.autoConnect(HOTSPOT.c_str(), WIFI_HOTSPOT_PASSWORD_DEFAULT);
-
-  xTaskCreate(
-      [](void *obj) {
-        while (wifiManager.getConfigPortalActive()) {
-          wifiManager.process();
-        }
-        vTaskDelete(NULL);
-      },
-      "wifi_cfg", 4096, NULL, 10, NULL);
-
-  uint32_t stimer = millis();
-  bool clientConnectChanged = false;
-  while (wifiManager.getConfigPortalActive()) {
-    if (WiFi.isConnected() == false) {
-      if (ledSmState == APP_SM_WIFI_MANAGER_MODE) {
-        uint32_t ms = (uint32_t)(millis() - stimer);
-        if (ms >= 100) {
-          stimer = millis();
-          ledSmHandler(ledSmState);
-        }
-      }
-
-      /** Check for client connect to change led color */
-      bool clientConnected = wifiMangerClientConnected();
-      if (clientConnected != clientConnectChanged) {
-        clientConnectChanged = clientConnected;
-        if (clientConnectChanged) {
-          ledSmHandler(APP_SM_WIFI_MAMAGER_PORTAL_ACTIVE);
-        } else {
-          ledSmHandler(APP_SM_WIFI_MANAGER_MODE);
-        }
-      }
-    }
-  }
-
-  /** Show display wifi connect result failed */
-  if (WiFi.isConnected() == false) {
-    ledSmHandler(APP_SM_WIFI_MANAGER_CONNECT_FAILED);
-  } else {
-    wifiHasConfig = true;
-  }
-}
-
-void debug(String msg) {
-  if (DEBUG)
-    Serial.print(msg);
-}
-
-void debug(int msg) {
-  if (DEBUG)
-    Serial.print(msg);
-}
-
-void debugln(String msg) {
-  if (DEBUG)
-    Serial.println(msg);
-}
-
-void debugln(int msg) {
-  if (DEBUG)
-    Serial.println(msg);
-}
-
-String getNormalizedMac() {
-  String mac = WiFi.macAddress();
-  mac.replace(":", "");
-  mac.toLowerCase();
-  return mac;
-}
-
-void boardInit(void) {
-  if (Wire.begin(ag.getI2cSdaPin(), ag.getI2cSclPin()) == false) {
-    failedHandler("Init I2C failed");
-  }
-
-  ag.watchdog.begin();
-
-  ag.button.begin();
-
-  ag.statusLed.begin();
-
-  if (ag.pms5003t_1.begin(Serial0) == false) {
-    failedHandler("Init PMS5003T failed");
-  }
-
-  if (ag.s8.begin(Serial1) == false) {
-    failedHandler("Init SenseAirS8 failed");
-  }
-
-  if (ag.sgp41.begin(Wire) == false) {
-    failedHandler("Init SGP41 failed");
-  }
-}
-
-void failedHandler(String msg) {
-  while (true) {
-    Serial.println(msg);
-    vTaskDelay(1000);
-  }
-}
-
-void updateServerConfigLoadTime(void) {
-  serverConfigLoadTime = millis();
-  if (serverConfigLoadTime == 0) {
-    serverConfigLoadTime = 1;
-  }
-}
-
-void showConfig(void) {
-  Serial.println("Server configuration: ");
-  Serial.printf("         inF: %s\r\n", serverConfig.inF ? "true" : "false");
-  Serial.printf("     inUSAQI: %s\r\n",
-                serverConfig.inUSAQI ? "true" : "false");
-  Serial.printf("useRGBLedBar: %d\r\n", (int)serverConfig.ledBarMode);
-  Serial.printf("       Model: %.*s\r\n", sizeof(serverConfig.model),
-                serverConfig.model);
-  Serial.printf(" Mqtt Broker: %.*s\r\n", sizeof(serverConfig.mqttBroker),
-                serverConfig.mqttBroker);
-}
-
-void getServerConfig(void) {
-  /** Only trigger load configuration again after pollServerConfigInterval sec
-   */
-  if (serverConfigLoadTime) {
-    uint32_t ms = (uint32_t)(millis() - serverConfigLoadTime);
-    if (ms < pollServerConfigInterval) {
-      return;
-    }
-  }
-
-  updateServerConfigLoadTime();
-
-  Serial.println("Trigger load server configuration");
-  if (WiFi.status() != WL_CONNECTED) {
-    Serial.println(
-        "Ignore get server configuration because WIFI not connected");
-    return;
-  }
-
-  // WiFiClient wifiClient;
-  HTTPClient httpClient;
-
-  String getUrl = "http://hw.airgradient.com/sensors/airgradient:" +
-                  String(getNormalizedMac()) + "/one/config";
-  Serial.println("HttpClient get: " + getUrl);
-  if (httpClient.begin(getUrl) == false) {
-    Serial.println("HttpClient init failed");
-    updateServerConfigLoadTime();
-    return;
-  }
-
-  int respCode = httpClient.GET();
-
-  /** get failure */
-  if (respCode != 200) {
-    Serial.printf("HttpClient get failed: %d\r\n", respCode);
-    updateServerConfigLoadTime();
-    httpClient.end();
-    configFailed = true;
-    return;
-  }
-
-  String respContent = httpClient.getString();
-  Serial.println("Server config: " + respContent);
-  httpClient.end();
-
-  /** Parse JSON */
-  JSONVar root = JSON.parse(respContent);
-  if (JSON.typeof_(root) == "undefined") {
-    Serial.println("Server configura JSON invalid");
-    updateServerConfigLoadTime();
-    configFailed = true;
-    return;
-  }
-  configFailed = false;
-
-  /** Get "country" */
-  bool inF = serverConfig.inF;
-  if (JSON.typeof_(root["country"]) == "string") {
-    String country = root["country"];
-    if (country == "US") {
-      inF = true;
-    } else {
-      inF = false;
-    }
-  }
-
-  /** Get "pmStandard" */
-  bool inUSAQI = serverConfig.inUSAQI;
-  if (JSON.typeof_(root["pmStandard"]) == "string") {
-    String standard = root["pmStandard"];
-    if (standard == "ugm3") {
-      inUSAQI = false;
-    } else {
-      inUSAQI = true;
-    }
-  }
-
-  /** Get CO2 "co2CalibrationRequested" */
-  co2CalibrationRequest = false;
-  if (JSON.typeof_(root["co2CalibrationRequested"]) == "boolean") {
-    co2CalibrationRequest = root["co2CalibrationRequested"];
-  }
-
-  /** get "model" */
-  String model = "";
-  if (JSON.typeof_(root["model"]) == "string") {
-    String _model = root["model"];
-    model = _model;
-  }
-
-  /** get "mqttBrokerUrl" */
-  String mqtt = "";
-  if (JSON.typeof_(root["mqttBrokerUrl"]) == "string") {
-    String _mqtt = root["mqttBrokerUrl"];
-    mqtt = _mqtt;
-  }
-
-  if (inF != serverConfig.inF) {
-    serverConfig.inF = inF;
-  }
-  if (inUSAQI != serverConfig.inUSAQI) {
-    serverConfig.inUSAQI = inUSAQI;
-  }
-  if (model.length()) {
-    if (model != String(serverConfig.model)) {
-      memset(serverConfig.model, 0, sizeof(serverConfig.model));
-      memcpy(serverConfig.model, model.c_str(), model.length());
-    }
-  }
-  if (mqtt.length()) {
-    if (mqtt != String(serverConfig.mqttBroker)) {
-      memset(serverConfig.mqttBroker, 0, sizeof(serverConfig.mqttBroker));
-      memcpy(serverConfig.mqttBroker, mqtt.c_str(), mqtt.length());
-    }
-  }
-
-  /** Show server configuration */
-  showConfig();
-
-  /** Calibration */
-  if (co2CalibrationRequest) {
-    co2Calibration();
-  }
-}
-
-void co2Calibration(void) {
-  /** Count down for co2CalibCountdown secs */
-  for (int i = 0; i < co2CalibCountdown; i++) {
-    Serial.printf("Start CO2 calib after %d sec\r\n", co2CalibCountdown - i);
-    delay(1000);
-  }
-
-  if (ag.s8.setBaselineCalibration()) {
-    Serial.println("Calibration success");
-    delay(1000);
-    Serial.println("Wait for calib finish...");
-    int count = 0;
-    while (ag.s8.isBaseLineCalibrationDone() == false) {
-      delay(1000);
-      count++;
-    }
-    Serial.printf("Calib finish after %d sec\r\n", count);
-    delay(2000);
-  } else {
-    Serial.println("Calibration failure!!!");
-    delay(2000);
-  }
-}
-
-void ledSmHandler(int sm) {
-  if (sm > APP_SM_NORMAL) {
-    return;
-  }
-
-  ledSmState = sm;
-  switch (sm) {
-  case APP_SM_WIFI_MANAGER_MODE: {
-    ag.statusLed.setToggle();
-    break;
-  }
-  case APP_SM_WIFI_MAMAGER_PORTAL_ACTIVE: {
-    ag.statusLed.setOn();
-    break;
-  }
-  case APP_SM_WIFI_MANAGER_STA_CONNECTING: {
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_MANAGER_STA_CONNECTED: {
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_OK_SERVER_CONNECTING: {
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_OK_SERVER_CONNNECTED: {
-    ag.statusLed.setOff();
-    ag.statusLed.setOn();
-    delay(50);
-    ag.statusLed.setOff();
-    delay(950);
-    ag.statusLed.setOn();
-    delay(50);
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_MANAGER_CONNECT_FAILED: {
-    ag.statusLed.setOff();
-    for (int j = 0; j < 3; j++) {
-      for (int i = 0; i < 3 * 2; i++) {
-        ag.statusLed.setToggle();
-        delay(100);
-      }
-      delay(2000);
-    }
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_OK_SERVER_CONNECT_FAILED: {
-    ag.statusLed.setOff();
-    for (int j = 0; j < 3; j++) {
-      for (int i = 0; i < 4 * 2; i++) {
-        ag.statusLed.setToggle();
-        delay(100);
-      }
-      delay(2000);
-    }
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_OK_SERVER_OK_SENSOR_CONFIG_FAILED: {
-    ag.statusLed.setOff();
-    for (int j = 0; j < 3; j++) {
-      for (int i = 0; i < 5 * 2; i++) {
-        ag.statusLed.setToggle();
-        delay(100);
-      }
-      delay(2000);
-    }
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_WIFI_LOST: {
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_SERVER_LOST: {
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_SENSOR_CONFIG_FAILED: {
-    ag.statusLed.setOff();
-    break;
-  }
-  case APP_SM_NORMAL: {
-    ag.statusLed.setOff();
-    break;
-  }
-  default:
-    break;
-  }
-}

examples/TestCO2/TestCO2.ino

@@ -2,41 +2,47 @@
 This is sample code for the AirGradient library with a minimal implementation to read CO2 values from the SenseAir S8 sensor.
 
 CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
+
 */
 
 #include <AirGradient.h>
 
 #ifdef ESP8266
-AirGradient ag = AirGradient(BOARD_DIY_PRO_INDOOR_V4_2);
-// AirGradient ag = AirGradient(BOARD_DIY_BASIC_KIT);
+AirGradient ag = AirGradient(DIY_BASIC);
 #else
-// AirGradient ag = AirGradient(BOARD_ONE_INDOOR_MONITOR_V9_0);
-AirGradient ag = AirGradient(BOARD_OUTDOOR_MONITOR_V1_3);
+/** Create airgradient instance for 'OPEN_AIR_OUTDOOR' board */
+AirGradient ag = AirGradient(OPEN_AIR_OUTDOOR);
 #endif
 
 void failedHandler(String msg);
 
-void setup() {
+void setup()
+{
   Serial.begin(115200);
 
   /** Init CO2 sensor */
 #ifdef ESP8266
-  if (ag.s8.begin(&Serial) == false) {
+  if (ag.s8.begin(&Serial) == false)
+  {
 #else
-  if (ag.s8.begin(Serial1) == false) {
+  if (ag.s8.begin(Serial0) == false)
+  {
 #endif
     failedHandler("SenseAir S8 init failed");
   }
 }
 
-void loop() {
-  int CO2 = ag.s8.getCo2();
-  Serial.printf("CO2: %d\r\n", CO2);
+void loop()
+{
+  int co2Ppm = ag.s8.getCo2();
+  Serial.printf("CO2: %d\r\n", co2Ppm);
   delay(5000);
 }
 
-void failedHandler(String msg) {
-  while (true) {
+void failedHandler(String msg)
+{
+  while (true)
+  {
     Serial.println(msg);
     delay(1000);
   }

examples/TestESP32/TestESP32.ino

@@ -1,369 +0,0 @@
-#include <AirGradient.h>
-#include <HardwareSerial.h>
-#include <Wire.h>
-
-/**
- * AirGradient use ESP32C3 has default Serial0 use for PMS5003, to print log
- * should use esp-hal-log instead.
- */
-#include <esp32-hal-log.h>
-
-/**
- * @brief Define test board
- */
-#define TEST_BOARD_OUTDOOR_MONITOR_V1_3 0
-#define TEST_BOARD_ONE_INDOOR_MONITOR_V9_0 1
-/**
- * @brief Define test sensor
- */
-#define TEST_SENSOR_SenseAirS8 0
-#define TEST_SENSOR_SHT4x 0
-#define TEST_SENSOR_SGP4x 0
-#define TEST_SWITCH 0
-#define TEST_OLED 0
-#if TEST_BOARD_OUTDOOR_MONITOR_V1_3
-#define TEST_STATUS_LED 0
-#define TEST_PMS5003T 1
-#endif
-#define TEST_WATCHDOG 1
-
-#if TEST_BOARD_ONE_INDOOR_MONITOR_V9_0
-#define TEST_LED_BAR 1
-#define TEST_SENSOR_PMS5003 0
-#endif
-
-#if TEST_BOARD_OUTDOOR_MONITOR_V1_3
-AirGradient ag(BOARD_OUTDOOR_MONITOR_V1_3);
-#elif TEST_BOARD_ONE_INDOOR_MONITOR_V9_0
-AirGradient ag(BOARD_ONE_INDOOR_MONITOR_V9_0);
-#else
-#error "Must enable board test
-#endif
-
-void setup() {
-
-  /** Print All AirGradient board define */
-  printBoardDef(NULL);
-
-#if TEST_SENSOR_SenseAirS8
-  /** Cause Serial is use default for PMS, CO2S8 should be use Serial 1
-   * Serial 1 will be init by SenseAirS8 don't need to init any more on user
-   * code
-   */
-  if (ag.s8.begin(Serial1)) {
-    log_i("CO2S8 sensor init success");
-  } else {
-    log_i("CO2S8 sensor init failure");
-  }
-
-  log_i("Start baseline calib");
-  if (ag.s8.setBaselineCalibration()) {
-    log_i("Calib success");
-  } else {
-    log_e("Calib failure");
-  }
-  delay(5000); // Wait for calib done
-#endif
-
-#if TEST_SENSOR_PMS5003
-  if (ag.pms5003.begin(Serial0)) {
-    log_i("PMS5003 sensor init success");
-  } else {
-    log_i("PMS5003 sensor init failure");
-  }
-#endif
-
-#if TEST_PMS5003T
-  /**
-   * @brief PMS5003T_1 alway connect to Serial (esp32c3 RXD0, RXD0)
-   */
-  if (ag.pms5003t_1.begin(Serial)) {
-    log_i("PMS5003T_1 sensor init success");
-  } else {
-    log_i("PMS5003T_1 sensor init failure");
-  }
-
-  // TODO Only test without senseair s8 because it's share the UART bus
-#if TEST_SENSOR_SenseAirS8 == 0
-  if (ag.pms5003t_2.begin(Serial1)) {
-    log_i("PMS5003T_2 sensor init success");
-  } else {
-    log_i("PMS5003T_2 sensor init failure");
-  }
-#endif
-#endif
-
-#if TEST_SENSOR_SHT4x || TEST_SENSOR_SGP4x || TEST_OLED
-  Wire.begin(ag.getI2cSdaPin(), ag.getI2cSclPin());
-#endif
-
-#if TEST_SENSOR_SHT4x
-
-  if (ag.sht.begin(Wire)) {
-    log_i("SHT init success");
-  } else {
-    log_i("SHT init failed");
-  }
-#endif
-
-#if TEST_SENSOR_SGP4x
-  if (ag.sgp41.begin(Wire)) {
-    log_i("SGP init success");
-  } else {
-    log_e("SGP init failure");
-  }
-#endif
-
-#if TEST_LED
-  led.begin();
-#endif
-
-#if TEST_SWITCH
-  ag.button.begin();
-#endif
-
-#if TEST_OLED
-  ag.display.begin(Wire);
-  ag.display.setTextSize(1);
-  ag.display.setCursor(0, 0);
-  ag.display.setTextColor(1);
-  ag.display.setText("180s to connect to wifi hostpost AC-xxxxx");
-  ag.display.show();
-#endif
-
-#if TEST_STATUS_LED
-  ag.statusLed.begin();
-#endif
-
-#if TEST_LED_BAR
-  ag.ledBar.begin();
-#endif
-
-#if TEST_WATCHDOG
-  ag.watchdog.begin();
-#endif
-}
-
-void loop() {
-  uint32_t ms;
-#if TEST_SENSOR_SenseAirS8
-  static uint32_t lastTime = 0;
-
-  /** Wait for sensor ready */
-  ms = (uint32_t)(millis() - lastTime);
-  if (ms >= 1000) {
-    lastTime = millis();
-    log_i("CO2: %d (PPM)", ag.s8.getCo2());
-  }
-#endif
-
-#if TEST_SENSOR_PMS5003
-  static uint32_t pmsTime = 0;
-  ms = (uint32_t)(millis() - pmsTime);
-
-  if (ms >= 1000) {
-    pmsTime = millis();
-    if (ag.pms5003.readData()) {
-      log_i("Passive mode PM 1.0  (ug/m3): %d", ag.pms5003.getPm10Ae());
-      log_i("Passive mode PM 2.5  (ug/m3): %d", ag.pms5003.getPm25Ae());
-      log_i("Passive mode PM 10.0 (ug/m3): %d", ag.pms5003.getPm10Ae());
-    } else {
-      log_i("PMS sensor read failure");
-    }
-  }
-#endif
-
-#if TEST_PMS5003T
-  static uint32_t pmsTime = 0;
-  ms = (uint32_t)(millis() - pmsTime);
-
-  if (ms >= 1000) {
-    pmsTime = millis();
-    if (ag.pms5003t_1.readData()) {
-      log_i("PMS5003_1 PM 1.0  (ug/m3): %d", ag.pms5003t_1.getPm10Ae());
-      log_i("PMS5003_1 PM 2.5  (ug/m3): %d", ag.pms5003t_1.getPm25Ae());
-      log_i("PMS5003_1 PM 10.0 (ug/m3): %d", ag.pms5003t_1.getPm10Ae());
-      log_i("PMS5003_1 PM 3.0  (ug/m3): %d",
-            ag.pms5003t_1.getPm03ParticleCount());
-      log_i("Temperature                 : %02f °C",
-            ag.pms5003t_1.getTemperature());
-      log_i("Humidity                    : %02f %%",
-            ag.pms5003t_1.getRelativeHumidity());
-    } else {
-      log_i("PMS5003_1 sensor read failure");
-    }
-
-    if (ag.pms5003t_2.readData()) {
-      log_i("PMS5003_2 PM 1.0  (ug/m3): %d", ag.pms5003t_2.getPm10Ae());
-      log_i("PMS5003_2 PM 2.5  (ug/m3): %d", ag.pms5003t_2.getPm25Ae());
-      log_i("PMS5003_2 PM 10.0 (ug/m3): %d", ag.pms5003t_2.getPm10Ae());
-      log_i("PMS5003_2 PM 3.0  (ug/m3): %d",
-            ag.pms5003t_2.getPm03ParticleCount());
-      // log_i("Temperature                 : %02f °C",
-      //       ag.pms5003t_1.getTemperature());
-      // log_i("Humidity                    : %02f %%",
-      //       ag.pms5003t_1.getRelativeHumidity());
-    } else {
-      log_i("PMS5003_2 sensor read failure");
-    }
-  }
-#endif
-
-#if TEST_SENSOR_SHT4x
-  /**
-   * @brief Get SHT sensor data each 1sec
-   *
-   */
-  static uint32_t shtTime = 0;
-  ms = (uint32_t)(millis() - shtTime);
-  if (ms >= 1000) {
-    shtTime = millis();
-    log_i("Get sht temperature: %0.2f (degree celsius)",
-          ag.sht.getTemperature());
-    log_i("Get sht temperature: %0.2f (%%)", ag.sht.getRelativeHumidity());
-  }
-#endif
-
-#if TEST_SENSOR_SGP4x
-  static uint32_t sgpTime;
-  ms = (uint32_t)(millis() - sgpTime);
-  if (ms >= 1000) {
-    sgpTime = millis();
-    uint16_t rawVOC;
-    log_i("Get TVOC: %d", ag.sgp41.getTvocIndex());
-    log_i("Get NOx: %d", ag.sgp41.getNoxIndex());
-  }
-#endif
-
-#if TEST_LED
-  static uint32_t ledTime;
-#if TEST_BOARD_OUTDOOR_MONITOR_V1_3
-  // ms = (uint32_t)(millis() - ledTime);
-  // if(ms >= 500)
-  // {
-  //   ledTime = millis();
-  //   led.ledToggle();
-  // }
-#elif TEST_BOARD_ONE_INDOOR_MONITOR_V9_0
-
-  static int ledIndex;
-  static int ledIndexOld;
-  ms = (uint32_t)(millis() - ledTime);
-  if (ms >= 50) {
-    ledTime = millis();
-    if (ledIndex == ledIndexOld) {
-      led.ledOff();
-    } else {
-      // Turn last LED off
-      led.ledSetColor(0, 0, 0, ledIndexOld);
-    }
-
-    // Turn new led ON
-    led.ledSetColor(255, 0, 0, ledIndex);
-    ledIndexOld = ledIndex;
-    ledIndex++;
-    if (ledIndex >= led.getNumberOfLed()) {
-      ledIndex = 0;
-    }
-  }
-#else
-#endif
-
-#endif
-
-#if TEST_SWITCH
-  static PushButton::State stateOld = PushButton::State::BUTTON_RELEASED;
-  PushButton::State state = ag.button.getState();
-  if (state != stateOld) {
-    stateOld = state;
-    log_i("Button state changed: %s", ag.button.toString(state).c_str());
-    if (state == PushButton::State::BUTTON_PRESSED) {
-      ag.statusLed.setOn();
-    } else {
-      ag.statusLed.setOff();
-    }
-  }
-#endif
-
-#if TEST_LED_BAR
-  static uint32_t ledTime;
-  static uint8_t ledNum = 0;
-  static uint8_t ledIndex = 0;
-  static uint8_t ledStep = 0;
-  static bool ledOn = false;
-
-  if (ledNum == 0) {
-    ledNum = ag.ledBar.getNumberOfLed();
-    log_i("Get number of led: %d", ledNum);
-    if (ledNum) {
-      ag.ledBar.setBrighness(0xff);
-      for (int i = 0; i < ledNum; i++) {
-        // ag.ledBar.setColor(0xff, 0xff, 0xff, i);
-        // ag.ledBar.setColor(204, 136, 153, i);
-        // ag.ledBar.setColor(204, 0, 0, i);
-        // ag.ledBar.setColor(204, 100, 153, i);
-        ag.ledBar.setColor(0, 136, 255, i);
-      }
-      ag.ledBar.show();
-    }
-  } else {
-    ms = (uint32_t)(millis() - ledTime);
-    if (ms >= 500) {
-      ledTime = millis();
-      switch (ledStep) {
-      case 0: {
-        ag.ledBar.setColor(255, 0, 0, ledIndex);
-        ledIndex++;
-        if (ledIndex >= ledNum) {
-          ag.ledBar.setColor(0, 0, 0);
-          ledIndex = 0;
-          ledStep = 1;
-        }
-        ag.ledBar.show();
-        break;
-      }
-      case 1: {
-        ledIndex++;
-        if (ledIndex >= ledNum) {
-          ag.ledBar.setColor(255, 0, 0);
-          ag.ledBar.show();
-          ledIndex = ledNum - 1;
-          ledStep = 2;
-        }
-        break;
-      }
-      case 2: {
-        if (ledOn) {
-          ag.ledBar.setColor(255, 0, 0);
-        } else {
-          ag.ledBar.setColor(0, 0, 0);
-        }
-        ledOn = !ledOn;
-        ag.ledBar.show();
-
-        ledIndex--;
-        if (ledIndex == 0) {
-          ag.ledBar.setColor(0, 0, 0);
-          ag.ledBar.show();
-          ledStep = 0;
-          ledIndex = 0;
-        }
-        break;
-      }
-      default:
-        break;
-      }
-    }
-  }
-#endif
-
-#if TEST_WATCHDOG
-  static uint32_t wdgTime;
-  ms = (uint32_t)(millis() - wdgTime);
-  if (ms >= (1000 * 60)) {
-    wdgTime = millis();
-    /** Reset watchdog reach 1 minutes */
-    ag.watchdog.reset();
-  }
-#endif
-}

examples/TestESP8266/TestESP8266.ino

@@ -1,164 +0,0 @@
-#include <AirGradient.h>
-#include <Wire.h>
-
-/**
- * @brief Define test board
- */
-#define TEST_BOARD_DIY_BASIC_KIT 0
-#define TEST_BOARD_DIY_PRO_INDOOR_V4_2 1
-
-/**
- * @brief Define test sensor
- */
-#define TEST_SENSOR_SenseAirS8 0
-#define TEST_SENSOR_PMS5003 0
-#define TEST_SENSOR_SHT4x 0
-#define TEST_SENSOR_SGP4x 1
-#define TEST_SWITCH 0
-#define TEST_OLED 0
-
-#if TEST_BOARD_DIY_BASIC_KIT
-AirGradient ag(BOARD_DIY_BASIC_KIT);
-#elif TEST_BOARD_DIY_PRO_INDOOR_V4_2
-AirGradient ag(BOARD_DIY_PRO_INDOOR_V4_2);
-#else
-#error "Board test not defined"
-#endif
-
-void setup() {
-  Serial.begin(115200);
-
-  /** Print All AirGradient board define */
-  printBoardDef(&Serial);
-
-#if TEST_SENSOR_SenseAirS8
-  if (ag.s8.begin(&Serial) == true) {
-    Serial.println("CO2S8 sensor init success");
-  } else {
-    Serial.println("CO2S8 sensor init failure");
-  }
-
-  if (ag.s8.setBaselineCalibration()) {
-    Serial.println("Manual calib success");
-  } else {
-    Serial.println("Manual calib failure");
-  }
-  delay(5000);
-#endif
-
-#if TEST_SENSOR_PMS5003
-  if (ag.pms5003.begin(&Serial) == true) {
-    Serial.println("PMS5003 sensor init success");
-  } else {
-    Serial.println("PMS5003 sensor init failure");
-  }
-#endif
-
-#if TEST_SENSOR_SHT4x || TEST_SENSOR_SGP4x || TEST_OLED
-  Wire.begin(ag.getI2cSdaPin(), ag.getI2cSclPin());
-#endif
-
-#if TEST_SENSOR_SHT4x
-  if (ag.sht.begin(Wire, Serial)) {
-    Serial.println("SHT init success");
-  } else {
-    Serial.println("SHT init failed");
-  }
-#endif
-
-#if TEST_SENSOR_SGP4x
-  if (ag.sgp41.begin(Wire, Serial)) {
-    Serial.println("SGP init succses");
-  } else {
-    Serial.println("SGP init failure");
-  }
-#endif
-
-#if TEST_SWITCH
-  ag.button.begin(Serial);
-#endif
-
-#if TEST_OLED
-  ag.display.begin(Wire, Serial);
-  ag.display.setTextSize(1);
-  ag.display.setCursor(0, 0);
-  ag.display.setTextColor(1);
-  ag.display.setText("Hello");
-  ag.display.show();
-#endif
-}
-
-void loop() {
-  uint32_t ms;
-#if TEST_SENSOR_SenseAirS8
-  static uint32_t lastTime = 0;
-
-  /** Wait for sensor ready */
-  // if(co2s8.isReady())
-  // {
-  // Get sensor data each 1sec
-  ms = (uint32_t)(millis() - lastTime);
-  if (ms >= 1000) {
-    lastTime = millis();
-    Serial.printf("CO2: %d (PMM)\r\n", ag.s8.getCo2());
-  }
-  // }
-#endif
-
-#if TEST_SENSOR_PMS5003
-  static uint32_t pmsTime = 0;
-  ms = (uint32_t)(millis() - pmsTime);
-  if (ms >= 1000) {
-    pmsTime = millis();
-    if (ag.pms5003.readData()) {
-      Serial.printf("Passive mode PM 1.0  (ug/m3): %d\r\n",
-                    ag.pms5003.getPm01Ae());
-      Serial.printf("Passive mode PM 2.5  (ug/m3): %d\r\n",
-                    ag.pms5003.getPm25Ae());
-      Serial.printf("Passive mode PM 10.5 (ug/m3): %d\r\n",
-                    ag.pms5003.getPm10Ae());
-    }
-  }
-#endif
-
-#if TEST_SENSOR_SHT4x
-  /**
-   * @brief Get SHT sensor data each 1sec
-   *
-   */
-  static uint32_t shtTime = 0;
-  ms = (uint32_t)(millis() - shtTime);
-  if (ms >= 1000) {
-    shtTime = millis();
-    float temperature, humidity;
-    Serial.printf("SHT Temperature: %f, Humidity: %f\r\n",
-                  ag.sht.getTemperature(), ag.sht.getRelativeHumidity());
-  }
-#endif
-
-#if TEST_SENSOR_SGP4x
-  static uint32_t sgpTime;
-  ms = (uint32_t)(millis() - sgpTime);
-
-  /***
-   * Must call this task on loop and avoid delay on loop over 1000 ms
-  */
-  ag.sgp41.handle();
-
-  if (ms >= 1000) {
-    sgpTime = millis();
-    Serial.printf("SGP TVOC: %d, NOx: %d\r\n", ag.sgp41.getTvocIndex(),
-                  ag.sgp41.getNoxIndex());
-  }
-#endif
-
-#if TEST_SWITCH
-  static PushButton::State stateOld = PushButton::State::BUTTON_RELEASED;
-  PushButton::State state = ag.button.getState();
-  if (state != stateOld) {
-    stateOld = state;
-    Serial.printf("Button state changed: %s\r\n",
-                  ag.button.toString(state).c_str());
-  }
-#endif
-}

examples/TestPM/TestPM.ino

@@ -1,5 +1,6 @@
 /*
-This is sample code for the AirGradient library with a minimal implementation to read PM values from the Plantower sensor.
+This is sample code for the AirGradient library with a minimal implementation
+to read PM values from the Plantower sensor.
 
 CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
 */
@@ -7,11 +8,10 @@ CC BY-SA 4.0 Attribution-ShareAlike 4.0 International License
 #include <AirGradient.h>
 
 #ifdef ESP8266
-AirGradient ag = AirGradient(BOARD_DIY_PRO_INDOOR_V4_2);
-// AirGradient ag = AirGradient(BOARD_DIY_BASIC_KIT);
+AirGradient ag = AirGradient(DIY_BASIC);
 #else
-// AirGradient ag = AirGradient(BOARD_ONE_INDOOR_MONITOR_V9_0);
-AirGradient ag = AirGradient(BOARD_OUTDOOR_MONITOR_V1_3);
+AirGradient ag = AirGradient(ONE_INDOOR);
+// AirGradient ag = AirGradient(OPEN_AIR_OUTDOOR);
 #endif
 
 void failedHandler(String msg);
@@ -19,46 +19,72 @@ void failedHandler(String msg);
 void setup() {
   Serial.begin(115200);
 #ifdef ESP8266
-  if(ag.pms5003.begin(&Serial) == false) {
+  if (ag.pms5003.begin(&Serial) == false) {
     failedHandler("Init PMS5003 failed");
   }
 #else
-  if (ag.getBoardType() == BOARD_OUTDOOR_MONITOR_V1_3) {
-    if(ag.pms5003t_1.begin(Serial0) == false) {
+  if (ag.getBoardType() == OPEN_AIR_OUTDOOR) {
+    if (ag.pms5003t_1.begin(Serial0) == false) {
       failedHandler("Init PMS5003T failed");
     }
   } else {
-    if(ag.pms5003.begin(Serial0) == false) {
+    if (ag.pms5003.begin(Serial0) == false) {
       failedHandler("Init PMS5003T failed");
     }
   }
 #endif
 }
 
+uint32_t lastRead = 0;
 void loop() {
   int PM2;
+  bool readResul = false;
+
+  uint32_t ms = (uint32_t)(millis() - lastRead);
+  if (ms >= 5000) {
+    lastRead = millis();
 #ifdef ESP8266
+    if (ag.pms5003.isFailed() == false) {
       PM2 = ag.pms5003.getPm25Ae();
       Serial.printf("PM2.5 in ug/m3: %d\r\n", PM2);
-  Serial.printf("PM2.5 in US AQI: %d\r\n", ag.pms5003.convertPm25ToUsAqi(PM2));
-#else
-  if (ag.getBoardType() == BOARD_OUTDOOR_MONITOR_V1_3) {
-    PM2 = ag.pms5003t_1.getPm25Ae();
+      Serial.printf("PM2.5 in US AQI: %d\r\n",
+                    ag.pms5003.convertPm25ToUsAqi(PM2));
     } else {
+      Serial.println("PMS sensor failed");
+    }
+#else
+    if (ag.getBoardType() == OPEN_AIR_OUTDOOR) {
+      if (ag.pms5003t_1.isFailed() == false) {
+        PM2 = ag.pms5003t_1.getPm25Ae();
+        readResul = true;
+      }
+    } else {
+      if (ag.pms5003.isFailed() == false) {
         PM2 = ag.pms5003.getPm25Ae();
+        readResul = true;
+      }
     }
 
+    if (readResul) {
       Serial.printf("PM2.5 in ug/m3: %d\r\n", PM2);
-  if (ag.getBoardType() == BOARD_OUTDOOR_MONITOR_V1_3) {
+      if (ag.getBoardType() == OPEN_AIR_OUTDOOR) {
         Serial.printf("PM2.5 in US AQI: %d\r\n",
                       ag.pms5003t_1.convertPm25ToUsAqi(PM2));
       } else {
         Serial.printf("PM2.5 in US AQI: %d\r\n",
                       ag.pms5003.convertPm25ToUsAqi(PM2));
       }
+    } else {
+      Serial.println("PMS sensor failed");
+    }
 #endif
+  }
 
-  delay(5000);
+  if (ag.getBoardType() == OPEN_AIR_OUTDOOR) {
+    ag.pms5003t_1.handle();
+  } else {
+    ag.pms5003.handle();
+  }
 }
 
 void failedHandler(String msg) {

examples/TestSht/TestSht.ino

@@ -0,0 +1,39 @@
+#include <AirGradient.h>
+
+#if defined(ESP8266)
+AirGradient ag(DIY_BASIC);
+#else
+AirGradient ag(ONE_INDOOR);
+#endif
+
+void failedHandler(String msg);
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Hello");
+  Wire.begin(ag.getI2cSdaPin(), ag.getI2cSclPin());
+  delay(1000);
+
+  if (ag.sht.begin(Wire) == false) {
+    failedHandler("SHT init failed");
+  }
+}
+
+void loop() {
+  if (ag.sht.measure()) {
+    float hum = ag.sht.getRelativeHumidity();
+    float temp = ag.sht.getTemperature();
+    Serial.printf("Get temperature: %f\r\n", temp);
+    Serial.printf("   Get humidity: %f\r\n", hum);
+  } else {
+    Serial.println("Measure failed");
+  }
+  delay(1000);
+}
+
+void failedHandler(String msg) {
+  while (true) {
+    Serial.println(msg);
+    delay(1000);
+  }
+}

library.properties

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

@@ -1,11 +1,11 @@
 #include "AirGradient.h"
 
-#define AG_LIB_VER "3.0.0"
+#define AG_LIB_VER "3.0.9"
 
 AirGradient::AirGradient(BoardType type)
-    : pms5003(type), pms5003t_1(type), pms5003t_2(type), s8(type), sht(type), sgp41(type),
+    : pms5003(type), pms5003t_1(type), pms5003t_2(type), s8(type), sgp41(type),
       display(type), boardType(type), button(type), statusLed(type),
-      ledBar(type), watchdog(type) {}
+      ledBar(type), watchdog(type), sht(type) {}
 
 /**
  * @brief Get pin number for I2C SDA
@@ -36,3 +36,11 @@ int AirGradient::getI2cSclPin(void) {
 String AirGradient::getVersion(void) { return AG_LIB_VER; }
 
 BoardType AirGradient::getBoardType(void) { return boardType; }
+
+double AirGradient::round2(double value) {
+  return (int)(value * 100 + 0.5) / 100.0;
+}
+
+String AirGradient::getBoardName(void) {
+  return String(getBoardDefName(boardType));
+}

src/AirGradient.h

@@ -1,18 +1,22 @@
 #ifndef _AIR_GRADIENT_H_
 #define _AIR_GRADIENT_H_
 
-#include "bsp/BoardDef.h"
-#include "bsp/LedBar.h"
-#include "bsp/PushButton.h"
-#include "bsp/StatusLed.h"
-#include "bsp/HardwareWatchdog.h"
-#include "co2/s8.h"
-#include "display/oled.h"
-#include "pm/pms5003.h"
-#include "pm/pms5003t.h"
-#include "sgp/sgp41.h"
-#include "sht/sht4x.h"
+#include "Display/Display.h"
+#include "Main/BoardDef.h"
+#include "Main/HardwareWatchdog.h"
+#include "Main/LedBar.h"
+#include "Main/PushButton.h"
+#include "Main/StatusLed.h"
+#include "PMS/PMS5003.h"
+#include "PMS/PMS5003T.h"
+#include "S8/S8.h"
+#include "Sgp41/Sgp41.h"
+#include "Sht/Sht.h"
 
+/**
+ * @brief Class with define all the sensor has supported by Airgradient. Each
+ * sensor usage must be init before use.
+ */
 class AirGradient {
 public:
   AirGradient(BoardType type);
@@ -21,7 +25,15 @@ public:
    * @brief Plantower PMS5003 sensor
    */
   PMS5003 pms5003;
+  /**
+   * @brief Plantower PMS5003T sensor: connect to PM1 connector on
+   * OPEN_AIR_OUTDOOR.
+   */
   PMS5003T pms5003t_1;
+  /**
+   * @brief Plantower PMS5003T sensor: connect to PM2 connector on
+   * OPEN_AIR_OUTDOOR.
+   */
   PMS5003T pms5003t_2;
 
   /**
@@ -30,18 +42,19 @@ public:
   S8 s8;
 
   /**
-   * @brief Temperature and humidity sensor
+   * @brief Temperature and humidity sensor supported SHT3x and SHT4x
+   *
    */
   Sht sht;
 
   /**
-   * @brief TVOC and NOx sensor
+   * @brief  SGP41 TVOC and NOx sensor
    *
    */
   Sgp41 sgp41;
 
   /**
-   * @brief Display
+   * @brief OLED Display
    *
    */
   Display display;
@@ -55,20 +68,60 @@ public:
    * @brief LED
    */
   StatusLed statusLed;
+
+  /**
+   * @brief RGB LED array
+   *
+   */
   LedBar ledBar;
 
   /**
-   * @brief Hardware watchdog
+   * @brief External hardware watchdog
    */
   HardwareWatchdog watchdog;
 
+  /**
+   * @brief Get I2C SDA pin has of board supported
+   *
+   * @return int Pin number if -1 invalid
+   */
   int getI2cSdaPin(void);
+  /**
+   * @brief Get I2C SCL pin has of board supported
+   *
+   * @return int Pin number if -1 invalid
+   */
   int getI2cSclPin(void);
 
+  /**
+   * @brief Get the Board Type
+   *
+   * @return BoardType @ref BoardType
+   */
   BoardType getBoardType(void);
 
+  /**
+   * @brief Get the library version string
+   *
+   * @return String
+   */
   String getVersion(void);
 
+  /**
+   * @brief Get the Board Name object
+   * 
+   * @return String 
+   */
+  String getBoardName(void);
+
+  /**
+   * @brief Round double value with for 2 decimal
+   * 
+   * @param valuem Round value
+   * @return double 
+   */
+  double round2(double value);
+
 private:
   BoardType boardType;
 };

src/Display/Display.cpp

@@ -0,0 +1,282 @@
+#include "Display.h"
+#include "../Libraries/Adafruit_SH110x/Adafruit_SH110X.h"
+#include "../Libraries/Adafruit_SSD1306_Wemos_OLED/Adafruit_SSD1306.h"
+
+#define disp(func)                                                             \
+  if (this->_boardType == DIY_BASIC) {                               \
+    ((Adafruit_SSD1306 *)(this->oled))->func;                                  \
+  } else {                                                                     \
+    ((Adafruit_SH110X *)(this->oled))->func;                                   \
+  }
+
+#if defined(ESP8266)
+void Display::begin(TwoWire &wire, Stream &debugStream) {
+  this->_debugStream = &debugStream;
+  this->begin(wire);
+}
+#else
+#endif
+
+Display::Display(BoardType type) : _boardType(type) {}
+
+/**
+ * @brief Initialize display, should be call this function before call of ther,
+ * if not it's always return failure.
+ *
+ * @param wire TwoWire instance, Must be initialized
+ */
+void Display::begin(TwoWire &wire) {
+  if (_isBegin) {
+    AgLog("Initialized, call end() then try again");
+    return;
+  }
+
+  this->_bsp = getBoardDef(this->_boardType);
+  if ((this->_bsp == nullptr) || (this->_bsp->I2C.supported == false) ||
+      (this->_bsp->OLED.supported == false)) {
+    AgLog("Init failed: board not supported");
+    return;
+  }
+
+  /** Init OLED */
+  if (this->_boardType == DIY_BASIC) {
+    AgLog("Init Adafruit_SSD1306");
+    Adafruit_SSD1306 *_oled = new Adafruit_SSD1306();
+    _oled->begin(wire, SSD1306_SWITCHCAPVCC, this->_bsp->OLED.addr);
+    this->oled = _oled;
+  } else {
+    AgLog("Init Adafruit_SH1106G");
+    Adafruit_SH1106G *_oled = new Adafruit_SH1106G(
+        this->_bsp->OLED.width, this->_bsp->OLED.height, &wire);
+    _oled->begin(this->_bsp->OLED.addr, false);
+    this->oled = _oled;
+  }
+
+  this->_isBegin = true;
+  disp(clearDisplay());
+  AgLog("Initialize");
+}
+
+/**
+ * @brief Clear display buffer
+ *
+ */
+void Display::clear(void) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(clearDisplay());
+}
+
+/**
+ * @brief Invert display color
+ *
+ * @param i 0: black, other is white
+ */
+void Display::invertDisplay(uint8_t i) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(invertDisplay(i));
+}
+
+/**
+ * @brief Send display frame buffer to OLED
+ *
+ */
+void Display::show() {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(display());
+}
+
+/**
+ * @brief Set display contract
+ *
+ * @param value Contract (0;255);
+ */
+void Display::setContrast(uint8_t value) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(setContrast(value));
+}
+
+/**
+ * @brief Draw pixel into display frame buffer, call show to draw to
+ * display(OLED)
+ *
+ * @param x X Position
+ * @param y Y Position
+ * @param color Color (0: black, other white)
+ */
+void Display::drawPixel(int16_t x, int16_t y, uint16_t color) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(drawPixel(x, y, color));
+}
+
+/**
+ * @brief Set text size, it's scale default font instead of point to multiple
+ * font has define for special size
+ *
+ * @param size Size of text (default = 1)
+ */
+void Display::setTextSize(int size) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(setTextSize(size));
+}
+
+/**
+ * @brief Move draw cursor into new position
+ *
+ * @param x X Position
+ * @param y Y Position
+ */
+void Display::setCursor(int16_t x, int16_t y) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(setCursor(x, y));
+}
+
+/**
+ * @brief Set Text Color
+ *
+ * @param color 0:black, 1: While
+ */
+void Display::setTextColor(uint16_t color) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(setTextColor(color));
+}
+
+/**
+ * @brief Set text foreground color and background color
+ *
+ * @param foreGroundColor Text Color (foreground color)
+ * @param backGroundColor Text background color
+ */
+void Display::setTextColor(uint16_t foreGroundColor, uint16_t backGroundColor) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(setTextColor(foreGroundColor, backGroundColor));
+}
+
+/**
+ * @brief Draw text to display framebuffer, call show() to draw to display
+ * (OLED)
+ *
+ * @param text String
+ */
+void Display::setText(String text) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(print(text));
+}
+
+/**
+ * @brief Draw bitmap into display framebuffer, call show() to draw to display
+ * (OLED)
+ *
+ * @param x X Position
+ * @param y Y Position
+ * @param bitmap Bitmap buffer
+ * @param w Bitmap width
+ * @param h Bitmap hight
+ * @param color Bitmap color
+ */
+void Display::drawBitmap(int16_t x, int16_t y, const uint8_t bitmap[],
+                         int16_t w, int16_t h, uint16_t color) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(drawBitmap(x, y, bitmap, w, h, color));
+}
+
+/**
+ * @brief Set text to display framebuffer, call show() to draw into to display
+ * (OLED)
+ *
+ * @param text Character buffer
+ */
+void Display::setText(const char text[]) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(print(text));
+}
+
+/**
+ * @brief Draw line to display framebuffer, call show() to draw to
+ * display(OLED)
+ *
+ * @param x0 Start X position
+ * @param y0 Start Y position
+ * @param x1 End X Position
+ * @param y1 End Y Position
+ * @param color Color (0: black, otherwise white)
+ */
+void Display::drawLine(int x0, int y0, int x1, int y1, uint16_t color) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(drawLine(x0, y0, x1, y1, color));
+}
+
+/**
+ * @brief Draw circle to display framebuffer,
+ *
+ * @param x
+ * @param y
+ * @param r
+ * @param color
+ */
+void Display::drawCircle(int x, int y, int r, uint16_t color) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(drawCircle(x, y, r, color));
+}
+
+void Display::drawRect(int x0, int y0, int x1, int y1, uint16_t color) {
+  if (this->isBegin() == false) {
+    return;
+  }
+  disp(drawRect(x0, y0, x1, y1, color));
+}
+
+bool Display::isBegin(void) {
+  if (this->_isBegin) {
+    return true;
+  }
+  AgLog("Display not-initialized");
+  return false;
+}
+
+void Display::setRotation(uint8_t r) {
+  if (isBegin() == false) {
+    return;
+  }
+  disp(setRotation(r));
+}
+
+void Display::end(void) {
+  if (this->_isBegin == false) {
+    return;
+  }
+  _isBegin = false;
+  if (this->_boardType == DIY_BASIC) {
+    delete ((Adafruit_SSD1306 *)(this->oled));
+  } else {
+    delete ((Adafruit_SH110X *)(this->oled));
+  }
+  AgLog("De-initialize");
+}

src/Display/Display.h

@@ -1,10 +1,14 @@
 #ifndef _AIR_GRADIENT_OLED_H_
 #define _AIR_GRADIENT_OLED_H_
 
-#include "../bsp/BoardDef.h"
+#include "../Main/BoardDef.h"
 #include <Arduino.h>
 #include <Wire.h>
 
+/**
+ * @brief The class define how to handle the OLED display on Airgradient has
+ * attached or support OLED display like: ONE-V9, Basic-V4
+ */
 class Display {
 public:
   const uint16_t COLOR_WHILTE = 1;
@@ -15,10 +19,11 @@ public:
 #endif
   Display(BoardType type);
   void begin(TwoWire &wire);
+  void end(void);
 
-  void clear(void); // .clear
+  void clear(void);
   void invertDisplay(uint8_t i);
-  void show(); // .show()
+  void show();
 
   void setContrast(uint8_t value);
   void drawPixel(int16_t x, int16_t y, uint16_t color);
@@ -39,14 +44,14 @@ private:
   BoardType _boardType;
   const BoardDef *_bsp = nullptr;
   void *oled;
-  bool _isInit = false;
+  bool _isBegin = false;
 #if defined(ESP8266)
   const char *TAG = "oled";
   Stream *_debugStream = nullptr;
 #else
 
 #endif
-  bool checkInit(void);
+  bool isBegin(void);
 };
 
 #endif /** _AIR_GRADIENT_OLED_H_ */