Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/building_and_running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ To build and run the application on one of the :ref:`supported development kits
- Build command
- Description
* - Debug (default)
- `X-NUCLEO-NFC09A1`_
- `X-NUCLEO-NFC12A1`_
- ``west build -p -b build_target app``
- Recommended for new door lock designs.
* - Debug (default)
- `X-NUCLEO-NFC12A1`_
- ``west build -p -b build_target app -- -DCONFIG_ST25R500_DRV=y``
- `X-NUCLEO-NFC09A1`_
- ``west build -p -b build_target app -- -DCONFIG_ST25R200_DRV=y``
- Supported, but not recommended for new products.

For example, if you are using the nRF5340 DK and `X-NUCLEO-NFC12A1`_, the command is:
Expand Down
6 changes: 4 additions & 2 deletions docs/door_lock_app_arch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The |APP_NAME| architecture can be represented as follows:

.. figure:: /images/door_lock_app_arch.svg
:scale: 100%
:alt: nRF Door Lock Reference Application architecture.
:alt: |APP_NAME| architecture.

|APP_NAME| architecture overview.

Expand Down Expand Up @@ -71,7 +71,9 @@ When the Aliro service is stopped and other Bluetooth LE services, such as Bluet
Bluetooth LE transport
**********************

Bluetooth LE transport is supported on the `nRF5340 DK`_ and `nRF54LM20 DK`_ platforms and is configured to operate in the peripheral role, allowing the device to advertise its presence and accept connections from Bluetooth LE central devices.
Aliro over Bluetooth LE-only mode is not supported.
The Aliro mode, which uses a combination of Bluetooth LE and UWB transports, is supported on the `nRF5340 DK`_ and `nRF54LM20 DK`_.
Bluetooth LE transport on the `nRF54L15 DK`_ or `nRF52840 DK`_ is used for other purposes, such as Nordic UART Service (NUS) or OTA DFU.
The advertising payload is generated according to the Aliro specification, based on the ``reader group identifier`` and ``reader group sub-identifier``.
The payload updates automatically whenever these values change, ensuring that the device always advertises the latest group information.

Expand Down
80 changes: 37 additions & 43 deletions docs/hardware_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,56 +209,50 @@ The application supports the following UWB module:
| `QM35825`_ | Qorvo Arduino Interface Board (with custom rework by Qorvo) |
+-------------------+-------------------------------------------------------------+

With the Qorvo Arduino Interface Board, you can use the UWB module with the `nRF5340 DK`_ without requiring any additional hardware, as it connects directly to the Arduino header of the DK.
The following table shows the pin mapping for the Qorvo Arduino Interface Board with custom rework by Qorvo:

.. note::
Contact your local Qorvo support team in the following cases:

* To obtain the Qorvo Arduino Interface Board with special rework done on the board.
You need it to run the application with the QM35825 UWB module.
.. tabs::

.. _hw_requirements_uwb_compatibility:
.. tab:: nRF54LM20 DK

UWB compatibility matrix
========================
The `nRF54LM20 DK`_ does not have Arduino-compatible header, therefore, you must connect your board using wires.
To connect the Qorvo Arduino Interface Board to the DK, refer to the following pin mapping.

+-------------------+---------------------------+
| nRF54LM20 DK | Qorvo Arduino Interface |
| | Board |
+===================+===========================+
| P1.13 | SPI0_CLK (D13) |
+-------------------+---------------------------+
| P1.12 | SPI0_MISO (D12) |
+-------------------+---------------------------+
| P1.11 | SPI0_MOSI (D11) |
+-------------------+---------------------------+
| P3.11 | SPI0_CS (D2) |
+-------------------+---------------------------+
| P0.0 | SS_IRQ (A5) |
+-------------------+---------------------------+
| P3.7 | RST_HOST (D7) |
+-------------------+---------------------------+
| P3.12 | EXTON (D5) |
+-------------------+---------------------------+
| VBUS | 5V_HOST |
+-------------------+---------------------------+
| VDDIO | 3V3_HOST |
+-------------------+---------------------------+
| GND | GND |
+-------------------+---------------------------+

.. note::
To make the hardware setup easier, you can request the PCB design files of the Arduino-compatible adapter for the nRF54LM20 DK and Qorvo Arduino Interface Board through `Nordic DevZone`_.

The following table shows the compatibility between the versions of the |REPO_NAME|, UWB Aliro SDK, UWB FW, and the |NCS|:
.. tab:: nRF5340 DK

.. list-table:: UWB compatibility matrix
:header-rows: 1
:widths: 20 20 20 20

* - |REPO_NAME| version
- UWB Aliro SDK version
- UWB FW version
- |NCS| version
* - 0.3.0
- 0.3.0
- 0.3.0
- 2.9.0
* - 0.4.0
- 0.4.0
- 0.4.0
- 3.1.0
* - 0.5.0
- 0.4.0
- 0.4.0
- 3.1.0
* - 0.6.0-rc1
- 0.5.0
- 0.5.0
- 3.2.0-preview2
* - 0.6.0
- 0.6.0
- 0.6.0
- 3.2.0
* - 1.0.0
- 0.6.0
- 0.6.0
- 3.2.0
The `nRF5340 DK`_ has Arduino-compatible headers, so you can connect the Qorvo Arduino Interface Board directly to development kit.

.. note::
The compatibility matrix shows tested and verified combinations of |REPO_NAME| version, UWB Aliro SDK, UWB firmware, and the |NCS| version.
Contact your local Qorvo Regional Sales Manager or Nordic Regional Sales Manager to obtain the Qorvo Arduino Interface Board with special rework done on the board.
You need it to run the application with the QM35825 UWB module.

.. _hw_requirements_test_harness:

Expand Down
8 changes: 4 additions & 4 deletions docs/images/aliro-add-ons.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/images/door_lock_app_arch.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 12 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,26 @@
|REPO_NAME|
########################

|REPO_NAME| is a top-level add-on containing a sample application that demonstrates how to integrate the `Aliro <Aliro Technology_>`_ and `Matter <Matter marketing note_>`_ stacks to implement fully functional door lock firmware.
In combination with the |NCS|, the |REPO_NAME| provides a complete reference for building Aliro- and Matter-compatible locks and access control readers for both residential and commercial applications.
The reference integrates multiple wireless technologies, including Bluetooth Low Energy (Bluetooth LE), Ultra-Wideband (UWB), NFC, Thread, and Wi-Fi.
This allows you to choose the appropriate technology for your specific use case.

The |REPO_NAME| natively integrates the UWB SDK for Qorvo's QM35825 UWB SoC and the NFC driver for STMicroelectronics' ST25R300.
However, platform abstraction APIs allow for easy integration of a UWB SoC and an NFC transceiver from any silicon vendor.

Aliro standardizes the interaction that lets a phone or wearable act as a digital key at an opening.
Matter delivers reliable command-and-control functionality, such as remote locking and unlocking, user provisioning, and integration with broader home automation platforms.
The reference can support Aliro alone, Matter alone, or both protocols, depending on the specific use case and product requirements.

Aliro is the new industry-standard access control and communication protocol, offering a secure, convenient, and consistent experience for users using smartphones, wearables, or other smart digital devices to unlock doors and openings.
Aliro includes several key features that distinguish it from existing access protocols:

* Interoperability and compatibility - Ensures seamless interaction between access readers, such as electronic locks and access control readers, and User Devices like a smartphone and wearables.
The standardized solution allows manufacturer-independent devices and readers to work together without compromising security.
* Flexibility - Does not dictate how your digital door lock or access control reader connects to the rest of your ecosystem.
* Protocol support - Supports various transport protocols, including mandatory Near Field Communication (NFC), Bluetooth® LE or Bluetooth LE with ultra wideband (UWB).
* Protocol support - Supports various transport protocols, including mandatory Near Field Communication (NFC), Bluetooth® LE or Bluetooth LE with Ultra-Wideband (UWB).

.. note::
The support for the Bluetooth LE transport and UWB ranging is currently `experimental <Software maturity_>`_.
Support for the Aliro mode, which uses a combination of Bluetooth LE and UWB transports, is currently `experimental <Software maturity_>`_.

.. toctree::
:maxdepth: 1
Expand Down
4 changes: 3 additions & 1 deletion docs/links.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. ### This page lists links used in the NCS door lock reference applications docs.
.. ### This page lists links used in the NCS Door Lock and Access Control Add-on docs.


.. ### Source: github.com

.. _`ncs-door-lock-and-access-control`: https://github.com/nrfconnect/ncs-door-lock-and-access-control
.. _`Aliro Certification Tool`: https://github.com/csa-access-control/aliro-certification-tool
.. _`aliro-sve-v1.0`: https://github.com/csa-access-control/aliro-certification-tool/releases/tag/aliro-sve-v1.0
.. _`dryrun/test_event4-2024-aliro_specification_v0.9.0-v1.0`: https://github.com/csa-access-control/aliro-certification-tool/releases/tag/dryrun%2Ftest_event4-2024-aliro_specification_v0.9.0-v1.0
.. _`test harness hardware requirements`: https://github.com/csa-access-control/aliro-certification-tool?tab=readme-ov-file#requirements
.. _`test harness usage instructions`: https://github.com/csa-access-control/aliro-certification-tool?tab=readme-ov-file#usage-instructions
.. _`running test scripts`: https://github.com/csa-access-control/aliro-certification-tool?tab=readme-ov-file#c---creating-a-test-run-running-test-scripts
Expand Down Expand Up @@ -50,6 +51,7 @@

.. _`Matter`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/protocols/matter/index.html
.. _`Matter overview`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/protocols/matter/overview/index.html
.. _`Matter development model in NCS`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/protocols/matter/overview/dev_model.html
.. _`Matter getting started`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/protocols/matter/getting_started/index.html
.. _`Matter tools`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/protocols/matter/getting_started/tools.html
.. _`Matter controller tools`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/protocols/matter/getting_started/tools.html#matter_controller_tools
Expand Down
2 changes: 1 addition & 1 deletion docs/nfc_power_measurements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ NFC current measurements
:local:
:depth: 2

This page describes a method for measuring NFC current consumption of an |APP_NAME| reference application using `Power Profiler Kit II`_ (PPK).
This page describes a method for measuring NFC current consumption of an |APP_NAME| using `Power Profiler Kit II`_ (PPK).

Overview
********
Expand Down
73 changes: 68 additions & 5 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,81 @@
.. _release_notes:

Release notes
#############
Compatibility matrix and release notes
######################################

.. contents::
:local:
:depth: 2

This page outlines changes introduced with each release of the |REPO_NAME|.
This page provides a compatibility matrix with various versions of the components used in |REPO_NAME| and outlines changes introduced with each release of the Add-on.

Compatibility matrix
********************

The following table shows tested and verified combinations of |REPO_NAME| releases with various versions of the components used in the Add-on.

.. list-table:: |REPO_NAME| compatibility matrix
:header-rows: 1
:widths: 12 12 12 12 12 12

* - |REPO_NAME| version
- |NCS| version
- Aliro protocol version
- Matter protocol version
- Qorvo UWB SDK and QM35825 FW version
- STM NFC RFAL library version
* - 0.1.0
- 2.9.0
- 0.9.0
- —
- —
- —
* - 0.2.0
- 2.9.0
- 0.9.0
- —
- —
- 3.0.0
* - 0.3.0
- 2.9.0
- 0.9.0
- —
- 0.3.0
- 3.0.0
* - 0.4.0
- 3.1.0
- 0.9.0
- 1.4.0
- 0.4.0
- 4.0.2
* - 0.5.0
- 3.1.0
- 0.9.0
- 1.4.0
- 0.4.0
- 4.0.2
* - 0.6.0
- 3.2.0
- 1.0.0
- 1.5.0
- 0.6.0
- 4.0.2
* - 1.0.0
- 3.2.0
- 1.0.0
- 1.5.0
- 0.6.0
- 4.0.2

Release notes
*************

The following list outlines the release notes for each release of the |REPO_NAME|.

v1.0.0
******

This milestone release represents the first production-ready, fully certifiable nRF Door Lock Add-on with Aliro v1.0 certification compliance and Matter support, enabling customers to develop and certify commercial smart lock products for the broad market.
This milestone release represents the first production-ready, fully certifiable |REPO_NAME| with Aliro v1.0 certification compliance and Matter support, enabling you to develop and certify interoperable access control products for everything from commercial buildings to residential smart homes.

Changelog
=========
Expand All @@ -25,7 +88,7 @@ Changelog

* Full compliance with Aliro v1.0 certification program.
* Production support for ST25R300 NFC reader module.
* Experimental support for BLE transport protocol and QM35825 UWB module.
* Experimental support for the Aliro mode, which uses a combination of Bluetooth LE and UWB transports, with support for the QM35825 UWB module.
* NFC power profiling and optimization documentation.
* Event-based RFAL worker implementation for reduced NFC power consumption.
* Encrypted Access Document storage on external flash using Zephyr NVS.
Expand Down