WLED/readme.md

62 lines
2.8 KiB
Markdown
Raw Normal View History

2019-02-09 15:41:55 +01:00
![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)
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!
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!
2016-09-11 23:07:18 +02:00
2018-10-04 23:16:25 +02:00
### Features:
2019-08-31 01:41:25 +02:00
- WS2812FX library integrated for 80 special effects
- FastLED noise effects and palettes
- Customizable Mobile and desktop UI with color and effect controls
- Settings page - configuration over network
- Access Point and station mode - automatic failsafe AP
- Support for RGBW strips
- 25 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
2018-10-04 23:16:25 +02:00
### Supported light control interfaces:
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)
### Quick start guide and documentation:
See the [wiki](https://github.com/Aircoookie/WLED/wiki)!
2019-11-10 00:54:35 +01:00
DrZzs has made some excellent video guides:
https://www.youtube.com/watch?v=tXvtxwK3jRk
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/
### Other
Licensed under the MIT license
Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)!
Uses Linearicons by Perxis!
2017-02-21 23:59:47 +01:00
Join the Discord [server](https://discord.gg/KuqP7NE) to discuss everything about WLED!
2018-10-04 23:16:25 +02:00
You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com).
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)