Skip to content

Commit

Permalink
doc: 2.9.0 pre-release adjustments
Browse files Browse the repository at this point in the history 
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]>
  • Loading branch information
@annwoj
annwoj committed Dec 6, 2024
1 parent a2433e0 commit bcf3f60
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 69 deletions.
9 changes: 9 additions & 0 deletions doc/compatibility_matrix.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
- Supported platforms
- The Amazon Sidewalk Protocol Implementation Conformance Statement (PICS)
- Amazon qualification status
* - v2.9.0
- v1.17.0
- * `nRF52840 DK`_
* `nRF5340 DK`_
* `nRF54L15 DK`_
- --
- Planned
* - v2.8.0
- v1.17.0
- * `nRF52840 DK`_
Expand All @@ -41,3 +48,5 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
* `nRF5340 DK`_
- ---
- Qualified/approved

`*` Experimental support.
4 changes: 2 additions & 2 deletions doc/includes/memory_requirement.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 31.02 | 325.46 | 4 | 8 | 368.48 | 99.98 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+

.. tab:: nRF54L10 emulation
.. tab:: nRF54L10 SoC

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.
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`_.
To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.

+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
Expand Down
51 changes: 26 additions & 25 deletions doc/links.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,39 @@
.. ncs links (all links need to be updated manually **right before** the targeted release)
.. _nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/index.html
.. _nrf52840 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
.. _nrf5340 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
.. _Thingy53: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
.. _nRF54L15 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
.. _Getting started with nRF52 Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/gsg_guides/nrf52_gs.html
.. _Getting started with nRF53 Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/gsg_guides/nrf5340_gs.html
.. _Getting started with nRF54L Series: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/gsg_guides/gsg_other.html
.. _nRF Connect SDK Getting started: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/installation.html
.. _nRF52840dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
.. _nrf5340dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
.. _thingy53_nrf5340: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/thingy53/doc/index.html
.. _nrf54l15dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html
.. _Building and programming an application: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/programming.html
.. _Testing and debugging an application: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/test_and_optimize.html
.. _Bootloader and DFU solutions for NCS: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/bootloaders/index.html
.. _Zephyr SMP Server: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/services/device_mgmt/ota.html#smp_server
.. _Zephyr SMP Server sample: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/samples/subsys/mgmt/mcumgr/smp_svr/README.html
.. _Zephyr State Machine Framework: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/services/smf/index.html
.. _NCS testing applications: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/test_and_optimize.html
.. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/installation/install_ncs.html
.. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
.. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/security/trusted_storage.html
.. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/security/bootloader/fprotect.html
.. _nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/index.html
.. _nrf52840 DK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
.. _nrf5340 DK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
.. _Thingy53: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
.. _nRF54L15 DK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/board_support/board_names.html
.. _Getting started with nRF52 Series: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/gsg_guides/nrf52_gs.html
.. _Getting started with nRF53 Series: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/gsg_guides/nrf5340_gs.html
.. _Getting started with nRF54L Series: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/gsg_guides/gsg_other.html
.. _nRF Connect SDK Getting started: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/installation.html
.. _nRF52840dk: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
.. _nrf5340dk: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
.. _thingy53_nrf5340: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/thingy53/doc/index.html
.. _nrf54l15dk: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html
.. _Building and programming an application: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/programming.html
.. _Testing and debugging an application: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/test_and_optimize.html
.. _Bootloader and DFU solutions for NCS: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/config_and_build/bootloaders/index.html
.. _Zephyr SMP Server: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/services/device_mgmt/ota.html#smp_server
.. _Zephyr SMP Server sample: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/samples/subsys/mgmt/mcumgr/smp_svr/README.html
.. _Zephyr State Machine Framework: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/services/smf/index.html
.. _NCS testing applications: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/test_and_optimize.html
.. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/installation/install_ncs.html
.. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/security/trusted_storage.html
.. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/security/bootloader/fprotect.html

.. ncs fixed links(do not update them)
.. _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
.. _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
.. _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
.. _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
.. _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
.. _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
.. _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
.. _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
.. _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
.. _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
Expand All @@ -45,6 +45,7 @@
.. _Nordic nRF52840 DK: https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK
.. _nRF Command Line Tools: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools/Download#infotabs
.. _DevZone DFU guide: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/software/posts/ncs-dfu#ble_testing
.. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html

.. github.com
Expand Down
1 change: 1 addition & 0 deletions doc/releases_and_migration.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ See information about the latest release notes and the available migration guide
:glob:
:caption: Release notes:

releases_and_migration/release_notes_v290.rst
releases_and_migration/release_notes_v280.rst
releases_and_migration/release_notes_v270.rst
releases_and_migration/release_notes_v2699cs1.rst
Expand Down
17 changes: 17 additions & 0 deletions doc/releases_and_migration/release_notes_v290.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _sidewalk_release_notes_290:

Release notes for Amazon Sidewalk - nRF Connect SDK v2.9.0
##########################################################


For more information about the current Amazon Sidewalk release, refer to the links in the following sections.

Changelog
*********

See the `Release notes for the nRF Connect SDK v2.9.0`_ release.

Known issues
************

See `Known issues for the nRF Connect SDK for the v2.9.0`_ release.
11 changes: 4 additions & 7 deletions doc/samples/samples_list.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,21 @@ The following table demonstrates the variants' configuration for the supported d
| :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`` |
| | over Sidewalk network. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | |
| | | * `nRF54L15 DK`_ | | | |
| | | * nRF54L10 emulating on `nRF54L15 DK`_ | | | |
| | | * nRF54L10 emulating on `nRF54L15 DK`_ * | | | |
+-----------------------------------+------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| :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`` |
| | with temperature sensor monitoring. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | |
| | | * `Thingy53`_ | | | |
| | | * `nRF54L15 DK`_ | | | |
| | | * nRF54L10 emulating on `nRF54L15 DK`_ | | | |
| | | * nRF54L10 emulating on `nRF54L15 DK`_ * | | | |
+-----------------------------------+------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| :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`` |
| | having activated CLI. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | |
| | | * `nRF54L15 DK`_ | | | |
| | | * nRF54L10 emulating on `nRF54L15 DK`_ | | | |
| | | * nRF54L10 emulating on `nRF54L15 DK`_ * | | | |
+-----------------------------------+------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+

.. note::

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

.. toctree::
:maxdepth: 3
Expand Down
43 changes: 8 additions & 35 deletions doc/setting_up_sidewalk_environment/setting_up_sidewalk_prototype.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,14 @@ The tools required for provisioning are located in the repository (`sdk-nrf`_ an
--addr 0x17c000
--output_hex nordic_aws_nrf54l15.hex
.. note::
You can use the ``--output_hex`` parameter to specify a custom name for the :file:`mfg.hex` file.
This change is optional and does not affect the file's compatibility with other supported boards.
If the parameter is not provided, the default name will be :file:`nordic_aws_nrf52840.hex`.
.. note::

For the nRF54L10 SoC emulating on the nRF54L15 DK, you must set the address value to ``--addr 0xFF000``.

.. note::
You can use the ``--output_hex`` parameter to specify a custom name for the :file:`mfg.hex` file.
This change is optional and does not affect the file's compatibility with other supported boards.
If the parameter is not provided, the default name will be :file:`nordic_aws_nrf52840.hex`.

#. Flash the generated file with the provisioning data:

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

.. group-tab:: nRF54L10 emulating on nRF54L15 DK

1. Follow the `Provision your Sidewalk endpoint and flash the binary image`_ documentation.

The default address of the :file:`mfg.hex` file provided in the official Amazon Sidewalk documentation is incompatible with the nRF Connect SDK applications.
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.
Depending on the device, the argument will differ.

* If you are using the combined device JSON file obtained from the AWS IoT console, use the ``certificate_json`` parameter.
It will specify this file as an input when running the provisioning script.

.. parsed-literal::
:class: highlight
python3 provision.py nordic aws --output_bin mfg.bin --certificate_json certificate.json --addr 0xFF000
* 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.
This will specify both files as input when running the provisioning script.

.. parsed-literal::
:class: highlight
python3 provision.py nordic aws --output_bin mfg.bin
--wireless_device_json wireless_device.json
--device_profile_json device_profile.json
--addr 0xFF000
.. note::
The default name of the :file:`mfg.hex` file generated from the :file:`provision.py` script is :file:`nordic_aws_nrf52840.hex`.
You can use the ``--output_hex`` parameter to specify a custom name for the :file:`mfg.hex` file.

Add MQTT to destination
***********************

Expand Down

0 comments on commit bcf3f60

Please sign in to comment.