Getting Started Guide¶

Select Start > Settings > Update & Security > Windows Update. Click Check for updates and install any that are available.

On macOS Mojave or later, select System Preferences... > Software Update. Click Update Now if necessary.

On other versions, see this Apple support topic.

This guide covers Ubuntu version 20.04 LTS and later.

1

sudo apt update

2

sudo apt upgrade

In modern version of Windows (10 and later) it is recommended to install the Windows Terminal application from the Microsoft Store. Instructions are provided for a cmd.exe or PowerShell command prompts.

These instructions rely on Windows' official package manager, winget. If using winget isn’t an option, you can install dependencies from their respective websites and ensure the command line tools are on your PATH environment variable.

1. In modern Windows versions, winget is already pre-installed by default. You can verify that this is the case by typing winget in a terminal window. If that fails, you can then install winget.

2. Open a Command Prompt (cmd.exe) or PowerShell terminal window. To do so, press the Windows key Win , type cmd.exe or PowerShell and click on the result.

3. Use winget to install the required dependencies:

   winget install Kitware.CMake Ninja-build.Ninja oss-winget.gperf Python.Python.3.12 Git.Git oss-winget.dtc wget 7zip.7zip
   

4. Close the terminal window.

1. Install Homebrew:

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

2. After the Homebrew installation script completes, follow the on-screen instructions to add the Homebrew installation to the path.

   Apple SiliconIntel

   1	(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zprofile

   2	source ~/.zprofile

   1	(echo; echo 'eval "$(/usr/local/bin/brew shellenv)"') >> ~/.zprofile

   2	source ~/.zprofile

3. Use brew to install the required dependencies:

   brew install cmake ninja gperf python3 python-tk ccache qemu dtc libmagic wget openocd
   

4. Add the Homebrew Python folder to the path, in order to be able to execute python and pip as well python3 and pip3.

   1	(echo; echo 'export PATH="'$(brew --prefix)'/opt/python/libexec/bin:$PATH"') >> ~/.zprofile

   2	source ~/.zprofile

brew list --versions

1. Use apt to install the required dependencies:

   1 2 3

   sudo apt install --no-install-recommends git cmake ninja-build gperf \ ccache dfu-util device-tree-compiler wget python3-dev python3-venv python3-tk \ xz-utils file make gcc gcc-multilib g++-multilib libsdl2-dev libmagic1

   Note

   Due to the unavailability of gcc-multilib and g++-multilib on AArch64 (ARM64) systems, you may need to omit them from the list of packages to install.

2. Verify the versions of the main dependencies installed on your system by entering:

   1	cmake --version

   2	python3 --version

   3	dtc --version

   Check those against the versions in the table in the beginning of this section. Refer to the Install Linux Host Dependencies page for additional information on updating the dependencies manually.

1. Open a cmd.exe terminal window as a regular user

2. Create a new virtual environment:

   BatchfilePowerShell

   1	cd %HOMEPATH%

   2	py -3.12 -m venv NCS-Project\.venv

   1	cd $Env:HOMEPATH

   2	py -3.12 -m venv NCS-Project\.venv

3. Activate the virtual environment:

   Note

   Python’s virtual environment activation in PowerShell requires running a script itself, which needs to be allowed.

   Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
   

   BatchfilePowerShell

   NCS-Project\.venv\Scripts\activate.bat
   

   NCS-Project\.venv\Scripts\Activate.ps1
   

   Once activated your shell will be prefixed with (.venv). The virtual environment can be deactivated at any time by running deactivate.

   Note

   Remember to activate the virtual environment every time you start working.

4. Install west:

   pip install west
   

5. Get the latest source code:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr main NCS-Project
   

   Tip

   You can initialize west with the revision of the project that you want to check out. For example, to check out the v2.0.0 release, use the following command instead:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr v2.0.0 NCS-Project
   

6. Enter the following commands to clone the project repositories:

   1	cd NCS-Project

   2	west update

   After all the repositories updated, your workspace folder now looks similar to this:

   1 2 3 4 5 6 7 8 9 10 11 12

   NCS-Project |___ .venv |___ .west |___ bootloader |___ modules |___ nrf |___ nrf9151-connectkit |___ nrfxlib |___ test |___ tools |___ zephyr |___ ...

7. Export a Zephyr CMake package. This allows CMake to automatically load boilerplate code required for building Zephyr applications.

   west zephyr-export
   

8. Install Python dependencies using west packages.

   BatchfilePowerShell

   cmd /c zephyr\scripts\utils\west-packages-pip-install.cmd
   

   python -m pip install @((west packages pip) -split ' ')
   

   Note

   This could downgrade or upgrade west itself.

1. Create a new virtual environment:

   python3 -m venv ~/NCS-Project/.venv
   

2. Activate the virtual environment:

   source ~/NCS-Project/.venv/bin/activate
   

   Once activated your shell will be prefixed with (.venv). The virtual environment can be deactivated at any time by running deactivate.

   Note

   Remember to activate the virtual environment every time you start working.

3. Install west:

   pip install west
   

4. Get the latest source code:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr main NCS-Project
   

   Tip

   You can initialize west with the revision of the project that you want to check out. For example, to check out the v2.0.0 release, use the following command instead:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr v2.0.0 NCS-Project
   

5. Enter the following commands to clone the project repositories:

   1	cd NCS-Project

   2	west update

   After all the repositories updated, your workspace folder now looks similar to this:

   1 2 3 4 5 6 7 8 9 10 11 12

   NCS-Project |___ .venv |___ .west |___ bootloader |___ modules |___ nrf |___ nrf9151-connectkit |___ nrfxlib |___ test |___ tools |___ zephyr |___ ...

6. Export a Zephyr CMake package. This allows CMake to automatically load boilerplate code required for building Zephyr applications.

   west zephyr-export
   

7. Install Python dependencies using west packages.

   west packages pip --install
   

   Note

   This could downgrade or upgrade west itself.

1. Create a new virtual environment:

   python3 -m venv ~/NCS-Project/.venv
   

2. Activate the virtual environment:

   source ~/NCS-Project/.venv/bin/activate
   

   Once activated your shell will be prefixed with (.venv). The virtual environment can be deactivated at any time by running deactivate.

   Note

   Remember to activate the virtual environment every time you start working.

3. Install west:

   pip install west
   

4. Get the latest source code:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr main NCS-Project
   

   Tip

   You can initialize west with the revision of the project that you want to check out. For example, to check out the v2.0.0 release, use the following command instead:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr v2.0.0 NCS-Project
   

5. Enter the following commands to clone the project repositories:

   1	cd NCS-Project

   2	west update

   After all the repositories updated, your workspace folder now looks similar to this:

   1 2 3 4 5 6 7 8 9 10 11 12

   NCS-Project |___ .venv |___ .west |___ bootloader |___ modules |___ nrf |___ nrf9151-connectkit |___ nrfxlib |___ test |___ tools |___ zephyr |___ ...

6. Export a Zephyr CMake package. This allows CMake to automatically load boilerplate code required for building Zephyr applications.

   west zephyr-export
   

7. Install Python dependencies using west packages.

   west packages pip --install
   

   Note

   This could downgrade or upgrade west itself.

Install the Zephyr SDK using the west sdk install.

1

cd %HOMEPATH%\NCS-Project\zephyr

2

west sdk install -t arm-zephyr-eabi

1

cd $Env:HOMEPATH\NCS-Project\zephyr

2

west sdk install -t arm-zephyr-eabi

Install the Zephyr SDK using the west sdk install.

1

cd ~/NCS-Project/zephyr

2

west sdk install -t arm-zephyr-eabi

Install the Zephyr SDK using the west sdk install.

1

cd ~/NCS-Project/zephyr

2

west sdk install -t arm-zephyr-eabi

1. Start PuTTY.

2. Configure the correct serial port and click Open:

   

Open up a terminal and run:

screen <serial-port-name> 115200

Open up a terminal and run:

screen <serial-port-name> 115200