Skip to content

Commit fa1c34d

Browse files
annwojannwoj
committed
doc: doc adjustments for v2.7.0 release
adjusted the documentation for 2.7.0 ncs release Signed-off-by: Anna Wojdylo <anna.wojdylo@nordicsemi.no>
1 parent eeb119f commit fa1c34d

20 files changed

Lines changed: 606 additions & 394 deletions

‎doc/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
plantuml = 'java -jar /usr/local/bin/plantuml.jar'
6161

6262
rst_epilog = """
63-
.. include:: /ncs_links.rst
63+
.. include:: /links.rst
6464
"""

‎doc/includes/include_testing_nordic_dfu.txt‎

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,40 @@
1-
Testing Device Firmware Update (DFU)
2-
------------------------------------
1+
Testing Device Firmware Update
2+
------------------------------
33

4-
#. To enter the DFU mode, long press **Button 1** on your development kit.
5-
This action sets the device in the DFU mode, in which only the `Zephyr SMP Server`_ is running and Sidewalk is not operational.
6-
When the application is in the DFU mode, all LEDs flash every 500 ms to signal that the application is waiting for a new image.
4+
Complete the following steps to test the Device Firmware Update (DFU) on your device:
75

8-
#. To perform a firmware update, follow the Bluetooth testing steps from the `DevZone DFU guide`_.
9-
When the update starts, the LEDs change the pattern to indicate upload in progress.
6+
.. tabs::
107

11-
#. To exit the DFU mode, long press **Button 1** again when device is in DFU mode.
12-
The device will set the device in the Sidewalk mode.
13-
If the update completes successfully, the device will start a new image.
14-
After using the DFU mode, the first bootup might take up to 60 seconds.
15-
During the image swap the application is silent, meaning that LEDs are not blinking and the console does not output any logs.
16-
The application, however, is running, so do not reset the device.
17-
In case the update fails, the old image is started instead.
8+
.. group-tab:: nRF52 and nRF53 DKs
189

19-
.. include:: ../../ncs_links.rst
10+
#. Enter the DFU mode by long pressing **Button 1** on your development kit.
11+
This action sets the device in the DFU mode, in which only the `Zephyr SMP Server`_ is running and Sidewalk is not operational.
12+
When the application is in the DFU mode, all LEDs flash every 500 ms to signal that the application is waiting for a new image.
2013

21-
.. _DevZone DFU guide: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/software/posts/ncs-dfu#ble_testing
14+
#. To perform a firmware update, follow the Bluetooth testing steps from the `DevZone DFU guide`_.
15+
When the update starts, the LEDs change the pattern to indicate upload in progress.
16+
17+
#. To exit the DFU mode, long press **Button 1** again when device is in DFU mode.
18+
The device will set the device in the Sidewalk mode.
19+
If the update completes successfully, the device will start a new image.
20+
After using the DFU mode, the first bootup might take up to 60 seconds.
21+
During the image swap the application is silent, meaning that LEDs are not blinking and the console does not output any logs.
22+
The application, however, is running, so do not reset the device.
23+
In case the update fails, the old image is started instead.
24+
25+
.. group-tab:: nRF54 DKs
26+
27+
#. Enter the DFU mode by long pressing **Button 0** on your development kit.
28+
This action sets the device in the DFU mode, in which only the `Zephyr SMP Server`_ is running and Sidewalk is not operational.
29+
When the application is in the DFU mode, all LEDs flash every 500 ms to signal that the application is waiting for a new image.
30+
31+
#. To perform a firmware update, follow the Bluetooth testing steps from the `DevZone DFU guide`_.
32+
When the update starts, the LEDs change the pattern to indicate upload in progress.
33+
34+
#. To exit the DFU mode, long press **Button 0** again when device is in DFU mode.
35+
The device will set the device in the Sidewalk mode.
36+
If the update completes successfully, the device will start a new image.
37+
After using the DFU mode, the first bootup might take up to 60 seconds.
38+
During the image swap the application is silent, meaning that LEDs are not blinking and the console does not output any logs.
39+
The application, however, is running, so do not reset the device.
40+
In case the update fails, the old image is started instead.

‎doc/includes/include_user_interface_common.txt‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎doc/includes/memory_requirement.txt‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. tab:: nRF52840 DK
44

55
The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample running on the `nRF52840 DK`_.
6-
To determine the available space for user extension, it needs to be summarized versus the allocated partition size and its layout.
6+
To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.
77

88
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
99
| Sample | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
@@ -12,15 +12,15 @@
1212
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
1313
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 26.33 | 352.07 | 4 | 8 | 390.40 | 89.66 |
1414
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
15-
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.33 | 496.32 | 4 | 8 | 534.65 | 109.91 |
15+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.33 | 496.32 | 4 | 8 | 534.65 | 109.91 |
1616
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
17-
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.33 | 430.45 | 4 | 8 | 468.78 | 105.04 |
17+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.33 | 430.45 | 4 | 8 | 468.78 | 105.04 |
1818
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
1919

2020
.. tab:: nRF5340 DK
2121

2222
The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample running on the `nRF5340 DK`_.
23-
To determine the available space for user extension, it needs to be summarized versus the allocated partition size and its layout.
23+
To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.
2424

2525
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
2626
| Sample | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
@@ -29,15 +29,15 @@
2929
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
3030
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 30.77 | 291.68 | 4 | 8 | 334.45 | 78.46 |
3131
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
32-
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 30.77 | 435.18 | 4 | 8 | 477.95 | 98.34 |
32+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 30.77 | 435.18 | 4 | 8 | 477.95 | 98.34 |
3333
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
34-
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 30.77 | 367.13 | 4 | 8 | 409.90 | 93.64 |
34+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 30.77 | 367.13 | 4 | 8 | 409.90 | 93.64 |
3535
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
3636

3737
.. tab:: nRF54L15 PDK
3838

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

4242
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
4343
| Sample | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
@@ -46,7 +46,7 @@
4646
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
4747
| :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release) | 26.03 | 285.67 | 4 | 8 | 323.70 | 83.80 |
4848
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
49-
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.03 | 432.32 | 4 | 8 | 470.35 | 103.99 |
49+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug) | 26.03 | 432.32 | 4 | 8 | 470.35 | 103.99 |
5050
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
51-
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.03 | 361.94 | 4 | 8 | 399.97 | 99.17 |
51+
| :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release) | 26.03 | 361.94 | 4 | 8 | 399.97 | 99.17 |
5252
+----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+

‎doc/index.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,5 @@ Browse the content by referring to the following pages:
4343
setting_up_sidewalk_environment/setting_up_environment.rst
4444
samples/samples_list.rst
4545
compatibility_matrix.rst
46-
migration_guide.rst
47-
sidewalk_release_notes.rst
46+
releases_and_migration.rst
4847
additional_resources.rst

0 commit comments

Comments
 (0)