Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.airzone.water_heater.AirzoneWaterHeater Class Reference
Inheritance diagram for homeassistant.components.airzone.water_heater.AirzoneWaterHeater:
[legend]
Collaboration diagram for homeassistant.components.airzone.water_heater.AirzoneWaterHeater:
[legend]

Public Member Functions

None __init__ (self, AirzoneUpdateCoordinator coordinator, ConfigEntry entry)
 
None async_set_operation_mode (self, str operation_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.airzone.entity.AirzoneHotWaterEntity
Any get_airzone_value (self, str key)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.airzone.coordinator.AirzoneUpdateCoordinator
None __init__ (self, HomeAssistant hass, AirzoneLocalApi airzone)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.water_heater.WaterHeaterEntity
None async_handle_set_operation_mode (self, str operation_mode)
 
None async_turn_away_mode_off (self)
 
None async_turn_away_mode_on (self)
 
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, strtranslation_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)
 

Private Member Functions

None _async_update_attrs (self)
 
None _handle_coordinator_update (self)
 

Private Attributes

 _attr_current_operation
 
 _attr_current_temperature
 
 _attr_max_temp
 
 _attr_min_temp
 
 _attr_operation_list
 
 _attr_target_temperature
 
 _attr_temperature_unit
 
 _attr_unique_id
 

Static Private Attributes

 _attr_name = None
 
tuple _attr_supported_features
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.airzone.coordinator.AirzoneUpdateCoordinator
 airzone
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.water_heater.WaterHeaterEntity
 None
 
 WaterHeaterEntityFeature
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Define an Airzone Water Heater.

Definition at line 70 of file water_heater.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater.__init__ (   self,
AirzoneUpdateCoordinator  coordinator,
ConfigEntry  entry 
)
Initialize Airzone water heater entity.

Reimplemented from homeassistant.components.airzone.entity.AirzoneHotWaterEntity.

Definition at line 80 of file water_heater.py.

Member Function Documentation

◆ _async_update_attrs()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater._async_update_attrs (   self)
private
Update water heater attributes.

Definition at line 126 of file water_heater.py.

◆ _handle_coordinator_update()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater._handle_coordinator_update (   self)
private
Update attributes when the coordinator updates.

Definition at line 120 of file water_heater.py.

◆ async_set_operation_mode()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater.async_set_operation_mode (   self,
str  operation_mode 
)
Set new target operation mode.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 107 of file water_heater.py.

◆ async_set_temperature()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 112 of file water_heater.py.

◆ async_turn_off()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater.async_turn_off (   self,
**Any  kwargs 
)
Turn the water heater off.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 99 of file water_heater.py.

◆ async_turn_on()

None homeassistant.components.airzone.water_heater.AirzoneWaterHeater.async_turn_on (   self,
**Any  kwargs 
)
Turn the water heater off.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 103 of file water_heater.py.

Member Data Documentation

◆ _attr_current_operation

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_current_operation
private

Definition at line 129 of file water_heater.py.

◆ _attr_current_temperature

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_current_temperature
private

Definition at line 128 of file water_heater.py.

◆ _attr_max_temp

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_max_temp
private

Definition at line 132 of file water_heater.py.

◆ _attr_min_temp

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_min_temp
private

Definition at line 133 of file water_heater.py.

◆ _attr_name

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_name = None
staticprivate

Definition at line 73 of file water_heater.py.

◆ _attr_operation_list

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_operation_list
private

Definition at line 89 of file water_heater.py.

◆ _attr_supported_features

tuple homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_supported_features
staticprivate
Initial value:
= (
WaterHeaterEntityFeature.TARGET_TEMPERATURE
| WaterHeaterEntityFeature.ON_OFF
| WaterHeaterEntityFeature.OPERATION_MODE
)

Definition at line 74 of file water_heater.py.

◆ _attr_target_temperature

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_target_temperature
private

Definition at line 134 of file water_heater.py.

◆ _attr_temperature_unit

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_temperature_unit
private

Definition at line 93 of file water_heater.py.

◆ _attr_unique_id

homeassistant.components.airzone.water_heater.AirzoneWaterHeater._attr_unique_id
private

Definition at line 88 of file water_heater.py.


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