Skip to content

Commit

Permalink
doc: small ux improvements
Browse files Browse the repository at this point in the history 
Small improvements for nrf54l15

Signed-off-by: Anna Wojdylo <[email protected]>
  • Loading branch information
@annwoj @totyz
annwoj authored and totyz committed Apr 22, 2024
1 parent bf20e8b commit ac2a8c2
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 24 deletions.
4 changes: 2 additions & 2 deletions doc/compatibility_matrix.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
- * `nRF52840 DK`_
- Qualified/approved
* - ---
- v2.5.0 ``*``
- v2.5.0 `*`
- v1.14
- * `nRF52840 DK`_
* `nRF5340 DK`_
Expand All @@ -38,6 +38,6 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
* `nRF5340 DK`_
- Planned

``*`` - From the v2.5.0 release, Amazon Sidewalk is a part of the nRF Connect SDK.
`*` From the v2.5.0 release, Amazon Sidewalk is a part of the nRF Connect SDK.

.. include:: ncs_links.rst
8 changes: 4 additions & 4 deletions doc/samples/samples_list.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ 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 PDK`_ | * 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 PDK`_ ``*`` | | | |
| | | * `nRF54L15 PDK`_ `*` | | | |
+-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| :ref:`variant_sensor_monitoring` | Demo application of Sidewalk protocol | * `nRF52840 DK`_ | * External flash (included in the DK) except `nRF54L15 PDK`_ | * 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 PDK`_ ``*`` | | | |
| | | * `nRF54L15 PDK`_ `*` | | | |
+-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| :ref:`variant_sidewalk_dut` | Device under test generic application | * `nRF52840 DK`_ | * External flash (included in the DK) except `nRF54L15 PDK`_ | * 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 PDK`_ ``*`` | | | |
| | | * `nRF54L15 PDK`_ `*` | | | |
+-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+

``*`` - `nRF54L15 PDK`_ does not support LoRa and FSK configurations.
`*` The `nRF54L15 PDK`_ does not support LoRa and FSK configurations.

.. note::

Expand Down
4 changes: 2 additions & 2 deletions doc/samples/sid_end_device.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ This sample supports the following development kits:
+--------------------+----------+----------------------------+----------------------------------+
| Thingy53 | PCA20053 | `thingy53_nrf5340`_ | ``thingy53_nrf5340_cpuapp`` |
+--------------------+----------+----------------------------+----------------------------------+
| nRF54L15 PDK ``*`` | PCA10156 | `nrf54l15pdk_nrf54l15`_ | ``nrf54l15pdk_nrf54l15_cpuapp`` |
| nRF54L15 PDK `*` | PCA10156 | `nrf54l15pdk_nrf54l15`_ | ``nrf54l15pdk_nrf54l15_cpuapp`` |
+--------------------+----------+----------------------------+----------------------------------+

``*`` - `nRF54L15 PDK`_ does not support LoRa and FSK configurations.
`*` The `nRF54L15 PDK`_ does not support LoRa and FSK configurations.

To run the sample in the Bluetooth LE link mode, you only need the development kit.
However, if you want to run the sample with LoRa or FSK configuration, you also need the LoRa radio module.
Expand Down
53 changes: 37 additions & 16 deletions doc/setting_up_sidewalk_environment/setting_up_sidewalk_product.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,53 @@ The tools required for provisioning are located in the repository (`sdk-nrf`_ an

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

.. note::
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:

* Add the ``--addr 0x17c000`` argument for the `nRF54L15 PDK`_.
* Add the ``--addr 0xFF000`` argument for other boards.
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
.. tabs::

.. tab:: nRF54L15 PDK

.. parsed-literal::
:class: highlight
python3 provision.py nordic aws --output_bin mfg.bin --certificate_json certificate.json --addr 0x17c000
.. tab:: Other boards

python3 provision.py nordic aws --output_bin mfg.bin --certificate_json certificate.json --addr *argument*
.. 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
.. tabs::

.. tab:: nRF54L15 PDK

.. 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 0x17c000
.. tab:: Other boards

.. 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 *argument*
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`.
Expand Down

0 comments on commit ac2a8c2

Please sign in to comment.