ports/esp32: Remove the --chip option from writing flash instructions.

projectgus · projectgus · commit 06e9206546f3 · 2025-01-07T15:18:43.000+11:00
esptool.py is smart enough to error out if you try to flash a .bin file
that belongs to the wrong target SoC.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton &lt;angus@redyak.com.au&gt;
diff --git a/ports/esp32/boards/deploy.md b/ports/esp32/boards/deploy.md
@@ -6,27 +6,39 @@ If you are putting MicroPython on your board for the first time then you should
 first erase the entire flash using:
 
 ```bash
-esptool.py --chip {mcu} erase_flash
+esptool.py erase_flash
 ```
 
+`esptool.py` will try to detect the serial port with the ESP32 automatically,
+but if this fails or there might be more than one Espressif-based device
+attached to your computer then pass the `--port` option with the name of the
+target serial port. For example:
+
+```bash
+esptool.py --port PORTNAME erase_flash
+```
+
+* On Linux, the port name is usually similar to `/dev/ttyUSB` or `/dev/ttyACM0`.
+* On Mac, the port name is usually similar to `/dev/cu.usbmodem01`.
+* On Windows, the port name is usually similar to `COM4`.
+
 ### Flashing
 
 Then deploy the firmware to the board, starting at address {flash_offset}:
 
 ```bash
-esptool.py --chip {mcu} --baud 460800 write_flash {flash_offset} ESP32_BOARD_NAME-DATE-VERSION.bin
+esptool.py --baud 460800 write_flash {flash_offset} ESP32_BOARD_NAME-DATE-VERSION.bin
 ```
 
 Replace `ESP32_BOARD_NAME-DATE-VERSION.bin` with the `.bin` file downloaded from this page.
 
 ### Troubleshooting
 
-`esptool.py` will try to detect the serial port with the ESP32 automatically. If
-detection is unsuccessful then you can check for the port name manually and then pass the
-`--port` option to esptool.py. For example:
+Similar to the Erasing step, if `esptool.py` can't automatically detect the serial port
+then you can pass it explicitly on the command line. For example:
 
 ```bash
-esptool.py --port PORTNAME --chip {mcu} --baud 460800 write_flash {flash_offset} ESP32_BOARD_NAME-DATE-VERSION.bin
+esptool.py --port PORTNAME --baud 460800 write_flash {flash_offset} ESP32_BOARD_NAME-DATE-VERSION.bin
 ```
 
 * On Linux, the port name is usually similar to `/dev/ttyUSB` or `/dev/ttyACM0`.
