alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: Add idf.py uf2 command description

Browse Source
This commit is contained in:
radim.karnis 2023-05-31 15:19:33 +02:00
parent 9f4a296274
commit 066a269fbf
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/api-guides/tools/idf-py.rst
View File

@ -203,6 +203,23 @@ Clean the Python Byte Code: ``python-clean``
This command deletes generated python byte code from the ESP-IDF directory. The byte code may cause issues when switching between ESP-IDF and Python versions. It is advised to run this target after switching versions of Python.
Generate a UF2 binary: ``uf2``
---------------------------------
.. code-block:: bash
idf.py uf2
This command will generate a UF2 (`USB Flashing Format <https://github.com/microsoft/uf2>`_) binary ``uf2.bin`` in the build directory. This file includes all the necessary binaries (bootloader, app, and partition table) for flashing the target.
This UF2 file can be copied to a USB mass storage device exposed by another ESP running the `ESP USB Bridge <https://github.com/espressif/esp-usb-bridge>`_ project. The bridge MCU will use it to flash the target MCU. This is as simple copying (or "drag-and-dropping") the file to the exposed disk accessed by a file explorer in your machine.
To generate a UF2 binary for the application only (not including the bootloader and partition table), use the ``uf2-app`` command.
.. code-block:: bash
idf.py uf2-app
Global Options
==============