Skip to content

Commit 792ad7b

Browse files
docs(component): Update to IDF 5.1 and add component manager instructions (espressif#10005)
* docs(component): Update to 5.1 and add component manager * ci(pre-commit): Apply automatic fixes --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
1 parent 1923f82 commit 792ad7b

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

docs/en/esp-idf_component.rst

+24-2
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,36 @@ For a simplified method, see `Installing using Boards Manager <https://docs.espr
1414
If you plan to use these modified settings multiple times, for different projects and targets, you can recompile the Arduino core with the new settings using the Arduino Static Library Builder.
1515
For more information, see the `Lib Builder documentation <lib_builder.html>`_.
1616

17+
.. note:: Latest Arduino Core ESP32 version (3.0.X) is now compatible with `ESP-IDF v5.1 <https://github.com/espressif/esp-idf/tree/release/v5.1>`_. Please consider this compatibility when using Arduino as a component in ESP-IDF.
18+
19+
For easiest use of Arduino framework as a ESP-IDF component, you can use the `IDF Component Manager <https://docs.espressif.com/projects/esp-idf/en/v5.1.4/esp32/api-guides/tools/idf-component-manager.html>`_ to add the Arduino component to your project.
20+
This will automatically clone the repository and its submodules. You can find the Arduino component in the `ESP Registry <https://components.espressif.com/components/espressif/arduino-esp32>`_ together with dependencies list and examples.
21+
1722
Installation
1823
------------
1924

20-
.. note:: Latest Arduino Core ESP32 version is now compatible with `ESP-IDF v4.4 <https://github.com/espressif/esp-idf/tree/release/v4.4>`_. Please consider this compatibility when using Arduino as a component in ESP-IDF.
21-
2225
#. Download and install `ESP-IDF <https://github.com/espressif/esp-idf>`_.
2326

2427
* For more information see `Get Started <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#installation-step-by-step>`_.
28+
29+
Installing using IDF Component Manager
30+
**************************************
31+
32+
To add the Arduino component to your project using the IDF Component Manager, run the following command in your project directory:
33+
34+
.. code-block:: bash
35+
36+
idf.py add-dependency "espressif/arduino-esp32^3.0.2"
37+
38+
Or you can start a new project from a template with the Arduino component:
39+
40+
.. code-block:: bash
41+
42+
idf.py create-project-from-example "espressif/arduino-esp32^3.0.2:hello_world"
43+
44+
Manual installation of Arduino framework
45+
****************************************
46+
2547
#. Create a blank ESP-IDF project (use sample_project from /examples/get-started) or choose one of the examples.
2648
#. In the project folder, create a new folder called ``components`` and clone this repository inside the newly created folder.
2749

0 commit comments

Comments
 (0)