Skip to content

doc: Update docs for release 0.2.0 #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markaj-nordic merged 1 commit into from
May 29, 2025
Merged

doc: Update docs for release 0.2.0 #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion app/VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
VERSION_MAJOR = 0
VERSION_MINOR = 1
VERSION_MINOR = 2
PATCHLEVEL = 0
VERSION_TWEAK = 0
EXTRAVERSION =
29 changes: 26 additions & 3 deletions docs/known_issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,45 @@ A known issue can list one or both of the following entries:
Some known issues have a workaround.
Sometimes, they are discovered later and added over time.

The |APP_NAME| v0.1.0
*********************
The |APP_NAME|
**************

`v0.2.0`

AL-239: Occasional timeout in the reader when executing the RD-NFC-STDTXN-2.0 test from the Test Harness
When executing the RD-NFC-STDTXN-2.0 test case, the reader might report an RX timeout error code in the serial console.
For more details, see `Test Harness issue #191`_.

`v0.2.0`

AL-282: Undefined access decision when executing the RD-NFC-STDTXN-2.0 Test Harness case in a loop
When executing the RD-NFC-STDTXN-2.0 test case multiple times in a row (with valid credentials provisioned), the reader might not report the access decision at all.
As a result, neither ``ACCESS GRANTED`` nor ``ACCESS DENIED`` log is displayed in the serial output of the reader under test.

`v0.1.0` `v0.2.0`

AL-148: The RD-NFC-STDTXN-1.0 test case fails when the NFC module ST X-NUCLEO-NFC05A1 is in use
Copy link
Copy Markdown
Collaborator Author

@markaj-nordic markaj-nordic May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@b-gent also one question to the whole section. The 'RD-NFC-STDTXN-*' is the naming from a particular revision of the test harness, we explicitly mention the version in use here:
https://github.com/nrfconnect/ncs-door-lock-app/blob/main/docs/testing.rst?plain=1#L30

Do you think we should add this information somewhere here as well? The point is, RD-NFC-STDTXN-* is not a valid name for newer test harness releases.

Testing RD-NFC-STDTXN-1.0 with the NFC module NFC05A1 results in failure.
The issue arises from an error indicated by the test harness, which detects the presence of an invalid TLV tag in the payload received from the Device Under Test (DUT).

**Workaround:** Switch to X-NUCLEO-NFC09A1, a newer, recommended revision of the NFC ST module.
Attach X-NUCLEO-NFC09A1 shield to the nRF54L15 DK, rebuild the firmware with the ``CONFIG_ST25R200_DRV`` Kconfig option enabled, and re-flash the nRF54L15 DK.
Attach the X-NUCLEO-NFC09A1 shield to the supported Nordic development kit, rebuild the firmware with the ``CONFIG_ST25R200_DRV`` Kconfig option enabled, and reflash the DK.

`v0.1.0` `v0.2.0`

AL-158: Access control is insufficient due to relying only on signature verification
The reader device does not have the capability to configure additional access rules.
Access Manager is not implemented.

`v0.1.0` `v0.2.0`

AL-159: Cannot provision multiple user devices
The system allows provisioning of only one user device to the reader device.

`v0.1.0` `v0.2.0`

AL-161: The RD-NFC-STDTXN-2.0 [X-NUCLEO-NFC08A1] test exhibits a delay in the transaction initiation step
During the RD-NFC-STDTXN-2.0 test execution, there is a noticeable delay of a few seconds after the transaction initiation step.

**Workaround:** Switch to X-NUCLEO-NFC09A1, a newer, recommended revision of the NFC ST module.
Attach the X-NUCLEO-NFC09A1 shield to the supported Nordic development kit, rebuild the firmware with the ``CONFIG_ST25R200_DRV`` Kconfig option enabled, and reflash the DK.
2 changes: 2 additions & 0 deletions docs/links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
.. _`running test scripts`: https://github.com/csa-access-control/aliro-certification-tool?tab=readme-ov-file#c---creating-a-test-run-running-test-scripts
.. _`Setting up the command-line build environment`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/installation/install_ncs.html#set_up_the_command-line_build_environment
.. _`Zephyr CMake package`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/build/zephyr_cmake_package.html#cmake-pkg
.. _`Test Harness issue #191`: https://github.com/csa-access-control/aliro-certification-tool/issues/191


.. ### Source: docs.nordicsemi.com
Requires manual update to align it with the NCS version.
Expand Down
35 changes: 34 additions & 1 deletion docs/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,46 @@ Release notes

This page outlines changes introduced with each release of the |APP_NAME|.

v0.2.0
******

.. note::
|EXPERIMENTAL_NOTE|

Changelog
=========

The following updates were introduced in this release.

* Added:

* Experimental support for the following development platforms:

* `nRF52840 DK`_
* `nRF5340 DK`_
Comment on lines 23 to 24
Copy link
Copy Markdown
Contributor

@MarGasiorek MarGasiorek May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links are related to the DK's, however, we added support for the SoC's

Copy link
Copy Markdown
Collaborator Author

@markaj-nordic markaj-nordic May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is questionable I'd say :) I think it's even safer to keep DKs here.


* A platform logger implementation.
* Integrated a new NFC transport interface.
* Integrated simplified Aliro stack API.

* Changed:

* Improved the implementation the following components in RFAL platform abstraction layer:

* Timers
* Semaphores
* Threading

v0.1.0
******

.. note::
|EXPERIMENTAL_NOTE|

See the following section for the list of implemented features.
Changelog
=========

The following updates were introduced in this release.

* Added experimental support for the following:

Expand Down
Loading