WLED/readme.md

<p align="center">
  <img src="/images/wled_logo_akemi.png">
  <a href="https://github.com/Aircoookie/WLED/releases"><img src="https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square"></a>
  <a href="https://raw.githubusercontent.com/Aircoookie/WLED/master/LICENSE"><img src="https://img.shields.io/github/license/Aircoookie/wled?color=blue&style=flat-square"></a>
  <a href="https://wled.discourse.group"><img src="https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square"></a>
  <a href="https://discord.gg/QAh7wJHrRM"><img src="https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square"></a>
  <a href="https://kno.wled.ge"><img src="https://img.shields.io/badge/quick_start-wiki-blue.svg?style=flat-square"></a>
  <a href="https://github.com/Aircoookie/WLED-App"><img src="https://img.shields.io/badge/app-wled-blue.svg?style=flat-square"></a>
  <a href="https://gitpod.io/#https://github.com/Aircoookie/WLED"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?style=flat-square&logo=gitpod"></a>

  </p>

# Welcome to my project WLED! ✨

A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812) LEDs or also SPI based chipsets like the WS2801 and APA102!

## ⚙️ 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 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=com.aircoookie.WLED) and [iOS](https://apps.apple.com/us/app/wled/id1475695033)
- 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)  

## 📲 Quick start guide and documentation

See the [documentation on our official site](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!

## 🖼️ User interface
<img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" width="50%"><img src="/images/walking-with-iphone-x.jpg" width="50%">

## 💾 Compatible hardware

See [here](https://kno.wled.ge/basics/compatible-hardware)!

## ✌️ Other

Licensed under the MIT license  
Credits [here](https://kno.wled.ge/about/contributors/)!

Join the Discord server to discuss everything about WLED!

<a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>

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 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 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.

As per the MIT license, I assume no liability for any damage to you or any other person or equipment.
Update readme.md 2020-06-07 12:50:25 +00:00			`<p align="center">`
Release of WLED v0.10.2 2020-08-31 15:03:07 +00:00			`<img src="/images/wled_logo_akemi.png">`
Update readme.md 2020-06-07 12:50:25 +00:00			`<a href="https://github.com/Aircoookie/WLED/releases"><img src="https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square"></a>`
Add shield for license 2020-09-28 22:08:12 +00:00			`<a href="https://raw.githubusercontent.com/Aircoookie/WLED/master/LICENSE"><img src="https://img.shields.io/github/license/Aircoookie/wled?color=blue&style=flat-square"></a>`
Update readme.md 2020-06-07 12:50:25 +00:00			`<a href="https://wled.discourse.group"><img src="https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square"></a>`
Update Discord invite links to point to guidelines channel 2023-10-19 11:29:46 +00:00			`<a href="https://discord.gg/QAh7wJHrRM"><img src="https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square"></a>`
Replace wiki link in readme to knoWLEDge 2021-09-11 09:18:39 +00:00			`<a href="https://kno.wled.ge"><img src="https://img.shields.io/badge/quick_start-wiki-blue.svg?style=flat-square"></a>`
Update readme.md 2020-06-07 12:50:25 +00:00			`<a href="https://github.com/Aircoookie/WLED-App"><img src="https://img.shields.io/badge/app-wled-blue.svg?style=flat-square"></a>`
Streamline platformio.ini 2020-11-17 23:54:41 +00:00			`<a href="https://gitpod.io/#https://github.com/Aircoookie/WLED"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?style=flat-square&logo=gitpod"></a>`
Add shield for license 2020-09-28 22:08:12 +00:00
Update readme.md 2020-06-07 12:50:25 +00:00			`</p>`
Fix formatting of the first title 2021-08-18 20:21:31 +00:00
Added Sunrise nightlight mode and more UI features - Added Sunrise nightlight mode - Added Chunchun effect - Added `LO` (live override) command to HTTP API - Added `mode` to `nl` object of JSON state API, deprecating `fade` - Added light color scheme support to web UI (click sun next to brightness slider) - Added option to hide labels in web UI (click flame icon next to intensity slider) - Added hex color input (click palette icon next to palette select) (resolves #506) - Added support for RGB sliders (need to set in localstorage) - Added support for custom background color or image (need to set in localstorage) - Added option to hide bottom tab bar in PC mode (need to set in localstorage) - Fixed transition lag with multiple segments (fixes #985) - Changed Nightlight wording (resolves #940) 2020-06-22 10:30:31 +00:00			`# 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 13:52:28 +00:00
Update readme.md 2020-11-09 19:14:24 +00:00			`A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812) LEDs or also SPI based chipsets like the WS2801 and APA102!`
XML settings done 2016-09-11 21:07:18 +00:00
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00:00			`## ⚙️ Features`
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org> 2022-12-10 15:12:55 +00:00			`- WS2812FX library with more than 100 special effects`
Fix LED pin changed 2020-02-25 01:25:17 +00:00			`- FastLED noise effects and 50 palettes`
Update readme 2019-12-13 00:31:48 +00:00			`- Modern UI with color, effect and segment controls`
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org> 2022-12-10 15:12:55 +00:00			`- Segments to set different effects and colors to user defined parts of the LED string`
			`- Settings page - configuration via the network`
Added C9 and Sakura palettes 2019-08-30 23:41:25 +00:00			`- Access Point and station mode - automatic failsafe AP`
Release of WLED v0.12.0 2021-04-02 22:15:28 +00:00			`- Up to 10 LED outputs per instance`
Added C9 and Sakura palettes 2019-08-30 23:41:25 +00:00			`- Support for RGBW strips`
Remove FS defines Increase boot preset max. to 250 Update changelog Update readme 2020-11-15 14:45:51 +00:00			`- 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`
Added C9 and Sakura palettes 2019-08-30 23:41:25 +00:00			`- Nightlight function (gradually dims down)`
code spell checking - part1 (core) I've found a code spellchecker, so this is what can be corrected easily. Changes are only affecting comments, readme and a few user-visible strings. So no functional impact expected. 2023-12-14 02:49:54 +00:00			`- Full OTA software updateability (HTTP + ArduinoOTA), password protectable`
Replaced native Cronixie support with usermod 2022-03-06 22:47:36 +00:00			`- Configurable analog clock (Cronixie, 7-segment and EleksTube IPS clock support via usermods)`
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org> 2022-12-10 15:12:55 +00:00			`- Configurable Auto Brightness limit for safe operation`
Remove FS defines Increase boot preset max. to 250 Update changelog Update readme 2020-11-15 14:45:51 +00:00			`- Filesystem-based config for easier backup of presets and settings`
Cleaned up readme 2018-10-04 21:16:25 +00:00
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00:00			`## 💡 Supported light control interfaces`
Update readme.md - add link to Hyperion.NG - add link to WLED App (Android & iOS) 2020-07-27 04:32:32 +00:00			`- WLED app for [Android](https://play.google.com/store/apps/details?id=com.aircoookie.WLED) and [iOS](https://apps.apple.com/us/app/wled/id1475695033)`
Added C9 and Sakura palettes 2019-08-30 23:41:25 +00:00			`- JSON and HTTP request APIs`
Remove Blynk support (#3102) Change default palette for Railway to Colors 1 and 2 2023-02-21 16:07:32 +00:00			`- MQTT`
Remove FS defines Increase boot preset max. to 250 Update changelog Update readme 2020-11-15 14:45:51 +00:00			`- E1.31, Art-Net, DDP and TPM2.net`
Add diyHue repo to readme.md Wled has been supported by diyHue for some time, now it also supports Hue Sync (Entertainment) under UDP in the flask branch which will be the new master branch. https://github.com/diyhue/diyHue/pull/628 2021-06-01 16:31:52 +00:00			`- [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))`
Update readme.md - add link to Hyperion.NG - add link to WLED App (Android & iOS) 2020-07-27 04:32:32 +00:00			`- [Hyperion](https://github.com/hyperion-project/hyperion.ng)`
Added C9 and Sakura palettes 2019-08-30 23:41:25 +00:00			`- UDP realtime`
			`- Alexa voice control (including dimming and color)`
			`- Sync to Philips hue lights`
Release of WLED v0.10.2 2020-08-31 15:03:07 +00:00			`- Adalight (PC ambilight via serial) and TPM2`
Added C9 and Sakura palettes 2019-08-30 23:41:25 +00:00			`- 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-14 23:24:28 +00:00
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00: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-14 23:24:28 +00:00
Updated reference to docs on readme to knoWLEDge 2021-09-18 05:23:51 +00:00			`See the [documentation on our official site](https://kno.wled.ge)!`
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 13:52:28 +00:00
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org> 2022-12-10 15:12:55 +00:00			`[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!`
Added custom per-LED mapping 2020-03-20 23:57:54 +00:00
Readme cleanup 2022-02-21 21:26:35 +00:00			`## 🖼️ User interface`
images to jpg (#1004) * images to jpg * Delete macbook-pro-space-gray-on-the-wooden-table.png * Delete walking-with-iphone-x.png * Update readme.md 2020-06-19 20:57:24 +00:00			`<img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" width="50%"><img src="/images/walking-with-iphone-x.jpg" width="50%">`
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00:00
Readme cleanup 2022-02-21 21:26:35 +00:00			`## 💾 Compatible hardware`
Add PC RGB notes add info for pc argb enthusiasts to know they can use WLED as an alternative to the motherboard controller. 2020-08-15 19:16:07 +00:00
Readme cleanup 2022-02-21 21:26:35 +00:00			`See [here](https://kno.wled.ge/basics/compatible-hardware)!`
Add PC RGB notes add info for pc argb enthusiasts to know they can use WLED as an alternative to the motherboard controller. 2020-08-15 19:16:07 +00:00
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00: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-14 23:24:28 +00:00
Added MQTT Updated readme for 0.8.0 Fixed custom theme bug Bumped version codes to 0.8.0 2018-10-04 14:50:12 +00:00			`Licensed under the MIT license`
Updated outdated wiki links in readme 2021-11-22 21:23:51 +00:00			`Credits [here](https://kno.wled.ge/about/contributors/)!`
Added MQTT Updated readme for 0.8.0 Fixed custom theme bug Bumped version codes to 0.8.0 2018-10-04 14:50:12 +00:00
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00:00			`Join the Discord server to discuss everything about WLED!`

Update Discord invite links to point to guidelines channel 2023-10-19 11:29:46 +00:00			`<a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>`
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00:00
Add discourse to readme 2020-02-04 16:43:46 +00:00			`Check out the WLED [Discourse forum](https://wled.discourse.group)!`
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org> 2022-12-10 15:12:55 +00:00
			`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 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 19:43:27 +00:00
New readme design (#973) * nicer readme - added emojis - changed the first sentence (information about WS2801) * added new images * moved main image * Delete wled_logo.png * mail to image * Some design changes in readme - added images - added discord banner - replaced email with image (protection for spam bots) * removed mail image * Delete mail.png * Added compatible LED Strips table I added this, because I thought for a long time that WLED doesn't support WS2801. I didn't read the wiki. And so I think this could be useful for many other people. * Added emojy for Compatible LED Strips * compressed images * Changed path to compressed images * Delete macbook-pro-space-gray-on-the-wooden-table.jpg * Delete walking-with-iphone-x.jpg 2020-06-08 08:55:37 +00:00
Migrate to ESPAsyncE131 2019-11-18 19:43:27 +00:00			`Disclaimer:`
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org> 2022-12-10 15:12:55 +00:00
			`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.`

Add CY=2 for cycle toggling (closes #1174) 2020-09-20 14:40:32 +00:00			`As per the MIT license, I assume no liability for any damage to you or any other person or equipment.`
Migrate to ESPAsyncE131 2019-11-18 19:43:27 +00:00