ESPHome  2023.11.6
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::binary_sensor_map::BinarySensorMap Class Reference

Class to map one or more binary_sensors to one Sensor. More...

#include <binary_sensor_map.h>

Inheritance diagram for esphome::binary_sensor_map::BinarySensorMap:
esphome::sensor::Sensor esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass esphome::EntityBase_UnitOfMeasurement

Public Member Functions

void dump_config () override
 
void loop () override
 The loop calls the configured type processing method. More...
 
void add_channel (binary_sensor::BinarySensor *sensor, float value)
 Add binary_sensors to the group when only one parameter is needed for the configured mapping type. More...
 
void add_channel (binary_sensor::BinarySensor *sensor, float prob_given_true, float prob_given_false)
 Add binary_sensors to the group when two parameters are needed for the Bayesian mapping type. More...
 
void set_sensor_type (BinarySensorMapType sensor_type)
 
void set_bayesian_prior (float prior)
 
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 
int8_t get_accuracy_decimals ()
 Get the accuracy in decimals, using the manual override if set. More...
 
void set_accuracy_decimals (int8_t accuracy_decimals)
 Manually set the accuracy in decimals. More...
 
StateClass get_state_class ()
 Get the state class, using the manual override if set. More...
 
void set_state_class (StateClass state_class)
 Manually set the state class. More...
 
bool get_force_update () const
 Get whether force update mode is enabled. More...
 
void set_force_update (bool force_update)
 Set force update mode. More...
 
void add_filter (Filter *filter)
 Add a filter to the filter chain. Will be appended to the back. More...
 
void add_filters (const std::vector< Filter *> &filters)
 Add a list of vectors to the back of the filter chain. More...
 
void set_filters (const std::vector< Filter *> &filters)
 Clear the filters and replace them by filters. More...
 
void clear_filters ()
 Clear the entire filter chain. More...
 
float get_state () const
 Getter-syntax for .state. More...
 
float get_raw_state () const
 Getter-syntax for .raw_state. More...
 
void publish_state (float state)
 Publish a new state to the front-end. More...
 
void add_on_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time a filtered value arrives. More...
 
void add_on_raw_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time the sensor sends a raw value. More...
 
bool has_state () const
 Return whether this sensor has gotten a full state (that passed through all filters) yet. More...
 
virtual std::string unique_id ()
 Override this method to set the unique ID of this sensor. More...
 
void internal_send_state_to_frontend (float state)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const char *device_class)
 Manually set the device class. More...
 
- Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
 
void set_unit_of_measurement (const char *unit_of_measurement)
 Manually set the unit of measurement. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

void process_group_ ()
 Methods to process the binary_sensor_maps types. More...
 
void process_sum_ ()
 
void process_bayesian_ ()
 
float bayesian_predicate_ (bool sensor_state, float prior, float prob_given_true, float prob_given_false)
 Computes the Bayesian predicate for a specific observation If the sensor state is false, then we use the parameters' probabilities for the observatiosn complement. More...
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

std::vector< BinarySensorMapChannelchannels_ {}
 
BinarySensorMapType sensor_type_ {BINARY_SENSOR_MAP_TYPE_GROUP}
 
uint64_t last_mask_ {0x00}
 
float bayesian_prior_ {}
 
- Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)> raw_callback_
 Storage for raw state callbacks. More...
 
CallbackManager< void(float)> callback_
 Storage for filtered state callbacks. More...
 
Filterfilter_list_ {nullptr}
 Store all active filters. More...
 
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
 
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
 
bool force_update_ {false}
 Force update mode. More...
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
 
- Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char * unit_of_measurement_ {nullptr}
 Unit of measurement override. More...
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Data Fields inherited from esphome::sensor::Sensor
float state
 This member variable stores the last state that has passed through all filters. More...
 
float raw_state
 This member variable stores the current raw state of the sensor, without any filters applied. More...
 

Detailed Description

Class to map one or more binary_sensors to one Sensor.

Each binary sensor has configured parameters that each mapping type uses to compute the single numerical result

Definition at line 33 of file binary_sensor_map.h.

Member Function Documentation

◆ add_channel() [1/2]

void esphome::binary_sensor_map::BinarySensorMap::add_channel ( binary_sensor::BinarySensor sensor,
float  value 
)

Add binary_sensors to the group when only one parameter is needed for the configured mapping type.

Parameters
*sensorThe binary sensor.
valueThe value this binary_sensor represents

Definition at line 119 of file binary_sensor_map.cpp.

◆ add_channel() [2/2]

void esphome::binary_sensor_map::BinarySensorMap::add_channel ( binary_sensor::BinarySensor sensor,
float  prob_given_true,
float  prob_given_false 
)

Add binary_sensors to the group when two parameters are needed for the Bayesian mapping type.

Parameters
*sensorThe binary sensor.
prob_given_trueProbability this observation is on when the Bayesian event is true
prob_given_falseProbability this observation is on when the Bayesian event is false

Definition at line 129 of file binary_sensor_map.cpp.

◆ bayesian_predicate_()

float esphome::binary_sensor_map::BinarySensorMap::bayesian_predicate_ ( bool  sensor_state,
float  prior,
float  prob_given_true,
float  prob_given_false 
)
protected

Computes the Bayesian predicate for a specific observation If the sensor state is false, then we use the parameters' probabilities for the observatiosn complement.

Parameters
sensor_stateState of observation
priorPrior probability before accounting for this observation
prob_given_trueProbability this observation is on when the Bayesian event is true
prob_given_falseProbability this observation is on when the Bayesian event is false

Definition at line 105 of file binary_sensor_map.cpp.

◆ dump_config()

void esphome::binary_sensor_map::BinarySensorMap::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file binary_sensor_map.cpp.

◆ loop()

void esphome::binary_sensor_map::BinarySensorMap::loop ( )
overridevirtual

The loop calls the configured type processing method.

The processing method loops through all sensors and calculates the numerical result The result is only published if a binary sensor state has changed or, for some types, on initial boot

Reimplemented from esphome::Component.

Definition at line 11 of file binary_sensor_map.cpp.

◆ process_bayesian_()

void esphome::binary_sensor_map::BinarySensorMap::process_bayesian_ ( )
protected

Definition at line 81 of file binary_sensor_map.cpp.

◆ process_group_()

void esphome::binary_sensor_map::BinarySensorMap::process_group_ ( )
protected

Methods to process the binary_sensor_maps types.

GROUP: process_group_() averages all the values ADD: process_add_() adds all the values BAYESIAN: process_bayesian_() computes the predicate probability

Definition at line 25 of file binary_sensor_map.cpp.

◆ process_sum_()

void esphome::binary_sensor_map::BinarySensorMap::process_sum_ ( )
protected

Definition at line 58 of file binary_sensor_map.cpp.

◆ set_bayesian_prior()

void esphome::binary_sensor_map::BinarySensorMap::set_bayesian_prior ( float  prior)
inline

Definition at line 64 of file binary_sensor_map.h.

◆ set_sensor_type()

void esphome::binary_sensor_map::BinarySensorMap::set_sensor_type ( BinarySensorMapType  sensor_type)
inline

Definition at line 62 of file binary_sensor_map.h.

Field Documentation

◆ bayesian_prior_

float esphome::binary_sensor_map::BinarySensorMap::bayesian_prior_ {}
protected

Definition at line 74 of file binary_sensor_map.h.

◆ channels_

std::vector<BinarySensorMapChannel> esphome::binary_sensor_map::BinarySensorMap::channels_ {}
protected

Definition at line 67 of file binary_sensor_map.h.

◆ last_mask_

uint64_t esphome::binary_sensor_map::BinarySensorMap::last_mask_ {0x00}
protected

Definition at line 71 of file binary_sensor_map.h.

◆ sensor_type_

BinarySensorMapType esphome::binary_sensor_map::BinarySensorMap::sensor_type_ {BINARY_SENSOR_MAP_TYPE_GROUP}
protected

Definition at line 68 of file binary_sensor_map.h.


The documentation for this class was generated from the following files: