From 066a269fbf14126f1434dbf9c3ef46fc7024ba55 Mon Sep 17 00:00:00 2001 From: "radim.karnis" Date: Wed, 31 May 2023 15:19:33 +0200 Subject: [PATCH] docs: Add idf.py uf2 command description --- docs/en/api-guides/tools/idf-py.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/en/api-guides/tools/idf-py.rst b/docs/en/api-guides/tools/idf-py.rst index 0a70d7158e..4770ba6309 100644 --- a/docs/en/api-guides/tools/idf-py.rst +++ b/docs/en/api-guides/tools/idf-py.rst @@ -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 `_) 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 `_ 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 ==============