Software requirements

This page summarizes the requirements for setting up and working with the nRF Door Lock and Access Control Application.

nRF Connect SDK

Before you start working with the application, you must install the nRF Connect SDK development environment and nRF Connect SDK toolchain.

Prepare the environment:

  1. From the Installing the nRF Connect SDK page, complete the following steps:

    1. Updating operating system

    2. Installing prerequisites

    3. Installing the nRF Connect SDK toolchain

  2. Once completed, open the repository and locate the ncs directory. By default, this is one level up from the location where you installed the toolchain. This directory holds all nRF Connect SDK repositories.

  3. Start the toolchain environment for your operating system by using the following command:

    nrfutil sdk-manager toolchain launch --ncs-version v3.4.0 --shell

  4. Initialize west:

    west init -m https://github.com/nrfconnect/ncs-door-lock-and-access-control --mr main project-workspace
cd project-workspace

    This command clones the ncs-door-lock-and-access-control manifest repository into project-workspace. The manifest imports the ncs-matter add-on, which provides the compatible nRF Connect SDK and Matter SDK revisions.

  5. Use the following command to clone the project repository and all of its submodules:

    west update

    This might take some time, depending on your connection.

  6. Apply the patches to the workspace:

    west patch apply

  7. Export a Zephyr CMake package. This enables CMake to automatically load the boilerplate code required for building nRF Connect SDK applications:

    west zephyr-export

    With the default location to install the toolchain, your directory structure will look similar to the following:

    ncs
├─── toolchains
│  └─── <toolchain-installation>
└─── project-workspace
   ├─── .west
   ├─── bootloader
   ├─── modules
   ├─── ncs-door-lock-and-access-control
   ├─── ncs-matter
   ├─── nrf
   ├─── nrfxlib
   ├─── zephyr
   └─── ...

    In this simplified structure preview, <toolchain-installation> corresponds to the toolchain version.

  8. Complete setting up the command-line build environment.

    Once you have completed all the steps, the development environment will be correctly configured.

Note

Aliro over Bluetooth LE and UWB requires a UWB implementation. The core repository builds the in-tree stub by default; a real UWB backend is provided by an external UWB provider module. For details, see Integrating a UWB implementation.

Aliro Certification Tool

If you are developing a door lock with Aliro support, and you want to execute the Aliro certification tests, you must have the official Aliro Certification Tool.

Matter development tools

If you are developing a door lock with Matter support, you need the Matter tools.