alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-17 23:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(idf_py): Describe the option to configure esptool.py with --extra-args

Browse Source
This commit is contained in:
Radim Karniš
2024-04-17 14:37:25 +02:00
parent c432c692fa
commit 26d6e7563d
4 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -120,6 +120,8 @@ This command automatically builds the project if necessary, and then flash it to
.. note:: The environment variables ``ESPPORT`` and ``ESPBAUD`` can be used to set default values for the ``-p`` and ``-b`` options, respectively. Providing these options on the command line overrides the default.
``idf.py`` uses the ``write_flash`` command of ``esptool.py`` under the hood to flash the target. You can pass additional arguments to configure the flash writing process using the ``--extra-args`` option. For example, to `write to an external SPI flash chip <https://docs.espressif.com/projects/esptool/en/latest/esptool/advanced-options.html#custom-spi-pin-configuration>`_, use the following command: ``idf.py flash --extra-args="--spi-connection <CLK>,<Q>,<D>,<HD>,<CS>"``. To see the full list of available arguments, run ``esptool.py write_flash --help`` or see the `esptool.py documentation <https://docs.espressif.com/projects/esptool/en/latest/esptool/index.html>`_.
Similarly to the ``build`` command, the command can be run with ``app``, ``bootloader`` and ``partition-table`` arguments to flash only the app, bootloader or partition table as applicable.
Hints on How to Resolve Errors