Add documentation for Supervisor Update entities (#22108)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Joakim Sørensen 2022-03-22 12:21:23 +01:00 committed by GitHub
parent 22a3c87dd6
commit eea9545f37
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,6 +4,7 @@ description: Control Supervisor Add-ons and OS from Home Assistant
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Sensor - Sensor
- Updates
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.42 ha_release: 0.42
ha_domain: hassio ha_domain: hassio
@ -11,6 +12,7 @@ ha_quality_scale: internal
ha_platforms: ha_platforms:
- binary_sensor - binary_sensor
- sensor - sensor
- update
ha_codeowners: ha_codeowners:
- '@home-assistant/supervisor' - '@home-assistant/supervisor'
--- ---
@ -18,7 +20,7 @@ ha_codeowners:
Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant. Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.
This integration is installed automatically if you run Home Assistant OS or Supervised. This integration is installed automatically if you run Home Assistant OS or Supervised.
## Sensors ## Sensor entities
For each installed add-on Supervisor provides following sensors: For each installed add-on Supervisor provides following sensors:
@ -36,13 +38,13 @@ For Home Assistant OS Supervisor provides following sensors:
| Version | no | Current version of the Home Assistant OS | Version | no | Current version of the Home Assistant OS
| Newest Version | no | Latest version of the Home Assistant OS currently available | Newest Version | no | Latest version of the Home Assistant OS currently available
## Binary Sensors ## Binary Sensor entities
For each installed add-on Supervisor provides following binary sensors: For each installed add-on Supervisor provides following binary sensors:
| Sensor | Enabled by default | Description | | Sensor | Enabled by default | Description |
| ------- | ------------------ | ----------- | | ------- | ------------------ | ----------- |
| Update Available | no | Whether there is an update available for this add-on | Update Available | no | Whether there is an update available for this add-on (This is deprecated, use the Update entities instead.)
| Running | no | Whether the add-on is running or not. | Running | no | Whether the add-on is running or not.
For Home Assistant OS Supervisor provides following binary sensors: For Home Assistant OS Supervisor provides following binary sensors:
@ -51,6 +53,10 @@ For Home Assistant OS Supervisor provides following binary sensors:
| ------- | ------------------ | ----------- | | ------- | ------------------ | ----------- |
| Update Available | no | Whether there is an update available for OS | Update Available | no | Whether there is an update available for OS
## Update entities
For all your installed add-ons, Home Assistant Core, Home Assistant Supervisor, and for the Home Assistant Operating System (if you are running that), this integration will provide [update](/integrations/update) entities that provide information about pending updates, and will allow you to update to them.
## Services ## Services
### Service hassio.addon_start ### Service hassio.addon_start