binary_sensor_map.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/component.h"
#include "esphome/components/binary_sensor/binary_sensor.h"
#include "esphome/components/sensor/sensor.h"

#include <vector>

namespace esphome {
namespace binary_sensor_map {

enum BinarySensorMapType {
  BINARY_SENSOR_MAP_TYPE_GROUP,
  BINARY_SENSOR_MAP_TYPE_SUM,
  BINARY_SENSOR_MAP_TYPE_BAYESIAN,
};

struct BinarySensorMapChannel {
  binary_sensor::BinarySensor *binary_sensor;
  union {
    float sensor_value;
    struct {
      float given_true;
      float given_false;
    } probabilities;
  } parameters;
};

class BinarySensorMap : public sensor::Sensor, public Component {
 public:
  void dump_config() override;

  void loop() override;

  void add_channel(binary_sensor::BinarySensor *sensor, float value);

  void add_channel(binary_sensor::BinarySensor *sensor, float prob_given_true, float prob_given_false);

  void set_sensor_type(BinarySensorMapType sensor_type) { this->sensor_type_ = sensor_type; }

  void set_bayesian_prior(float prior) { this->bayesian_prior_ = prior; };

 protected:
  std::vector<BinarySensorMapChannel> channels_{};
  BinarySensorMapType sensor_type_{BINARY_SENSOR_MAP_TYPE_GROUP};

  // this allows a max of 64 channels/observations in order to keep track of binary_sensor states
  uint64_t last_mask_{0x00};

  // Bayesian event prior probability before taking into account any observations
  float bayesian_prior_{};

  void process_group_();
  void process_sum_();
  void process_bayesian_();

  float bayesian_predicate_(bool sensor_state, float prior, float prob_given_true, float prob_given_false);
};

}  // namespace binary_sensor_map
}  // namespace esphome