summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-01-02 21:25:41 -0500
committerDan Halbert <halbert@halwitz.org>2018-01-02 21:25:41 -0500
commit065e82015f0d2bd6732c62b7375fcc7af87fa0cf (patch)
treee48fa8caa5675d529d335a2b154e69eba8199cff /docs
parentce81c8dda9686d3cd78d9c5383b6982c148ac7ec (diff)
merge from 2.2.0 + fix up board defs
Diffstat (limited to 'docs')
-rw-r--r--docs/troubleshooting.rst24
1 files changed, 17 insertions, 7 deletions
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index 34ee392d2..1c7e87f61 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 <https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/flash_erase_express>`_.
+
+#. Download the appropriate flash .erase uf2 from `here <https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/flash_erase_express>`_.
#. 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 <https://github.com/adafruit/circuitpython/releases/latest>`_.
+**For boards without SPI flash, such as Feather M0 Proto, Gemma M0 and, Trinket M0:**
+
+#. Download the appropriate erase .uf2 from `here <https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/uf2_flash_erasers>`_.
+#. 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 <https://github.com/adafruit/circuitpython/releases/latest>`_.
+
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 <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest>`_