Skip to content

Commit 901e672

Browse files
edmontedmont
committed
doc: add nRF5340 support
Udpdate documentation with nRF5340 support and memory requirements. Signed-off-by: Eduardo Montoya <eduardo.montoya@nordicsemi.no>
1 parent a58e375 commit 901e672

15 files changed

Lines changed: 82 additions & 54 deletions

‎docs/includes/basic_device_table.txt‎

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

‎docs/includes/coprocessor_note.txt‎

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

‎docs/includes/device_table_all.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@
2222
- PCA10056
2323
- `nrf52840dk`_
2424
- ``nrf52840dk/nrf52840``
25+
* - `nRF5340 DK <Developing with nRF53 Series_>`_
26+
- PCA10095
27+
- `nrf5340dk`_
28+
- | ``nrf5340dk/nrf5340/cpuapp``

‎docs/includes/device_table_ncp.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,7 @@
2626
- PCA10059
2727
- `nrf52840dongle`_
2828
- ``nrf52840dongle/nrf52840``
29+
* - `nRF5340 DK <Developing with nRF53 Series_>`_
30+
- PCA10095
31+
- `nrf5340dk`_
32+
- | ``nrf5340dk/nrf5340/cpuapp``

‎docs/includes/device_table_shell.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@
2222
- PCA10059
2323
- `nrf52840dongle`_
2424
- ``nrf52840dongle/nrf52840``
25+
* - `nRF5340 DK <Developing with nRF53 Series_>`_
26+
- PCA10095
27+
- `nrf5340dk`_
28+
- | ``nrf5340dk/nrf5340/cpuapp``

‎docs/includes/device_table_single_multi.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@
1818
- PCA10056
1919
- `nrf52840dk`_
2020
- ``nrf52840dk/nrf52840``
21+
* - `nRF5340 DK <Developing with nRF53 Series_>`_
22+
- PCA10095
23+
- `nrf5340dk`_
24+
- | ``nrf5340dk/nrf5340/cpuapp``

‎docs/includes/experimental_note.txt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/memory.rst‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,35 @@ Values are provided in kilobytes (KB).
167167
| :ref:`Zigbee shell over USB <zigbee_shell_sample>` | 500 | 4 | 32 | 4 | 540 | 98 | 98 |
168168
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
169169

170+
.. group-tab:: nRF5340
171+
172+
The following table lists memory requirements for samples running on the `nRF5340 DK <Board support_>`_ (`nrf5340dk`_).
173+
174+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
175+
| Sample | ROM, ZBOSS stack + App | ROM, MCUboot bootloader | ROM, ZBOSS non-volatile memory | ROM, ZBOSS product config | Total ROM | RAM, ZBOSS stack + App | Total RAM |
176+
+========================================================================================================================+==========================+===========================+==================================+=============================+=============+==========================+=============+
177+
| :ref:`Network coordinator <zigbee_network_coordinator_sample>` | 360 | 0 | 32 | 4 | 396 | 90 | 90 |
178+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
179+
| :ref:`Light bulb <zigbee_light_bulb_sample>` | 384 | 0 | 32 | 4 | 420 | 70 | 70 |
180+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
181+
| :ref:`Light switch <zigbee_light_switch_sample>` | 291 | 0 | 32 | 4 | 327 | 60 | 60 |
182+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
183+
| :ref:`Light switch <zigbee_light_switch_sample>` with :ref:`lib_zigbee_fota` | 306 | 64 | 32 | 4 | 406 | 74 | 74 |
184+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
185+
| :ref:`Light switch <zigbee_light_switch_sample>` with :ref:`zigbee_light_switch_sample_nus` | 355 | 0 | 32 | 4 | 391 | 76 | 76 |
186+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
187+
| :ref:`Light switch <zigbee_light_switch_sample>` with :ref:`zigbee_light_switch_sample_nus` and :ref:`lib_zigbee_fota` | n/a | n/a | n/a | n/a | n/a | n/a | n/a |
188+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
189+
| :ref:`NCP <zigbee_ncp_sample>` | 383 | 0 | 32 | 4 | 419 | 97 | 97 |
190+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
191+
| :ref:`NCP with USB transport <zigbee_ncp_sample>` | 401 | 64 | 32 | 4 | 501 | 106 | 106 |
192+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
193+
| :ref:`Zigbee application template <zigbee_template_sample>` | 359 | 0 | 32 | 4 | 395 | 79 | 79 |
194+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
195+
| :ref:`Zigbee shell <zigbee_shell_sample>` | 439 | 0 | 32 | 4 | 475 | 96 | 96 |
196+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
197+
| :ref:`Zigbee shell over USB <zigbee_shell_sample>` | 457 | 0 | 32 | 4 | 493 | 105 | 105 |
198+
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
170199

171200
Stack memory requirements
172201
*************************
@@ -208,3 +237,17 @@ Values are provided in bytes (B).
208237
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
209238
| :ref:`Light switch <zigbee_light_switch_sample>` | 728 | 2048 | 2996 | 5120 |
210239
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
240+
241+
.. group-tab:: nRF5340
242+
243+
The following table lists memory requirements for the `nRF5340 <Developing with nRF53 Series_>`_ device.
244+
245+
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
246+
| Sample | ``main`` thread stack usage | ``main`` thread stack size | ``zboss`` thread stack usage | ``zboss`` thread stack size |
247+
+================================================================+===============================+==============================+================================+===============================+
248+
| :ref:`Network coordinator <zigbee_network_coordinator_sample>` | 756 | 2048 | 1376 | 5120 |
249+
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
250+
| :ref:`Light bulb <zigbee_light_bulb_sample>` | 756 | 2048 | 1376 | 5120 |
251+
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
252+
| :ref:`Light switch <zigbee_light_switch_sample>` | 760 | 2048 | 1376 | 5120 |
253+
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+

‎docs/quick-start.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ To program the samples, complete the following steps:
8484

8585
.. rst-class:: numbered-step
8686

87-
.. group-tab:: nRF52840 DK
87+
.. group-tab:: nRF52840 and nRF5340 DKs
8888

8989
.. include:: includes/vsc_build_and_run.txt
9090

@@ -141,7 +141,7 @@ After forming the Zigbee network, test the interaction between the devices.
141141
#. Press and hold **Button 1** on the development kit programmed with the light switch sample to decrease the light bulb's **LED 1** brightness.
142142
#. Press and hold **Button 0** on the development kit programmed with the light switch sample to increase the light bulb's **LED 1** brightness.
143143

144-
.. group-tab:: nRF52840 DK
144+
.. group-tab:: nRF52840 and nRF5340 DKs
145145

146146
1. Press **Button 2** once on the development kit programmed with the light switch sample to turn off the light bulb's **LED 4**.
147147
#. Press **Button 1** once on the development kit programmed with the light switch sample to turn on the light bulb's **LED 4**.

‎samples/light_bulb/README.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ User interface
6868
* If pressed for five seconds, it initiates the `factory reset of the device <Resetting to factory defaults_>`_.
6969
The length of the button press can be edited using the ``CONFIG_FACTORY_RESET_PRESS_TIME_SECONDS`` Kconfig option from :ref:`lib_zigbee_application_utilities`.
7070
Releasing the button within this time does not trigger the factory reset procedure.
71-
.. group-tab:: nRF52840 DK
71+
.. group-tab:: nRF52840 and nRF5340 DKs
7272

7373
LED 1:
7474
Blinks to indicate that the main application thread is running.
@@ -131,7 +131,7 @@ After programming the sample to your development kits, complete the following st
131131

132132
The result of using the buttons is reflected on the light bulb's **LED 1**.
133133

134-
.. group-tab:: nRF52840 DK
134+
.. group-tab:: nRF52840 and nRF5340 DKs
135135

136136
1. Turn on the development kit that runs the Network coordinator sample.
137137

0 commit comments

Comments
 (0)