jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-19 15:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document update entity's update_percentage property (#2413)

Browse Source
This commit is contained in:
Erik Montnemery 2024-10-21 20:01:39 +02:00 committed by GitHub
parent 0e20b58399
commit 7a110960bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/core/entity/update.md
View File

@ -24,12 +24,13 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description | Name | Type | Default | Description
| ---- | ---- | ------- | ----------- | ---- | ---- | ------- | -----------
| auto_update | bool | `False` | The device or service that the entity represents has auto update logic. When this is set to `True` you can not skip updates. | auto_update | bool | `False` | The device or service that the entity represents has auto update logic. When this is set to `True` you can not skip updates.
| in_progress | bool, int | `None` | Update installation progress. Can either return a boolean (True if in progress, False if not) or an integer to indicate the progress from 0 to 100%. | in_progress | bool | `None` | Update installation progress. Should return a boolean (True if in progress, False if not).
| installed_version | str | `None` | The currently installed and used version of the software. | installed_version | str | `None` | The currently installed and used version of the software.
| latest_version | str | `None` | The latest version of the software available. | latest_version | str | `None` | The latest version of the software available.
| release_summary | str | `None` | Summary of the release notes or changelog. This is not suitable for long changelogs but merely suitable for a short excerpt update description of max 255 characters. | release_summary | str | `None` | Summary of the release notes or changelog. This is not suitable for long changelogs but merely suitable for a short excerpt update description of max 255 characters.
| release_url | str | `None` | URL to the full release notes of the latest version available. | release_url | str | `None` | URL to the full release notes of the latest version available.
| title | str | `None` | Title of the software. This helps to differentiate between the device or entity name versus the title of the software installed. | title | str | `None` | Title of the software. This helps to differentiate between the device or entity name versus the title of the software installed.
| update_percentage | int | `None` | Update installation progress. Can either return a number to indicate the progress from 0 to 100% or None.
Other properties that are common to all entities such as `device_class`, `entity_category`, `icon`, `name` etc are still applicable. Other properties that are common to all entities such as `device_class`, `entity_category`, `icon`, `name` etc are still applicable.