Deprecated page

This commit is contained in:
Christian Schwinne 2021-09-11 11:23:07 +02:00
parent 7cc847381c
commit 3f0e6a5fc6

View file

@ -1,99 +1,3 @@
_Note: this page is now out of date, see updated functionality in the code ([udp.cpp](https://github.com/Aircoookie/WLED/blob/master/wled00/udp.cpp))_
Please see https://kno.wled.ge/interfaces/udp-notifier/ for this information.
### Usage
The UDP notifier function of WLED makes it easy to sync multiple lights to the same color/effect, enabled by default.
You can set the specific behavior of it in Sync settings, also you can choose if all aspects or only brightness/color/effects are applied.
Additionally, there is a "Sync" quick toggle for it in the main control UI!
In UI settings, you can set whether this button only turns on/off sending (default) or also receiving, with the option `Sync button toggles both send and receive`.
If your sync settings are not the way you like on boot, check the `WLED Broadcast` section in Sync settings, where you can specify what is sent and received by default:
#### Receiving settings
| Setting | Description |
| --- | --- |
Receive Brightness | If there is a sync notification, whether its brightness should be applied
Color | Whether the color of the synced device should be applied
Effects | Whether the effect settings should be applied
If all checkboxes are disabled, nothing is received by default after each boot. If the sync is toggled on in the main UI _and_ the corresponding checkbox in UI settings is checked, everything is received.
A sync receiver will not assume the state of the last sender directly after booting, a new packet must be send for it to react.
#### Sending settings
| Setting | Description |
| --- | --- |
Send on direct change | Whether to send a sync notification when state changed via the web UI or API
Send on button press | Whether to send sync when toggled by the physical hardware button
Send Alexa notifications | Whether to send sync after changed by Alexa (you may use Alexa groups instead)
Send Hue notifications | Whether to send sync after a connected Philips light changed
Send Macro notifications | Whether to send sync after a macro was triggered
Send notifications twice | Sends notifications twice (if you have issues with UDP packet loss)
The quick toggle in the main UI will only apply to direct changes (UI + API), all other sync type sending behavior remains unaffected.
You can easily group WLED devices (for example all in one room) by changing the UDP port of all devices you want in that group.
### Protocol description
When enabled, the module where a value was changed will send an UDP broadcast to a port (default 21324).
Other modules that listen on this port will set themselves to the same color.
For interoperability, the protocol was designed so that even modules with different WLED versions can sync.
Therefore, if a WLED 0.4 system receives a WLED 0.3 UDP notification it will apply the primary color but keep its current secondary color.
The UDP packet is currently 24 bytes long. It is laid out in the following:
Byte Index | Var Name | Description | Notifier Version
| --- | --- | --- | --- |
0 | \- | Packet Purpose Byte* | 0
1 | callMode | Packet Reason** | 0
2 | bri | Master Brightness | 0
3 | col[0] | Primary Red Value | 0
4 | col[1] | Primary Green Value | 0
5 | col[2] | Primary Blue Value | 0
6 | nightlightActive | Nightlight running? | 0
7 | nightlightDelayMins | Nightlight Time | 0
8 | effectCurrent | Effect Index | 0
9 | effectSpeed | Effect Speed | 0
10 | white | Primary White Value | 1
11 | \- | Version Byte*** | 1
12 | colSec[0] | Secondary Red Value | 2
13 | colSec[1] | Secondary Green Value | 2
14 | colSec[2] | Secondary Blue Value | 2
15 | whiteSec | Secondary White Value | 2
16 | effectIntensity | Effect Intensity | 3
17 | transitionDelay | Transition Duration Upper | 4
18 | transitionDelay | Transition Duration Lower | 4
19 | effectPalette | FastLED palette | 5
20-23 | - | Zeros | -
*The notifier protocol is only used if this byte is 0. Otherwise, one of the [UDP Realtime](https://github.com/Aircoookie/WLED/wiki/UDP-Realtime-Control) protocols will be used.
**The callMode variable specifies the reason for the notification.
Every color update has the potential to trigger a notification.
callMode | Description | Behavior
| --- | --- | --- |
0 | Initial Boot | Do not notify
1 | Direct Change via UI or API | notifyDirect?
2 | Button was pressed | notifyButton?
3 | Update by other notification | Do not notify
4 | Nightlight activated | notifyDirect?
5 | Other (Req. with &NN) | Do not notify
6 | Effect changed | notifyDirect?
7 | Hue light changed | notifyHue?
8 | Preset Cycle active | notifyDirect?
9 | Updated via Blynk | notifyDirect?
***This is the version of the UDP protocol.
UDP Version | Description | WLED Version
| --- | --- | --- |
0 | Basic Support | 0.3
1 | White Value supported | 0.4p
2 | Secondary Color supported | 0.4
3 | Effect Intensity supported | 0.5.0
4 | Transition Time supported | 0.6.0
5 | Palettes supported | 0.8.0
This wiki is now deprecated. Please consider contributing to kno.wled.ge by making improvements as a pull request. Thank you!