Skip to content

Commit 100ff1b

Browse files
committed
IEP-1557: Documentation for the ESP-IDF Manager
1 parent 49d194d commit 100ff1b

File tree

5 files changed

+19
-13
lines changed

5 files changed

+19
-13
lines changed

docs/en/installation.rst

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,36 +30,42 @@ ESP-IDF and Tools Installation
3030
-------------------------------
3131
.. _esp-idf-tools-installation:
3232

33-
The Espressif-IDE provides a tool manager to install and manage ESP-IDF and related tools. Please follow the instructions below for installing ESP-IDF in the Espressif-IDE.
33+
The Espressif-IDE provides a Tool Manager view that allows you to activate available ESP-IDF versions and manage related tools. To install the ESP-IDF and its tools, first download the Espressif Installation Manager (EIM) from the following link:
34+
35+
`https://dl.espressif.com/dl/eim/`
36+
37+
After downloading and launching EIM, follow the on-screen instructions to install the required ESP-IDF version and associated tools. Once the installation is complete, you can use the ESP-IDF Manager within the IDE to activate the installed ESP-IDF version in the workspace.
38+
The Espressif-IDE allows you to download and launch the EIM directly from the IDE, making it easier to manage your ESP-IDF versions and tools. If you are coming trying to open the workspace from and older version of Espressif-IDE you will be prompted to convert the older configuration to use with EIM.
39+
40+
Follow these steps inside the Espressif-IDE to install the ESP-IDF and related tools:
3441

3542
1. Go to ``Espressif > ESP-IDF Manager``. The following editor will open:
3643

3744
.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Editor_Screen.png
3845

39-
2. Click on the ``Add ESP-IDF`` button.
40-
41-
.. image:: ../../media/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png
46+
2. Click on the ``Launch EIM`` or ``Download & Launch EIM`` button if you have not already downloaded and installed EIM.
4247

43-
From the screen shown above, you can choose an already downloaded ESP-IDF directory or select and download directly from the given dialog. The ``Git`` and ``Python`` tools must be installed, and if they are configured in the system PATH, they will be preloaded in the view. If not, you can browse to the directory and select the proper executables.
48+
You will see the progress of download and installation in the console. Once the EIM is launched, you can use it to install the ESP-IDF and related tools.
4449

45-
3. Click on ``Finish``, which will be enabled after all paths and executables are properly configured.
50+
3. Once you close the EIM your ESP-IDF Manager editor will be updated with the latest information about the ESP-IDF versions and tools available.
4651

4752
.. note::
48-
Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory IDE will automatically pick up the python once you have installed the tools
53+
Please note that the EIM will be the only tool going forward to manage the ESP-IDF versions and tools. The previous versions of the Espressif-IDE used to manage tools internally but now the only point of entry into the ESP-IDF will be through the EIM.
4954

50-
After you have clicked ``Finish``, you will see the progress in the console for the tools getting installed. Once the installation is done, and if this is the very first set of ESP-IDF installed in the IDE, it will be activated as well. You will see a similar entry in the editor for ESP-IDF Manager:
55+
After the EIM is closed the ESP-IDF Manager editor will be updated with the latest information about the ESP-IDF versions and tools available.:
5156

5257
.. image:: ../../media/ToolsManager/Tool_installed_and_activated.png
5358

54-
You can add as many versions of ESP-IDF as you want, but only one version can be set as active, and that version will be used to compile and index projects in your workspace. This feature helps you switch between versions in the workspace easily.
59+
You can add as many versions of ESP-IDF as you want via EIM, but only one version can be set as active, and that version will be used to compile and index projects in your workspace. This feature helps you switch between versions in the workspace easily.
5560

56-
Let's take a look at how multiple versions will look. Follow the same steps as before to add another ESP-IDF version to the IDE.
61+
To activate any specific version, simply click on the radio button next to it in the ``Active`` column.
5762

58-
.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Multiple_versions.png
63+
The refresh button in the last column for the active ESP-IDF version can be used to reload any changes in the ESP-IDF directory you made.
5964

60-
To activate any specific version, simply click on the radio button next to it in the ``Active`` column.
65+
.. note::
66+
Any manual changes made to the ESP-IDF directory will not be reflected in the IDE until you refresh the active ESP-IDF version using the refresh button but if you made any changes to the installation of ESP-IDF using the EIM, those changes will be detected and a popup message will be shown to you to update the ESP-IDF version in the IDE.
6167

62-
The refresh button in the last column for the active ESP-IDF version can be used to reload any changes in the directory you made.
68+
.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Changed_Installation_Message.png
6369

6470
References
6571
----------
Binary file not shown.
133 KB
Loading
474 KB
Loading
-52.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)