You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[ Configuring the flash arguments ](#customizeLaunchConfig)<br>
23
+
*[ Troubleshooting Guide](#troubleshooting)<br>
22
24
*[ How to raise bugs ](#howToRaiseBugs)<br>
23
25
*[ FAQ ](#faq)<br>
24
26
@@ -37,18 +39,18 @@ Eclipse provides two ways to install the IDF Plugins
37
39
* Installing IDF Plugins from Local
38
40
39
41
# Installing IDF Plugins using update site url
40
-
*You can install the IDF Eclipse plugins into an existing Eclipse CDT installation using the update site url. You first need to add the release repository url as follows:
42
+
You can install the IDF Eclipse plugins into an existing Eclipse CDT installation using the update site url. You first need to add the release repository url as follows:
41
43
* Go to `Help` -> `Install New Software`
42
44
* Click `Add…`
43
-
* Enter `Location` of the repository `https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/`
45
+
* Enter `Location` of the repository https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/
44
46
* Enter `Name` as `Espressif IDF Plugins for Eclipse`
45
47
* Click `Ok`
46
48
* Select `Espressif IDF` from the list and proceed with the installation
47
49
48
50
49
51
50
52
# Installing IDF Plugins from Local
51
-
* Download the latest update site archive for IDF Eclipse Plugins here - `https://github.com/espressif/idf-eclipse-plugin/releases`
53
+
* Download the latest update site archive for IDF Eclipse Plugins here - https://github.com/espressif/idf-eclipse-plugin/releases
52
54
* Unzip the archive
53
55
* In Eclipse, choose `Help` -> `Install New Software`
54
56
* Click `Add…` button
@@ -60,7 +62,7 @@ Eclipse provides two ways to install the IDF Plugins
60
62
61
63
62
64
<aname="InstallTools"></a>
63
-
# Installation of IDF Tools
65
+
# Installing ESP-IDF Tools
64
66
ESP-IDF requires some prerequisite tools to be installed so you can build firmware for the ESP32. The prerequisite tools include Python, Git, cross-compilers, menuconfig tool, CMake and Ninja build tools.
65
67
66
68
For this getting started follow the instructions below.
@@ -72,58 +74,24 @@ For this getting started follow the instructions below.
72
74
73
75
74
76
75
-
ESP_IDF Directory selection dialog:
77
+
ESP-IDF Directory selection dialog:
76
78
77
79
78
80
79
-
<aname="configureEnvironmentVariables"></a>
80
-
# Configuring Environment Variables
81
-
If IDF Tools are installed using `Help` > `Espressif IDF Tools Manager` > `Install Tools` menu option, and Eclipse auto configure these required environment variables.
82
-
83
-
Mandatory required environment variables:
84
-
* IDF_PATH
85
-
* PATH
86
-
* OPENOCD_SCRIPTS
87
-
* IDF_PYTHON_ENV_PATH
88
-
89
-
If due to any issues if the required environment variables are not configured, please follow the below instructions to add or modify them.
90
-
91
-
* Click on the `Environment` preference page under `C/C++ Build`.
92
-
* Click “Add…” again, and enter name `IDF_PATH`. The value should be the full path where ESP-IDF is installed.
93
-
* Similarly we shoud configure OPENOCD_SCRIPTS, IDF_PYTHON_ENV_PATH and PATH environment variables
## To create a new Project using default esp-idf-template:
115
-
* Make sure you are in C/C++ perspective.
82
+
# Create a new Project
83
+
* Make sure you are in `C/C++ Perspective`
116
84
* Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective..`)
117
-
* Provide the project Name
85
+
* Provide the `Project name`
118
86
* Click `Finish`
119
87
120
88
121
89
122
90
<aname="NewProjectUsingTemplates"></a>
123
-
## To create a new project using idf examples/templates:
124
-
* Make sure you're in C/C++ perspective.
91
+
#Create a new project using ESP-IDF Templates
92
+
* Make sure you're in `C/C++ Perspective`
125
93
* Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective..`)
126
-
* Provide the Project Name
94
+
* Provide the `Project name`
127
95
* Click `Next`
128
96
* Check `Create a project using one of the templates`
129
97
* Select the required template from the tree
@@ -132,54 +100,18 @@ This is how they looks like:
132
100
133
101
134
102
<aname="ImportProject"></a>
135
-
# Import an existing IDF Project
103
+
# Import an existing IDF Project
136
104
* Make sure you're in `C/C++ Perspective`.
137
-
* Right click on the Project Explorer
105
+
* Right click in the Project Explorer
138
106
* Select `Import..` Menu
139
107
* Select `Existing IDF Project` from `Espressif` import wizard menu list
140
108
* Click `Next`
141
109
* Click on `Browse...` to choose an existing project location directory
142
-
* Provide project name if you wish you have a different name
110
+
* Provide `Project name` if you wish you have a different name
143
111
* Click `Finish` to import the selected project into eclipse workspace as a CMake project
144
112
145
113
146
114
147
-
<aname="BuildIDFProject"></a>
148
-
# Building the IDF projects
149
-
150
-
We need to tell Eclipse CDT what is the CMake toolchain and toolchain file which need to be used to build the project. However, this will be auto-detected if you've installed the tools using the `Help > Espressif IDF Tools Manager > Install Tools` option from the Eclipse.
151
-
152
-
If you see toolchain is not auto-detected you can always configure using the below instructions.
153
-
154
-
<aname="ConfigureToolchains"></a>
155
-
# Configuring Core Build Toolchains
156
-
157
-
* Open Eclipse Preferences
158
-
* Navigate to `C/C++ -> “Core Build Toolchains` preference page
159
-
* Click on `Add..` from the User defined Toolchians tables
We now need to tell CDT which toolchain to use when building the project. This will pass the required arguments to CMake when generating the Ninja files.
173
-
174
-
* Navigate to “C/C++ -> “CMake” preference page
175
-
* Click `Add..` and this will launch the New CMake Toolchain configuration dialog
* Select GCC Xtensa Toolchain compiler from the drop-down list. Example: `esp32 xtensa /Users/kondal/esp/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc`
178
-
179
-
**NOTE:** Eclipse CDT has a bug in saving the toolchain preferences, hence it's recommended to restart the Eclipse before we move further configuring the launch target.
180
-
181
-
182
-
183
115
<aname="ConfigureLaunchTarget"></a>
184
116
# Configuring Launch target
185
117
Next, we need to tell CDT to use the toolchain for our project. This is accomplished through the Launch Bar, the new widget set you see on the far left of the toolbar. And this will be shown only when you have a project in the project explorer.
@@ -203,22 +135,9 @@ Next, we need to tell CDT to use the toolchain for our project. This is accompli
203
135
204
136
<aname="FlashApplication"></a>
205
137
# Flashing the Project
206
-
ESP-IDF has a tool called "idf.py" which is a wrapper around make flash command with some handy operations. Flash operation can be initiated with just a click of a launch button(second button from the left) and it's auto-configured to flash the application with the default flash command i.e, "idf.py -p PORT flash".
207
-
208
-
To provide the customized flash arguments, follow the below instructions to launch the configuration UI
209
-
210
-
* Click on the `Launch Configuration` edit button
211
-
* Switch to the `Main` tab
212
-
* Specify the `Location` where this application has to run on. Since idf.py is a python file, will configure the python system path. Example:`${system_path:python}`
213
-
* Specify `Working directory` of the application. Example: `${workspace_loc:/hello_world}`
214
-
* In additional arguments, provide a flashing command which will run in the specified working directory
215
-
* Flash command looks like this: `/Users/kondal/esp/esp-idf/tools/idf.py -p /dev/cu.SLAB_USBtoUART flash`
216
-
* Click OK to save the settings
217
-
* Click on the `Launch` icon to flash the application to the selected board
138
+
ESP-IDF has a tool called `idf.py` which is a wrapper around make flash command with some handy operations. Flash operation can be initiated with just a click of a launch button(second button from the left) and it's auto-configured to flash the application with the default flash command i.e, `idf.py -p PORT flash`.
218
139
219
-
220
-
221
-
140
+
To provide the customized flash arguments, please follow [this](#customizeLaunchConfig) link for further instructions.
222
141
223
142
<aname="ConfigureLaunchTerminal"></a>
224
143
# Viewing Serial Output
@@ -260,6 +179,89 @@ CMake editor preferences can be controlled using `Eclipse > Preferences > CMakeE
260
179
# Debugging the Project
261
180
Please refer to <ahref ="https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html" > JTAG Debugging guide</a>
262
181
182
+
<aname="configureEnvironmentVariables"></a>
183
+
# Configuring Environment Variables
184
+
Eclipse auto configure the required environment variables in the `Preferences > C/C++ Build > Environment` section If IDF Tools are installed using `Help` > `Espressif IDF Tools Manager` > `Install Tools` menu option.
185
+
186
+
Mandatory required environment variables:
187
+
* IDF_PATH
188
+
* PATH
189
+
* OPENOCD_SCRIPTS
190
+
* IDF_PYTHON_ENV_PATH
191
+
192
+
Due to any issues if the required environment variables are not configured, Please follow the step by step instructions below.
193
+
* Click on the `Environment` preference page under `C/C++ Build`.
194
+
* Click “Add…” again, and enter name `IDF_PATH`. The value should be the full path where ESP-IDF is installed.
195
+
* Similarly we shoud configure OPENOCD_SCRIPTS, IDF_PYTHON_ENV_PATH and PATH environment variables
We need to tell Eclipse CDT what is the core build toolchain and CMake toolchain which need to be used to build the project. However, this will be auto-detected if you've installed the tools using the `Help > Espressif IDF Tools Manager > Install Tools` option from the Eclipse.
215
+
216
+
If due to any issues if these toolchains are not detected, Please follow the step by step instructions below to add a new toolchain.
217
+
218
+
<aname="ConfigureToolchains"></a>
219
+
# Configuring Core Build Toolchains
220
+
221
+
* Open Eclipse Preferences
222
+
* Navigate to `C/C++ -> “Core Build Toolchains` preference page
223
+
* Click on `Add..` from the User defined Toolchians tables
We now need to tell CDT which toolchain to use when building the project. This will pass the required arguments to CMake when generating the Ninja files.
237
+
238
+
* Navigate to “C/C++ -> “CMake” preference page
239
+
* Click `Add..` and this will launch the New CMake Toolchain configuration dialog
* Select GCC Xtensa Toolchain compiler from the drop-down list. Example: `esp32 xtensa /Users/kondal/esp/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc`
242
+
243
+
**NOTE:** Eclipse CDT has a bug in saving the toolchain preferences, hence it's recommended to restart the Eclipse before we move further configuring the launch target.
244
+
245
+
246
+
247
+
<aname="customizeLaunchConfig"></a>
248
+
# Launch Configuration
249
+
To provide the customized launch configuration and flash arguments, please follow the step by step instructions below.
250
+
251
+
* Click on the `Launch Configuration` edit button
252
+
* Switch to the `Main` tab
253
+
* Specify the `Location` where this application has to run on. Since `idf.py` is a python file, will configure the python system path. Example:`${system_path:python}`
254
+
* Specify `Working directory` of the application. Example: `${workspace_loc:/hello_world}`
255
+
* In additional arguments, provide a flashing command which will run in the specified working directory
256
+
* Flash command looks like this: `/Users/kondal/esp/esp-idf/tools/idf.py -p /dev/cu.SLAB_USBtoUART flash`
257
+
* Click OK to save the settings
258
+
* Click on the `Launch` icon to flash the application to the selected board
0 commit comments