homeassistant.components.litterrobot.update.RobotUpdateEntity Class Reference

Inheritance diagram for homeassistant.components.litterrobot.update.RobotUpdateEntity:

Collaboration diagram for homeassistant.components.litterrobot.update.RobotUpdateEntity:

Public Member Functions
None	async_install (self, str|None version, bool backup, **Any kwargs)
None	async_update (self)
bool	in_progress (self)
str	installed_version (self)
bool	should_poll (self)
Public Member Functions inherited from homeassistant.components.litterrobot.entity.LitterRobotEntity
None	__init__ (self, _RobotT robot, LitterRobotHub hub, EntityDescription description)
None	async_added_to_hass (self)
DeviceInfo	device_info (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
bool	available (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 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	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_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)
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_latest_version

Static Private Attributes
tuple	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.litterrobot.entity.LitterRobotEntity
	entity_description
	hub
	robot
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

A class that describes robot update entities.

Definition at line 46 of file update.py.

Member Function Documentation

async_install()

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

Install an update.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 79 of file update.py.

async_update()

None homeassistant.components.litterrobot.update.RobotUpdateEntity.async_update

(

self

)

Update the entity.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 68 of file update.py.

in_progress()

bool homeassistant.components.litterrobot.update.RobotUpdateEntity.in_progress

(

self

)

Update installation progress.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 59 of file update.py.

installed_version()

str homeassistant.components.litterrobot.update.RobotUpdateEntity.installed_version

(

self

)

Version installed and in use.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 54 of file update.py.

should_poll()

bool homeassistant.components.litterrobot.update.RobotUpdateEntity.should_poll

(

self

)

Set polling to True.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 64 of file update.py.

Member Data Documentation

_attr_latest_version

homeassistant.components.litterrobot.update.RobotUpdateEntity._attr_latest_version

private

Definition at line 77 of file update.py.

_attr_supported_features

tuple homeassistant.components.litterrobot.update.RobotUpdateEntity._attr_supported_features

staticprivate

Initial value:

=  (
        UpdateEntityFeature.INSTALL | UpdateEntityFeature.PROGRESS
    )

Definition at line 49 of file update.py.

---

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

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