Skip to content
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

doc: use nrfutil in documentation #640

Merged
merged 3 commits into from
Nov 5, 2024
Merged

doc: use nrfutil in documentation #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef850dd
doc: use nrfutil in documentation
RobertGalatNordic Nov 4, 2024
34ac319
doc: update expected logs on boot
RobertGalatNordic Nov 4, 2024
ce02523
doc: update memory requirements
RobertGalatNordic Nov 4, 2024
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
24 changes: 12 additions & 12 deletions doc/includes/memory_requirement.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| Sample | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
+================================================================================================================+==================+======================+===================+==========================+================+================+
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Debug) | 26.33 | 414.19 | 4 | 8 | 452.52 | 95.41 |
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Debug) | 26.40 | 368.01 | 4 | 8 | 406.41 | 93.78 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 26.33 | 352.13 | 4 | 8 | 390.46 | 90.54 |
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 26.40 | 299.97 | 4 | 8 | 338.37 | 88.91 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.33 | 512.94 | 4 | 8 | 551.27 | 122.16 |
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.40 | 467.21 | 4 | 8 | 505.61 | 120.28 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.33 | 430.49 | 4 | 8 | 468.82 | 106.04 |
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.40 | 378.97 | 4 | 8 | 417.37 | 104.03 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+

.. tab:: nRF5340 DK
Expand All @@ -25,13 +25,13 @@
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| Sample | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
+================================================================================================================+==================+======================+===================+==========================+================+================+
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Debug) | 30.77 | 356.90 | 4 | 8 | 399.67 | 84.09 |
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Debug) | 30.99 | 311.83 | 4 | 8 | 354.82 | 86.34 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 30.77 | 291.82 | 4 | 8 | 334.59 | 79.40 |
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 30.99 | 241.55 | 4 | 8 | 284.54 | 81.66 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 30.77 | 452.05 | 4 | 8 | 494.82 | 110.62 |
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 30.99 | 412.17 | 4 | 8 | 455.16 | 112.67 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 30.77 | 367.28 | 4 | 8 | 410.05 | 94.58 |
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 30.99 | 321.31 | 4 | 8 | 364.30 | 96.58 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+

.. tab:: nRF54L15 DK
Expand All @@ -42,11 +42,11 @@
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| Sample | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
+================================================================================================================+==================+======================+===================+==========================+================+================+
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Debug) | 26.15 | 353.24 | 4 | 8 | 391.39 | 89.59 |
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Debug) | 26.24 | 366.77 | 4 | 8 | 405.01 | 90.46 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 26.15 | 285.78 | 4 | 8 | 323.93 | 84.77 |
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 26.24 | 296.91 | 4 | 8 | 335.15 | 85.79 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.15 | 449.00 | 4 | 8 | 487.15 | 116.28 |
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.24 | 461.23 | 4 | 8 | 499.47 | 116.64 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.15 | 362.06 | 4 | 8 | 400.21 | 100.13 |
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.24 | 372.77 | 4 | 8 | 411.01 | 100.57 |
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
44 changes: 24 additions & 20 deletions doc/samples/variants/hello.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,18 +142,20 @@ To start Sidewalk, do the following:

.. code-block:: console

*** Booting nRF Connect SDK 883c3709f9c8 ***
*** Booting Sidewalk v2.7.99-ae200c29600e ***
*** Using nRF Connect SDK v2.8.99-152acb8205de ***
*** Using Zephyr OS v3.7.99-08f1c5bc9f20 ***
----------------------------------------------------------------
sidewalk v2.5.0-3-g1232aabb
nrf v2.5.0-g271e80422
zephyr 883c3709f9
Sidewalk SDK = 1.17.1.18
APP_BUILD_VERSION = ae200c29600e
APP_NAME = sidewalk
build time = Oct 30 2024 15:07:09
board = nrf52840dk/nrf52840
----------------------------------------------------------------
sidewalk_fork_point = af5d608303eb03465f35e369ef22ad6c02564ac6
build time = 2023-03-14 15:00:00.000000+00:00
board = nrf52840dk
----------------------------------------------------------------
[00:00:00.001,373] <inf> application_state: working = true
[00:00:00.055,480] <inf> sidewalk_app: Sidewalk link switch to BLE
[00:00:01.095,637] <inf> sid_mfg: Need to parse mfg data
[00:00:01.098,853] <inf> sid_mfg_parser_v8: MFG_ED25519 import success
[00:00:01.101,607] <inf> sid_mfg_parser_v8: MFG_SECP_256R1 import success
[00:00:01.109,493] <inf> sid_mfg: Successfully parsed mfg data

When Sidewalk sample starts, **LED 4** turns on.

Expand Down Expand Up @@ -202,18 +204,20 @@ To start Sidewalk, do the following:

.. code-block:: console

*** Booting nRF Connect SDK 883c3709f9c8 ***
----------------------------------------------------------------
sidewalk v2.5.0-3-g1232aabb
nrf v2.5.0-g271e80422
zephyr 883c3709f9
*** Booting Sidewalk v2.7.99-ae200c29600e ***
*** Using nRF Connect SDK v2.8.99-152acb8205de ***
*** Using Zephyr OS v3.7.99-08f1c5bc9f20 ***
----------------------------------------------------------------
sidewalk_fork_point = af5d608303eb03465f35e369ef22ad6c02564ac6
build time = 2023-03-14 15:00:00.000000+00:00
board = nrf52840dk
Sidewalk SDK = 1.17.1.18
APP_BUILD_VERSION = ae200c29600e
APP_NAME = sidewalk
build time = Oct 30 2024 15:07:09
board = nrf54l15dk/nrf54l15/cpuapp
----------------------------------------------------------------
[00:00:00.001,373] <inf> application_state: working = true
[00:00:00.055,480] <inf> sidewalk_app: Sidewalk link switch to BLE
[00:00:01.095,637] <inf> sid_mfg: Need to parse mfg data
[00:00:01.098,853] <inf> sid_mfg_parser_v8: MFG_ED25519 import success
[00:00:01.101,607] <inf> sid_mfg_parser_v8: MFG_SECP_256R1 import success
[00:00:01.109,493] <inf> sid_mfg: Successfully parsed mfg data

When Sidewalk sample starts, **LED 3** turns on.

Expand Down
22 changes: 12 additions & 10 deletions doc/samples/variants/sensor_monitoring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,17 +116,19 @@ You should see the following output:

.. code-block:: console

*** Booting nRF Connect SDK 883c3709f9c8 ***
*** Booting Sidewalk v2.7.99-ae200c29600e ***
*** Using nRF Connect SDK v2.8.99-152acb8205de ***
*** Using Zephyr OS v3.7.99-08f1c5bc9f20 ***
----------------------------------------------------------------
sidewalk v2.5.0-3-g1232aabb
nrf v2.5.0-g271e80422
zephyr 883c3709f9
Sidewalk SDK = 1.17.1.18
APP_BUILD_VERSION = ae200c29600e
APP_NAME = sidewalk
build time = Oct 30 2024 15:07:09
board = nrf54l15dk/nrf54l15/cpuapp
----------------------------------------------------------------
sidewalk_fork_point = af5d608303eb03465f35e369ef22ad6c02564ac6
build time = 2023-03-14 15:00:00.000000+00:00
board = nrf52840dk
----------------------------------------------------------------
[00:00:00.001,373] <inf> application_state: working = true
[00:00:00.055,480] <inf> sidewalk_app: Sidewalk link switch to BLE
[00:00:01.095,637] <inf> sid_mfg: Need to parse mfg data
[00:00:01.098,853] <inf> sid_mfg_parser_v8: MFG_ED25519 import success
[00:00:01.101,607] <inf> sid_mfg_parser_v8: MFG_SECP_256R1 import success
[00:00:01.109,493] <inf> sid_mfg: Successfully parsed mfg data

.. include:: ../../includes/include_testing_nordic_dfu.txt
16 changes: 9 additions & 7 deletions doc/setting_up_sidewalk_environment/setting_up_sidewalk_prototype.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The tools required for provisioning are located in the repository (`sdk-nrf`_ an

.. note::
The default name of the :file:`mfg.hex` file generated from the :file:`provision.py` script is :file:`nordic_aws_nrf52840.hex`.
It is, however, compatible with other supported boards.
The ``--output_hex`` parameter is used to specify a custom name for the :file:`mfg.hex` file.

#. Flash the generated :file:`nordic_aws_nrf52840.hex` file with the provisioning data:

Expand Down Expand Up @@ -86,20 +86,22 @@ The tools required for provisioning are located in the repository (`sdk-nrf`_ an
--wireless_device_json wireless_device.json
--device_profile_json device_profile.json
--addr 0x17c000
--output_hex nordic_aws_nrf54l15.hex

.. note::
The default name of the :file:`mfg.hex` file generated from the :file:`provision.py` script is :file:`nordic_aws_nrf52840.hex`.
It is, however, compatible with other supported boards.
The ``--output_hex`` parameter is used 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:`nordic_aws_nrf52840.hex` file with the provisioning data:
#. Flash the generated file with the provisioning data:

.. code-block:: console

nrfjprog --sectorerase --program nordic_aws_nrf52840.hex --reset
nrfutil device program --x-family nrf54l --options chip_erase_mode=ERASE_RANGES_TOUCHED_BY_FIRMWARE,reset=RESET_PIN,verify=VERIFY_READ --traits jlink --firmware nordic_aws_nrf54l15.hex

* If you reflashed the :file:`nordic_aws_nrf52840.hex` file on an already working device, you need to deregister the previously flashed device.
* If you reflashed the :file:`nordic_aws_nrf54l15.hex` file on an already working device, you need to deregister the previously flashed device.
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_nrf52840.hex`) in the Sidewalk network.
This will allow you to register a new product (new :file:`nordic_aws_nrf54l15.hex`) in the Sidewalk network.

Add MQTT to destination
***********************
Expand Down
Loading