Skip to content

Latest commit

 

History

History
117 lines (72 loc) · 12.3 KB

FEATURES.md

File metadata and controls

117 lines (72 loc) · 12.3 KB
Raw

ESP-IDF Extension features for Visual Studio Code

This extension provides many features to ease development of ESP-IDF Projects.

Arduino as ESP-IDF component

The Add Arduino-ESP32 as ESP-IDF Component command will add Arduino-ESP32 as a ESP-IDF component in your current directory (${CURRENT_DIRECTORY}/components/arduino). You can also use the ESP-IDF: Create project from extension template command with arduino-as-component template to create a new project directory that includes Arduino-esp32 as an ESP-IDF component.

NOTE Not all versions of ESP-IDF are supported. Make sure to check Arduino-ESP32 to see if your ESP-IDF version is compatible.

Build

ESP-IDF: Build your project is provided by this extension to build your project using CMake and Ninja-build as explained in ESP-IDF Build system using Cmake directly. You could modify the behavior of the build task with idf.cmakeCompilerArgs for Cmake configure step and idf.ninjaArgs for Ninja step. For example, using [-j N] where N is the number of jobs run in parallel.

Debugging

Click F5 to start debugging. To configure the debug behaviour, please review DEBUGGING.

NOTE For correct debug experience, first define the correct idf.customExtraPaths paths and idf.customExtraVars using SETUP, build your project, choose the right serial port, flash the program to your device.

CMakeLists.txt Editor

THIS WILL OVERRIDE ANY EXISTING CODE IN THE FILE WITH THE ONE GENERATED IN THE EDITOR. IF YOU HAVE ANY CODE NOT INCLUDED IN THE SCHEMA (OR SINGLE LINE COMMENTS) USE A REGULAR TEXT EDITOR INSTEAD

On CMakeLists.txt file right click this extension provides a custom CMakeLists.txt Editor to fill an ESP-IDF Project and Component registration as specified in ESP-IDF Project CMakeLists.txt and ESP-IDF Component CMakeLists.txt files. You need to choose which kind of CMakeLists.txt file (project or component) to edit. There is 2 types of input, one is a simple string and another is an array of strings, such as Component Sources (SRCS). All inputs are described in the CMakeLists.txt Schema (${this_repository}/src/cmake/cmakeListsSchema.json).

NOTE This editor doesn't support all CMake functions and syntaxes. This editor should only be used for simple CMakeLists.txt options such as component registration (using idf_component_register) and basic project elements. If you need more customization or advanced CMakeLists.txt, consider reviewing ESP-IDF Build System. Also review CMakeLists.txt editor schema for a list of supported code.

Custom tasks

There are couple of custom tasks that the user can implement by using one of these configuration settings:

  1. Set idf.customTask to define a custom task to be executed with ESP-IDF: Execute custom task command or the activity bar icon.
  2. Set idf.preBuildTask to define a custom task to be executed before ESP-IDF: Build your project command task.
  3. Set idf.postBuildTask to define a custom task to be executed after ESP-IDF: Build your project command task.
  4. Set idf.preFlashTask to define a custom task to be executed before Flash commands.
  5. Set idf.postFlashTask to define a custom task to be executed after Flash commands.

Flash

The commands Select Flash Method and Flash, Flash (with JTag) using OpenOCD and JTAG or Flash (UART) your project using the ESP-IDF esptool.py as explained in ESP-IDF Build system Flash arguments, are provided by this extension to flash your project. This command depends on the ${YOUR_PROJECT_DIR}/build/flasher_args.json file generated by build and the idf.flashBaudRate configuration setting.

Kconfig files editor

When you open a Kconfig, Kconfig.projbuild or Kconfig.in file we provide syntax highlighting. If idf.useIDFKconfigStyle is enabled, we also provide ESP-IDF Kconfig style syntax validation such as indent validation and not closing blocks found (Example: menu-endmenu). Please review Kconfig Formatting Rules and Kconfig Language for further details about the ESP-IDF Kconfig formatting rules and Kconfig language in general.

Log & Heap Tracing

We support log and heap tracing out of the box, which enables users to perform log/heap tracing with just few button clicks and present the results of tracing data with UI.

You can follow this quick step-by-step guide for heap tracing.

Monitor

ESP-IDF: Monitor your device is provided by this extension to start idf.py monitor terminal program in Visual Studio Code. Please take a look at the IDF Monitor documentation.

In Visual Studio Code, for ESP-IDF: Monitor your device we use the shell executable given in vscode.env.shell which is override by terminal.integrated.shell.* in your Visual Studio Code Settings when using the Terminal: Select Default Shell command to update the shell or updating terminal.integrated.shell.windows for Windows, terminal.integrated.shell.osx for MacOS and terminal.integrated.shell.linux for Linux in VSCode Settings Preference menu (F1 -> Preferences: Open Settings (JSON)).

OpenOCD Server

The user can start or stop the openOCD from Visual Studio Code using the ESP-IDF: OpenOCD Manager command or from the OpenOCD Server (Running | Stopped) button in the visual studio code status bar. The output is shown in menu View -> Output -> OpenOCD. By default it will be launched using localhost, port 4444 for Telnet communication, port 6666 for TCL communication and port 3333 for gdb.

Before using the OpenOCD server, you need to set the proper values for openOCD Configuration files in the idf.openOCDConfigs configuration setting. You can choose a specific board listed in openOCD using ESP-IDF: Select OpenOCD Board Configuration or use ESP-IDF: Device configuration to manually set any value you desire.

NOTE: The user can modify openocd.tcl.host and openocd.tcl.port configuration settings to modify these values. Please review ESP-IDF Settings to see how to modify these configuration settings.

Partition table tree

Click theESP-IDF Explorer in the activity bar. On the Device Partition Explorer section, click the Refresh partition table icon or the ESP-IDF: Refresh partition table command in the Command Palette. This will get a list of the partitions listed in the partition table of your connected device and show them in the Device Partition Explorer section. When you can any partition, you can choose to either open the partition table editor (only when custom partition table is enabled) or choose a binary (.bin) file to flash on the selected partition. You can also right click any .bin file and choose the partition in device to flash this partition.

SDK Configuration editor

This extension includes a GUI menuconfig that reads your current project folder's sdkconfig file (if available, otherwise it would take default values) and start the ESP-IDF JSON configuration server process (confserver.py in ${IDF_PATH}/tools) that enables the user to redefine ESP-IDF project and board configuration.

When the user modify a parameter value, the value is send to the confserver.py process, which return the new value and other values modified to GUI menuconfig and then update the values in the UI.

Values are not automatically saved to the sdkconfig file until you click save changes. You can cancel any changes and load the values from the sdkconfig file by clicking cancel changes. If you click set default the current sdkconfig file is replaced by a template sdkconfig file and then loaded into the GUI menuconfig rendered values.

The search functionality allows to find a parameter by description, i.e the name that appears in the sdkconfig file.

An IDF GUI Menuconfig log in Output (Menu View -> Output) is created to print all communications with ${idf.espIdfPath}\tools\confserver.py. It can be be used to track any errors.

Set Espressif device target

The ESP-IDF: Set Espressif device target allows the user to choose among Espressif different chips based on idf.py set-target.

When you use this command, the following files are set:

  • Choosing esp32 as IDF_TARGET will set idf.openOCDConfigs to ["interface/ftdi/esp32_devkitj_v1.cfg", "target/esp32.cfg"]
  • Choosing esp32s2 as IDF_TARGET will set idf.openOCDConfigs to ["interface/ftdi/esp32_devkitj_v1.cfg", "target/esp32s2.cfg"]
  • Choosing esp32s3 as IDF_TARGET will set idf.openOCDConfigs to ["interface/ftdi/esp32_devkitj_v1.cfg", "target/esp32s3.cfg"]
  • Choosing esp32c3 as IDF_TARGET will set idf.openOCDConfigs to ["board/esp32c3-builtin.cfg"] if using built-in usb jtag or ["board/esp32c3-ftdi.cfg"] if using ESP-PROG-JTAG.

System View Tracing Viewer

We have provide a system view tracing viewer inside the vscode extension which will enable you to view the traces along with other relevant details.