ESPHome  2021.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::integration::IntegrationSensor Class Reference

#include <integration_sensor.h>

Inheritance diagram for esphome::integration::IntegrationSensor:
esphome::sensor::Sensor esphome::Component esphome::EntityBase

Public Member Functions

void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_min_save_interval (uint32_t min_interval)
 
void set_sensor (Sensor *sensor)
 
void set_time (IntegrationSensorTime time)
 
void set_method (IntegrationMethod method)
 
void set_restore (bool restore)
 
void reset ()
 
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 
 Sensor (const std::string &name)
 
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
 
void set_unit_of_measurement (const std::string &unit_of_measurement)
 Manually set the unit of measurement. More...
 
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...
 
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const std::string &device_class)
 Manually set the device class. 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 ()
 A unique ID for this sensor, empty for no unique id. More...
 
void internal_send_state_to_frontend (float state)
 
- Public Member Functions inherited from esphome::EntityBase
 EntityBase ()
 
 EntityBase (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_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)
 
const std::string & get_icon () const
 
void set_icon (const std::string &name)
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. 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 ()
 
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_sensor_value_ (float value)
 
float get_time_factor_ ()
 
void publish_and_save_ (double result)
 
std::string unit_of_measurement () override
 
int8_t accuracy_decimals () override
 
- Protected Member Functions inherited from esphome::sensor::Sensor
virtual std::string device_class ()
 Override this to set the default device class. More...
 
virtual StateClass state_class ()
 Override this to set the default state class. More...
 
uint32_t hash_base () override
 
- Protected Member Functions inherited from esphome::EntityBase
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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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

sensor::Sensorsensor_
 
IntegrationSensorTime time_
 
IntegrationMethod method_
 
bool restore_
 
ESPPreferenceObject rtc_
 
uint32_t last_save_ {0}
 
uint32_t min_save_interval_ {0}
 
uint32_t last_update_
 
double result_ {0.0f}
 
float last_value_ {0.0f}
 
- 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...
 
bool has_state_ {false}
 
Filterfilter_list_ {nullptr}
 Store all active filters. More...
 
optional< std::string > unit_of_measurement_
 Unit of measurement override. More...
 
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
 
optional< std::string > device_class_
 Device class override. More...
 
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
 
bool force_update_ {false}
 Force update mode. More...
 
- Protected Attributes inherited from esphome::EntityBase
std::string name_
 
std::string object_id_
 
std::string icon_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
- 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

Definition at line 26 of file integration_sensor.h.

Member Function Documentation

◆ accuracy_decimals()

int8_t esphome::integration::IntegrationSensor::accuracy_decimals ( )
inlineoverrideprotectedvirtual

Reimplemented from esphome::sensor::Sensor.

Definition at line 67 of file integration_sensor.h.

◆ dump_config()

void esphome::integration::IntegrationSensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file integration_sensor.cpp.

◆ get_setup_priority()

float esphome::integration::IntegrationSensor::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file integration_sensor.h.

◆ get_time_factor_()

float esphome::integration::IntegrationSensor::get_time_factor_ ( )
inlineprotected

Definition at line 40 of file integration_sensor.h.

◆ process_sensor_value_()

void esphome::integration::IntegrationSensor::process_sensor_value_ ( float  value)
protected

Definition at line 51 of file integration_sensor.cpp.

◆ publish_and_save_()

void esphome::integration::IntegrationSensor::publish_and_save_ ( double  result)
inlineprotected

Definition at line 56 of file integration_sensor.h.

◆ reset()

void esphome::integration::IntegrationSensor::reset ( )
inline

Definition at line 36 of file integration_sensor.h.

◆ set_method()

void esphome::integration::IntegrationSensor::set_method ( IntegrationMethod  method)
inline

Definition at line 34 of file integration_sensor.h.

◆ set_min_save_interval()

void esphome::integration::IntegrationSensor::set_min_save_interval ( uint32_t  min_interval)
inline

Definition at line 31 of file integration_sensor.h.

◆ set_restore()

void esphome::integration::IntegrationSensor::set_restore ( bool  restore)
inline

Definition at line 35 of file integration_sensor.h.

◆ set_sensor()

void esphome::integration::IntegrationSensor::set_sensor ( Sensor sensor)
inline

Definition at line 32 of file integration_sensor.h.

◆ set_time()

void esphome::integration::IntegrationSensor::set_time ( IntegrationSensorTime  time)
inline

Definition at line 33 of file integration_sensor.h.

◆ setup()

void esphome::integration::IntegrationSensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file integration_sensor.cpp.

◆ unit_of_measurement()

std::string esphome::integration::IntegrationSensor::unit_of_measurement ( )
overrideprotectedvirtual

Reimplemented from esphome::sensor::Sensor.

Definition at line 26 of file integration_sensor.cpp.

Field Documentation

◆ last_save_

uint32_t esphome::integration::IntegrationSensor::last_save_ {0}
protected

Definition at line 75 of file integration_sensor.h.

◆ last_update_

uint32_t esphome::integration::IntegrationSensor::last_update_
protected

Definition at line 77 of file integration_sensor.h.

◆ last_value_

float esphome::integration::IntegrationSensor::last_value_ {0.0f}
protected

Definition at line 79 of file integration_sensor.h.

◆ method_

IntegrationMethod esphome::integration::IntegrationSensor::method_
protected

Definition at line 71 of file integration_sensor.h.

◆ min_save_interval_

uint32_t esphome::integration::IntegrationSensor::min_save_interval_ {0}
protected

Definition at line 76 of file integration_sensor.h.

◆ restore_

bool esphome::integration::IntegrationSensor::restore_
protected

Definition at line 72 of file integration_sensor.h.

◆ result_

double esphome::integration::IntegrationSensor::result_ {0.0f}
protected

Definition at line 78 of file integration_sensor.h.

◆ rtc_

ESPPreferenceObject esphome::integration::IntegrationSensor::rtc_
protected

Definition at line 73 of file integration_sensor.h.

◆ sensor_

sensor::Sensor* esphome::integration::IntegrationSensor::sensor_
protected

Definition at line 69 of file integration_sensor.h.

◆ time_

IntegrationSensorTime esphome::integration::IntegrationSensor::time_
protected

Definition at line 70 of file integration_sensor.h.


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