homeassistant.components.aosmith.entity.AOSmithStatusEntity Class Reference

Inheritance diagram for homeassistant.components.aosmith.entity.AOSmithStatusEntity:

Collaboration diagram for homeassistant.components.aosmith.entity.AOSmithStatusEntity:

Public Member Functions
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)

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

Detailed Description

Base entity for entities that use data from the status coordinator.

Definition at line 34 of file entity.py.

Member Function Documentation

available()

bool homeassistant.components.aosmith.entity.AOSmithStatusEntity.available

(

self

)

Return True if entity is available.

Definition at line 43 of file entity.py.

device()

AOSmithDevice homeassistant.components.aosmith.entity.AOSmithStatusEntity.device

(

self

)

Shortcut to get the device from the coordinator data.

Definition at line 38 of file entity.py.

---

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

• core/homeassistant/components/aosmith/entity.py