Skip to content

Commit

Permalink
doc: update samples memory requirements
Browse files Browse the repository at this point in the history 
[KRKNWK-17832]
Update samples for v1.14.5 (ncs v2.5.0) release
Fix board link in script.
Move memory unit information before tabs.

Signed-off-by: Krzysztof Taborowski <[email protected]>
  • Loading branch information
@ktaborowski
ktaborowski committed Oct 26, 2023
1 parent a45eb05 commit 1254ba9
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 25 deletions.
43 changes: 20 additions & 23 deletions doc/setting_up_sidewalk_environment/requirements.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,64 +51,61 @@ RAM and flash memory requirements

RAM and flash memory requirement values differ depending on the DK and programmed sample.

All values are provided in kilobytes (KB).

.. tabs::

.. tab:: nRF52840 DK

The following table lists memory requirements for samples running on the `nRF52840 DK`_.

All values are provided in kilobytes (KB).

+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| Sample | MCUboot ROM | Application ROM | Sidewalk Settings | Total ROM | Total RAM |
+===================================================================+===============+===================+=====================+=============+=============+
| :ref:`Sensor monitoring <sensor_monitoring>` (Bluetooth LE Debug) | 0 | 382 | 32 | 414 | 78 |
| :ref:`Sensor monitoring <sensor_monitoring>` (Bluetooth LE Debug) | 0 | 371 | 32 | 403 | 78 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Sensor monitoring <sensor_monitoring>` (FSK Debug) | 0 | 520 | 32 | 552 | 99 |
| :ref:`Sensor monitoring <sensor_monitoring>` (FSK Debug) | 0 | 530 | 32 | 562 | 99 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Sensor monitoring <sensor_monitoring>` (LoRa Debug) | 0 | 480 | 32 | 512 | 98 |
| :ref:`Sensor monitoring <sensor_monitoring>` (LoRa Debug) | 0 | 470 | 32 | 502 | 98 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (FSK Debug) | 36 | 532 | 28 | 596 | 109 |
| :ref:`Template sub-GHz <template_subghz>` (FSK Debug) | 36 | 547 | 28 | 611 | 109 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (FSK Release) | 36 | 468 | 28 | 532 | 105 |
| :ref:`Template sub-GHz <template_subghz>` (FSK Release) | 36 | 479 | 28 | 543 | 105 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (LoRa Debug) | 36 | 494 | 28 | 558 | 108 |
| :ref:`Template sub-GHz <template_subghz>` (LoRa Debug) | 36 | 488 | 28 | 552 | 108 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (LoRa Release) | 36 | 422 | 28 | 486 | 104 |
| :ref:`Template sub-GHz <template_subghz>` (LoRa Release) | 36 | 413 | 28 | 477 | 104 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template Bluetooth LE <template_ble>` (Debug) | 36 | 395 | 28 | 459 | 90 |
| :ref:`Template Bluetooth LE <template_ble>` (Debug) | 36 | 384 | 28 | 448 | 90 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template Bluetooth LE <template_ble>` (Release) | 36 | 329 | 28 | 393 | 86 |
| :ref:`Template Bluetooth LE <template_ble>` (Release) | 36 | 314 | 28 | 378 | 86 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+

.. tab:: nRF5340 DK

The following table lists memory requirements for samples running on the `nRF5340 DK`_.

All values are provided in kilobytes (KB).

+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| Sample | MCUboot ROM | Application ROM | Sidewalk Settings | Total ROM | Total RAM |
+===================================================================+===============+===================+=====================+=============+=============+
| :ref:`Sensor monitoring <sensor_monitoring>` (Bluetooth LE Debug) | 0 | 325 | 32 | 357 | 68 |
| :ref:`Sensor monitoring <sensor_monitoring>` (Bluetooth LE Debug) | 0 | 314 | 32 | 346 | 68 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Sensor monitoring <sensor_monitoring>` (FSK Debug) | 0 | 457 | 32 | 489 | 89 |
| :ref:`Sensor monitoring <sensor_monitoring>` (FSK Debug) | 0 | 463 | 32 | 495 | 89 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Sensor monitoring <sensor_monitoring>` (LoRa Debug) | 0 | 420 | 32 | 452 | 88 |
| :ref:`Sensor monitoring <sensor_monitoring>` (LoRa Debug) | 0 | 411 | 32 | 443 | 88 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (FSK Debug) | 56 | 469 | 28 | 553 | 99 |
| :ref:`Template sub-GHz <template_subghz>` (FSK Debug) | 40 | 479 | 28 | 547 | 99 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (FSK Release) | 56 | 404 | 28 | 488 | 95 |
| :ref:`Template sub-GHz <template_subghz>` (FSK Release) | 40 | 410 | 28 | 478 | 95 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (LoRa Debug) | 56 | 434 | 28 | 518 | 98 |
| :ref:`Template sub-GHz <template_subghz>` (LoRa Debug) | 40 | 428 | 28 | 496 | 98 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template sub-GHz <template_subghz>` (LoRa Release) | 56 | 361 | 28 | 445 | 94 |
| :ref:`Template sub-GHz <template_subghz>` (LoRa Release) | 40 | 352 | 28 | 420 | 94 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template Bluetooth LE <template_ble>` (Debug) | 56 | 339 | 28 | 423 | 81 |
| :ref:`Template Bluetooth LE <template_ble>` (Debug) | 40 | 333 | 28 | 401 | 81 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+
| :ref:`Template Bluetooth LE <template_ble>` (Release) | 56 | 270 | 28 | 354 | 77 |
| :ref:`Template Bluetooth LE <template_ble>` (Release) | 40 | 260 | 28 | 328 | 77 |
+-------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+

.. include:: ../ncs_links.rst

.. _Amazon developer account: https://developer.amazon.com/dashboard
Expand Down
4 changes: 2 additions & 2 deletions scripts/ci/memory_requirements.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ def full_title(self) -> str:


BOARDS = {
'nrf52840dk_nrf52840': ':ref:`nRF52840 DK <zephyr:nrf52840dk_nrf52840>`',
'nrf5340dk_nrf5340_cpuapp': ':ref:`nRF5340 DK <zephyr:nrf5340dk_nrf5340_cpuapp>`',
'nrf52840dk_nrf52840': '`nRF52840 DK`_',
'nrf5340dk_nrf5340_cpuapp': '`nRF5340 DK`_',
}


Expand Down

0 comments on commit 1254ba9

Please sign in to comment.