diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 34ee392d25..1c7e87f61b 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -15,19 +15,29 @@ This often happens on Windows when the ``CIRCUITPY`` disk is not safely ejected before being reset by the button or being disconnected from USB. This can also happen on Linux and Mac OSX but its less likely. -.. caution:: Delete ``CIRCUITPY`` filesystem and reload CircuitPython. +.. caution:: To erase and re-create ``CIRCUITPY`` (for example, to correct a corrupted filesystem), + follow one of the procedures below. It's important to note that **any files stored on the** + ``CIRCUITPY`` **drive will be erased**. - To reload CircuitPython (for example, to correct a corrupted filesystem), - follow the process below. It's important to note that **any files stored on the - ``CIRCUITPY`` drive will be erased**. +**For boards with** ``CIRCUITPY`` **stored on a separate SPI flash chip, +such as Feather M0 Express, Metro M0 Express and Circuit Playground Express:** -#. Download the appropriate flash erase uf2 from `here `_. + +#. Download the appropriate flash .erase uf2 from `here `_. #. Double-click the reset button. #. Copy the appropriate .uf2 to the xxxBOOT drive. #. The on-board NeoPixel will turn blue, indicating the erase has started. #. After about 15 seconds, the NexoPixel will start flashing green. If it flashes red, the erase failed. #. Double-click again and load the appropriate `CircuitPython .uf2 `_. +**For boards without SPI flash, such as Feather M0 Proto, Gemma M0 and, Trinket M0:** + +#. Download the appropriate erase .uf2 from `here `_. +#. Double-click the reset button. +#. Copy the appropriate .uf2 to the xxxBOOT drive. +#. The boot LED will start pulsing again, and the xxxBOOT drive will appear again. +#. Load the appropriate `CircuitPython .uf2 `_. + ValueError: Incompatible ``.mpy`` file. --------------------------------------- @@ -35,9 +45,9 @@ This error occurs when importing a module that is stored as a ``mpy`` binary fil (rather than a ``py`` text file) that was generated by a different version of CircuitPython than the one its being loaded into. Most versions are compatible but, rarely they aren't. In particular, the ``mpy`` binary format changed between -CircuitPython versions 1.x and 2.x. +CircuitPython versions 1.x and 2.x, and will change again between 2.x and 3.x. -So, if you just upgraded to CircuitPython 2.x from 1.x you'll need to download a +So, for instance, if you just upgraded to CircuitPython 2.x from 1.x you'll need to download a newer version of the library that triggered the error on ``import``. They are all available in the `Adafruit bundle `_