debounce.h

Go to the documentation of this file.

#ifndef debounce_H
#define debounce_H
 
#include "transform.h"
 
namespace sensesp {
 
static const char DEBOUNCE_SCHEMA[] PROGMEM = R"###({
    "type": "object",
    "properties": {
        "min_delay": { "title": "Minimum delay", "type": "number", "description": "The minimum time in ms between inputs for output to happen" }
    }
  })###";
 
template <class T>
class DebounceTemplate : public SymmetricTransform<T> {
 public:
  DebounceTemplate(int ms_min_delay = 15, String config_path = "")
      : SymmetricTransform<T>(config_path),
        ms_min_delay_{ms_min_delay} {
    this->load_configuration();
  }
 
  virtual void set_input(T input, uint8_t input_channel = 0) override {
 
    // Input has changed since the last emit, or this is the first
    // input since the program started to run.
 
    if (input != debounced_value_ || !value_received_) {
      debounced_value_ = input;
 
      if (reaction_) {
        reaction_->remove();
        reaction_ = nullptr;
      }
      reaction_ = ReactESP::app->onDelay(ms_min_delay_, [this, input]() {
        this->reaction_ = nullptr;
        this->debounced_value_ = input;
        this->emit(input);
      });
      value_received_ = true;
    }
  }
 
 private:
  int ms_min_delay_;
  bool value_received_ = false;
  T debounced_value_;
  DelayReaction* reaction_ = nullptr;
  virtual void get_configuration(JsonObject& doc) override {
    doc["min_delay"] = ms_min_delay_;
  }
 
  virtual bool set_configuration(const JsonObject& config) override {
    String expected[] = {"min_delay"};
    for (auto str : expected) {
      if (!config.containsKey(str)) {
        return false;
      }
    }
    ms_min_delay_ = config["min_delay"];
    return true;
  }
 
  virtual String get_config_schema() override { return FPSTR(DEBOUNCE_SCHEMA); }
};
 
typedef DebounceTemplate<bool> DebounceBool;
typedef DebounceTemplate<bool>
    Debounce;  // for backward-compatibility with original class
typedef DebounceTemplate<int> DebounceInt;
typedef DebounceTemplate<float>
    DebounceFloat;  // not sure this works - test it if you use it
 
}
 
#endif