constant_sensor.h

Go to the documentation of this file.

#ifndef CONSTANT_SENSOR_H_
#define CONSTANT_SENSOR_H_
 
#include "Arduino.h"
#include "sensesp/sensors/sensor.h"
 
namespace sensesp {
 
static const char SCHEMA_CONSTANT_SENSOR[] PROGMEM = R"###({
        "type": "object",
        "properties": {
            "value": { "title": "Constant Value", "type": "number", "description": "Constant value" }
        }
    })###";
 
template <class T>
class ConstantSensor : public SensorT<T> {
 public:
  ConstantSensor(T value, int send_interval = 30, String config_path = "")
      : SensorT<T>(config_path), value_{value}, send_interval_{send_interval} {
    this->load_configuration();
  }
  void start() override {
    ReactESP::app->onRepeat(send_interval_ * 1000,
                            [this]() { this->emit(value_); });
  }
 
  void set_value(T value) { value_ = value; }
  T get_value() { return value_; }
 
 protected:
  virtual void get_configuration(JsonObject &doc) override {
    doc["value"] = value_;
    doc["interval"] = send_interval_;
  }
  virtual bool set_configuration(const JsonObject &config) override {
    // Neither of the configuration parameters are mandatory
    if (config.containsKey("value")) {
      value_ = config["value"];
    }
    if (config.containsKey("interval")) {
      send_interval_ = config["interval"];
    }
    return true;
  }
  virtual String get_config_schema() override {
    return FPSTR(SCHEMA_CONSTANT_SENSOR);
  }
  void update() { this->emit(value_); }
 
  T value_;
  int send_interval_;  // seconds
};
 
// ..........................................
//  constant value sensors
// ..........................................
 
typedef ConstantSensor<float> FloatConstantSensor;
typedef ConstantSensor<int> IntConstantSensor;
typedef ConstantSensor<bool> BoolConstantSensor;
typedef ConstantSensor<String> StringConstantSensor;
 
}  // namespace sensesp
 
#endif