homeassistant.components.hassio.entity.HassioOSEntity Class Reference

Inheritance diagram for homeassistant.components.hassio.entity.HassioOSEntity:

Collaboration diagram for homeassistant.components.hassio.entity.HassioOSEntity:

Public Member Functions
None	__init__ (self, HassioDataUpdateCoordinator coordinator, EntityDescription entity_description)
bool	available (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.hassio.coordinator.HassioDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, ConfigEntry config_entry, dr.DeviceRegistry dev_reg)
CALLBACK_TYPE	async_enable_container_updates (self, str slug, str entity_id, set[str] types)
None	force_data_refresh (self, bool first_update)
None	force_info_update_supervisor (self)
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 Attributes
	entity_description
Public Attributes inherited from homeassistant.components.hassio.coordinator.HassioDataUpdateCoordinator
	data
	dev_reg
	entry_id
	is_hass_os
	supervisor_client
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

Private Attributes
	_attr_device_info
	_attr_unique_id

Static Private Attributes
bool	_attr_has_entity_name = True

Detailed Description

Base Entity for Hass.io OS.

Definition at line 68 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.hassio.entity.HassioOSEntity.__init__	(		self,
		HassioDataUpdateCoordinator	coordinator,
		EntityDescription	entity_description
	)

Initialize base entity.

Definition at line 73 of file entity.py.

Member Function Documentation

available()

bool homeassistant.components.hassio.entity.HassioOSEntity.available

(

self

)

Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 85 of file entity.py.

Member Data Documentation

_attr_device_info

homeassistant.components.hassio.entity.HassioOSEntity._attr_device_info

private

Definition at line 82 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.hassio.entity.HassioOSEntity._attr_has_entity_name = True

staticprivate

Definition at line 71 of file entity.py.

_attr_unique_id

homeassistant.components.hassio.entity.HassioOSEntity._attr_unique_id

private

Definition at line 81 of file entity.py.

entity_description

homeassistant.components.hassio.entity.HassioOSEntity.entity_description

Definition at line 80 of file entity.py.

---

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

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