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

Chocolatey is recommended to install dependencies here. If Chocolatey isn’t an option, you can install dependencies from their respective websites and ensure the command line tools added in your PATH environment variable.

1. Install chocolatey.

2. Open a cmd.exe window as Administrator. To do so, press the Windows key Win , type cmd.exe, right-click the result, and choose Run as Administrator.

3. Disable global confirmation to avoid having to confirm the installation of individual programs:

   choco feature enable -n allowGlobalConfirmation
   

4. Use choco to install the required dependencies:

   1	choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'

   2	choco install ninja gperf python311 git dtc-msys2 wget 7zip

5. Close the terminal window and open a new cmd.exe window as a regular user to continue.

choco list -lo

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. If using an Ubuntu version older than 22.04, it is necessary to add extra repositories to meet the minimum required versions for the main dependencies listed above. In that case, download, inspect and execute the Kitware archive script to add the Kitware APT repository to your sources list. A detailed explanation of kitware-archive.sh can be found here kitware third-party apt repository:

   1	wget https://apt.kitware.com/kitware-archive.sh

   2	sudo bash kitware-archive.sh

2. Use apt to install the required dependencies:

   1 2 3 4

   sudo apt install --no-install-recommends git cmake ninja-build gperf \ ccache dfu-util device-tree-compiler wget \ python3-dev python3-pip python3-setuptools python3-tk python3-wheel 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 remove them from the list of packages to install.

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

   1	cmake --version

   2	python3 --version

   3	dtc --version

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

2. Create a new virtual environment:

   python -m venv NCS-Project\.venv
   

3. Activate the virtual environment:

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

   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 v1.0.0 release, use the following command instead:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr v1.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. The Zephyr west extension command west packages can be used to install Python dependencies.

   west packages pip --install
   

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 v1.0.0 release, use the following command instead:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr v1.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. The Zephyr west extension command west packages can be used to install Python dependencies.

   west packages pip --install
   

1. Use apt to install Python venv package:

   sudo apt install python3-venv
   

2. Create a new virtual environment:

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

3. 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.

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 v1.0.0 release, use the following command instead:

   west init -m https://github.com/makerdiary/nrf9151-connectkit --mr v1.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. The Zephyr west extension command west packages can be used to install Python dependencies.

   west packages pip --install
   

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

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