WLED/readme.md

![WLED logo](https://raw.githubusercontent.com/Aircoookie/WLED/master/wled_logo.png)   

[![](https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square)](https://github.com/Aircoookie/WLED/releases)
[![](https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square)](https://wled.discourse.group)
[![](https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square)](https://discord.gg/KuqP7NE)
[![](https://img.shields.io/badge/quick_start-wiki-blue.svg?style=flat-square)](https://github.com/Aircoookie/WLED/wiki)
[![](https://img.shields.io/badge/app-wled-blue.svg?style=flat-square)](https://github.com/Aircoookie/WLED-App)

## Welcome to my project WLED!

A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812, APA102) LEDs!

### Features:
- WS2812FX library integrated for almost 100 special effects  
- FastLED noise effects and palettes  
- Modern UI with color, effect and segment controls  
- Segments to set different effects and colors to parts of the LEDs  
- Settings page - configuration over network  
- Access Point and station mode - automatic failsafe AP  
- Support for RGBW strips  
- 16 user presets to save and load colors/effects easily, supports cycling through them.  
- Macro functions to automatically execute API calls  
- Nightlight function (gradually dims down)  
- Full OTA software updatability (HTTP + ArduinoOTA), password protectable  
- Configurable analog clock + support for the Cronixie kit by Diamex  
- Configurable Auto Brightness limit for safer operation  

### Supported light control interfaces:
- WLED app for Android and iOS  
- JSON and HTTP request APIs  
- MQTT  
- Blynk IoT  
- E1.31  
- Hyperion  
- UDP realtime  
- Alexa voice control (including dimming and color)  
- Sync to Philips hue lights  
- Adalight (PC ambilight via serial)  
- Sync color of multiple WLED devices (UDP notifier)  
- Infrared remotes (24-key RGB, receiver required)  
- Simple timers/schedules (time from NTP, timezones/DST supported)  

### Quick start guide and documentation:

See the [wiki](https://github.com/Aircoookie/WLED/wiki)!

DrZzs has made some excellent video guides:  
[Introduction, hardware and installation](https://www.youtube.com/watch?v=tXvtxwK3jRk)  
[Settings, tips and tricks](https://www.youtube.com/watch?v=6eCE2BpLaUQ)  

If you'd rather read, here is a very [detailed step-by-step beginner tutorial](https://tynick.com/blog/11-03-2019/getting-started-with-wled-on-esp8266/) by tynick!  

### Other

Licensed under the MIT license  
Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)!

Uses Linearicons by Perxis!

Join the Discord [server](https://discord.gg/KuqP7NE) 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.  
If WLED really brightens up your every day, you can [![](https://img.shields.io/badge/send%20me%20a%20small%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie)

*Disclaimer:*   
If you are sensitive to photoeleptic seizures it is not recommended that you use this software.  
In case you still want to try, don't use strobe, lighting or noise modes or high effect speed settings.
As per the MIT license, i assume no liability for any damage to you or any other person or equipment.
Added shields.io to readme 2019-02-09 15:41:55 +01:00			`![WLED logo](https://raw.githubusercontent.com/Aircoookie/WLED/master/wled_logo.png)`
Added MQTT Updated readme for 0.8.0 Fixed custom theme bug Bumped version codes to 0.8.0 2018-10-04 16:50:12 +02:00
Split up WS2812FX.cpp in FX and helper files 2019-02-09 16:37:20 +01:00			`[![](https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square)](https://github.com/Aircoookie/WLED/releases)`
Fix discourse badge 2020-02-04 17:46:43 +01:00			`[![](https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square)](https://wled.discourse.group)`
Added shields.io to readme 2019-02-09 15:41:55 +01:00			`[![](https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square)](https://discord.gg/KuqP7NE)`
			`[![](https://img.shields.io/badge/quick_start-wiki-blue.svg?style=flat-square)](https://github.com/Aircoookie/WLED/wiki)`
			`[![](https://img.shields.io/badge/app-wled-blue.svg?style=flat-square)](https://github.com/Aircoookie/WLED-App)`

			`## Welcome to my project WLED!`
Release of WLED 0.4 - the BLINKEN update Added setting to change default boot preset Changed default NTP server Removed keywords.txt from dependencies because IDE would consider it as an (invalid) library Updated readme Updated binaries to 0.4 2017-12-12 14:52:28 +01:00
Improved rainbow effects 2019-10-05 01:56:55 +02:00			`A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812, APA102) LEDs!`
XML settings done 2016-09-11 23:07:18 +02:00
Cleaned up readme 2018-10-04 23:16:25 +02:00			`### Features:`
Update readme 2020-01-13 18:24:23 +01:00			`- WS2812FX library integrated for almost 100 special effects`
Added C9 and Sakura palettes 2019-08-31 01:41:25 +02:00			`- FastLED noise effects and palettes`
Update readme 2019-12-13 01:31:48 +01:00			`- Modern UI with color, effect and segment controls`
			`- Segments to set different effects and colors to parts of the LEDs`
Added C9 and Sakura palettes 2019-08-31 01:41:25 +02:00			`- Settings page - configuration over network`
			`- Access Point and station mode - automatic failsafe AP`
			`- Support for RGBW strips`
Update readme 2019-12-13 01:31:48 +01:00			`- 16 user presets to save and load colors/effects easily, supports cycling through them.`
Added C9 and Sakura palettes 2019-08-31 01:41:25 +02:00			`- Macro functions to automatically execute API calls`
			`- Nightlight function (gradually dims down)`
			`- Full OTA software updatability (HTTP + ArduinoOTA), password protectable`
			`- Configurable analog clock + support for the Cronixie kit by Diamex`
			`- Configurable Auto Brightness limit for safer operation`
Cleaned up readme 2018-10-04 23:16:25 +02:00
			`### Supported light control interfaces:`
Added C9 and Sakura palettes 2019-08-31 01:41:25 +02:00			`- WLED app for Android and iOS`
			`- JSON and HTTP request APIs`
			`- MQTT`
			`- Blynk IoT`
			`- E1.31`
			`- Hyperion`
			`- UDP realtime`
			`- Alexa voice control (including dimming and color)`
			`- Sync to Philips hue lights`
			`- Adalight (PC ambilight via serial)`
			`- Sync color of multiple WLED devices (UDP notifier)`
			`- Infrared remotes (24-key RGB, receiver required)`
			`- Simple timers/schedules (time from NTP, timezones/DST supported)`
Added (highly unstable and experimental) NTP time support Added timezones library (CET for now, you can easily adapt it to your timezone however) Added overlays to support both digital and analog clockfaces, basic countdown Improved serial debug Included license notes in settings file Added a bit of guides to readme file Warning! Using NTP usually results in a complete system crash after 1-48 hours. Please only enable it if you are willing to experiment with it. To get a proper WLED experience, make sure the checkbox for NTP is disabled in settings! 2017-01-15 00:24:28 +01:00
Attempted to mitigate flickering on ESP32 Replaced broken effect 34, now a quad-color running effect Added new binaries and guide Updated readme 2018-01-10 23:57:58 +01:00			`### Quick start guide and documentation:`
Added (highly unstable and experimental) NTP time support Added timezones library (CET for now, you can easily adapt it to your timezone however) Added overlays to support both digital and analog clockfaces, basic countdown Improved serial debug Included license notes in settings file Added a bit of guides to readme file Warning! Using NTP usually results in a complete system crash after 1-48 hours. Please only enable it if you are willing to experiment with it. To get a proper WLED experience, make sure the checkbox for NTP is disabled in settings! 2017-01-15 00:24:28 +01:00
Attempted to mitigate flickering on ESP32 Replaced broken effect 34, now a quad-color running effect Added new binaries and guide Updated readme 2018-01-10 23:57:58 +01:00			`See the [wiki](https://github.com/Aircoookie/WLED/wiki)!`
Release of WLED 0.4 - the BLINKEN update Added setting to change default boot preset Changed default NTP server Removed keywords.txt from dependencies because IDE would consider it as an (invalid) library Updated readme Updated binaries to 0.4 2017-12-12 14:52:28 +01:00
Updated Espalexa (#274) and readme 2019-11-10 00:54:35 +01:00			`DrZzs has made some excellent video guides:`
Replaced literal URLs in readme 2019-11-10 01:12:38 +01:00			`[Introduction, hardware and installation](https://www.youtube.com/watch?v=tXvtxwK3jRk)`
			`[Settings, tips and tricks](https://www.youtube.com/watch?v=6eCE2BpLaUQ)`
Updated Espalexa (#274) and readme 2019-11-10 00:54:35 +01:00
Replaced literal URLs in readme 2019-11-10 01:12:38 +01:00			`If you'd rather read, here is a very [detailed step-by-step beginner tutorial](https://tynick.com/blog/11-03-2019/getting-started-with-wled-on-esp8266/) by tynick!`
Updated Espalexa (#274) and readme 2019-11-10 00:54:35 +01:00
Release of WLED 0.4 - the BLINKEN update Added setting to change default boot preset Changed default NTP server Removed keywords.txt from dependencies because IDE would consider it as an (invalid) library Updated readme Updated binaries to 0.4 2017-12-12 14:52:28 +01:00			`### Other`
Added (highly unstable and experimental) NTP time support Added timezones library (CET for now, you can easily adapt it to your timezone however) Added overlays to support both digital and analog clockfaces, basic countdown Improved serial debug Included license notes in settings file Added a bit of guides to readme file Warning! Using NTP usually results in a complete system crash after 1-48 hours. Please only enable it if you are willing to experiment with it. To get a proper WLED experience, make sure the checkbox for NTP is disabled in settings! 2017-01-15 00:24:28 +01:00
Added MQTT Updated readme for 0.8.0 Fixed custom theme bug Bumped version codes to 0.8.0 2018-10-04 16:50:12 +02:00			`Licensed under the MIT license`
Moved About section to Github wiki Updated readme 2018-11-23 00:03:44 +01:00			`Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)!`
Added MQTT Updated readme for 0.8.0 Fixed custom theme bug Bumped version codes to 0.8.0 2018-10-04 16:50:12 +02:00
			`Uses Linearicons by Perxis!`
Added Alexa support 2017-02-21 23:59:47 +01:00
Added MQTT Updated readme for 0.8.0 Fixed custom theme bug Bumped version codes to 0.8.0 2018-10-04 16:50:12 +02:00			`Join the Discord [server](https://discord.gg/KuqP7NE) to discuss everything about WLED!`
Add discourse to readme 2020-02-04 17:43:46 +01:00			`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.`
Added shields.io to readme 2019-02-09 15:41:55 +01:00			`If WLED really brightens up your every day, you can [![](https://img.shields.io/badge/send%20me%20a%20small%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie)`
Migrate to ESPAsyncE131 2019-11-18 20:43:27 +01:00
			`Disclaimer:`
			`If you are sensitive to photoeleptic seizures it is not recommended that you use this software.`
			`In case you still want to try, don't use strobe, lighting or noise modes or high effect speed settings.`
			`As per the MIT license, i assume no liability for any damage to you or any other person or equipment.`