Merge pull request #224 from airgradienthq/hotfix/pms25-compensated-show-on-display

[Fix] PM2.5 compensated show on display

src/PMS/PMS.cpp

@@ -315,7 +315,7 @@ int PMSBase::pm25ToAQI(int pm02) {
  * @param humidity Humidity value (%)
  * @return int 
  */
-int PMSBase::compensated(int pm25, float humidity) {
+int PMSBase::compensate(int pm25, float humidity) {
   float value;
   float fpm25 = pm25;
   if (humidity < 0) {

src/PMS/PMS.h

@@ -36,7 +36,7 @@ public:
   uint8_t getErrorCode(void);
 
   int pm25ToAQI(int pm02);
-  int compensated(int pm25, float humidity);
+  int compensate(int pm25, float humidity);
 
 private:
   Stream *stream;

src/PMS/PMS5003.cpp

@@ -124,12 +124,14 @@ int PMS5003::convertPm25ToUsAqi(int pm25) { return pms.pm25ToAQI(pm25); }
 /**
  * @brief Correct PM2.5
  * 
+ * Reference formula: https://www.airgradient.com/documentation/correction-algorithms/
+ * 
  * @param pm25 PM2.5 raw value
  * @param humidity Humidity value
- * @return float 
+ * @return int 
  */
-int PMS5003::compensated(int pm25, float humidity) {
-  return pms.compensated(pm25, humidity);
+int PMS5003::compensate(int pm25, float humidity) {
+  return pms.compensate(pm25, humidity);
 }
 
 /**

src/PMS/PMS5003.h

@@ -28,7 +28,7 @@ public:
   int getPm10Ae(void);
   int getPm03ParticleCount(void);
   int convertPm25ToUsAqi(int pm25);
-  int compensated(int pm25, float humidity);
+  int compensate(int pm25, float humidity);
   int getFirmwareVersion(void);
   uint8_t getErrorCode(void);
 

src/PMS/PMS5003T.cpp

@@ -167,12 +167,14 @@ float PMS5003T::getRelativeHumidity(void) {
 /**
  * @brief Correct PM2.5
  * 
+ * Reference formula: https://www.airgradient.com/documentation/correction-algorithms/
+ * 
  * @param pm25 PM2.5 raw value
  * @param humidity Humidity value
- * @return float 
+ * @return int 
  */
-float PMS5003T::compensated(int pm25, float humidity) {
-  return pms.compensated(pm25, humidity);
+int PMS5003T::compensate(int pm25, float humidity) {
+  return pms.compensate(pm25, humidity);
 }
 
 /**

src/PMS/PMS5003T.h

@@ -33,7 +33,7 @@ public:
   int convertPm25ToUsAqi(int pm25);
   float getTemperature(void);
   float getRelativeHumidity(void);
-  float compensated(int pm25, float humidity);
+  int compensate(int pm25, float humidity);
   int getFirmwareVersion(void);
   uint8_t getErrorCode(void);