Skip to content
Aircoookie edited this page Apr 3, 2019 · 20 revisions

Welcome to the WLED wiki!

If not noted otherwise, all information applies to the latest release (v0.8.4).

Quick start guide:

  1. Connect a WS2812B/SK6812/WS2811 RGB(W) led strip to GPIO2. Optionally connect a normally open pushbutton to GPIO0 (internal pull-up) and ground.

  2. Follow a guide to setup your Arduino IDE (I am using version 1.8.7) with the ESP8266 libraries. For current compiles I recommend Arduino core version 2.4.2 (the 2.5.0 core may have WiFi issues, see https://github.com/esp8266/Arduino/issues/5784).

  3. You will need to install the NeoPixelBus library by Makuna (2.4.3), FastLED, ESPAsyncWebServer, AsyncTCP, and IRRemoteESP8266 (not for ESP32). All other dependencies are included with WLED for convenience. Now compile and flash the software!

  4. Connect to automatically started WiFi access point "WLED-AP" using default passwort "wled1234". Go to the IP "192.168.4.1". You should also be able to use the embedded DNS server and connect to "wled.me".

  5. Click on the cog icon to edit settings like connecting the module to your home WiFi.

  6. Check your router device list for the IP of the WLED device inside your local network. For easier discovery, use the WLED app!

  7. Have fun with the software!

Compile settings:

  • Board: NodeMCU 1.0 (ESP-12E module) (or select your ESP board)
  • CPU frequency: 80 MHz
  • Flash size : 4MB (1MB SPIFFS)
  • LwIP variant (if applicable): 2.0 Higher Bandwidth (use 1.4 if you experience responsiveness issues)
  • Upload speed: Any, 921600 recommended

Software update procedure:

Method 1: Reflash the new update source via USB.

Method 2: The software has an integrated OTA software update capability. First you have to enable it by typing in the correct OTA passphrase (default: "wledota") in the settings menu. Remove the tick in the checkbox "OTA locked". Then save settings and reboot the ESP. Now you can go to "/update" to update binary firmware. After you are done, it is recommended to lock the OTA function again. To do so, tick the checkbox again (you can change the passphrase by typing in a new one now). Reboot. If you try to access the update page now, you should see the message "OTA lock active".

Method 3: ArduinoOTA is also supported.

You can’t perform that action at this time.