From 3a9a1bb3b56524559a8b33b04aedcdef1b19ef68 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 16:26:48 -0500 Subject: [PATCH 01/19] Fix grammar, heading case and WiFi spelling on the Getting Started page Grammar: "to you ESP board", "coming to and end of support", "Recommend is to use", and "scripts which is allow you to update". Headings: "Quick start guide" and "Software update procedure" now use title case, matching the rest of the site. WiFi: the page used both "WiFi" and "Wifi". It now uses "WiFi" throughout, which matches the settings docs and the rest of the site. Also removes two stray trailing spaces and notes that curl ships with Windows 11 as well as Windows 10. --- docs/basics/getting-started.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 6ece1b60f..6fe6d5472 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -12,11 +12,11 @@ hide: !!! warning "ESP8266 End of Life" - Do not install any new setups using ESP8266. While WLED currently still supports ESP8266, all new setups should be using the ESP32 as it's much better hardware and ESP8266 is coming to and end of support. + Do not install any new setups using ESP8266. While WLED currently still supports ESP8266, all new setups should use the ESP32 as it's much better hardware and ESP8266 support is coming to an end. -### Quick start guide +### Quick Start Guide -**1.** Connect a WS2812B-compatible RGB(W) led strip to you ESP board: +**1.** Connect a WS2812B-compatible RGB(W) LED strip to your ESP board: - For ESP32 use `GPIO16` (or `IO16` or `G16`); GPIOs `4`, `13` and `16-33` can be used, other pins are not recommended. - For ESP8266 use `GPIO2`, on most development boards this pin is labeled `D4`. @@ -32,7 +32,7 @@ Check out the [Wiring Guides](/basics/wiring-guides) for more examples. While using an ESP8266 and LEDs that have clock and data, you can either use hardware SPI (mostly faster) or software SPI. - hardware SPI: use `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data. - - software SPI: since all pins can be changed in the Hardware section of LED settings, you can use any pins. Recommend is to use `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. + - software SPI: since all pins can be changed in the Hardware section of LED settings, you can use any pins. We recommend `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. For safe operation, it is recommended to size your power wires correctly and to integrate fuses. For reference, you may use this [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). @@ -60,17 +60,17 @@ You can also just scan this QR code: Go to the IP `4.3.2.1` in your browser to control your lights! You should also be able to connect to `wled.me` if in access point mode (embedded DNS server). -### Wifi Setup +### WiFi Setup -To connect your WLED module to your home Wifi: +To connect your WLED module to your home WiFi: -**1.** Click on the _Config_ (gear) icon to edit your WLED module settings and choose "Wifi Setup". +**1.** Click on the _Config_ (gear) icon to edit your WLED module settings and choose "WiFi Setup". -**2.** For most home networks, simply enter your Wifi network's name and network password. You can also change the mDNS address for your WLED module here. +**2.** For most home networks, simply enter your WiFi network's name and network password. You can also change the mDNS address for your WLED module here. **3.** Click Save & Connect at the bottom of the page. -**4.** Reconnect your device to your home's Wifi network. +**4.** Reconnect your device to your home's WiFi network. **5.** Check the device list in your router's user interface for the IP of the WLED device within your local network. For easy automatic discovery, use the WLED Native app! Have fun with the WLED software! @@ -82,11 +82,11 @@ To connect your WLED module to your home Wifi: | Function | GPIO | Suggested pin | |---|---|---| LED Data | 2 | ESP8266: 1, 2 (3 if <= 100 LEDs), ESP32: 1, 2, 3, 4, 16 -Button | 0 | +Button | 0 | IR Remote| None | 4 Relay | None | 12 -### Software update procedure +### Software Update Procedure Method 1: Reflashing the new update like a new install (see above). @@ -101,4 +101,4 @@ If you try to access the update page now, you should see the message "OTA lock a Method 3: ArduinoOTA is also supported. !!! info "If you own multiple devices and want to update them" - Since v0.13 of WLED source code includes shell/command prompt scripts which is allow you to update multiple devices with a single command. Please check `tools` subfolder for `multi-update` scripts (.cmd or .sh). You will need to modify them to include IP addresses of your WLED devices and assign firmware binary file for each device. If you are using Windows, make sure you install `curl` utility somewhere in your `PATH` (curl is included with Windows 10 since build 17063). This will only work if "OTA Lock" is disabled. + Since v0.13, the WLED source code includes shell/command prompt scripts that let you update multiple devices with a single command. Please check the `tools` subfolder for the `multi-update` scripts (.cmd or .sh). You will need to modify them to include the IP addresses of your WLED devices and assign a firmware binary file for each device. If you are using Windows, make sure the `curl` utility is somewhere in your `PATH` (curl ships with Windows 10 build 17063 and later, and with Windows 11). This will only work if "OTA Lock" is disabled. From f4f3fd2c3c07103f2de1203980305314b7b2681f Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 16:27:04 -0500 Subject: [PATCH 02/19] Introduce Akemi and move the ESP8266 advice into an annotation The page opened with two stacked admonitions before any content. The "Version Info" box was the only one on the site with no version in it, it just said that pages describe the latest release. This replaces both with a single line introducing Akemi as the annotation marker added in #347, with the ESP8266 guidance as her first annotation. It is the first page to use the marker, so it doubles as the explanation of what she does. --- docs/basics/getting-started.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 6fe6d5472..78e192970 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -7,12 +7,10 @@ hide: ## Welcome to the WLED Wiki! -!!! info "Version Info" - Unless noted otherwise, all information applies to the latest release. +Say hi to Akemi, the WLED mascot. She marks extra information throughout these docs. Click her any time you want to know more. (1) +{ .annotate } -!!! warning "ESP8266 End of Life" - - Do not install any new setups using ESP8266. While WLED currently still supports ESP8266, all new setups should use the ESP32 as it's much better hardware and ESP8266 support is coming to an end. +1. For a new project, an ESP32 is the better pick. It's much more capable hardware, and ESP8266 support is coming to an end. ### Quick Start Guide From e7f735f642dab3ca385bb415154cbb8429e33a5b Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 17:14:51 -0500 Subject: [PATCH 03/19] Trim step 1 and put the wiring diagrams in tabs Step 1 ran two wiring diagrams, an SPI pin list, power and fuse advice and MOSFET part numbers before step 2 told anyone to flash. Most of that is already covered by the Wiring Guides page in the same nav section, which uses the same two images. The two diagrams now sit in Digital and Analog tabs, so both are still on the page but take the space of one. The analog MOSFET parts survive as a caption. The remaining wiring depth is cross-linked instead of repeated, and the ESP8266 SPI pins moved into an annotation. The level shifter link now points at the Wiring Guides section that has the diagrams, rather than at compatible-hardware. --- docs/basics/getting-started.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 78e192970..f55c40c57 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -19,26 +19,27 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d - For ESP32 use `GPIO16` (or `IO16` or `G16`); GPIOs `4`, `13` and `16-33` can be used, other pins are not recommended. - For ESP8266 use `GPIO2`, on most development boards this pin is labeled `D4`. -_If the connecting wire cannot be kept short, use a [level shifter/translator](/basics/compatible-hardware#levelshifters)._ Optionally, connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros). +_If the connecting wire cannot be kept short, use a [level shifter](/basics/wiring-guides#levelshifter)._ Optionally, connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros). !!! warning Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -![DigitalWiring](../assets/images/content/WLED_5VdigitalWiring.png) -Check out the [Wiring Guides](/basics/wiring-guides) for more examples. +=== "Digital LED Strips" -While using an ESP8266 and LEDs that have clock and data, you can either use hardware SPI (mostly faster) or software SPI. + ![DigitalWiring](../assets/images/content/WLED_5VdigitalWiring.png) - - hardware SPI: use `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data. - - software SPI: since all pins can be changed in the Hardware section of LED settings, you can use any pins. We recommend `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. + Also called addressable strips. Each LED can be controlled separately. -For safe operation, it is recommended to size your power wires correctly and to integrate fuses. -For reference, you may use this [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). +=== "Analog LED Strips" -For analog LEDs, the MOSFETs IRLZ44N or STP55NF06L are good candidates. Example circuit: + ![AnalogWiring](../assets/images/content/12Vanalog_wiring.png) -![image](../assets/images/content/12Vanalog_wiring.png) -More analog wiring examples can be found [here](/basics/compatible-led-strips/#non-addressable-led-strips) + Also called non-addressable strips. Every LED shows the same color, and each color channel needs its own GPIO and MOSFET. The IRLZ44N and STP55NF06L are good choices. + +For 12V strips, multiple strips, several power supplies and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). (1) +{ .annotate } + +1. For clock-and-data LEDs on an ESP8266, hardware SPI uses `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data. Software SPI works on any pins, we recommend `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. **2.** Flash the software to your ESP module! There are two options for this step: From 69337b309d3a027901bf3a1dabd9fc3c0d8556d4 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 17:19:16 -0500 Subject: [PATCH 04/19] Split step 1 into digital and analog tabs Step 1 was written for digital strips. It named a WS2812B strip and gave a single data pin, then showed an analog wiring diagram underneath, so the analog path read as an afterthought attached to instructions that did not apply to it. Each tab now carries what differs: the pin choices, the level shifter note and the SPI pins are digital only, and the MOSFET note is analog only. What applies to both stays outside the tabs, including the grounds warning, the pushbutton note and the wiring and fuse links. --- docs/basics/getting-started.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index f55c40c57..34bec6d8b 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -14,32 +14,34 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d ### Quick Start Guide -**1.** Connect a WS2812B-compatible RGB(W) LED strip to your ESP board: +**1.** Connect your LED strip to your ESP board. -- For ESP32 use `GPIO16` (or `IO16` or `G16`); GPIOs `4`, `13` and `16-33` can be used, other pins are not recommended. -- For ESP8266 use `GPIO2`, on most development boards this pin is labeled `D4`. +=== "Digital LED Strips" -_If the connecting wire cannot be kept short, use a [level shifter](/basics/wiring-guides#levelshifter)._ Optionally, connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros). + Also called addressable strips, for example WS2812B-compatible RGB(W) strips. Each LED can be controlled separately. -!!! warning - Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ + - For ESP32 use `GPIO16` (or `IO16` or `G16`); GPIOs `4`, `13` and `16-33` can be used, other pins are not recommended. + - For ESP8266 use `GPIO2`, on most development boards this pin is labeled `D4`. -=== "Digital LED Strips" + _If the connecting wire cannot be kept short, use a [level shifter](/basics/wiring-guides#levelshifter)._ (1) + { .annotate } - ![DigitalWiring](../assets/images/content/WLED_5VdigitalWiring.png) + 1. For clock-and-data LEDs on an ESP8266, hardware SPI uses `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data. Software SPI works on any pins, we recommend `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. - Also called addressable strips. Each LED can be controlled separately. + ![DigitalWiring](../assets/images/content/WLED_5VdigitalWiring.png) === "Analog LED Strips" + Also called non-addressable strips. Every LED shows the same color, and each color channel needs its own GPIO and MOSFET. The IRLZ44N and STP55NF06L are good choices. + ![AnalogWiring](../assets/images/content/12Vanalog_wiring.png) - Also called non-addressable strips. Every LED shows the same color, and each color channel needs its own GPIO and MOSFET. The IRLZ44N and STP55NF06L are good choices. +!!! warning + Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -For 12V strips, multiple strips, several power supplies and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). (1) -{ .annotate } +Optionally, connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros). -1. For clock-and-data LEDs on an ESP8266, hardware SPI uses `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data. Software SPI works on any pins, we recommend `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. +For 12V strips, multiple strips, several power supplies and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). **2.** Flash the software to your ESP module! There are two options for this step: From a6b5b05f189c16502f3a455961615d5504893ed3 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 17:29:27 -0500 Subject: [PATCH 05/19] Put the update methods in tabs and drop ArduinoOTA The three update methods were stacked one after another even though a reader only needs one of them. They are now tabs, labelled by what they do rather than by number. The reflash method said "Reflashing the new update like a new install (see above)", which is not an instruction and points at nothing in particular. It now says where to get the binary and links to the install page. ArduinoOTA is not compiled into 16.0, so its method is removed. It is still referenced in features/settings.md and index.md, which need a separate look. --- docs/basics/getting-started.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 34bec6d8b..c9790508c 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -89,17 +89,19 @@ Relay | None | 12 ### Software Update Procedure -Method 1: Reflashing the new update like a new install (see above). +=== "Reflash" -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. -Then you can select "Manual OTA update" in Security settings and upload a [release binary](https://github.com/wled/WLED/releases). -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". + Download the latest [release binary](https://github.com/wled/WLED/releases) and flash it exactly like the first install. The [Install WLED Binary](/basics/install-binary) page covers every flashing method. -Method 3: ArduinoOTA is also supported. +=== "OTA Update" + + 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. + Then you can select "Manual OTA update" in Security settings and upload a [release binary](https://github.com/wled/WLED/releases). + 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". !!! info "If you own multiple devices and want to update them" Since v0.13, the WLED source code includes shell/command prompt scripts that let you update multiple devices with a single command. Please check the `tools` subfolder for the `multi-update` scripts (.cmd or .sh). You will need to modify them to include the IP addresses of your WLED devices and assign a firmware binary file for each device. If you are using Windows, make sure the `curl` utility is somewhere in your `PATH` (curl ships with Windows 10 build 17063 and later, and with Windows 11). This will only work if "OTA Lock" is disabled. From 9e1d75647f4308b8ec80ea21be76f1210581832e Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 17:53:23 -0500 Subject: [PATCH 06/19] Remove the Default GPIO Usage section Every row of the table is already documented on the page that owns the feature: the button pin in features/macros.md and features/settings.md, the IR pin in interfaces/infrared.md, and the relay pin in features/relay-control.md, which also notes that GPIO12 does not work on the ESP32-C3. The LED data row is covered by step 1, and its ESP32 suggestions contradicted step 1 anyway. The ESP8266 pin notes were the only part not documented elsewhere, so they now sit in an annotation next to the ESP8266 pin recommendation in step 1, including the bit-banging warning and the 100 LED limit on GPIO3. --- docs/basics/getting-started.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index c9790508c..da8615648 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -20,13 +20,14 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d Also called addressable strips, for example WS2812B-compatible RGB(W) strips. Each LED can be controlled separately. - - For ESP32 use `GPIO16` (or `IO16` or `G16`); GPIOs `4`, `13` and `16-33` can be used, other pins are not recommended. - - For ESP8266 use `GPIO2`, on most development boards this pin is labeled `D4`. + For ESP32 use `GPIO16` (or `IO16` or `G16`); GPIOs `4`, `13` and `16-33` can be used, other pins are not recommended. - _If the connecting wire cannot be kept short, use a [level shifter](/basics/wiring-guides#levelshifter)._ (1) + For ESP8266 use `GPIO2`, on most development boards this pin is labeled `D4`. (1) { .annotate } - 1. For clock-and-data LEDs on an ESP8266, hardware SPI uses `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data. Software SPI works on any pins, we recommend `GPIO1` (TxD) for clock and `GPIO2` (D4) for data. + 1. `GPIO1` and `GPIO2` are the recommended LED data pins on ESP8266, and `GPIO3` works for up to 100 LEDs. Other pins need _bit-banging_, which can slow performance and cause problems elsewhere such as with IR decoding. For clock-and-data LEDs, hardware SPI uses `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data, and software SPI works on any pins. All pins can be changed in the Hardware section of LED settings. + + _If the connecting wire cannot be kept short, use a [level shifter](/basics/wiring-guides#levelshifter)._ ![DigitalWiring](../assets/images/content/WLED_5VdigitalWiring.png) @@ -75,18 +76,6 @@ To connect your WLED module to your home WiFi: **5.** Check the device list in your router's user interface for the IP of the WLED device within your local network. For easy automatic discovery, use the WLED Native app! Have fun with the WLED software! -### Default GPIO Usage - -!!! info "These are only defaults" - All pins can be changed in the Hardware section of LED settings. Please note that these are GPIO numbers, please consult a pinout for your board to find the labeled pin (e.g `D4` = `GPIO2` on most ESP8266 boards). When using an ESP8266 board, it's recommended to use pins `GPIO1`, `GPIO2`, or `GPIO3` for LED Data; using other pins will require _bit-banging_ and may cause slow performance and/or issues elsewhere (such as with IR decoding). - -| Function | GPIO | Suggested pin | -|---|---|---| -LED Data | 2 | ESP8266: 1, 2 (3 if <= 100 LEDs), ESP32: 1, 2, 3, 4, 16 -Button | 0 | -IR Remote| None | 4 -Relay | None | 12 - ### Software Update Procedure === "Reflash" @@ -96,12 +85,13 @@ Relay | None | 12 === "OTA Update" 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. - Then you can select "Manual OTA update" in Security settings and upload a [release binary](https://github.com/wled/WLED/releases). - 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". + + 1. Type the correct OTA passphrase (default: "wledota") in the settings menu and remove the tick in the checkbox "OTA locked". + 2. Save settings and reboot the ESP. + 3. Select "Manual OTA update" in Security settings and upload a [release binary](https://github.com/wled/WLED/releases). + 4. When you are done, it is recommended to lock the OTA function again. Tick the checkbox and reboot. You can change the passphrase by typing in a new one first. + + If you try to access the update page while OTA is locked, you should see the message "OTA lock active". !!! info "If you own multiple devices and want to update them" Since v0.13, the WLED source code includes shell/command prompt scripts that let you update multiple devices with a single command. Please check the `tools` subfolder for the `multi-update` scripts (.cmd or .sh). You will need to modify them to include the IP addresses of your WLED devices and assign a firmware binary file for each device. If you are using Windows, make sure the `curl` utility is somewhere in your `PATH` (curl ships with Windows 10 build 17063 and later, and with Windows 11). This will only work if "OTA Lock" is disabled. From f4c186d697cb91ddd2a5c0878577636846bf196a Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 18:05:59 -0500 Subject: [PATCH 07/19] Say up front what the wiring actually involves Step 1 went straight from "connect your LED strip" into GPIO numbers. It now says what the job is first, three connections, and points at the diagrams for the extras. --- docs/basics/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index da8615648..6470efe6c 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -14,7 +14,7 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d ### Quick Start Guide -**1.** Connect your LED strip to your ESP board. +**1.** Connect your LED strip to your ESP board. At its simplest, it's three connections: power, data, and ground. The diagrams below show the extras worth adding. === "Digital LED Strips" @@ -42,7 +42,7 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d Optionally, connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros). -For 12V strips, multiple strips, several power supplies and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). +For 12V strips, multiple strips, several power supplies, and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). **2.** Flash the software to your ESP module! There are two options for this step: From abd2730c607fe50c9ec8bf4efe3e1fc4e33472e8 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 18:37:40 -0500 Subject: [PATCH 08/19] Give step 2 a single path and call out the result Step 2 offered installing a binary and compiling from source as equal choices, which asks a newcomer to make a decision they are not equipped to make. Almost nobody reaching a quick start needs to compile. The web installer is now the primary action, since the install page calls it by far the easiest and fastest way. Compiling stays visible, labelled for advanced users, so people who do want it can still find it here. The "how do I know it worked" line is now a success callout instead of a passing sentence, and uses 30 rather than thirty to match every other LED count on the site. --- docs/basics/getting-started.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 6470efe6c..d067e97a4 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -40,17 +40,19 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d !!! warning Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -Optionally, connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros). +For 12V strips, multiple strips, several power supplies, and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). (1) +{ .annotate } -For 12V strips, multiple strips, several power supplies, and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). +1. While you have the board in your hands, you can also connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground, for [configurable actions](/features/macros). -**2.** Flash the software to your ESP module! There are two options for this step: +**2.** Flash the software to your ESP module. The easiest way is the WLED web installer, which flashes your board straight from the browser. -[I just want to use WLED! (install release binary)](/basics/install-binary) +[Install WLED](/basics/install-binary#flashing-method-1-wled-web-installer){ .md-button .md-button--primary } -[I want to modify WLED (compile from source code)](/advanced/compiling-wled) +Other flashing methods are on the [Install WLED Binary](/basics/install-binary) page. Advanced users who want to change WLED before flashing it can [compile it from source](/advanced/compiling-wled) instead. -If everything worked the first thirty LEDs will light up in bright orange to stimulate courage, friendliness and success! +!!! success "How to tell it worked" + The first 30 LEDs will light up in bright orange to stimulate courage, friendliness and success! **3.** Use a WiFi device to connect to the access point `WLED-AP` using the default password `wled1234`. You can also just scan this QR code: From 8223965150d0b3df0977d789bcea21f11268bd04 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 18:41:10 -0500 Subject: [PATCH 09/19] Turn the wiring cross-links into a short list Two sentences carrying three references read as prose but work as a lookup, so they are now one line each. The optional pushbutton joins them rather than sitting in an annotation, which also keeps it visible to someone scanning the page. --- docs/basics/getting-started.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index d067e97a4..39f38e38f 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -40,10 +40,9 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d !!! warning Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -For 12V strips, multiple strips, several power supplies, and level shifters, see the [Wiring Guides](/basics/wiring-guides). To size your power wires and fuses, use the [LED power, wiring and fuse calculator](https://wled-calculator.github.io/). (1) -{ .annotate } - -1. While you have the board in your hands, you can also connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground, for [configurable actions](/features/macros). +- 12V strips, multiple strips, several supplies, level shifters: [Wiring Guides](/basics/wiring-guides) +- Wire and fuse sizing: [LED power, wiring and fuse calculator](https://wled-calculator.github.io/) +- Optional pushbutton on `GPIO0` (`D3` on NodeMCU/Wemos, `IO17` on ESP32): [configurable actions](/features/macros) **2.** Flash the software to your ESP module. The easiest way is the WLED web installer, which flashes your board straight from the browser. From f022439397f401a5943a2efb11703bb0d5888c1d Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 19:12:50 -0500 Subject: [PATCH 10/19] Rework the WiFi setup steps The steps did not mention that 4.3.2.1 stops working once the device joins your network, which is why step 5 sent people digging through their router. The mDNS address is now its own step with an example, and it is the primary way to reach the device afterwards. Also covers the Scan button, notes that the password is case-sensitive, and says that the app shows the hostname and IP. Collects the wiring cross-links into their own section, and says "phone or computer" and "WiFi network" rather than "WiFi device" and "access point" where a beginner meets them for the first time. --- docs/basics/getting-started.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 39f38e38f..fe258c356 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -40,10 +40,6 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d !!! warning Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -- 12V strips, multiple strips, several supplies, level shifters: [Wiring Guides](/basics/wiring-guides) -- Wire and fuse sizing: [LED power, wiring and fuse calculator](https://wled-calculator.github.io/) -- Optional pushbutton on `GPIO0` (`D3` on NodeMCU/Wemos, `IO17` on ESP32): [configurable actions](/features/macros) - **2.** Flash the software to your ESP module. The easiest way is the WLED web installer, which flashes your board straight from the browser. [Install WLED](/basics/install-binary#flashing-method-1-wled-web-installer){ .md-button .md-button--primary } @@ -53,13 +49,13 @@ Other flashing methods are on the [Install WLED Binary](/basics/install-binary) !!! success "How to tell it worked" The first 30 LEDs will light up in bright orange to stimulate courage, friendliness and success! -**3.** Use a WiFi device to connect to the access point `WLED-AP` using the default password `wled1234`. +**3.** On your phone or computer, connect to the WiFi network `WLED-AP` using the default password `wled1234`. You can also just scan this QR code: ![QR-Code](../assets/images/content/getting-started-wled-ap-qr.png) !!! tip "WLED-AP is not showing up!" - If you do not see the `WLED-AP` SSID, the default SSID may have been changed at [compile time](/advanced/custom-ap). + If you do not see the `WLED-AP` network, its name may have been changed at [compile time](/advanced/custom-ap). Go to the IP `4.3.2.1` in your browser to control your lights! You should also be able to connect to `wled.me` if in access point mode (embedded DNS server). @@ -69,13 +65,24 @@ To connect your WLED module to your home WiFi: **1.** Click on the _Config_ (gear) icon to edit your WLED module settings and choose "WiFi Setup". -**2.** For most home networks, simply enter your WiFi network's name and network password. You can also change the mDNS address for your WLED module here. +**2.** Select **Scan** to find nearby networks, or type your network name. Enter your WiFi password, which is case-sensitive. + +**3.** Set an **mDNS address**, such as `wled-livingroom`. This becomes the name you use to reach your device from now on. + +**4.** Click Save & Connect at the bottom of the page. -**3.** Click Save & Connect at the bottom of the page. +**5.** Reconnect your phone or computer to your home WiFi network. -**4.** Reconnect your device to your home's WiFi network. +**6.** Open your mDNS address in a browser, for example `http://wled-livingroom.local`. If you didn't set one, the WLED Native app finds your device automatically and shows its hostname and IP under Config, or you can look up the IP in your router's device list. Have fun with the WLED software! -**5.** Check the device list in your router's user interface for the IP of the WLED device within your local network. For easy automatic discovery, use the WLED Native app! Have fun with the WLED software! +!!! tip "4.3.2.1 stops working" + Once your device joins your home network, `4.3.2.1` and `wled.me` stop working. Use your mDNS address or the device's IP instead. + +### Useful Links + +- 12V strips, multiple strips, several supplies, level shifters: [Wiring Guides](/basics/wiring-guides) +- Wire and fuse sizing: [LED power, wiring and fuse calculator](https://wled-calculator.github.io/) +- Optional pushbutton on `GPIO0` (`D3` on NodeMCU/Wemos, `IO17` on ESP32): [configurable actions](/features/macros) ### Software Update Procedure From 717dd90c82202f57def04cd27d33aeecdb027a4b Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 19:20:18 -0500 Subject: [PATCH 11/19] Add a section on finding your device with the WLED app Step 6 pointed at the app for "automatic discovery" without saying that it also shows you the address to use. Finding the hostname and IP is now its own section, with the store links in tabs. Calls it the WLED app rather than WLED Native. The rest of the docs still use the old name and need a follow-up. --- docs/basics/getting-started.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index fe258c356..3c418833f 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -73,11 +73,29 @@ To connect your WLED module to your home WiFi: **5.** Reconnect your phone or computer to your home WiFi network. -**6.** Open your mDNS address in a browser, for example `http://wled-livingroom.local`. If you didn't set one, the WLED Native app finds your device automatically and shows its hostname and IP under Config, or you can look up the IP in your router's device list. Have fun with the WLED software! +**6.** Open your mDNS address in a browser, for example `http://wled-livingroom.local`. If you didn't set one, use the WLED app to find your device, or look up its IP in your router's device list. !!! tip "4.3.2.1 stops working" Once your device joins your home network, `4.3.2.1` and `wled.me` stop working. Use your mDNS address or the device's IP instead. +### Find Your Device with the WLED App + +The WLED app discovers devices on your network for you, so you don't have to dig through your router. + +=== "iOS" + + Install [WLED from the App Store](https://apps.apple.com/us/app/wled-official-app/id6446207239). + +=== "Android" + + Install [WLED from Google Play](https://play.google.com/store/apps/details?id=ca.cgagnier.wlednativeandroid). + +1. Connect your phone to the same WiFi network as your WLED device. +2. Your device appears in the app automatically. Select it, then open the **Config** tab in the top right. +3. Choose **WiFi Setup**. At the bottom of that screen is a text box with your hostname, ending in `.local`, and the IP address directly below it. + +Either one works in a browser, as `http://your-hostname.local` or `http://your-ip-address`. + ### Useful Links - 12V strips, multiple strips, several supplies, level shifters: [Wiring Guides](/basics/wiring-guides) From be80072c3e13761bc1530ca7eac6de6c605a4d54 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 19:34:20 -0500 Subject: [PATCH 12/19] Point the install button at the installer and tidy step 3 The button went to the docs page about the web installer rather than the installer, so it now goes to install.wled.me. Step 3 leads with wled.me rather than the IP, and drops the reference to the embedded DNS server, which does not help anyone trying to reach their lights. The QR code is centred, captioned, and no longer 300px wide. --- docs/basics/getting-started.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 3c418833f..d237f89de 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -40,11 +40,11 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d !!! warning Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -**2.** Flash the software to your ESP module. The easiest way is the WLED web installer, which flashes your board straight from the browser. +**2.** Flash the software to your ESP module. The web installer flashes your board straight from the browser. -[Install WLED](/basics/install-binary#flashing-method-1-wled-web-installer){ .md-button .md-button--primary } +[Install WLED](https://install.wled.me){ .md-button .md-button--primary } -Other flashing methods are on the [Install WLED Binary](/basics/install-binary) page. Advanced users who want to change WLED before flashing it can [compile it from source](/advanced/compiling-wled) instead. +Other flashing methods, including for boards with less than 4MB of flash, are on the [Install WLED Binary](/basics/install-binary) page. Advanced users who want to change WLED before flashing it can [compile it from source](/advanced/compiling-wled) instead. !!! success "How to tell it worked" The first 30 LEDs will light up in bright orange to stimulate courage, friendliness and success! @@ -52,12 +52,15 @@ Other flashing methods are on the [Install WLED Binary](/basics/install-binary) **3.** On your phone or computer, connect to the WiFi network `WLED-AP` using the default password `wled1234`. You can also just scan this QR code: -![QR-Code](../assets/images/content/getting-started-wled-ap-qr.png) +
+ ![QR-Code](../assets/images/content/getting-started-wled-ap-qr.png){ width="220" } +
Scan to join WLED-AP
+
!!! tip "WLED-AP is not showing up!" If you do not see the `WLED-AP` network, its name may have been changed at [compile time](/advanced/custom-ap). -Go to the IP `4.3.2.1` in your browser to control your lights! You should also be able to connect to `wled.me` if in access point mode (embedded DNS server). +Open `wled.me` in your browser to control your lights. The IP `4.3.2.1` works too while you're connected to WLED-AP. ### WiFi Setup From 708acb03865a683be1ad31b08fe84e2b338f361d Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 19:36:26 -0500 Subject: [PATCH 13/19] Use one name for the hardware The page called the same thing an ESP board, an ESP module, a WLED module and a WLED device. It now says ESP board before WLED is flashed onto it, and WLED device afterwards, which is what the rest of the site uses. --- docs/basics/getting-started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index d237f89de..84453a8f7 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -40,7 +40,7 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d !!! warning Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO pins to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_ -**2.** Flash the software to your ESP module. The web installer flashes your board straight from the browser. +**2.** Flash the software to your ESP board. The web installer flashes it straight from the browser. [Install WLED](https://install.wled.me){ .md-button .md-button--primary } @@ -64,9 +64,9 @@ Open `wled.me` in your browser to control your lights. The IP `4.3.2.1` works to ### WiFi Setup -To connect your WLED module to your home WiFi: +To connect your WLED device to your home WiFi: -**1.** Click on the _Config_ (gear) icon to edit your WLED module settings and choose "WiFi Setup". +**1.** Click on the _Config_ (gear) icon to edit your WLED device settings and choose "WiFi Setup". **2.** Select **Scan** to find nearby networks, or type your network name. Enter your WiFi password, which is case-sensitive. From 1232781633848065ed3e7b11fe21e4c38cad532b Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 19:46:29 -0500 Subject: [PATCH 14/19] Say device rather than ESP in the OTA steps --- docs/basics/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 84453a8f7..add31aa71 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -116,7 +116,7 @@ Either one works in a browser, as `http://your-hostname.local` or `http://your-i The software has an integrated _OTA software update_ capability. 1. Type the correct OTA passphrase (default: "wledota") in the settings menu and remove the tick in the checkbox "OTA locked". - 2. Save settings and reboot the ESP. + 2. Save settings and reboot your device. 3. Select "Manual OTA update" in Security settings and upload a [release binary](https://github.com/wled/WLED/releases). 4. When you are done, it is recommended to lock the OTA function again. Tick the checkbox and reboot. You can change the passphrase by typing in a new one first. From e00dc02dff327af34779de8d6623cd4a35cfb823 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 13 Aug 2026 19:47:46 -0500 Subject: [PATCH 15/19] Match the page title to its nav entry AGENTS.md requires the front matter title to match the entry in mkdocs.yml. The nav says Quick Start, which is also what the page header already displayed, while the browser tab said Getting Started. --- docs/basics/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index add31aa71..29ac71624 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -1,5 +1,5 @@ --- -title: Getting Started +title: Quick Start hide: # - navigation # - toc From 7adc67f2d2e4fd5338122b7c6dc14f22e62e1bb4 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Fri, 14 Aug 2026 11:17:16 -0500 Subject: [PATCH 16/19] Address review: pin conflict, analog success check, mDNS fallback The pushbutton line recommended IO17 while step 1 lists GPIO 16-33 as usable for LED data, so following both assigned one pin twice. It now says to pick a free pin. The success check described a digital strip only. On analog every LED shares the same channels, so a working setup looked like a failure. Step 6 only covered having no mDNS address set, not a name that fails to resolve. --- docs/basics/getting-started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 29ac71624..cbe202295 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -47,7 +47,7 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d Other flashing methods, including for boards with less than 4MB of flash, are on the [Install WLED Binary](/basics/install-binary) page. Advanced users who want to change WLED before flashing it can [compile it from source](/advanced/compiling-wled) instead. !!! success "How to tell it worked" - The first 30 LEDs will light up in bright orange to stimulate courage, friendliness and success! + The first 30 LEDs will light up in bright orange to stimulate courage, friendliness and success! On an analog strip the whole strip turns orange, since every LED shares the same channels. **3.** On your phone or computer, connect to the WiFi network `WLED-AP` using the default password `wled1234`. You can also just scan this QR code: @@ -76,7 +76,7 @@ To connect your WLED device to your home WiFi: **5.** Reconnect your phone or computer to your home WiFi network. -**6.** Open your mDNS address in a browser, for example `http://wled-livingroom.local`. If you didn't set one, use the WLED app to find your device, or look up its IP in your router's device list. +**6.** Open your mDNS address in a browser, for example `http://wled-livingroom.local`. If you didn't set one, or the `.local` name doesn't resolve on your device, use the WLED app to find it, or look up its IP in your router's device list. !!! tip "4.3.2.1 stops working" Once your device joins your home network, `4.3.2.1` and `wled.me` stop working. Use your mDNS address or the device's IP instead. @@ -103,7 +103,7 @@ Either one works in a browser, as `http://your-hostname.local` or `http://your-i - 12V strips, multiple strips, several supplies, level shifters: [Wiring Guides](/basics/wiring-guides) - Wire and fuse sizing: [LED power, wiring and fuse calculator](https://wled-calculator.github.io/) -- Optional pushbutton on `GPIO0` (`D3` on NodeMCU/Wemos, `IO17` on ESP32): [configurable actions](/features/macros) +- Optional pushbutton for [configurable actions](/features/macros). The default is `GPIO0` (`D3` on NodeMCU/Wemos). On ESP32 use any free pin, such as `IO17`, that you are not already using for LED data ### Software Update Procedure From 8a63ba1f5ff697f1e67406278d722eacebbded2b Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Fri, 14 Aug 2026 11:17:31 -0500 Subject: [PATCH 17/19] Scope the three-connection line to digital strips It sat above both tabs, so it also claimed to describe analog strips, which have no data line and need a channel per color. --- docs/basics/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index cbe202295..19942c7f4 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -14,7 +14,7 @@ Say hi to Akemi, the WLED mascot. She marks extra information throughout these d ### Quick Start Guide -**1.** Connect your LED strip to your ESP board. At its simplest, it's three connections: power, data, and ground. The diagrams below show the extras worth adding. +**1.** Connect your LED strip to your ESP board. A digital strip is three connections at its simplest: power, data, and ground. Analog strips need a channel per color instead. The diagrams below show the extras worth adding. === "Digital LED Strips" From 2174658b1780eb45fa35f0d7920a38ae8bf8043e Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Fri, 14 Aug 2026 11:18:12 -0500 Subject: [PATCH 18/19] Say to change the AP password and to relock OTA after a batch update Step 3 handed out the default wled1234 with no prompt to replace it, and the multi-device note required OTA Lock off without saying to turn it back on. --- docs/basics/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 19942c7f4..81adaee54 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -70,7 +70,7 @@ To connect your WLED device to your home WiFi: **2.** Select **Scan** to find nearby networks, or type your network name. Enter your WiFi password, which is case-sensitive. -**3.** Set an **mDNS address**, such as `wled-livingroom`. This becomes the name you use to reach your device from now on. +**3.** Set an **mDNS address**, such as `wled-livingroom`. This becomes the name you use to reach your device from now on. Change the AP password here too, since `wled1234` is the same on every WLED device. **4.** Click Save & Connect at the bottom of the page. @@ -123,4 +123,4 @@ Either one works in a browser, as `http://your-hostname.local` or `http://your-i If you try to access the update page while OTA is locked, you should see the message "OTA lock active". !!! info "If you own multiple devices and want to update them" - Since v0.13, the WLED source code includes shell/command prompt scripts that let you update multiple devices with a single command. Please check the `tools` subfolder for the `multi-update` scripts (.cmd or .sh). You will need to modify them to include the IP addresses of your WLED devices and assign a firmware binary file for each device. If you are using Windows, make sure the `curl` utility is somewhere in your `PATH` (curl ships with Windows 10 build 17063 and later, and with Windows 11). This will only work if "OTA Lock" is disabled. + Since v0.13, the WLED source code includes shell/command prompt scripts that let you update multiple devices with a single command. Please check the `tools` subfolder for the `multi-update` scripts (.cmd or .sh). You will need to modify them to include the IP addresses of your WLED devices and assign a firmware binary file for each device. If you are using Windows, make sure the `curl` utility is somewhere in your `PATH` (curl ships with Windows 10 build 17063 and later, and with Windows 11). This will only work if "OTA Lock" is disabled, so turn it back on and reboot once the batch is finished. From c9f5790219fbae02ed60116b2853d5294461c056 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 20 Aug 2026 10:47:22 -0500 Subject: [PATCH 19/19] Link to the Web UI tour as a next step --- docs/basics/getting-started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 4ff00d94a..a6e55002b 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -81,6 +81,8 @@ To connect your WLED device to your home WiFi: !!! tip "4.3.2.1 stops working" Once your device joins your home network, `4.3.2.1` and `wled.me` stop working. Use your mDNS address or the device's IP instead. +Once you're in, take a look at [The Web UI](/basics/web-ui) to find your way around the interface. + ### Find Your Device with the WLED App The WLED app discovers devices on your network for you, so you don't have to dig through your router.