Developing with ZBOSS SDK for Zigbee

Macros

#define ZB_MIN_ENDPOINT_NUMBER   1
 Minimum valid endpoint number.
 
#define ZB_MAX_ENDPOINT_NUMBER   240
 Maximum valid endpoint number.
 
#define ZB_APS_BROADCAST_ENDPOINT_NUMBER   255
 Broadcast endpoint number.
 

Typedefs

typedef enum zb_aps_status_e zb_aps_status_t
 APS status constants.
 
typedef enum zb_aps_addr_mode_e zb_aps_addr_mode_t
 APS addressing mode constants.
 

Enumerations

enum  zb_aps_status_e {
  ZB_APS_STATUS_SUCCESS = 0x00, ZB_APS_ASDU_TOO_LONG = 0xa0, ZB_APS_DEFRAG_DEFERRED = 0xa1, ZB_APS_DEFRAG_UNSUPPORTED = 0xa2,
  ZB_APS_STATUS_ILLEGAL_REQUEST = 0xa3, ZB_APS_STATUS_INVALID_BINDING = 0xa4, ZB_APS_STATUS_INVALID_GROUP = 0xa5, ZB_APS_STATUS_INVALID_PARAMETER = 0xa6,
  ZB_APS_STATUS_NO_ACK = 0xa7, ZB_APS_STATUS_NO_BOUND_DEVICE = 0xa8, ZB_APS_STATUS_NO_SHORT_ADDRESS = 0xa9, ZB_APS_STATUS_NOT_SUPPORTED = 0xaa,
  ZB_APS_STATUS_SECURED_LINK_KEY = 0xab, ZB_APS_STATUS_SECURED_NWK_KEY = 0xac, ZB_APS_STATUS_SECURITY_FAIL = 0xad, ZB_APS_STATUS_TABLE_FULL = 0xae,
  ZB_APS_STATUS_UNSECURED = 0xaf, ZB_APS_STATUS_UNSUPPORTED_ATTRIBUTE = 0xb0
}
 APS status constants. More...
 
enum  zb_aps_addr_mode_e { ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT = 0, ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT = 1, ZB_APS_ADDR_MODE_16_ENDP_PRESENT = 2, ZB_APS_ADDR_MODE_64_ENDP_PRESENT = 3 }
 APS addressing mode constants. More...
 

Detailed Description

Enumeration Type Documentation

◆ zb_aps_addr_mode_e

APS addressing mode constants.

Enumerator
ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT 

0x00 = DstAddress and DstEndpoint not present

ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT 

0x01 = 16-bit group address for DstAddress; DstEndpoint not present

ZB_APS_ADDR_MODE_16_ENDP_PRESENT 

0x02 = 16-bit address for DstAddress and DstEndpoint present

ZB_APS_ADDR_MODE_64_ENDP_PRESENT 

0x03 = 64-bit extended address for DstAddress and DstEndpoint present

◆ zb_aps_status_e

APS status constants.

Enumerator
ZB_APS_STATUS_SUCCESS 

A request has been executed successfully.

ZB_APS_ASDU_TOO_LONG 

A transmit request failed since the ASDU is too large and fragmentation is not supported.

ZB_APS_STATUS_ILLEGAL_REQUEST 

A parameter value was out of range.

ZB_APS_STATUS_INVALID_BINDING 

An APSME-UNBIND.request failed due to the requested binding link not existing in the binding table.

ZB_APS_STATUS_INVALID_GROUP 

An APSME-REMOVE-GROUP.request has been issued with a group identifier that does not appear in the group table.

ZB_APS_STATUS_INVALID_PARAMETER 

A parameter value was invalid or out of range.

ZB_APS_STATUS_NO_ACK 

An APSDE-DATA.request requesting acknowledged transmission failed due to no acknowledgement being received.

ZB_APS_STATUS_NO_BOUND_DEVICE 

An APSDE-DATA.request with a destination addressing mode set to 0x00 failed due to there being no devices bound to this device.

ZB_APS_STATUS_NO_SHORT_ADDRESS 

An APSDE-DATA.request with a destination addressing mode set to 0x03 failed due to no corresponding short address found in the address map table.

ZB_APS_STATUS_NOT_SUPPORTED 

An APSDE-DATA.request with a destination addressing mode set to 0x00 failed due to a binding table not being supported on the device.

ZB_APS_STATUS_SECURED_LINK_KEY 

An ASDU was received that was secured using a link key.

ZB_APS_STATUS_SECURED_NWK_KEY 

An ASDU was received that was secured using a network key.

ZB_APS_STATUS_SECURITY_FAIL 

An APSDE-DATA.request requesting security has resulted in an error during the corresponding security processing.

ZB_APS_STATUS_TABLE_FULL 

An APSME-BIND.request or APSME.ADD- GROUP.request issued when the binding or group tables, respectively, were full.

ZB_APS_STATUS_UNSECURED 

An ASDU was received without any security

ZB_APS_STATUS_UNSUPPORTED_ATTRIBUTE 

An APSME-GET.request or APSME- SET.request has been issued with an unknown attribute identifier.