Skip to content

Commit 065a319

Browse files
dhalberttannewt
authored andcommitted
Update info about erasing CIRCUITPY to include flash erasers for non-… (adafruit#427)
Update info about erasing CIRCUITPY to include flash erasers for non-Express boards.
1 parent d183b66 commit 065a319

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

docs/troubleshooting.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,39 @@ This 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 its less likely.
1717

18-
.. caution:: Delete ``CIRCUITPY`` filesystem and reload CircuitPython.
18+
.. caution:: To erase and re-create ``CIRCUITPY`` (for example, to correct a corrupted filesystem),
19+
follow one of the procedures below. It's important to note that **any files stored on the**
20+
``CIRCUITPY`` **drive will be erased**.
1921

20-
To reload CircuitPython (for example, to correct a corrupted filesystem),
21-
follow the process below. It's important to note that **any files stored on the
22-
``CIRCUITPY`` drive will be erased**.
22+
**For boards with** ``CIRCUITPY`` **stored on a separate SPI flash chip,
23+
such as Feather M0 Express, Metro M0 Express and Circuit Playground Express:**
2324

24-
#. Download the appropriate flash erase uf2 from `here <https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/flash_erase_express>`_.
25+
26+
#. Download the appropriate flash .erase uf2 from `here <https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/flash_erase_express>`_.
2527
#. Double-click the reset button.
2628
#. Copy the appropriate .uf2 to the xxxBOOT drive.
2729
#. The on-board NeoPixel will turn blue, indicating the erase has started.
2830
#. After about 15 seconds, the NexoPixel will start flashing green. If it flashes red, the erase failed.
2931
#. Double-click again and load the appropriate `CircuitPython .uf2 <https://github.com/adafruit/circuitpython/releases/latest>`_.
3032

33+
**For boards without SPI flash, such as Feather M0 Proto, Gemma M0 and, Trinket M0:**
34+
35+
#. Download the appropriate erase .uf2 from `here <https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/uf2_flash_erasers>`_.
36+
#. Double-click the reset button.
37+
#. Copy the appropriate .uf2 to the xxxBOOT drive.
38+
#. The boot LED will start pulsing again, and the xxxBOOT drive will appear again.
39+
#. Load the appropriate `CircuitPython .uf2 <https://github.com/adafruit/circuitpython/releases/latest>`_.
40+
3141
ValueError: Incompatible ``.mpy`` file.
3242
---------------------------------------
3343

3444
This error occurs when importing a module that is stored as a ``mpy`` binary file
3545
(rather than a ``py`` text file) that was generated by a different version of
3646
CircuitPython than the one its being loaded into. Most versions are compatible
3747
but, rarely they aren't. In particular, the ``mpy`` binary format changed between
38-
CircuitPython versions 1.x and 2.x.
48+
CircuitPython versions 1.x and 2.x, and will change again between 2.x and 3.x.
3949

40-
So, if you just upgraded to CircuitPython 2.x from 1.x you'll need to download a
50+
So, for instance, if you just upgraded to CircuitPython 2.x from 1.x you'll need to download a
4151
newer version of the library that triggered the error on ``import``. They are
4252
all available in the
4353
`Adafruit bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest>`_

0 commit comments

Comments
 (0)