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

Public Member Functions

None __init__ (self, *str unique_id, str device_name, str|None title, str|None installed_version, str|None latest_version, str|None release_summary=None, str|None release_url=None, bool support_progress=False, bool support_install=True, bool support_release_notes=False, UpdateDeviceClass|None device_class=None, int display_precision=0, int update_steps=100)
 
None async_install (self, str|None version, bool backup, **Any kwargs)
 
str|None release_notes (self)
 
- 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_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)
 
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 Attributes

 _attr_device_class
 
 _attr_device_info
 
 _attr_display_precision
 
 _attr_in_progress
 
 _attr_installed_version
 
 _attr_latest_version
 
 _attr_release_summary
 
 _attr_release_url
 
 _attr_title
 
 _attr_unique_id
 
 _attr_update_percentage
 
 _update_steps
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = False
 

Additional Inherited Members

- 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

Representation of a demo update entity.

Definition at line 103 of file update.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.update.DemoUpdate.__init__ (   self,
*str  unique_id,
str  device_name,
str | None  title,
str | None  installed_version,
str | None  latest_version,
str | None   release_summary = None,
str | None   release_url = None,
bool   support_progress = False,
bool   support_install = True,
bool   support_release_notes = False,
UpdateDeviceClass | None   device_class = None,
int   display_precision = 0,
int   update_steps = 100 
)
Initialize the Demo select entity.

Definition at line 110 of file update.py.

Member Function Documentation

◆ async_install()

None homeassistant.components.demo.update.DemoUpdate.async_install (   self,
str | None  version,
bool  backup,
**Any   kwargs 
)
Install an update.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 153 of file update.py.

◆ release_notes()

str | None homeassistant.components.demo.update.DemoUpdate.release_notes (   self)
Return the release notes.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 171 of file update.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.demo.update.DemoUpdate._attr_device_class
private

Definition at line 129 of file update.py.

◆ _attr_device_info

homeassistant.components.demo.update.DemoUpdate._attr_device_info
private

Definition at line 136 of file update.py.

◆ _attr_display_precision

homeassistant.components.demo.update.DemoUpdate._attr_display_precision
private

Definition at line 130 of file update.py.

◆ _attr_has_entity_name

bool homeassistant.components.demo.update.DemoUpdate._attr_has_entity_name = True
staticprivate

Definition at line 106 of file update.py.

◆ _attr_in_progress

homeassistant.components.demo.update.DemoUpdate._attr_in_progress
private

Definition at line 158 of file update.py.

◆ _attr_installed_version

homeassistant.components.demo.update.DemoUpdate._attr_installed_version
private

Definition at line 128 of file update.py.

◆ _attr_latest_version

homeassistant.components.demo.update.DemoUpdate._attr_latest_version
private

Definition at line 131 of file update.py.

◆ _attr_name

homeassistant.components.demo.update.DemoUpdate._attr_name = None
staticprivate

Definition at line 107 of file update.py.

◆ _attr_release_summary

homeassistant.components.demo.update.DemoUpdate._attr_release_summary
private

Definition at line 132 of file update.py.

◆ _attr_release_url

homeassistant.components.demo.update.DemoUpdate._attr_release_url
private

Definition at line 133 of file update.py.

◆ _attr_should_poll

bool homeassistant.components.demo.update.DemoUpdate._attr_should_poll = False
staticprivate

Definition at line 108 of file update.py.

◆ _attr_title

homeassistant.components.demo.update.DemoUpdate._attr_title
private

Definition at line 134 of file update.py.

◆ _attr_unique_id

homeassistant.components.demo.update.DemoUpdate._attr_unique_id
private

Definition at line 135 of file update.py.

◆ _attr_update_percentage

homeassistant.components.demo.update.DemoUpdate._attr_update_percentage
private

Definition at line 160 of file update.py.

◆ _update_steps

homeassistant.components.demo.update.DemoUpdate._update_steps
private

Definition at line 140 of file update.py.


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