summaryrefslogtreecommitdiffstatshomepage
path: root/docs/esp32/tutorial/reset.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/esp32/tutorial/reset.rst')
-rw-r--r--docs/esp32/tutorial/reset.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/esp32/tutorial/reset.rst b/docs/esp32/tutorial/reset.rst
new file mode 100644
index 0000000000..b3fc6a85bd
--- /dev/null
+++ b/docs/esp32/tutorial/reset.rst
@@ -0,0 +1,25 @@
+Factory reset
+=============
+
+If something unexpected happens and your ESP32-based board no longer boots
+MicroPython, then you may have to factory reset it. For more details, see
+:ref:`soft_bricking`.
+
+Factory resetting the MicroPython esp32 port involves fully erasing the flash
+and resetting the flash memory, so you will need to re-flash the MicroPython
+firmware afterwards and copy any Python files to the filesystem again.
+
+1. You will need the Espressif `esptool`_ installed on your system. This is the
+ same tool that you may have used to initially install MicroPython on your
+ board (see :ref:`installation instructions <esp32_flashing>`).
+2. Find the serial port name of your board, and then use esptool to erase the
+ entire flash contents::
+
+ esptool.py -p PORTNAME erase_flash
+
+3. Use esptool to flash the MicroPython file to your board again. If needed,
+ this file and flashing instructions can be found on the `MicroPython
+ downloads page`_.
+
+.. _esptool: https://github.com/espressif/esptool
+.. _MicroPython downloads page: https://micropython.org/download/?port=esp32