ESPHome  2021.9.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::pid::PIDClimate Class Reference

#include <pid_climate.h>

Inheritance diagram for esphome::pid::PIDClimate:
esphome::climate::Climate esphome::Component esphome::Nameable

Public Member Functions

 PIDClimate ()=default
 
void setup () override
 
void dump_config () override
 
void set_sensor (sensor::Sensor *sensor)
 
void set_cool_output (output::FloatOutput *cool_output)
 
void set_heat_output (output::FloatOutput *heat_output)
 
void set_kp (float kp)
 
void set_ki (float ki)
 
void set_kd (float kd)
 
void set_min_integral (float min_integral)
 
void set_max_integral (float max_integral)
 
float get_output_value () const
 
float get_error_value () const
 
float get_kp ()
 
float get_ki ()
 
float get_kd ()
 
float get_proportional_term () const
 
float get_integral_term () const
 
float get_derivative_term () const
 
void add_on_pid_computed_callback (std::function< void()> &&callback)
 
void set_default_target_temperature (float default_target_temperature)
 
void start_autotune (std::unique_ptr< PIDAutotuner > &&autotune)
 
void reset_integral_term ()
 
- Public Member Functions inherited from esphome::climate::Climate
 Climate ()
 Construct a climate device with empty name (will be set later). More...
 
 Climate (const std::string &name)
 Construct a climate device with a name. More...
 
 ESPDEPRECATED ("away is deprecated, use preset instead", "v1.20") bool away
 Whether the climate device is in away mode. More...
 
void add_on_state_callback (std::function< void()> &&callback)
 Add a callback for the climate device state, each time the state of the climate device is updated (using publish_state), this callback will be called. More...
 
ClimateCall make_call ()
 Make a climate device control call, this is used to control the climate device, see the ClimateCall description for more info. More...
 
void publish_state ()
 Publish the state of the climate device, to be called from integrations. More...
 
ClimateTraits get_traits ()
 Get the traits of this climate device with all overrides applied. More...
 
void set_visual_min_temperature_override (float visual_min_temperature_override)
 
void set_visual_max_temperature_override (float visual_max_temperature_override)
 
void set_visual_temperature_step_override (float visual_temperature_step_override)
 
- Public Member Functions inherited from esphome::Nameable
 Nameable ()
 
 Nameable (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_object_id ()
 Get the sanitized name of this nameable as an ID. Caching it internally. More...
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 Check if this object is declared to be disabled by default. More...
 
void set_disabled_by_default (bool disabled_by_default)
 
- 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 control (const climate::ClimateCall &call) override
 Override control to change settings of the climate device. More...
 
climate::ClimateTraits traits () override
 Return the traits of this controller. More...
 
void update_pid_ ()
 
bool supports_cool_ () const
 
bool supports_heat_ () const
 
void write_output_ (float value)
 
- Protected Member Functions inherited from esphome::climate::Climate
bool set_fan_mode_ (ClimateFanMode mode)
 Set fan mode. Reset custom fan mode. Return true if fan mode has been changed. More...
 
bool set_custom_fan_mode_ (const std::string &mode)
 Set custom fan mode. Reset primary fan mode. Return true if fan mode has been changed. More...
 
bool set_preset_ (ClimatePreset preset)
 Set preset. Reset custom preset. Return true if preset has been changed. More...
 
bool set_custom_preset_ (const std::string &preset)
 Set custom preset. Reset primary preset. Return true if preset has been changed. More...
 
optional< ClimateDeviceRestoreStaterestore_state_ ()
 Restore the state of the climate device, call this from your setup() method. More...
 
void save_state_ ()
 Internal method to save the state of the climate device to recover memory. More...
 
uint32_t hash_base () override
 
void dump_traits_ (const char *tag)
 
- Protected Member Functions inherited from esphome::Nameable
void calc_object_id_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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_
 The sensor used for getting the current temperature. More...
 
output::FloatOutputcool_output_ = nullptr
 
output::FloatOutputheat_output_ = nullptr
 
PIDController controller_
 
float output_value_
 Output value as reported by the PID controller, for PIDClimateSensor. More...
 
CallbackManager< void()> pid_computed_callback_
 
float default_target_temperature_
 
std::unique_ptr< PIDAutotunerautotuner_
 
bool do_publish_ = false
 
- Protected Attributes inherited from esphome::climate::Climate
friend ClimateCall
 
CallbackManager< void()> state_callback_ {}
 
ESPPreferenceObject rtc_
 
optional< float > visual_min_temperature_override_ {}
 
optional< float > visual_max_temperature_override_ {}
 
optional< float > visual_temperature_step_override_ {}
 
- Protected Attributes inherited from esphome::Nameable
std::string name_
 
std::string object_id_
 
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::climate::Climate
ClimateMode mode {CLIMATE_MODE_OFF}
 The active mode of the climate device. More...
 
ClimateAction action {CLIMATE_ACTION_OFF}
 The active state of the climate device. More...
 
float current_temperature {NAN}
 The current temperature of the climate device, as reported from the integration. More...
 
union {
   float   target_temperature
 The target temperature of the climate device. More...
 
   struct {
      float   target_temperature_low
 The minimum target temperature of the climate device, for climate devices with split target temperature. More...
 
      float   target_temperature_high
 The maximum target temperature of the climate device, for climate devices with split target temperature. More...
 
   } 
 
}; 
 
optional< ClimateFanModefan_mode
 The active fan mode of the climate device. More...
 
ClimateSwingMode swing_mode
 The active swing mode of the climate device. More...
 
optional< std::string > custom_fan_mode
 The active custom fan mode of the climate device. More...
 
optional< ClimatePresetpreset
 The active preset of the climate device. More...
 
optional< std::string > custom_preset
 The active custom preset mode of the climate device. More...
 

Detailed Description

Definition at line 15 of file pid_climate.h.

Constructor & Destructor Documentation

◆ PIDClimate()

esphome::pid::PIDClimate::PIDClimate ( )
default

Member Function Documentation

◆ add_on_pid_computed_callback()

void esphome::pid::PIDClimate::add_on_pid_computed_callback ( std::function< void()> &&  callback)
inline

Definition at line 38 of file pid_climate.h.

◆ control()

void esphome::pid::PIDClimate::control ( const climate::ClimateCall call)
overrideprotectedvirtual

Override control to change settings of the climate device.

Implements esphome::climate::Climate.

Definition at line 32 of file pid_climate.cpp.

◆ dump_config()

void esphome::pid::PIDClimate::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 60 of file pid_climate.cpp.

◆ get_derivative_term()

float esphome::pid::PIDClimate::get_derivative_term ( ) const
inline

Definition at line 37 of file pid_climate.h.

◆ get_error_value()

float esphome::pid::PIDClimate::get_error_value ( ) const
inline

Definition at line 31 of file pid_climate.h.

◆ get_integral_term()

float esphome::pid::PIDClimate::get_integral_term ( ) const
inline

Definition at line 36 of file pid_climate.h.

◆ get_kd()

float esphome::pid::PIDClimate::get_kd ( )
inline

Definition at line 34 of file pid_climate.h.

◆ get_ki()

float esphome::pid::PIDClimate::get_ki ( )
inline

Definition at line 33 of file pid_climate.h.

◆ get_kp()

float esphome::pid::PIDClimate::get_kp ( )
inline

Definition at line 32 of file pid_climate.h.

◆ get_output_value()

float esphome::pid::PIDClimate::get_output_value ( ) const
inline

Definition at line 30 of file pid_climate.h.

◆ get_proportional_term()

float esphome::pid::PIDClimate::get_proportional_term ( ) const
inline

Definition at line 35 of file pid_climate.h.

◆ reset_integral_term()

void esphome::pid::PIDClimate::reset_integral_term ( )

Definition at line 148 of file pid_climate.cpp.

◆ set_cool_output()

void esphome::pid::PIDClimate::set_cool_output ( output::FloatOutput cool_output)
inline

Definition at line 22 of file pid_climate.h.

◆ set_default_target_temperature()

void esphome::pid::PIDClimate::set_default_target_temperature ( float  default_target_temperature)
inline

Definition at line 41 of file pid_climate.h.

◆ set_heat_output()

void esphome::pid::PIDClimate::set_heat_output ( output::FloatOutput heat_output)
inline

Definition at line 23 of file pid_climate.h.

◆ set_kd()

void esphome::pid::PIDClimate::set_kd ( float  kd)
inline

Definition at line 26 of file pid_climate.h.

◆ set_ki()

void esphome::pid::PIDClimate::set_ki ( float  ki)
inline

Definition at line 25 of file pid_climate.h.

◆ set_kp()

void esphome::pid::PIDClimate::set_kp ( float  kp)
inline

Definition at line 24 of file pid_climate.h.

◆ set_max_integral()

void esphome::pid::PIDClimate::set_max_integral ( float  max_integral)
inline

Definition at line 28 of file pid_climate.h.

◆ set_min_integral()

void esphome::pid::PIDClimate::set_min_integral ( float  min_integral)
inline

Definition at line 27 of file pid_climate.h.

◆ set_sensor()

void esphome::pid::PIDClimate::set_sensor ( sensor::Sensor sensor)
inline

Definition at line 21 of file pid_climate.h.

◆ setup()

void esphome::pid::PIDClimate::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file pid_climate.cpp.

◆ start_autotune()

void esphome::pid::PIDClimate::start_autotune ( std::unique_ptr< PIDAutotuner > &&  autotune)

Definition at line 137 of file pid_climate.cpp.

◆ supports_cool_()

bool esphome::pid::PIDClimate::supports_cool_ ( ) const
inlineprotected

Definition at line 55 of file pid_climate.h.

◆ supports_heat_()

bool esphome::pid::PIDClimate::supports_heat_ ( ) const
inlineprotected

Definition at line 56 of file pid_climate.h.

◆ traits()

climate::ClimateTraits esphome::pid::PIDClimate::traits ( )
overrideprotectedvirtual

Return the traits of this controller.

Implements esphome::climate::Climate.

Definition at line 44 of file pid_climate.cpp.

◆ update_pid_()

void esphome::pid::PIDClimate::update_pid_ ( )
protected

Definition at line 101 of file pid_climate.cpp.

◆ write_output_()

void esphome::pid::PIDClimate::write_output_ ( float  value)
protected

Definition at line 69 of file pid_climate.cpp.

Field Documentation

◆ autotuner_

std::unique_ptr<PIDAutotuner> esphome::pid::PIDClimate::autotuner_
protected

Definition at line 69 of file pid_climate.h.

◆ controller_

PIDController esphome::pid::PIDClimate::controller_
protected

Definition at line 64 of file pid_climate.h.

◆ cool_output_

output::FloatOutput* esphome::pid::PIDClimate::cool_output_ = nullptr
protected

Definition at line 62 of file pid_climate.h.

◆ default_target_temperature_

float esphome::pid::PIDClimate::default_target_temperature_
protected

Definition at line 68 of file pid_climate.h.

◆ do_publish_

bool esphome::pid::PIDClimate::do_publish_ = false
protected

Definition at line 70 of file pid_climate.h.

◆ heat_output_

output::FloatOutput* esphome::pid::PIDClimate::heat_output_ = nullptr
protected

Definition at line 63 of file pid_climate.h.

◆ output_value_

float esphome::pid::PIDClimate::output_value_
protected

Output value as reported by the PID controller, for PIDClimateSensor.

Definition at line 66 of file pid_climate.h.

◆ pid_computed_callback_

CallbackManager<void()> esphome::pid::PIDClimate::pid_computed_callback_
protected

Definition at line 67 of file pid_climate.h.

◆ sensor_

sensor::Sensor* esphome::pid::PIDClimate::sensor_
protected

The sensor used for getting the current temperature.

Definition at line 61 of file pid_climate.h.


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