Skip to content

Commit ed23353

Browse files
Refactor Zephyr Workbench documentation for clarity and consistency across installation, development, and debugging sections.
1 parent ba8386e commit ed23353

3 files changed

Lines changed: 61 additions & 60 deletions

File tree

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

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,55 @@
11
---
2-
title: Prepare your system for Zephyr development in Visual Studio Code
2+
title: Set up your environment
33
weight: 2
44

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

9-
## Set up your environment
9+
## The benefits of using Workbench for Zephyr Visual Code extension
1010

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.
11+
Getting started with [Zephyr](https://zephyrproject.org/) RTOS development can be challenging. You often need to install SDKs, set up toolchains, and organize workspace directories by hand. The process is different for each operating system and board vendor, which can make setup confusing and lead to errors.
1212

1313
[Workbench for Zephyr](https://zephyr-workbench.com/) is an open-source [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=Ac6.zephyr-workbench) that transforms Zephyr RTOS development into a streamlined IDE experience. Created by [Ac6](https://www.ac6.fr/en/), it automates toolchain setup, project management, and debugging, making Zephyr projects faster to start and easier to scale.
1414

15-
In this Learning Path, you'll follow clear steps to install Workbench for Zephyr and set up a full development environment on your computer. By the end, you'll be able to create, build, and debug applications for Arm Cortex-M boards using Zephyr RTOS.
15+
In this Learning Path, you'll set up Workbench for Zephyr and configure a complete development environment on your computer. By the end, you can create, build, and debug applications for Arm Cortex-M boards using Zephyr RTOS.
1616

17-
Workbench for Zephyr makes it easy to set up your development environment with a single click. It automatically installs all the tools you need, such as Python, CMake, Ninja, and Git. You can import and manage different versions of the Zephyr SDK, choose the right architecture, and quickly initialize west workspaces. The extension lets you create board-specific applications from sample projects, build and flash them to your hardware, and debug your code, all within Visual Studio Code. You also get features like breakpoint debugging and memory usage insights when using a supported hardware probe.
17+
Workbench for Zephyr makes it easy to set up your development environment with a single click. It automatically installs all the tools you need, such as Python, CMake, Ninja, and Git. You can import and manage different versions of the Zephyr SDK, choose the right architecture, and quickly initialize West workspaces. The extension lets you create board-specific applications from sample projects, build and flash them to your hardware, and debug your code, all within Visual Studio Code. You also get features like breakpoint debugging and memory usage insights when using a supported hardware probe.
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

23-
**Windows OS:**
23+
24+
### Windows
2425
For Windows, you need version 10 or later (64-bit x64), along with administrator privileges for installing runners and drivers.
2526

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

2930
```bash
3031
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
3132
```
3233

33-
**Linux:**
34-
- A recent 64-bit X64 distribution such as Ubuntu 20.04 or later, Fedora, Clear Linux OS, or Arch Linux
35-
- Other distributions might work, but might require manual configuration of system packages
36-
- After installation, use the Workbench host tools manager to verify that all required tools were installed correctly
34+
### Linux
35+
To use Workbench for Zephyr on Linux, install a recent 64-bit distribution such as Ubuntu 20.04 or later, Fedora, Clear Linux OS, or Arch Linux. Other distributions can work, but you might need to manually configure some system packages. After installing your operating system, use the Workbench host tools manager to check that all required tools are installed correctly.
3736

3837

3938
Zephyr Workbench supports STM32 development boards (STM32 Discovery, Nucleo series), Nordic Semiconductor boards (nRF52, nRF53, nRF91 series), NXP development boards (FRDM, LPCXpresso series), Espressif boards (ESP32-based boards), and many other Zephyr-supported platforms like Renesas, Silabs or Infineon. You need a development board to try out the code examples.
4039

41-
## Configure the Workbench for Zephyr extension in Visual Studio Code
42-
43-
This section covers installing the Zephyr Workbench extension and configuring your Arm development environment.
40+
## Install and configure the Zephyr Workbench extension
4441

45-
### Install the Workbench for Zephyr extension
42+
This section covers installing the Workbench for Zephyr extension and configuring your Arm development environment.
4643

47-
To install the Workbench for Zephyr extension, open Visual Studio Code. In the Activity Bar, select the **Extensions** icon to open the Extensions view.
44+
To install the Workbench for Zephyr extension, open **Visual Studio Code**. In the **Activity Bar**, select the **Extensions** icon to open the **Extensions view**.
4845

49-
You can also use the keyboard shortcut `Ctrl+Shift+X` on Windows or Linux, or `Cmd+Shift+X` on macOS.
46+
You can also use the keyboard shortcut **Ctrl+Shift+X** on Windows or Linux, or **Cmd+Shift+X** on macOS.
5047

51-
In the search box, enter **Workbench for Zephyr**. Locate the official extension by Ac6 and select **Install**.
48+
In the search box, enter `Workbench for Zephyr`. Locate the official extension by **Ac6** and select **Install**.
5249

53-
After installation, the Workbench for Zephyr icon appears in the Activity Bar. A welcome screen confirms that the extension is ready to use.
50+
After installation, the Workbench for Zephyr icon appears in the **Activity Bar**. A welcome screen confirms that the extension is ready to use.
5451

55-
### Install the required host tools
52+
## Install the required host tools
5653

5754
In the Workbench for Zephyr panel, select **Install Host Tools** to automatically install the required dependencies.
5855

@@ -64,16 +61,20 @@ This process installs Python 3.x, CMake, the Ninja build system, Git, Device Tre
6461
On Windows, you might see permission prompts when Workbench for Zephyr installs or runs tools. Select **Allow** to continue with the setup.{{% /notice%}}
6562

6663
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-
### Import and configure the Zephyr toolchain
64+
## Import and configure the Zephyr toolchain
6865

6966
To build and debug Zephyr applications for Arm Cortex-M boards, you need to import and configure the Zephyr toolchain using Workbench for Zephyr.
7067

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

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
70+
In the **Import Toolchain** panel, configure the following options to set up your Zephyr toolchain for Arm development:
71+
72+
- **Toolchain Family**: select *Zephyr SDK* to use the official Zephyr toolchain.
73+
- **SDK Type**: select *Minimal* to install only the essential components needed for development.
74+
- **Version**: select the Zephyr SDK release you want to use, such as v0.17.0 or v0.17.3.
75+
- **Target Architectures**: select *arm* to target Arm-based boards.
76+
77+
These settings ensure your environment is optimized for Arm Cortex-M development. After configuring these options, continue with the import process to download and install the selected SDK.
7778

7879
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.
7980

@@ -83,7 +84,7 @@ If you see errors during import, check your internet connection and confirm you
8384
![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")
8485

8586

86-
### Initialize the Zephyr project workspace
87+
## Initialize the Zephyr project workspace
8788

8889
Zephyr uses a Git-based workspace manager called West to organize its source code, modules, and samples. Use Workbench for Zephyr to initialize your first West workspace.
8990

@@ -99,7 +100,7 @@ Select **Import** to create and update the workspace.
99100
The workspace initialization downloads the Zephyr source code and dependencies. This process can take several minutes depending on your internet connection speed.
100101
{{% /notice %}}
101102

102-
### Verify setup
103+
## Verify setup
103104

104105
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.
105106
{{% 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 %}}

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: Build Zephyr applications in VS Code
2+
title: Build a Zephyr application with Zephyr workbench
33
weight: 3
44

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

9-
## Create and build your first Zephyr application
9+
## Set up your Zephyr development board and environment
1010

11-
In this session, you'll learn how to create and build your first Zephyr application using Workbench for Zephyr. This step prepares you to customize, test, and expand real firmware projects on Arm Cortex-M boards.
11+
In this section, you'll learn how to create and build your first Zephyr application using Workbench for Zephyr. This step prepares you to customize, test, and expand real firmware projects on Arm Cortex-M boards.
12+
For this demonstration, you'll use an [NXP FRDM-MCXN947](https://www.nxp.com/design/design-center/development-boards-and-designs/FRDM-MCXN947) development board as your target device. The same process works for any Zephyr-supported Arm Cortex-M board.
1213

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-
You can find the full list of supported boards in the [Supported Boards](https://docs.zephyrproject.org/latest/boards/#).
14+
To see all compatible boards, visit the [Zephyr Supported Boards list](https://docs.zephyrproject.org/latest/boards/#).
1515

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

18-
### Create application
18+
## Create the application
1919

2020
In the Zephyr Workbench panel:
2121

@@ -29,17 +29,17 @@ Configure your project:
2929

3030
After you complete these steps, Workbench for Zephyr creates the project and prepares it for building.
3131

32-
![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")
32+
![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. alt-text #center](images/create_app.png "Zephyr Workbench Create New Application panel")
3333

34-
### Build the application
34+
## Build the application
3535

3636
Select the **Build** button in Workbench for Zephyr or press `Ctrl+Shift+B`.
3737

3838
The build system compiles your application and links it against the Zephyr kernel and board-specific drivers.
3939

4040
![VS Code Zephyr Workbench build application panel showing workspace selection, SDK version, target board dropdown, sample application selection, and project name fields. The primary subject is the Zephyr Workbench interface guiding users through building a Zephyr application. Visible text includes labels such as Workspace, SDK, Target Board, Sample Application, and Project Name, with buttons for Create New Application and Build. The wider VS Code environment is visible in the background, presenting a clean and organized workspace with a neutral, professional tone. alt-text#center]
4141

42-
### Install board-specific debug utilities
42+
## Install board-specific debug utilities
4343

4444
To enable debugging on your target hardware, you might need to install additional tools based on the board vendor.
4545

@@ -54,7 +54,7 @@ If Workbench for Zephyr doesn't automatically detect the installed debug runner,
5454
Open the **Debug Manager** from the Zephyr sidebar, and enter the full path to the runner executable.
5555
{{% /notice %}}
5656

57-
### Review output
57+
## Review the output
5858

5959
Check the build output at the bottom panel of VS Code. Make sure there are no errors or warnings. A successful build displays:
6060

@@ -65,7 +65,7 @@ Memory region Used Size Region Size % Used
6565
SRAM: 4048 B 256 KB 1.5%
6666
```
6767

68-
### Code walkthrough: hello_world
68+
## Code walkthrough: hello_world
6969

7070
The following code shows a basic Zephyr application that prints a message to the console:
7171

0 commit comments

Comments
 (0)