homeassistant.components.unifi.update.UnifiDeviceUpdateEntity Class Reference

Inheritance diagram for homeassistant.components.unifi.update.UnifiDeviceUpdateEntity:

Collaboration diagram for homeassistant.components.unifi.update.UnifiDeviceUpdateEntity:

Public Member Functions
None	async_initiate_state (self)
None	async_install (self, str|None version, bool backup, **Any kwargs)
None	async_update_state (self, ItemEvent event, str obj_id)
Public Member Functions inherited from homeassistant.components.unifi.entity.UnifiEntity
None	__init__ (self, str obj_id, UnifiHub hub, UnifiEntityDescription[HandlerT, ApiItemT] description)
None	async_added_to_hass (self)
None	async_event_callback (self, Event event)
None	async_signal_options_updated (self)
None	async_signal_reachable_callback (self)
None	async_signalling_callback (self, ItemEvent event, str obj_id)
None	async_update (self)
None	remove_item (self, set keys)
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_device_update (self, bool warning=True)
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)
dict[str, Any]|None	capability_attributes (self)
DeviceInfo|None	device_info (self)
bool	enabled (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)
Public Member Functions inherited from homeassistant.components.update.UpdateEntity
None	async_clear_skipped (self)
None	async_install_with_progress (self, str|None version, bool backup)
None	async_internal_added_to_hass (self)
str|None	async_release_notes (self)
None	async_skip (self)
bool	auto_update (self)
UpdateDeviceClass|None	device_class (self)
int	display_precision (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool|int|None	in_progress (self)
None	install (self, str|None version, bool backup, **Any kwargs)
str|None	installed_version (self)
str|None	latest_version (self)
str|None	release_notes (self)
str|None	release_summary (self)
str|None	release_url (self)
str|None	state (self)
dict[str, Any]|None	state_attributes (self)
UpdateEntityFeature	supported_features (self)
UpdateEntityFeature	supported_features_compat (self)
str|None	title (self)
int|float|None	update_percentage (self)
bool	version_is_newer (self, str latest_version, str installed_version)
Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None	async_get_last_extra_data (self)
State|None	async_get_last_state (self)
None	async_internal_will_remove_from_hass (self)
ExtraStoredData|None	extra_restore_state_data (self)

Private Attributes
	_attr_in_progress
	_attr_installed_version
	_attr_latest_version
	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.unifi.entity.UnifiEntity
	api
	entity_description
	hub
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.update.UpdateEntity
	installed_version
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.update.UpdateEntity
	bool
	int
	None
	UpdateEntityFeature

Detailed Description

Representation of a UniFi device update entity.

Definition at line 81 of file update.py.

Member Function Documentation

async_initiate_state()

None homeassistant.components.unifi.update.UnifiDeviceUpdateEntity.async_initiate_state

(

self

)

Initiate entity state.

Reimplemented from homeassistant.components.unifi.entity.UnifiEntity.

Definition at line 87 of file update.py.

async_install()

None homeassistant.components.unifi.update.UnifiDeviceUpdateEntity.async_install	(		self,
		str | None	version,
		bool	backup,
		**Any	kwargs
	)

Install an update.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 95 of file update.py.

async_update_state()

None homeassistant.components.unifi.update.UnifiDeviceUpdateEntity.async_update_state	(		self,
		ItemEvent	event,
		str	obj_id
	)

Update entity state.

Update in_progress, installed_version and latest_version.

Reimplemented from homeassistant.components.unifi.entity.UnifiEntity.

Definition at line 102 of file update.py.

Member Data Documentation

_attr_in_progress

homeassistant.components.unifi.update.UnifiDeviceUpdateEntity._attr_in_progress

private

Definition at line 110 of file update.py.

_attr_installed_version

homeassistant.components.unifi.update.UnifiDeviceUpdateEntity._attr_installed_version

private

Definition at line 111 of file update.py.

_attr_latest_version

homeassistant.components.unifi.update.UnifiDeviceUpdateEntity._attr_latest_version

private

Definition at line 112 of file update.py.

_attr_supported_features

homeassistant.components.unifi.update.UnifiDeviceUpdateEntity._attr_supported_features

private

Definition at line 89 of file update.py.

---

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

• core/homeassistant/components/unifi/update.py