Skip to content

Commit 422aff6

Browse files
authored
doc changes and changes to the last column to only show delete button for non active esp-idf versions (#953)
1 parent ba53aec commit 422aff6

13 files changed

+32
-55
lines changed

README.md

Lines changed: 18 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ To get a quick understanding of ESP-IDF and Eclipse plugin features, check our s
3636
<details open>
3737
<summary>Other IDE Features</summary>
3838

39-
* [ Installing ESP-IDF and Tools via Tools Installation Wizard ](#InstallToolsWizard) <br>
4039
* [ Configuring the Project using sdkconfig Editor](#projectconfigure)<br>
4140
* [ CMake Editor](#cmakeproject)<br>
4241
* [ ESP-IDF Application Size Analysis Editor](#sizeanalysiseditor)<br>
@@ -112,42 +111,35 @@ For adding beta and nightly builds, you can use the following update site urls.
112111
<a name="InstallTools"></a>
113112
# Installing ESP-IDF
114113

115-
To install ESP-IDF directly from the Eclipse:
114+
>With release of the beata 3.0 all the old installation flows for the ESP-IDF are now closed. We will be moving forward with this approach from next stable release.
116115
117-
1. Go to `Espressif` > `Download and Configure ESP-IDF`.
118-
1. From the `Download ESP-IDF` section, choose ESP-IDF version and directory to download.
119-
1. Click on `Finish`.
120-
121-
To configure an existing ESP-IDF:
116+
Please follow the instructions bleow for installing ESP-IDF in the Espressif IDE.
122117

123-
1. Go to `Espressif` > `Download and Configure ESP-IDF`.
124-
1. Check `Use an existing ESP-IDF directory from the file system`.
125-
1. Choose an existing ESP-IDF directory from the file system.
126-
1. Click on `Finish`.
127-
128-
This will download a specified ESP-IDF version and configure `IDF_PATH` in the Eclipse CDT build environment variables.
118+
1. Go to `Espressif` > `ESP-IDF Manager`. The following editor will open
119+
![](docs/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png)
129120

130-
![](docs/images/espidf_download.png)
121+
1. Click on `Add ESP-IDF` button.
122+
![](docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png)
123+
From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables.
131124

132-
# Installing ESP-IDF Tools
125+
1. Click on `Finish` which will be enabled after all the paths and executables are properly configured.
133126

134-
ESP-IDF requires the installation of several prerequisite tools to build firmware for the ESP32. These tools include Python, Git, cross-compilers, the menuconfig tool, CMake, and Ninja build tools.
127+
> **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.
128+
To configure an existing ESP-IDF:
135129

136-
Follow the below instructions to get started.
130+
After you have clicked `Finish` you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE it will be activated as well and you will see a similar entry in the editor for ESP-IDF Manager
131+
![](docs/images/ToolsManager/Tool_installed_and_activated.png)
137132

138-
1. Navigate to `Espressif` > `ESP-IDF Tools Manager` > `Install Tools`.
139-
1. Provide the `ESP-IDF Directory` path.
140-
1. Provide `Git` and `Python` executable locations if they are not auto-detected.
141-
1. Click on `Install Tools` to proceed with the installation process. Check the Console for the installation details.
142-
1. Installation might take a while if you're doing it for the first time since it has to download and install `xtensa-esp32-elf`, `esp32ulp-elf`, Cmake, `openocd-esp32` and Ninja tools.
133+
You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily.
143134

144-
> **Note:** Ensure that you perform this step even if you have already installed the necessary tools. This step sets the IDF_PATH, PATH, OPENOCD_SCRIPTS, and IDF_PYTHON_ENV_PATH in the Eclipse CDT build environment based on the idf_tools.py export command.
135+
Lets take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE.
136+
![](docs/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png)
145137

146-
![](docs/images/install_tools.png)
138+
To activate any specific version simply click on the radio button next to it in the `Active` column.
147139

148-
ESP-IDF Directory selection dialog:
140+
The refresh button in last column for the active ESP-IDF version can be used to reload any changes in the directory you made.
149141

150-
![](docs/images/esp_idf_dir.png)
142+
> **Note** Please note that you can not delete an active ESP-IDF Version you need to activate another version before deleting that.
151143
152144
<a name="NewProjectUsingDefault"></a>
153145
# Create a new Project
@@ -256,24 +248,6 @@ To learn more about the debug configuration, please refer to <a href="https://gi
256248
257249
![](docs/images/4_new_project_templates.png)
258250

259-
<a name="InstallToolsWizard"></a>
260-
# Tools Installation Wizard
261-
262-
You can use the Tools Installation Wizard to manage the tools installation via a wizard. The advantage of this method over the existing installation is that you can easily manage the whole flow via the wizard and install the tools in ESP-IDF framework that you only need.<br/>
263-
264-
To get started:
265-
266-
1. Navigate to `Espressif` > `ESP-IDF Tools Manager` > `Tools Installation Wizard (Preview)`.
267-
![](docs/images/ToolsManager/install_tools_manager.png)
268-
269-
1. The wizard will start and you can select the location for the Git and Python, if they are already present on the system PATH or registry the tools will be populated. After selection, you can click `Next`.
270-
![](docs/images/ToolsManager/git_python_selection.png)
271-
272-
1. Next page will let you select the folder for existing ESP-IDF or you can also select from the drop down list to download the available versions. You can also select master from the list to clone the master for ESP-IDF from GitHub.
273-
![](docs/images/ToolsManager/select_or_download_new_esp_idf.png)
274-
275-
1. After you select `Next` you will see the list of all the available tools in the selected ESP-IDF version, this page lets you select only the recommended tools or you can select the tools you want to. You can also filter out the tools via the filter text box or based on the target. The wizard page is the last page and will Install and Download if necessary all the selected tools required. After you have installed all the tools you can finish the wizard and start creating projects.
276-
![](docs/images/ToolsManager/manage_tools_installation.png)
277251

278252
<a name="projectconfigure"></a>
279253
# SDK Configuration editor

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -392,17 +392,6 @@ private void createButtonsForLastCol(ViewerCell cell)
392392

393393
item.setData(EDITOR_KEY, editor);
394394
IDFToolSet idfToolSet = (IDFToolSet) cell.getElement();
395-
Button removeButton = new Button(buttonComposite, SWT.PUSH | SWT.FLAT);
396-
removeButton.pack();
397-
removeButton.setData(IDF_TOOL_SET_BTN_KEY, idfToolSet);
398-
removeButton.setImage(UIPlugin.getImage(REMOVE_ICON));
399-
removeButton.setToolTipText(Messages.EspIdfManagerDeleteBtnToolTip);
400-
removeButton.addListener(SWT.Selection, e -> {
401-
Button btn = (Button) e.widget;
402-
IDFToolSet selectedToolSet = (IDFToolSet) btn.getData(IDF_TOOL_SET_BTN_KEY);
403-
performDeleteOperation(selectedToolSet);
404-
refreshTable();
405-
});
406395

407396
if (idfToolSet.isActive())
408397
{
@@ -420,6 +409,20 @@ private void createButtonsForLastCol(ViewerCell cell)
420409
toolsActivationJob.schedule();
421410
});
422411
}
412+
else
413+
{
414+
Button removeButton = new Button(buttonComposite, SWT.PUSH | SWT.FLAT);
415+
removeButton.pack();
416+
removeButton.setData(IDF_TOOL_SET_BTN_KEY, idfToolSet);
417+
removeButton.setImage(UIPlugin.getImage(REMOVE_ICON));
418+
removeButton.setToolTipText(Messages.EspIdfManagerDeleteBtnToolTip);
419+
removeButton.addListener(SWT.Selection, e -> {
420+
Button btn = (Button) e.widget;
421+
IDFToolSet selectedToolSet = (IDFToolSet) btn.getData(IDF_TOOL_SET_BTN_KEY);
422+
performDeleteOperation(selectedToolSet);
423+
refreshTable();
424+
});
425+
}
423426

424427
editor.grabHorizontal = true;
425428
editor.setEditor(buttonComposite, item, cell.getColumnIndex());
145 KB
Loading
41.1 KB
Loading
52.4 KB
Loading
36.9 KB
Loading
-50.3 KB
Binary file not shown.
-84.3 KB
Binary file not shown.
-242 KB
Binary file not shown.
-65.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)