homeassistant.components.water_heater Namespace Reference

Namespaces
	const
	device_action
	reproduce_state
	significant_change

Classes
class	WaterHeaterEntity
class	WaterHeaterEntityEntityDescription
class	WaterHeaterEntityFeature

Functions
None	async_service_away_mode (WaterHeaterEntity entity, ServiceCall service)
None	async_service_temperature_set (WaterHeaterEntity entity, ServiceCall service)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
	__all__ = all_with_deprecated_constants(globals())
	__dir__
	__getattr__ = ft.partial(check_if_deprecated_constant, module_globals=globals())
	_DEPRECATED_SUPPORT_AWAY_MODE
	_DEPRECATED_SUPPORT_OPERATION_MODE
	_DEPRECATED_SUPPORT_TARGET_TEMPERATURE
	_LOGGER = logging.getLogger(__name__)
string	ATTR_AWAY_MODE = "away_mode"
string	ATTR_CURRENT_TEMPERATURE = "current_temperature"
string	ATTR_MAX_TEMP = "max_temp"
string	ATTR_MIN_TEMP = "min_temp"
string	ATTR_OPERATION_LIST = "operation_list"
string	ATTR_OPERATION_MODE = "operation_mode"
string	ATTR_TARGET_TEMP_HIGH = "target_temp_high"
string	ATTR_TARGET_TEMP_LOW = "target_temp_low"
dictionary	CACHED_PROPERTIES_WITH_ATTR_
list	CONVERTIBLE_ATTRIBUTE = [ATTR_TEMPERATURE]
int	DEFAULT_MAX_TEMP = 140
int	DEFAULT_MIN_TEMP = 110
string	ENTITY_ID_FORMAT = DOMAIN + ".{}"
	PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
	SCAN_INTERVAL = timedelta(seconds=60)
string	SERVICE_SET_AWAY_MODE = "set_away_mode"
string	SERVICE_SET_OPERATION_MODE = "set_operation_mode"
string	SERVICE_SET_TEMPERATURE = "set_temperature"
string	STATE_ECO = "eco"
string	STATE_ELECTRIC = "electric"
string	STATE_GAS = "gas"
string	STATE_HEAT_PUMP = "heat_pump"
string	STATE_HIGH_DEMAND = "high_demand"
string	STATE_PERFORMANCE = "performance"
	VolDictType

Detailed Description

Support for water heater devices.

Function Documentation

async_service_away_mode()

None homeassistant.components.water_heater.async_service_away_mode	(	WaterHeaterEntity	entity,
		ServiceCall	service
	)

Handle away mode service.

Definition at line 414 of file __init__.py.

async_service_temperature_set()

None homeassistant.components.water_heater.async_service_temperature_set	(	WaterHeaterEntity	entity,
		ServiceCall	service
	)

Handle set temperature service.

Definition at line 424 of file __init__.py.

async_setup()

bool homeassistant.components.water_heater.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up water_heater devices.

Definition at line 112 of file __init__.py.

async_setup_entry()

bool homeassistant.components.water_heater.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 140 of file __init__.py.

async_unload_entry()

bool homeassistant.components.water_heater.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 145 of file __init__.py.

Variable Documentation

__all__

homeassistant.components.water_heater.__all__ = all_with_deprecated_constants(globals())

private

Definition at line 447 of file __init__.py.

__dir__

homeassistant.components.water_heater.__dir__

private

Initial value:

=  ft.partial(
    dir_with_deprecated_constants, module_globals_keys=[*globals().keys()]
)

Definition at line 444 of file __init__.py.

__getattr__

homeassistant.components.water_heater.__getattr__ = ft.partial(check_if_deprecated_constant, module_globals=globals())

private

Definition at line 443 of file __init__.py.

_DEPRECATED_SUPPORT_AWAY_MODE

homeassistant.components.water_heater._DEPRECATED_SUPPORT_AWAY_MODE

private

Initial value:

=  DeprecatedConstantEnum(
    WaterHeaterEntityFeature.AWAY_MODE, "2025.1"
)

Definition at line 81 of file __init__.py.

_DEPRECATED_SUPPORT_OPERATION_MODE

homeassistant.components.water_heater._DEPRECATED_SUPPORT_OPERATION_MODE

private

Initial value:

=  DeprecatedConstantEnum(
    WaterHeaterEntityFeature.OPERATION_MODE, "2025.1"
)

Definition at line 78 of file __init__.py.

_DEPRECATED_SUPPORT_TARGET_TEMPERATURE

homeassistant.components.water_heater._DEPRECATED_SUPPORT_TARGET_TEMPERATURE

private

Initial value:

=  DeprecatedConstantEnum(
    WaterHeaterEntityFeature.TARGET_TEMPERATURE, "2025.1"
)

Definition at line 75 of file __init__.py.

_LOGGER

homeassistant.components.water_heater._LOGGER = logging.getLogger(__name__)

private

Definition at line 96 of file __init__.py.

ATTR_AWAY_MODE

string homeassistant.components.water_heater.ATTR_AWAY_MODE = "away_mode"

Definition at line 87 of file __init__.py.

ATTR_CURRENT_TEMPERATURE

string homeassistant.components.water_heater.ATTR_CURRENT_TEMPERATURE = "current_temperature"

Definition at line 92 of file __init__.py.

ATTR_MAX_TEMP

string homeassistant.components.water_heater.ATTR_MAX_TEMP = "max_temp"

Definition at line 85 of file __init__.py.

ATTR_MIN_TEMP

string homeassistant.components.water_heater.ATTR_MIN_TEMP = "min_temp"

Definition at line 86 of file __init__.py.

ATTR_OPERATION_LIST

string homeassistant.components.water_heater.ATTR_OPERATION_LIST = "operation_list"

Definition at line 89 of file __init__.py.

ATTR_OPERATION_MODE

string homeassistant.components.water_heater.ATTR_OPERATION_MODE = "operation_mode"

Definition at line 88 of file __init__.py.

ATTR_TARGET_TEMP_HIGH

string homeassistant.components.water_heater.ATTR_TARGET_TEMP_HIGH = "target_temp_high"

Definition at line 90 of file __init__.py.

ATTR_TARGET_TEMP_LOW

string homeassistant.components.water_heater.ATTR_TARGET_TEMP_LOW = "target_temp_low"

Definition at line 91 of file __init__.py.

CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.water_heater.CACHED_PROPERTIES_WITH_ATTR_

Initial value:

=  {
    "temperature_unit",
    "current_operation",
    "operation_list",
    "current_temperature",
    "target_temperature",
    "target_temperature_high",
    "target_temperature_low",
    "is_away_mode_on",
}

Definition at line 154 of file __init__.py.

CONVERTIBLE_ATTRIBUTE

list homeassistant.components.water_heater.CONVERTIBLE_ATTRIBUTE = [ATTR_TEMPERATURE]

Definition at line 94 of file __init__.py.

DEFAULT_MAX_TEMP

int homeassistant.components.water_heater.DEFAULT_MAX_TEMP = 140

Definition at line 50 of file __init__.py.

DEFAULT_MIN_TEMP

int homeassistant.components.water_heater.DEFAULT_MIN_TEMP = 110

Definition at line 49 of file __init__.py.

ENTITY_ID_FORMAT

string homeassistant.components.water_heater.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 44 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.water_heater.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 45 of file __init__.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.water_heater.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 46 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.water_heater.SCAN_INTERVAL = timedelta(seconds=60)

Definition at line 47 of file __init__.py.

SERVICE_SET_AWAY_MODE

string homeassistant.components.water_heater.SERVICE_SET_AWAY_MODE = "set_away_mode"

Definition at line 52 of file __init__.py.

SERVICE_SET_OPERATION_MODE

string homeassistant.components.water_heater.SERVICE_SET_OPERATION_MODE = "set_operation_mode"

Definition at line 54 of file __init__.py.

SERVICE_SET_TEMPERATURE

string homeassistant.components.water_heater.SERVICE_SET_TEMPERATURE = "set_temperature"

Definition at line 53 of file __init__.py.

STATE_ECO

string homeassistant.components.water_heater.STATE_ECO = "eco"

Definition at line 56 of file __init__.py.

STATE_ELECTRIC

string homeassistant.components.water_heater.STATE_ELECTRIC = "electric"

Definition at line 57 of file __init__.py.

STATE_GAS

string homeassistant.components.water_heater.STATE_GAS = "gas"

Definition at line 61 of file __init__.py.

STATE_HEAT_PUMP

string homeassistant.components.water_heater.STATE_HEAT_PUMP = "heat_pump"

Definition at line 60 of file __init__.py.

STATE_HIGH_DEMAND

string homeassistant.components.water_heater.STATE_HIGH_DEMAND = "high_demand"

Definition at line 59 of file __init__.py.

STATE_PERFORMANCE

string homeassistant.components.water_heater.STATE_PERFORMANCE = "performance"

Definition at line 58 of file __init__.py.

VolDictType

homeassistant.components.water_heater.VolDictType

Definition at line 98 of file __init__.py.