WLED README

The project's README from github.com/wled/WLED. As one markdown file: README.md.

Welcome to WLED! ✨

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, now maintained by a community of contributors.

⚙️ Features

Effects & Visuals

Segments & Control

Hardware Support

Connectivity & Integrations

Developer-Friendly

📲 Quick start guide and documentation

See the documentation at kno.wled.ge!

Tutorials and getting-started guides to help you get your project running quickly.

🖼️ User interface

💾 Compatible hardware

See the compatible hardware list on the wiki.

✌️ Other

Licensed under the EUPL v1.2.
Credits to all contributors!
CORS proxy by Corsfix.

Join the Discord server to discuss everything about WLED!

Check out the WLED Discourse forum!

If you'd like to reach the original creator privately: [email protected].

If WLED brightens up your day, you can send a gift to Aircoookie via PayPal.


Disclaimer:

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.

WLED (wled/WLED)

Searching Database…

18.9K ·GitHub
What is this?WLED is a fast, feature-rich open-source firmware for ESP32 microcontrollers that controls addressable RGB LEDs over WiFi — from single strips to large 2D matrices and HUB75 panels.
Is this something I install on my phone, or does it live somewhere else?It lives on the ESP32 board wired to your LEDs: you flash it once, and the board serves its own control page on your network. Phone apps and browsers are just remotes — there is a WLED app for Android and iOS.
How do I get it running?Flash the firmware onto an ESP32 board wired to your strip — kno.wled.ge has tutorials and getting-started guides. Once it joins your WiFi you control it from a browser or app, and later updates install over the air via HTTP or ArduinoOTA.
Will my LED strip work with it?Most likely — it supports WS2812B, WS2811, WS2815, SK6812, APA102, WS2801 and many more addressable types, plus RGBW and RGB+CCT strips. Plain analog LEDs and dimmers work too via PWM outputs.
How many LED outputs can one board drive?Up to 17 separate outputs on an ESP32, using parallel I2S and RMT peripherals. A configurable Auto Brightness Limiter protects each output so you don't overload your power supply.
What controller board do I need — does it have to be a specific one?Any ESP32 variant works — original, S2, S3 or C3 — and a wide range of boards (QuinLED, LILYGO, Olimex and more) support Ethernet. The repo topics also list the older ESP8266.
Does it need an internet connection to work?No — it serves its own web UI on your local WiFi and falls back to its own access point if no network is found. Devices can even sync animations directly over ESP-NOW without any router.
What effects does it ship with?Over 200 built-in effects and 50+ color palettes, from classic animations to audio-reactive and 2D matrix effects, with smooth blending between animations. There is also a built-in palette editor called PixelForge.
Can parts of my LED setup do different things at the same time?Yes — Segments give independent parts of your setup their own effects, colors and palettes simultaneously. You can save up to 250 presets and chain them into playlists that cycle automatically.
Does it work with Home Assistant, Alexa, or DMX lighting gear?It announces itself to Home Assistant via MQTT auto-discovery, and Alexa handles on/off, brightness and color by voice. For pro lighting there is E1.31, Art-Net, DDP and TPM2.net, plus Philips Hue sync and Hyperion support.
Anything I should watch out for?The README warns people prone to photosensitive epilepsy not to use WLED — or at least to avoid strobe, lightning and noise modes and high effect speeds. The license also disclaims liability for any damage to people or equipment.
Creator
wled
Size
69.7 MB
Stars
18.9K
Age
9y
Commits · 90 Days