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-21 16:26:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document /os/boards/{board} endpoints (#1526)

Browse Source 
* Document `/os/boards/{board}` endpoints

* Missed closing tag
This commit is contained in:
Mike Degatano 2022-11-08 03:29:13 -05:00 committed by GitHub
parent 36fb0e2985
commit f2fd582ba1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2086,6 +2086,54 @@ Move datadisk to a new location, **This will also reboot the device!**
</ApiEndpoint>
<ApiEndpoint path="/os/boards/{board}" method="get">
Returns information about your board if it has features or settings
that can be modified from Home Assistant. The value for `board`
is the value in the `board` field returned by `/os/info`.
Boards with such options are documented below.
</ApiEndpoint>
<ApiEndpoint path="/os/boards/yellow" method="get">
If running on a yellow board, returns current values for its settings.
**Returned data:**
| key | type | description |
| ------------- | ------- | ---------------------------- |
| disk_led | boolean | Is the disk LED enabled |
| heartbeat_led | boolean | Is the heartbeat LED enabled |
| power_led | boolean | Is the power LED enabled |
**Example response:**
```json
{
"disk_led": true,
"heartbeat_led": true,
"power_led": false
}
```
</ApiEndpoint>
<ApiEndpoint path="/os/boards/yellow" method="post">
If running on a yellow board, changes one or more of its settings.
**Payload:**
| key | type | description |
| ------------- | ------- | ---------------------------------------- |
| disk_led | boolean | Enable/disable disk LED enabled |
| heartbeat_led | boolean | Enable/disable the heartbeat LED enabled |
| power_led | boolean | Enable/disable the power LED enabled |
</ApiEndpoint>
### Resolution
<ApiEndpoint path="/resolution/info" method="get">