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-24 01:36:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document new endpoints for green board (#1905)

Browse Source
This commit is contained in:
Mike Degatano 2023-10-06 15:06:56 -04:00 committed by GitHub
parent a866f21133
commit 7a01aea2e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2289,11 +2289,49 @@ 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 |
| key | type | description |
| ------------- | ------- | ---------------------------------|
| disk_led | boolean | Enable/disable the disk LED |
| heartbeat_led | boolean | Enable/disable the heartbeat LED |
| power_led | boolean | Enable/disable the power LED |
</ApiEndpoint>
<ApiEndpoint path="/os/boards/green" method="get">
If running on a green board, returns current values for its settings.
**Returned data:**
| key | type | description |
| ----------------- | ------- | --------------------------------------- |
| activity_led | boolean | Is the green activity LED enabled |
| power_led | boolean | Is the white power LED enabled |
| system_health_led | boolean | Is the yellow system health LED enabled |
**Example response:**
```json
{
"activity_led": true,
"power_led": true,
"system_health_led": false
}
```
</ApiEndpoint>
<ApiEndpoint path="/os/boards/green" method="post">
If running on a green board, changes one or more of its settings.
**Payload:**
| key | type | description |
| ----------------- | ------- | ------------------------------------------- |
| activity_led | boolean | Enable/disable the green activity LED |
| power_led | boolean | Enable/disable the white power LED |
| system_health_led | boolean | Enable/disable the yellow system health LED |
</ApiEndpoint>