Skip to content

Commit 2cc2c09

Browse files
committed
doc: 2.9.0 pre-release adjustments
Made few fixes for better readability. Updated links and added release notes placeholder. Removed note about sample model change from 2.6.0 Signed-off-by: Anna Wojdylo <[email protected]>
1 parent a2433e0 commit 2cc2c09

File tree

7 files changed

+66
-69
lines changed

7 files changed

+66
-69
lines changed

doc/compatibility_matrix.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
1515
- Supported platforms
1616
- The Amazon Sidewalk Protocol Implementation Conformance Statement (PICS)
1717
- Amazon qualification status
18+
* - v2.9.0
19+
- v1.17.0
20+
- * `nRF52840 DK`_
21+
* `nRF5340 DK`_
22+
* `nRF54L15 DK`_
23+
- --
24+
- Planned
1825
* - v2.8.0
1926
- v1.17.0
2027
- * `nRF52840 DK`_
@@ -41,3 +48,5 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
4148
* `nRF5340 DK`_
4249
- ---
4350
- Qualified/approved
51+
52+
`*` Experimental support

doc/includes/memory_requirement.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 31.02 | 325.46 | 4 | 8 | 368.48 | 99.98 |
3535
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
3636

37-
.. tab:: nRF54L10 emulation
37+
.. tab:: nRF54L10 SoC
3838

39-
The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample running on the `nRF54L15 DK`_, emulating the nRF54L10 SoC.
39+
The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample emulating the nRF54L10 SoC on the `nRF54L15 DK`_.
4040
To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.
4141

4242
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+

doc/links.rst

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@
22
33
.. ncs links (all links need to be updated manually **right before** the targeted release)
44
5-
.. _nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/index.html
6-
.. _nrf52840 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
7-
.. _nrf5340 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
8-
.. _Thingy53: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
9-
.. _nRF54L15 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
10-
.. _Getting started with nRF52 Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/gsg_guides/nrf52_gs.html
11-
.. _Getting started with nRF53 Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/gsg_guides/nrf5340_gs.html
12-
.. _Getting started with nRF54L Series: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/gsg_guides/gsg_other.html
13-
.. _nRF Connect SDK Getting started: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/installation.html
14-
.. _nRF52840dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
15-
.. _nrf5340dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
16-
.. _thingy53_nrf5340: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/thingy53/doc/index.html
17-
.. _nrf54l15dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html
18-
.. _Building and programming an application: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/programming.html
19-
.. _Testing and debugging an application: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/test_and_optimize.html
20-
.. _Bootloader and DFU solutions for NCS: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/bootloaders/index.html
21-
.. _Zephyr SMP Server: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/services/device_mgmt/ota.html#smp_server
22-
.. _Zephyr SMP Server sample: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/samples/subsys/mgmt/mcumgr/smp_svr/README.html
23-
.. _Zephyr State Machine Framework: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/services/smf/index.html
24-
.. _NCS testing applications: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/test_and_optimize.html
25-
.. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/installation/install_ncs.html
26-
.. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
27-
.. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/security/trusted_storage.html
28-
.. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/security/bootloader/fprotect.html
5+
.. _nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/index.html
6+
.. _nrf52840 DK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
7+
.. _nrf5340 DK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
8+
.. _Thingy53: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
9+
.. _nRF54L15 DK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
10+
.. _Getting started with nRF52 Series: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/gsg_guides/nrf52_gs.html
11+
.. _Getting started with nRF53 Series: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/gsg_guides/nrf5340_gs.html
12+
.. _Getting started with nRF54L Series: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/gsg_guides/gsg_other.html
13+
.. _nRF Connect SDK Getting started: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/installation.html
14+
.. _nRF52840dk: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
15+
.. _nrf5340dk: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
16+
.. _thingy53_nrf5340: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/thingy53/doc/index.html
17+
.. _nrf54l15dk: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html
18+
.. _Building and programming an application: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/programming.html
19+
.. _Testing and debugging an application: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/test_and_optimize.html
20+
.. _Bootloader and DFU solutions for NCS: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/bootloaders/index.html
21+
.. _Zephyr SMP Server: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/services/device_mgmt/ota.html#smp_server
22+
.. _Zephyr SMP Server sample: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/samples/subsys/mgmt/mcumgr/smp_svr/README.html
23+
.. _Zephyr State Machine Framework: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/services/smf/index.html
24+
.. _NCS testing applications: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/test_and_optimize.html
25+
.. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/installation/install_ncs.html
26+
.. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/security/trusted_storage.html
27+
.. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/security/bootloader/fprotect.html
2928

3029
.. ncs fixed links(do not update them)
3130
32-
31+
.. _Release notes for the nRF Connect SDK v2.9.0: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/releases_and_maturity/releases/release-notes-2.9.0.html
3332
.. _Release notes for the nRF Connect SDK v2.8.0: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/releases/release-notes-2.8.0.html
3433
.. _Release notes for the nRF Connect SDK v2.7.0: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/releases_and_maturity/releases/release-notes-2.7.0.html
3534
.. _Release notes and limitations for the nRF Connect SDK v2.6.99-cs1: https://docs.nordicsemi.com/bundle/ncs-2.6.99-cs1/page/nrf/releases_and_maturity/releases/release-notes-2.6.99-cs1.html
3635
.. _Release notes for the nRF Connect SDK v2.6.0: https://docs.nordicsemi.com/bundle/ncs-2.6.0/page/nrf/releases_and_maturity/releases/release-notes-2.6.0.html
3736
.. _Release notes for the nRF Connect SDK v2.5.0: https://docs.nordicsemi.com/bundle/ncs-2.5.0/page/nrf/releases_and_maturity/releases/release-notes-2.5.0.html
37+
.. _Known issues for the nRF Connect SDK for the v2.9.0: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/releases_and_maturity/known_issues.html
3838
.. _Known issues for the nRF Connect SDK for the v2.8.0: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/known_issues.html
3939
.. _Known issues for the nRF Connect SDK for the v2.7.0: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/releases_and_maturity/known_issues.html
4040
.. _Known issues for the nRF Connect SDK for the v2.6.0: https://docs.nordicsemi.com/bundle/ncs-2.6.0/page/nrf/releases_and_maturity/known_issues.html
@@ -45,6 +45,7 @@
4545
.. _Nordic nRF52840 DK: https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK
4646
.. _nRF Command Line Tools: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools/Download#infotabs
4747
.. _DevZone DFU guide: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/software/posts/ncs-dfu#ble_testing
48+
.. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
4849

4950
.. github.com
5051

doc/releases_and_migration.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ See information about the latest release notes and the available migration guide
1010
:glob:
1111
:caption: Release notes:
1212

13+
releases_and_migration/release_notes_v290.rst
1314
releases_and_migration/release_notes_v280.rst
1415
releases_and_migration/release_notes_v270.rst
1516
releases_and_migration/release_notes_v2699cs1.rst
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sidewalk_release_notes_290:
2+
3+
Release notes for Amazon Sidewalk - nRF Connect SDK v2.9.0
4+
##########################################################
5+
6+
For more information about the current Amazon Sidewalk release, refer to the links in the following sections.
7+
8+
Changelog
9+
*********
10+
11+
See the `Release notes for the nRF Connect SDK v2.9.0`_ release.
12+
13+
Known issues
14+
************
15+
16+
See `Known issues for the nRF Connect SDK for the v2.9.0`_ release.

doc/samples/samples_list.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,21 @@ The following table demonstrates the variants' configuration for the supported d
1414
| :ref:`variant_sidewalk_hello` | Sample application showing communication | * `nRF52840 DK`_ | * External flash (included in the DK) except `nRF54L15 DK`_ | * MCUboot - DFU partition in external flash | * ``overlay-hello.conf`` |
1515
| | over Sidewalk network. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | |
1616
| | | * `nRF54L15 DK`_ | | | |
17-
| | | * nRF54L10 emulating on `nRF54L15 DK`_ | | | |
17+
| | | * nRF54L10 emulating on `nRF54L15 DK`_ * | | | |
1818
+-----------------------------------+------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
1919
| :ref:`variant_sensor_monitoring` | Demo application of Sidewalk protocol | * `nRF52840 DK`_ | * External flash (included in the DK) except `nRF54L15 DK`_ | * MCUboot - DFU partition in external flash | * ``overlay-demo.conf`` |
2020
| | with temperature sensor monitoring. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | |
2121
| | | * `Thingy53`_ | | | |
2222
| | | * `nRF54L15 DK`_ | | | |
23-
| | | * nRF54L10 emulating on `nRF54L15 DK`_ | | | |
23+
| | | * nRF54L10 emulating on `nRF54L15 DK`_ * | | | |
2424
+-----------------------------------+------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
2525
| :ref:`variant_sidewalk_dut` | Device under test generic application | * `nRF52840 DK`_ | * External flash (included in the DK) except `nRF54L15 DK`_ | * MCUboot - DFU partition in external flash | * ``overlay-dut.conf`` |
2626
| | having activated CLI. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | |
2727
| | | * `nRF54L15 DK`_ | | | |
28-
| | | * nRF54L10 emulating on `nRF54L15 DK`_ | | | |
28+
| | | * nRF54L10 emulating on `nRF54L15 DK`_ * | | | |
2929
+-----------------------------------+------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
3030

31-
.. note::
32-
33-
With the v2.6.0 release of the `nRF Connect SDK`_ a new sample model has been introduced.
34-
To see how the changes might affect your application, see the :ref:`migration_guide_v260`.
31+
`*` Experimental support
3532

3633
.. toctree::
3734
:maxdepth: 3

doc/setting_up_sidewalk_environment/setting_up_sidewalk_prototype.rst

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,14 @@ The tools required for provisioning are located in the repository (`sdk-nrf`_ an
8888
--addr 0x17c000
8989
--output_hex nordic_aws_nrf54l15.hex
9090
91-
.. note::
92-
You can use the ``--output_hex`` parameter to specify a custom name for the :file:`mfg.hex` file.
93-
This change is optional and does not affect the file's compatibility with other supported boards.
94-
If the parameter is not provided, the default name will be :file:`nordic_aws_nrf52840.hex`.
91+
.. note::
92+
93+
For the nRF54L10 SoC emulating on the nRF54L15 DK, you must set the address value to ``--addr 0xFF000``.
94+
95+
.. note::
96+
You can use the ``--output_hex`` parameter to specify a custom name for the :file:`mfg.hex` file.
97+
This change is optional and does not affect the file's compatibility with other supported boards.
98+
If the parameter is not provided, the default name will be :file:`nordic_aws_nrf52840.hex`.
9599

96100
#. Flash the generated file with the provisioning data:
97101

@@ -103,37 +107,6 @@ The tools required for provisioning are located in the repository (`sdk-nrf`_ an
103107
To do this, perform a factory reset by long pressing **Button 0**.
104108
This will allow you to register a new product (new :file:`nordic_aws_nrf54l15.hex`) in the Sidewalk network.
105109

106-
.. group-tab:: nRF54L10 emulating on nRF54L15 DK
107-
108-
1. Follow the `Provision your Sidewalk endpoint and flash the binary image`_ documentation.
109-
110-
The default address of the :file:`mfg.hex` file provided in the official Amazon Sidewalk documentation is incompatible with the nRF Connect SDK applications.
111-
To fix it, you must add an argument to the :file:`provision.py` script in order to generate the :file:`mfg.hex` file that is compatible with the nRF Connect SDK memory map.
112-
Depending on the device, the argument will differ.
113-
114-
* If you are using the combined device JSON file obtained from the AWS IoT console, use the ``certificate_json`` parameter.
115-
It will specify this file as an input when running the provisioning script.
116-
117-
.. parsed-literal::
118-
:class: highlight
119-
120-
python3 provision.py nordic aws --output_bin mfg.bin --certificate_json certificate.json --addr 0xFF000
121-
122-
* If you are using separate device JSON files obtained as responses from the GetDeviceProfile and GetWirelessDevice API operations, use the ``wireless_device_json`` and ``device_profile_json`` parameters.
123-
This will specify both files as input when running the provisioning script.
124-
125-
.. parsed-literal::
126-
:class: highlight
127-
128-
python3 provision.py nordic aws --output_bin mfg.bin
129-
--wireless_device_json wireless_device.json
130-
--device_profile_json device_profile.json
131-
--addr 0xFF000
132-
133-
.. note::
134-
The default name of the :file:`mfg.hex` file generated from the :file:`provision.py` script is :file:`nordic_aws_nrf52840.hex`.
135-
You can use the ``--output_hex`` parameter to specify a custom name for the :file:`mfg.hex` file.
136-
137110
Add MQTT to destination
138111
***********************
139112

0 commit comments

Comments
 (0)