doc: improve WLED installation

This commit is contained in:
King Kévin 2024-04-29 12:02:45 +02:00
parent bf576fe66c
commit 03b9eb3118
1 changed files with 47 additions and 18 deletions

View File

@ -95,32 +95,61 @@ Test resettable 1.8A input fuse:
- remove the resistor from the 5V screw terminal
- after a second, the green light should turns back on
WLED installation
-----------------
You can easily install the latest WLED release, but this will not support DMX.
- prepare a USB to UART adapter and 1x6 100 mil pin header to be inserted on the DEBUG port
- connect UART GND to DEBUG GND, UART TX to DEBUG RX, UART RX to DEBUG TX
- plug USB to UART adapter to computer
- remove USB from the board
- go to the [WLED install page](https://install.wled.me/)
- select version (latest release or stable starting with 0.15.0) and audio reactive variant
- click on install
- select serial port, but don't click on connect yet
- press and hold DL button on board
- plug USB into board
- you can release the DL button
- insert and hold pins in DEBUG header with an angle to make temporary contact
- press "Connect" on page
- press "INSTALL WLED"
- wait for 2 minutes to flash WLED, still holding the DEBUG header
WARNING: Do not select WLED version 0.14.*.
It has a [unknown](https://wled.discourse.group/t/cannot-get-wled-flashed-on-esp32-mini-1/10047) [issue](https://github.com/Aircoookie/WLED/issues/3548) with the ESP32-MINI modules used by WLED chain (probably related to the toolchain), which causes a firmware crash and reboot in a loop.
Older v0.13.3 and Sound Reactive v0.13.4 work fine.
If you prefer to use [WLED binary releases](https://github.com/Aircoookie/WLED/releases) and [esptool](https://github.com/espressif/esptool) on the command line instead of the [web interface](https://install.wled.me/), here the commands (set the version to the one wished):
~~~
wget https://install.wled.me/bin/release_0_14_0/esp32_bootloader_v4.bin
esptool.py --port /dev/ttyACM0 --after no_reset write_flash 0x0 ./esp32_bootloader_v4.bin
wget https://install.wled.me/bin/release_0_14_0/WLED_0.14.0_ESP32_audioreactive.bin
esptool.py --port /dev/ttyACM0 --after no_reset write_flash 0x10000 WLED_0.14.0_ESP32_audioreactive.bin
export WLED_VERSION="0.15.0"
export WLED_PATH=`echo $WLED_VERSION | sed 's/\./_/g'`
wget https://install.wled.me/bin/release_${WLED_PATH}/esp32_bootloader_v4.bin
wget https://install.wled.me/bin/release_${WLED_PATH}/WLED_${WLED_VERSION}_ESP32_audioreactive.bin
esptool.py --port /dev/ttyUSB0 erase_flash
esptool.py --port /dev/ttyUSB0 write_flash 0x0 ./esp32_bootloader_v4.bin
esptool.py --port /dev/ttyUSB0 write_flash 0x10000 WLED_${WLED_VERSION}_ESP32_audioreactive.bin
~~~
TODO: make a custom WLED build with
If the USB to UART adapter also breaks out the DTR and RTS signals, you can connect them to the DL and RST pin respectively on the debug header.
Now esptool will take care of resetting and putting the board into bootloader mode.
You don't have to press on the DL button and re-plug the power over USB anymore by hand.
- status LED set
- audio reactive enabled
- DMX out (needs to be implemented)
- DMX in enabled (needs to be implemented)
- all pins configured (that's just a configuration)
A CH340K USB to UART chip can also be soldered on the back of the board.
You then don't need an external USB to UART adapter anymore, as it is now on board.
This is very useful when you have to flash or configure often the board.
status
------
Once the firmware is install, re-plug the power to start it.
If you added the RST button on the back, you can also press this alternatively.
If you connected the DEBUG RST signal to RTS on the USB to UART adapter, you can also lower the line to reset it.
This signal is also connected to the optional on-board USB to UART chip.
On the RJ45 ports there are 4 LEDs.
These indicate the status:
To restart the board and check the debug output:
- the center-right LED indicates the >6V status: it is on when 6-60V power is provided to the board
- the rightmost LED indicates the 5V status: it is on when the on-board DC-DC voltage regulator converts the 6-60V to 5V right after 6-60V is plugged in, or when 5V power is provided externally
- the center-left LED indicates the DMX RX traffic: it blink on DMX input traffic (when the board is configure as slave)
- the leftmost LED indicates the DMX TX traffic: it blinks on DMX output traffic (when the board is configure as master)
~~~
picocom -b 115200 --lower-rts --lower-dtr /dev/ttyUSB0
~~~
installation
============