ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
water_heater.h
Go to the documentation of this file.
1#pragma once
7#include "esphome/core/log.h"
9
10namespace esphome::water_heater {
11
12class WaterHeater;
13struct WaterHeaterCallInternal;
14
15#define LOG_WATER_HEATER(prefix, type, obj) log_entity_header(TAG, prefix, LOG_STR_LITERAL(type), (obj))
16
26
27// Type alias for water heater mode bitmask
28// Replaces std::set<WaterHeaterMode> to eliminate red-black tree overhead
31
47
55
67
70
71 public:
72 WaterHeaterCall() : parent_(nullptr) {}
73
75
77 WaterHeaterCall &set_mode(const char *mode);
78 WaterHeaterCall &set_mode(const char *mode, size_t len);
79 WaterHeaterCall &set_mode(const std::string &mode) { return this->set_mode(mode.c_str(), mode.size()); }
83 WaterHeaterCall &set_away(bool away);
84 WaterHeaterCall &set_on(bool on);
85
86 void perform();
87
88 const optional<WaterHeaterMode> &get_mode() const { return this->mode_; }
89 float get_target_temperature() const { return this->target_temperature_; }
92 optional<bool> get_away() const {
94 return (this->state_ & WATER_HEATER_STATE_AWAY) != 0;
95 }
96 return {};
97 }
98
99 optional<bool> get_on() const {
101 return (this->state_ & WATER_HEATER_STATE_ON) != 0;
102 }
103 return {};
104 }
105
106 protected:
107 void validate_();
109 optional<WaterHeaterMode> mode_;
116
119
121 this->mode_ = restore.mode_;
125 this->state_ = restore.state_;
126 this->state_mask_ = restore.state_mask_;
127 return *this;
128 }
129};
130
132 public:
136 bool has_feature_flags(uint32_t flags) const { return (this->feature_flags_ & flags) == flags; }
137 uint32_t get_feature_flags() const { return this->feature_flags_; }
138
149
151 void set_supports_away_mode(bool supports) {
152 if (supports) {
154 } else {
156 }
157 }
158
169
170 void set_min_temperature(float min_temperature) { this->min_temperature_ = min_temperature; }
171 float get_min_temperature() const { return this->min_temperature_; }
172
173 void set_max_temperature(float max_temperature) { this->max_temperature_ = max_temperature; }
174 float get_max_temperature() const { return this->max_temperature_; }
175
176 void set_target_temperature_step(float target_temperature_step) {
177 this->target_temperature_step_ = target_temperature_step;
178 }
180
183 bool supports_mode(WaterHeaterMode mode) const { return this->supported_modes_.count(mode); }
184
187
188 protected:
189 // Ordered to minimize padding: 4-byte members first
191 float min_temperature_{0.0f};
192 float max_temperature_{0.0f};
196};
197
198class WaterHeater : public EntityBase {
199 public:
200 WaterHeaterMode get_mode() const { return this->mode_; }
201 float get_current_temperature() const { return this->current_temperature_; }
202 float get_target_temperature() const { return this->target_temperature_; }
206 uint32_t get_state() const { return this->state_; }
208 bool is_away() const { return (this->state_ & WATER_HEATER_STATE_AWAY) != 0; }
210 bool is_on() const { return (this->state_ & WATER_HEATER_STATE_ON) != 0; }
211
212 void set_current_temperature(float current_temperature) { this->current_temperature_ = current_temperature; }
213
214 virtual void publish_state();
217
218#ifdef USE_WATER_HEATER_VISUAL_OVERRIDES
219 void set_visual_min_temperature_override(float min_temperature_override) {
220 this->visual_min_temperature_override_ = min_temperature_override;
221 }
222 void set_visual_max_temperature_override(float max_temperature_override) {
223 this->visual_max_temperature_override_ = max_temperature_override;
224 }
225 void set_visual_target_temperature_step_override(float visual_target_temperature_step_override) {
226 this->visual_target_temperature_step_override_ = visual_target_temperature_step_override;
227 }
228#endif
229 virtual void control(const WaterHeaterCall &call) = 0;
230
231 protected:
233
235 void dump_traits_(const char *tag);
236
238 optional<WaterHeaterCall> restore_state_();
239
255 void set_state_flag_(uint32_t flag, bool value) { assign_bits(this->state_, flag, value); }
256
262 uint32_t state_{0}; // Bitmask of WaterHeaterStateFlag
263
264#ifdef USE_WATER_HEATER_VISUAL_OVERRIDES
268#endif
269
271};
272
275
276inline void log_water_heater(const char *tag, const char *prefix, const char *type, WaterHeater *obj) {
277 log_entity_header(tag, prefix, type, obj);
278}
279
280} // namespace esphome::water_heater
BedjetMode mode
BedJet operating mode.
constexpr size_t count(ValueType value) const
Check if the set contains a specific value (std::set compatibility) Returns 1 if present,...
WaterHeaterCall & set_away(bool away)
WaterHeaterCall & set_target_temperature_high(float temperature)
WaterHeaterCall & set_mode(WaterHeaterMode mode)
WaterHeaterCall & set_target_temperature_low(float temperature)
WaterHeaterCall & set_on(bool on)
optional< bool > get_away() const
optional< bool > get_on() const
WaterHeaterCall & set_mode(const std::string &mode)
optional< WaterHeaterMode > mode_
const optional< WaterHeaterMode > & get_mode() const
WaterHeaterCall & set_target_temperature(float temperature)
uint32_t get_state() const
Get the current state flags bitmask.
void set_target_temperature_low_(float target_temperature_low)
Set the low target temperature (for two-point control). Should only be called from control().
void set_mode_(WaterHeaterMode mode)
Set the mode of the water heater. Should only be called from control().
void set_visual_min_temperature_override(float min_temperature_override)
virtual void control(const WaterHeaterCall &call)=0
void set_visual_target_temperature_step_override(float visual_target_temperature_step_override)
void set_state_flag_(uint32_t flag, bool value)
Set or clear a state flag. Should only be called from control().
void set_visual_max_temperature_override(float max_temperature_override)
optional< WaterHeaterCall > restore_state_()
Restore the state of the water heater, call this from your setup() method.
void set_state_(uint32_t state)
Set the state flags. Should only be called from control().
void set_target_temperature_high_(float target_temperature_high)
Set the high target temperature (for two-point control). Should only be called from control().
bool is_on() const
Check if the water heater is on.
bool is_away() const
Check if away mode is currently active.
void set_target_temperature_(float target_temperature)
Set the target temperature of the water heater. Should only be called from control().
virtual WaterHeaterCallInternal make_call()=0
WaterHeaterMode get_mode() const
void dump_traits_(const char *tag)
Log the traits of this water heater for dump_config().
virtual WaterHeaterTraits get_traits()
virtual WaterHeaterTraits traits()=0
void set_current_temperature(float current_temperature)
void set_supported_modes(WaterHeaterModeMask modes)
const WaterHeaterModeMask & get_supported_modes() const
void add_feature_flags(uint32_t flags)
Get/set feature flags (see WaterHeaterFeature enum)
bool supports_mode(WaterHeaterMode mode) const
void set_supports_current_temperature(bool supports)
TemperatureUnit get_temperature_unit() const
void set_min_temperature(float min_temperature)
void set_temperature_unit(TemperatureUnit unit)
void set_supports_two_point_target_temperature(bool supports)
bool has_feature_flags(uint32_t flags) const
void set_target_temperature_step(float target_temperature_step)
void set_max_temperature(float max_temperature)
float target_temperature_high
Definition climate.h:3
float target_temperature
Definition climate.h:0
float target_temperature_low
Definition climate.h:2
uint16_t flags
uint8_t type
bool state
Definition fan.h:2
void log_water_heater(const char *tag, const char *prefix, const char *type, WaterHeater *obj)
WaterHeaterStateFlag
State flags for water heater current state (bitmask)
@ WATER_HEATER_STATE_ON
Water heater is on (not in standby)
@ WATER_HEATER_STATE_AWAY
Away/vacation mode is currently active.
WaterHeaterFeature
Feature flags for water heater capabilities (matches Home Assistant WaterHeaterEntityFeature)
@ WATER_HEATER_SUPPORTS_TARGET_TEMPERATURE
The water heater supports a target temperature.
@ WATER_HEATER_SUPPORTS_OPERATION_MODE
The water heater supports operation mode selection.
@ WATER_HEATER_SUPPORTS_ON_OFF
The water heater can be turned on/off.
@ WATER_HEATER_SUPPORTS_AWAY_MODE
The water heater supports an away/vacation mode.
@ WATER_HEATER_SUPPORTS_CURRENT_TEMPERATURE
The water heater supports reporting the current temperature.
@ WATER_HEATER_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE
The water heater supports two-point target temperature (low/high range).
const LogString * water_heater_mode_to_string(WaterHeaterMode mode)
Convert the given WaterHeaterMode to a human-readable string for logging.
class esphome::water_heater::WaterHeaterCall __attribute__
bool log_entity_header(const char *tag, const char *prefix, const char *type, const EntityBase *obj)
Log "<prefix><type> '<name>'" for a dump_config header; returns false when obj is null.
uint32_t value
Definition hal.cpp:41
ESPHOME_ALWAYS_INLINE constexpr void assign_bits(T &value, std::type_identity_t< T > mask, bool on)
Set the bits of mask in value when on is true, clear them otherwise.
Definition helpers.h:1150
const void size_t len
Definition hal.h:68
TemperatureUnit
Definition helpers.h:1867
static void uint32_t
struct esphome::water_heater::SavedWaterHeaterState::@191::@192 __attribute__
WaterHeaterCallInternal & set_from_restore(const WaterHeaterCall &restore)
uint16_t temperature
Definition sun_gtil2.cpp:12