iGoX/busylight
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Wiki Activity

Update blink documentation

Browse Source
This commit is contained in:
iGoX
2026-04-24 14:53:27 +02:00
parent b0903c7610
commit bc062a0c13
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -3
View File
@@ -73,8 +73,8 @@ Or directly from **[busyLight-streamdeck-pluing](https://code.igox.org/iGoX/busy
| /api/status/busy | POST / GET | n/a | Set the BusyLight in `busy` mode. Red color. Return a `status` object. | | /api/status/busy | POST / GET | n/a | Set the BusyLight in `busy` mode. Red color. Return a `status` object. |
| /api/status/off | POST / GET | n/a | Shutdown the BusyLight. Return a `status` object. | | /api/status/off | POST / GET | n/a | Shutdown the BusyLight. Return a `status` object. |
| /api/status | GET | n/a | Retreive the current BusyLight status. Return a `status` object. | | /api/status | GET | n/a | Retreive the current BusyLight status. Return a `status` object. |
| /api/blink | POST | `blink` JSON object | Make the BusyLight blink. Preserves current color, status and brightness. Return a `status` object. | | /api/blink | POST | `blinkParam` JSON object | Make the BusyLight blink. Preserves current color, status and brightness. Return a `status` object. |
| /api/blink | GET | n/a | Retrieve the current BusyLight blink status. Return a `blink` object. | | /api/blink | GET | n/a | Retrieve the current BusyLight blink status. Return a `blinkStatus` object. |
| /api/blink/stop | POST | n/a | Stop the BusyLight blinking and restore previous state. Return a `status` object. | | /api/blink/stop | POST | n/a | Stop the BusyLight blinking and restore previous state. Return a `status` object. |
| /api/debug | GET | n/a | Retreive the full BusyLight status. | | /api/debug | GET | n/a | Retreive the full BusyLight status. |
@@ -106,7 +106,19 @@ Or directly from **[busyLight-streamdeck-pluing](https://code.igox.org/iGoX/busy
`brightness`: LED brightness | float | [0.0 .. 1.0] `brightness`: LED brightness | float | [0.0 .. 1.0]
### `blink` object ### `blinkParam` object
```json
{
"frequency": 2,
"duration": 5.0,
```
`frequency`: blink frequency | integer | Hz
`duration`: total blink duration | float | seconds | 0 = endless
### `blinkStatus` object
```json ```json
{ {