Add error codes

Author: thgeorgiou

src/hackair.cpp

@@ -68,7 +68,7 @@ void hackAIR::readData(hackAirData &data) {
             // If package is valid
             if (receiveflag > 0) {
                 // Set the error flag
-                data.error = 0;
+                data.error = H_NO_ERROR;
 
                 // Set data
                 data.pm25 = ((_buff[8] << 8) + _buff[9]);
@@ -80,7 +80,7 @@ void hackAIR::readData(hackAirData &data) {
                 return;
             } else {
                 // Set the error flag and exit
-                data.error = 1;
+                data.error = H_ERROR_SENSOR;
                 return;
             }
         }
@@ -103,7 +103,7 @@ void hackAIR::readData(hackAirData &data) {
 
             if ((receiveSum & 0xFF) == _buff[8]) {
                 // Set the error flag
-                data.error = 0;
+                data.error = H_NO_ERROR;
 
                 // Set data
                 data.pm25 = ((_buff[3] << 8) + _buff[2]) / 10.0f;
@@ -112,7 +112,7 @@ void hackAIR::readData(hackAirData &data) {
                 return;
             } else {
                 // Invalid package, set the error flag
-                data.error = 1;
+                data.error = H_ERROR_SENSOR;
                 return;
             }
         }
@@ -126,7 +126,7 @@ void hackAIR::readData(hackAirData &data) {
 
         int ratio = _pulseDuration / 20000.0;
         data.pm10 = 1.1 * pow(ratio, 3) - 3.8 * pow(ratio, 2) + 520 * ratio + 0.62; // From manual
-        data.error = 0;
+        data.error = H_NO_ERROR;
         return;
     }
 
@@ -144,7 +144,7 @@ void hackAIR::readAverageData(hackAirData &data, uint8_t n) {
                      // 1Hz sampling rate
         readData(data);
 
-        if (data.error == 0) {
+        if (data.error == H_NO_ERROR) {
             sum_pm25 += data.pm25;
             sum_pm10 += data.pm10;
 
@@ -156,16 +156,16 @@ void hackAIR::readAverageData(hackAirData &data, uint8_t n) {
     data.pm10 = sum_pm10 / successes;
 
     if (successes != n) {
-        data.error = 1;
+        data.error = H_ERROR_SENSOR_ONCE;
     } else {
-        data.error = 0;
+        data.error = H_NO_ERROR;
     }
 }
 
 void hackAIR::clearData(hackAirData &data) {
     data.pm25 = 0;
     data.pm10 = 0;
-    data.error = 0;
+    data.error = H_NO_ERROR;
     data.tamper = 0;
     data.battery = 0;
 }

src/hackair.h

@@ -40,6 +40,7 @@
 #endif
 
 #include "Arduino.h"
+#include "hackair_errors.h"
 #include <SoftwareSerial.h>
 
 /**

src/hackair_errors.h

@@ -0,0 +1,40 @@
+/*
+* hackAIR Arduino Library
+* Copyright © 2016-2017 hackAir Consortium
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+* @file Error codes
+* @author Thanasis Georgiou
+*/
+
+/** No error, everything is fine */
+#define H_NO_ERROR 0
+
+/** There was an error reading from the air quality sensor */
+#define H_ERROR_SENSOR (1 << 0)
+
+/**
+ * There was an error reading from the sensor at least once
+ * but the reading should be correct
+ */
+#define H_ERROR_SENSOR_ONCE (1 << 1)
+
+/** There was an error reading from the humidity sensor */
+#define H_ERROR_HUMIDITY (1 << 2)
+
+/** Something else went wrong */
+#define H_ERROR_UNKNOWN (1 << 3)