zephyr-vscode-example

This is an example configuration for setting up Visual Studio Code for Zephyr application development. It was originally created for the talk entitled, "Zephyr & Visual Studio Code: How to Develop Zephyr Apps with a Modern, Visual IDE" at EOSS 2023.

Example details

There are many, many different ways to develop a Zephyr application. This example currently assumes:

• All paths follow the Getting Started Guide
• Uses the Zephyr SDK where possible (ex. Host tools are not available on macOS or Windows)
• In-tree development
• Use of Python Virtual Environments
• Building samples/basic/thread so we can demonstrate thread-aware debugging
• Targetting an nRF52840 DK

Steps

1. Follow the Zephyr Getting Started Guide for your OS and make sure to use virtual environments
2. Turn on Compilation Database with west config build.cmake-args -- -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
3. Copy the .code-workspace for your OS to samples/basic/thread as well the .vscode folder
4. Retrieve ZEPHYR_SDK_INSTALL_DIR with cmake -P zephyr/cmake/verify-toolchain.cmake. It'll be the prefix of the C_Cpp.default.compilerPath
5. Set the Python: Interpreter Path
6. CD to samples/basic/thread
7. Try the different build tasks and the flash task
8. Try to connect over the serial terminal
9. TODO try step debugging

Credits

https://zmk.dev/docs/development/ide-integration