Logo
Developing with ZBOSS for Zigbee

Modules

 Tc_swap
 

Data Structures

struct  zb_zdo_signal_leave_params_s
 Leave parameters. More...
 
struct  zb_zdo_signal_nlme_status_indication_params_s
 NLME status indication parameters. More...
 
struct  zb_zdo_signal_leave_indication_params_s
 Leave Indication parameters. More...
 
struct  zb_se_signal_service_discovery_bind_params_s
 Service Discovery Bind signal parameters. More...
 
struct  zb_zgp_signal_commissioning_params_s
 ZGP commissioning parameters. More...
 
struct  zb_zgp_signal_approve_comm_params_s
 ZGP approve commissioning parameters. More...
 
struct  zb_zgp_signal_mode_change_params_s
 ZGP mode changed parameters. More...
 
struct  zb_zdo_device_unavailable_params_s
 Device unavailable signal parameters. More...
 
struct  zb_nwk_signal_device_associated_params_s
 Association parameters. More...
 
struct  zb_zdo_signal_device_annce_params_s
 Association parameters. More...
 
struct  zb_bdb_signal_touchlink_nwk_started_params_s
 
struct  zb_bdb_signal_touchlink_nwk_joined_router_s
 
struct  zb_zdo_signal_can_sleep_params_s
 Sleep signal parameters. More...
 
struct  zb_zdo_signal_macsplit_dev_boot_params_s
 MAC-Split device boot parameters. More...
 
struct  zb_zdo_signal_fb_initiator_finished_params_s
 F&B Initiator Finished signal parameters. More...
 
struct  zb_zdo_signal_device_update_params_s
 Device Updated signal parameters. More...
 
struct  zb_zdo_signal_device_ready_for_interview_params_s
 Device Ready For Interview signal parameters. More...
 
struct  zb_zdo_signal_device_authorized_params_s
 Device Authorized signal parameters. More...
 
struct  zb_debug_signal_tclk_ready_params_s
 TCLK Read debug signal parameters. More...
 
struct  zb_zdo_app_signal_hdr_s
 

Macros

#define ZB_ZDO_SIGNAL_GET_PARAMS(sg_p, type)   ((type *)(void *)((((zb_uint8_t *)sg_p) + sizeof(zb_zdo_app_signal_hdr_t))))
 
#define ZB_ZDO_SIGNAL_CUT_HEADER(buf)   zb_buf_cut_left(buf, sizeof(zb_zdo_app_signal_hdr_t))
 Cuts ZBOSS signal headers while keeping the signal parameter (if it was in the buffer). More...
 
#define ZB_HIGH_SEQ_SECURED_REJOIN   4U
 
#define ZB_HIGH_SEQ_UNSECURED_JOIN   5U
 
#define ZB_HIGH_SEQ_UNSECURED_REJOIN   7U
 
#define ZB_GET_APP_SIGNAL_STATUS(param)   zb_buf_get_status(param)
 Get status from the application signal. More...
 

Typedefs

typedef zb_bool_t(* zb_signal_handler_t) (zb_uint8_t param)
 ZBOSS signal handler function. More...
 
typedef zb_uint8_t zb_zdp_status_t
 Type for ZDP status values. More...
 
typedef zb_uint8_t zb_zdo_app_signal_type_t
 Type for signals passed to an application signal handler. More...
 
typedef zb_zdo_app_signal_type_t zb_zdo_app_signal_t
 
typedef struct zb_zdo_signal_leave_params_s zb_zdo_signal_leave_params_t
 Leave parameters. More...
 
typedef struct zb_zdo_signal_nlme_status_indication_params_s zb_zdo_signal_nlme_status_indication_params_t
 NLME status indication parameters. More...
 
typedef struct zb_zdo_signal_leave_indication_params_s zb_zdo_signal_leave_indication_params_t
 Leave Indication parameters. More...
 
typedef struct zb_se_signal_service_discovery_bind_params_s zb_se_signal_service_discovery_bind_params_t
 Service Discovery Bind signal parameters. More...
 
typedef struct zb_zgp_signal_commissioning_params_s zb_zgp_signal_commissioning_params_t
 ZGP commissioning parameters. More...
 
typedef struct zb_zgp_signal_approve_comm_params_s zb_zgp_signal_approve_comm_params_t
 ZGP approve commissioning parameters. More...
 
typedef struct zb_zgp_signal_mode_change_params_s zb_zgp_signal_mode_change_params_t
 ZGP mode changed parameters. More...
 
typedef struct zb_zdo_device_unavailable_params_s zb_zdo_device_unavailable_params_t
 Device unavailable signal parameters. More...
 
typedef struct zb_nwk_signal_device_associated_params_s zb_nwk_signal_device_associated_params_t
 Association parameters. More...
 
typedef struct zb_zdo_signal_device_annce_params_s zb_zdo_signal_device_annce_params_t
 Association parameters. More...
 
typedef struct zb_bdb_signal_touchlink_nwk_started_params_s zb_bdb_signal_touchlink_nwk_started_params_t
 
typedef struct zb_bdb_signal_touchlink_nwk_joined_router_s zb_bdb_signal_touchlink_nwk_joined_router_t
 
typedef struct zb_zdo_signal_can_sleep_params_s zb_zdo_signal_can_sleep_params_t
 Sleep signal parameters. More...
 
typedef struct zb_zdo_signal_macsplit_dev_boot_params_s zb_zdo_signal_macsplit_dev_boot_params_t
 MAC-Split device boot parameters. More...
 
typedef zb_uint8_t zb_zdo_fb_initiator_finished_status_t
 Type for Status codes for F&B Initiator Finished signal. More...
 
typedef struct zb_zdo_signal_fb_initiator_finished_params_s zb_zdo_signal_fb_initiator_finished_params_t
 F&B Initiator Finished signal parameters. More...
 
typedef struct zb_zdo_signal_device_update_params_s zb_zdo_signal_device_update_params_t
 Device Updated signal parameters. More...
 
typedef struct zb_zdo_signal_device_ready_for_interview_params_s zb_zdo_signal_device_ready_for_interview_params_t
 Device Ready For Interview signal parameters. More...
 
typedef zb_uint8_t zb_zdo_authorization_type_t
 Type for Authorization types for ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED. More...
 
typedef zb_uint8_t zb_zdo_legacy_device_authorization_status_t
 Type for Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_LEGACY value of zdo_authorization_type type. More...
 
typedef zb_uint8_t zb_zdo_tclk_authorization_status_t
 Type for Authorization types for ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED. More...
 
typedef struct zb_zdo_signal_device_authorized_params_s zb_zdo_signal_device_authorized_params_t
 Device Authorized signal parameters. More...
 
typedef struct zb_debug_signal_tclk_ready_params_s zb_debug_signal_tclk_ready_params_t
 TCLK Read debug signal parameters. More...
 
typedef struct zb_zdo_app_signal_hdr_s zb_zdo_app_signal_hdr_t
 
typedef zb_zdo_app_signal_hdr_t zb_zdo_app_event_t
 

Functions

void zboss_signal_handler (zb_uint8_t param)
 
zb_bool_t zb_signal_handler_add_back (zb_signal_handler_t handler)
 Add new signal handler to the end of a subscription chain. More...
 
zb_bool_t zb_signal_handler_add_front (zb_signal_handler_t handler)
 Add new signal handler to the beginning of a subscription chain. More...
 
zb_bool_t zb_signal_handler_remove (zb_signal_handler_t handler)
 Remove signal handler from the subscription chain. More...
 
zb_zdo_app_signal_type_t zb_get_app_signal (zb_uint8_t param, zb_zdo_app_signal_hdr_t **sg_p)
 Unpack application signal buffer in zboss_signal_handler() More...
 

ZDP status values

See also
2.4.5 - ZDP Enumeration Description
#define ZB_ZDP_STATUS_SUCCESS   0x00U
 
#define ZB_ZDP_STATUS_INV_REQUESTTYPE   0x80U
 
#define ZB_ZDP_STATUS_DEVICE_NOT_FOUND   0x81U
 
#define ZB_ZDP_STATUS_INVALID_EP   0x82U
 
#define ZB_ZDP_STATUS_NOT_ACTIVE   0x83U
 
#define ZB_ZDP_STATUS_NOT_SUPPORTED   0x84U
 
#define ZB_ZDP_STATUS_TIMEOUT   0x85U
 
#define ZB_ZDP_STATUS_NO_MATCH   0x86U
 
#define ZB_ZDP_STATUS_NO_ENTRY   0x88U
 
#define ZB_ZDP_STATUS_NO_DESCRIPTOR   0x89U
 
#define ZB_ZDP_STATUS_INSUFFICIENT_SPACE   0x8aU
 
#define ZB_ZDP_STATUS_NOT_PERMITTED   0x8bU
 
#define ZB_ZDP_STATUS_TABLE_FULL   0x8cU
 
#define ZB_ZDP_STATUS_NOT_AUTHORIZED   0x8dU
 
#define ZB_ZDP_STATUS_INVALID_INDEX   0x8fU
 
#define ZB_ZDP_STATUS_FRAME_TOO_LARGE   0x90U
 
#define ZB_ZDP_STATUS_BAD_KEY_NEG_METHOD   0x91U
 
#define ZB_ZDP_STATUS_TEMPORARY_FAILURE   0x92U
 
#define ZB_ZDP_STATUS_DEV_ANNCE_SENDING_FAILED   0x0feU
 
#define ZB_ZDP_STATUS_TIMEOUT_BY_STACK   0xffU
 

Signals passed to application signal handler

Note
If an application requires the parameters to be passed to the zboss_signal_handler, it is recommended to introduce the structure according to the pattern below:
typedef struct zb_zdo_app_my_custom_signal_s
{
zb_my_custom_data_type_t my_custom_data;
}
#define ZB_ZDO_SIGNAL_DEFAULT_START   0U
 
#define ZB_ZDO_SIGNAL_SKIP_STARTUP   1U
 
#define ZB_ZDO_SIGNAL_DEVICE_ANNCE   2U
 
#define ZB_ZDO_SIGNAL_LEAVE   3U
 
#define ZB_ZDO_SIGNAL_ERROR   4U
 
#define ZB_BDB_SIGNAL_DEVICE_FIRST_START   5U
 
#define ZB_BDB_SIGNAL_DEVICE_REBOOT   6U
 
#define ZB_SIGNAL_DEVICE_FIRST_START   ZB_BDB_SIGNAL_DEVICE_FIRST_START
 
#define ZB_SIGNAL_DEVICE_REBOOT   ZB_BDB_SIGNAL_DEVICE_REBOOT
 
#define ZB_BDB_SIGNAL_STEERING   10U
 
#define ZB_BDB_SIGNAL_FORMATION   11U
 
#define ZB_BDB_SIGNAL_FINDING_AND_BINDING_TARGET_FINISHED   12U
 
#define ZB_BDB_SIGNAL_FINDING_AND_BINDING_INITIATOR_FINISHED   13U
 
#define ZB_NWK_SIGNAL_DEVICE_ASSOCIATED   18U
 
#define ZB_ZDO_SIGNAL_LEAVE_INDICATION   19U
 
#define ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED   20U
 
#define ZB_ZGP_SIGNAL_COMMISSIONING   21U
 
#define ZB_COMMON_SIGNAL_CAN_SLEEP   22U
 
#define ZB_ZDO_SIGNAL_PRODUCTION_CONFIG_READY   23U
 
#define ZB_NWK_SIGNAL_NO_ACTIVE_LINKS_LEFT   24U
 
#define ZB_SE_SIGNAL_SKIP_JOIN   25U
 
#define ZB_SE_SIGNAL_REJOIN_STARTED   ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED
 
#define ZB_SE_SIGNAL_REJOIN   26U
 
#define ZB_SE_SIGNAL_CHILD_REJOIN   27U
 
#define ZB_SE_TC_SIGNAL_CHILD_JOIN_CBKE   28U
 
#define ZB_SE_TC_SIGNAL_CHILD_JOIN_NON_CBKE   29U
 
#define ZB_SE_SIGNAL_CBKE_FAILED   30U
 
#define ZB_SE_SIGNAL_CBKE_OK   31U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_START   32U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_DO_BIND   33U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_OK   34U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_FAILED   35U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_INDICATION   36U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_OK   37U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_FAILED   38U
 
#define ZB_SE_SIGNAL_APS_KEY_READY   39U
 
#define ZB_SE_SIGNAL_APS_KEY_FAIL   40U
 
#define ZB_SIGNAL_SUBGHZ_SUSPEND   41U
 
#define ZB_SIGNAL_SUBGHZ_RESUME   42U
 
#define ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED   47U
 
#define ZB_ZDO_SIGNAL_DEVICE_UPDATE   48U
 
#define ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW   49U
 
#define ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_STARTED   50U
 
#define ZB_NWK_SIGNAL_PANID_CONFLICT_DETECTED   51U
 
#define ZB_NLME_STATUS_INDICATION   52U
 
#define ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL   53U
 
#define ZB_TC_SWAPPED_SIGNAL   54U
 

Status codes for F&B Initiator Finished signal

#define ZB_ZDO_FB_INITIATOR_STATUS_SUCCESS   0U
 
#define ZB_ZDO_FB_INITIATOR_STATUS_CANCEL   1U
 
#define ZB_ZDO_FB_INITIATOR_STATUS_ALARM   2U
 
#define ZB_ZDO_FB_INITIATOR_STATUS_ERROR   3U
 

Security/rejoin states of the 'status' field of APSME-Update-Device

See also
Table 4.40
#define ZB_STD_SEQ_SECURED_REJOIN   0U
 
#define ZB_STD_SEQ_UNSECURED_JOIN   1U
 
#define ZB_DEVICE_LEFT   2U
 
#define ZB_STD_SEQ_UNSECURED_REJOIN   3U
 
#define ZB_JOIN_WITH_DLK   6U
 

TC action on incoming Update Device

#define ZB_TC_ACTION_AUTHORIZE   0u
 
#define ZB_TC_ACTION_DENY   1u
 
#define ZB_TC_ACTION_IGNORE   2u
 

Authorization types for @ref ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED

#define ZB_ZDO_AUTHORIZATION_TYPE_LEGACY   0U
 
#define ZB_ZDO_AUTHORIZATION_TYPE_R21_TCLK   1U
 
#define ZB_ZDO_AUTHORIZATION_TYPE_SE_CBKE   2U
 
#define ZB_ZDO_AUTHORIZATION_TYPE_DLK   3U
 

Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_LEGACY value of @ref

zdo_authorization_type type.

#define ZB_ZDO_LEGACY_DEVICE_AUTHORIZATION_SUCCESS   0U
 
#define ZB_ZDO_LEGACY_DEVICE_AUTHORIZATION_FAILED   1U
 

Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_R21_TCLK and ZB_ZDO_AUTHORIZATION_TYPE_DLK

values zdo_authorization_type

#define ZB_ZDO_TCLK_AUTHORIZATION_SUCCESS   0U
 
#define ZB_ZDO_TCLK_AUTHORIZATION_TIMEOUT   1U
 
#define ZB_ZDO_TCLK_AUTHORIZATION_FAILED   2U
 

Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_SE_CBKE value @ref zdo_authorization_type

For non-success statuses

See also
zb_kec_term_status_t
#define ZB_ZDO_CBKE_AUTHORIZATION_SUCCESS   0U
 

Detailed Description

There are tools that allow an application to handle Zigbee events like network formation, association status, leave indication, and others. Due to its nature, different Zigbee events appear asynchronously and ZBOSS informs the application about it through application signals. The application may handle or ignore a received signal. All application signals are processed in the application with a predefined callback function zboss_signal_handler(). It is mandatory for each application to implement this function, even if there is no need to process a signal.

There are policies that should be taken into account while implementing zboss_signal_handler() function:

Macro Definition Documentation

§ ZB_BDB_SIGNAL_DEVICE_FIRST_START

#define ZB_BDB_SIGNAL_DEVICE_FIRST_START   5U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Device started for the first time after the NVRAM erase. When generated:

§ ZB_BDB_SIGNAL_DEVICE_REBOOT

#define ZB_BDB_SIGNAL_DEVICE_REBOOT   6U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Device started using the NVRAM contents.

When generated:

Note
No ZB_BDB_SIGNAL_STEERING or ZB_BDB_SIGNAL_FORMATION signals will be generated.

Status codes:

  • RET_OK: Device started using configuration stored in NVRAM

§ ZB_BDB_SIGNAL_FINDING_AND_BINDING_INITIATOR_FINISHED

#define ZB_BDB_SIGNAL_FINDING_AND_BINDING_INITIATOR_FINISHED   13U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

BDB finding and binding for an initiator endpoint completed.

When generated:

  • F&B with a Target succeeded or F&B initiator timeout expired or cancelled.

Status codes:

Signal parameters:

§ ZB_BDB_SIGNAL_FINDING_AND_BINDING_TARGET_FINISHED

#define ZB_BDB_SIGNAL_FINDING_AND_BINDING_TARGET_FINISHED   12U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

BDB finding and binding for a target endpoint completed.

When generated:

  • F&B target timeout expires.

Status codes:

  • RET_OK: F&B target identifying time is expired.
  • RET_CANCELLED: F&B target identifying is cancelled during the IdentifyTime.
  • RET_ERROR: An error of any type.

Signal parameters:

§ ZB_BDB_SIGNAL_FORMATION

#define ZB_BDB_SIGNAL_FORMATION   11U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

BDB network formation completed (Network formation only).

When generated:

  • Upon completing Network formation initiated by bdb_start_top_level_commissioning(ZB_BDB_NETWORK_FORMATION).

Status codes:

Signal parameters:

  • none

§ ZB_BDB_SIGNAL_STEERING

#define ZB_BDB_SIGNAL_STEERING   10U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

BDB network steering completed (Network steering only).

When generated:

  • Upon completing Network steering initiated by bdb_start_top_level_commissioning(ZB_BDB_NETWORK_STEERING).

Status codes:

Has additional data of type zb_zdo_signal_leave_indication_params_t.

Signal parameters:

  • none

§ ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED

#define ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED   20U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

WWAH Rejoin start indication.

When generated:

  • Device lost communication with the parent and started WWAH Rejoin procedure.

Status codes:

  • RET_OK: Leave command received from the child device.
  • Does not return error status.

Signal parameters: no

§ ZB_COMMON_SIGNAL_CAN_SLEEP

#define ZB_COMMON_SIGNAL_CAN_SLEEP   22U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the application that the MCU can sleep for the specified period of time.

Note
Signal will not be generated if the sleep interval is less than sleep threshold ZB_SCHED_SLEEP_THRESHOLD_MS. To change the sleep threshold see zb_ret_t zb_sleep_set_threshold().

When generated:

  • ZBOSS scheduler detects that the sleep mode can be enabled on the device.

Status codes:

  • RET_OK: The sleep mode can be enabled on the device.
  • Does not return error status.

Signal parameters:

§ ZB_DEVICE_LEFT

§ ZB_GET_APP_SIGNAL_STATUS

#define ZB_GET_APP_SIGNAL_STATUS (   param)    zb_buf_get_status(param)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Get status from the application signal.

Parameters
param- buffer reference
Returns
status zb_ret_t

§ ZB_HIGH_SEQ_SECURED_REJOIN

§ ZB_HIGH_SEQ_UNSECURED_JOIN

§ ZB_HIGH_SEQ_UNSECURED_REJOIN

§ ZB_JOIN_WITH_DLK

#define ZB_JOIN_WITH_DLK   6U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Device join after network commissioning (r23). Note: non-standard status; do not send it.

§ ZB_NLME_STATUS_INDICATION

#define ZB_NLME_STATUS_INDICATION   52U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

NLME status indication. Application may implement additional logic based on receiving some statuses.

Signal parameter
zb_zdo_signal_nlme_status_indication_params_t
See also
zb_nwk_command_status_t is the full list of NLME statuses

§ ZB_NWK_SIGNAL_DEVICE_ASSOCIATED

#define ZB_NWK_SIGNAL_DEVICE_ASSOCIATED   18U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Obsolete signal, used for pre-R21 ZBOSS API compatibility. Use ZB_ZDO_SIGNAL_DEVICE_ANNCE signal instead!

When generated:

  • Indicates that there is a new device associated with Zigbee Coordinator or router.

Status codes:

  • RET_OK: New device associated.
  • Does not return error status.

Signal parameters:

§ ZB_NWK_SIGNAL_NO_ACTIVE_LINKS_LEFT

#define ZB_NWK_SIGNAL_NO_ACTIVE_LINKS_LEFT   24U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the application about the Neighbor Table expiration. It means that the neighbor devices did not send the Link Status messages for ZB_NWK_ROUTER_AGE_LIMIT * ZB_NWK_LINK_STATUS_PERIOD seconds.

When generated:

  • All routes expired (usually when the link is down).

Status codes:

  • RET_OK: All routers expired.
  • Does not return error status.

Signal parameters:

  • none

§ ZB_NWK_SIGNAL_PANID_CONFLICT_DETECTED

#define ZB_NWK_SIGNAL_PANID_CONFLICT_DETECTED   51U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

PAN ID conflict has been detected. Application has to decide whether to initiate its resolution or not.

Signal parameter
See also
zb_prepare_network_for_panid_change and zb_start_panid_change

§ ZB_SE_SIGNAL_APS_KEY_FAIL

#define ZB_SE_SIGNAL_APS_KEY_FAIL   40U

§ ZB_SE_SIGNAL_APS_KEY_READY

#define ZB_SE_SIGNAL_APS_KEY_READY   39U

§ ZB_SE_SIGNAL_CBKE_FAILED

#define ZB_SE_SIGNAL_CBKE_FAILED   30U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

CBKE procedure failed. Application may set another certificate & key and retry CBKE procedure.

Signal parameter
N/A
Example
Signal processing code for ZB_SE_SIGNAL_CBKE_OK can be used as a template
See also
zb_se_load_ecc_cert - set certificate
zb_se_retry_cbke_with_tc - retry CBKE procedure

§ ZB_SE_SIGNAL_CBKE_OK

#define ZB_SE_SIGNAL_CBKE_OK   31U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

CBKE procedure with TC succeed. Note: TC can't receive that signal.

Signal parameter
N/A
Example

§ ZB_SE_SIGNAL_CHILD_REJOIN

#define ZB_SE_SIGNAL_CHILD_REJOIN   27U

§ ZB_SE_SIGNAL_REJOIN

§ ZB_SE_SIGNAL_REJOIN_STARTED

#define ZB_SE_SIGNAL_REJOIN_STARTED   ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

SE Rejoin start indication.

When generated:

  • Device lost communication with the parent and started SE rejoin procedure.

Status codes:

  • RET_OK: Leave command received from the child device.
  • Does not return error status.

Signal parameters: no

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_FAILED

#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_FAILED   35U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Bind request failed.

Signal parameter
zb_uint16_t - short remote device address
Example
The same code to ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_OK can be used for signal processing.

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_INDICATION

#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_INDICATION   36U

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_OK

#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_OK   34U

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_DO_BIND

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_FAILED

#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_FAILED   38U

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_OK

#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_OK   37U

§ ZB_SE_SIGNAL_SERVICE_DISCOVERY_START

#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_START   32U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Ready to start Service Discovery. Application can issue zb_se_service_discovery_start to actually start discovery

Signal parameter
N/A
Example

§ ZB_SE_SIGNAL_SKIP_JOIN

#define ZB_SE_SIGNAL_SKIP_JOIN   25U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Device started. No auto-join/rejoin configured, no join attempts were performed, control is passed to application.

Signal parameter
  • N/A

§ ZB_SE_TC_SIGNAL_CHILD_JOIN_CBKE

#define ZB_SE_TC_SIGNAL_CHILD_JOIN_CBKE   28U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Some device joined & authenticated in the net, established TCLK using CBKE procedure. Only TC can receive that signal.

Signal parameter
zb_ieee_addr_t - long remote device address
Example

§ ZB_SE_TC_SIGNAL_CHILD_JOIN_NON_CBKE

#define ZB_SE_TC_SIGNAL_CHILD_JOIN_NON_CBKE   29U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Some device joined & authenticated in the net, established TCLK, but using non-CBKE procedure (BDB). Only TC can receive that signal.

Signal parameter
zb_ieee_addr_t - long remote device address

§ ZB_SIGNAL_DEVICE_FIRST_START

§ ZB_SIGNAL_DEVICE_REBOOT

§ ZB_SIGNAL_SUBGHZ_RESUME

§ ZB_SIGNAL_SUBGHZ_SUSPEND

#define ZB_SIGNAL_SUBGHZ_SUSPEND   41U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

ZC / our MAC suspended our device tx: out of Duty cycle (sub-ghz only)

Signal parameter - number of minutes to suspend, -1 if unknown

§ ZB_STD_SEQ_SECURED_REJOIN

§ ZB_STD_SEQ_UNSECURED_JOIN

§ ZB_STD_SEQ_UNSECURED_REJOIN

#define ZB_STD_SEQ_UNSECURED_REJOIN   3U

§ ZB_TC_ACTION_AUTHORIZE

§ ZB_TC_ACTION_DENY

§ ZB_TC_ACTION_IGNORE

#define ZB_TC_ACTION_IGNORE   2u

§ ZB_TC_SWAPPED_SIGNAL

§ ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL

#define ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL   53U

§ ZB_ZDO_AUTHORIZATION_TYPE_DLK

#define ZB_ZDO_AUTHORIZATION_TYPE_DLK   3U

§ ZB_ZDO_AUTHORIZATION_TYPE_LEGACY

#define ZB_ZDO_AUTHORIZATION_TYPE_LEGACY   0U

§ ZB_ZDO_AUTHORIZATION_TYPE_R21_TCLK

#define ZB_ZDO_AUTHORIZATION_TYPE_R21_TCLK   1U

§ ZB_ZDO_AUTHORIZATION_TYPE_SE_CBKE

#define ZB_ZDO_AUTHORIZATION_TYPE_SE_CBKE   2U

§ ZB_ZDO_CBKE_AUTHORIZATION_SUCCESS

§ ZB_ZDO_FB_INITIATOR_STATUS_ALARM

#define ZB_ZDO_FB_INITIATOR_STATUS_ALARM   2U

§ ZB_ZDO_FB_INITIATOR_STATUS_CANCEL

#define ZB_ZDO_FB_INITIATOR_STATUS_CANCEL   1U

§ ZB_ZDO_FB_INITIATOR_STATUS_ERROR

#define ZB_ZDO_FB_INITIATOR_STATUS_ERROR   3U

§ ZB_ZDO_FB_INITIATOR_STATUS_SUCCESS

#define ZB_ZDO_FB_INITIATOR_STATUS_SUCCESS   0U

§ ZB_ZDO_LEGACY_DEVICE_AUTHORIZATION_FAILED

§ ZB_ZDO_LEGACY_DEVICE_AUTHORIZATION_SUCCESS

§ ZB_ZDO_SIGNAL_CUT_HEADER

#define ZB_ZDO_SIGNAL_CUT_HEADER (   buf)    zb_buf_cut_left(buf, sizeof(zb_zdo_app_signal_hdr_t))

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Cuts ZBOSS signal headers while keeping the signal parameter (if it was in the buffer).

Parameters
buf- pointer to a zb_buf_t structure. The buffer must be the one passed into zb_signal_handler_t.

§ ZB_ZDO_SIGNAL_DEFAULT_START

#define ZB_ZDO_SIGNAL_DEFAULT_START   0U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Obsolete signal, used for pre-R21 ZBOSS API compatibility. Not recommended to use. When generated:

  • After the device has been started and the non-BDB commissioning completed.

    • In case of the commissioning error.

    Status codes:

    • RET_OK: Device has started and joined the network.
    • RET_ERROR: An error of any type.

    Signal parameters:

    • none

§ ZB_ZDO_SIGNAL_DEVICE_ANNCE

#define ZB_ZDO_SIGNAL_DEVICE_ANNCE   2U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the application about the new device appearance.

When generated:

  • Upon receiving the Device_annce command.

Status codes:

  • RET_OK: Device_annce command was received.
  • Does not return error status.

Signal parameters:

§ ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED

#define ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED   47U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the Zigbee Trust center application about a new device is authorized in the network. For Zigbee R21 devices it means that the TCLK exchange procedure was finished, for the legacy devices it means that the Transport key was send to the device.

                                     When generated:
                                      - Authorization success
                                      - Authorization failed
                                      - Authorization timeout

                                     Status codes:
                                      - RET_OK: Device information updated.
                                      - Does not return error status.
                                     Signal parameters:
                                      - @ref zb_zdo_signal_device_authorized_params_t

§ ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_STARTED

#define ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_STARTED   50U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the Joiner device that Device Interview was started

Status codes:

  • RET_OK: Device Interview is started.

Device Interview is finished when device is authorized.

§ ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW

#define ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW   49U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the Zigbee Trust center that new device is ready for Device Interview.

Parameters
[in]param_inzb_zdo_signal_device_ready_for_interview_params_t

TC can exchange APS encrypted APS Data (including ZDO) with Joiner during Device Interview. TC can finish Device Interview by calling either zb_tc_auth_device_after_interview() or zb_tc_reject_device_after_interview ().

Status codes:

  • RET_OK: Device is ready and can be authorized.

Signal parameters:

§ ZB_ZDO_SIGNAL_DEVICE_UPDATE

#define ZB_ZDO_SIGNAL_DEVICE_UPDATE   48U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the Zigbee Trust center or parent router application about a new device joined, rejoined or left the network.

                                     When generated:
                                      - Standard device secured rejoin
                                      - Standard device unsecured join
                                      - Device left
                                      - Standard device trust center rejoin

                                     Status codes:
                                      - RET_OK: Device information updated.
                                      - Does not return error status.

                                     Signal parameters:
                                      - @ref zb_zdo_signal_device_update_params_t

§ ZB_ZDO_SIGNAL_ERROR

#define ZB_ZDO_SIGNAL_ERROR   4U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Corrupted or incorrect signal information.

When generated:

  • Incorrect buffer length detected by zb_get_app_signal (less then zb_zdo_app_signal_hdr_t)

Status codes:

  • none

Signal parameters:

  • none

§ ZB_ZDO_SIGNAL_GET_PARAMS

#define ZB_ZDO_SIGNAL_GET_PARAMS (   sg_p,
  type 
)    ((type *)(void *)((((zb_uint8_t *)sg_p) + sizeof(zb_zdo_app_signal_hdr_t))))

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Obtains pointer to parameters passed with application signal.

Parameters
[in]sg_p- pointer to application signal
[in]type- parameter type
Returns
pointer to signal parameters

Example

§ ZB_ZDO_SIGNAL_LEAVE

#define ZB_ZDO_SIGNAL_LEAVE   3U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the application that the device itself has left the network.

When generated:

  • Upon sending the "Leave" command.

Status codes:

  • RET_OK: Device has sent the "Leave" command.
  • Does not return error status.

Signal parameters:

Note
All callbacks for ZDO requests will be cleared and will be never called. For example, if zb_zdo_simple_desc_req has been sent with cb argument set and leave received before ZDO cb called, then this cb will be never called later.
                      @snippet light_sample/light_control/light_control.c signal_leave

§ ZB_ZDO_SIGNAL_LEAVE_INDICATION

#define ZB_ZDO_SIGNAL_LEAVE_INDICATION   19U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Network leave indication.

When generated:

  • The child device has left the network.

Status codes:

  • RET_OK: Leave command received from the child device.
  • RET_ERROR: An error of any type.

Signal parameters:

§ ZB_ZDO_SIGNAL_PRODUCTION_CONFIG_READY

#define ZB_ZDO_SIGNAL_PRODUCTION_CONFIG_READY   23U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the application that the application specific part of the production configuration was found and restored and provides the application with this data.

When generated:

  • After restoring the production configuration.

Status codes:

  • RET_OK: The application specific part of the production configuration exists.
  • RET_ERROR: An error of any type.

Signal parameters:

  • Passed up with application specific data from production configuration.

§ ZB_ZDO_SIGNAL_SKIP_STARTUP

#define ZB_ZDO_SIGNAL_SKIP_STARTUP   1U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Notifies the application that ZBOSS framework (scheduler, buffer pool, etc.) has started, but no join/rejoin/formation/BDB initialization has been done yet.

                            @parblock 
                            When generated:
  • When the application calls zboss_start_no_autostart() instead of zboss_start() before the zboss_main_loop(). Used when some hardware must be initialized before the Zigbee commissioning, but already has ZBOSS scheduler running. Example: sensor connected through UART.
  • On MAC-Split architecture, when the application calls zboss_start_no_autostart() and both host, SoC components completed initialization procedure. This signal is always generated after ZB_MACSPLIT_DEVICE_BOOT in such case.
                             Status codes:
                              - RET_OK: Only ZBOSS framework has been initialized.
                              - Does not return error status.
    
                             Signal parameters:
                                      - none
    
                             @snippet smart_plug_v2/sp_device/sp_device.c signal_skip_startup
    

§ ZB_ZDO_TCLK_AUTHORIZATION_FAILED

§ ZB_ZDO_TCLK_AUTHORIZATION_SUCCESS

§ ZB_ZDO_TCLK_AUTHORIZATION_TIMEOUT

§ ZB_ZDP_STATUS_BAD_KEY_NEG_METHOD

#define ZB_ZDP_STATUS_BAD_KEY_NEG_METHOD   0x91U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

The request encountered a temporary failure but a retry at a later time should be attempted and may succeed.

§ ZB_ZDP_STATUS_DEV_ANNCE_SENDING_FAILED

§ ZB_ZDP_STATUS_DEVICE_NOT_FOUND

#define ZB_ZDP_STATUS_DEVICE_NOT_FOUND   0x81U

§ ZB_ZDP_STATUS_FRAME_TOO_LARGE

#define ZB_ZDP_STATUS_FRAME_TOO_LARGE   0x90U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

A TLV required for processing the ZDO Request was absent from the received ZDO message.

§ ZB_ZDP_STATUS_INSUFFICIENT_SPACE

#define ZB_ZDP_STATUS_INSUFFICIENT_SPACE   0x8aU

§ ZB_ZDP_STATUS_INV_REQUESTTYPE

#define ZB_ZDP_STATUS_INV_REQUESTTYPE   0x80U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

The requested device did not exist on a device following a child descriptor request to a parent.

§ ZB_ZDP_STATUS_INVALID_EP

#define ZB_ZDP_STATUS_INVALID_EP   0x82U

§ ZB_ZDP_STATUS_INVALID_INDEX

#define ZB_ZDP_STATUS_INVALID_INDEX   0x8fU

§ ZB_ZDP_STATUS_NO_DESCRIPTOR

#define ZB_ZDP_STATUS_NO_DESCRIPTOR   0x89U

§ ZB_ZDP_STATUS_NO_ENTRY

#define ZB_ZDP_STATUS_NO_ENTRY   0x88U

§ ZB_ZDP_STATUS_NO_MATCH

#define ZB_ZDP_STATUS_NO_MATCH   0x86U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

The unbind request was unsuccessful due to the coordinator or source device not having an entry in its binding table to unbind.

§ ZB_ZDP_STATUS_NOT_ACTIVE

#define ZB_ZDP_STATUS_NOT_ACTIVE   0x83U

§ ZB_ZDP_STATUS_NOT_AUTHORIZED

#define ZB_ZDP_STATUS_NOT_AUTHORIZED   0x8dU

§ ZB_ZDP_STATUS_NOT_PERMITTED

#define ZB_ZDP_STATUS_NOT_PERMITTED   0x8bU

§ ZB_ZDP_STATUS_NOT_SUPPORTED

#define ZB_ZDP_STATUS_NOT_SUPPORTED   0x84U

§ ZB_ZDP_STATUS_SUCCESS

#define ZB_ZDP_STATUS_SUCCESS   0x00U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

The requested operation or transmission was completed successfully. The supplied request type was invalid.

§ ZB_ZDP_STATUS_TABLE_FULL

#define ZB_ZDP_STATUS_TABLE_FULL   0x8cU

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

The permissions configuration table on the target indicates that the request is not authorized from this device.

§ ZB_ZDP_STATUS_TEMPORARY_FAILURE

§ ZB_ZDP_STATUS_TIMEOUT

#define ZB_ZDP_STATUS_TIMEOUT   0x85U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

The end device bind request was unsuccessful due to a failure to match any suitable clusters.

§ ZB_ZDP_STATUS_TIMEOUT_BY_STACK

§ ZB_ZGP_SIGNAL_COMMISSIONING

#define ZB_ZGP_SIGNAL_COMMISSIONING   21U

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

ZGP commissioning signal.

When generated:

  • GPCB commissioned/decommissioned a device.

Status codes:

  • RET_OK: commissioning/decommissioned complete.
    • Does not return error status.

Signal parameters:

Typedef Documentation

§ zb_bdb_signal_touchlink_nwk_joined_router_t

§ zb_bdb_signal_touchlink_nwk_started_params_t

§ zb_debug_signal_tclk_ready_params_t

§ zb_nwk_signal_device_associated_params_t

§ zb_se_signal_service_discovery_bind_params_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Service Discovery Bind signal parameters.

Contains info about the device found during Service Discovery. Stack passes this parameter to the application with signal ZB_SE_SIGNAL_SERVICE_DISCOVERY_DO_BIND

§ zb_signal_handler_t

typedef zb_bool_t(* zb_signal_handler_t) (zb_uint8_t param)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

ZBOSS signal handler function.

An application or any ZBOSS subsystem can subscribe to all ZBOSS signals through this function.

Note
If the signal was processed and the function returns TRUE, it shall free the buffer as well.
Returns
ZB_TRUE if the signal was fully processed and no more actions needed by other handler in the subsription chain.

§ zb_zdo_app_event_t

§ zb_zdo_app_signal_hdr_t

§ zb_zdo_app_signal_t

§ zb_zdo_app_signal_type_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Type for signals passed to an application signal handler.

Holds one of zdo_app_signal_type. Previously it was defined as enum but was converted to a set of defines due to MISRA violations.

§ zb_zdo_authorization_type_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Type for Authorization types for ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED.

Deprecated:
holds one of zdo_authorization_type. Kept only for backward compatibility as zdo_authorization_type were declared previously as enum. Can be removed in future releases.

§ zb_zdo_device_unavailable_params_t

§ zb_zdo_fb_initiator_finished_status_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Type for Status codes for F&B Initiator Finished signal.

Holds one of zdo_fb_initiator_finished_status. Kept only for backward compatibility as zdo_fb_initiator_finished_status were declared previously as enum. Can be removed in future releases.

§ zb_zdo_legacy_device_authorization_status_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Type for Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_LEGACY value of zdo_authorization_type type.

Deprecated:
holds one of zdo_legacy_device_authorization_status. Kept only for backward compatibility as zdo_legacy_device_authorization_status were declared previously as enum. Can be removed in future releases.

§ zb_zdo_signal_can_sleep_params_t

§ zb_zdo_signal_device_annce_params_t

§ zb_zdo_signal_device_authorized_params_t

§ zb_zdo_signal_device_ready_for_interview_params_t

§ zb_zdo_signal_device_update_params_t

§ zb_zdo_signal_fb_initiator_finished_params_t

§ zb_zdo_signal_leave_indication_params_t

§ zb_zdo_signal_leave_params_t

§ zb_zdo_signal_macsplit_dev_boot_params_t

§ zb_zdo_signal_nlme_status_indication_params_t

§ zb_zdo_tclk_authorization_status_t

§ zb_zdp_status_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Type for ZDP status values.

Holds one of zdp_status. Kept for backward compatibility as zdp_status were declared previously as enum.

§ zb_zgp_signal_approve_comm_params_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

ZGP approve commissioning parameters.

Stack passes this parameter to application to notify about attempt GPD commissioning. Due to limited buffer memory, a pointer to the structure is passed.

§ zb_zgp_signal_commissioning_params_t

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

ZGP commissioning parameters.

Stack passes this parameter to application to notify about GPD commissioning result.

§ zb_zgp_signal_mode_change_params_t

Function Documentation

§ zb_get_app_signal()

zb_zdo_app_signal_type_t zb_get_app_signal ( zb_uint8_t  param,
zb_zdo_app_signal_hdr_t **  sg_p 
)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zdo.h>

Unpack application signal buffer in zboss_signal_handler()

Parameters
param- parameter of zboss_signal_handler()
sg_p- pointer to the extended signal info, if application wants it. Can be NULL.
Returns
Application signal

§ zb_signal_handler_add_back()

zb_bool_t zb_signal_handler_add_back ( zb_signal_handler_t  handler)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Add new signal handler to the end of a subscription chain.

Returns
ZB_TRUE if the handler was registered successfully. ZB_FALSE if there is no space left in the chain.

§ zb_signal_handler_add_front()

zb_bool_t zb_signal_handler_add_front ( zb_signal_handler_t  handler)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Add new signal handler to the beginning of a subscription chain.

Returns
ZB_TRUE if the handler was registered successfully. ZB_FALSE if there is no space left in the chain.

§ zb_signal_handler_remove()

zb_bool_t zb_signal_handler_remove ( zb_signal_handler_t  handler)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Remove signal handler from the subscription chain.

Returns
ZB_TRUE if the handler was removed successfully, ZB_FALSE otherwise.

§ zboss_signal_handler()

void zboss_signal_handler ( zb_uint8_t  param)

#include </home/developer/.conan/data/ti_zigbee/9.10.00.17/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

ZBOSS application signal handler.

If implemented by a ZBOSS application, it will be called for every signal. See zdo_app_signal_type.

Parameters
param- reference to the buffer which contains signal. See zb_get_app_signal.