https://github.com/beriberikix/zephyr-vscode-example

An example configuration for setting up Visual Studio Code for Zephyr application development
https://github.com/beriberikix/zephyr-vscode-example

visual-studio-code vscode zephyr-rtos

Last synced: about 2 months ago
JSON representation

An example configuration for setting up Visual Studio Code for Zephyr application development

• Host: GitHub
• URL: https://github.com/beriberikix/zephyr-vscode-example
• Owner: beriberikix
• License: apache-2.0
• Created: 2023-06-13T06:30:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-09T22:28:53.000Z (6 months ago)
• Last Synced: 2024-11-30T19:32:38.455Z (about 2 months ago)
• Topics: visual-studio-code, vscode, zephyr-rtos
• Homepage:
• Size: 26.4 KB
• Stars: 74
• Watchers: 7
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://youtu.be/IKNHPmG-Qxo)" 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](https://docs.zephyrproject.org/latest/develop/getting_started/index.html) 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