WLED/usermods/boblight
Will Miles 4f48ddfaec Replace SET_F with F in usermods
Since oappend() is now strongly typed, pass the correct type.  This is a
step towards removing the extra shim logic on ESP8266.
2024-10-23 21:35:30 -04:00
..
boblight.h Replace SET_F with F in usermods 2024-10-23 21:35:30 -04:00
readme.md

readme.md

BobLight usermod

This usermod allows displaying BobLight ambilight protocol on WLED device with a limited command set (not a full implementation). BobLight protocol uses a TCP connection which guarantees packet delivery at the possible expense of latency delays. It is not very efficient (as it uses plaintext comands) so is not suited for large number of LEDs.

This implementation is intended for TV backlight in combination with XBMC/Kodi BobLight add-on.

The LEDs can be configured in usermod settings page. The configuration is simple: you enter the number of LED pixels on each side of your TV (top, right, bottom, left). The LEDs should be wired in a clockwise orientation starting in the middle of bottom side (left half of bottom leds is where the string should start).

+-------->-------+
|                |
^                v
|                |
+---<--+  ---<---+
       ^
     start

Installation

Add -D USERMOD_BOBLIGHT to your PlatformIO environment. If you are not using PlatformIO (which you should) try adding #define USERMOD_BOBLIGHT to my_config.h.

Configuration

All parameters are runtime configurable though changing port may require reboot.

If you want to define default port during compile time use the following (default values in parentheses):

  • BOB_PORT=x : defines default TCP port for usermod to listen on (19333)

Release notes

2022-11 Initial implementation by @blazoncek (AKA Blaz Kristan)