You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/learning-paths/embedded-and-microcontrollers/zephyr_vsworkbench/1_installation.md
+13-19Lines changed: 13 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: Install and configure Workbench for Zephyr in VS Code
2
+
title: Prepare your system for Zephyr development in Visual Studio Code
3
3
weight: 2
4
4
5
5
### FIXED, DO NOT MODIFY
6
6
layout: learningpathall
7
7
---
8
8
9
-
## Set up your Zephyr development environment
9
+
## Set up your environment
10
10
11
11
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.
12
12
@@ -18,13 +18,13 @@ Workbench for Zephyr makes it easy to set up your development environment with a
18
18
19
19
## Install dependencies
20
20
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.
22
22
23
23
**Windows OS:**
24
24
For Windows, you need version 10 or later (64-bit x64), along with administrator privileges for installing runners and drivers.
25
25
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:
@@ -61,7 +61,7 @@ This process installs Python 3.x, CMake, the Ninja build system, Git, Device Tre
61
61

62
62
63
63
{{% 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%}}
65
65
66
66
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.
67
67
### 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
70
70
71
71
In the Workbench for Zephyr panel, select **Import Toolchain**. This opens a guided setup panel.
72
72
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
77
77
78
78
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.
79
79
80
80
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.
81
81
82
82
83
-

83
+

84
84
85
85
86
86
### Initialize the Zephyr project workspace
@@ -102,12 +102,6 @@ The workspace initialization downloads the Zephyr source code and dependencies.
102
102
### Verify setup
103
103
104
104
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 %}}
105
106
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.
Copy file name to clipboardExpand all lines: content/learning-paths/embedded-and-microcontrollers/zephyr_vsworkbench/2_development.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,21 @@ In this session, you'll learn how to create and build your first Zephyr applicat
13
13
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.
14
14
You can find the full list of supported boards in the [Supported Boards](https://docs.zephyrproject.org/latest/boards/#).
15
15
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.
17
17
18
18
### Create application
19
19
20
20
In the Zephyr Workbench panel:
21
21
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.
28
31
29
32

30
33
@@ -79,7 +82,7 @@ int main(void)
79
82
80
83
`CONFIG_BOARD` expands to your target board name. You'll modify this app in the next module!
81
84
82
-
### Try this: modify and rebuild
85
+
## Try this: modify and rebuild
83
86
84
87
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.
Copy file name to clipboardExpand all lines: content/learning-paths/embedded-and-microcontrollers/zephyr_vsworkbench/3_debug.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -185,15 +185,15 @@ Before starting a debug session, make sure your settings match your application
185
185
### Application configuration
186
186
Select your application and build config (for example, "primary"), then wait for values to load or build the project if needed.
187
187
188
-
###Program settings
188
+
## Program settings
189
189
The ELF executable path is auto-filled after build. You can optionally add a **CMSIS-SVD** file to enable register-level view.
190
190
191
-
###Debug server
191
+
## Debug server
192
192
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.
193
193
194
194

195
195
196
-
###Manual debug runner configuration
196
+
## Manual debug runner configuration
197
197
198
198
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.
0 commit comments