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

  5. (Optional) Add the QM35 SDK repository to your workspace. See the Aliro QM35 SDK repository section for more information.

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

  7. Apply the patches to the workspace:

    west patch apply

  8. 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
   ├─── nrf
   ├─── nrfxlib
   ├─── zephyr
   └─── ...

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

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

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

Aliro QM35 SDK repository

The nRF Door Lock and Access Control Add-on integrates the QM35825 UWB (Ultra Wideband) module in applications that support the Aliro technology. This support uses the UWB stack and QM35 host driver from the qm35-aliro-sdk Qorvo SDK repository. If you are using QM35 UWB in your application, add the repository to your workspace. To do that, execute the following command before running west update:

west config manifest.group-filter -- "+qm35-aliro-sdk"

If you are using more group filters in your application, you need to pass them all to the west config manifest.group-filter command using comma-separated values. For example:

west config manifest.group-filter -- "+qm35-aliro-sdk,+group1,+group2,+group3"

Before the first use of the QM35 hardware, make sure you have the correct firmware programmed on the coprocessor module (see Initial QM35 module programming).

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.