diff --git a/readme.md b/readme.md index bcdf5ab303..762be9bd43 100644 --- a/readme.md +++ b/readme.md @@ -7,81 +7,97 @@ - -

+

# 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 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**](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**](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**](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](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](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**](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](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](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://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** ## 📲 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 [send a gift to Aircoookie via PayPal](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.