homeassistant.components.water_heater.WaterHeaterEntity Class Reference

Inheritance diagram for homeassistant.components.water_heater.WaterHeaterEntity:

Collaboration diagram for homeassistant.components.water_heater.WaterHeaterEntity:

Public Member Functions
None	async_handle_set_operation_mode (self, str operation_mode)
None	async_set_operation_mode (self, str operation_mode)
None	async_set_temperature (self, **Any kwargs)
None	async_turn_away_mode_off (self)
None	async_turn_away_mode_on (self)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
dict[str, Any]	capability_attributes (self)
str|None	current_operation (self)
float|None	current_temperature (self)
bool|None	is_away_mode_on (self)
float	max_temp (self)
float	min_temp (self)
list[str]|None	operation_list (self)
float	precision (self)
None	set_operation_mode (self, str operation_mode)
None	set_temperature (self, **Any kwargs)
str|None	state (self)
dict[str, Any]	state_attributes (self)
WaterHeaterEntityFeature	supported_features (self)
WaterHeaterEntityFeature	supported_features_compat (self)
float|None	target_temperature (self)
float|None	target_temperature_high (self)
float|None	target_temperature_low (self)
str	temperature_unit (self)
None	turn_away_mode_off (self)
None	turn_away_mode_on (self)
None	turn_off (self, **Any kwargs)
None	turn_on (self, **Any kwargs)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Static Public Attributes
	None
	WaterHeaterEntityFeature
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Static Private Attributes
	_entity_component_unrecorded_attributes

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Base class for water heater entities.

Definition at line 166 of file __init__.py.

Member Function Documentation

async_handle_set_operation_mode()

None homeassistant.components.water_heater.WaterHeaterEntity.async_handle_set_operation_mode	(		self,
		str	operation_mode
	)

Handle a set target operation mode service call.

Definition at line 337 of file __init__.py.

async_set_operation_mode()

None homeassistant.components.water_heater.WaterHeaterEntity.async_set_operation_mode	(		self,
		str	operation_mode
	)

Set new target operation mode.

Reimplemented in homeassistant.components.overkiz.water_heater.hitachi_dhw.HitachiDHW, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.nibe_heatpump.water_heater.WaterHeater, homeassistant.components.mqtt.water_heater.MqttWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.hive.water_heater.HiveWaterHeater, homeassistant.components.geniushub.water_heater.GeniusWaterHeater, homeassistant.components.evohome.water_heater.EvoDHW, homeassistant.components.bsblan.water_heater.BSBLANWaterHeater, homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity, homeassistant.components.airzone_cloud.water_heater.AirzoneWaterHeater, and homeassistant.components.airzone.water_heater.AirzoneWaterHeater.

Definition at line 332 of file __init__.py.

async_set_temperature()

None homeassistant.components.water_heater.WaterHeaterEntity.async_set_temperature	(		self,
		**Any	kwargs
	)

Set new target temperature.

Reimplemented in homeassistant.components.overkiz.water_heater.hitachi_dhw.HitachiDHW, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.mqtt.water_heater.MqttWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.bsblan.water_heater.BSBLANWaterHeater, homeassistant.components.atag.water_heater.AtagWaterHeater, homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity, homeassistant.components.airzone_cloud.water_heater.AirzoneWaterHeater, and homeassistant.components.airzone.water_heater.AirzoneWaterHeater.

Definition at line 306 of file __init__.py.

async_turn_away_mode_off()

None homeassistant.components.water_heater.WaterHeaterEntity.async_turn_away_mode_off

(

self

)

Turn away mode off.

Reimplemented in homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.evohome.water_heater.EvoDHW, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 373 of file __init__.py.

async_turn_away_mode_on()

None homeassistant.components.water_heater.WaterHeaterEntity.async_turn_away_mode_on

(

self

)

Turn away mode on.

Reimplemented in homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.evohome.water_heater.EvoDHW, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 365 of file __init__.py.

async_turn_off()

None homeassistant.components.water_heater.WaterHeaterEntity.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the water heater off.

Reimplemented in homeassistant.components.mqtt.water_heater.MqttWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.hive.water_heater.HiveWaterHeater, homeassistant.components.evohome.water_heater.EvoDHW, homeassistant.components.airzone_cloud.water_heater.AirzoneWaterHeater, and homeassistant.components.airzone.water_heater.AirzoneWaterHeater.

Definition at line 324 of file __init__.py.

async_turn_on()

None homeassistant.components.water_heater.WaterHeaterEntity.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the water heater on.

Reimplemented in homeassistant.components.mqtt.water_heater.MqttWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.hive.water_heater.HiveWaterHeater, homeassistant.components.evohome.water_heater.EvoDHW, homeassistant.components.airzone_cloud.water_heater.AirzoneWaterHeater, and homeassistant.components.airzone.water_heater.AirzoneWaterHeater.

Definition at line 316 of file __init__.py.

capability_attributes()

dict[str, Any] homeassistant.components.water_heater.WaterHeaterEntity.capability_attributes

(

self

)

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 204 of file __init__.py.

current_operation()

str | None homeassistant.components.water_heater.WaterHeaterEntity.current_operation

(

self

)

Return current operation ie. eco, electric, performance, ...

Reimplemented in homeassistant.components.vicare.water_heater.ViCareWater, homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.overkiz.water_heater.hitachi_dhw.HitachiDHW, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.incomfort.water_heater.IncomfortWaterHeater, homeassistant.components.geniushub.water_heater.GeniusWaterHeater, homeassistant.components.evohome.water_heater.EvoDHW, homeassistant.components.econet.water_heater.EcoNetWaterHeater, homeassistant.components.bsblan.water_heater.BSBLANWaterHeater, homeassistant.components.atag.water_heater.AtagWaterHeater, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 268 of file __init__.py.

current_temperature()

float | None homeassistant.components.water_heater.WaterHeaterEntity.current_temperature

(

self

)

Return the current temperature.

Reimplemented in homeassistant.components.overkiz.water_heater.hitachi_dhw.HitachiDHW, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.incomfort.water_heater.IncomfortWaterHeater, homeassistant.components.bsblan.water_heater.BSBLANWaterHeater, and homeassistant.components.atag.water_heater.AtagWaterHeater.

Definition at line 278 of file __init__.py.

is_away_mode_on()

bool | None homeassistant.components.water_heater.WaterHeaterEntity.is_away_mode_on

(

self

)

Return true if away mode is on.

Reimplemented in homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.evohome.water_heater.EvoDHW, homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 298 of file __init__.py.

max_temp()

float homeassistant.components.water_heater.WaterHeaterEntity.max_temp

(

self

)

Return the maximum temperature.

Reimplemented in homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.econet.water_heater.EcoNetWaterHeater, homeassistant.components.atag.water_heater.AtagWaterHeater, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 387 of file __init__.py.

min_temp()

float homeassistant.components.water_heater.WaterHeaterEntity.min_temp

(

self

)

Return the minimum temperature.

Reimplemented in homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.atag.water_heater.AtagWaterHeater.

Definition at line 378 of file __init__.py.

operation_list()

list[str] | None homeassistant.components.water_heater.WaterHeaterEntity.operation_list

(

self

)

Return the list of available operation modes.

Reimplemented in homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.geniushub.water_heater.GeniusWaterHeater, homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 273 of file __init__.py.

precision()

float homeassistant.components.water_heater.WaterHeaterEntity.precision

(

self

)

Return the precision of the system.

Definition at line 195 of file __init__.py.

set_operation_mode()

None homeassistant.components.water_heater.WaterHeaterEntity.set_operation_mode	(		self,
		str	operation_mode
	)

Set new target operation mode.

Reimplemented in homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.demo.water_heater.DemoWaterHeater.

Definition at line 328 of file __init__.py.

set_temperature()

None homeassistant.components.water_heater.WaterHeaterEntity.set_temperature	(		self,
		**Any	kwargs
	)

Set new target temperature.

Reimplemented in homeassistant.components.vicare.water_heater.ViCareWater, homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.demo.water_heater.DemoWaterHeater.

Definition at line 302 of file __init__.py.

state()

str | None homeassistant.components.water_heater.WaterHeaterEntity.state

(

self

)

Return the current state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 190 of file __init__.py.

state_attributes()

dict[str, Any] homeassistant.components.water_heater.WaterHeaterEntity.state_attributes

(

self

)

Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 222 of file __init__.py.

supported_features()

WaterHeaterEntityFeature homeassistant.components.water_heater.WaterHeaterEntity.supported_features

(

self

)

Return the list of supported features.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 396 of file __init__.py.

supported_features_compat()

WaterHeaterEntityFeature homeassistant.components.water_heater.WaterHeaterEntity.supported_features_compat

(

self

)

Return the supported features as WaterHeaterEntityFeature.

Remove this compatibility shim in 2025.1 or later.

Definition at line 401 of file __init__.py.

target_temperature()

float | None homeassistant.components.water_heater.WaterHeaterEntity.target_temperature

(

self

)

Return the temperature we try to reach.

Reimplemented in homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.overkiz.water_heater.hitachi_dhw.HitachiDHW, homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.water_heater.atlantic_pass_apc_dhw.AtlanticPassAPCDHW, homeassistant.components.overkiz.water_heater.atlantic_domestic_hot_water_production_mlb_component.AtlanticDomesticHotWaterProductionMBLComponent, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.econet.water_heater.EcoNetWaterHeater, homeassistant.components.bsblan.water_heater.BSBLANWaterHeater, homeassistant.components.atag.water_heater.AtagWaterHeater, and homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.

Definition at line 283 of file __init__.py.

target_temperature_high()

float | None homeassistant.components.water_heater.WaterHeaterEntity.target_temperature_high

(

self

)

Return the highbound target temperature we try to reach.

Reimplemented in homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, and homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.

Definition at line 288 of file __init__.py.

target_temperature_low()

float | None homeassistant.components.water_heater.WaterHeaterEntity.target_temperature_low

(

self

)

Return the lowbound target temperature we try to reach.

Reimplemented in homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, and homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.

Definition at line 293 of file __init__.py.

temperature_unit()

str homeassistant.components.water_heater.WaterHeaterEntity.temperature_unit

(

self

)

Return the unit of measurement used by the platform.

Reimplemented in homeassistant.components.melcloud.water_heater.AtwWaterHeater.

Definition at line 263 of file __init__.py.

turn_away_mode_off()

None homeassistant.components.water_heater.WaterHeaterEntity.turn_away_mode_off

(

self

)

Turn away mode off.

Reimplemented in homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.demo.water_heater.DemoWaterHeater.

Definition at line 369 of file __init__.py.

turn_away_mode_on()

None homeassistant.components.water_heater.WaterHeaterEntity.turn_away_mode_on

(

self

)

Turn away mode on.

Reimplemented in homeassistant.components.econet.water_heater.EcoNetWaterHeater, and homeassistant.components.demo.water_heater.DemoWaterHeater.

Definition at line 361 of file __init__.py.

turn_off()

None homeassistant.components.water_heater.WaterHeaterEntity.turn_off	(		self,
		**Any	kwargs
	)

Turn the water heater off.

Reimplemented in homeassistant.components.demo.water_heater.DemoWaterHeater.

Definition at line 320 of file __init__.py.

turn_on()

None homeassistant.components.water_heater.WaterHeaterEntity.turn_on	(		self,
		**Any	kwargs
	)

Turn the water heater on.

Reimplemented in homeassistant.components.demo.water_heater.DemoWaterHeater.

Definition at line 312 of file __init__.py.

Member Data Documentation

_entity_component_unrecorded_attributes

homeassistant.components.water_heater.WaterHeaterEntity._entity_component_unrecorded_attributes

staticprivate

Initial value:

=  frozenset(
        {ATTR_OPERATION_LIST, ATTR_MIN_TEMP, ATTR_MAX_TEMP}
    )

Definition at line 169 of file __init__.py.

None

homeassistant.components.water_heater.WaterHeaterEntity.None

static

Definition at line 174 of file __init__.py.

WaterHeaterEntityFeature

homeassistant.components.water_heater.WaterHeaterEntity.WaterHeaterEntityFeature

static

Definition at line 182 of file __init__.py.

---

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

• core/homeassistant/components/water_heater/__init__.py