From 72cfa54128fa8f2ccc69cd1124854ee27d2bb35d Mon Sep 17 00:00:00 2001 From: avee87 <6134677+avee87@users.noreply.github.com> Date: Tue, 26 Oct 2021 15:10:47 +0100 Subject: [PATCH] Add documentation for Supervisor integration (#19778) --- source/_integrations/hassio.markdown | 137 +++++++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 source/_integrations/hassio.markdown diff --git a/source/_integrations/hassio.markdown b/source/_integrations/hassio.markdown new file mode 100644 index 00000000000..c8beaf282c4 --- /dev/null +++ b/source/_integrations/hassio.markdown @@ -0,0 +1,137 @@ +--- +title: Supervisor +description: Control Supervisor Add-ons and OS from Home Assistant +ha_category: + - Binary Sensor + - Sensor +ha_iot_class: Local Polling +ha_release: 2021.4 +ha_domain: hassio +ha_platforms: + - binary_sensor + - sensor +--- + +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. + +## Sensors + +For each installed add-on Supervisor provides following sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Version | no | Current version of the add-on +| Newest Version | no | Latest version of the add-on currently available + +For Home Assistant OS Supervisor provides following sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Version | no | Current version of the Home Assistant OS +| Newest Version | no | Latest version of the Home Assistant OS currently available + +## Binary Sensors + +For each installed add-on Supervisor provides following binary sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Update Available | no | Whether there is an update available for this add-on + +For Home Assistant OS Supervisor provides following binary sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Update Available | no | Whether there is an update available for OS + +## Services + +### Service hassio.addon_start + +Start an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_stop + +Stop an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_restart + +Restart an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_stdin + +Write data to add-on stdin. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_update + +Update add-on. This service should be used with caution since add-on updates can contain breaking changes. It is highly recommended that you review release notes/change logs before updating an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.host_reboot + +Reboot the host system. + +### Service hassio.host_shutdown + +Shutdown the host system. + +### Service hassio.backup_full + +Create a full backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `name` | yes | Name of the backup file. Default is current date and time +| `password` | yes | Optional password for backup + +### Service hassio.backup_partial + +Create a partial backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addons` | yes | List of add-on slugs to backup +| `folders` | yes | List of directories to backup +| `name` | yes | Name of the backup file. Default is current date and time +| `password` | yes | Optional password for backup + +### Service hassio.restore_full + +Restore from full backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `slug` | no | Slug of backup to restore from +| `password` | yes | Optional password for backup + +### Service hassio.restore_partial + +Restore from partial backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `slug` | no | Slug of backup to restore from +| `homeassistant` | yes | Whether to restore Home Assistant, `true` or `false` +| `addons` | yes | List of add-on slugs to restore +| `folders` | yes | List of directories to restore +| `password` | yes | Optional password for backup