Add HM330x Particle Sensor Support (#5)

Authored-by: Stefan Brand <seiichiro@seiichiro0185.org>
Reviewed-on: https://www.seiichiro0185.org/git/attnode/v3_firmware/pulls/5
Co-authored-by: seiichiro <seiichiro@seiichiro0185.org>
Co-committed-by: seiichiro <seiichiro@seiichiro0185.org>

lib/HM330x/HM330x.cpp

@@ -0,0 +1,94 @@
+/*
+  HM330x.cpp - Seeed HM330x Particle-Sensor Library
+  Copyright (c) 2020-2021, Stefan Brand
+  All rights reserved.
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+  3. Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from
+     this software without specific prior written permission.
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#include <Arduino.h>
+#include <inttypes.h>
+#include <Wire.h>
+#include "HM330x.h"
+
+// Default Constructor
+HM330x::HM330x() {};
+
+// Initialize the Sensor
+void HM330x::initialize(void) {
+  uint8_t retryCount = 0;
+  // Send select command
+  while (!sendCmd(HM330x_SELECT)) {
+    if (retryCount++ >= 0) {
+      return;
+    } else {
+      delay(100);
+    }
+  }
+}
+
+// Read Data From Sensor and Put Them Into the Payload Array
+uint8_t HM330x::getSensorData(char *payload, uint8_t startbyte) {
+  uint8_t data[HM330x_DATA_LEN] = {0};
+  uint16_t value = 0;
+
+  // Initialize Payload with 0s
+  for (uint8_t i=startbyte; i < startbyte+6; i++)
+    payload[i] = 0;
+
+  // Get Data from the Sensors
+  Wire.requestFrom(HM330x_ADDR, HM330x_DATA_LEN);
+  if (Wire.available()) {
+    for (uint8_t i = 0; i<HM330x_DATA_LEN; i++)
+      data[i] = Wire.read();
+
+    if (calcSum(data) == data[HM330x_DATA_LEN-1]) {
+      for (uint8_t pos = 5; pos<8; pos++) {
+        value = bytesToUint16(data, pos);
+        uint16ToPayload(value, payload, startbyte);
+        startbyte += 2;
+      }
+      return startbyte;
+    }
+  }
+  return startbyte+6;
+}
+
+// Send only a Command
+bool HM330x::sendCmd(uint8_t cmd) {
+  Wire.beginTransmission(HM330x_ADDR);
+  Wire.write(cmd);
+  return Wire.endTransmission();
+}
+
+// Calculate the CheckSum
+uint8_t HM330x::calcSum(uint8_t bytes[]) {
+  uint8_t checksum = 0;
+  for (int i = 0; i < HM330x_DATA_LEN - 1; i++) {
+    checksum += bytes[i];
+  }
+  return checksum;
+}
+
+// Get Value from Sensor Bytes Array
+uint16_t HM330x::bytesToUint16(uint8_t bytes[], uint8_t pos){
+  return bytes[pos * 2] * 0x100 + bytes[pos * 2 + 1];
+}

lib/HM330x/HM330x.h

@@ -0,0 +1,53 @@
+/*
+  HM330x.h - Seeed HM330x Particle-Sensor Library
+  Copyright (c) 2020-2021, Stefan Brand
+  All rights reserved.
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+  3. Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from
+     this software without specific prior written permission.
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef HM330x_H
+#define HM330x_H
+
+#include "../../include/attsensor.h"
+
+// Sensor I2C Address
+#define HM330x_ADDR     0x40
+#define HM330x_SELECT   0x88
+
+#define HM330x_DATA_LEN 29
+
+class HM330x : public AttSensor {
+  private:
+    bool     sendCmd(uint8_t cmd);
+    uint8_t  calcSum(uint8_t bytes[]);
+    uint16_t bytesToUint16(uint8_t bytes[], uint8_t pos);
+
+  public:
+    HM330x();
+    HM330x(uint8_t interval, bool selfcalib);
+    void initialize(void);
+    void calibrate(void) {};
+    uint8_t numBytes(void) {return 6;};
+    uint8_t getSensorData(char *payload, uint8_t startbyte);
+};
+
+#endif

payload/index.html

@@ -69,6 +69,10 @@
           <input type="checkbox" value="sht21" onchange="updateDecoder();">
           SHT21
         </label>
+        <label>
+          <input type="checkbox" value="hm330x" onchange="updateDecoder();">
+          HM330x
+        </label>
         <label>
           <input type="checkbox" value="ds18b20" onchange="updateDecoder();">
           DS18B20
@@ -105,6 +109,11 @@
           { "name": "temperature", "type": "Int32", "factor": 100, "multi": false },
           { "name": "humidity", "type": "Int32", "factor": 100, "multi": false },
         ],
+        "hm330x": [
+          { "name": "pm1", "type": "UInt16", "factor": 1, "multi": false },
+          { "name": "pm2_5", "type": "UInt16", "factor": 1, "multi": false },
+          { "name": "pm10", "type": "UInt16", "factor": 1, "multi": false },
+        ],
         "ds18b20": [
           { "name": "t", "type": "Int16", "factor": 100, "multi": true },
         ]

platformio.ini

@@ -22,6 +22,7 @@ board_hardware.bod = disabled
 
 ## Debug Port Config ##
 monitor_speed = 115200
+monitor_port = /dev/ttyACM1
 
 ## LMIC Config via Build Flags ##
 build_flags =

src/config.h.example

@@ -57,6 +57,7 @@
 // #define HAS_SCD30
 // #define HAS_BME280
 // #define HAS_SHT21
+// #define HAS_HM330x
 // #define HAS_DS18B20
 
 /**************************************************************************************************************************

src/main.cpp

@@ -36,6 +36,9 @@
 #ifdef HAS_SHT21
   #include <SHT21.h>
 #endif
+#ifdef HAS_HM330x
+  #include <HM330x.h>
+#endif
 #ifdef HAS_DS18B20
   #include <DS18B20.h>
 #endif
@@ -334,6 +337,10 @@ void setup()
     sensors[i] = new SHT21();
     i++;
   #endif
+  #ifdef HAS_HM330x
+    sensors[i] = new HM330x();
+    i++;
+  #endif
   #ifdef HAS_DS18B20
     sensors[i] = new DS18B20(DS18B20_PIN, DS18B20_RES);
     i++;