WLED

<< Click to Display Table of Contents >>

Navigation:  Components > Driver >

WLED

The WLED driver provides full integration of a WLED controller into an EisBär project.
By integrating WLED into EisBär, the device can be controlled directly via KNX, BACnet, Modbus, or any other supported automation protocol, allowing WLED to be used like any standard lighting element within the building automation system.

All relevant control and status functions of the device are exposed through structured inputs and outputs, including brightness, colors, effects, segment configurations, nightlight mode, device information, Wi-Fi diagnostics, and system status values.

Communication is handled through the WLED JSON API.
When available, the driver uses WebSockets for real-time updates; otherwise, communication falls back to HTTP polling. The number of segments is defined in the component properties, and the corresponding data points are generated automatically.

No additional hardware is required — EisBär communicates directly with the WLED device.

 

Data points of the component

The following tables list all data points exposed by the WLED driver. They are grouped into functional folders that mirror the structure of the WLED JSON API. Each entry includes the data point name, its type (Input, Output, Bidirectional, Folder), and a functional description.

 

Name

Typ

Funktion

Diagnosis  [Text]

Output

Provides readable diagnostic messages for monitoring.

Effects

Output

List of available lighting effects.

Extended Diagnosis

Input

An ON signal is used to extend the diagnostic output.

Palettes [Text]

Output

List of available color palettes.

Driver On/Off

Bidirectional

Enables or disables the internal communication between EisBär and the WLED device.

 

 

Dateisystem

Name

Typ

Funktion

Used Memory (KB)

Output

Indicates how much memory is used by WLED.

Total Memory (KB)

Output

Total available onboard memory.

PMT Value

Output

Internal diagnostic parameter for system monitoring.

 

Info

Name

Typ

Funktion

Architecture

Output

Identifies the hardware architecture.

User Palettes

Output

Number of saved user palettes.

Uptime (Seconds)

Output

Time since last reboot.

Build-ID

Output

Internal firmware build identifier.

CPU Frequency (MHz)

Output

Processor frequency.

Filesystem

Output

Type or status of filesystem.

Effect Count

Output

Number of available effects.

ESP-Core-Version

Output

Underlying ESP firmware version.

Firmware-Version

Output

Firmware version of WLED.

Flash Size

Output

Size of the flash memory.

Free Heap

Output

Amount of available RAM.

Device name

Output

Name of the device.

IP Address

Output

Current IP address.

Node Count

Output

Number of configuration nodes.

LED Configuration

Output

Description of LED hardware configuration.

LED Mappings

Output

Information about pixel mapping.

LED Strip Valid

Output

Indicates if the LED strip is correctly detected.

Live IP Address

Output

IP of the live data source.

Live Mode

Output

Current live mode.

Live Mode Active

Output

Indicates active live data processing

Live Segment

Output

Segment used for live streaming.

LWIP Version

Output

Version of the network stack.

MAC Address

Output

WiFi MAC address.

Brand

Output

Device brand.

Release Identifier

Output

UI release version.

UDP Port

Output

Port used for UDP live receiving.

UserMod Data

Output

Data from WLED user modifications.

Web UI Version

Output

Version of the device web interface.

WebSocket Clients

Output

Number of connected clients.

WiFi Information

Output

Formatted WiFi status string.

 

Leds

Name

Typ

Funktion

Active Segments

Output

Number of active LED segments.

Boot Preset

Output

Preset loaded at device startup.

Color Temperature (CCT)

Output

White color temperature.

FPS

Output

Frames per second.

Estimated Power

Output

Estimated LED power usage.

LED Count

Output

Total number of LEDs.

Maximum Power

Output

Maximum allowed power level.

Maximum Segments

Output

Maximum number of supported segments.

RGBW Mode

Output

Whether RGBW mode is enabled.

Segment Load

Output

Internal representation of segment usage.

White Value

Output

Current white channel value.

 

Live

Name

Typ

Funktion

Live Mode

Bidirectional

Enables/disables live data override.

Live Segment

Bidirectional

Defines which segment receives live data.

 

Nightlight

Name

Typ

Funktion

Active

Bidirectional

Turns nightlight mode on/off.

Duration

Bidirectional

Nightlight duration in seconds.

Fade

Bidirectional

Enables fade transition.

Mode

Bidirectional

Nightlight operating mode.

Target Brightness

Bidirectional

Brightness at the end of nightlight mode.

 

Segment

Segment 0 (sample segment)

Name

Typ

Funktion

2D Mapping

Bidirectional

Mapping mode for 2D layouts.

Spacing

Bidirectional

Pixel spacing for effect structure.

Selected

Bidirectional

Marks the segment as selected.

Effect Speed

Bidirectional

Speed of the running effect.

Effect ID

Bidirectional


Effect Intensity

Bidirectional

Intensity of the effect.

Effektparameter 1-3

Bidirectional

Effektabhängige Zusatzparameter. Ermöglichen Feineinstellungen wie Mustergröße, Farbvariation oder Partikeldichte.

Load Effect Defaults

Input

Loads default settings of the current effect.

End Pixel

Bidirectional

End index of the segment.

Color (primär)

Bidirectional

Primärfarbe des Segments (RGB).

Color (sekundär)

Bidirectional

Zweite Farbe – z. B. für Verläufe, Animationen, Überblendungen.

Color (tertiär)

Bidirectional

Dritte Farbe – unterstützt komplexe Effekte oder Dreifarbsequenzen.

Palette

Bidirectional

Auswahl einer Farbpalette zur Steuerung des aktiven Effekts.

Farbtemperatur

Bidirectional

Weißpunkt des Segments.

Grouping

Bidirectional

Enables LED grouping.

Klangsimulation

Input

Aktiviert soundbezogene Animationseffekte (falls unterstützt).

Length

Output

Length of the pixel range.

Offset

Bidirectional

Pixel offset for the mapping.

Segment On/Off

Bidirectional

Activates/deactivates the segment.

Segment Frozen

Bidirectional

Freezes animation updates.

Segment Brightness

Bidirectional

Brightness of this segment.

Segment ID

Output

Identifier number of the segment.

Set Grouping

Bidirectional

Enables LED grouping.

Mirror

Bidirectional

Mirrors the animation horizontally.

Mirror Y

Bidirectional

Mirrors the animation vertically.

Start Y

Bidirectional

2D start Y coordinate.

Start Pixel

Bidirectional

Start index of the segment.

Stop Y

Bidirectional

2D stop Y coordinate.

Transpose

Input

Swaps X/Y mapping.

Reverse

Input

Reverses animation direction.

Reverse Y

Input

Reverses animation along Y axis.

Repeat

Input

Repeats the effect pattern.

 

Status

Name

Typ

Funktion

Segment Count

Bidirectional

Returns or sets the number of LED segments currently defined on the WLED device. A segment is a user-defined LED range (e.g., LEDs 0–50 as Segment 0). The count changes dynamically when segments are created, removed, or reconfigured. EisBär reads this value to automatically create segment-related datapoints. When written, WLED may attempt to update segment structures (only supported in certain build contexts).

On/Off

 

Bidirectional

Turns the entire WLED system on or off and returns the current state. “On” enables output on all active segments, while “Off” disables all LED output regardless of effect or brightness settings. This corresponds to the JSON key state.on.

Color Temperature

 

Bidirectional

Sets or reads the color temperature (0–255), used in CCT mode or with dual-white LED strips. Lower values represent warm white, higher values cold white. The value applies to all segments that support CCT. Corresponds to state.seg[x].cct in the JSON API.

Main Segment

 

Bidirectional

Defines or reports which LED segment is treated as the “main” segment. Global operations like live mode, color changes, and effect settings use the main segment unless specified otherwise. Only one main segment can be active at a time. Corresponds to state.mainseg.

Brightness

 

Bidirectional

Sets or reads the global WLED brightness (0–255). This affects all segments equally without modifying internal effect parameters. A value of 0 does not turn off the device; it only dims all LEDs. Corresponds to state.bri.

Overlay Routing

Bidirectional

Enables or reports overlay routing functions. This is used primarily in special builds such as Audio Reactive WLED, where external inputs (e.g., audio data) can be blended with the LED output. Corresponds to state.lor.

Playlist

Bidirectional

Sets or reads the active playlist ID. A playlist consists of multiple presets, each with individual hold times, transition durations, repeat counts, and behavior instructions. Corresponds to state.pl in the JSON API.

Preset

Bidirectional

Activates or reports the currently active preset. Presets store full device configurations including colors, palettes, effects, speeds, intensities, segment definitions, and transitions. Corresponds to state.ps.

Preset Cycle

 

Bidirectional

Enables or configures automatic switching between presets. When set to a value >0, WLED moves to the next preset after the defined interval. Used together with preset cycle time or playlists.

Preset Cycle Time

 

Bidirectional

Sets or reads the interval (in seconds) after which a preset switch occurs when preset cycling is enabled. This is used when no playlist is active but automated preset rotation is desired.

Transition Time

 

Bidirectional

Sets or reads the transition duration (fade time) between color changes, effect changes, or preset changes. The value is specified in milliseconds. WLED interpolates effect parameters smoothly over this period. Corresponds to state.transition.

 

Udpn

Name

Typ

Funktion

Receive Active

Bidirectional

Enables or disables receiving UDP synchronization packets. When active, the device responds to broadcast or group-based commands from other WLED instances. Corresponds to JSON key udpn.recv

Receive Group

Bidirectional

Defines the UDP group from which the device will accept synchronization signals. Devices sharing the same receive group (rgrp) process each other’s UDP messages. Corresponds to udpn.rgrp.

Send Active

Bidirectional

Enables or disables sending UDP synchronization packets to other WLED devices. Used to broadcast effects, colors, presets, or live data. Corresponds to udpn.send.

Send Group

Bidirectional

Specifies the UDP group to which the device will send its synchronization packets. Devices sharing the same send group (sgrp) receive commands from this unit. Corresponds to udpn.sgrp.

 

Wifi

Name

Typ

Funktion

Access-Point-Mode

Output

Indicates whether the WLED device is currently operating in access-point mode (wifi.ap = true). In AP mode, the device creates its own WiFi network and is not connected to an external WLAN. Values: On = AP active, Off = normal WiFi station mode.

BSSID

Output

Returns the MAC address of the WiFi access point the device is connected to. Useful for network diagnostics and mesh networks. Corresponds to wifi.bssid.

Signal Quality (%)

 

Output

Shows the estimated WiFi signal quality in percent. This is a simplified value derived from RSSI and used for a quick assessment of connection strength. Corresponds to wifi.signal.

Channel

Output

Indicates the current WiFi channel (1–13) used by the connected network. Corresponds to wifi.channel.

Signal Strength (RSSI)

 

Output

Returns the actual WiFi signal strength in dBm. Example: –50 dBm = strong, –80 dBm = weak. This is the technical measurement used in networking. Corresponds to wifi.rssi.

 

Properties of the component

Name

Standard

Funktion

IP-Adresse

 

IP-Adresse of the WLED controller

Timeout [s]

5

Adjustable timeout for establishing a connection in seconds

Polling instead of Websockets

 

Enable to use polling instead of asynchronous WebSocket status updates (only enable if problems occur)

Status Polling Interval [s]

1

Dynamisches Status-Polling Intervall

Quasi-static polling interval [s]

5

Quasi-static polling interval for values that do not change frequently

Segments

4

Number of defined segments

Driver On/Off

 

The driver switches on or off.

 

Addendum: Using ColorShow with WLED (RGBW)

ColorShow is an external color source within EisBär and generates RGBW color values (4 bytes).
These values can be transferred via EisBär data points to the color parameters of a WLED segment to control effects and animations.

Supported WLED color slots:

•Primary color

•Secondary color

•Tertiary color

 

1. One ColorShow per color slot

A ColorShow always produces exactly one RGBW color value.
WLED segments can use up to three colors simultaneously (Primary, Secondary, Tertiary).

Therefore:
A separate ColorShow component must be used for each color slot.
 

Example:

WLED Color Slot

EisBär Connection

ColorShow

Primary Color

Segment 0 → Primary Color

ColorShow 1

Secondary Color

Segment 0 → Secondary Color

ColorShow 2

Tertiary Color

Segment 0 → Tertiary Color

ColorShow 3

This allows multiple color layers of an effect to be controlled independently from EisBär.

 

2. Set WLED color to "Default" beforehand

To ensure WLED correctly accepts the RGBW values supplied by ColorShow, the WLED color selection must be set to “Default” once before using ColorShow.

Important:
In the WLED interface, press the “Default” button (= 0) in the color selection.

This will:

•reset the current color stored in WLED to a defined default state

•prepare WLED’s internal color storage so that external color values (API / EisBär / ColorShow) are applied correctly

Effects do not need to be reset or disabled.
Only the color must be set to “Default” once.

 

3. Interaction: ColorShow (RGBW) + WLED Effects

After setting the WLED color to Default (= 0):

•ColorShow supplies the RGBW color values (e.g., to primary/secondary/tertiary)

•WLED accepts these values immediately

•Active effects continue running and use the external colors as their color source

•Animation (movement, patterns) still comes from WLED

•Color content comes from the individual ColorShow instances

This enables scenarios such as:

•Multi-color effects (Gradient, Dual Scan, Tri-Chase) with externally controlled colors

•Slow color fades from ColorShow combined with fast WLED movement

•Independent control of the three color layers of a segment (one ColorShow per layer)

 

4. Behavior during active ColorShow sequences

When a ColorShow sequence is running:

•the ColorShow continuously generates new RGBW values

•WLED continuously updates the corresponding color slot (primary/secondary/tertiary)

•the effect dynamically uses the updated colors

•the white channel (W) is fully supported (0–255)

Since each color slot has its own ColorShow:

•Primary, secondary, and tertiary colors can use different sequences

•Complex color gradients in combination with WLED effects become possible

 

5. Summary

•Use one ColorShow per color slot (Primary, Secondary, Tertiary)

•Before commissioning: in WLED set color to “Default” (= 0) once

•Effects stay active; only the color is supplied externally

•ColorShow outputs RGBW colors; WLED handles the animation