Updated UDP Realtime Control (markdown)

This commit is contained in:
Aircoookie 2018-11-01 00:15:13 +01:00
parent bd83872038
commit 02fec9c35f
1 changed files with 29 additions and 1 deletions

View File

@ -1,7 +1,21 @@
### E1.31
WLED supports the E1.31 (sACN) realtime light protocol.
I highly recommend the [LedFx](https://github.com/ahodges9/LedFx) project!
170 LEDs (510 DMX channels) are supported per universe.
You can use up to 5 adjacent universes which is a total of 850 LEDs.
LedFx users: If you want to use more than 170 LEDs, you need to go to additional settings and set "Universe Size" to 510!
### Hyperion
You can now use WLED with the popular Ambilight software Hyperion.
Just configure Hyperion to use an UDP device with protocol 0 on port 19446!
The maximum number of LEDs supported in this mode is 480. (WLED 0.8.0 and lower: 341)
### UDP Realtime
Additionally, WLED offers a way to directly drive the connected LEDs via UDP. The protocol is referred to as WLED [Audio-Reactive-Led-Strip](https://github.com/scottlawsonbc/audio-reactive-led-strip) (WARLS), since the support of that project was its primary goal. However, it can also be used for other realtime applications like an ambilight.
The maximum number of LEDs supported in these modes is 480. (WLED 0.8.0 and lower: 341)
WARLS uses the same UDP port the notifier uses (default 21324, can be changed in settings).
At the moment, the web UI will be disabled while active, the HTTP API, Alexa and button control remains functional.
@ -14,6 +28,7 @@ Value | Description
1 | WARLS
2 | DRGB
3 | DRGBW
4 | DNRGB
0 | WLED Notifier
In every protocol, Byte 1 tells the server how many seconds to wait after the last received packet before returning to normal mode, in practice you should use 1-2 (seconds) here in most cases so that the module returns to normal mode quickly after the end of transmission.
@ -48,7 +63,20 @@ Byte | Description
4 + n*4 | Blue Value
5 + n*4 | White Value
When WARLS mode starts, all LEDs will be black. However, you don't have to change all LEDs using one packet.
DNRGB:
DRGB, but with 2 additional bytes that signify the starting LED index.
This allows for more than 480 LEDs in realtime mode by sending multiple packets.
Byte | Description
--- | ---
2 | Start index high byte
3 | Start index low byte
4 + n*3 | Red Value
5 + n*3 | Green Value
6 + n*3 | Blue Value
When realtime mode starts, all LEDs will be black. However, you don't have to change all LEDs using one packet.
Changing a single LED therefore only requires a packet of 2+4 bytes. All LEDs maintain their color until it is changed or the module exits WARLS mode because of a timeout.
### Setup with ARLS