Install ESP-IDF and Tools

After installing Visual Studio Code you need to install the ESP-IDF extension for Visual Studio Code.

• Navigate to View > Extensions or keyboard shortcut Ctrl+Shift+X in Windows/Linux or Shift+⌘+X in MacOS.

• Search for ESP-IDF Extension from the list of extensions.

1. Install the ESP-IDF extension.

• Navigate to View > Command Palette.

• Type ESP-IDF: Configure ESP-IDF Extension and select the command to specify to launch the setup wizard. A loading notification will be shown and later the setup wizard will appear.

Note

• For versions of ESP-IDF < 5.0, spaces are not supported inside configured paths.

2. Choose Express and select the download server:

• Espressif: Faster speed in China using Espressif Download servers links.

• Github: Using github releases links.

3. Pick an ESP-IDF version to download or use the Find ESP-IDF in your system option to search for existing ESP-IDF directory.

• Choose the location for ESP-IDF Tools ( IDF_TOOLS_PATH) which is %USERPROFILE%\.espressif on Windows and $HOME\.espressif on MacOS/Linux by default.

Note

• Make sure that IDF_TOOLS_PATH doesn’t have any spaces to avoid any build issues. Also make sure that IDF_TOOLS_PATH is not the same directory as IDF_PATH.

Note

• For MacOS/Linux users, select the Python executable to use to create ESP-IDF python virtual environment.

4. Click Install to begin download and install of ESP-IDF and ESP-IDF Tools.

5. A page will appear with the setup progress status showing:

• ESP-IDF download progress

• ESP-IDF Tools download and install progress

• Creation of a python virtual environment and ESP-IDF python requirements.

6. If everything is installed correctly, you will see a message that all settings have been configured.

Note

For Linux users, a message is shown to add OpenOCD rules in /etc/udev/rules.d which you need to run with sudo privileges.

7. Next step is to Start a ESP-IDF Project.

Warning

Check the Troubleshooting section if you have any issues during installation.