Skip to content

Commit f5ac0ac

Browse files
committed
Update to point to guide.
1 parent 7b0660f commit f5ac0ac

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

docs/troubleshooting.rst

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,21 @@ If your host computer starts complaining that your ``CIRCUITPY`` drive is corrup
1111
or files cannot be overwritten or deleted, then you will have to erase it completely.
1212
When CircuitPython restarts it will create a fresh empty ``CIRCUITPY`` filesystem.
1313

14-
This often happens on Windows when the ``CIRCUITPY`` disk is not safely ejected
14+
Corruption often happens on Windows when the ``CIRCUITPY`` disk is not safely ejected
1515
before being reset by the button or being disconnected from USB. This can also
1616
happen on Linux and Mac OSX but it's less likely.
1717

1818
.. caution:: To erase and re-create ``CIRCUITPY`` (for example, to correct a corrupted filesystem),
1919
follow one of the procedures below. It's important to note that **any files stored on the**
20-
``CIRCUITPY`` **drive will be erased**.
20+
``CIRCUITPY`` **drive will be erased. Back up your code if possible before continuing!**
2121

2222
REPL Erase Method
2323
^^^^^^^^^^^^^^^^^
24-
**For any board if you have access to the REPL:**
24+
This is the recommended method of erasing your board. If you are having trouble accessing the
25+
``CIRCUITPY`` drive or the REPL, consider first putting your board into
26+
`safe mode <https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting#safe-mode-3105351-22>`_.
27+
28+
**To erase any board if you have access to the REPL:**
2529

2630
#. Connect to the CircuitPython REPL using a terminal program.
2731
#. Type ``import storage`` into the REPL.
@@ -30,25 +34,12 @@ REPL Erase Method
3034

3135
Erase File Method
3236
^^^^^^^^^^^^^^^^^
33-
**If you do not have access to the REPL, you have the following options to erase your board.**
34-
35-
**For boards with** ``CIRCUITPY`` **stored on a separate SPI flash chip,
36-
such as Feather M0 Express, Metro M0 Express and Circuit Playground Express:**
37-
38-
#. Download the appropriate flash erase .uf2 from `the Adafruit_SPIFlash repo <https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/flash_erase_express>`_.
39-
#. Double-click the reset button.
40-
#. Copy the appropriate .uf2 to the xxxBOOT drive.
41-
#. The on-board NeoPixel will turn blue, indicating the erase has started.
42-
#. After about 15 seconds, the NexoPixel will start flashing green. If it flashes red, the erase failed.
43-
#. Double-click again and load the appropriate `CircuitPython .uf2 <https://circuitpython.org/downloads>`_.
44-
45-
**For boards without SPI flash, such as Feather M0 Proto, Gemma M0 and, Trinket M0:**
37+
**If you do not have access to the REPL, you may still have options to erase your board.**
4638

47-
#. Download the appropriate erase .uf2 from `the Learn repo <https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/uf2_flash_erasers>`_.
48-
#. Double-click the reset button.
49-
#. Copy the appropriate .uf2 to the xxxBOOT drive.
50-
#. The boot LED will start pulsing again, and the xxxBOOT drive will appear again.
51-
#. Load the appropriate `CircuitPython .uf2 <https://circuitpython.org/downloads>`_.
39+
The `Erase CIRCUITPY Without Access to the REPL <https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting#erase-circuitpy-without-access-to-the-repl-3105309-26>`_
40+
section of the Troubleshooting page in the Welcome to CircuitPython guide covers the non-REPL
41+
erase process for various boards. Visit the guide, find the process that applies to your board,
42+
and follow the instructions to erase your board.
5243

5344
ValueError: Incompatible ``.mpy`` file.
5445
---------------------------------------

0 commit comments

Comments
 (0)