From 7a01aea2e2055fbe4bcbfdbbc214edd926f40f91 Mon Sep 17 00:00:00 2001 From: Mike Degatano Date: Fri, 6 Oct 2023 15:06:56 -0400 Subject: [PATCH] Document new endpoints for green board (#1905) --- docs/api/supervisor/endpoints.md | 48 ++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index 442a4f9d..cd8e3541 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -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 | + + + + + +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 +} +``` + + + + + +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 |