Inheritance diagram for homeassistant.components.melcloud.water_heater.AtwWaterHeater:

Collaboration diagram for homeassistant.components.melcloud.water_heater.AtwWaterHeater:

Public Member Functions
None	__init__ (self, MelCloudDevice api, AtwDevice device)

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)

None	async_update (self)

str\|None	current_operation (self)

float\|None	current_temperature (self)

dict[str, Any]\|None	extra_state_attributes (self)

float	max_temp (self)

float	min_temp (self)

list[str]	operation_list (self)

float\|None	target_temperature (self)

str	temperature_unit (self)

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)

bool\|None	is_away_mode_on (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_high (self)

float\|None	target_temperature_low (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)

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)

Private Attributes
	_api

	_attr_device_info

	_attr_unique_id

	_device

Static Private Attributes
bool	_attr_has_entity_name = True

	_attr_name = None

tuple	_attr_supported_features

Additional Inherited Members
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

Air-to-Water water heater.

Definition at line 43 of file water_heater.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.melcloud.water_heater.AtwWaterHeater.__init__	(		self,
		MelCloudDevice	api,
		AtwDevice	device
	)

Initialize water heater device.

Definition at line 54 of file water_heater.py.

Member Function Documentation

◆ async_set_operation_mode()

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

Set new target operation mode.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 113 of file water_heater.py.

◆ async_set_temperature()

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

Set new target temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 103 of file water_heater.py.

◆ async_turn_off()

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

Turn the entity off.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 69 of file water_heater.py.

◆ async_turn_on()

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

Turn the entity on.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 65 of file water_heater.py.

◆ async_update()

None homeassistant.components.melcloud.water_heater.AtwWaterHeater.async_update ( self )

Update state from MELCloud.

Definition at line 61 of file water_heater.py.

◆ current_operation()

str | None homeassistant.components.melcloud.water_heater.AtwWaterHeater.current_operation ( self )

Return current operation as reported by pymelcloud.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 84 of file water_heater.py.

◆ current_temperature()

float | None homeassistant.components.melcloud.water_heater.AtwWaterHeater.current_temperature ( self )

Return the current temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 94 of file water_heater.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.melcloud.water_heater.AtwWaterHeater.extra_state_attributes ( self )

Return the optional state attributes with device specific additions.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 74 of file water_heater.py.

◆ max_temp()

float homeassistant.components.melcloud.water_heater.AtwWaterHeater.max_temp ( self )

Return the maximum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 123 of file water_heater.py.

◆ min_temp()

float homeassistant.components.melcloud.water_heater.AtwWaterHeater.min_temp ( self )

Return the minimum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 118 of file water_heater.py.

◆ operation_list()

list[str] homeassistant.components.melcloud.water_heater.AtwWaterHeater.operation_list ( self )

Return the list of available operation modes as reported by pymelcloud.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 89 of file water_heater.py.

◆ target_temperature()

float | None homeassistant.components.melcloud.water_heater.AtwWaterHeater.target_temperature ( self )

Return the temperature we try to reach.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 99 of file water_heater.py.

◆ temperature_unit()

str homeassistant.components.melcloud.water_heater.AtwWaterHeater.temperature_unit ( self )

Return the unit of measurement used by the platform.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 79 of file water_heater.py.

Member Data Documentation

◆ _api

homeassistant.components.melcloud.water_heater.AtwWaterHeater._api

private

Definition at line 56 of file water_heater.py.

◆ _attr_device_info

homeassistant.components.melcloud.water_heater.AtwWaterHeater._attr_device_info

private

Definition at line 59 of file water_heater.py.

◆ _attr_has_entity_name

bool homeassistant.components.melcloud.water_heater.AtwWaterHeater._attr_has_entity_name = True

staticprivate

Definition at line 51 of file water_heater.py.

◆ _attr_name

homeassistant.components.melcloud.water_heater.AtwWaterHeater._attr_name = None

staticprivate

Definition at line 52 of file water_heater.py.

◆ _attr_supported_features

tuple homeassistant.components.melcloud.water_heater.AtwWaterHeater._attr_supported_features

staticprivate

Initial value:

=  (
        WaterHeaterEntityFeature.TARGET_TEMPERATURE
        | WaterHeaterEntityFeature.ON_OFF
        | WaterHeaterEntityFeature.OPERATION_MODE
    )

Definition at line 46 of file water_heater.py.

◆ _attr_unique_id

homeassistant.components.melcloud.water_heater.AtwWaterHeater._attr_unique_id

private

Definition at line 58 of file water_heater.py.

◆ _device

homeassistant.components.melcloud.water_heater.AtwWaterHeater._device

private

Definition at line 57 of file water_heater.py.

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

core/homeassistant/components/melcloud/water_heater.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ async_set_operation_mode()

◆ async_set_temperature()

◆ async_turn_off()

◆ async_turn_on()

◆ async_update()

◆ current_operation()

◆ current_temperature()

◆ extra_state_attributes()

◆ max_temp()

◆ min_temp()

◆ operation_list()

◆ target_temperature()

◆ temperature_unit()

Member Data Documentation

◆ _api

◆ _attr_device_info

◆ _attr_has_entity_name

◆ _attr_name

◆ _attr_supported_features

◆ _attr_unique_id

◆ _device

◆ init()