Skip to content

Commit 895c74b

Browse files
authored
Update command syntax for esptool usage (#286)
write_flash has been replaced with write-flash, erase_flash has been replaced with erase-flash, and -port has been replaced with --port and must not go immeidately after the executable or before the write-flash.
1 parent 7afc5e1 commit 895c74b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/basics/install-binary.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ This installer is not yet available for ESPs with flash chips smaller than 4MB (
2323

2424
- First of all, please follow the steps to install esptool.py [here](https://github.com/espressif/esptool).
2525
- Download the latest [release binary](https://github.com/Aircoookie/WLED/releases) file!
26-
- 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`
26+
- 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 before `write_flash`
2727
- Execute this command:
2828

2929
#### ESP8266
3030

3131
```bash
32-
esptool.py write_flash 0x0 ./WLED_XXX.bin
32+
esptool.py write-flash 0x0 ./WLED_XXX.bin
3333
```
3434

3535
#### ESP32
@@ -38,21 +38,21 @@ Firstly, flash the version 4 bootloader file, which you can find [here](https://
3838
This step only has to be done once, to update afterwards the bootloader does not have to be re-installed.
3939

4040
```bash
41-
esptool.py write_flash 0x0 ./esp32_bootloader_v4.bin
41+
esptool.py write-flash 0x0 ./esp32_bootloader_v4.bin
4242
```
4343

4444
Now you can flash the actual firmware binary. Keep in mind the bootloader needs to have a flash offset of 0, but the firmware 0x10000.
4545

4646
```bash
47-
esptool.py write_flash 0x10000 ./WLED_XXX.bin
47+
esptool.py write-flash 0x10000 ./WLED_XXX.bin
4848
```
4949

5050
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
5151

5252
- If you experience issues, run this command before trying `write_flash` again (Note: this will erase all settings stored on the ESP!)
5353

5454
```bash
55-
esptool.py erase_flash
55+
esptool.py erase-flash
5656
```
5757

5858
If you have a MagicHome controller, here is a [good video tutorial](https://www.youtube.com/watch?v=qgBAU39v07k) on how to flash it.

0 commit comments

Comments
 (0)