-
Notifications
You must be signed in to change notification settings - Fork 130
IEP-1557: Documentation for the ESP-IDF Manager #1257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alirana01
wants to merge
6
commits into
release/v4.0.0
Choose a base branch
from
IEP-1557
base: release/v4.0.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
100ff1b
IEP-1557: Documentation for the ESP-IDF Manager
alirana01 80257d3
fix for link refs in docs
alirana01 9c01b03
fixed link
alirana01 d8c50cf
fixing link format
alirana01 7121248
fixing link syntax
alirana01 cf3d48c
fixing link syntax
alirana01 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,36 +30,41 @@ ESP-IDF and Tools Installation | |
------------------------------- | ||
.. _esp-idf-tools-installation: | ||
|
||
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. | ||
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 <https://dl.espressif.com/dl/eim/>`_. | ||
|
||
|
||
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. | ||
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. | ||
|
||
Follow these steps inside the Espressif-IDE to install the ESP-IDF and related tools: | ||
Comment on lines
+37
to
+39
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you also make clear instructions for the existing users. |
||
|
||
1. Go to ``Espressif > ESP-IDF Manager``. The following editor will open: | ||
|
||
.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Editor_Screen.png | ||
|
||
2. Click on the ``Add ESP-IDF`` button. | ||
|
||
.. image:: ../../media/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png | ||
2. Click on the ``Launch EIM`` or ``Download & Launch EIM`` button if you have not already downloaded and installed EIM. | ||
|
||
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. | ||
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. | ||
|
||
3. Click on ``Finish``, which will be enabled after all paths and executables are properly configured. | ||
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. | ||
|
||
.. note:: | ||
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 | ||
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. | ||
|
||
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: | ||
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.: | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Isn't line 54 a duplicate of line 49? |
||
.. image:: ../../media/ToolsManager/Tool_installed_and_activated.png | ||
|
||
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. | ||
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. | ||
|
||
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. | ||
To activate any specific version, simply click on the radio button next to it in the ``Active`` column. | ||
|
||
.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Multiple_versions.png | ||
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. | ||
|
||
To activate any specific version, simply click on the radio button next to it in the ``Active`` column. | ||
.. note:: | ||
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. | ||
|
||
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. | ||
.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Changed_Installation_Message.png | ||
|
||
References | ||
---------- | ||
|
Binary file removed
BIN
-145 KB
media/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you link EIM documentation here for installation instructions- https://docs.espressif.com/projects/idf-im-ui/en/latest/