esphome::water_heater::WaterHeaterCall Class Reference

#include <water_heater.h>

Inheritance diagram for esphome::water_heater::WaterHeaterCall:

Public Member Functions
	WaterHeaterCall ()
	WaterHeaterCall (WaterHeater *parent)
WaterHeaterCall &	set_mode (WaterHeaterMode mode)
WaterHeaterCall &	set_mode (const char *mode)
WaterHeaterCall &	set_mode (const std::string &mode)
WaterHeaterCall &	set_target_temperature (float temperature)
WaterHeaterCall &	set_target_temperature_low (float temperature)
WaterHeaterCall &	set_target_temperature_high (float temperature)
WaterHeaterCall &	set_away (bool away)
WaterHeaterCall &	set_on (bool on)
void	perform ()
const optional< WaterHeaterMode > &	get_mode () const
float	get_target_temperature () const
float	get_target_temperature_low () const
float	get_target_temperature_high () const
	ESPDEPRECATED ("get_state() is deprecated, use get_away() and get_on() instead. (Removed in 2026.8.0)", "2026.2.0") uint32_t get_state() const
	Get state flags value.
optional< bool >	get_away () const
optional< bool >	get_on () const

Protected Member Functions
void	validate_ ()

Protected Attributes
WaterHeater *	parent_
optional< WaterHeaterMode >	mode_
float	target_temperature_ {NAN}
float	target_temperature_low_ {NAN}
float	target_temperature_high_ {NAN}
uint32_t	state_ {0}
uint32_t	state_mask_ {0}

Detailed Description

Definition at line 69 of file water_heater.h.

Constructor & Destructor Documentation

WaterHeaterCall() [1/2]

esphome::water_heater::WaterHeaterCall::WaterHeaterCall ( )

inline

Definition at line 73 of file water_heater.h.

WaterHeaterCall() [2/2]

esphome::water_heater::WaterHeaterCall::WaterHeaterCall

(

WaterHeater *

parent

)

Definition at line 19 of file water_heater.cpp.

Member Function Documentation

ESPDEPRECATED()

esphome::water_heater::WaterHeaterCall::ESPDEPRECATED ( "get_state() is deprecated, use get_away() and get_on() instead.(Removed in 2026.8.0)" , "2026.2.0"  ) const

inline

Get state flags value.

Definition at line 93 of file water_heater.h.

get_away()

optional< bool > esphome::water_heater::WaterHeaterCall::get_away ( ) const

inline

Definition at line 96 of file water_heater.h.

get_mode()

const optional< WaterHeaterMode > & esphome::water_heater::WaterHeaterCall::get_mode ( ) const

inline

Definition at line 88 of file water_heater.h.

get_on()

optional< bool > esphome::water_heater::WaterHeaterCall::get_on ( ) const

inline

Definition at line 103 of file water_heater.h.

get_target_temperature()

float esphome::water_heater::WaterHeaterCall::get_target_temperature ( ) const

inline

Definition at line 89 of file water_heater.h.

get_target_temperature_high()

float esphome::water_heater::WaterHeaterCall::get_target_temperature_high ( ) const

inline

Definition at line 91 of file water_heater.h.

get_target_temperature_low()

float esphome::water_heater::WaterHeaterCall::get_target_temperature_low ( ) const

inline

Definition at line 90 of file water_heater.h.

perform()

void esphome::water_heater::WaterHeaterCall::perform

(

)

Definition at line 82 of file water_heater.cpp.

set_away()

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_away

(

bool

away

)

Definition at line 62 of file water_heater.cpp.

set_mode() [1/3]

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_mode

(

const char *

mode

)

Definition at line 26 of file water_heater.cpp.

set_mode() [2/3]

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_mode ( const std::string & mode )

inline

Definition at line 79 of file water_heater.h.

set_mode() [3/3]

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_mode

(

WaterHeaterMode

mode

)

Definition at line 21 of file water_heater.cpp.

set_on()

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_on

(

bool

on

)

Definition at line 72 of file water_heater.cpp.

set_target_temperature()

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_target_temperature

(

float

temperature

)

Definition at line 47 of file water_heater.cpp.

set_target_temperature_high()

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_target_temperature_high

(

float

temperature

)

Definition at line 57 of file water_heater.cpp.

set_target_temperature_low()

WaterHeaterCall & esphome::water_heater::WaterHeaterCall::set_target_temperature_low

(

float

temperature

)

Definition at line 52 of file water_heater.cpp.

validate_()

void esphome::water_heater::WaterHeaterCall::validate_ ( )

protected

Definition at line 106 of file water_heater.cpp.

Field Documentation

mode_

optional<WaterHeaterMode> esphome::water_heater::WaterHeaterCall::mode_

protected

Definition at line 113 of file water_heater.h.

parent_

WaterHeater* esphome::water_heater::WaterHeaterCall::parent_

protected

Definition at line 112 of file water_heater.h.

state_

uint32_t esphome::water_heater::WaterHeaterCall::state_ {0}

protected

Definition at line 117 of file water_heater.h.

state_mask_

uint32_t esphome::water_heater::WaterHeaterCall::state_mask_ {0}

protected

Definition at line 118 of file water_heater.h.

target_temperature_

float esphome::water_heater::WaterHeaterCall::target_temperature_ {NAN}

protected

Definition at line 114 of file water_heater.h.

target_temperature_high_

float esphome::water_heater::WaterHeaterCall::target_temperature_high_ {NAN}

protected

Definition at line 116 of file water_heater.h.

target_temperature_low_

float esphome::water_heater::WaterHeaterCall::target_temperature_low_ {NAN}

protected

Definition at line 115 of file water_heater.h.

---

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

• esphome/components/water_heater/water_heater.h
• esphome/components/water_heater/water_heater.cpp