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.

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: zigbee: add known issue NCSIDB-1411 #19688

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
27 changes: 27 additions & 0 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1222,6 +1222,33 @@ Zigbee

The issues in this section are related to the :ref:`ug_zigbee` protocol.

.. rst-class:: v2-9-0 v2-8-0 v2-7-0 v2-6-2 v2-6-1 v2-6-0 v2-5-3 v2-5-2 v2-5-1 v2-5-0 v2-4-4 v2-4-3 v2-4-2 v2-4-1 v2-4-0 v2-3-0 v2-2-0 v2-1-4 v2-1-3 v2-1-2 v2-1-1 v2-1-0 v2-0-2 v2-0-1 v2-0-0 v1-9-2 v1-9-1 v1-9-0

NCSIDB-1411: Clearing config data in response to the Leave Network command is not fully performed
Configuration data of ZCL Reporting feature is not cleared when processing the "Leave Network" command, which means that compliance with the specification is incomplete.
Comment on lines +1227 to +1228
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
NCSIDB-1411: Clearing config data in response to the Leave Network command is not fully performed
Configuration data of ZCL Reporting feature is not cleared when processing the "Leave Network" command, which means that compliance with the specification is incomplete.
NCSIDB-1411: Clearing configuration data is not fully performed when processing the leave network command
Configuration data of ZCL Reporting feature is not cleared when processing the leave network command, resulting in incomplete compliance with the specification.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposal to update @annwoj suggestion with Leave Network command by starting the name with capital letter

Suggested change
NCSIDB-1411: Clearing config data in response to the Leave Network command is not fully performed
Configuration data of ZCL Reporting feature is not cleared when processing the "Leave Network" command, which means that compliance with the specification is incomplete.
NCSIDB-1411: Clearing configuration data is not fully performed when processing the Leave Network command
Configuration data of ZCL Reporting feature is not cleared when processing the leave network command, resulting in incomplete compliance with the specification.

@annwoj please comment.

Copy link
Contributor

@peknis peknis Dec 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have he command name highlighted (in double backticks)? Or is it a name or just description?


The Zigbee BDB 3.0 Specification, section 9.4 says that all Zigbee persistent data (with exceptions ..) must be cleared in response to the Mgmt_Leave_req command, however the stack leaves the ZCL Reporting parameter values ​​set (cached in memory) and continues to use them.

**Workaround:** You can supplement the processing of the "Leave Network" command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Workaround:** You can supplement the processing of the "Leave Network" command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler.
**Workaround:** You can supplement the processing of the leave network command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same proposal as above - Leave Network command by starting the name with capital letter

Suggested change
**Workaround:** You can supplement the processing of the "Leave Network" command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler.
**Workaround:** You can supplement the processing of the Leave Network command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler.

@annwoj please comment

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with that approach

See the following snippet for an example:

.. code-block:: c

case ZB_ZDO_SIGNAL_LEAVE:
/* Device leaves the network. */
if (status == RET_OK) {
zb_zdo_signal_leave_params_t *leave_params =
ZB_ZDO_SIGNAL_GET_PARAMS(sig_hndler, zb_zdo_signal_leave_params_t);

if (leave_params->leave_type == ZB_NWK_LEAVE_TYPE_RESET) {
/* Workaround for NCSIDB-1411 - clearing ZCL Reporting parameters. */
zb_zcl_init_reporting_info();
}
}
/* Call default signal handler. */
ZB_ERROR_CHECK(zigbee_default_signal_handler(bufid));
break;

.. rst-class:: v2-9-0-nRF54H20-rc1 v2-9-0 v2-8-0 v2-7-0 v2-6-2 v2-6-1 v2-6-0 v2-5-3 v2-5-2 v2-5-1 v2-5-0 v2-4-4 v2-4-3 v2-4-2 v2-4-1 v2-4-0 v2-3-0 v2-2-0 v2-1-4 v2-1-3 v2-1-2 v2-1-1 v2-1-0 v2-0-2 v2-0-1 v2-0-0 v1-9-2 v1-9-1 v1-9-0

NCSIDB-1336: Zigbee Router device cannot rejoin after missing Network Key update or rotation
Expand Down
Loading