NOTE: Consider that if you are using other Espressif frameworks for your projects, not all ESP-IDF versions are compatible with an specific framework. For example, ESP-ADF might not work with the current ESP-IDF master branch. It is recommended that you configure the extension to use the ESP-IDF within the framework (most frameworks include compatible ESP-IDF as subdirectory) in the setup wizard or JSON Configuration as shown in SETUP documentation or Install tutorial.
Besides ESP-IDF, you can install other frameworks to extend the extension functionality. Please look at HARDWARE Support for a list of supported frameworks and Espressif chips.
-
Espressif Audio Development Framework (ESP-ADF) with this extension using the Install ESP-ADF command, which will clone ESP-ADF to the selected directory and set
idf.espAdfPath
(idf.espAdfPathWin
in Windows) configuration setting. -
Espressif Mesh Development Framework (ESP-MDF) with this extension using the Install ESP-MDF command, which will clone ESP-MDF to the selected directory and set
idf.espMdfPath
(idf.espMdfPathWin
in Windows) configuration setting.
NOTE: You can also just set each configuration setting with the framework directory path if you already have them. For example, on Visual Studio Code menu
View
->Command Palette..
. -> typePreferences: Open Settings (UI)
and search for ESP-ADF to manually set this path.
NOTE: Please review ESP-IDF Settings to see how to modify these configuration settings.
After configuring these framework, you can see their examples with the ESP-IDF: Show Examples Projects and they will be used by other extensions commands like Build project
.
-
Add Arduino-ESP32 as ESP-IDF Component extension command will clone Arduino-ESP32 and use it as a ESP-IDF component in your current directory. You should check the Arduino-ESP32 repository for more information about using arduino libraries as ESP-IDF component.
-
Can also use Create ESP-IDF project command with
arduino-as-component
template to create a new project with arduino as a ESP-IDF component.