filter.h

Go to the documentation of this file.

#pragma once
 
#include <queue>
#include <utility>
#include <vector>
#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/helpers.h"
 
namespace esphome {
namespace sensor {
 
class Sensor;
 
class Filter {
 public:
  virtual optional<float> new_value(float value) = 0;
 
  virtual void initialize(Sensor *parent, Filter *next);
 
  void input(float value);
 
  void output(float value);
 
 protected:
  friend Sensor;
 
  Filter *next_{nullptr};
  Sensor *parent_{nullptr};
};
 
class QuantileFilter : public Filter {
 public:
  explicit QuantileFilter(size_t window_size, size_t send_every, size_t send_first_at, float quantile);
 
  optional<float> new_value(float value) override;
 
  void set_send_every(size_t send_every);
  void set_window_size(size_t window_size);
  void set_quantile(float quantile);
 
 protected:
  std::deque<float> queue_;
  size_t send_every_;
  size_t send_at_;
  size_t window_size_;
  float quantile_;
};
 
class MedianFilter : public Filter {
 public:
  explicit MedianFilter(size_t window_size, size_t send_every, size_t send_first_at);
 
  optional<float> new_value(float value) override;
 
  void set_send_every(size_t send_every);
  void set_window_size(size_t window_size);
 
 protected:
  std::deque<float> queue_;
  size_t send_every_;
  size_t send_at_;
  size_t window_size_;
};
 
class SkipInitialFilter : public Filter {
 public:
  explicit SkipInitialFilter(size_t num_to_ignore);
 
  optional<float> new_value(float value) override;
 
 protected:
  size_t num_to_ignore_;
};
 
class MinFilter : public Filter {
 public:
  explicit MinFilter(size_t window_size, size_t send_every, size_t send_first_at);
 
  optional<float> new_value(float value) override;
 
  void set_send_every(size_t send_every);
  void set_window_size(size_t window_size);
 
 protected:
  std::deque<float> queue_;
  size_t send_every_;
  size_t send_at_;
  size_t window_size_;
};
 
class MaxFilter : public Filter {
 public:
  explicit MaxFilter(size_t window_size, size_t send_every, size_t send_first_at);
 
  optional<float> new_value(float value) override;
 
  void set_send_every(size_t send_every);
  void set_window_size(size_t window_size);
 
 protected:
  std::deque<float> queue_;
  size_t send_every_;
  size_t send_at_;
  size_t window_size_;
};
 
class SlidingWindowMovingAverageFilter : public Filter {
 public:
  explicit SlidingWindowMovingAverageFilter(size_t window_size, size_t send_every, size_t send_first_at);
 
  optional<float> new_value(float value) override;
 
  void set_send_every(size_t send_every);
  void set_window_size(size_t window_size);
 
 protected:
  std::deque<float> queue_;
  size_t send_every_;
  size_t send_at_;
  size_t window_size_;
};
 
class ExponentialMovingAverageFilter : public Filter {
 public:
  ExponentialMovingAverageFilter(float alpha, size_t send_every, size_t send_first_at);
 
  optional<float> new_value(float value) override;
 
  void set_send_every(size_t send_every);
  void set_alpha(float alpha);
 
 protected:
  float accumulator_{NAN};
  float alpha_;
  size_t send_every_;
  size_t send_at_;
  bool first_value_{true};
};
 
class ThrottleAverageFilter : public Filter, public Component {
 public:
  explicit ThrottleAverageFilter(uint32_t time_period);
 
  void setup() override;
 
  optional<float> new_value(float value) override;
 
  float get_setup_priority() const override;
 
 protected:
  float sum_{0.0f};
  unsigned int n_{0};
  uint32_t time_period_;
  bool have_nan_{false};
};
 
using lambda_filter_t = std::function<optional<float>(float)>;
 
class LambdaFilter : public Filter {
 public:
  explicit LambdaFilter(lambda_filter_t lambda_filter);
 
  optional<float> new_value(float value) override;
 
  const lambda_filter_t &get_lambda_filter() const;
  void set_lambda_filter(const lambda_filter_t &lambda_filter);
 
 protected:
  lambda_filter_t lambda_filter_;
};
 
class OffsetFilter : public Filter {
 public:
  explicit OffsetFilter(TemplatableValue<float> offset);
 
  optional<float> new_value(float value) override;
 
 protected:
  TemplatableValue<float> offset_;
};
 
class MultiplyFilter : public Filter {
 public:
  explicit MultiplyFilter(TemplatableValue<float> multiplier);
  optional<float> new_value(float value) override;
 
 protected:
  TemplatableValue<float> multiplier_;
};
 
class FilterOutValueFilter : public Filter {
 public:
  explicit FilterOutValueFilter(std::vector<TemplatableValue<float>> values_to_filter_out);
 
  optional<float> new_value(float value) override;
 
 protected:
  std::vector<TemplatableValue<float>> values_to_filter_out_;
};
 
class ThrottleFilter : public Filter {
 public:
  explicit ThrottleFilter(uint32_t min_time_between_inputs);
 
  optional<float> new_value(float value) override;
 
 protected:
  uint32_t last_input_{0};
  uint32_t min_time_between_inputs_;
};
 
class ThrottleWithPriorityFilter : public Filter {
 public:
  explicit ThrottleWithPriorityFilter(uint32_t min_time_between_inputs,
                                      std::vector<TemplatableValue<float>> prioritized_values);
 
  optional<float> new_value(float value) override;
 
 protected:
  uint32_t last_input_{0};
  uint32_t min_time_between_inputs_;
  std::vector<TemplatableValue<float>> prioritized_values_;
};
 
class TimeoutFilter : public Filter, public Component {
 public:
  explicit TimeoutFilter(uint32_t time_period);
  explicit TimeoutFilter(uint32_t time_period, const TemplatableValue<float> &new_value);
 
  optional<float> new_value(float value) override;
 
  float get_setup_priority() const override;
 
 protected:
  uint32_t time_period_;
  optional<TemplatableValue<float>> value_;
};
 
class DebounceFilter : public Filter, public Component {
 public:
  explicit DebounceFilter(uint32_t time_period);
 
  optional<float> new_value(float value) override;
 
  float get_setup_priority() const override;
 
 protected:
  uint32_t time_period_;
};
 
class HeartbeatFilter : public Filter, public Component {
 public:
  explicit HeartbeatFilter(uint32_t time_period);
 
  void setup() override;
 
  optional<float> new_value(float value) override;
 
  float get_setup_priority() const override;
 
 protected:
  uint32_t time_period_;
  float last_input_;
  bool has_value_{false};
};
 
class DeltaFilter : public Filter {
 public:
  explicit DeltaFilter(float delta, bool percentage_mode);
 
  optional<float> new_value(float value) override;
 
 protected:
  float delta_;
  float current_delta_;
  float last_value_{NAN};
  bool percentage_mode_;
};
 
class OrFilter : public Filter {
 public:
  explicit OrFilter(std::vector<Filter *> filters);
 
  void initialize(Sensor *parent, Filter *next) override;
 
  optional<float> new_value(float value) override;
 
 protected:
  class PhiNode : public Filter {
   public:
    PhiNode(OrFilter *or_parent);
    optional<float> new_value(float value) override;
 
   protected:
    OrFilter *or_parent_;
  };
 
  std::vector<Filter *> filters_;
  PhiNode phi_;
  bool has_value_{false};
};
 
class CalibrateLinearFilter : public Filter {
 public:
  CalibrateLinearFilter(std::vector<std::array<float, 3>> linear_functions)
      : linear_functions_(std::move(linear_functions)) {}
  optional<float> new_value(float value) override;
 
 protected:
  std::vector<std::array<float, 3>> linear_functions_;
};
 
class CalibratePolynomialFilter : public Filter {
 public:
  CalibratePolynomialFilter(std::vector<float> coefficients) : coefficients_(std::move(coefficients)) {}
  optional<float> new_value(float value) override;
 
 protected:
  std::vector<float> coefficients_;
};
 
class ClampFilter : public Filter {
 public:
  ClampFilter(float min, float max, bool ignore_out_of_range);
  optional<float> new_value(float value) override;
 
 protected:
  float min_{NAN};
  float max_{NAN};
  bool ignore_out_of_range_;
};
 
class RoundFilter : public Filter {
 public:
  explicit RoundFilter(uint8_t precision);
  optional<float> new_value(float value) override;
 
 protected:
  uint8_t precision_;
};
 
class RoundMultipleFilter : public Filter {
 public:
  explicit RoundMultipleFilter(float multiple);
  optional<float> new_value(float value) override;
 
 protected:
  float multiple_;
};
 
class ToNTCResistanceFilter : public Filter {
 public:
  ToNTCResistanceFilter(double a, double b, double c) : a_(a), b_(b), c_(c) {}
  optional<float> new_value(float value) override;
 
 protected:
  double a_;
  double b_;
  double c_;
};
 
class ToNTCTemperatureFilter : public Filter {
 public:
  ToNTCTemperatureFilter(double a, double b, double c) : a_(a), b_(b), c_(c) {}
  optional<float> new_value(float value) override;
 
 protected:
  double a_;
  double b_;
  double c_;
};
 
}  // namespace sensor
}  // namespace esphome