ESPHome  2021.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::pid::PIDClimateSensor Class Reference

#include <pid_climate_sensor.h>

Inheritance diagram for esphome::pid::PIDClimateSensor:
esphome::sensor::Sensor esphome::Component esphome::EntityBase

Public Member Functions

void setup () override
void set_parent (PIDClimate *parent)
void set_type (PIDClimateSensorType type)
void dump_config () override
- 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)
EntityCategory get_entity_category () const
void set_entity_category (EntityCategory entity_category)
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...
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 ()
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 update_from_parent_ ()
- Protected Member Functions inherited from esphome::sensor::Sensor
virtual std::string unit_of_measurement ()
 Override this to set the default unit of measurement. More...
virtual int8_t accuracy_decimals ()
 Override this to set the default accuracy in decimals. More...
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

PIDClimateSensorType type_
- 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}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
- 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 22 of file pid_climate_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::pid::PIDClimateSensor::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 56 of file pid_climate_sensor.cpp.

◆ set_parent()

void esphome::pid::PIDClimateSensor::set_parent ( PIDClimate parent)

Definition at line 25 of file pid_climate_sensor.h.

◆ set_type()

void esphome::pid::PIDClimateSensor::set_type ( PIDClimateSensorType  type)

Definition at line 26 of file pid_climate_sensor.h.

◆ setup()

void esphome::pid::PIDClimateSensor::setup ( )

Reimplemented from esphome::Component.

Definition at line 10 of file pid_climate_sensor.cpp.

◆ update_from_parent_()

void esphome::pid::PIDClimateSensor::update_from_parent_ ( )

Definition at line 14 of file pid_climate_sensor.cpp.

Field Documentation

◆ parent_

PIDClimate* esphome::pid::PIDClimateSensor::parent_

Definition at line 32 of file pid_climate_sensor.h.

◆ type_

PIDClimateSensorType esphome::pid::PIDClimateSensor::type_

Definition at line 33 of file pid_climate_sensor.h.

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