airq_ccs811.h

// airq_ccs811.h
// adapted from:
// https://github.com/sparkfun/SparkFun_CCS811_Arduino_Library/blob/master/examples/BasicReadings/BasicReadings.ino
#pragma once

#include "scheduler.h"
#include "sensors.h"
#include "home_assistant.h"

#include "SparkFunCCS811.h"

// Default I2C Address for
// https://learn.sparkfun.com/tutorials/ccs811-air-quality-breakout-hookup-guide
#define SPARKFUN_CCS811_ADDR 0x5B

namespace ustd {
class AirQualityCCS811 {
  public:
    String AIRQUALITY_VERSION = "0.1.0";
    Scheduler *pSched;
    int tID;
    String name;
    uint8_t i2caddr;
    String calibrationTopic;
    double co2Val;
    double vocVal;
    time_t startTime = 0;
    bool bStartup = true;
    uint16_t baseline = 0xffff;
    bool bActive = false;
    String errmsg = "";
    ustd::sensorprocessor co2 = ustd::sensorprocessor(12, 600, 2.0);
    ustd::sensorprocessor voc = ustd::sensorprocessor(4, 600, 0.4);
    float relHumid = -1.0;
    float temper = -99.0;
    CCS811 *pAirQuality;
#ifdef __ESP__
    HomeAssistant *pHA;
#endif

    AirQualityCCS811(String name, uint8_t i2caddr = SPARKFUN_CCS811_ADDR,
                     String calibrationTopic = "")
        : name(name), i2caddr(i2caddr), calibrationTopic(calibrationTopic) {
        pAirQuality = new CCS811(i2caddr);
    }

    ~AirQualityCCS811() {
    }

    double getCo2() {
        return co2Val;
    }

    double getVoc() {
        return vocVal;
    }

    void printDriverError(CCS811Core::CCS811_Status_e errorCode) {
#ifdef USE_SERIAL_DBG
        switch (errorCode) {
        case CCS811Core::CCS811_Status_e::CCS811_Stat_SUCCESS:
            Serial.print("SUCCESS");
            break;
        case CCS811Core::CCS811_Status_e::CCS811_Stat_ID_ERROR:
            errmsg = "ID_ERROR";
            Serial.print(errmsg);
            break;
        case CCS811Core::CCS811_Status_e::CCS811_Stat_I2C_ERROR:
            errmsg = "I2C_ERROR (did you put WAK low? Required!) See code for more.";
            Serial.println(errmsg);
            Serial.println("You need a patch: "
                           "https://github.com/sparkfun/"
                           "SparkFun_CCS811_Arduino_Library/issues/6");
            break;
        case CCS811Core::CCS811_Status_e::CCS811_Stat_INTERNAL_ERROR:
            errmsg = "INTERNAL_ERROR";
            Serial.print(errmsg);
            break;
        case CCS811Core::CCS811_Status_e::CCS811_Stat_GENERIC_ERROR:
            errmsg = "GENERIC_ERROR";
            Serial.print(errmsg);
            break;
        default:
            errmsg = "Unspecified error.";
            Serial.print(errmsg);
        }
#endif
    }

    void begin(Scheduler *_pSched) {
        pSched = _pSched;

        CCS811Core::CCS811_Status_e returnCode = pAirQuality->beginWithStatus();
        if (returnCode == CCS811Core::CCS811_Status_e::CCS811_Stat_SUCCESS) {
            bActive = true;
            // Mode 0 = Idle
            // Mode 1 = read every 1s
            // Mode 2 = every 10s
            // Mode 3 = every 60s
            // Mode 4 = RAW mode
            startTime = time(NULL);
            pAirQuality->setDriveMode(2);  // measure every 10 secs.
        } else {
            printDriverError(returnCode);
        }

        auto ft = [=]() { this->loop(); };
        tID = pSched->add(ft, name, 12000000);  // every 12sec

        auto fnall = [=](String topic, String msg, String originator) {
            this->subsMsg(topic, msg, originator);
        };
        pSched->subscribe(tID, name + "/sensor/#", fnall);
        if (calibrationTopic != "")
            pSched->subscribe(tID, calibrationTopic + "/#", fnall);
    }

#ifdef __ESP__
    void registerHomeAssistant(String homeAssistantFriendlyName, String projectName = "",
                               String homeAssistantDiscoveryPrefix = "homeassistant") {
        pHA = new HomeAssistant(name, tID, homeAssistantFriendlyName, projectName,
                                AIRQUALITY_VERSION, homeAssistantDiscoveryPrefix);
        pHA->addSensor("co2", "CO2", "ppm", "None", "mdi:air-filter");
        pHA->addSensor("voc", "VOC", "ppb", "None", "mdi:air-filter");
        pHA->begin(pSched);
    }
#endif

    void publishCO2() {
        if (bActive && !bStartup) {
            char buf[32];
            sprintf(buf, "%5.1f", co2Val);
            pSched->publish(name + "/sensor/result", "OK");
            pSched->publish(name + "/sensor/co2", buf);
        }
    }

    void publishVOC() {
        if (bActive && !bStartup) {
            char buf[32];
            sprintf(buf, "%5.1f", vocVal);
            pSched->publish(name + "/sensor/result", "OK");
            pSched->publish(name + "/sensor/voc", buf);
        }
    }

    void publishBaseline() {
        char buf[32];
        if (bActive && !bStartup) {
            sprintf(buf, "%5d", pAirQuality->getBaseline());
        } else {
            if (!bStartup)
                sprintf(buf, errmsg.c_str());
            else
                sprintf(buf, "Startup phase");
        }
        pSched->publish(name + "/sensor/baseline", buf);
    }

    void storeBaseline(uint16_t newBase) {
        if (bActive) {
            pAirQuality->setBaseline(newBase);
            publishBaseline();
            publishCalibration();
        }
    }

    void loop() {
        if (startTime < 100000)
            startTime = time(NULL);  // NTP data available.
        if (bActive) {
            if (pAirQuality->dataAvailable()) {
                double c, v;
#ifdef USE_SERIAL_DBG
                Serial.println("AirQuality sensor data available");
#endif
                pAirQuality->readAlgorithmResults();
                c = pAirQuality->getCO2();
                v = pAirQuality->getTVOC();
                if (bStartup) {
                    if (c < 350.0)
                        return;  // invalid.
                    bStartup = false;
                }
#ifdef USE_SERIAL_DBG
                Serial.print("AirQuality sensor data available, co2: ");
                Serial.print(c);
                Serial.print(" voc: ");
                Serial.println(v);
#endif
                if (co2.filter(&c)) {
                    co2Val = c;
                    publishCO2();
                }
                if (voc.filter(&v)) {
                    vocVal = v;
                    publishVOC();
                }
            } else {
#ifdef USE_SERIAL_DBG
                Serial.println("AirQuality sensor no data available");
#endif
            }
        } else {
#ifdef USE_SERIAL_DBG
            Serial.println("AirQuality sensor not active. Patch applied?");
#endif
            if (errmsg != "") {
                pSched->publish(name + "/result", errmsg);
            }
        }
    }

    void publishCalibration() {
        if (bActive && !bStartup) {
            baseline = pAirQuality->getBaseline();
            char msg[192];
            if (startTime < 100000)
                startTime = time(NULL);  // NTP is now available.
            double uptimeH = (time(NULL) - startTime) / 3600.0;
            sprintf(msg,
                    "{\"humidity\":%5.1f, \"temperature\":%5.1f, \"baseline\": "
                    "%5d, \"co2\": %5.1f, \"voc\": %5.1f, \"upTimeHours\": %7.1f}",
                    relHumid, temper, baseline, co2Val, vocVal, uptimeH);
            pSched->publish(name + "/sensor/calibration", msg);
        }
    }

    void calibrate() {
        if (relHumid != -1.0 && temper != -99.0 && bActive && !bStartup) {
            pAirQuality->setEnvironmentalData(relHumid, temper);
            publishCalibration();
            publishCO2();
            publishVOC();
        }
    }

    void subsMsg(String topic, String msg, String originator) {
        if (topic == name + "/sensor/co2/get") {
            publishCO2();
        }
        if (topic == name + "/sensor/voc/get") {
            publishVOC();
        }
        if (topic == name + "/sensor/calibration/get") {
            publishCalibration();
        }
        if (topic == name + "/sensor/baseline/get") {
            publishBaseline();
        }
        if (topic == name + "/sensor/baseline/set") {
            storeBaseline(atoi(msg.c_str()));
        }
        if (topic == calibrationTopic + "/temperature") {
            temper = atof(msg.c_str());
            calibrate();
        }
        if (topic == calibrationTopic + "/humidity") {
            relHumid = atof(msg.c_str());
            calibrate();
        }
    };
};  // AirQualityCCS811

}  // namespace ustd