mhsw-espurna/code/espurna/sensor.ino

/*

SENSOR MODULE

Copyright (C) 2016-2017 by Xose Pérez <xose dot perez at gmail dot com>

*/

#include <vector>
#include "filters/MedianFilter.h"
#include "filters/MovingAverageFilter.h"
#include "sensors/BaseSensor.h"

typedef struct {
    BaseSensor * sensor;
    unsigned char local;        // Local index in its provider
    magnitude_t type;           // Type of measurement
    unsigned char global;       // Global index in its type
    double current;             // Current (last) value, unfiltered
    double filtered;            // Filtered (averaged) value
    BaseFilter * filter;    // Filter object
} sensor_magnitude_t;

std::vector<BaseSensor *> _sensors;
std::vector<sensor_magnitude_t> _magnitudes;

unsigned char _counts[MAGNITUDE_MAX];
bool _sensor_realtime = API_REAL_TIME_VALUES;
unsigned char _sensor_temperature_units = SENSOR_TEMPERATURE_UNITS;
double _sensor_temperature_correction = SENSOR_TEMPERATURE_CORRECTION;
unsigned char _sensor_isr = 0xFF;

// -----------------------------------------------------------------------------
// Private
// -----------------------------------------------------------------------------

String _sensorTopic(magnitude_t type) {
    if (type == MAGNITUDE_TEMPERATURE) {
        return String(SENSOR_TEMPERATURE_TOPIC);
    } else if (type == MAGNITUDE_HUMIDITY) {
        return String(SENSOR_HUMIDITY_TOPIC);
    } else if (type == MAGNITUDE_ANALOG) {
        return String(SENSOR_ANALOG_TOPIC);
    } else if (type == MAGNITUDE_EVENTS) {
        return String(SENSOR_EVENTS_TOPIC);
    }
    return String(SENSOR_UNKNOWN_TOPIC);
}

unsigned char _sensorDecimals(magnitude_t type) {
    if (type == MAGNITUDE_TEMPERATURE) {
        return SENSOR_TEMPERATURE_DECIMALS;
    } else if (type == MAGNITUDE_HUMIDITY) {
        return SENSOR_HUMIDITY_DECIMALS;
    } else if (type == MAGNITUDE_ANALOG) {
        return SENSOR_ANALOG_DECIMALS;
    } else if (type == MAGNITUDE_EVENTS) {
        return SENSOR_EVENTS_DECIMALS;
    }
    return 0;
}

String _sensorUnits(magnitude_t type) {
    if (type == MAGNITUDE_TEMPERATURE) {
        if (_sensor_temperature_units == TMP_CELSIUS) {
            return String("C");
        } else {
            return String("F");
        }
    } else if (type == MAGNITUDE_HUMIDITY) {
        return String("%");
    } else if (type == MAGNITUDE_EVENTS) {
        return String("/m");
    }
    return String();
}

double _sensorProcess(magnitude_t type, double value) {
    if (type == MAGNITUDE_TEMPERATURE) {
        if (_sensor_temperature_units == TMP_FAHRENHEIT) value = value * 1.8 + 32;
        value = value + _sensor_temperature_correction;
    }
    return roundTo(value, _sensorDecimals(type));
}

void _sensorConfigure() {
    _sensor_realtime = getSetting("apiRealTime", API_REAL_TIME_VALUES).toInt() == 1;
    _sensor_temperature_units = getSetting("tmpUnits", SENSOR_TEMPERATURE_UNITS).toInt();
    _sensor_temperature_correction = getSetting("tmpCorrection", SENSOR_TEMPERATURE_CORRECTION).toFloat();
}

#if WEB_SUPPORT

void _sensorWebSocketOnSend(JsonObject& root) {

    char buffer[10];
    bool hasTemperature = false;

    JsonArray& sensors = root.createNestedArray("sensors");
    for (unsigned char i=0; i<_magnitudes.size(); i++) {

        sensor_magnitude_t magnitude = _magnitudes[i];
        unsigned char decimals = _sensorDecimals(magnitude.type);
        dtostrf(magnitude.current, 1-sizeof(buffer), decimals, buffer);

        JsonObject& sensor = sensors.createNestedObject();
        sensor["type"] = int(magnitude.type);
        sensor["value"] = String(buffer);
        sensor["units"] = _sensorUnits(magnitude.type);
        sensor["description"] = magnitude.sensor->slot(magnitude.local);

        if (magnitude.type == MAGNITUDE_TEMPERATURE) hasTemperature = true;

    }

    //root["apiRealTime"] = _sensor_realtime;
    root["tmpUnits"] = _sensor_temperature_units;
    root["tmpCorrection"] = _sensor_temperature_correction;
    if (hasTemperature) root["temperatureVisible"] = 1;

}

void _sensorAPISetup() {

    for (unsigned char magnitude_id=0; magnitude_id<_magnitudes.size(); magnitude_id++) {

        sensor_magnitude_t magnitude = _magnitudes[magnitude_id];

        String topic = _sensorTopic(magnitude.type);
        if (SENSOR_USE_INDEX || (_counts[magnitude.type] > 1)) topic = topic + "/" + String(magnitude.global);

        apiRegister(topic.c_str(), topic.c_str(), [magnitude_id](char * buffer, size_t len) {
            sensor_magnitude_t magnitude = _magnitudes[magnitude_id];
            unsigned char decimals = _sensorDecimals(magnitude.type);
            double value = _sensor_realtime ? magnitude.current : magnitude.filtered;
            dtostrf(value, 1-len, decimals, buffer);
        });

    }

}
#endif

// -----------------------------------------------------------------------------
// Values
// -----------------------------------------------------------------------------

void sensorISR() {
    _sensors[_sensor_isr]->InterruptHandler();
}

void sensorRegister(BaseSensor * sensor) {
    _sensors.push_back(sensor);
}

unsigned char sensorCount() {
    return _sensors.size();
}

void sensorInterrupt(unsigned char sensor_id, unsigned char gpio, int mode) {
    _sensor_isr = sensor_id;
    attachInterrupt(gpio, sensorISR, mode);
}

void sensorInit() {

    #if DHT_SUPPORT
        #include "sensors/DHTSensor.h"
        sensorRegister(new DHTSensor(DHT_PIN, DHT_TYPE, DHT_PULLUP));
    #endif

    #if DS18B20_SUPPORT
        #include "sensors/DS18B20Sensor.h"
        sensorRegister(new DS18B20Sensor(DS18B20_PIN, DS18B20_PULLUP));
    #endif

    #if ANALOG_SUPPORT
        #include "sensors/AnalogSensor.h"
        sensorRegister(new AnalogSensor(ANALOG_PIN));
    #endif

    #if COUNTER_SUPPORT
        if (_sensor_isr == 0xFF) {
            #include "sensors/EventSensor.h"
            sensorRegister(new EventSensor(COUNTER_PIN, COUNTER_PIN_MODE, COUNTER_DEBOUNCE));
            sensorInterrupt(sensorCount()-1, COUNTER_PIN, COUNTER_INTERRUPT_MODE);
        }
    #endif

}

void sensorSetup() {

    // Load sensors
    sensorInit();

    // Load magnitudes
    for (unsigned char i=0; i<_sensors.size(); i++) {

        BaseSensor * sensor = _sensors[i];
        DEBUG_MSG("[SENSOR] %s\n", sensor->name().c_str());

        for (unsigned char k=0; k<sensor->count(); k++) {

            magnitude_t type = sensor->type(k);

            sensor_magnitude_t new_magnitude;
            new_magnitude.sensor = sensor;
            new_magnitude.local = k;
            new_magnitude.type = type;
            new_magnitude.global = _counts[type];
            new_magnitude.current = 0;
            new_magnitude.filtered = 0;
            if (type == MAGNITUDE_EVENTS) {
                new_magnitude.filter = new MovingAverageFilter(SENSOR_REPORT_EVERY);
            } else {
                new_magnitude.filter = new MedianFilter();
            }
            _magnitudes.push_back(new_magnitude);

            DEBUG_MSG("[SENSOR]  -> %s:%d\n", _sensorTopic(type).c_str(), _counts[type]);

            _counts[type] = _counts[type] + 1;

        }

    }

    #if WEB_SUPPORT

        // Websockets
        wsOnSendRegister(_sensorWebSocketOnSend);
        wsOnAfterParseRegister(_sensorConfigure);

        // API
        _sensorAPISetup();

    #endif

}

void sensorLoop() {

    static unsigned long last_update = 0;
    static unsigned long report_count = 0;

    // Check if we should read new data
    if ((millis() - last_update > SENSOR_READ_INTERVAL) || (last_update == 0)) {

        last_update = millis();
        report_count = (report_count + 1) % SENSOR_REPORT_EVERY;

        double value;
        char buffer[64];

        // Pre-read hook
        for (unsigned char i=0; i<_sensors.size(); i++) {
            _sensors[i]->pre();
            if (!_sensors[i]->status()) {
                DEBUG_MSG("[SENSOR] Error reading data from %s (error: %d)\n",
                    _sensors[i]->name().c_str(),
                    _sensors[i]->error()
                );
            }
        }

        // Get readings
        for (unsigned char i=0; i<_magnitudes.size(); i++) {

            sensor_magnitude_t magnitude = _magnitudes[i];

            if (magnitude.sensor->status()) {

                unsigned char decimals = _sensorDecimals(magnitude.type);

                value = magnitude.sensor->value(magnitude.local);
                magnitude.filter->add(value);

                // Special case
                if (magnitude.type == MAGNITUDE_EVENTS) value = magnitude.filter->result();

                value = _sensorProcess(magnitude.type, value);
                _magnitudes[i].current = value;

                // Debug
                /*
                {
                    dtostrf(value, 1-sizeof(buffer), decimals, buffer);
                    DEBUG_MSG("[SENSOR] %s - %s: %s%s\n",
                        magnitude.sensor->name().c_str(),
                        _sensorTopic(magnitude.type).c_str(),
                        buffer,
                        _sensorUnits(magnitude.type).c_str()
                    );
                }
                */

                if (report_count == 0) {

                    // TODO: option to report only if it has change (configurable amount)

                    value = magnitude.filter->result();
                    value = _sensorProcess(magnitude.type, value);
                    _magnitudes[i].filtered = value;
                    magnitude.filter->reset();
                    dtostrf(value, 1-sizeof(buffer), decimals, buffer);

                    #if MQTT_SUPPORT
                        if (SENSOR_USE_INDEX || (_counts[magnitude.type] > 1)) {
                            mqttSend(_sensorTopic(magnitude.type).c_str(), magnitude.global, buffer);
                        } else {
                            mqttSend(_sensorTopic(magnitude.type).c_str(), buffer);
                        }
                    #endif

                    #if INFLUXDB_SUPPORT
                        if (SENSOR_USE_INDEX || (_counts[magnitude.type] > 1)) {
                            idbSend(_sensorTopic(magnitude.type).c_str(), magnitude.global, buffer);
                        } else {
                            idbSend(_sensorTopic(magnitude.type).c_str(), buffer);
                        }
                    #endif

                    #if DOMOTICZ_SUPPORT
                        // TODO
                    #endif

                }
            }
        }

        // Post-read hook
        for (unsigned char i=0; i<_sensors.size(); i++) {
            _sensors[i]->post();
        }

        #if WEB_SUPPORT
            wsSend(_sensorWebSocketOnSend);
        #endif

    }


}