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-15 21:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move Supervisor API (#666)

Browse Source
This commit is contained in:
Joakim Sørensen 2020-10-09 14:38:40 +02:00 committed by GitHub
parent 6184eef85e
commit 828cf1f930
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 2477 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2204
docs/api/supervisor/endpoints.md Normal file
View File

File diff suppressed because it is too large Load Diff

47
docs/api/supervisor/examples.md Normal file
View File

@ -0,0 +1,47 @@
---
title: "Examples"
---
Examples on how to interface against the supervisor API.
## Get network information with cURL
```bash
curl -sSL -H "Authorization: Bearer $SUPERVISOR_TOKEN" http://supervisor/network/info
```
**response:**
```json
{
"result": "ok",
"data": {
"interfaces": {
"eth0": {
"ip_address": "192.168.1.100/24",
"gateway": "192.168.1.1",
"id": "Wired connection 1",
"type": "802-3-ethernet",
"nameservers": ["192.168.1.1"],
"method": "static",
"primary": true
}
}
}
}
```
## Ping the supervisor
```bash
curl -sSL http://supervisor/ping
```
**response:**
```json
{
"result": "ok",
"data": {}
}
```

166
docs/api/supervisor/models.md Normal file
View File

@ -0,0 +1,166 @@
---
title: "Models"
---
These models are describing objects that are getting returned from the supervisor API.
## Addon
| key | type | description |
| ----------- | ------- | ----------------------------------------------------- |
| name | string | The name of the add-on |
| slug | string | The slug for the add-on |
| advanced | boolean | `true` if it should only be visible to advanced users |
| description | string | The description of the add-on |
| repository | string | The repository the add-on came from |
| version | string | The latest published version of the add-on |
| installed | string | The installed version of the add-on |
| available | boolean | `false` if you can not install the add-on |
| 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
| key | type | description |
| ------------ | ------- | -------------------------------------- |
| name | string | The application name |
| index | int | TODO: What is this? |
| stream_index | int | TODO: What is this? |
| stream_type | string | The type of the stream (INPUT, OUTPUT) |
| volume | float | The current volume |
| mute | boolean | `true` if the application is muted |
| addon | string | The add-on slug |
## Audio
| key | type | description |
| ----------- | ---- | ----------------------------------------------- |
| card | list | A list of [Card models](#card) |
| input | list | A list of [Audio device models](#audio-device) |
| output | list | A list of [Output device models](#audio-device) |
| application | list | A list of [Application models](#application) |
## Audio device
| key | type | description |
| ------------ | ----------- | -------------------------------------------- |
| name | string | The descriptnameion of the device |
| index | int | TODO: What is this? |
| description | string | The description of the device |
| volume | float | The current volume |
| mute | string | `true` if the device is muted |
| default | string | `true` if the device is default |
| card | int or null | TODO: What is this? |
| applications | string | A list of [Application models](#application) |
## Audio profile
| key | type | description |
| ----------- | ------- | ------------------------------- |
| name | string | The name of the profile |
| description | string | The description of the profile |
| active | boolean | `true` if the profile is active |
## Card
| key | type | description |
| -------- | ------ | ------------------------------------------------ |
| name | string | The name of the card |
| index | int | TODO: What is this? |
| driver | string | The name of the card driver |
| profiles | list | A list of [Audio profile models](#audio-profile) |
## Discovery
| key | type | description |
| ------- | ------ | ------------------------- |
| addon | string | The add-on slug |
| service | string | The service name |
| uuid | string | The UUID of the discovery |
| config | dict | The configuration |
## Host Service
| key | type | description |
| ----------- | ------ | ----------------------- |
| name | string | The service name |
| description | string | The service description |
| state | string | The service state |
## Network interface
| key | type | description |
| ----------- | ------- | ---------------------------------------------------------------------------- |
| ip_address | string | The IP address and the netmask in a X.X.X.X/XX format. |
| gateway | string | The IP address of the gateway. |
| id | string | The ID of the interface. |
| type | string | The interface type. |
| nameservers | list | A list containing the IP addresses of the configured nameservers as strings. |
| method | string | The method used to set the IP can be "static" or "dhcp". |
| primary | boolean | `true` if it's the primary network interface. |
## Panel
| key | type | description |
| ------ | ------- | -------------------------------------- |
| enable | boolean | `true` if it's enabled |
| icon | string | The sidebar icon |
| title | string | The sidebar title |
| admin | boolean | `true` if it's for admin accounts only |
## Repository
| key | type | description |
| ---------- | -------------- | ------------------------------------- |
| slug | string | The repository slug |
| name | string | The name of the repository |
| source | string | The URL to the repository |
| url | string or null | URL for repository website |
| maintainer | string | The name of the repository maintainer |
## Service
| key | type | description |
| --------- | ------- | ----------------------------------- |
| slug | string | The service slug |
| available | boolean | `true` if the service is available |
| providers | list | A list of providers for the service |
## Snapshot
| key | type | description |
| --------- | ------- | --------------------------------------------------------------------- |
| slug | string | A generated slug for the snapshot |
| date | string | A ISO date string representation of the date the snapshot was created |
| name | string | The name given to the snapshot |
| type | string | The type of snapshot (full, partial) |
| protected | boolean | `true` if the snapshot is password protected |
## Snapshot details
| key | type | description |
| ------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| slug | string | A generated slug for the snapshot |
| type | string | The type of snapshot (full, partial) |
| name | string | The name given to the snapshot |
| date | string | A ISO date string representation of the date the snapshot was created |
| size | string | The size of the snapshot in MB |
| protected | boolean | `true` if the snapshot is password protected |
| homeassistant | string | The version of Home Assistant that was in use |
| addons | list | A list of add-ons in the snapshot, addons are represented as a dictionary with these keys [`slug`,`name`,`version`,`size`] |
| repositories | list | A list of add-on repository URL's as strings |
| folders | list | A list of strings representing directories |
## Stats
| key | type | description |
| -------------- | ----- | ----------------------------------------- |
| cpu_percent | float | The percentage of the CPU that is used |
| memory_usage | int | The current memory usage in bytes |
| memory_limit | int | The max allowed memory usage in bytes |
| memory_percent | float | The percentage of the memory that is used |
| network_tx | int | Network transmission usage |
| network_rx | int | Network receiver usage |
| blk_read | int | File system read usage |
| blk_write | int | File system write usage |

1
docusaurus.config.js
View File

@ -55,6 +55,7 @@ module.exports = {
items: [
{ label: "REST-API", to: "docs/api/rest" },
{ label: "WebSocket API", to: "docs/api/websocket" },
{ label: "Supervisor API", to: "docs/api/supervisor/endpoints" },
{
label: "Native App Integration",
to: "docs/api/native-app-integration",

9
sidebars.js
View File

@ -20,6 +20,15 @@ module.exports = {
API: [
"api/rest",
"api/websocket",
{
type: "category",
label: "Supervisor API",
items: [
"api/supervisor/endpoints",
"api/supervisor/models",
"api/supervisor/examples",
],
},
{
type: "category",
label: "Native App Integration",

50
src/css/custom.css
View File

@ -96,3 +96,53 @@ small {
html[data-theme='dark'] .invertDark {
filter: invert(1.0)
}
/* Custom summary styles for API endpoint definitions */
summary.endpoint {
align-items: center;
background-color: var(--ifm-code-background);
word-break: break-all;
border-radius: var(--ifm-code-border-radius);
color: var(--ifm-code-color);
cursor: pointer;
display: flex;
font-family: var(--ifm-font-family-monospace);
margin: 4px 0;
padding: var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal);
}
summary.endpoint::-webkit-details-marker {
display: none;
}
summary.endpoint:before {
border-radius: 8px;
color: white;
display: block;
font-weight: bold;
margin-right: 12px;
padding: 4px;
text-align: center;
width: 75px;
}
summary.endpoint.post:before {
content: "POST";
background-color: var(--ifm-color-success);
}
summary.endpoint.get:before {
content: "GET";
background-color: var(--ifm-color-info);
}
summary.endpoint.delete:before {
content: "DELETE";
background-color: var(--ifm-color-danger)
}
summary.endpoint.protected:after {
content: "🔒";
margin: auto;
margin-right: 0;
}
summary.endpoint.unprotected:after {
content: "🔓";
margin: auto;
margin-right: 0;
}
/* Custom summary styles for API endpoint definitions */