Installation with VScode extension on Windows

Step 1 Download ROGO_ESP32_WILE_SDK

you can also directly download from the ROGO_ESP32_WILE_SDK’s github page

download zip file of the ROGO_ESP32_WILE_SDK

Alternatively if you have install git or Github Desktop, you can clone the repo with branch dev/v5.1.1 in the following link:

https://github.com/RogoSolutions/rogo-esp32-sdk.git

Please

Step 2 Install VScode extension and ROGO_ESP32_WILE_SDK

Download and install Visual Studio Code.

Open the Extensions view by clicking on the Extension icon in the Activity Bar on the side of Visual Studio Code or the View: Extensions command (shortcut: Ctrl+Shift+X).

Extension Search

Search for ESP-IDF Extension, and install it.

Extension Install

(OPTIONAL) Press F1 and type ESP-IDF: Select where to Save Configuration Settings, which can be User Settings, Workspace Settings or Workspace Folder Settings. Please take a look at Working with multiple projects for more information. Default is User settings.

Extension Save Configuration Settings

In Visual Studio Code, Press F1 or select menu “View” and “Command Palette” and type [configure esp-idf extension]. After, choose the ESP-IDF: Configure ESP-IDF Extension option. You can also choose where to save settings in the setup wizard.

Configure ESP-IDF Extension

Now the setup wizard window will be shown with several setup options: Express, Advanced or Use Existing Setup.

Select extension mode

Choose Advanced option, after ESP-IDF is downloaded and extracted, select to either download ESP-IDF Tools or manually provide each ESP-IDF tool absolute path and required environment variables. > NOTE: Consider that IDF_PATH requires each ESP-IDF tool to be of the version described in IDF_PATH/tools/tools.json. > If it is desired to use a different ESP-IDF tool version, check JSON Manual Configuration

Select ESP-IDF Tools

Next step, the user will be asked how to install the ESP_IDF tools, the user can just leave the default option of Download ESP-IDF tools

Select ESP-IDF Tools

Otherwise, if the user already installed the ESP-IDF tools, and want to use them , they can select Use existing ESP-IDF tools and provide the absolute path, please enter the executable container directory for each binary as shown below: > NOTE: Check JSON Manual Configuration for more information.

Enter ESP-IDF Tools paths manually

If everything is installed correctly, the user will see a message that all settings have been configured. You can start using the extension.

Install complete

NOTE: The advance mode allows the user to choose to use existing ESP-IDF tools by manually entering each ESP-IDF tool absolute path. Make sure each ESP-IDF tool path doesn’t have any spaces.

Now that the extension setup is finally done, check the Basic use to learn how to use the SDK Configuration editor, build, flash and monitor your Espressif device.

NOTE: Visual Studio Code has many places where to set configuration settings. This extension uses the idf.saveScope configuration setting to determine where to save settings, Global (User Settings), Workspace and WorkspaceFolder. Please review vscode settings precedence.

NOTE: the setup wizard will install ESP-IDF Python packages and ESP-IDF debug adapter (EXTENSION_PATH/esp_debug_adapter/requirements.txt) python packages. Make sure that if using an existing python virtual environment that installing these packages doesn’t affect your virtual environment. The EXTENSION_PATH is: %USERPROFILE%\.vscode\extensions\espressif.esp-idf-extension-VERSION