From 529d1bc456f9eb06203b15b5490427fad7740e84 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Wed, 4 Dec 2024 14:23:21 +0100 Subject: [PATCH] Document update entity's display_precision property (#2414) * Document display_precision property * Update update.md --- docs/core/entity/update.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/core/entity/update.md b/docs/core/entity/update.md index ecb7103a..aeec724e 100644 --- a/docs/core/entity/update.md +++ b/docs/core/entity/update.md @@ -24,13 +24,14 @@ Properties should always only return information from memory and not do I/O (lik | 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. +| display_precision | int | `0` | Number of decimal digits for display of update progress. | 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. | 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_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. -| update_percentage | int | `None` | Update installation progress. Can either return a number to indicate the progress from 0 to 100% or None. +| update_percentage | int, float | `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.