# Zephyr lab installation and preparation

In this lab, you will learn to install/import the tools below.  This guide is written for Windows11. Ubuntu or macOS can also follow similar steps.

The necessary installations include:  
- Visual Studio Code
- MCUXpresso Extension for VS Code
- Dependencies for Zephyr development, including the Zephyr SDK
- Zephyr Repository in VS Code

## Software Versions

This lab guide was written with the following versions
- MCUXpresso extension for VS Code v26.1.56
- MCUXpresso Installer v25.12
- Zephyr v4.3.0
- Zephyr SDK v0.17.4
- LinkServer v25.12.83

## Zephyr Revision

Before importing the Zephyr repository, determine the Zephyr revision to checkout.  Upstream Zephyr manages the revisions with Git: Zephyr releases have Git tags for the versions, or the latest code is in the `main` branch.

For development, it is ideal to use a Zephyr release.  Releases go through the Zephyr Project's release flow and quality checks.  This is why the Repository Importer in the MCUXpresso extension defaults to the latest Zephyr release.  Learn more about [Zephyr Releases](https://docs.zephyrproject.org/latest/releases/index.html).

One resource available to confirm support in different revisions is the Zephyr Project documentation.  For example, the [Supported Boards and Shields](https://docs.zephyrproject.org/latest/boards/index.html) is a living document for the hardware currently in the `main` branch, and is updated frequently.


## Installation Steps

### VS Code and MCUXpresso extension

1.   To install Visual Studio Code (VS Code), download the installer here: https://code.visualstudio.com/download	

2. Open VS Code, and install the **MCUXpresso** extension. 
    a. Click the extensions view **( CTRL+Shift+X )**
    b. In the search field at the top of the extension view type **MCUXpresso**
    c. Click the **Install** button 

    ![Install MCUXpresso Extension](./pictures/training-zephyr-0-1-2.png)

    The MCUXpresso extension will be added to the installed list after successful installation.
    <br/>

### Zephyr dependencies and debugger tools

Zephyr development environment needs some host dependencies like: CMake, Python, Devicetree, Zephyr SDK, and others. LinkServer is also required to debug with the NXP on-board probes.

> **Note** this lab guide assumes a LinkServer debug probe is used, which is default on the evaluation boards.  When utilizing other supported debug probes, this installer can additionally integrate support for Segger JLink and PEmicro tools. 

3.   Open the MCUXpresso Extension.  In the **Quickstart Panel**, click **Open MCUXpresso Installer**
   ![Open MCUXpresso Installer](./pictures/training-zephyr-0-2-4.png)<br/>

4.   Select the Zephyr Developer package version to install.  Clicking the pull-down next to the version gives a list of versions.  The Installer defaults to the package for the latest Zephyr release.
   ![Select Zephyr package version](./pictures/training-zephyr-install-select-zephyr-package.png)<br/>

5. After selecting the install options: **Zephyr Developer**, and **LinkServer**  click the **Install** button. The status bar at the bottom shows how the installation is progressing. 

    ![Installer for Zephyr](./pictures/training-zephyr-0-2-5.png)<br/>

6.  Restart VS Code to enable the changes to environment variables.

##  Import the software repositories

7.	To import the Zephyr repository, open the **MCUXpresso** view in VS Code and click **Import Repository** in the **Quickstart Panel**.

   ![Import Repository](./pictures/training-zephyr-0-3-7.png) <br/>


8. Select **Zephyr** Repository, the Importer defaults to the latest Zephyr release.  Choose the folder location and name.  These settings create the workspace in C:\zephyrproject. When finished, click **Import**. 

    ![Import Zephyr repo](./pictures/training-zephyr-0-3-8.png)<br/>

> **Note** This import step takes a long time to clone the Zephyr repo, and dependency repos (currently 70!).  VS Code shows a progress bar pop-up with the status of the West tool as it clones all the repos. The repository should be added to the Imported Repository view once the import is successful. <br/>

   The repository is successfully added to the **Imported Repositories** view once the import is successful.

   ![Imported Repositories](./pictures/training-zephyr-0-3-9b.png) <br/>

9.	To import any example application from the Zephyr Repository, click **Import Example from Repository** in the **Quickstart Panel**.

    ![Import Zephyr Example](./pictures/training-zephyr-install-import-example.png) <br/>

10.	To ensure successful installation, follow the steps in the [Hello World guide](./Zephyr-Lab-MCXN947-Hello-World.md) to run the hello_world example from the Zephyr repo.

> Lab completed.  Return to the Zephyr Labs Overview [Training Zephyr Getting Started](./Training-Zephyr-Getting-Started.md)