ZDO Common

Zigbee Device Object (ZDO) definition for ESP Zigbee SDK.

API Reference

Header File

Structures

struct esp_zb_app_signal_msg_t

The struct of esp zboss app signal message table.

Public Members

esp_zb_app_signal_type_t signal

The signal type of Zigbee

const char *msg

The string of Zigbee signal

struct esp_zb_zdo_signal_leave_params_s

Leave parameters.

Note

Stack passes this parameter to application when device leave the network.

Public Members

uint8_t leave_type

Leave type. nwk_leave_type

struct esp_zb_zdo_signal_leave_indication_params_s

Leave Indication parameters.

Note

Stack passes this parameter to application upon receipt of leave indication primitive.

Public Members

uint16_t short_addr

Short address of device requested to leave or leaving device

esp_zb_ieee_addr_t device_addr

Long address of device requested to leave or leaving device

uint8_t rejoin

1 if this was leave with rejoin; 0 - otherwise

struct esp_zb_zdo_signal_device_annce_params_s

Association parameters.

Note

Stack passes this parameter to application when some device joins/rejoins to network.

Public Members

uint16_t device_short_addr

address of device that recently joined to network

esp_zb_ieee_addr_t ieee_addr

The 64-bit (IEEE) address assigned to the device.

uint8_t capability

The capability of the device.

struct esp_zb_zdo_signal_macsplit_dev_boot_params_s

Macsplit device boot parameters.

Note

Macsplit passes this parameter to application when device is booted.

Public Members

uint32_t dev_version

macsplit device version

esp_zb_ieee_addr_t extended_address

The 64-bit (IEEE) address assigned to the device.

char version_str[80]

macsplit version string

struct esp_zb_zdo_signal_device_update_params_s

Device Updated signal parameters.

Note

status of the device update 0x00 = Standard device secured rejoin 0x01 = Standard device unsecured join 0x02 = Device left 0x03 = Standard device trust center rejoin 0x04 – 0x07 = Reserved

Public Members

esp_zb_ieee_addr_t long_addr

Long Address of the updated device

uint16_t short_addr

Short Address of the updated device

uint8_t status

Indicates the updated status of the device

struct esp_zb_zdo_signal_device_authorized_params_s

Device authorized signal parameters.

Note

The authorization_type as following: 0x00 = Authorization type for legacy devices ( < r21) Status: 0x00: Authorization success 0x01: Authorization failed 0x01 = Authorization type for r21 device through TCLK Status: 0x00: Authorization success 0x01: Authorization timeout 0x02: Authorization failed 0x02 = Authorization type for SE through CBKE Status: 0x00: Authorization success

Public Members

esp_zb_ieee_addr_t long_addr

Long Address of the updated device

uint16_t short_addr

Short Address of the updated device

uint8_t authorization_type

Type of the authorization procedure

uint8_t authorization_status

Status of the authorization procedure which depends on authorization_type

Type Definitions

typedef struct esp_zb_zdo_signal_leave_params_s esp_zb_zdo_signal_leave_params_t

Leave parameters.

Note

Stack passes this parameter to application when device leave the network.

typedef struct esp_zb_zdo_signal_leave_indication_params_s esp_zb_zdo_signal_leave_indication_params_t

Leave Indication parameters.

Note

Stack passes this parameter to application upon receipt of leave indication primitive.

typedef struct esp_zb_zdo_signal_device_annce_params_s esp_zb_zdo_signal_device_annce_params_t

Association parameters.

Note

Stack passes this parameter to application when some device joins/rejoins to network.

typedef struct esp_zb_zdo_signal_macsplit_dev_boot_params_s esp_zb_zdo_signal_macsplit_dev_boot_params_t

Macsplit device boot parameters.

Note

Macsplit passes this parameter to application when device is booted.

typedef struct esp_zb_zdo_signal_device_update_params_s esp_zb_zdo_signal_device_update_params_t

Device Updated signal parameters.

Note

status of the device update 0x00 = Standard device secured rejoin 0x01 = Standard device unsecured join 0x02 = Device left 0x03 = Standard device trust center rejoin 0x04 – 0x07 = Reserved

typedef struct esp_zb_zdo_signal_device_authorized_params_s esp_zb_zdo_signal_device_authorized_params_t

Device authorized signal parameters.

Note

The authorization_type as following: 0x00 = Authorization type for legacy devices ( < r21) Status: 0x00: Authorization success 0x01: Authorization failed 0x01 = Authorization type for r21 device through TCLK Status: 0x00: Authorization success 0x01: Authorization timeout 0x02: Authorization failed 0x02 = Authorization type for SE through CBKE Status: 0x00: Authorization success

Enumerations

enum esp_zb_nwk_leave_type_t

Values:

enumerator ESP_ZB_NWK_LEAVE_TYPE_RESET

Leave without rejoin

enumerator ESP_ZB_NWK_LEAVE_TYPE_REJOIN

Leave with rejoin

enum esp_zb_zdp_status_t

ZDP status values.

Note

the status feedback for the zdo command

Values:

enumerator ESP_ZB_ZDP_STATUS_SUCCESS

The requested operation or transmission was completed successfully.

enumerator ESP_ZB_ZDP_STATUS_INV_REQUESTTYPE

The supplied request type was invalid.

enumerator ESP_ZB_ZDP_STATUS_DEVICE_NOT_FOUND

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

enumerator ESP_ZB_ZDP_STATUS_INVALID_EP

The supplied endpoint was equal to 0x00 or between 0xf1 and 0xff.

enumerator ESP_ZB_ZDP_STATUS_NOT_ACTIVE

The requested endpoint is not described by simple descriptor.

enumerator ESP_ZB_ZDP_STATUS_NOT_SUPPORTED

The requested optional feature is not supported on the target device.

enumerator ESP_ZB_ZDP_STATUS_TIMEOUT

A timeout has occurred with the requested operation.

enumerator ESP_ZB_ZDP_STATUS_NO_MATCH

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

enumerator ESP_ZB_ZDP_STATUS_NO_ENTRY

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

enumerator ESP_ZB_ZDP_STATUS_NO_DESCRIPTOR

A child descriptor was not available following a discovery request to a parent.

enumerator ESP_ZB_ZDP_STATUS_INSUFFICIENT_SPACE

The device does not have storage space to support the requested operation.

enumerator ESP_ZB_ZDP_STATUS_NOT_PERMITTED

The device is not in the proper state to support the requested operation.

enumerator ESP_ZB_ZDP_STATUS_TABLE_FULL

The device does not have table space to support the operation.

enumerator ESP_ZB_ZDP_STATUS_NOT_AUTHORIZED

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

enumerator ESP_ZB_ZDP_STATUS_BINDING_TABLE_FULL

The device doesn’t have binding table space to support the operation

enumerator ESP_ZB_ZDP_STATUS_INVALID_INDEX

The index in the received command is out of bounds.

enum esp_zb_app_signal_type_t

signal passed to the esp_zb_application_signal_handler

Note

It indicates current BDB, NWK or ZDO signal is finished

Values:

enumerator ESP_ZB_ZDO_SIGNAL_DEFAULT_START
enumerator ESP_ZB_ZDO_SIGNAL_SKIP_STARTUP
enumerator ESP_ZB_ZDO_SIGNAL_DEVICE_ANNCE
enumerator ESP_ZB_ZDO_SIGNAL_LEAVE
enumerator ESP_ZB_ZDO_SIGNAL_ERROR
enumerator ESP_ZB_BDB_SIGNAL_DEVICE_FIRST_START
enumerator ESP_ZB_BDB_SIGNAL_DEVICE_REBOOT
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK_NWK_STARTED
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK_NWK_JOINED_ROUTER
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK
enumerator ESP_ZB_BDB_SIGNAL_STEERING
enumerator ESP_ZB_BDB_SIGNAL_FORMATION
enumerator ESP_ZB_BDB_SIGNAL_FINDING_AND_BINDING_TARGET_FINISHED
enumerator ESP_ZB_BDB_SIGNAL_FINDING_AND_BINDING_INITIATOR_FINISHED
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK_TARGET
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK_NWK
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK_TARGET_FINISHED
enumerator ESP_ZB_BDB_SIGNAL_TOUCHLINK_ADD_DEVICE_TO_NWK
enumerator ESP_ZB_NWK_SIGNAL_DEVICE_ASSOCIATED
enumerator ESP_ZB_ZDO_SIGNAL_LEAVE_INDICATION
enumerator ESP_ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED
enumerator ESP_ZB_ZGP_SIGNAL_COMMISSIONING
enumerator ESP_ZB_COMMON_SIGNAL_CAN_SLEEP
enumerator ESP_ZB_ZDO_SIGNAL_PRODUCTION_CONFIG_READY
enumerator ESP_ZB_NWK_SIGNAL_NO_ACTIVE_LINKS_LEFT
enumerator ESP_ZB_SE_SIGNAL_SKIP_JOIN
enumerator ESP_ZB_SE_SIGNAL_REJOIN
enumerator ESP_ZB_SE_SIGNAL_CHILD_REJOIN
enumerator ESP_ZB_SE_TC_SIGNAL_CHILD_JOIN_CBKE
enumerator ESP_ZB_SE_TC_SIGNAL_CHILD_JOIN_NON_CBKE
enumerator ESP_ZB_SE_SIGNAL_CBKE_FAILED
enumerator ESP_ZB_SE_SIGNAL_CBKE_OK
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_START
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_DO_BIND
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_OK
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_FAILED
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_INDICATION
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_OK
enumerator ESP_ZB_SE_SIGNAL_SERVICE_DISCOVERY_FAILED
enumerator ESP_ZB_SE_SIGNAL_APS_KEY_READY
enumerator ESP_ZB_SE_SIGNAL_APS_KEY_FAIL
enumerator ESP_ZB_SIGNAL_SUBGHZ_SUSPEND
enumerator ESP_ZB_SIGNAL_SUBGHZ_RESUME
enumerator ESP_ZB_MACSPLIT_DEVICE_BOOT
enumerator ESP_ZB_MACSPLIT_DEVICE_READY_FOR_UPGRADE
enumerator ESP_ZB_MACSPLIT_DEVICE_FW_UPGRADE_EVENT
enumerator ESP_ZB_SIGNAL_NWK_INIT_DONE
enumerator ESP_ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED
enumerator ESP_ZB_ZDO_SIGNAL_DEVICE_UPDATE
enumerator ESP_ZB_NWK_SIGNAL_PANID_CONFLICT_DETECTED
enumerator ESP_ZB_NLME_STATUS_INDICATION
enumerator ESP_ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL
enumerator ESP_ZB_TC_SWAPPED_SIGNAL
enumerator ESP_ZB_BDB_SIGNAL_TC_REJOIN_DONE
enumerator ESP_ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS
enumerator ESP_ZB_BDB_SIGNAL_STEERING_CANCELLED
enumerator ESP_ZB_BDB_SIGNAL_FORMATION_CANCELLED
enumerator ESP_ZB_SIGNAL_READY_TO_SHUT
enumerator ESP_ZB_SIGNAL_INTERPAN_PREINIT
enumerator ESP_ZB_ZGP_SIGNAL_MODE_CHANGE
enumerator ESP_ZB_ZDO_DEVICE_UNAVAILABLE
enumerator ESP_ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING
enumerator ESP_ZB_SIGNAL_END
enum esp_zb_bdb_commissioning_mode_t

The enum of mode of Base Device Behavior (BDB)

Values:

enumerator ESP_ZB_BDB_MODE_INITIALIZATION
enumerator ESP_ZB_BDB_MODE_NETWORK_STEERING
enumerator ESP_ZB_BDB_MODE_NETWORK_FORMATION
enum esp_zb_zdo_bind_dst_addr_mode_t

The enum of bind request destination address mode.

Values:

enumerator ESP_ZB_ZDO_BIND_DST_ADDR_MODE_16_BIT_GROUP
enumerator ESP_ZB_ZDO_BIND_DST_ADDR_MODE_64_BIT_EXTENDED