Skip to content

Commit ad81138

Browse files
authored
Merge pull request #1490 from tasmota/revert-1489-esptool-docs
Revert "Updated esptool docs"
2 parents 488ddce + 93afcf1 commit ad81138

9 files changed

+24
-24
lines changed

docs/Create-your-own-Firmware-Build-without-IDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ If this GPIO0 is connected to GND when the module gets power, it starts in a fir
246246
Switch off the power of the board, this will be the reference 'steady state' of the system.
247247

248248
```
249-
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py read-flash 0x00000 0x100000 fcmila_bulb_orig.bin
249+
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py read_flash 0x00000 0x100000 fcmila_bulb_orig.bin
250250
esptool.py v2.6
251251
Found 1 serial ports
252252
Serial port /dev/cuaU0
@@ -280,11 +280,11 @@ If done, then **power the module off**, as this management mode is not restartab
280280
If it's not well, then you may try some queries:
281281

282282
```
283-
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py -p /dev/ttyU0 chip-id
283+
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py -p /dev/ttyU0 chip_id
284284
...
285285
Chip ID: 0x00e02af2
286286
...
287-
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py -p /dev/ttyU0 flash-id
287+
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py -p /dev/ttyU0 flash_id
288288
...
289289
Manufacturer: c8
290290
Device: 4014
@@ -301,7 +301,7 @@ Until you can't get this step working, don't proceed to the next one, it won't w
301301
(With the usual button-pressed-power-on rain dance, and don't forget to power the module off afterwards.)
302302

303303
```
304-
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py erase-flash
304+
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py erase_flash
305305
...
306306
Erasing flash (this may take a while)...
307307
Chip erase completed successfully in 1.6s
@@ -310,7 +310,7 @@ Chip erase completed successfully in 1.6s
310310
## Install the firmware to your module
311311

312312
```
313-
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py write-flash --flash-size 1MB --flash-mode dout 0x00000 firmware.bin
313+
(esptool) [tasmota_installer@lantash ~/esptool]$ esptool.py write_flash --flash_size 1MB --flash_mode dout 0x00000 firmware.bin
314314
Configuring flash size...
315315
Compressed 535424 bytes to 367679...
316316
Wrote 535424 bytes (367679 compressed) at 0x00000000 in 33.8 seconds (effective 126.6 kbit/s)...

docs/ESP32.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Other options include:
4646
esptool.py - use the following command syntax:
4747

4848
```bash
49-
esptool.py write-flash 0x0 tasmota32.factory.bin
49+
esptool.py write_flash 0x0 tasmota32.factory.bin
5050
```
5151

5252
!!! warning "Use a proper power supply!"

docs/Esptool.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Ensure the device is in firmware upload mode.
3737

3838
Backup the current firmware with the following command:
3939
```
40-
esptool.py --port COM5 read-flash 0x00000 ALL image.bin
40+
esptool.py --port COM5 read_flash 0x00000 0x100000 image1M.bin
4141
```
4242
NOTE: When the command completes the device is out of firmware upload mode!
4343

@@ -46,7 +46,7 @@ Ensure the device is in firmware upload mode.
4646

4747
Erase the complete flash memory holding the firmware with the following command:
4848
```
49-
esptool.py --port COM5 erase-flash
49+
esptool.py --port COM5 erase_flash
5050
```
5151
NOTE1: When the command completes the device is out of firmware upload mode!
5252

@@ -58,7 +58,7 @@ Ensure the device is in firmware upload mode.
5858
Load the downloaded Tasmota firmware file *tasmota.bin* with the following command:
5959

6060
```
61-
esptool.py --port COM5 write-flash -fs 1MB -fm dout 0x0 tasmota.bin
61+
esptool.py --port COM5 write_flash -fs 1MB -fm dout 0x0 tasmota.bin
6262
```
6363
NOTE1: When the command completes the device is out of firmware upload mode!
6464

@@ -86,11 +86,11 @@ Once the device is in firmware upload mode the following commands are recommende
8686

8787
Erase the flash completely with the following command (substituting the COM port for the one which was used on your computer)
8888

89-
`esptool.exe --port COM5 erase-flash`
89+
`esptool.exe --port COM5 erase_flash`
9090

9191
Once the erase is complete, reset your device back into programming mode and then upload the firmware using the following command
9292

9393
`
94-
esptool.exe --port COM5 write-flash -fs 1MB -fm dout 0x0 tasmota.bin`
94+
esptool.exe --port COM5 write_flash -fs 1MB -fm dout 0x0 tasmota.bin`
9595

9696

docs/Getting-Started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ To put the ESP into Programming Mode:
131131
??? tip "esptool.py programming mode test"
132132
You can test whether your device is in Programming Mode by attempting to read information from the ESP82xx chip. This requires `esptool.py`. Instructions on installing and using `esptool` are provided below. For example (`COM5` will be your COM port):
133133

134-
- `esptool.py -p COM5 read-mac` (It should read the MAC address. It may fail afterwards during Uploading and running a "stub". This is normal.)
135-
- `esptool.py -p COM5 flash-id`
134+
- `esptool.py -p COM5 read_mac` (It should read the MAC address. It may fail afterwards during Uploading and running a "stub". This is normal.)
135+
- `esptool.py -p COM5 flash_id`
136136

137137
If everything went well, you are now in Programming Mode and ready to continue with [flashing](#flashing). If the flashing process is unable to start, disconnect the device and retry the steps.
138138

@@ -222,14 +222,14 @@ Choose an installation method:
222222
#### Backup Firmware <small>(optional step)</small>
223223
Backup the current firmware with the following command:
224224
```
225-
esptool.py --port COM5 read-flash 0x00000 ALL fwbackup.bin
225+
esptool.py --port COM5 read_flash 0x00000 0x100000 fwbackup.bin
226226
```
227227
*When the command completes the device is not in programming mode anymore.* Repeat the process of putting your device in programming mode.
228228

229229
#### Erase Flash Memory
230230
Erase the complete flash memory holding the firmware with the following command:
231231
```
232-
esptool.py --port COM5 erase-flash
232+
esptool.py --port COM5 erase_flash
233233
```
234234
It only takes a few seconds to erase 1M of flash.
235235

@@ -239,14 +239,14 @@ Choose an installation method:
239239
Load the chosen Tasmota firmware file with the following command (e.g., `tasmota.bin` in this example):
240240

241241
```
242-
esptool.py write-flash -fm dout 0x0 tasmota.bin
242+
esptool.py write_flash -fm dout 0x0 tasmota.bin
243243
```
244244
or for ESP32:
245245
!!! note
246246
_Factory_ binaries are used for inital flashing this time
247247
https://ota.tasmota.com/tasmota32/release/
248248
```
249-
esptool.py write-flash 0x0 tasmota32.factory.bin
249+
esptool.py write_flash 0x0 tasmota32.factory.bin
250250
```
251251

252252
Unplug your serial programming adapter or your device and plug it back in or connect to another power source. Your device is now ready for [Initial configuration](#initial-configuration).

docs/devices/BlitzWolf-SHP6.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Erase flash to avoid issues with dropping WiFi connection.
6161

6262
Example using esptool:
6363
```
64-
esptool.py --port COM3 erase-flash
64+
esptool.py --port COM3 erase_flash
6565
```
6666

6767
### Step 8

docs/devices/H801.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Most boards supported by the Tasmota firmware use GPIO 1 for serial TX. The H801
3737

3838
See [#2155](https://github.com/arendst/Tasmota/issues/2155) for more details.
3939

40-
Please be aware that some of the H801 modules were sold with only 512kB of flash. You can check whether yours is affected by using esptool, with the flash-id command. If you only have 512kB of flash, you can still build your own firmware, but will have to remove components that you do not need, in order to reduce the size of the firmware binary. You will also have to use a linker script for the smaller flash. For an example, see [this issue](https://github.com/arendst/Tasmota/issues/2982)
40+
Please be aware that some of the H801 modules were sold with only 512kB of flash. You can check whether yours is affected by using esptool, with the flash_id command. If you only have 512kB of flash, you can still build your own firmware, but will have to remove components that you do not need, in order to reduce the size of the firmware binary. You will also have to use a linker script for the smaller flash. For an example, see [this issue](https://github.com/arendst/Tasmota/issues/2982)
4141

4242
## Known Issue
4343
While powering up there is a short but bright light flash emitted from the strip.

docs/devices/LSC-Smart-Connect-Smart-Power-Plug.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Simply connect the (clearly labeled) 3v3, GND, TX, RX pins of the TYWE2S to the
1313

1414
With the device connected and in flashing mode, create a backup of the factory firmware, erase the flash, and flash a tasmota firmware approximately as follows:
1515

16-
esptool.py read-flash 0x000000 0x100000 image1M.bin
17-
esptool.py erase-flash
18-
esptool.py write-flash -fs 1MB -fm dout 0x0 tasmota-lite.bin`
16+
esptool.py read_flash 0x000000 0x100000 image1M.bin
17+
esptool.py erase_flash
18+
esptool.py write_flash -fs 1MB -fm dout 0x0 tasmota-lite.bin`
1919

2020
## Configuration
2121
⚠️ Warning! While the below configuration is correct and working, configuring a button on GPIO14 will make the device reset itself to the default Tasmota configuration after a number of seconds.

docs/devices/Sonoff-Slampher.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ After much screwing around, I discovered that simply holding the button while I
1010
I flashed it from a mac terminal window like so:
1111

1212
```shellsession
13-
esptool.py --port /dev/tty.usbserial-A60226NF write-flash -fs 1MB -fm dout 0x0 ~/Downloads/tasmota.bin
13+
esptool.py --port /dev/tty.usbserial-A60226NF write_flash -fs 1MB -fm dout 0x0 ~/Downloads/tasmota.bin
1414
```
1515

1616
The barcode on the box for the device that I received is 6920075757361, it's also labeled with MPN:IM190528001.

docs/devices/Xiaomi-Mi-Desk-Lamp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ As there is plenty of free space in the lamp stand, I left the wires long enough
9696

9797
The rest of the serial flashing process is [as usual](../Getting-Started#hardware-preparation), but if you want to make a backup of the original firmware, keep in mind that the flash size is **2 MBs**.
9898

99-
If you are re-flashing the original firmware, the flash size must be explicitly set to '2MB-c1', **the auto-detected '2MB' doesn't work**, so: `esptool.py write-flash --flash-size 2MB-c1 0x00000 xiaomi_desk_lamp.orig.bin`
99+
If you are re-flashing the original firmware, the flash size must be explicitly set to '2MB-c1', **the auto-detected '2MB' doesn't work**, so: `esptool.py write_flash --flash_size 2MB-c1 0x00000 xiaomi_desk_lamp.orig.bin`
100100

101101

102102
## Serial logging

0 commit comments

Comments
 (0)