ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
pid_climate.h
Go to the documentation of this file.
1#pragma once
2
9#include "pid_controller.h"
10#include "pid_autotuner.h"
11
12namespace esphome::pid {
13
14class PIDClimate final : public climate::Climate, public Component {
15 SUB_SENSOR(temperature)
16 SUB_SENSOR(humidity)
17
18 public:
19 PIDClimate() = default;
20 void setup() override;
21 void dump_config() override;
22
23 void set_cool_output(output::FloatOutput *cool_output) { cool_output_ = cool_output; }
24 void set_heat_output(output::FloatOutput *heat_output) { heat_output_ = heat_output; }
25 void set_kp(float kp) { controller_.kp_ = kp; }
26 void set_ki(float ki) { controller_.ki_ = ki; }
27 void set_kd(float kd) { controller_.kd_ = kd; }
28 void set_min_integral(float min_integral) { controller_.min_integral_ = min_integral; }
29 void set_max_integral(float max_integral) { controller_.max_integral_ = max_integral; }
30 bool set_deadband_thresholds(float threshold_low, float threshold_high);
31 void set_output_samples(int in) { controller_.output_samples_ = in; }
32 void set_derivative_samples(int in) {
33 controller_.derivative_samples_ = in;
34 if (in > 1) // No allocation needed when samples=1 (ring_buffer_average_ short-circuits)
35 controller_.derivative_window_.init(in);
36 }
37
38 void set_threshold_low(float in) { controller_.threshold_low_ = in; }
39 void set_threshold_high(float in) { controller_.threshold_high_ = in; }
40 void set_kp_multiplier(float in) { controller_.kp_multiplier_ = in; }
41 void set_ki_multiplier(float in) { controller_.ki_multiplier_ = in; }
42 void set_kd_multiplier(float in) { controller_.kd_multiplier_ = in; }
43 void set_starting_integral_term(float in) { controller_.set_starting_integral_term(in); }
44
45 void set_deadband_output_samples(int in) { controller_.deadband_output_samples_ = in; }
46 void init_output_buffer(int size) {
47 if (size > 1) // No allocation needed when samples=1 (ring_buffer_average_ short-circuits)
48 controller_.output_window_.init(size);
49 }
50
51 float get_output_value() const { return output_value_; }
52 float get_error_value() const { return controller_.error_; }
53 float get_kp() { return controller_.kp_; }
54 float get_ki() { return controller_.ki_; }
55 float get_kd() { return controller_.kd_; }
56 float get_min_integral() { return controller_.min_integral_; }
57 float get_max_integral() { return controller_.max_integral_; }
58 float get_proportional_term() const { return controller_.proportional_term_; }
59 float get_integral_term() const { return controller_.integral_term_; }
60 float get_derivative_term() const { return controller_.derivative_term_; }
61 int get_output_samples() { return controller_.output_samples_; }
62 int get_derivative_samples() { return controller_.derivative_samples_; }
63
64 float get_threshold_low() { return controller_.threshold_low_; }
65 float get_threshold_high() { return controller_.threshold_high_; }
66 float get_kp_multiplier() { return controller_.kp_multiplier_; }
67 float get_ki_multiplier() { return controller_.ki_multiplier_; }
68 float get_kd_multiplier() { return controller_.kd_multiplier_; }
69 int get_deadband_output_samples() { return controller_.deadband_output_samples_; }
70 bool in_deadband() { return controller_.in_deadband(); }
71
72 // int get_derivative_samples() const { return controller_.derivative_samples; }
73 // float get_deadband() const { return controller_.deadband; }
74 // float get_proportional_deadband_multiplier() const { return controller_.proportional_deadband_multiplier; }
75
76 template<typename F> void add_on_pid_computed_callback(F &&callback) {
77 this->pid_computed_callback_.add(std::forward<F>(callback));
78 }
79 void set_default_target_temperature(float default_target_temperature) {
80 default_target_temperature_ = default_target_temperature;
81 }
82 void start_autotune(std::unique_ptr<PIDAutotuner> &&autotune);
84 void start_autotune(float noiseband, float positive_output, float negative_output);
85 void reset_integral_term();
86
87 protected:
89 void control(const climate::ClimateCall &call) override;
92
93 void update_pid_();
94
95 bool supports_cool_() const { return this->cool_output_ != nullptr; }
96 bool supports_heat_() const { return this->heat_output_ != nullptr; }
97
98 void write_output_(float value);
99
107 std::unique_ptr<PIDAutotuner> autotuner_;
108 bool do_publish_ = false;
109};
110
111} // namespace esphome::pid
void init(index_type capacity)
Allocate capacity - can only be called once.
Definition helpers.h:537
This class is used to encode all control actions on a climate device.
Definition climate.h:31
ClimateDevice - This is the base class for all climate integrations.
Definition climate.h:192
Base class for all output components that can output a variable level, like PWM.
PIDController controller_
output::FloatOutput * cool_output_
bool supports_cool_() const
Definition pid_climate.h:95
void write_output_(float value)
std::unique_ptr< PIDAutotuner > autotuner_
void control(const climate::ClimateCall &call) override
Override control to change settings of the climate device.
CallbackManager< void()> pid_computed_callback_
float output_value_
Output value as reported by the PID controller, for PIDClimateSensor.
climate::ClimateTraits traits() override
Return the traits of this controller.
bool supports_heat_() const
Definition pid_climate.h:96
output::FloatOutput * heat_output_
uint32_t value
Definition hal.cpp:41
uint16_t size
Definition helpers.cpp:34
void set_starting_integral_term(float in)
uint16_t temperature
Definition sun_gtil2.cpp:12