WLEDwiki/Install-WLED-binary.md

53 lines
3.9 KiB
Markdown
Raw Normal View History

2020-02-27 15:30:30 +01:00
### Flashing method 1: esptool
2020-02-27 15:55:13 +01:00
- First of all, please follow the steps to install esptool.py [here](https://github.com/espressif/esptool).
- Download the latest [release binary](https://github.com/Aircoookie/WLED/releases) file!
- Make sure only one ESP device/microcontroller is connected to your computer! Otherwise you could accidentally overwrite the wrong one. If you know the serial port, you can also add the `-port COM3` attribute after `write_flash`
- Exectute this command:
ESP8266
```
esptool.py write_flash 0x0 .\WLED_XXX.bin
```
2020-02-27 16:07:09 +01:00
ESP32 (you will need to have a bootloader installed)
2020-02-27 15:55:13 +01:00
```
esptool.py write_flash 0x10000 .\WLED_XXX.bin
```
2020-02-27 16:07:09 +01:00
If the ESP32 is new, you will need to flash the bootloader first. This is not required if you had an Arduino sketch running on it before. You can find the bootloader file in the assets for the 0.9.1 release.
```
esptool.py write_flash 0x0 .\esp32_bootloader.bin
```
When esptool.py says `Connecting...`, some ESP32 boards require you to hold the boot button (to the right of the USB port for a few seconds)
2020-02-27 15:55:13 +01:00
- If you experience issues, run this command before trying `write_flash` again (Note: this will erase all settings stored on the ESP!)
```
esptool.py erase_flash
```
2020-02-27 15:30:30 +01:00
2020-02-27 16:17:38 +01:00
### Flashing method 2: [ESP Home Flasher](https://github.com/esphome/esphome-flasher/releases) tool
2020-02-27 15:30:30 +01:00
2020-02-27 16:07:09 +01:00
This is a GUI-based tool recommended by some users as easier to use than esptool.
For some ESP32 boards, you might have to press some buttons after uploading:
> Hold both buttons down, plug it in, start flashing, then when is tries to detect, let go of the button to the left of the USB as you look at it, then when it detects the board type, let go of the other button.
2020-02-27 15:55:13 +01:00
### Flashing method 3: OTA update
You can alternatively use my [basic HTTP OTA updater](https://github.com/Aircoookie/ESP8266MinimalHTTPUpdater) sketch and upload the binary! This requires the Arduino IDE and ESP8266 core installed.
If your device is already running a firmware with built-in OTA capability, you can probably use that as well.
2020-02-27 15:30:30 +01:00
2020-02-27 15:16:57 +01:00
### What binary should I use?
2020-02-27 15:17:47 +01:00
I would recommend to always use the latest release. Please use the following binary for these boards respectively:
2020-02-27 15:21:06 +01:00
Binary Name | For devices
| --- | --- |
2020-03-27 14:27:26 +01:00
| WLED_0.x.x_ESP8266.bin | NodeMCU, Wemos D1 mini, ESP-12, all ESP8266 with 4Mb flash. Recommended. (The ledpin is GPIO2 in this case.)
2020-02-27 15:19:49 +01:00
| WLED_0.x.x_ESP32.bin | All ESP32 devices (try [this](https://github.com/Aircoookie/WLED/issues/517#issuecomment-571333712) if the WLED-AP doesn't appear after flashing) |
| WLED_0.x.x_ESP8266_1M_ota.bin | ESP-01 (black PCB), most Sonoff devices, ESP8265, all ESP8266 with 1Mb flash. This binary has some interfaces disabled (Alexa, Blynk, Hue sync, Infrared) in order for wireless updates to continue working. |
| WLED_0.x.x_ESP8266_1M_full.bin | ESP-01 (black PCB), most Sonoff devices, ESP8265, all ESP8266 with 1Mb flash. This binary has the full feature set, but wireless updates will not work. |
2020-02-27 15:21:06 +01:00
| WLED_0.x.x_ESP8266_512k.bin | ESP-01 (blue PCB), older Sonoff devices, all ESP8266 with 512k flash. Interfaces (Alexa, Blynk, Hue sync, Infrared) disabled, no OTA. Support will not be possible in future versions. |
| WLED_0.x.x_ESP8266_ledpinY.bin | Custom build for 4Mb flash ESP8266 and WS2812b. LED pin is changed (default is GPIO2). LED pin 4 is useful for the QuinLed Dig Uno board. (This is GPIOY and not DY for the D to GPIO mapping, check your boards spec!) |
2020-02-27 15:19:49 +01:00
| WLED_0.x.x_ESP8266_apa102.bin | Custom build for 4Mb flash ESP8266 and APA102 LEDs (clock pin GPIO0, data GPIO2).
| WLED_0.x.x_ESP8266_ws2801.bin | Custom build for 4Mb flash ESP8266 and WS2801 LEDs (clock pin GPIO0, data GPIO2).
| WLED_0.x.x_ESP32_ledpinY.bin | Custom build for ESP32 and WS2812b. LED pin is changed (default is GPIO2). LED pin 16 is useful for the QuinLed Dig Uno board. |
2020-02-27 16:07:09 +01:00
| esp32_bootloader.bin | Not a WLED release. To be flashed to a brand new ESP32 before flashing the WLED binary itself. |
2020-02-27 15:19:49 +01:00