BusyLight Buddy - update supported platforms (#12 )

Reviewed-on: #12
Rework status object (#11 )
2026-04-24 18:16:40 +02:00 · 2026-04-24 17:42:40 +02:00 · 2026-04-24 15:09:36 +02:00 · 2026-04-24 14:53:42 +02:00 · 2026-03-26 11:08:55 +01:00 · 2026-03-26 11:04:44 +01:00
15 changed files with 125 additions and 27 deletions
@@ -165,7 +165,7 @@ class LedController:
    async def stop(self):
        await self.sendCommand({"type": "off"})

-    def get_state(self):
+    def getStatus(self):
        if self.blinking and self.blinkDuration > 0:
            elapsed = time.ticks_diff(time.ticks_ms(), self.blinkStart) / 1000
            remains = max(0.0, self.blinkDuration - elapsed)
@@ -258,7 +258,16 @@ async def setColor(request):
    await led.set_color((r, g, b), brightness)
    status = await led.get_status()

-    return {'status': status}
+    state = led.getStatus()
+    return {'status': state["status"], 
+            'color': state["color"], 
+            'brightness': state["brightness"], 
+            'isblinking': state["isblinking"], 
+            'blinkParameters': {
+                'frequency': state["frequency"], 
+                'duration': state["duration"], 
+                'remains': state["remains"]} 
+            }


@app.get('/api/color')
@@ -270,7 +279,16 @@ async def getColor(request):
@app.get('/api/status')
 async def getStatus(request):
    status = await led.get_status()
-    return {'status': status}
+    state = led.getStatus()
+    return {'status': state["status"], 
+            'color': state["color"], 
+            'brightness': state["brightness"], 
+            'isblinking': state["isblinking"], 
+            'blinkParameters': {
+                'frequency': state["frequency"], 
+                'duration': state["duration"], 
+                'remains': state["remains"]} 
+            }


@app.route('/api/status/<status>', methods=['GET', 'POST'])
@@ -281,7 +299,16 @@ async def setStatus(request, status):
        return {'error': 'unknown status'}, 404

    status = await led.get_status()
-    return {'status': status}
+    state = led.getStatus()
+    return {'status': state["status"], 
+            'color': state["color"], 
+            'brightness': state["brightness"], 
+            'isblinking': state["isblinking"], 
+            'blinkParameters': {
+                'frequency': state["frequency"], 
+                'duration': state["duration"], 
+                'remains': state["remains"]} 
+            }


@app.post('/api/blink')
@@ -300,12 +327,21 @@ async def setBlink(request):

    await led.blink(freq, duration)

-    return {'status': 'blinking', 'frequency': freq, 'duration': duration}
+    state = led.getStatus()
+    return {'status': state["status"], 
+            'color': state["color"], 
+            'brightness': state["brightness"], 
+            'isblinking': state["isblinking"], 
+            'blinkParameters': {
+                'frequency': state["frequency"], 
+                'duration': state["duration"], 
+                'remains': state["remains"]} 
+            }


@app.get('/api/blink')
-async def getBlink(request):
-    state = led.get_state()
+async def getBlinkStatus(request):
+    state = led.getStatus()
    return {
        'isblinking': state["isblinking"],
        'frequency': state["frequency"],
@@ -319,7 +355,16 @@ async def blinkStop(request):
    await led.stop()
    await led.set_status(led.previousStatus)
    status = await led.get_status()
-    return {'status': status}
+    state = led.getStatus()
+    return {'status': state["status"], 
+            'color': state["color"], 
+            'brightness': state["brightness"], 
+            'isblinking': state["isblinking"], 
+            'blinkParameters': {
+                'frequency': state["frequency"], 
+                'duration': state["duration"], 
+                'remains': state["remains"]} 
+            }


@app.get('/api/debug')
@@ -352,7 +397,16 @@ async def mutedeckWebhook(request):
    else:
        await led.set_status('available')

-    return {'status': led.status}
+    state = led.getStatus()
+    return {'status': state["status"], 
+            'color': state["color"], 
+            'brightness': state["brightness"], 
+            'isblinking': state["isblinking"], 
+            'blinkParameters': {
+                'frequency': state["frequency"], 
+                'duration': state["duration"], 
+                'remains': state["remains"]} 
+            }


@app.post('/shutdown')
@@ -21,8 +21,12 @@ A cheap, simple to build, nice looking and portable DIY **Busy Light**.
 It comes with a with a simplistic but neat **Web UI** and a simple (but hopefully convenient) **Rest API**.

 | Controlled by Stream Deck with REST API                       | Light roll                                        |
-| --- | --- |
-| ![busylight and stream deck](img/busylight.jpg) | ![busylight roll](img/busylight.gif) |
+| ------------------------------------------------------------- | ------------------------------------------------- |
+| ![busylight and stream deck](resources/images/busylight.jpg)  | ![busylight roll](resources/images/busylight.gif) |
+
+---
+
+![show case](resources/videos/busylight-showoff.webp)

 # Web UI

@@ -33,23 +37,25 @@ You can try to reach the web UI @ <http://igox-busylight.local>.

 | What an neat UI ! 😄 |
 | --- |
-| ![Web UI](img/web-ui.png) |
+| ![Web UI](resources/images/web-ui.png) |

 # BusyLight Buddy companion app

 [BusyLight Buddy](https://code.igox.org/iGoX/busylight-buddy) is a free, open-source multiplatform companion app to control your BusyLight from your phone or computer — no browser needed.

-Available for **iOS**, **iPadOS**, **Android**, **macOS**, and **Windows**.
+Available for **Android**, **macOS** and **Windows**.

 It features quick status presets, a custom color picker with saveable presets, a brightness slider, and background polling to keep the UI in sync with the device.

+![busylight-buddy-screenshot](resources/images/buddy-ios-screenshot-main.png)
+
 # Stream Deck plug-in

-You can download a Stream Deck plugin to control your BusyLight:
+You can download the Stream Deck plugin to control your BusyLight:

-[![marketplace button](img/streamdeck-plugin-get-it-on-marketplace.svg)](https://marketplace.elgato.com/product/igox-busylight-7448a0be-6dd6-4711-ba0d-86c52b9075b9)
+[![marketplace button](resources/images/streamdeck-plugin-get-it-on-marketplace.svg)](https://marketplace.elgato.com/product/igox-busylight-7448a0be-6dd6-4711-ba0d-86c52b9075b9)

-Or directly from [BusyLight Stream Deck pluing](https://code.igox.org/iGoX/busylight-streamdeck-plugin) repository.
+Or directly from **[busyLight-streamdeck-pluing](https://code.igox.org/iGoX/busylight-streamdeck-plugin)** repository.

 # BusyLight API

@@ -67,8 +73,8 @@ Or directly from [BusyLight Stream Deck pluing](https://code.igox.org/iGoX/busyl
 | /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 | 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 | GET | n/a | Retrieve the current BusyLight blink status. Return a `blink` 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 `blinkStatus` 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. |

@@ -100,7 +106,19 @@ Or directly from [BusyLight Stream Deck pluing](https://code.igox.org/iGoX/busyl

 `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
 {
@@ -120,11 +138,37 @@ Or directly from [BusyLight Stream Deck pluing](https://code.igox.org/iGoX/busyl

 ```json
 {
-  "status": "<STATUS>"
+  "status": "<STATUS>",
+  "color": {
+    "r": 255,
+    "g": 0,
+    "b": 110
+  },
+  "brightness": 0.1
+  "isBlinkning": false,
+  "blinkParameters": {
+    "frequency": 2,
+    "duration": 5.0,
+    "remains": 3.2
+  }
 }
 ```

-`<STATUS>` : `on` | `off` | `available` | `away` | `busy` | `colored` | `blinking`
+`<STATUS>` : `on` | `off` | `available` | `away` | `busy` | `colored`
+
+`color`: 
+- `r`: RED color | integer | [0 .. 255]  
+- `g`: GREEN color | integer | [0 .. 255]  
+- `b`: BLUE color | integer | [0 .. 255]  
+
+`brightness`: LED brightness (optional) | float | [0.0 .. 1.0]
+
+`isblinking`: whether the BusyLight is currently blinking | boolean  
+
+`blinkParameters`
+- `frequency`: blink frequency | integer | Hz  
+- `duration`: total blink duration | float | seconds | 0 = endless  
+- `remains`: remaining blink time | float | seconds | 0 if endless  

 # MuteDeck integration

@@ -139,7 +183,7 @@ It will automatically switch to the BusyLight in:

 | MuteDeck Configuration |
 | --- |
-| ![MuteDeck config](img/mutedeck-webhook-conf.png) |
+| ![MuteDeck config](resources/images/mutedeck-webhook-conf.png) |

 # Electronic parts

@@ -158,7 +202,7 @@ It will automatically switch to the BusyLight in:

 | Tools > Manage plug-ins | lib selection |
 | --- | --- |
-| ![lib-menu](img/lib-menu.png) | ![lib-install](img/lib-install.png) |
+| ![lib-menu](resources/images/lib-menu.png) | ![lib-install](resources/images/lib-install.png) |

 > ⚠️ **Compatibility note:** MicroPython v1.27 is **not compatible** with Microdot due to breaking changes in the underlying ESP-IDF v5.5. Use MicroPython **v1.24.1** with Microdot **v2.0.6**.

@@ -166,7 +210,7 @@ It will automatically switch to the BusyLight in:

 **(4)** Copy the content of [ESP32](ESP32) folder with the modified `boot.py` file to the root of your ESP32 file system. Again, can easily be done using [Thonny](https://thonny.org):

-![file-copy](img/file-copy.png)
+![file-copy](resources/images/file-copy.png)

 **Done!**

@@ -178,7 +222,7 @@ All the required 3D files (STLs and f3d project) to 3D print the enclosure are a

 # Wiring / Soldering

-![wiring-soldering](img/wiring-soldering.png)
+![wiring-soldering](resources/images/wiring-soldering.png)

 You can see a final assembly image [here](3D-files-to-print/README.md).

@@ -194,7 +238,7 @@ You can see a final assembly image [here](3D-files-to-print/README.md).

 ## Microdot

-<https://microdot.readthedocs.io/en/latest/index.html>
+<https://microdot.readthedocs.io>

 ## JSColor
Author	SHA1	Message	Date
iGoX	f64ceeb477	BusyLight Buddy - update supported platforms (#12 ) Reviewed-on: #12	2026-04-24 18:16:40 +02:00
iGoX	4efb3ad581	Rework status object (#11 ) Co-authored-by: Copilot <copilot@github.com> Reviewed-on: #11	2026-04-24 17:42:40 +02:00
iGoX	60d179cf4a	POST /api/blink - Fix call return (#10 ) Reviewed-on: #10	2026-04-24 15:09:36 +02:00
iGoX	f2da89b184	Update blink documentation (#9 ) Reviewed-on: #9	2026-04-24 14:53:42 +02:00
iGoX	b0903c7610	Rework README.md (#8 ) Reviewed-on: #8	2026-03-26 11:08:55 +01:00
iGoX	1a3bec9e85	Migrate Stream Deck plugin to its own repository (#7 ) Migrate Stream Deck plugin to its own repository: - https://code.igox.org/iGoX/busylight-streamdeck-plugin Reviewed-on: #7	2026-03-26 11:04:44 +01:00