From bedf3b2efdb4bde93a7f746589ad00afb317648a Mon Sep 17 00:00:00 2001 From: Will Tatam Date: Sun, 17 May 2026 12:19:47 +0100 Subject: [PATCH 1/6] docs: refresh README to reflect current feature set and project state --- readme.md | 113 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 65 insertions(+), 48 deletions(-) diff --git a/readme.md b/readme.md index bcdf5ab303..30ff03733a 100644 --- a/readme.md +++ b/readme.md @@ -7,81 +7,98 @@ - -

+

# Welcome to WLED! ✨ -A fast and feature-rich implementation of an ESP32 and ESP8266 webserver to control NeoPixel (WS2812B, WS2811, SK6812) LEDs or also SPI based chipsets like the WS2801 and APA102! +A fast and feature-rich firmware for ESP32 and ESP8266 microcontrollers to control addressable LEDs — from simple strips to large 2D matrices and HUB75 panels. -Originally created by [Aircoookie](https://github.com/Aircoookie) +Originally created by [Aircoookie](https://github.com/Aircoookie), now maintained by a community of contributors. ## ⚙️ Features -- WS2812FX library with more than 100 special effects -- FastLED noise effects and 50 palettes -- Modern UI with color, effect and segment controls -- Segments to set different effects and colors to user defined parts of the LED string -- Settings page - configuration via the network -- Access Point and station mode - automatic failsafe AP -- [Up to 10 LED outputs](https://kno.wled.ge/features/multi-strip/#esp32) per instance -- Support for RGBW strips -- Up to 250 user presets to save and load colors/effects easily, supports cycling through them. -- Presets can be used to automatically execute API calls -- Nightlight function (gradually dims down) -- Full OTA software updateability (HTTP + ArduinoOTA), password protectable -- Configurable analog clock (Cronixie, 7-segment and EleksTube IPS clock support via usermods) -- Configurable Auto Brightness limit for safe operation -- Filesystem-based config for easier backup of presets and settings - -## 💡 Supported light control interfaces -- WLED app for [Android](https://play.google.com/store/apps/details?id=ca.cgagnier.wlednativeandroid) and [iOS](https://apps.apple.com/gb/app/wled-native/id6446207239) -- JSON and HTTP request APIs -- MQTT -- E1.31, Art-Net, DDP and TPM2.net -- [diyHue](https://github.com/diyhue/diyHue) (Wled is supported by diyHue, including Hue Sync Entertainment under udp. Thanks to [Gregory Mallios](https://github.com/gmallios)) -- [Hyperion](https://github.com/hyperion-project/hyperion.ng) -- UDP realtime -- Alexa voice control (including dimming and color) -- Sync to Philips hue lights -- Adalight (PC ambilight via serial) and TPM2 -- Sync color of multiple WLED devices (UDP notifier) -- Infrared remotes (24-key RGB, receiver required) -- Simple timers/schedules (time from NTP, timezones/DST supported) + +### Effects & Visuals +- **200+ built-in effects** including classic animations, audio-reactive, and 2D/matrix effects +- 50+ color palettes plus a built-in **custom palette editor** (PixelForge) +- **2D LED matrix support** with dedicated 2D effects and flexible panel mapping +- **HUB75 RGB matrix panel support** (ESP32-S3) +- **AudioReactive** effects — included by default, responding to sound via microphone or line-in +- Effect blending for smooth transitions between animations +- Antialiased drawing functions for smooth graphics + +### Segments & Control +- **Segments** — apply different effects, colors and palettes to independent parts of your LED setup simultaneously +- Up to **250 presets** to save and recall colors, effects and segment configurations +- Preset playlists for automated cycling and sequencing +- Nightlight function with configurable dimming curve +- Configurable **Auto Brightness Limiter** (per output) for safe operation + +### Hardware Support +- **ESP32** (all variants: original, S2, S3, C3), **ESP8266** +- **Up to 17 LED outputs** on ESP32 using parallel I2S + RMT +- Addressable LED support: WS2812B, WS2811, WS2815, SK6812, WS2805, TM1914, APA102, WS2801, LPD8806, and many more +- RGBW, RGB+CCT and white-only strips +- PWM outputs for analog LEDs and dimmers +- **Ethernet** support for a wide range of boards (QuinLED, LILYGO, Olimex, and more) +- Filesystem-based config for easy backup and restore of presets and settings +- Full OTA firmware updates (HTTP + ArduinoOTA), password-protectable + +### Connectivity & Integrations +- **WLED app** for [Android](https://play.google.com/store/apps/details?id=ca.cgagnier.wlednativeandroid) and [iOS](https://apps.apple.com/gb/app/wled-native/id6446207239) +- JSON and HTTP request APIs +- **Multi-WiFi** — connect to up to 3 networks with automatic AP fallback +- **ESP-NOW** wireless sync between devices (no WiFi router required) +- **MQTT** with Home Assistant discovery +- **E1.31, Art-Net, DDP and TPM2.net** for DMX/professional lighting control +- UDP realtime sync across multiple WLED devices +- Alexa voice control (on/off, brightness, color) +- Philips Hue sync +- [diyHue](https://github.com/diyhue/diyHue) and [Hyperion](https://github.com/hyperion-project/hyperion.ng) integration +- Adalight / TPM2 (PC ambilight via serial) +- Infrared remote control (24-key RGB, receiver required) +- Timers and schedules (NTP time sync, full timezone and DST support) + +### Developer-Friendly +- **Usermod system** — extend WLED with community or custom modules without modifying core code +- Large and active [usermod library](https://github.com/wled-dev/WLED/tree/main/usermods) including AudioReactive, temperature sensors, rotary encoders, displays, and much more +- Well-documented [JSON API](https://kno.wled.ge/interfaces/json-api/) +- Licensed under the **EUPL v1.2** ## 📲 Quick start guide and documentation -See the [documentation on our official site](https://kno.wled.ge)! +See the [documentation at kno.wled.ge](https://kno.wled.ge)! -[On this page](https://kno.wled.ge/basics/tutorials/) you can find excellent tutorials and tools to help you get your new project up and running! +[Tutorials and getting-started guides](https://kno.wled.ge/basics/tutorials/) to help you get your project running quickly. ## 🖼️ User interface + ## 💾 Compatible hardware -See [here](https://kno.wled.ge/basics/compatible-hardware)! +See the [compatible hardware list](https://kno.wled.ge/basics/compatible-hardware) on the wiki. ## ✌️ Other -Licensed under the EUPL v1.2 license -Credits [here](https://kno.wled.ge/about/contributors/)! -CORS proxy by [Corsfix](https://corsfix.com/) +Licensed under the [EUPL v1.2](https://raw.githubusercontent.com/wled-dev/WLED/main/LICENSE). +Credits to all [contributors](https://kno.wled.ge/about/contributors/)! +CORS proxy by [Corsfix](https://corsfix.com/). Join the Discord server to discuss everything about WLED! -Check out the WLED [Discourse forum](https://wled.discourse.group)! - -You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com), but please, only do so if you want to talk to me privately. +Check out the WLED [Discourse forum](https://wled.discourse.group)! -If WLED really brightens up your day, you can [![](https://img.shields.io/badge/send%20me%20a%20small%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie) +If you'd like to reach the original creator privately: [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com). +If WLED brightens up your day, you can [![](https://img.shields.io/badge/send%20a%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie) -*Disclaimer:* +--- -If you are prone to photosensitive epilepsy, we recommended you do **not** use this software. -If you still want to try, don't use strobe, lighting or noise modes or high effect speed settings. +*Disclaimer:* -As per the EUPL license, I assume no liability for any damage to you or any other person or equipment. +If you are prone to photosensitive epilepsy, we recommend you do **not** use this software. +If you still want to try, avoid strobe, lightning or noise modes and high effect speed settings. +As per the EUPL license, no liability is assumed for any damage to you or any other person or equipment. From c7f6a505cdda2cafae9690321305f3b6b274fd95 Mon Sep 17 00:00:00 2001 From: Will Tatam Date: Sun, 17 May 2026 12:22:13 +0100 Subject: [PATCH 2/6] =?UTF-8?q?docs:=20fix=20HUB75=20support=20note=20?= =?UTF-8?q?=E2=80=94=20available=20on=20all=20ESP32=20variants,=20not=20ju?= =?UTF-8?q?st=20S3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 30ff03733a..0b61f53838 100644 --- a/readme.md +++ b/readme.md @@ -21,7 +21,7 @@ Originally created by [Aircoookie](https://github.com/Aircoookie), now maintaine - **200+ built-in effects** including classic animations, audio-reactive, and 2D/matrix effects - 50+ color palettes plus a built-in **custom palette editor** (PixelForge) - **2D LED matrix support** with dedicated 2D effects and flexible panel mapping -- **HUB75 RGB matrix panel support** (ESP32-S3) +- **HUB75 RGB matrix panel support** (ESP32) - **AudioReactive** effects — included by default, responding to sound via microphone or line-in - Effect blending for smooth transitions between animations - Antialiased drawing functions for smooth graphics From a19ea79ca984dc84064d2afef5207663f5a0dd2a Mon Sep 17 00:00:00 2001 From: Will Tatam Date: Sun, 17 May 2026 12:22:55 +0100 Subject: [PATCH 3/6] docs: mention network audio sources in AudioReactive feature description --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 0b61f53838..87da1695cc 100644 --- a/readme.md +++ b/readme.md @@ -22,7 +22,7 @@ Originally created by [Aircoookie](https://github.com/Aircoookie), now maintaine - 50+ color palettes plus a built-in **custom palette editor** (PixelForge) - **2D LED matrix support** with dedicated 2D effects and flexible panel mapping - **HUB75 RGB matrix panel support** (ESP32) -- **AudioReactive** effects — included by default, responding to sound via microphone or line-in +- **AudioReactive** effects — included by default, responding to sound via microphone, line-in, or network audio source - Effect blending for smooth transitions between animations - Antialiased drawing functions for smooth graphics From 570a3156b650e9c77b82aaf03b273dbfe29d4a39 Mon Sep 17 00:00:00 2001 From: Will Tatam Date: Sun, 17 May 2026 12:27:22 +0100 Subject: [PATCH 4/6] =?UTF-8?q?docs:=20remove=20ESP8266=20references=20?= =?UTF-8?q?=E2=80=94=20EOL=20platform,=20not=20recommended=20for=20new=20i?= =?UTF-8?q?nstalls?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 87da1695cc..82d880cb7f 100644 --- a/readme.md +++ b/readme.md @@ -11,7 +11,7 @@ # Welcome to WLED! ✨ -A fast and feature-rich firmware for ESP32 and ESP8266 microcontrollers to control addressable LEDs — from simple strips to large 2D matrices and HUB75 panels. +A fast and feature-rich firmware for ESP32 microcontrollers to control addressable LEDs — from simple strips to large 2D matrices and HUB75 panels. Originally created by [Aircoookie](https://github.com/Aircoookie), now maintained by a community of contributors. @@ -34,7 +34,7 @@ Originally created by [Aircoookie](https://github.com/Aircoookie), now maintaine - Configurable **Auto Brightness Limiter** (per output) for safe operation ### Hardware Support -- **ESP32** (all variants: original, S2, S3, C3), **ESP8266** +- **ESP32** (all variants: original, S2, S3, C3) - **Up to 17 LED outputs** on ESP32 using parallel I2S + RMT - Addressable LED support: WS2812B, WS2811, WS2815, SK6812, WS2805, TM1914, APA102, WS2801, LPD8806, and many more - RGBW, RGB+CCT and white-only strips From 0274d6192574ad9b0af557d82301f010508472a8 Mon Sep 17 00:00:00 2001 From: Will Tatam Date: Sun, 17 May 2026 12:28:06 +0100 Subject: [PATCH 5/6] docs: make PayPal donation link clearly attributed to Aircoookie --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 82d880cb7f..fe5b1ce6d1 100644 --- a/readme.md +++ b/readme.md @@ -92,7 +92,7 @@ Check out the WLED [Discourse forum](https://wled.discourse.group)! If you'd like to reach the original creator privately: [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com). -If WLED brightens up your day, you can [![](https://img.shields.io/badge/send%20a%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie) +If WLED brightens up your day, you can [send a gift to Aircoookie via PayPal](https://paypal.me/aircoookie). --- From 6b6ecf786f00844b04930386beaa21724c5639fb Mon Sep 17 00:00:00 2001 From: Will Tatam Date: Sun, 17 May 2026 12:31:23 +0100 Subject: [PATCH 6/6] docs: add cross-references to kno.wled.ge docs throughout feature list --- readme.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/readme.md b/readme.md index fe5b1ce6d1..762be9bd43 100644 --- a/readme.md +++ b/readme.md @@ -18,49 +18,48 @@ Originally created by [Aircoookie](https://github.com/Aircoookie), now maintaine ## ⚙️ Features ### Effects & Visuals -- **200+ built-in effects** including classic animations, audio-reactive, and 2D/matrix effects -- 50+ color palettes plus a built-in **custom palette editor** (PixelForge) -- **2D LED matrix support** with dedicated 2D effects and flexible panel mapping -- **HUB75 RGB matrix panel support** (ESP32) -- **AudioReactive** effects — included by default, responding to sound via microphone, line-in, or network audio source +- [**200+ built-in effects**](https://kno.wled.ge/features/effects/) including classic animations, audio-reactive, and 2D/matrix effects +- [50+ color palettes](https://kno.wled.ge/features/palettes/) plus a built-in **custom palette editor** (PixelForge) +- [**2D LED matrix support**](https://kno.wled.ge/advanced/mapping/) with dedicated 2D effects and flexible panel mapping +- [**HUB75 RGB matrix panel support**](https://kno.wled.ge/advanced/HUB75/) (ESP32) +- [**AudioReactive**](https://kno.wled.ge/advanced/audio-reactive/) effects — included by default, responding to sound via microphone, line-in, or network audio source - Effect blending for smooth transitions between animations - Antialiased drawing functions for smooth graphics ### Segments & Control -- **Segments** — apply different effects, colors and palettes to independent parts of your LED setup simultaneously -- Up to **250 presets** to save and recall colors, effects and segment configurations -- Preset playlists for automated cycling and sequencing +- [**Segments**](https://kno.wled.ge/features/segments/) — apply different effects, colors and palettes to independent parts of your LED setup simultaneously +- Up to **250 presets** to save and recall colors, effects and segment configurations — supports [playlists](https://kno.wled.ge/features/presets/) for automated cycling - Nightlight function with configurable dimming curve - Configurable **Auto Brightness Limiter** (per output) for safe operation ### Hardware Support - **ESP32** (all variants: original, S2, S3, C3) -- **Up to 17 LED outputs** on ESP32 using parallel I2S + RMT -- Addressable LED support: WS2812B, WS2811, WS2815, SK6812, WS2805, TM1914, APA102, WS2801, LPD8806, and many more -- RGBW, RGB+CCT and white-only strips +- [**Up to 17 LED outputs**](https://kno.wled.ge/features/multi-strip/) on ESP32 using parallel I2S + RMT +- [Addressable LED support](https://kno.wled.ge/basics/compatible-led-strips/): WS2812B, WS2811, WS2815, SK6812, WS2805, TM1914, APA102, WS2801, LPD8806, and many more +- RGBW, [RGB+CCT](https://kno.wled.ge/features/cct/) and white-only strips - PWM outputs for analog LEDs and dimmers -- **Ethernet** support for a wide range of boards (QuinLED, LILYGO, Olimex, and more) +- [**Ethernet** support](https://kno.wled.ge/features/ethernet-lan/) for a wide range of boards (QuinLED, LILYGO, Olimex, and more) - Filesystem-based config for easy backup and restore of presets and settings - Full OTA firmware updates (HTTP + ArduinoOTA), password-protectable ### Connectivity & Integrations - **WLED app** for [Android](https://play.google.com/store/apps/details?id=ca.cgagnier.wlednativeandroid) and [iOS](https://apps.apple.com/gb/app/wled-native/id6446207239) -- JSON and HTTP request APIs +- [JSON](https://kno.wled.ge/interfaces/json-api/) and [HTTP request](https://kno.wled.ge/interfaces/http-api/) APIs - **Multi-WiFi** — connect to up to 3 networks with automatic AP fallback - **ESP-NOW** wireless sync between devices (no WiFi router required) -- **MQTT** with Home Assistant discovery -- **E1.31, Art-Net, DDP and TPM2.net** for DMX/professional lighting control -- UDP realtime sync across multiple WLED devices +- [**MQTT**](https://kno.wled.ge/interfaces/mqtt/) with Home Assistant discovery +- [**E1.31, Art-Net**](https://kno.wled.ge/interfaces/e1.31-dmx/), [DDP](https://kno.wled.ge/interfaces/ddp/) and [TPM2.net](https://kno.wled.ge/interfaces/udp-realtime/) for DMX/professional lighting control +- [UDP realtime sync](https://kno.wled.ge/interfaces/udp-notifier/) across multiple WLED devices - Alexa voice control (on/off, brightness, color) -- Philips Hue sync +- [Philips Hue sync](https://kno.wled.ge/interfaces/philips-hue/) - [diyHue](https://github.com/diyhue/diyHue) and [Hyperion](https://github.com/hyperion-project/hyperion.ng) integration -- Adalight / TPM2 (PC ambilight via serial) -- Infrared remote control (24-key RGB, receiver required) +- [Adalight / TPM2](https://kno.wled.ge/interfaces/serial/) (PC ambilight via serial) +- [Infrared remote control](https://kno.wled.ge/interfaces/infrared/) (24-key RGB, receiver required) - Timers and schedules (NTP time sync, full timezone and DST support) ### Developer-Friendly - **Usermod system** — extend WLED with community or custom modules without modifying core code -- Large and active [usermod library](https://github.com/wled-dev/WLED/tree/main/usermods) including AudioReactive, temperature sensors, rotary encoders, displays, and much more +- Large and active [usermod library](https://kno.wled.ge/advanced/community-usermods/) including AudioReactive, temperature sensors, rotary encoders, displays, and much more - Well-documented [JSON API](https://kno.wled.ge/interfaces/json-api/) - Licensed under the **EUPL v1.2**