homeassistant.components.shelly.update.RestUpdateEntity Class Reference

Inheritance diagram for homeassistant.components.shelly.update.RestUpdateEntity:

Collaboration diagram for homeassistant.components.shelly.update.RestUpdateEntity:

Public Member Functions
None	__init__ (self, ShellyBlockCoordinator block_coordinator, str attribute, RestUpdateDescription description)
None	async_install (self, str|None version, bool backup, **Any kwargs)
bool	in_progress (self)
str|None	installed_version (self)
str|None	latest_version (self)
bool	version_is_newer (self, str latest_version, str installed_version)
Public Member Functions inherited from homeassistant.components.shelly.entity.ShellyRestAttributeEntity
None	__init__ (self, ShellyBlockCoordinator coordinator, str attribute, RestEntityDescription description)
StateType	attribute_value (self)
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.shelly.coordinator.ShellyBlockCoordinator
None	__init__ (self, HomeAssistant hass, ShellyConfigEntry entry, BlockDevice device)
None	async_setup (self, list[Platform]|None pending_platforms=None)
CALLBACK_TYPE	async_subscribe_input_events (self, Callable[[dict[str, Any]], None] input_event_callback)
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)
None	install (self, str|None version, bool backup, **Any kwargs)
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)
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_added_to_hass (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)

Private Attributes
	_attr_release_url
	_in_progress_old_version

Static Private Attributes
tuple	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.shelly.entity.ShellyRestAttributeEntity
	attribute
	block_coordinator
	entity_description
Public Attributes inherited from homeassistant.components.shelly.coordinator.ShellyBlockCoordinator
	entry
	model
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

Represent a REST update entity.

Definition at line 135 of file update.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.shelly.update.RestUpdateEntity.__init__	(		self,
		ShellyBlockCoordinator	block_coordinator,
		str	attribute,
		RestUpdateDescription	description
	)

Initialize update entity.

Definition at line 143 of file update.py.

Member Function Documentation

async_install()

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

Install the latest firmware version.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 179 of file update.py.

in_progress()

bool homeassistant.components.shelly.update.RestUpdateEntity.in_progress

(

self

)

Update installation in progress.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 175 of file update.py.

installed_version()

str | None homeassistant.components.shelly.update.RestUpdateEntity.installed_version

(

self

)

Version currently in use.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 159 of file update.py.

latest_version()

str | None homeassistant.components.shelly.update.RestUpdateEntity.latest_version

(

self

)

Latest version available for install.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 164 of file update.py.

version_is_newer()

bool homeassistant.components.shelly.update.RestUpdateEntity.version_is_newer	(		self,
		str	latest_version,
		str	installed_version
	)

Return True if available version is newer then installed version.

Default strategy generate an exception with Shelly firmware format
thus making the entity state always true.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 207 of file update.py.

Member Data Documentation

_attr_release_url

homeassistant.components.shelly.update.RestUpdateEntity._attr_release_url

private

Definition at line 151 of file update.py.

_attr_supported_features

tuple homeassistant.components.shelly.update.RestUpdateEntity._attr_supported_features

staticprivate

Initial value:

=  (
        UpdateEntityFeature.INSTALL | UpdateEntityFeature.PROGRESS
    )

Definition at line 138 of file update.py.

_in_progress_old_version

homeassistant.components.shelly.update.RestUpdateEntity._in_progress_old_version

private

Definition at line 177 of file update.py.

---

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

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