filter.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/defines.h"
#ifdef USE_BINARY_SENSOR_FILTER
 
#include <array>
 
#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/helpers.h"
 
namespace esphome::binary_sensor {
 
class BinarySensor;
 
class Filter {
 public:
  virtual optional<bool> new_value(bool value) = 0;
 
  virtual void input(bool value);
 
  void output(bool value);
 
 protected:
  friend BinarySensor;
 
  Filter *next_{nullptr};
  BinarySensor *parent_{nullptr};
  Deduplicator<bool> dedup_;
};
 
class TimeoutFilter : public Filter {
 public:
  optional<bool> new_value(bool value) override { return value; }
  void input(bool value) override;
  template<typename T> void set_timeout_value(T timeout) { this->timeout_delay_ = timeout; }
 
 protected:
  TemplatableFn<uint32_t> timeout_delay_{};
};
 
class DelayedOnOffFilter final : public Filter {
 public:
  optional<bool> new_value(bool value) override;
 
  template<typename T> void set_on_delay(T delay) { this->on_delay_ = delay; }
  template<typename T> void set_off_delay(T delay) { this->off_delay_ = delay; }
 
 protected:
  TemplatableFn<uint32_t> on_delay_{};
  TemplatableFn<uint32_t> off_delay_{};
};
 
class DelayedOnFilter : public Filter {
 public:
  // User provided, not "= default": `new(p) DelayedOnFilter()` would zero-fill .bss that is already zero.
  DelayedOnFilter() {}
 
  optional<bool> new_value(bool value) override;
 
  template<typename T> void set_delay(T delay) { this->delay_ = delay; }
 
 protected:
  TemplatableFn<uint32_t> delay_{};
};
 
class DelayedOffFilter : public Filter {
 public:
  // User provided, not "= default": `new(p) DelayedOffFilter()` would zero-fill .bss that is already zero.
  DelayedOffFilter() {}
 
  optional<bool> new_value(bool value) override;
 
  template<typename T> void set_delay(T delay) { this->delay_ = delay; }
 
 protected:
  TemplatableFn<uint32_t> delay_{};
};
 
class InvertFilter : public Filter {
 public:
  optional<bool> new_value(bool value) override;
};
 
struct AutorepeatFilterTiming {
  uint32_t delay;
  uint32_t time_off;
  uint32_t time_on;
};
 
class AutorepeatFilterBase : public Filter {
 public:
  optional<bool> new_value(bool value) override;
  AutorepeatFilterBase(const AutorepeatFilterBase &) = delete;
  AutorepeatFilterBase &operator=(const AutorepeatFilterBase &) = delete;
 
 protected:
  AutorepeatFilterBase() = default;
  void next_timing_();
  void next_value_(bool val);
 
  const AutorepeatFilterTiming *timings_{nullptr};
  uint8_t timings_count_{0};
  uint8_t active_timing_{0};
};
 
template<size_t N> class AutorepeatFilter : public AutorepeatFilterBase {
 public:
  explicit AutorepeatFilter(std::initializer_list<AutorepeatFilterTiming> timings) {
    init_array_from(this->timings_storage_, timings);
    this->timings_ = this->timings_storage_.data();
    this->timings_count_ = N;
  }
 
 protected:
  std::array<AutorepeatFilterTiming, N> timings_storage_{};
};
 
class LambdaFilter : public Filter {
 public:
  explicit LambdaFilter(std::function<optional<bool>(bool)> f);
 
  optional<bool> new_value(bool value) override;
 
 protected:
  std::function<optional<bool>(bool)> f_;
};
 
class StatelessLambdaFilter : public Filter {
 public:
  explicit StatelessLambdaFilter(optional<bool> (*f)(bool)) : f_(f) {}
 
  optional<bool> new_value(bool value) override { return this->f_(value); }
 
 protected:
  optional<bool> (*f_)(bool);
};
 
class SettleFilter : public Filter {
 public:
  // User provided, not "= default": `new(p) SettleFilter()` would zero-fill .bss that is already zero.
  SettleFilter() {}
  optional<bool> new_value(bool value) override;
 
  template<typename T> void set_delay(T delay) { this->delay_ = delay; }
 
 protected:
  TemplatableFn<uint32_t> delay_{};
  bool steady_{true};
};
 
}  // namespace esphome::binary_sensor
 
#endif  // USE_BINARY_SENSOR_FILTER