Skip to content

doc: Zigbee R23 add-on v1.2.0 update #46

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

Merged
edmont merged 2 commits into from
Aug 22, 2025
Merged

doc: Zigbee R23 add-on v1.2.0 update #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8fe2e8
doc: add nRF5340 support
edmont Aug 21, 2025
8411210
doc: Zigbee R23 add-on v1.2.0 update
edmont Aug 21, 2025
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: 0 additions & 24 deletions docs/includes/basic_device_table.txt
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions docs/includes/coprocessor_note.txt
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions docs/includes/device_table_all.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,7 @@
- PCA10056
- `nrf52840dk`_
- ``nrf52840dk/nrf52840``
* - `nRF5340 DK <Developing with nRF53 Series_>`_
- PCA10095
- `nrf5340dk`_
- | ``nrf5340dk/nrf5340/cpuapp``
4 changes: 4 additions & 0 deletions docs/includes/device_table_ncp.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@
- PCA10059
- `nrf52840dongle`_
- ``nrf52840dongle/nrf52840``
* - `nRF5340 DK <Developing with nRF53 Series_>`_
- PCA10095
- `nrf5340dk`_
- | ``nrf5340dk/nrf5340/cpuapp``
4 changes: 4 additions & 0 deletions docs/includes/device_table_shell.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,7 @@
- PCA10059
- `nrf52840dongle`_
- ``nrf52840dongle/nrf52840``
* - `nRF5340 DK <Developing with nRF53 Series_>`_
- PCA10095
- `nrf5340dk`_
- | ``nrf5340dk/nrf5340/cpuapp``
4 changes: 4 additions & 0 deletions docs/includes/device_table_single_multi.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@
- PCA10056
- `nrf52840dk`_
- ``nrf52840dk/nrf52840``
* - `nRF5340 DK <Developing with nRF53 Series_>`_
- PCA10095
- `nrf5340dk`_
- | ``nrf5340dk/nrf5340/cpuapp``
1 change: 0 additions & 1 deletion docs/includes/experimental_note.txt
View file
Open in desktop

This file was deleted.

4 changes: 3 additions & 1 deletion docs/links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
.. _`Programming board names`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/app_dev/board_support/board_names.html#programming-board-names

.. _`Developing with nRF52 Series`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/app_dev/device_guides/nrf52/index.html
.. _`Developing with nRF53 Series`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/app_dev/device_guides/nrf53/index.html
.. _`Developing with nRF54L Series`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/app_dev/device_guides/nrf54l/index.html
.. _`Developing with Front-End Modules`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/app_dev/device_guides/fem/index.html
.. _`Developing with the nRF21540 EK`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/app_dev/device_guides/fem/21540ek_dev_guide.html
Expand Down Expand Up @@ -80,6 +81,7 @@

.. _`nrf52840dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
.. _`nrf52840dongle`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/boards/nordic/nrf52840dongle/doc/index.html#nrf52840dongle-nrf52840
.. _`nrf5340dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
.. _`nrf54l15dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html

.. _`USB DFU (Device Firmware Upgrade)`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/samples/subsys/usb/dfu/README.html
Expand Down Expand Up @@ -137,7 +139,7 @@
.. _`ZBOSS stack release notes`: https://ncsdoc.z6.web.core.windows.net/zboss-r23
.. _`external ZBOSS development guide and API documentation`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.0/zigbee_devguide.html
.. _`Stack commissioning start sequence`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.0/using_zigbee__z_c_l.html#stack_start_initiation
.. _`ZBOSS NCP Host`: https://github.com/nrfconnect/ncs-zigbee/releases/download/v1.1.0/ncp_host_v3.3.0.zip
.. _`ZBOSS NCP Host`: https://github.com/nrfconnect/ncs-zigbee/releases/download/v1.2.0/ncp_host_v3.4.0.zip
.. _`NCP Host documentation`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.0/zboss_ncp_host_intro.html
.. _`Rebuilding the ZBOSS libraries for host`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.0/zboss_ncp_host.html#rebuilding_libs
.. _`process the frame`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.0/using_zigbee__z_c_l.html#process_zcl_cmd
Expand Down
43 changes: 43 additions & 0 deletions docs/memory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,35 @@ Values are provided in kilobytes (KB).
| :ref:`Zigbee shell over USB <zigbee_shell_sample>` | 500 | 4 | 32 | 4 | 540 | 98 | 98 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+

.. group-tab:: nRF5340

The following table lists memory requirements for samples running on the `nRF5340 DK <Board support_>`_ (`nrf5340dk`_).

+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| 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 |
+========================================================================================================================+==========================+===========================+==================================+=============================+=============+==========================+=============+
| :ref:`Network coordinator <zigbee_network_coordinator_sample>` | 360 | 0 | 32 | 4 | 396 | 90 | 90 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Light bulb <zigbee_light_bulb_sample>` | 384 | 0 | 32 | 4 | 420 | 70 | 70 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Light switch <zigbee_light_switch_sample>` | 291 | 0 | 32 | 4 | 327 | 60 | 60 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Light switch <zigbee_light_switch_sample>` with :ref:`lib_zigbee_fota` | 306 | 64 | 32 | 4 | 406 | 74 | 74 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Light switch <zigbee_light_switch_sample>` with :ref:`zigbee_light_switch_sample_nus` | 355 | 0 | 32 | 4 | 391 | 76 | 76 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :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 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`NCP <zigbee_ncp_sample>` | 383 | 0 | 32 | 4 | 419 | 97 | 97 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`NCP with USB transport <zigbee_ncp_sample>` | 401 | 64 | 32 | 4 | 501 | 106 | 106 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Zigbee application template <zigbee_template_sample>` | 359 | 0 | 32 | 4 | 395 | 79 | 79 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Zigbee shell <zigbee_shell_sample>` | 439 | 0 | 32 | 4 | 475 | 96 | 96 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
| :ref:`Zigbee shell over USB <zigbee_shell_sample>` | 457 | 0 | 32 | 4 | 493 | 105 | 105 |
+------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+

Stack memory requirements
*************************
Expand Down Expand Up @@ -208,3 +237,17 @@ Values are provided in bytes (B).
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
| :ref:`Light switch <zigbee_light_switch_sample>` | 728 | 2048 | 2996 | 5120 |
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+

.. group-tab:: nRF5340

The following table lists memory requirements for the `nRF5340 <Developing with nRF53 Series_>`_ device.

+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
| Sample | ``main`` thread stack usage | ``main`` thread stack size | ``zboss`` thread stack usage | ``zboss`` thread stack size |
+================================================================+===============================+==============================+================================+===============================+
| :ref:`Network coordinator <zigbee_network_coordinator_sample>` | 756 | 2048 | 1376 | 5120 |
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
| :ref:`Light bulb <zigbee_light_bulb_sample>` | 756 | 2048 | 1376 | 5120 |
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
| :ref:`Light switch <zigbee_light_switch_sample>` | 760 | 2048 | 1376 | 5120 |
+----------------------------------------------------------------+-------------------------------+------------------------------+--------------------------------+-------------------------------+
4 changes: 2 additions & 2 deletions docs/quick-start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ To program the samples, complete the following steps:

.. rst-class:: numbered-step

.. group-tab:: nRF52840 DK
.. group-tab:: nRF52840 and nRF5340 DKs

.. include:: includes/vsc_build_and_run.txt

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

.. group-tab:: nRF52840 DK
.. group-tab:: nRF52840 and nRF5340 DKs

1. Press **Button 2** once on the development kit programmed with the light switch sample to turn off the light bulb's **LED 4**.
#. Press **Button 1** once on the development kit programmed with the light switch sample to turn on the light bulb's **LED 4**.
Expand Down
14 changes: 14 additions & 0 deletions docs/release-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ For a full list of |addon| releases, related |NCS| and ZBOSS stack and NCP host
+-------------------+------------------+-----------------------+---------------------+
| |addon| version | |NCS| version | ZBOSS stack version | NCP host version |
+===================+==================+=======================+=====================+
| 1.2.0 | 2.9.0 | 4.2.2.0 | 3.4.0 |
+-------------------+------------------+-----------------------+---------------------+
| 1.1.0 | 2.9.0 | 4.2.2.0 | 3.3.0 |
+-------------------+------------------+-----------------------+---------------------+
| 1.0.0 | 2.9.0 | 4.2.0.0 | 3.2.0 |
Expand All @@ -33,6 +35,18 @@ For a full list of |addon| releases, related |NCS| and ZBOSS stack and NCP host

.. _zigbee_release:

|addon| v1.2.0 - 21/08/2025
***************************

The following release is `supported <Software maturity levels_>`_.

* Added:

* Support for the nRF5340 SoC.
* The ZBOSS NCP Host package v3.4.0.

* Updated the documentation to reflect the changes.

|addon| v1.1.0 - 08/08/2025
***************************

Expand Down
2 changes: 1 addition & 1 deletion docs/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Follow the `Installing the nRF Connect SDK`_ instructions, with the following ex

.. code-block:: console

west init -m "http://github.com/nrfconnect/ncs-zigbee" --mr v1.1.0
west init -m "http://github.com/nrfconnect/ncs-zigbee" --mr v1.2.0


To create an application, use :ref:`zigbee_template_sample` sample as a starting point.
4 changes: 2 additions & 2 deletions docs/shortcuts.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. ### Versions

.. |addon_version| replace:: 1.1.0
.. |addon_version| replace:: 1.2.0
.. |ncs_version| replace:: 2.9.0
.. |zigbee_version| replace:: Zigbee 3.0
.. |zboss_version| replace:: 4.2.2.0
Expand Down Expand Up @@ -32,7 +32,7 @@

.. ### Zigbee & ZBOSS shortcuts

.. |zigbee_ncp_package_version| replace:: 3.3.0
.. |zigbee_ncp_package_version| replace:: 3.4.0
.. |zigbee_description| replace:: Zigbee is a portable, low-power software networking protocol that provides connectivity over an 802.15.4-based mesh network.
.. |enable_zigbee_before_testing| replace:: Make sure to configure the Zigbee stack before building and testing this sample.
See :ref:`ug_zigbee_configuring` for more information.
Expand Down
4 changes: 2 additions & 2 deletions samples/light_bulb/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ User interface
* If pressed for five seconds, it initiates the `factory reset of the device <Resetting to factory defaults_>`_.
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`.
Releasing the button within this time does not trigger the factory reset procedure.
.. group-tab:: nRF52840 DK
.. group-tab:: nRF52840 and nRF5340 DKs

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

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

.. group-tab:: nRF52840 DK
.. group-tab:: nRF52840 and nRF5340 DKs

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

Expand Down
Loading