Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.reolink.update.ReolinkUpdateBaseEntity Class Reference
Inheritance diagram for homeassistant.components.reolink.update.ReolinkUpdateBaseEntity:
[legend]
Collaboration diagram for homeassistant.components.reolink.update.ReolinkUpdateBaseEntity:
[legend]

Public Member Functions

None __init__ (self, ReolinkData reolink_data, int|None channel, DataUpdateCoordinator[None] coordinator)
 
None async_added_to_hass (self)
 
None async_install (self, str|None version, bool backup, **Any kwargs)
 
str|None async_release_notes (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
bool in_progress (self)
 
str|None installed_version (self)
 
str|None latest_version (self)
 
UpdateEntityFeature supported_features (self)
 
int update_percentage (self)
 
bool version_is_newer (self, str latest_version, str installed_version)
 
- 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.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)
 
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_compat (self)
 
str|None title (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_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_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, strtranslation_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_update_future (self, *Any args)
 
None _async_update_progress (self, *Any args)
 
None _pause_update_coordinator (self)
 
None _resume_update_coordinator (self, *Any args)
 

Private Attributes

 _cancel_progress
 
 _cancel_resume
 
 _cancel_update
 
 _channel
 
 _host
 
 _installing
 
 _reolink_data
 

Static Private Attributes

string _attr_release_url = "https://reolink.com/download-center/"
 

Additional Inherited Members

- 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

Base update entity class for Reolink.

Definition at line 96 of file update.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.__init__ (   self,
ReolinkData  reolink_data,
int | None  channel,
DataUpdateCoordinator[None coordinator 
)
Initialize Reolink update entity.

Definition at line 103 of file update.py.

Member Function Documentation

◆ _async_update_future()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._async_update_future (   self,
*Any  args 
)
private
Request update.

Definition at line 232 of file update.py.

◆ _async_update_progress()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._async_update_progress (   self,
*Any  args 
)
private
Request update.

Definition at line 224 of file update.py.

◆ _pause_update_coordinator()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._pause_update_coordinator (   self)
private
Pause updating the states using the data update coordinator (during reboots).

Definition at line 211 of file update.py.

◆ _resume_update_coordinator()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._resume_update_coordinator (   self,
*Any  args 
)
private
Resume updating the states using the data update coordinator (after reboots).

Definition at line 216 of file update.py.

◆ async_added_to_hass()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.async_added_to_hass (   self)
Entity created.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 239 of file update.py.

◆ async_install()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.async_install (   self,
str | None  version,
bool  backup,
**Any   kwargs 
)
Install the latest firmware version.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 186 of file update.py.

◆ async_release_notes()

str | None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.async_release_notes (   self)
Return the release notes.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 174 of file update.py.

◆ async_will_remove_from_hass()

None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.async_will_remove_from_hass (   self)
Entity removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 244 of file update.py.

◆ available()

bool homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 157 of file update.py.

◆ in_progress()

bool homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.in_progress (   self)
Update installation progress.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 137 of file update.py.

◆ installed_version()

str | None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.installed_version (   self)
Version currently in use.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 120 of file update.py.

◆ latest_version()

str | None homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.latest_version (   self)
Latest version available for install.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 125 of file update.py.

◆ supported_features()

UpdateEntityFeature homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.supported_features (   self)
Flag supported features.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 147 of file update.py.

◆ update_percentage()

int homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.update_percentage (   self)
Update installation progress.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 142 of file update.py.

◆ version_is_newer()

bool homeassistant.components.reolink.update.ReolinkUpdateBaseEntity.version_is_newer (   self,
str  latest_version,
str  installed_version 
)
Return True if latest_version is newer than installed_version.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 163 of file update.py.

Member Data Documentation

◆ _attr_release_url

string homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._attr_release_url = "https://reolink.com/download-center/"
staticprivate

Definition at line 101 of file update.py.

◆ _cancel_progress

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._cancel_progress
private

Definition at line 192 of file update.py.

◆ _cancel_resume

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._cancel_resume
private

Definition at line 206 of file update.py.

◆ _cancel_update

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._cancel_update
private

Definition at line 203 of file update.py.

◆ _channel

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._channel
private

Definition at line 111 of file update.py.

◆ _host

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._host
private

Definition at line 112 of file update.py.

◆ _installing

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._installing
private

Definition at line 190 of file update.py.

◆ _reolink_data

homeassistant.components.reolink.update.ReolinkUpdateBaseEntity._reolink_data
private

Definition at line 117 of file update.py.


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