8000 docs/esp32: Defer to the download page for flashing steps. · micropython/micropython@8e991c0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8e991c0

Browse files
committed
docs/esp32: Defer to the download page for flashing steps.
The user already has it open, and its customised for their particular board. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
1 parent 8cc1938 commit 8e991c0

File tree

1 file changed

+21
-51
lines changed

1 file changed

+21
-51
lines changed

docs/esp32/tutorial/intro.rst

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -62,60 +62,17 @@ features, then you may find the Preview builds useful.
6262
Deploying the firmware
6363
----------------------
6464

65-
Once you have the MicroPython firmware you need to load it onto your ESP32 device.
66-
There are two main steps to do this: first you need to put your device in
67-
bootloader mode, and second you need to copy across the firmware. The exact
68-
procedure for these steps is highly dependent on the particular board and you will
69-
need to refer to its documentation for details.
65+
Once you have the MicroPython firmware you need to load it onto your ESP32
66+
device. There are two main steps to do this: first you need to put your device
67+
in bootloader mode, and second you need to copy across the firmware. The exact
68+
procedure for these steps is highly dependent on the particular board.
7069

71-
Fortunately, most boards have a USB connector, a USB-serial converter, and the DTR
72-
and RTS pins wired in a special way then deploying the firmware should be easy as
73-
all steps can be done automatically. Boards that have such features
74-
include the Adafruit Feather HUZZAH32, M5Stack, Wemos LOLIN32, and TinyPICO
75-
boards, along with the Espressif DevKitC, PICO-KIT, WROVER-KIT dev-kits.
76-
77-
For best results it is recommended to first erase the entire flash of your
78-
device before putting on new MicroPython firmware.
79-
80-
Currently we only support esptool.py to copy across the firmware. You can find
81-
this tool here: `<https://docs.espressif.com/projects/esptool/>`__, or install it
82-
using pip::
83-
84-
pip install esptool
85-
86-
Using esptool.py you can erase the flash with the command::
87-
88-
esptool.py erase_flash
89-
90-
.. note:: On Windows, the command may be named ``esptool`` not ``esptool.py``
91-
92-
Then deploy the new firmware. Use this command for original ESP32 and ESP32-S2 SoCs::
93-
94-
esptool.py --baud 460800 write_flash 0x1000 ESP32_BOARD_NAME-DATE-VERSION.bin
95-
96-
Use this command for all other SoCs (including ESP32-S3, ESP32-C3, and all newer chips)::
97-
98-
esptool.py --baud 460800 write_flash 0 ESP32_BOARD_NAME-DATE-VERSION.bin
99-
100-
Replace ``ESP32_BOARD_NAME-DATE-VERSION.bin`` with the name of your firmware .bin file.
101-
102-
.. note:: If you're unsure which command line to use, check the `MicroPython
103-
download page`_ for your board. Each download page shows an accurate command
104-
line example for that board and its SoC.
70+
Detailed steps can be found on the same `MicroPython download page`_ for your
71+
board. It's recommended that you follow the steps on the download page, as they
72+
are customised for your particular board.
10573

10674
If the above commands run without error 8000 then MicroPython should be installed on
107-
your board! If the command fails, see :ref:`esp32_troubleshooting_install` below.
108-
109-
Serial prompt
110-
-------------
111-
112-
Once you have the firmware on the device you can access the REPL (Python prompt)
113-
over either UART0, which might be connected to a USB-serial converter depending
114-
on your board, or the chip's built-in USB device. The baudrate is 115200.
115-
116-
From here you can now follow the ESP8266 tutorial, because these two Espressif chips
117-
are very similar when it comes to using MicroPython on them. The ESP8266 tutorial
118-
is found at :ref:`esp8266_tutorial` (but skip the Introduction section).
75+
your board! Skip ahead to :ref:`esp32_serial_prompt`.
11976

12077
.. _esp32_troubleshooting_install:
12178

@@ -153,6 +110,19 @@ after flashing, here are some troubleshooting recommendations:
153110
* If you still experience problems with flashing the firmware then please also
154111
refer to the `esptool Troubleshooting documentation`_.
155112

113+
.. _esp32_serial_prompt:
114+
115+
Serial prompt
116+
-------------
117+
118+
Once you have the firmware on the device you can access the REPL (Python prompt)
119+
over either UART0, which might be connected to a USB-serial converter depending
120+
on your board, or the chip's built-in USB device. The baudrate is 115200.
121+
122+
From here you can now follow the ESP8266 tutorial, because these two Espressif chips
123+
are very similar when it comes to using MicroPython on them. The ESP8266 tutorial
124+
is found at :ref:`esp8266_tutorial` (but skip the Introduction section).
125+
156126
.. _esptool Troubleshooting documentation: https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html
157127
.. _MicroPython download page: https://micropython.org/download/?port=esp32
158128
.. _ESP32 / WROOM: https://micropython.org/download/ESP32_GENERIC

0 commit comments

Comments
 (0)
0