Install Espressif IDF Plugin Tutorial
From Waveshare Wiki
Install Online
- Open VSCode, click on Extensions on the left, search for extensions and install C/C++, ESP-IDF. Other extensions can be installed as needed
- Press shortcut key F1 to input:
esp-idf: configure esp-idf extension
- Select express (This tutorial is intended for first-time installation users, so only the first general installation tutorial is covered)
- Choose the download server, we recommend users to use Espressif as your download server
- Select the ESP-IDF version you want, generally select the supported version according to the requirements of the development board, if there is no requirement, it is recommended to use the latest release version
- The following two are the installation paths respectively for the ESP-IDF container directory and the ESP-IDF Tools directory
- After configuring, click Install to download
- Enter the download interface, and then it will automatically install the corresponding tools and environment, just wait for a second
- After the installation is complete, you will enter the following interface, indicating that the installation is finished
Note: If you have installed ESP-IDF before, or failed to do so, please be sure to delete the file completely or create a new path without Chinese.
Install Offline
Set up the ESP-IDF environment
- First build a local ESP-IDF environment, through the link https://dl.espressif.cn/dl/esp-idf/?idf=4.4 open and pull down, select espidf-v5.1.4 as shown in the figure
- If it is not displayed above, click Download below
- Once the download is complete, double-click to open it, which will be installed by default
- Some of the applications need to be fixed, please expand the steps
- The installation path cannot contain Chinese
- Select Custom Install and check all
- The rest can be installed by default
- The content in the ESP-IDF command prompt window indicates successful installation
- After installation, open "Edit System Environment Variables" and check if any related variables have been added to the system. If not, manual addition is required
- For the steps to add manually, please expand to view
- After installing VSCode, double-click to check if the VSCode variables have been added. If they haven't, you need to add them manually
- For the steps to add manually, please expand to view
- You must click New to generate a new line, otherwise the original content will be replaced
- This path is the installation path for the Visual Studio software, which varies by person
Configure VSCode
- Open VSCode, click on Extensions on the left, search for extensions and install C/C++, ESP-IDF. Other extensions can be installed as needed
- Once you have installed the prerequisite extensions, reopen VSCode and click on the ESP-IDF logo on the left to configure it
- If an ERROR_INVALID_PIP error occurs during installation, please expand
- Delete the "idf-git" and "idf-python" folders within the "*/Espressif/tools" directory, then reinstall
- When prompted to download ESP tools, you can choose to search locally and continue with the installation
