homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity Class Reference

Inheritance diagram for homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity:

Collaboration diagram for homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity:

Public Member Functions
None	__init__ (self, RuntimeEntryData entry_data, ESPHomeDashboardCoordinator coordinator)
None	async_added_to_hass (self)
None	async_install (self, str|None version, bool backup, **Any kwargs)
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.esphome.coordinator.ESPHomeDashboardCoordinator
None	__init__ (self, HomeAssistant hass, str addon_slug, str url, aiohttp.ClientSession session)
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.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)
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)
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)

Private Member Functions
ESPHomeDeviceInfo	_device_info (self)
None	_handle_coordinator_update (self)
None	_handle_device_update (self, list[EntityInfo]|None static_info=None)
None	_update_attrs (self)

Private Attributes
	_attr_device_info
	_attr_installed_version
	_attr_latest_version
	_attr_supported_features
	_attr_unique_id
	_entry_data

Static Private Attributes
	_attr_device_class = UpdateDeviceClass.FIRMWARE
bool	_attr_entity_registry_enabled_default = False
bool	_attr_has_entity_name = True
string	_attr_name = "Firmware"
string	_attr_release_url = "https://esphome.io/changelog/"
string	_attr_title = "ESPHome"

Additional Inherited Members
Public Attributes inherited from homeassistant.components.esphome.coordinator.ESPHomeDashboardCoordinator
	addon_slug
	api
	supports_update
	url
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.components.update.UpdateEntity
	installed_version
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.update.UpdateEntity
	bool
	int
	None
	UpdateEntityFeature
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Defines an ESPHome update entity.

Definition at line 102 of file update.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity.__init__	(		self,
		RuntimeEntryData	entry_data,
		ESPHomeDashboardCoordinator	coordinator
	)

Initialize the update entity.

Definition at line 114 of file update.py.

Member Function Documentation

_device_info()

ESPHomeDeviceInfo homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._device_info (   self )

private

Return the device info.

Definition at line 157 of file update.py.

_handle_coordinator_update()

None homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._handle_coordinator_update (   self )

private

Handle updated data from the coordinator.

Definition at line 151 of file update.py.

_handle_device_update()

None homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._handle_device_update (   self, list[EntityInfo] | None   static_info = None  )

private

Handle updated data from the device.

Definition at line 176 of file update.py.

_update_attrs()

None homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._update_attrs (   self )

private

Update the supported features.

Definition at line 130 of file update.py.

async_added_to_hass()

None homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity.async_added_to_hass

(

self

)

Handle entity added to Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 183 of file update.py.

async_install()

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

Install an update.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 194 of file update.py.

available()

bool homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity.available

(

self

)

Return if update is available.

During deep sleep the ESP will not be connectable (by design)
and thus, even when unavailable, we'll show it as available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 163 of file update.py.

Member Data Documentation

_attr_device_class

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_device_class = UpdateDeviceClass.FIRMWARE

staticprivate

Definition at line 108 of file update.py.

_attr_device_info

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_device_info

private

Definition at line 122 of file update.py.

_attr_entity_registry_enabled_default

bool homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_entity_registry_enabled_default = False

staticprivate

Definition at line 112 of file update.py.

_attr_has_entity_name

bool homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_has_entity_name = True

staticprivate

Definition at line 107 of file update.py.

_attr_installed_version

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_installed_version

private

Definition at line 145 of file update.py.

_attr_latest_version

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_latest_version

private

Definition at line 148 of file update.py.

_attr_name

string homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_name = "Firmware"

staticprivate

Definition at line 110 of file update.py.

_attr_release_url

string homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_release_url = "https://esphome.io/changelog/"

staticprivate

Definition at line 111 of file update.py.

_attr_supported_features

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_supported_features

private

Definition at line 142 of file update.py.

_attr_title

string homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_title = "ESPHome"

staticprivate

Definition at line 109 of file update.py.

_attr_unique_id

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._attr_unique_id

private

Definition at line 121 of file update.py.

_entry_data

homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity._entry_data

private

Definition at line 120 of file update.py.

---

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

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