Zephyr IDE for VS Code

The Zephyr IDE for VS code extension provides tools to aide in your Zephyr Project work flow. This extension helps you to build Zephyr projects and share them with your team.

Please check out our new extension pack that bundles in additional tools.

You can read a little bit more about the motivation behind the project here.

Features

• Sets up a west environment
• Downloads the Zephyr SDK
• Provides west.yml templates to start with or you can provide your own
• Allows you to add projects from scratch or from templates
• Create multiple projects
• For each project, you can create multiple builds
• Each project may have its own kconfig files and overlay files
• Each build may have a unique board, kconfig files, and overlay files and runner
• Each build may be bound to a launch/debug configuration for debug, build and debug and attach.
• GUI Panels to show the full project tree and active projects
• Automatically changing active project based on the last viewed file in the editor
• All commands that are available in the GUI are available in the command palette.
• Provides useful functions to set up custom launch/debug configurations
• Provides the user with a terminal to manually run west commands
• Saves/loads project structure to workspace in a human readable and editable file

Getting Started

There is a manual available to help get started along with a couple Youtube tutorials.

You can have a look at this sample directory to also help with getting started and sharing project.

Requirements

In order for this application to work correctly the zephyr require build tools need to be installed and available on the path. These include cmake, python3, and Devicetree Compiler.

See the Install Dependecies Section of the Zephyr Getting Started Guide

For ubuntu please also install python3-venv by sudo apt install python3-venv

Known Issues

• macOS compatibility is untested. Please make an issue on our github page with any incompatibilities found.

Release Notes

See CHANGELOG for release notes

Development and Debugging

See the Zephyr IDE for VS Code Developer's Guide for development and debugging instructions.