ESPHome  2024.11.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::EntityBase

Public Member Functions

 PIDClimate ()=default
 
void setup () override
 
void dump_config () override
 
void set_sensor (sensor::Sensor *sensor)
 
void set_humidity_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)
 
void set_output_samples (int in)
 
void set_derivative_samples (int in)
 
void set_threshold_low (float in)
 
void set_threshold_high (float in)
 
void set_kp_multiplier (float in)
 
void set_ki_multiplier (float in)
 
void set_kd_multiplier (float in)
 
void set_starting_integral_term (float in)
 
void set_deadband_output_samples (int in)
 
float get_output_value () const
 
float get_error_value () const
 
float get_kp ()
 
float get_ki ()
 
float get_kd ()
 
float get_min_integral ()
 
float get_max_integral ()
 
float get_proportional_term () const
 
float get_integral_term () const
 
float get_derivative_term () const
 
int get_output_samples ()
 
int get_derivative_samples ()
 
float get_threshold_low ()
 
float get_threshold_high ()
 
float get_kp_multiplier ()
 
float get_ki_multiplier ()
 
float get_kd_multiplier ()
 
int get_deadband_output_samples ()
 
bool in_deadband ()
 
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 ()
 
void add_on_state_callback (std::function< void(Climate &)> &&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...
 
void add_on_control_callback (std::function< void(ClimateCall &)> &&callback)
 Add a callback for the climate device configuration; each time the configuration parameters of a climate device is updated (using perform() of a ClimateCall), this callback will be called, before any on_state callback. 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 target, float current)
 
void set_visual_min_humidity_override (float visual_min_humidity_override)
 
void set_visual_max_humidity_override (float visual_max_humidity_override)
 
- 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::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 () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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...
 
void dump_traits_ (const char *tag)
 
- 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

sensor::Sensorsensor_
 The sensor used for getting the current temperature. More...
 
sensor::Sensorhumidity_sensor_ {nullptr}
 The sensor used for getting the current humidity. 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(Climate &)> state_callback_ {}
 
CallbackManager< void(ClimateCall &)> control_callback_ {}
 
ESPPreferenceObject rtc_
 
optional< float > visual_min_temperature_override_ {}
 
optional< float > visual_max_temperature_override_ {}
 
optional< float > visual_target_temperature_step_override_ {}
 
optional< float > visual_current_temperature_step_override_ {}
 
optional< float > visual_min_humidity_override_ {}
 
optional< float > visual_max_humidity_override_ {}
 
- 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::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...
 
float current_humidity {NAN}
 The current humidity 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 {NAN}
 The minimum target temperature of the climate device, for climate devices with split target temperature. More...
 
      float   target_temperature_high {NAN}
 The maximum target temperature of the climate device, for climate devices with split target temperature. More...
 
   } 
 
}; 
 
float target_humidity
 The target humidity of the climate device. 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 67 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 43 of file pid_climate.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 74 of file pid_climate.cpp.

◆ get_deadband_output_samples()

int esphome::pid::PIDClimate::get_deadband_output_samples ( )
inline

Definition at line 60 of file pid_climate.h.

◆ get_derivative_samples()

int esphome::pid::PIDClimate::get_derivative_samples ( )
inline

Definition at line 53 of file pid_climate.h.

◆ get_derivative_term()

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

Definition at line 51 of file pid_climate.h.

◆ get_error_value()

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

Definition at line 43 of file pid_climate.h.

◆ get_integral_term()

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

Definition at line 50 of file pid_climate.h.

◆ get_kd()

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

Definition at line 46 of file pid_climate.h.

◆ get_kd_multiplier()

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

Definition at line 59 of file pid_climate.h.

◆ get_ki()

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

Definition at line 45 of file pid_climate.h.

◆ get_ki_multiplier()

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

Definition at line 58 of file pid_climate.h.

◆ get_kp()

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

Definition at line 44 of file pid_climate.h.

◆ get_kp_multiplier()

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

Definition at line 57 of file pid_climate.h.

◆ get_max_integral()

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

Definition at line 48 of file pid_climate.h.

◆ get_min_integral()

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

Definition at line 47 of file pid_climate.h.

◆ get_output_samples()

int esphome::pid::PIDClimate::get_output_samples ( )
inline

Definition at line 52 of file pid_climate.h.

◆ get_output_value()

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

Definition at line 42 of file pid_climate.h.

◆ get_proportional_term()

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

Definition at line 49 of file pid_climate.h.

◆ get_threshold_high()

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

Definition at line 56 of file pid_climate.h.

◆ get_threshold_low()

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

Definition at line 55 of file pid_climate.h.

◆ in_deadband()

bool esphome::pid::PIDClimate::in_deadband ( )
inline

Definition at line 61 of file pid_climate.h.

◆ reset_integral_term()

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

Definition at line 184 of file pid_climate.cpp.

◆ set_cool_output()

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

Definition at line 23 of file pid_climate.h.

◆ set_deadband_output_samples()

void esphome::pid::PIDClimate::set_deadband_output_samples ( int  in)
inline

Definition at line 40 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 70 of file pid_climate.h.

◆ set_derivative_samples()

void esphome::pid::PIDClimate::set_derivative_samples ( int  in)
inline

Definition at line 31 of file pid_climate.h.

◆ set_heat_output()

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

Definition at line 24 of file pid_climate.h.

◆ set_humidity_sensor()

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

Definition at line 22 of file pid_climate.h.

◆ set_kd()

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

Definition at line 27 of file pid_climate.h.

◆ set_kd_multiplier()

void esphome::pid::PIDClimate::set_kd_multiplier ( float  in)
inline

Definition at line 37 of file pid_climate.h.

◆ set_ki()

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

Definition at line 26 of file pid_climate.h.

◆ set_ki_multiplier()

void esphome::pid::PIDClimate::set_ki_multiplier ( float  in)
inline

Definition at line 36 of file pid_climate.h.

◆ set_kp()

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

Definition at line 25 of file pid_climate.h.

◆ set_kp_multiplier()

void esphome::pid::PIDClimate::set_kp_multiplier ( float  in)
inline

Definition at line 35 of file pid_climate.h.

◆ set_max_integral()

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

Definition at line 29 of file pid_climate.h.

◆ set_min_integral()

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

Definition at line 28 of file pid_climate.h.

◆ set_output_samples()

void esphome::pid::PIDClimate::set_output_samples ( int  in)
inline

Definition at line 30 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.

◆ set_starting_integral_term()

void esphome::pid::PIDClimate::set_starting_integral_term ( float  in)
inline

Definition at line 38 of file pid_climate.h.

◆ set_threshold_high()

void esphome::pid::PIDClimate::set_threshold_high ( float  in)
inline

Definition at line 34 of file pid_climate.h.

◆ set_threshold_low()

void esphome::pid::PIDClimate::set_threshold_low ( float  in)
inline

Definition at line 33 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 159 of file pid_climate.cpp.

◆ supports_cool_()

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

Definition at line 84 of file pid_climate.h.

◆ supports_heat_()

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

Definition at line 85 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 55 of file pid_climate.cpp.

◆ update_pid_()

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

Definition at line 126 of file pid_climate.cpp.

◆ write_output_()

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

Definition at line 93 of file pid_climate.cpp.

Field Documentation

◆ autotuner_

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

Definition at line 100 of file pid_climate.h.

◆ controller_

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

Definition at line 95 of file pid_climate.h.

◆ cool_output_

output::FloatOutput* esphome::pid::PIDClimate::cool_output_ {nullptr}
protected

Definition at line 93 of file pid_climate.h.

◆ default_target_temperature_

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

Definition at line 99 of file pid_climate.h.

◆ do_publish_

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

Definition at line 101 of file pid_climate.h.

◆ heat_output_

output::FloatOutput* esphome::pid::PIDClimate::heat_output_ {nullptr}
protected

Definition at line 94 of file pid_climate.h.

◆ humidity_sensor_

sensor::Sensor* esphome::pid::PIDClimate::humidity_sensor_ {nullptr}
protected

The sensor used for getting the current humidity.

Definition at line 92 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 97 of file pid_climate.h.

◆ pid_computed_callback_

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

Definition at line 98 of file pid_climate.h.

◆ sensor_

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

The sensor used for getting the current temperature.

Definition at line 90 of file pid_climate.h.


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