homeassistant.components.harmony.entity.HarmonyEntity Class Reference

Inheritance diagram for homeassistant.components.harmony.entity.HarmonyEntity:

Collaboration diagram for homeassistant.components.harmony.entity.HarmonyEntity:

Public Member Functions
None	__init__ (self, HarmonyData data)
None	async_got_connected (self, str|None _=None)
None	async_got_disconnected (self, str|None _=None)
bool	available (self)
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)
dict[str, Any]|None	capability_attributes (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)
StateType	state (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (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 Member Functions
None	_async_clear_disconnection_delay (self)
None	_async_mark_disconnected_if_unavailable (self, datetime _)

Private Attributes
	_attr_should_poll
	_data
	_unsub_mark_disconnected

Static Private Attributes
bool	_attr_has_entity_name = True

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.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Base entity for Harmony with connection state handling.

Definition at line 20 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.harmony.entity.HarmonyEntity.__init__	(		self,
		HarmonyData	data
	)

Initialize the Harmony base entity.

Reimplemented in homeassistant.components.harmony.select.HarmonyActivitySelect.

Definition at line 25 of file entity.py.

Member Function Documentation

_async_clear_disconnection_delay()

None homeassistant.components.harmony.entity.HarmonyEntity._async_clear_disconnection_delay (   self )

private

Definition at line 56 of file entity.py.

_async_mark_disconnected_if_unavailable()

None homeassistant.components.harmony.entity.HarmonyEntity._async_mark_disconnected_if_unavailable (   self, datetime  _  )

private

Definition at line 62 of file entity.py.

async_got_connected()

None homeassistant.components.harmony.entity.HarmonyEntity.async_got_connected	(		self,
		str | None	_ = None
	)

Notification that we're connected to the HUB.

Definition at line 37 of file entity.py.

async_got_disconnected()

None homeassistant.components.harmony.entity.HarmonyEntity.async_got_disconnected	(		self,
		str | None	_ = None
	)

Notification that we're disconnected from the HUB.

Definition at line 44 of file entity.py.

available()

bool homeassistant.components.harmony.entity.HarmonyEntity.available

(

self

)

Return True if we're connected to the Hub, otherwise False.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 33 of file entity.py.

Member Data Documentation

_attr_has_entity_name

bool homeassistant.components.harmony.entity.HarmonyEntity._attr_has_entity_name = True

staticprivate

Definition at line 23 of file entity.py.

_attr_should_poll

homeassistant.components.harmony.entity.HarmonyEntity._attr_should_poll

private

Definition at line 30 of file entity.py.

_data

homeassistant.components.harmony.entity.HarmonyEntity._data

private

Definition at line 29 of file entity.py.

_unsub_mark_disconnected

homeassistant.components.harmony.entity.HarmonyEntity._unsub_mark_disconnected

private

Definition at line 49 of file entity.py.

---

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

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