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-16 13:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Supervisor version handling over API (#696)

Browse Source
This commit is contained in:
Pascal Vizeli 2020-10-26 14:42:55 +01:00 committed by GitHub
parent 663eea260b
commit 780ff178c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 87 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
docs/api/supervisor/endpoints.md
View File

@ -34,8 +34,10 @@ Return overview information about add-ons and add-on repositories.
"advanced": false, "advanced": false,
"stage": "stable", "stage": "stable",
"repository": "core", "repository": "core",
"version": "1.0.1", "version": null,
"installed": null, "version_latest": "1.0.1",
"update_available": false,
"installed": false,
"detached": true, "detached": true,
"available": true, "available": true,
"build": false, "build": false,
@ -144,6 +146,7 @@ Get details about a add-on
| state | string or null | The state of the add-on (started, stopped) | | state | string or null | The state of the add-on (started, stopped) |
| stdin | boolean | `true` if the add-on accepts stdin commands | | stdin | boolean | `true` if the add-on accepts stdin commands |
| udev | boolean | `true` if udev access is granted is enabled | | udev | boolean | `true` if udev access is granted is enabled |
| update_available | boolean | `true` if an update is available |
| url | string or null | URL to more information about the add-on | | url | string or null | URL to more information about the add-on |
| usb | list | A list of attached USB devices | | usb | list | A list of attached USB devices |
| version | string | The installed version of the add-on | | version | string | The installed version of the add-on |
@ -215,6 +218,7 @@ Get details about a add-on
"state": "started", "state": "started",
"stdin": false, "stdin": false,
"udev": false, "udev": false,
"update_available": false,
"url": null, "url": null,
"usb": ["/dev/usb1"], "usb": ["/dev/usb1"],
"version_latest": "1.0.2", "version_latest": "1.0.2",
@ -374,12 +378,13 @@ Return information about the audio plugin.
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | ---------- | ------------------------------- | | ---------------- | ---------- | -------------------------------- |
| host | string | The IP address of the plugin | | host | string | The IP address of the plugin |
| version | string | The installed observer version | | version | string | The installed observer version |
| version_latest | string | The latest published version | | version_latest | string | The latest published version |
| audio | dictionary | A [Audio model](api/supervisor/models.md#audio) | | update_available | boolean | `true` if an update is available |
| audio | dictionary | A [Audio model](api/supervisor/models.md#audio) |
**Example response:** **Example response:**
@ -388,6 +393,7 @@ Return information about the audio plugin.
"host": "172.0.0.19", "host": "172.0.0.19",
"version": "1", "version": "1",
"latest_version": "2", "latest_version": "2",
"update_available": true,
"audio": { "audio": {
"card": [ "card": [
{ {
@ -657,17 +663,19 @@ Returns information about the CLI plugin
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | ------ | ---------------------------- | | ---------------- | ---------- | -------------------------------- |
| version | string | The installed CLI version | | version | string | The installed cli version |
| version_latest | string | The latest published version | | version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |
**Example response:** **Example response:**
```json ```json
{ {
"version": "1", "version": "1",
"version_latest": "2" "version_latest": "2",
"update_available": true
} }
``` ```
@ -724,21 +732,22 @@ Returns information about the Home Assistant core
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | -------------- | ---------------------------------------------------------- | | ---------------- | -------------- | ---------------------------------------------------------- |
| version | string | The installed core version | | version | string | The installed core version |
| version_latest | string | The latest published version in the active channel | | version_latest | string | The latest published version in the active channel |
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) | | update_available | boolean | `true` if an update is available |
| machine | string | The machine type that is running the host | | arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
| ip_address | string | The internal docker IP address to the supervisor | | machine | string | The machine type that is running the host |
| image | string | The container image that is running the core | | ip_address | string | The internal docker IP address to the supervisor |
| boot | boolean | `true` if it should start on boot | | image | string | The container image that is running the core |
| port | int | The port Home Assistant is running on | | boot | boolean | `true` if it should start on boot |
| ssl | boolean | `true` if Home Assistant is using SSL | | port | int | The port Home Assistant is running on |
| watchdog | boolean | `true` if watchdog is enabled | | ssl | boolean | `true` if Home Assistant is using SSL |
| wait_boot | int | Max time to wait during boot | | watchdog | boolean | `true` if watchdog is enabled |
| audio_input | string or null | The description of the audio input device | | wait_boot | int | Max time to wait during boot |
| audio_output | string or null | The description of the audio output device | | audio_input | string or null | The description of the audio input device |
| audio_output | string or null | The description of the audio output device |
**Example response:** **Example response:**
@ -746,6 +755,7 @@ Returns information about the Home Assistant core
{ {
"version": "0.117.0", "version": "0.117.0",
"version_latest": "0.117.0", "version_latest": "0.117.0",
"update_available": true,
"arch": "arch", "arch": "arch",
"machine": "amd64", "machine": "amd64",
"ip_address": "172.0.0.15", "ip_address": "172.0.0.15",
@ -911,13 +921,14 @@ Return information about the DNS plugin.
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | ------ | ------------------------------ | | ---------------- | ------- | -------------------------------- |
| host | string | The IP address of the plugin | | host | string | The IP address of the plugin |
| version | string | The installed observer version | | version | string | The installed observer version |
| version_latest | string | The latest published version | | version_latest | string | The latest published version |
| servers | list | A list of DNS servers | | update_available | boolean | `true` if an update is available |
| locals | list | A list of DNS servers | | servers | list | A list of DNS servers |
| locals | list | A list of DNS servers |
**Example response:** **Example response:**
@ -926,6 +937,7 @@ Return information about the DNS plugin.
"host": "127.0.0.18", "host": "127.0.0.18",
"version": "1", "version": "1",
"version_latest": "2", "version_latest": "2",
"update_available": true,
"servers": ["dns://8.8.8.8"], "servers": ["dns://8.8.8.8"],
"locals": ["dns://127.0.0.18"] "locals": ["dns://127.0.0.18"]
} }
@ -1308,17 +1320,19 @@ Returns information about the multicast plugin
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | ------ | ------------------------------ | | ---------------- | ---------- | --------------------------------- |
| version | string | The installed observer version | | version | string | The installed multicast version |
| version_latest | string | The latest published version | | version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |
**Example response:** **Example response:**
```json ```json
{ {
"version": "1", "version": "1",
"version_latest": "2" "version_latest": "2",
"update_available": true
} }
``` ```
@ -1454,11 +1468,12 @@ Returns information about the observer plugin
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | ------ | ----------------------------------------- | | ---------------- | ---------- | -------------------------------- |
| host | string | The IP address the observer is running on | | host | string | The IP address of the plugin |
| version | string | The installed observer version | | version | string | The installed observer version |
| version_latest | string | The latest published version | | version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |
**Example response:** **Example response:**
@ -1466,7 +1481,8 @@ Returns information about the observer plugin
{ {
"host": "172.0.0.17", "host": "172.0.0.17",
"version": "1", "version": "1",
"version_latest": "2" "version_latest": "2",
"update_available": true
} }
``` ```
@ -1519,12 +1535,13 @@ Returns information about the OS.
**Returned data:** **Returned data:**
| key | type | description | | key | type | description |
| -------------- | ------ | ------------------------------------------------------------ | | ---------------- | ------- | ------------------------------------------------------------ |
| version | string | The current version of the OS | | version | string | The current version of the OS |
| version_latest | string | The latest published version of the OS in the active channel | | version_latest | string | The latest published version of the OS in the active channel |
| board | string | The name of the board | | update_available | boolean | `true` if an update is available |
| boot | string | Which slot that are in use | | board | string | The name of the board |
| boot | string | Which slot that are in use |
**Example response:** **Example response:**
@ -1884,6 +1901,7 @@ Returns information about the supervisor
| ------------------- | ------------ | ------------------------------------------------------------- | | ------------------- | ------------ | ------------------------------------------------------------- |
| version | string | The installed supervisor version | | version | string | The installed supervisor version |
| version_latest | string | The latest published version in the active channel | | version_latest | string | The latest published version in the active channel |
| update_available | boolean | `true` if an update is available |
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) | | arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
| channel | string | The active channel (stable, beta, dev) | | channel | string | The active channel (stable, beta, dev) |
| timezone | string | The current timezone | | timezone | string | The current timezone |
@ -1893,7 +1911,7 @@ Returns information about the supervisor
| ip_address | string | The internal docker IP address to the supervisor | | ip_address | string | The internal docker IP address to the supervisor |
| wait_boot | int | Max time to wait during boot | | wait_boot | int | Max time to wait during boot |
| debug | bool | Debug is active | | debug | bool | Debug is active |
| debug_block | bool | `true` if debug block is enabled | | debug_block | bool | `true` if debug block is enabled |
| diagnostics | bool or null | Sending diagnostics is enabled | | diagnostics | bool or null | Sending diagnostics is enabled |
| addons | list | A list of installed [Addon models](api/supervisor/models.md#addon) | | addons | list | A list of installed [Addon models](api/supervisor/models.md#addon) |
| addons_repositories | list | A list of add-on repository URL's as strings | | addons_repositories | list | A list of add-on repository URL's as strings |
@ -1904,6 +1922,7 @@ Returns information about the supervisor
{ {
"version": "246", "version": "246",
"version_latest": "version_latest", "version_latest": "version_latest",
"update_available": true,
"arch": "amd64", "arch": "amd64",
"channel": "dev", "channel": "dev",
"timezone": "TIMEZONE", "timezone": "TIMEZONE",

28
docs/api/supervisor/models.md
View File

@ -6,19 +6,21 @@ These models are describing objects that are getting returned from the superviso
## Addon ## Addon
| key | type | description | | key | type | description |
| ----------- | ------- | ----------------------------------------------------- | | ---------------- | -------------- | ----------------------------------------------------- |
| name | string | The name of the add-on | | name | string | The name of the add-on |
| slug | string | The slug for the add-on | | slug | string | The slug for the add-on |
| advanced | boolean | `true` if it should only be visible to advanced users | | advanced | boolean | `true` if it should only be visible to advanced users |
| description | string | The description of the add-on | | description | string | The description of the add-on |
| repository | string | The repository the add-on came from | | repository | string | The repository the add-on came from |
| version | string | The latest published version of the add-on | | version | string or null | The installed version of the add-on |
| installed | string | The installed version of the add-on | | version_latest | string | The latest published version of the add-on |
| available | boolean | `false` if you can not install the add-on | | update_available | boolean | `true` if an update is available |
| icon | bool | The add-on has a icon file | | installed | string | `true` if the the add-on is installed |
| logo | bool | The add-on has a logo file | | available | boolean | `false` if you can not install the add-on |
| state | string | The state of the add-on (started, stopped) | | icon | bool | The add-on has a icon file |
| logo | bool | The add-on has a logo file |
| state | string | The state of the add-on (started, stopped) |
## Application ## Application