Skip to content

Commit 21ee16b

Browse files
jaenrig-ifxactions-user
authored andcommitted
docs/psoc6/installation.rst: Added device-erase doc.
Signed-off-by: enriquezgarc <[email protected]>
1 parent 2e3c5d8 commit 21ee16b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/psoc6/installation.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,31 @@ The board needs to be specified, and the path and name of the ``.hex`` file:
159159
160160
mpy-psoc6.cmd firmware-deploy CY8CPROTO-062-4343W pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex
161161
162+
Erasing the device (external) file system
163+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
164+
165+
Some PSoC6™ boards include an external flash memory which is used by the MicroPython file system. This memory will not be erased when
166+
reprogramming or erasing MicroPython firmware via ``device-setup`` or ``firmware-deploy``.
167+
Use the ``device-erase`` command to erase of the external memory of your PSoC6™ device:
168+
169+
.. tabs::
170+
171+
.. group-tab:: Linux
172+
173+
.. code-block:: bash
174+
175+
./mpy-psoc6.sh device-erase
176+
177+
.. group-tab:: Windows
178+
179+
.. code-block:: bash
180+
181+
mpy-psoc6.cmd device-erase
182+
183+
.. warning::
184+
185+
This command flashes the PSoC6™ controller with a custom program to delete the external memory. Thus, MicroPython will be removed from the
186+
microcontroller. Use any of the script commands described above to reinstall MicroPython.
162187

163188
Getting the firmware
164189
^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)