Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ In combination with the |NCS|, the |addon| allows for development of low-power c
memory
configuring
configuring/index
migration
zboss/index
samples/index
lib/index
Expand Down
2 changes: 1 addition & 1 deletion docs/lib/zigbee_fota.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The Zigbee FOTA library has the following limitations:

* The endpoint definition in the library includes the endpoint ID, defined with ``CONFIG_ZIGBEE_FOTA_ENDPOINT``.
When using the Zigbee FOTA library, this endpoint ID cannot be used for other endpoints.
* The Zigbee FOTA upgrades are currently supported on the nRF52840 DK (PCA10056) and nRF54L15 DK (PCA10156).
* The Zigbee FOTA upgrades are currently supported on the nRF52840 DK (PCA10056), nRF5340 DK (PCA10095) and nRF54L15 DK (PCA10156).
* The Zigbee FOTA library does not currently support bootloader upgrades.

API documentation
Expand Down
7 changes: 5 additions & 2 deletions docs/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@
.. _`Registering device context`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/using_zigbee__z_c_l.html#register_zigbee_device
.. _`Support for Zigbee commissioning`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/using_zigbee__z_c_l.html#zcl_zigbee_commissioning
.. _`BDB Commissioning API`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/group__zboss__bdb__api.html
.. _`ZBOSS R23 changelog`: https://ncsdoc.z6.web.core.windows.net/zboss-r23
.. _`ZBOSS Zigbee 2023 (R23) features`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/r23_new_features.html
.. _`Runtime switch of R23 ZBOSS into R22 mode`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/r23_new_features.html#r23_r23_switch
.. _`PANID conflict resolution API`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/r23_new_features.html#r23_panid_conflict
.. _`ZBOSS NVRAM API`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/group__zboss__nvram.html

.. _`ZB_BDB_SIGNAL_FINDING_AND_BINDING_INITIATOR_FINISHED`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/group__zb__comm__signals.html#ga18f5e7ddfefb7d01ef98f696a9694d79
.. _`ZB_ZDO_SIGNAL_PRODUCTION_CONFIG_READY`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/group__zb__comm__signals.html#ga3eb4631c12c345991be2461566c150e9
Expand All @@ -186,8 +191,6 @@
.. _`ZB_BDB_FINDING_N_BINDING`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ad9bcb56a6668b6ba6f37edc73a796b58
.. _`zb_bdb_finding_binding_initiator()`: https://ncsdoc.z6.web.core.windows.net/zboss-r23/4.2.2.3/group__zboss__bdb__comm__fb.html#gae6fd60a050559ef0aa3c3e5ec32bc515

.. _`ZBOSS R23 changelog`: https://ncsdoc.z6.web.core.windows.net/zboss-r23

.. ### Other sources

.. _`dfu-util tool`: http://dfu-util.sourceforge.net/
30 changes: 30 additions & 0 deletions docs/migration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _migration:

Migration guide for R22 to R23 Add-on
#####################################

.. contents::
:local:
:depth: 3

This page describes the changes required to successfully migrate a Zigbee application based on the latest |r22-addon| (v\ |r22_addon_version|) release to |addon| v\ |addon_version|.

.. note::
Updating |r22-addon|-based firmware to |addon|-based firmware through OTA is possible.
For testing purposes, use the :ref:`zigbee_light_switch_sample` with the :ref:`FOTA extension <zigbee_light_switch_activating_variants>`.

Complete the following steps:

1. Read the `ZBOSS Zigbee 2023 (R23) features`_ page about new R23 features.
#. Read the section about changes in PAN ID conflict resolution `PANID conflict resolution API`_.
#. If the application manually adjusts configurable memory settings, note the new :c:macro:`ZB_CONFIG_NWK_DISC_TABLE_SIZE` setting.
#. If the application manually adjusts configurable memory settings, note the new :c:macro:`ZB_CONFIG_ZDO_KEY_NEGOTIATIONS_NUM` setting.
#. If the application operates directly with ZBOSS neighbor table entries (the unusual case), note the changed format of :c:func:`zb_neighbor_tbl_ent_t` and the introduction of the :c:func:`zb_nwk_disc_tbl_ent_t` function.

.. warning::
The NVRAM version has been changed.
Data stored in NVRAM on the device is automatically migrated to the new version on the first ZBOSS startup.
For details on NVRAM dataset types and version definitions, see the `ZBOSS NVRAM API`_ documentation.

When migrating, note that support for new R23 features increases the required memory.
Refer to the :ref:`zigbee_memory` page for examples of memory requirements for different samples.
2 changes: 2 additions & 0 deletions docs/shortcuts.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. ### Versions

.. |r22_addon_version| replace:: 1.0.1
.. |addon_version| replace:: 1.2.1
.. |ncs_version| replace:: 2.9.2
.. |zigbee_version| replace:: Zigbee 3.0
Expand All @@ -8,6 +9,7 @@

.. |NCS| replace:: nRF Connect SDK
.. |addon| replace:: Zigbee R23 add-on
.. |r22-addon| replace:: Zigbee R22 add-on

.. |VSC| replace:: Visual Studio Code
.. |nRFVSC| replace:: nRF Connect for VS Code extension
Expand Down