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: Add nRF54L15 to documentation #545

Merged
merged 4 commits into from
Apr 18, 2024
Merged

doc: Add nRF54L15 to documentation #545

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
07aadaf
doc: Add nRF54L15 PDK
totyz Apr 15, 2024
9ad5f4d
doc: remove support for plantuml from build script
totyz Apr 15, 2024
de4c031
doc: Remove memory_requirements.py script
totyz Apr 15, 2024
6d91cb2
doc: Move memory requirement section
totyz Apr 17, 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
3 changes: 0 additions & 3 deletions doc/build_doc_in_docker.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,7 @@ if [ $# -eq 0 ]; then
docker run -it --rm -e USER_ID=$(id -u) -e GRP_ID=$(id -g) -v "$(pwd)":/work -v "$(pwd)"/build_doc_in_docker.sh:/run.sh "${DOCKER}" /run.sh "RUN_IN_DOCKER"
echo "Docker exited"
elif [ $# -eq 1 ]; then
apt update
apt install default-jre graphviz -y
cd /work
curl -sSL https://github.com/plantuml/plantuml/releases/download/v1.2023.13/plantuml-1.2023.13.jar --output /usr/local/bin/plantuml.jar
pip install -r requirements-doc.txt
sphinx-build -M html . build
chown -R $USER_ID:$GRP_ID build
Expand Down
3 changes: 3 additions & 0 deletions doc/ncs_links.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@
.. _nrf52840 DK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr
.. _nrf5340 DK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr
.. _Thingy53: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr
.. _nRF54L15 PDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr
.. _Getting started with nRF52 Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/device_guides/working_with_nrf/nrf52/gs.html
.. _Getting started with nRF53 Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/device_guides/nrf53.html
.. _Getting started with nRF54L Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/device_guides/nrf54l.html
.. _Zephyr toolchain: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/gs_installing.html#install-a-toolchain
.. _nRF Connect SDK Getting started: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/getting_started.html
.. _nRF52840dk_nrf52840: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf52840dk_nrf52840/doc/index.html
.. _nrf5340dk_nrf5340: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf5340dk_nrf5340/doc/index.html#nrf5340dk-nrf5340
.. _thingy53_nrf5340: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/thingy53_nrf5340/doc/index.html#thingy53-nrf5340
.. _nrf54l15pdk_nrf54l15: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf54l15pdk_nrf54l15/doc/index.html
.. _Building and programming an application: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/getting_started/programming.html#gs-programming
.. _Testing and debugging an application: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/getting_started/testing.html#gs-testing
.. _Bootloader and DFU solutions for NCS: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/app_bootloaders.html
Expand Down
3 changes: 3 additions & 0 deletions doc/ncs_links_update.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,16 @@ links=( ".. _nRF Connect SDK: https://developer.nordicsemi.com/nRF_Connect_SDK/d
".. _nrf52840 DK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr"
".. _nrf5340 DK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr"
".. _Thingy53: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr"
".. _nRF54L15 PDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr"
".. _Getting started with nRF52 Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/device_guides/working_with_nrf/nrf52/gs.html"
".. _Getting started with nRF53 Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/device_guides/nrf53.html"
".. _Getting started with nRF54L Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/device_guides/nrf54l.html"
".. _Zephyr toolchain: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/gs_installing.html#install-a-toolchain"
".. _nRF Connect SDK Getting started: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/getting_started.html"
".. _nRF52840dk_nrf52840: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/zephyr/boards/arm/nrf52840dk_nrf52840/doc/index.html"
".. _nrf5340dk_nrf5340: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/zephyr/boards/arm/nrf5340dk_nrf5340/doc/index.html#nrf5340dk-nrf5340"
".. _thingy53_nrf5340: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/zephyr/boards/arm/thingy53_nrf5340/doc/index.html#thingy53-nrf5340"
".. _nrf54l15pdk_nrf54l15: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/zephyr/boards/arm/nrf54l15pdk_nrf54l15/doc/index.html"
".. _Building and programming an application: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/getting_started/programming.html#gs-programming"
".. _Testing and debugging an application: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/getting_started/testing.html#gs-testing"
".. _Bootloader and DFU solutions for NCS: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/<NCS_TAG>/nrf/app_bootloaders.html"
Expand Down
31 changes: 18 additions & 13 deletions doc/samples/samples_list.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,24 @@ In the Sidewalk repository, all samples are placed in the :file:`samples` direct
The current sample structure includes the :ref:`sidewalk_end_device` sample with available variants.
The following table demonstrates the variants' configuration for the supported development kits:

+-----------------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+
| Sample variant | Description | Development kit | Additional hardware | Bootloader (in release and debug configs) | Application overlays |
+===================================+==========================================+=============================+==========================================================================+===============================================+===============================+
| :ref:`variant_sidewalk_hello` | Sample application showing communication | * `nRF52840 DK`_ | * External flash (included in the DK) | * 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 | |
+-----------------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+
| :ref:`variant_sensor_monitoring` | Demo application of Sidewalk protocol | * `nRF52840 DK`_ | * External flash (included in the DK) | * 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`_ | | | |
+-----------------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+
| :ref:`variant_sidewalk_dut` | Device under test generic application | * `nRF52840 DK`_ | * External flash (included in the DK) | * 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 | |
+-----------------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+
+-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| Sample variant | Description | Development kit | Additional hardware | Bootloader (in release and debug configs) | Application overlays |
+===================================+==========================================+================================+===========================================================================+===============================================+===========================+
| :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`_ ``*`` | | | |
+-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| :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`_ ``*`` | | | |
+-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
| :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`_ does not support LoRa and FSK configurations.

.. note::

Expand Down
22 changes: 13 additions & 9 deletions doc/samples/sid_end_device.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,19 @@ Requirements

This sample supports the following development kits:

+--------------------+----------+------------------------+------------------------------+
| Hardware platforms | PCA | Board name | Build target |
+====================+==========+========================+==============================+
| nRF52840 DK | PCA10056 | `nrf52840dk_nrf52840`_ | ``nrf52840dk_nrf52840`` |
+--------------------+----------+------------------------+------------------------------+
| nRF5340 DK | PCA10095 | `nrf5340dk_nrf5340`_ | ``nrf5340dk_nrf5340_cpuapp`` |
+--------------------+----------+------------------------+------------------------------+
| Thingy53 | PCA20053 | `thingy53_nrf5340`_ | ``thingy53_nrf5340_cpuapp`` |
+--------------------+----------+------------------------+------------------------------+
+--------------------+----------+----------------------------+----------------------------------+
| Hardware platforms | PCA | Board name | Build target |
+====================+==========+============================+==================================+
| nRF52840 DK | PCA10056 | `nrf52840dk_nrf52840`_ | ``nrf52840dk_nrf52840`` |
+--------------------+----------+----------------------------+----------------------------------+
| nRF5340 DK | PCA10095 | `nrf5340dk_nrf5340`_ | ``nrf5340dk_nrf5340_cpuapp`` |
+--------------------+----------+----------------------------+----------------------------------+
| Thingy53 | PCA20053 | `thingy53_nrf5340`_ | ``thingy53_nrf5340_cpuapp`` |
+--------------------+----------+----------------------------+----------------------------------+
| nRF54L15 PDK ``*`` | PCA10156 | `nrf54l15pdk_nrf54l15`_ | ``nrf54l15pdk_nrf54l15_cpuapp`` |
+--------------------+----------+----------------------------+----------------------------------+

``*`` - `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
Loading
Loading