Developing with ZBOSS for Zigbee

Macros

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

Typedefs

typedef zb_uint8_t zb_aps_status_t
 Type for APS status constants. More...
 
typedef zb_uint8_t zb_aps_addr_mode_t
 Type for APS addressing mode constants. More...
 

APS status constants

#define ZB_APS_STATUS_SUCCESS   0x00U
 
#define ZB_APS_ASDU_TOO_LONG   0xa0U
 
#define ZB_APS_DEFRAG_DEFERRED   0xa1U
 
#define ZB_APS_DEFRAG_UNSUPPORTED   0xa2U
 
#define ZB_APS_STATUS_ILLEGAL_REQUEST   0xa3U
 
#define ZB_APS_STATUS_INVALID_BINDING   0xa4U
 
#define ZB_APS_STATUS_INVALID_GROUP   0xa5U
 
#define ZB_APS_STATUS_INVALID_PARAMETER   0xa6U
 
#define ZB_APS_STATUS_NO_ACK   0xa7U
 
#define ZB_APS_STATUS_NO_BOUND_DEVICE   0xa8U
 
#define ZB_APS_STATUS_NO_SHORT_ADDRESS   0xa9U
 
#define ZB_APS_STATUS_NOT_SUPPORTED   0xaaU
 
#define ZB_APS_STATUS_SECURED_LINK_KEY   0xabU
 
#define ZB_APS_STATUS_SECURED_NWK_KEY   0xacU
 
#define ZB_APS_STATUS_SECURITY_FAIL   0xadU
 
#define ZB_APS_STATUS_TABLE_FULL   0xaeU
 
#define ZB_APS_STATUS_UNSECURED   0xafU
 
#define ZB_APS_STATUS_UNSUPPORTED_ATTRIBUTE   0xb0U
 

APS addressing mode constants

#define ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT   0x00U
 
#define ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT   0x01U
 
#define ZB_APS_ADDR_MODE_16_ENDP_PRESENT   0x02U
 
#define ZB_APS_ADDR_MODE_64_ENDP_PRESENT   0x03U
 
#define ZB_APS_ADDR_MODE_BIND_TBL_ID   0x04U
 

Detailed Description

Macro Definition Documentation

◆ ZB_APS_ADDR_MODE_16_ENDP_PRESENT

#define ZB_APS_ADDR_MODE_16_ENDP_PRESENT   0x02U

16-bit address for DstAddress and DstEndpoint present

◆ ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT

#define ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT   0x01U

16-bit group address for DstAddress; DstEndpoint not present

◆ ZB_APS_ADDR_MODE_64_ENDP_PRESENT

#define ZB_APS_ADDR_MODE_64_ENDP_PRESENT   0x03U

64-bit extended address for DstAddress and DstEndpoint present

◆ ZB_APS_ADDR_MODE_BIND_TBL_ID

#define ZB_APS_ADDR_MODE_BIND_TBL_ID   0x04U

"destination endpoint" is interpreted as an index in the binding table, all other destination address information is ignored

◆ ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT

#define ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT   0x00U

DstAddress and DstEndpoint not present

◆ ZB_APS_ASDU_TOO_LONG

#define ZB_APS_ASDU_TOO_LONG   0xa0U

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

◆ ZB_APS_DEFRAG_DEFERRED

#define ZB_APS_DEFRAG_DEFERRED   0xa1U

A received fragmented frame could not be defragmented at the current time.

◆ ZB_APS_DEFRAG_UNSUPPORTED

#define ZB_APS_DEFRAG_UNSUPPORTED   0xa2U

A received fragmented frame could not be defragmented since the device does not support fragmentation.

◆ ZB_APS_STATUS_ILLEGAL_REQUEST

#define ZB_APS_STATUS_ILLEGAL_REQUEST   0xa3U

A parameter value was out of range.

◆ ZB_APS_STATUS_INVALID_BINDING

#define ZB_APS_STATUS_INVALID_BINDING   0xa4U

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

◆ ZB_APS_STATUS_INVALID_GROUP

#define ZB_APS_STATUS_INVALID_GROUP   0xa5U

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

#define ZB_APS_STATUS_INVALID_PARAMETER   0xa6U

A parameter value was invalid or out of range.

◆ ZB_APS_STATUS_NO_ACK

#define ZB_APS_STATUS_NO_ACK   0xa7U

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

◆ ZB_APS_STATUS_NO_BOUND_DEVICE

#define ZB_APS_STATUS_NO_BOUND_DEVICE   0xa8U

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

#define ZB_APS_STATUS_NO_SHORT_ADDRESS   0xa9U

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

#define ZB_APS_STATUS_NOT_SUPPORTED   0xaaU

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

#define ZB_APS_STATUS_SECURED_LINK_KEY   0xabU

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

◆ ZB_APS_STATUS_SECURED_NWK_KEY

#define ZB_APS_STATUS_SECURED_NWK_KEY   0xacU

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

◆ ZB_APS_STATUS_SECURITY_FAIL

#define ZB_APS_STATUS_SECURITY_FAIL   0xadU

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

◆ ZB_APS_STATUS_SUCCESS

#define ZB_APS_STATUS_SUCCESS   0x00U

A request has been executed successfully.

◆ ZB_APS_STATUS_TABLE_FULL

#define ZB_APS_STATUS_TABLE_FULL   0xaeU

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

◆ ZB_APS_STATUS_UNSECURED

#define ZB_APS_STATUS_UNSECURED   0xafU

An ASDU was received without any security.

◆ ZB_APS_STATUS_UNSUPPORTED_ATTRIBUTE

#define ZB_APS_STATUS_UNSUPPORTED_ATTRIBUTE   0xb0U

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

Typedef Documentation

◆ zb_aps_addr_mode_t

Type for APS addressing mode constants.

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

◆ zb_aps_status_t

Type for APS status constants.

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