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

Public Member Functions

None __init__ (self, Driver driver, ZwaveNode node, timedelta delay)
 
None async_added_to_hass (self)
 
None async_install (self, str|None version, bool backup, **Any kwargs)
 
None async_poll_value (self, bool _)
 
str|None async_release_notes (self)
 
None async_will_remove_from_hass (self)
 
ZWaveNodeFirmwareUpdateExtraStoredData extra_restore_state_data (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)
 
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)
 
- 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)
 
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)
 

Public Attributes

 driver
 
 node
 
- 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
 

Private Member Functions

None _async_update (self, HomeAssistant|datetime|None _=None)
 
None _unsub_firmware_events_and_reset_progress (self, bool write_state=True)
 
None _update_finished (self, dict[str, Any] event)
 
None _update_on_status_change (self, dict[str, Any] _)
 
None _update_progress (self, dict[str, Any] event)
 

Private Attributes

 _attr_device_info
 
 _attr_in_progress
 
 _attr_installed_version
 
 _attr_latest_version
 
 _attr_name
 
 _attr_unique_id
 
 _attr_update_percentage
 
 _base_unique_id
 
 _finished_event
 
 _finished_unsub
 
 _latest_version_firmware
 
 _poll_unsub
 
 _progress_unsub
 
 _result
 
 _status_unsub
 

Static Private Attributes

 _attr_device_class = UpdateDeviceClass.FIRMWARE
 
 _attr_entity_category = EntityCategory.CONFIG
 
bool _attr_has_entity_name = True
 
bool _attr_should_poll = False
 
tuple _attr_supported_features
 

Additional Inherited Members

- 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 firmware update entity.

Definition at line 107 of file update.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.__init__ (   self,
Driver  driver,
ZwaveNode  node,
timedelta  delay 
)
Initialize a Z-Wave device firmware update entity.

Definition at line 120 of file update.py.

Member Function Documentation

◆ _async_update()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._async_update (   self,
HomeAssistant | datetime | None   _ = None 
)
private
Update the entity.

Definition at line 189 of file update.py.

◆ _unsub_firmware_events_and_reset_progress()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._unsub_firmware_events_and_reset_progress (   self,
bool   write_state = True 
)
private
Unsubscribe from firmware events and reset update install progress.

Definition at line 170 of file update.py.

◆ _update_finished()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._update_finished (   self,
dict[str, Any]  event 
)
private
Update install progress on event.

Definition at line 163 of file update.py.

◆ _update_on_status_change()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._update_on_status_change (   self,
dict[str, Any]  _ 
)
private
Update the entity when node is awake.

Definition at line 147 of file update.py.

◆ _update_progress()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._update_progress (   self,
dict[str, Any]  event 
)
private
Update install progress on event.

Definition at line 153 of file update.py.

◆ async_added_to_hass()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.async_added_to_hass (   self)
Call when entity is added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 314 of file update.py.

◆ async_install()

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

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 264 of file update.py.

◆ async_poll_value()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.async_poll_value (   self,
bool  _ 
)
Poll a value.

Definition at line 304 of file update.py.

◆ async_release_notes()

str | None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.async_release_notes (   self)
Get release notes.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 258 of file update.py.

◆ async_will_remove_from_hass()

None homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.async_will_remove_from_hass (   self)
Call when entity will be removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 377 of file update.py.

◆ extra_restore_state_data()

ZWaveNodeFirmwareUpdateExtraStoredData homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.extra_restore_state_data (   self)
Return ZWave Node Firmware Update specific state data to be restored.

Reimplemented from homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 142 of file update.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_device_class = UpdateDeviceClass.FIRMWARE
staticprivate

Definition at line 111 of file update.py.

◆ _attr_device_info

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_device_info
private

Definition at line 139 of file update.py.

◆ _attr_entity_category

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_entity_category = EntityCategory.CONFIG
staticprivate

Definition at line 110 of file update.py.

◆ _attr_has_entity_name

bool homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_has_entity_name = True
staticprivate

Definition at line 117 of file update.py.

◆ _attr_in_progress

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_in_progress
private

Definition at line 158 of file update.py.

◆ _attr_installed_version

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_installed_version
private

Definition at line 137 of file update.py.

◆ _attr_latest_version

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_latest_version
private

Definition at line 248 of file update.py.

◆ _attr_name

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_name
private

Definition at line 134 of file update.py.

◆ _attr_should_poll

bool homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_should_poll = False
staticprivate

Definition at line 118 of file update.py.

◆ _attr_supported_features

tuple homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_supported_features
staticprivate
Initial value:
= (
UpdateEntityFeature.INSTALL
| UpdateEntityFeature.RELEASE_NOTES
| UpdateEntityFeature.PROGRESS
)

Definition at line 112 of file update.py.

◆ _attr_unique_id

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_unique_id
private

Definition at line 136 of file update.py.

◆ _attr_update_percentage

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._attr_update_percentage
private

Definition at line 159 of file update.py.

◆ _base_unique_id

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._base_unique_id
private

Definition at line 135 of file update.py.

◆ _finished_event

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._finished_event
private

Definition at line 129 of file update.py.

◆ _finished_unsub

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._finished_unsub
private

Definition at line 180 of file update.py.

◆ _latest_version_firmware

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._latest_version_firmware
private

Definition at line 247 of file update.py.

◆ _poll_unsub

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._poll_unsub
private

Definition at line 193 of file update.py.

◆ _progress_unsub

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._progress_unsub
private

Definition at line 176 of file update.py.

◆ _result

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._result
private

Definition at line 166 of file update.py.

◆ _status_unsub

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate._status_unsub
private

Definition at line 149 of file update.py.

◆ driver

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.driver

Definition at line 122 of file update.py.

◆ node

homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate.node

Definition at line 123 of file update.py.


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