Skip to content

Commit ba8386e

Browse files
Update Zephyr VSWorkBench learning path
1 parent df48353 commit ba8386e

3 files changed

Lines changed: 27 additions & 30 deletions

File tree

content/learning-paths/embedded-and-microcontrollers/zephyr_vsworkbench/1_installation.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Install and configure Workbench for Zephyr in VS Code
2+
title: Prepare your system for Zephyr development in Visual Studio Code
33
weight: 2
44

55
### FIXED, DO NOT MODIFY
66
layout: learningpathall
77
---
88

9-
## Set up your Zephyr development environment
9+
## Set up your environment
1010

1111
Setting up a [Zephyr](https://zephyrproject.org/) RTOS development environment from scratch can be challenging, requiring you to manually install SDKs, configure toolchains, and initialize workspace directories. These steps often vary across operating systems and board vendors, leading to a fragmented and error-prone setup process.
1212

@@ -18,13 +18,13 @@ Workbench for Zephyr makes it easy to set up your development environment with a
1818

1919
## Install dependencies
2020

21-
To get started with Workbench for Zephyr you need to have Visual Studio Code downloaded, installed, and running on your computer.
21+
To get started with Workbench for Zephyr, you need to have Visual Studio Code downloaded, installed, and running on your computer.
2222

2323
**Windows OS:**
2424
For Windows, you need version 10 or later (64-bit x64), along with administrator privileges for installing runners and drivers.
2525

26-
**MacOS:**
27-
On MacOS, the Homebrew package manager is required. To install Homebrew, run the following command:
26+
**macOS:**
27+
On macOS, the Homebrew package manager is required. To install Homebrew, run the following command:
2828

2929
```bash
3030
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
@@ -61,7 +61,7 @@ This process installs Python 3.x, CMake, the Ninja build system, Git, Device Tre
6161
![Workbench for Zephyr extension panel in Visual Studio Code showing the Install Host Tools button highlighted. The panel lists required tools such as Python, CMake, Ninja, Git, and Device Tree Compiler. The environment is a modern code editor interface with a sidebar and clear labels. The tone is instructional and welcoming. Visible text includes Install Host Tools and a checklist of dependencies to be installed. alt-text#center](images/install_host_tools.png "Workbench for Zephyr extension panel")
6262

6363
{{% notice Note %}}
64-
On Windows, you might see permission prompts when Workbench for Zephyr installs or runs tools. Select **Allow** to continue with the setup.
64+
On Windows, you might see permission prompts when Workbench for Zephyr installs or runs tools. Select **Allow** to continue with the setup.{{% /notice%}}
6565

6666
When the installation completes, select **Verify Host Tools** to confirm that each required package is installed and up to date. The panel displays the version and status for Python, CMake, Ninja, Git, and Device Tree Compiler. If any tool is missing or out of date, follow the prompts to resolve the issue before continuing.
6767
### Import and configure the Zephyr toolchain
@@ -70,17 +70,17 @@ To build and debug Zephyr applications for Arm Cortex-M boards, you need to impo
7070

7171
In the Workbench for Zephyr panel, select **Import Toolchain**. This opens a guided setup panel.
7272

73-
- For **Toolchain Family**, select *Zephyr SDK*.
74-
- For **SDK Type**, choose *Minimal* to install only the essential components.
75-
- For **Version**, pick the Zephyr SDK release you want to use, such as v0.17.0 or v0.17.3.
76-
- For **Target Architectures**, select *arm* to target Arm-based boards.
73+
- For **Toolchain Family**, select *Zephyr SDK*
74+
- For **SDK Type**, choose *Minimal* to install only the essential components
75+
- For **Version**, pick the Zephyr SDK release you want to use, such as v0.17.0 or v0.17.3
76+
- For **Target Architectures**, select *arm* to target Arm-based boards
7777

7878
Next, specify the directory where you want to install the SDK. Select **Import** to start the download and installation process. When the import completes, the panel displays a confirmation that the toolchain is ready.
7979

8080
If you see errors during import, check your internet connection and confirm you have at least 2 GB of free disk space. For more troubleshooting tips, review the extension's documentation or check the Visual Studio Code output panel.
8181

8282

83-
![Workbench for Zephyr Import Toolchain panel in Visual Studio Code. The panel displays options for selecting the toolchain family, SDK type, version, and target architectures. Visible text includes Import Toolchain, Zephyr SDK, Minimal, v0.17.0, v0.17.3, and arm. The interface is organized and user-friendly, with clearly labeled dropdown menus and buttons. The overall tone is instructional and welcoming, set within a modern code editor workspace.](images/import_toolchain.png "Workbench for Zephyr Import Toolchain panel")
83+
![Workbench for Zephyr Import Toolchain panel in Visual Studio Code. The panel displays options for selecting the toolchain family, SDK type, version, and target architectures. Visible text includes Import Toolchain, Zephyr SDK, Minimal, v0.17.0, v0.17.3, and arm. The interface is organized and user-friendly, with clearly labeled dropdown menus and buttons. The overall tone is instructional and welcoming, set within a modern code editor workspace. alt-text #center](images/import_toolchain.png "Workbench for Zephyr Import Toolchain panel")
8484

8585

8686
### Initialize the Zephyr project workspace
@@ -102,12 +102,6 @@ The workspace initialization downloads the Zephyr source code and dependencies.
102102
### Verify setup
103103

104104
Test your setup by confirming that the Workbench for Zephyr panel shows all components as installed successfully. Verify the host tools are installed, the SDK is imported and detected, and the West workspace is initialized. Ensure no error messages appear in the VS Code output panel.
105+
{{% notice Troubleshooting Tips %}} If you have trouble installing host tools on Windows, try running Visual Studio Code as an administrator. Make sure your firewall allows internet access so dependencies can download. Before importing the SDK, confirm you have at least 2 GB of free disk space.{{% /notice %}}
105106

106-
{{% notice Note %}}
107-
**Troubleshooting tips:**
108-
- Run VS Code as Administrator if host tool installation fails on Windows
109-
- Ensure internet access is allowed through your firewall
110-
- Check for minimum 2 GB free disk space before importing SDK
111-
{{% /notice %}}
112-
113-
You're ready to create and build your first Zephyr application targeting an Arm Cortex-M board.
107+
You're now ready to create and build your first Zephyr application targeting an Arm Cortex-M board.

content/learning-paths/embedded-and-microcontrollers/zephyr_vsworkbench/2_development.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,21 @@ In this session, you'll learn how to create and build your first Zephyr applicat
1313
For demonstration, you'll use an [NXP FRDM-MCXN947](https://www.nxp.com/design/design-center/development-boards-and-designs/FRDM-MCXN947) development board as the target device. However, the same steps apply to any Zephyr-supported Arm Cortex-M board.
1414
You can find the full list of supported boards in the [Supported Boards](https://docs.zephyrproject.org/latest/boards/#).
1515

16-
Depending on your board, you might need to install a different debug tool aka `runner`. The next module covers this setup.
16+
Depending on your board, you might need to install a different debug tool aka `runner`. The next section covers this setup.
1717

1818
### Create application
1919

2020
In the Zephyr Workbench panel:
2121

22-
1. Select **Create New Application**
23-
2. Configure your project:
24-
- Select workspace and SDK
25-
- Choose your target board (for example, NXP FRDM-MCXN947)
26-
- Select a sample app (for example, `hello_world`)
27-
- Provide a project name
22+
Select **Create New Application** in the Zephyr Workbench panel.
23+
24+
Configure your project:
25+
- Select the workspace and SDK version.
26+
- Choose your target board (for example, NXP FRDM-MCXN947).
27+
- Select a sample application (for example, `hello_world`).
28+
- Enter a project name.
29+
30+
After you complete these steps, Workbench for Zephyr creates the project and prepares it for building.
2831

2932
![Zephyr Workbench Create New Application panel in VS Code showing workspace selection SDK version target board dropdown sample application selection and project name fields. The interface is clean and organized with clear labels and buttons. The wider VS Code environment is visible in the background with a neutral and professional tone. All text in the panel is legible and guides the user through creating a new Zephyr application.](images/create_app.png "Zephyr Workbench Create New Application panel")
3033

@@ -79,7 +82,7 @@ int main(void)
7982
8083
`CONFIG_BOARD` expands to your target board name. You'll modify this app in the next module!
8184
82-
### Try this: modify and rebuild
85+
## Try this: modify and rebuild
8386
8487
Now that the app works, try editing the message in `printk()` or changing the board target in the application settings. Then rebuild and observe the output. This helps verify that your toolchain and workspace respond correctly to code and config changes.
8588

content/learning-paths/embedded-and-microcontrollers/zephyr_vsworkbench/3_debug.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,15 +185,15 @@ Before starting a debug session, make sure your settings match your application
185185
### Application configuration
186186
Select your application and build config (for example, "primary"), then wait for values to load or build the project if needed.
187187

188-
### Program settings
188+
## Program settings
189189
The ELF executable path is auto-filled after build. You can optionally add a **CMSIS-SVD** file to enable register-level view.
190190

191-
### Debug server
191+
## Debug server
192192
Choose the runner from OpenOCD, J-Link, LinkServer, or PyOCD. If the system doesn't detect your runner automatically, enter the runner path manually. Select **Apply** to save your settings or launch debug directly.
193193

194194
![Debug Manager panel in Workbench for Zephyr showing a list of connected debug runners and configuration options. The interface displays fields for selecting the runner executable path, board profile, and status indicators for each tool. The environment is a VS Code window with the Zephyr Workbench sidebar open. The tone is technical and neutral. Visible text includes Debug Manager, Runner Path, Board Profile, and status labels for detected runners.](images/debug_manager.png "Debug Manager panel in Workbench for Zephyr")
195195

196-
### Manual debug runner configuration
196+
## Manual debug runner configuration
197197

198198
If Workbench for Zephyr doesn't automatically detect the installed debug runner, open the **Debug Manager** from the sidebar and locate your board profile to enter the path to the runner executable manually.
199199

0 commit comments

Comments
 (0)