Merge branch 'develop' into hotfix/pms25-compensated-show-on-display

src/PMS/PMS.cpp

@@ -12,6 +12,7 @@ bool PMSBase::begin(Stream *stream) {
   this->stream = stream;
 
   failed = true;
+  failCount = 0;
   lastRead = 0; // To read buffer on handle without wait after 1.5sec
 
   this->stream->flush();
@@ -147,6 +148,27 @@ void PMSBase::handle() {
  */
 bool PMSBase::isFailed(void) { return failed; }
 
+/**
+ * @brief Increate number of fail
+ * 
+ */
+void PMSBase::updateFailCount(void) {
+  if (failCount < failCountMax) {
+    failCount++;
+  }
+}
+
+void PMSBase::resetFailCount(void) { failCount = 0; }
+
+/**
+ * @brief Get number of fail
+ * 
+ * @return int 
+ */
+int PMSBase::getFailCount(void) { return failCount; }
+
+int PMSBase::getFailCountMax(void) { return failCountMax; }
+
 /**
  * @brief Read PMS 0.1 ug/m3 with CF = 1 PM estimates
  *
@@ -245,6 +267,20 @@ int16_t PMSBase::getTemp(void) { return toI16(&package[24]); }
  */
 uint16_t PMSBase::getHum(void) { return toU16(&package[26]); }
 
+/**
+ * @brief Get firmware version code
+ * 
+ * @return uint8_t 
+ */
+uint8_t PMSBase::getFirmwareVersion(void) { return package[28]; }
+
+/**
+ * @brief Ge PMS5003 error code
+ * 
+ * @return uint8_t 
+ */
+uint8_t PMSBase::getErrorCode(void) { return package[29]; }
+
 /**
  * @brief Convert PMS2.5 to US AQI unit
  *

src/PMS/PMS.h

@@ -3,11 +3,17 @@
 
 #include <Arduino.h>
 
+#define PMS_FAIL_COUNT_SET_INVALID 3
+
 class PMSBase {
 public:
   bool begin(Stream *stream);
   void handle();
   bool isFailed(void);
+  void updateFailCount(void);
+  void resetFailCount(void);
+  int getFailCount(void);
+  int getFailCountMax(void);
   uint16_t getRaw0_1(void);
   uint16_t getRaw2_5(void);
   uint16_t getRaw10(void);
@@ -26,6 +32,8 @@ public:
   /** For PMS5003T*/
   int16_t getTemp(void);
   uint16_t getHum(void);
+  uint8_t getFirmwareVersion(void); 
+  uint8_t getErrorCode(void);
 
   int pm25ToAQI(int pm02);
   int compensate(int pm25, float humidity);
@@ -36,6 +44,8 @@ private:
   int packageIndex;
   bool failed = false;
   uint32_t lastRead;
+  const int failCountMax = 10;
+  int failCount = 0;
 
   int16_t toI16(char *buf);
   uint16_t toU16(char* buf);

src/PMS/PMS5003.cpp

@@ -78,7 +78,7 @@ bool PMS5003::begin(void) {
     return false;
   }
 #endif
-
+  _ver = pms.getFirmwareVersion();
   this->_isBegin = true;
   return true;
 }
@@ -132,6 +132,20 @@ int PMS5003::compensate(int pm25, float humidity) {
   return pms.compensate(pm25, humidity);
 }
 
+/**
+ * @brief Get sensor firmware version
+ * 
+ * @return int
+ */
+int PMS5003::getFirmwareVersion(void) { return _ver; }
+
+/**
+ * @brief Get sensor error code
+ * 
+ * @return uint8_t 
+ */
+uint8_t PMS5003::getErrorCode(void) { return pms.getErrorCode(); }
+
 /**
  * @brief Check device initialized or not
  *
@@ -175,3 +189,25 @@ void PMS5003::handle(void) { pms.handle(); }
  * @return false Communication timeout or sensor has removed
  */
 bool PMS5003::isFailed(void) { return pms.isFailed(); }
+
+void PMS5003::updateFailCount(void) {
+  pms.updateFailCount();
+}
+
+void PMS5003::resetFailCount(void) {
+  pms.resetFailCount();
+}
+
+/**
+ * @brief Get number of fail count
+ * 
+ * @return int 
+ */
+int PMS5003::getFailCount(void) { return pms.getFailCount(); }
+
+/**
+ * @brief Get number of fail count max
+ * 
+ * @return int 
+ */
+int PMS5003::getFailCountMax(void) { return pms.getFailCountMax(); }

src/PMS/PMS5003.h

@@ -19,15 +19,22 @@ public:
   void end(void);
   void handle(void);
   bool isFailed(void);
+  void updateFailCount(void);
+  void resetFailCount(void);
+  int getFailCount(void);
+  int getFailCountMax(void);
   int getPm01Ae(void);
   int getPm25Ae(void);
   int getPm10Ae(void);
   int getPm03ParticleCount(void);
   int convertPm25ToUsAqi(int pm25);
   int compensate(int pm25, float humidity);
+  int getFirmwareVersion(void);
+  uint8_t getErrorCode(void);
 
 private:
   bool _isBegin = false;
+  int _ver;
   BoardType _boardDef;
   PMSBase pms;
   const BoardDef *bsp;

src/PMS/PMS5003T.cpp

@@ -103,7 +103,7 @@ bool PMS5003T::begin(void) {
     return false;
   }
 #endif
-
+  _ver = pms.getFirmwareVersion();
   this->_isBegin = true;
   return true;
 }
@@ -175,6 +175,20 @@ int PMS5003T::compensate(int pm25, float humidity) {
   return pms.compensate(pm25, humidity);
 }
 
+/**
+ * @brief Get module(s) firmware version
+ * 
+ * @return int Version code
+ */
+int PMS5003T::getFirmwareVersion(void) { return _ver; }
+
+/**
+ * @brief Get sensor error code
+ * 
+ * @return uint8_t 
+ */
+uint8_t PMS5003T::getErrorCode(void) { return pms.getErrorCode(); }
+
 /**
  * @brief Check device initialized or not
  *
@@ -216,3 +230,24 @@ void PMS5003T::handle(void) { pms.handle(); }
  */
 bool PMS5003T::isFailed(void) { return pms.isFailed(); }
 
+void PMS5003T::updateFailCount(void) {
+  pms.updateFailCount();
+}
+
+void PMS5003T::resetFailCount(void) {
+  pms.resetFailCount();
+}
+
+/**
+ * @brief Get fail count
+ * 
+ * @return int 
+ */
+int PMS5003T::getFailCount(void) { return pms.getFailCount(); }
+
+/**
+ * @brief Get fail count max
+ * 
+ * @return int 
+ */
+int PMS5003T::getFailCountMax(void) { return pms.getFailCountMax(); }

src/PMS/PMS5003T.h

@@ -22,6 +22,10 @@ public:
 
   void handle(void);
   bool isFailed(void);
+  void updateFailCount(void);
+  void resetFailCount(void);
+  int getFailCount(void);
+  int getFailCountMax(void);
   int getPm01Ae(void);
   int getPm25Ae(void);
   int getPm10Ae(void);
@@ -30,10 +34,13 @@ public:
   float getTemperature(void);
   float getRelativeHumidity(void);
   int compensate(int pm25, float humidity);
+  int getFirmwareVersion(void);
+  uint8_t getErrorCode(void);
 
 private:
   bool _isBegin = false;
   bool _isSleep = false;
+  int _ver;   /** Firmware version code */
 
   BoardType _boardDef;
   const BoardDef *bsp;