Inheritance diagram for homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity:

Collaboration diagram for homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity:

Public Member Functions
None	__init__ (self, AOSmithStatusCoordinator coordinator, str junction_id)

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)

str	current_operation (self)

def	is_away_mode_on (self)

float	max_temp (self)

list[str]	operation_list (self)

WaterHeaterEntityFeature	supported_features (self)

float\|None	target_temperature (self)

Public Member Functions inherited from homeassistant.components.aosmith.entity.AOSmithStatusEntity
bool	available (self)

AOSmithDevice	device (self)

Public Member Functions inherited from homeassistant.components.aosmith.coordinator.AOSmithStatusCoordinator
None	__init__ (self, HomeAssistant hass, AOSmithAPIClient client)

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_off (self, **Any kwargs)

None	async_turn_on (self, **Any kwargs)

dict[str, Any]	capability_attributes (self)

float\|None	current_temperature (self)

float	min_temp (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_compat (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)

Private Attributes
	_attr_unique_id

Static Private Attributes
int	_attr_min_temp = 95

	_attr_name = None

	_attr_temperature_unit = UnitOfTemperature.FAHRENHEIT

Additional Inherited Members
Public Attributes inherited from homeassistant.components.aosmith.coordinator.AOSmithStatusCoordinator
	client

	update_interval

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

The water heater entity for the A. O. Smith integration.

Definition at line 60 of file water_heater.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.__init__	(		self,
		AOSmithStatusCoordinator	coordinator,
		str	junction_id
	)

Initialize the entity.

Definition at line 67 of file water_heater.py.

Member Function Documentation

◆ async_set_operation_mode()

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

Set new target operation mode.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 128 of file water_heater.py.

◆ async_set_temperature()

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

Set new target temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 139 of file water_heater.py.

◆ async_turn_away_mode_off()

None homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.async_turn_away_mode_off ( self )

Turn away mode off.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 153 of file water_heater.py.

◆ async_turn_away_mode_on()

None homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.async_turn_away_mode_on ( self )

Turn away mode on.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 147 of file water_heater.py.

◆ current_operation()

str homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.current_operation ( self )

Return the current operation mode.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 119 of file water_heater.py.

◆ is_away_mode_on()

def homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.is_away_mode_on ( self )

Return True if away mode is on.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 124 of file water_heater.py.

◆ max_temp()

float homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.max_temp ( self )

Return the maximum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 114 of file water_heater.py.

◆ operation_list()

list[str] homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.operation_list ( self )

Return the list of supported operation modes.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 77 of file water_heater.py.

◆ supported_features()

WaterHeaterEntityFeature homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.supported_features ( self )

Return the list of supported features.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 90 of file water_heater.py.

◆ target_temperature()

float | None homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity.target_temperature ( self )

Return the temperature we try to reach.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 109 of file water_heater.py.

Member Data Documentation

◆ _attr_min_temp

int homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity._attr_min_temp = 95

staticprivate

Definition at line 65 of file water_heater.py.

◆ _attr_name

homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity._attr_name = None

staticprivate

Definition at line 63 of file water_heater.py.

◆ _attr_temperature_unit

homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity._attr_temperature_unit = UnitOfTemperature.FAHRENHEIT

staticprivate

Definition at line 64 of file water_heater.py.

◆ _attr_unique_id

homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity._attr_unique_id

private

Definition at line 74 of file water_heater.py.

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

core/homeassistant/components/aosmith/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_away_mode_off()

◆ async_turn_away_mode_on()

◆ current_operation()

◆ is_away_mode_on()

◆ max_temp()

◆ operation_list()

◆ supported_features()

◆ target_temperature()

Member Data Documentation

◆ _attr_min_temp

◆ _attr_name

◆ _attr_temperature_unit

◆ _attr_unique_id

◆ init()