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-26 02:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for UpdateEntityFeature.AUTO_UPDATE

Browse Source
This commit is contained in:
Ludeeus 2022-03-31 16:06:35 +00:00
parent 7aeb2a00ec
commit 874d787846
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -41,6 +41,7 @@ Other properties that are common to all entities such as `device_class`, `entity
| 'UpdateEntityFeature.PROGRESS' | This integration is able to provide progress information. If omitted, Home Assistant will try to provide a progress status; although it is better if the progress can be extracted from the device or service API. | 'UpdateEntityFeature.PROGRESS' | This integration is able to provide progress information. If omitted, Home Assistant will try to provide a progress status; although it is better if the progress can be extracted from the device or service API.
| 'UpdateEntityFeature.SPECIFIC_VERSION' | A specific version of an update can be installed using the `update.install` service. | 'UpdateEntityFeature.SPECIFIC_VERSION' | A specific version of an update can be installed using the `update.install` service.
| 'UpdateEntityFeature.RELEASE_NOTES' | The entity provides methods to fetch a complete changelog. | 'UpdateEntityFeature.RELEASE_NOTES' | The entity provides methods to fetch a complete changelog.
| 'UpdateEntityFeature.AUTO_UPDATE' | The device or service that the entity represent have auto update logic, when this is set you can not skip updates.
## Methods ## Methods
@ -49,10 +50,10 @@ Other properties that are common to all entities such as `device_class`, `entity
This method can be implemented so users can install an offered update directly This method can be implemented so users can install an offered update directly
from within Home Assistant. from within Home Assistant.
This method requires `SUPPORT_INSTALL` to be set. Additionally, if this This method requires `UpdateEntityFeature.INSTALL` to be set. Additionally, if this
integration supports installing specific version or is capable of backing up integration supports installing specific version or is capable of backing up
before starting the update installation process, `SUPPORT_SPECIFIC_VERSION` and before starting the update installation process, `UpdateEntityFeature.SPECIFIC_VERSION` and
`SUPPORT_BACKUP` can be set respectively. `UpdateEntityFeature.BACKUP` can be set respectively.
```python ```python
class MyUpdate(UpdateEntity): class MyUpdate(UpdateEntity):