Z-Stack

Monitor and Test API

Document Number: SWRA198

Texas Instruments, Inc.

San Diego, California USA

Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Version Description Date

1.0 Initial Release 09/06/2008
1.1 Update address type for AUTOPEND 04/02/2009
1.2 Add MT_AF command and MT_ZDO callback for source routing 06/25/2009
Add MT_AF commands to support inter-pan
Add MT_ZDO commands to support link key configuration
1.3 Add MT_ZDO commands to MSG callback register/remove/indicate 01/17/2010
Add MT_UTIL commands for link key establishment
Increase ‘Length’ field from uint8 to uint16 in:
MT_AF_DATA_REQUEST_EXT and MT_AF_INCOMING_MSG_EXT
Add MT_AF_DATA_STORE and MT_AF_DATA_RETRIEVE
Add MT_UTIL_DATA_REQ and UTIL_TEST_LOOPBACK
1.4 Move MT_MAC_SRC_MATCH commands to MT_UTIL 07/08/2010
Add MT_ZDO commands to support manual joining procedure:
MT_ZDO_NWK_DISCOVERY_REQ
MT_ZDO_JOIN_REQ
MT_ZDO_NWK_DISCOVERY_CNF
MT_ZDO_BEACON_NOTIFY_IND
MT_JOIN_CNF
1.5 Add UTIL_APSME_LINK_KEY_NV_ID_GET command 07/27/2010
Add MT_SYS commands for handling system date and time:
MT_SYS_GET_TIME
MT_SYS_SET_TIME
Corrections to SYS_VERSION and ZDO_NODE_DESC_RSP commands
Add UTIL_APSME_REQUEST_KEY_CMD command.
Changed command name from ZDO_NETWORK_DISCOVERY_REQ to
ZDO_NWK_DISCOVERY_REQ
Fixed Cmd0 for ZDO_NWK_DISCOVERY_REQ and ZDO_JOIN_REQ.
Add AF_APSF_CONFIG_SET, SYS_OSAL_NV_ITEM_INIT,
SYS_OSAL_NV_ITEM_LENGTH, SYS_OSAL_NV_ITEM_DELETE
1.6 commands. 07/16/2011
Add ZDO_LEAVE_IND callback
Add SYS_SET_TX_POWER command
1.7 Fixed parameter info for UTIL_ADDRMGR_EXT_ADDR_LOOKUP 03/10/2012
Add Wildcard Profile ID bit definition in AF_DATA_REQUEST and
AF_DATA_REQUEST_EXT
Add AF_REFLECT_ERROR message
Clarify RemoveChildren_Rejoin parameter for ZDO_MGMT_LEAVE_REQ
1.8 command 11/14/2012
Add UTIL_SRNG_GEN and UTIL_BIND_ADD_ENTRY commands
Modify ZDO_MGMT_PERMIT_JOIN_REQ command, added AddrMode
1.9 field. 11/23/2013
Add MT_SYS commands for statistics:
1.10 SYS_ZDIAGS_INIT_STATS 03/13/2014

i Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14
NV
SYS_ZDIAGS_CLEAR_STATS
SYS_ZDIAGS_GET_STATS
SYS_ZDIAGS_RESTORE_STATS_NV
SYS_ ZDIAGS_SAVE_STATS_TO_NV
1.11 Correction to UTIL_KEY_EVENT command 12/09/2014
Added NV MT commands
SYS_NV_CREATE
SYS_NV_DELETE
SYS_NV_READ
SYS_NV_WRITE
SYS_NV_UPDATE
SYS_NV_COMPACT
Added ZDO command for new rejoin parameter
ZDO_SET_REJOIN_PARAMETERS_REQ
Added MT_ZDO extension commands
MT_ZDO_SEC_ADD_LINK_KEY
MT_ZDO_SEC_ENTRY_LOOKUP_EXT
MT_ZDO_SEC_DEVICE_REMOVE
MT_ZDO_EXT_ROUTE_DISC
MT_ZDO_EXT_ROUTE_CHECK
MT_ZDO_EXT_REMOVE_GROUP
MT_ZDO_EXT_REMOVE_ALL_GROUP
MT_ZDO_EXT_FIND_ALL_GROUPS_ENDPOINT
MT_ZDO_EXT_FIND_GROUP
MT_ZDO_EXT_ADD_GROUP
MT_ZDO_EXT_COUNT_ALL_GROUPS
MT_ZDO_EXT_RX_IDLE
MT_ZDO_EXT_UPDATE_NWK_KEY
MT_ZDO_EXT_SWITCH_NWK_KEY
MT_ZDO_EXT_NWK_INFO
MT_ZDO_EXT_SEC_APS_REMOVE_REQ
MT_ZDO_FORCE_CONCENTRATOR_CHANGE
1.12 MT_ZDO_EXT_SET_PARAMS 02/19/2015
Added MT_ZDO_TC_DEVICE_IND, MT_ZDO_PERMIT_JOIN_IND ,
1.13 MT_ZDO_NWK_ADDR_OF_INTEREST_REQ commands 03/09/2015
Addition of new MT commands for the Z3 stack update
New ZDO command ZDO_STARTUP_FROM_APP_EX
Added MT_APP_CNF commands
APP_CNF_SET_NWK_FRAME_COUNTER
APP_CNF_SET_DEFAULT_REMOTE_ENDDEVICE _TIMEOUT
APP_CNF_SET_ENDDEVICETIMEOUT
1.14 APP_CNF_SET_ALLOWREJOIN_TC_POLICY 10/25/2016

ii Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

APP_CNF_BDB_START_COMMISSIONING
APP_CNF_BDB_SET_CHANNEL
APP_CNF_BDB_ADD_INSTALLCODE
APP_CNF_BDB_SET_TC_REQUIRE_KEY_EXCHANGE
APP_CNF_BDB_SET_JOINUSESINSTALLCODEKEY
APP_CNF_BDB_SET_ACTIVE_DEFAULT_CENTRALIZED
APP_CNF_BDB_COMMISSIONING_NOTIFICATION
APP_CNF_BDB_ZED_ATTEMPT_RECOVER_NWK
Added MT_GREENPOWER commands
GP_DATA_REQ
GP_SEC_RSP
GP_DATA_CNF
GP_SEC_REQ
GP_DATA_IND
MT_APP_CNF
ZDO_STARTUP_FROM_APP_EX deprecated.
ZDO_STARTUP_FROM_APP fixed to be backward compatible.
BDB_COMMISSIONING_NOTIFICATION remaining methods
parameter now returns the right value.
MT_UTIL
UTIL_GET_DEVICE_INFO now returns Reduce
Function Devices associated to the local device instead of
1.15 all devices in the association table. 5/10/2017

iii Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Table of Contents
1. INTRODUCTION............................................................................................................................... 1
1.1 SCOPE ............................................................................................................................................... 1
1.2 OVERVIEW ........................................................................................................................................ 1
1.3 REQUIREMENTS ................................................................................................................................ 2
1.4 ACRONYMS ....................................................................................................................................... 2
1.5 REFERENCE DOCUMENTS .................................................................................................................. 2
2. MONITOR AND TEST TRANSPORT PROTOCOL..................................................................... 3
2.1 FORMAT ............................................................................................................................................ 3
2.1.1 General Serial Packet ............................................................................................................. 3
2.1.2 MT CMD ................................................................................................................................. 3
2.2 EXAMPLE .......................................................................................................................................... 5
3. MONITOR AND TEST COMMANDS ............................................................................................ 6
3.1 INTRODUCTION ................................................................................................................................. 6
3.2 MT_AF............................................................................................................................................. 6
3.2.1 MT_AF Commands ................................................................................................................. 6
3.2.1.1 AF_REGISTER .................................................................................................................. 6
3.2.1.2 AF_DATA_REQUEST ....................................................................................................... 7
3.2.1.3 AF_DATA_REQUEST_EXT .............................................................................................. 7
3.2.1.4 AF_DATA_REQUEST_SRC_RTG ..................................................................................... 8
3.2.1.5 AF_INTER_PAN_CTL ....................................................................................................... 9
3.2.1.6 AF_ DATA_STORE...........................................................................................................10
3.2.1.7 AF_ DATA_RETRIEVE ....................................................................................................10
3.2.1.8 AF_APSF_CONFIG_SET .................................................................................................11
3.2.2 MT_AF Callbacks ..................................................................................................................11
3.2.1.1 AF_DATA_CONFIRM ......................................................................................................11
3.2.1.2 AF_REFLECT_ERROR ....................................................................................................12
3.2.1.3 AF_INCOMING_MSG ......................................................................................................12
3.2.1.4 AF_INCOMING_MSG_EXT.............................................................................................12
3.3 MT_APP .........................................................................................................................................13
3.3.1 MT_APP Commands .............................................................................................................14
3.3.1.1 APP_MSG .........................................................................................................................14
3.3.1.2 APP_USER_TEST ............................................................................................................14
3.3.2 MT_APP Callbacks ...............................................................................................................15
3.4 MT_DEBUG ...................................................................................................................................15
3.4.1 MT_DEBUG Commands .......................................................................................................15
3.4.1.1 DEBUG_SET_THRESHOLD ...........................................................................................15
3.4.1.2 DEBUG_MSG ...................................................................................................................15
3.4.2 MT_DEBUG Callbacks .........................................................................................................15
3.5 MT_MAC........................................................................................................................................16
3.5.1 MT_MAC Commands ............................................................................................................16
3.5.1.1 MAC_RESET_REQ ...........................................................................................................16
3.5.1.2 MAC_INIT ........................................................................................................................16
3.5.1.3 MAC_START_REQ ...........................................................................................................16
3.5.1.4 MAC_SYNC_REQ .............................................................................................................18
3.5.1.5 MAC_DATA_REQ ............................................................................................................18
3.5.1.6 MAC_ASSOCIATE_REQ ..................................................................................................20
3.5.1.7 MAC_ASSOCIATE_RSP ...................................................................................................21
3.5.1.8 MAC_DISASSOCIATE_REQ ............................................................................................22
3.5.1.9 MAC_GET_REQ ...............................................................................................................23
3.5.1.10 MAC_SET_REQ................................................................................................................24
3.5.1.11 MAC_SCAN_REQ ............................................................................................................25

iv Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.5.1.12 MAC_ORPHAN_RSP .......................................................................................................26

3.5.1.13 MAC_POLL_REQ ............................................................................................................26
3.5.1.14 MAC_PURGE_REQ .........................................................................................................27
3.5.1.15 MAC_SET_RX_GAIN_REQ .............................................................................................28
3.5.2 MT_MAC Callbacks ..............................................................................................................28
3.5.2.1 MAC_SYNC_LOSS_IND...................................................................................................28
3.5.2.2 MAC_ASSOCIATE_IND ...................................................................................................29
3.5.2.3 MAC_ASSOCIATE_CNF ..................................................................................................30
3.5.2.4 MAC_BEACON_NOTIFY_IND ........................................................................................31
3.5.2.5 MAC_DATA_CNF ............................................................................................................32
3.5.2.6 MAC_DATA_IND .............................................................................................................32
3.5.2.7 MAC_DISASSOCIATE_IND.............................................................................................33
3.5.2.8 MAC_DISASSOCIATE_CNF ............................................................................................34
3.5.2.9 MAC_ORPHAN_IND .......................................................................................................35
3.5.2.10 MAC_POLL_CNF ............................................................................................................35
3.5.2.11 MAC_SCAN_CNF ............................................................................................................36
3.5.2.12 MAC_COMM_STATUS_IND ...........................................................................................36
3.5.2.13 MAC_START_CNF ...........................................................................................................37
3.5.2.14 MAC_RX_ENABLE_CNF .................................................................................................37
3.5.2.15 MAC_PURGE_CNF .........................................................................................................38
3.6 MT_NWK .......................................................................................................................................38
3.7 MT_SAPI ........................................................................................................................................38
3.7.1 MT_SAPI Commands ............................................................................................................38
3.7.1.1 ZB_SYSTEM_RESET ........................................................................................................38
3.7.1.2 ZB_START_REQUEST .....................................................................................................38
3.7.1.3 ZB_PERMIT_JOINING_REQUEST .................................................................................39
3.7.1.4 ZB_BIND_DEVICE ..........................................................................................................39
3.7.1.5 ZB_ALLOW_BIND ...........................................................................................................40
3.7.1.6 ZB_SEND_DATA_REQUEST...........................................................................................40
3.7.1.7 ZB_READ_CONFIGURATION ........................................................................................41
3.7.1.8 ZB_WRITE_CONFIGURATION ......................................................................................41
3.7.1.9 ZB_GET_DEVICE_INFO .................................................................................................42
3.7.1.10 ZB_FIND_DEVICE_REQUEST .......................................................................................42
3.7.2 MT_SAPI Callbacks ..............................................................................................................43
3.7.2.1 ZB_START_CONFIRM .....................................................................................................43
3.7.2.2 ZB_BIND_CONFIRM .......................................................................................................43
3.7.2.3 ZB_ALLOW_BIND_CONFIRM ........................................................................................43
3.7.2.4 ZB_SEND_DATA_CONFIRM ..........................................................................................43
3.7.2.5 ZB_RECEIVE_DATA_INDICATION ...............................................................................44
3.7.2.6 ZB_FIND_DEVICE_CONFIRM .......................................................................................44
3.8 MT_SYS .........................................................................................................................................44
3.8.1 MT_SYS Commands ..............................................................................................................45
3.8.1.1 SYS_RESET_REQ .............................................................................................................45
3.8.1.2 SYS_PING .........................................................................................................................45
3.8.1.3 SYS_VERSION ..................................................................................................................46
3.8.1.4 SYS_SET_EXTADDR ........................................................................................................46
3.8.1.5 SYS_GET_EXTADDR .......................................................................................................47
3.8.1.6 SYS_RAM_READ ..............................................................................................................47
3.8.1.7 SYS_RAM_WRITE ............................................................................................................48
3.8.1.8 SYS_OSAL_NV_READ .....................................................................................................48
3.8.1.9 SYS_OSAL_NV_WRITE ....................................................................................................49
3.8.1.10 SYS_OSAL_NV_ITEM_INIT .............................................................................................49
3.8.1.11 SYS_OSAL_NV_DELETE .................................................................................................50
3.8.1.12 SYS_OSAL_NV_LENGTH ................................................................................................50
3.8.1.13 SYS_OSAL_START_TIMER ..............................................................................................51
3.8.1.14 SYS_OSAL_STOP_TIMER ...............................................................................................51

v Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.15 SYS_RANDOM..................................................................................................................52
3.8.1.16 SYS_ADC_READ ..............................................................................................................52
3.8.1.17 SYS_GPIO.........................................................................................................................53
3.8.1.18 SYS_STACK_TUNE ..........................................................................................................53
3.8.1.19 SYS_SET_TIME ................................................................................................................54
3.8.1.20 SYS_GET_TIME ...............................................................................................................54
3.8.1.21 SYS_SET_TX_POWER .....................................................................................................55
3.8.1.22 SYS_ZDIAGS_INIT_STATS ..............................................................................................55
3.8.1.23 SYS_ZDIAGS_CLEAR_STATS..........................................................................................56
3.8.1.24 SYS_ZDIAGS_GET_STATS ..............................................................................................56
3.8.1.25 SYS_ZDIAGS_RESTORE_STATS_NV ..............................................................................57
3.8.1.26 SYS_ZDIAGS_SAVE_STATS_TO_NV ..............................................................................57
3.8.1.27 SYS_NV_CREATE ............................................................................................................58
3.8.1.28 SYS_NV_DELETE ............................................................................................................58
3.8.1.29 SYS_NV_LENGTH ............................................................................................................59
3.8.1.30 SYS_NV_READ .................................................................................................................59
3.8.1.31 SYS_NV_WRITE ...............................................................................................................60
3.8.1.32 SYS_NV_UPDATE ............................................................................................................60
3.8.1.33 SYS_NV_COMPACT.........................................................................................................61
3.8.1.34 SYS_OSAL_NV_READ_EXT ............................................................................................61
3.8.1.35 SYS_OSAL_NV_WRITE_EXT ...........................................................................................62
3.8.2 MT_SYS Callbacks ................................................................................................................62
3.8.2.1 SYS_RESET_IND ..............................................................................................................62
3.8.2.2 SYS_OSAL_TIMER_EXPIRED .........................................................................................63
3.9 MT_UART ......................................................................................................................................63
3.10 MT_UTIL ...................................................................................................................................63
3.10.1 MT_UTIL Commands .......................................................................................................63
3.10.1.1 UTIL_GET_DEVICE_INFO .............................................................................................63
3.10.1.2 UTIL_GET_NV_INFO ......................................................................................................64
3.10.1.3 UTIL_SET_PANID ...........................................................................................................64
3.10.1.4 UTIL_SET_CHANNELS ...................................................................................................65
3.10.1.5 UTIL_SET_SECLEVEL ....................................................................................................65
3.10.1.6 UTIL_SET_PRECFGKEY.................................................................................................66
3.10.1.7 UTIL_CALLBACK_SUB_CMD ........................................................................................66
3.10.1.8 UTIL_KEY_EVENT ..........................................................................................................67
3.10.1.9 UTIL_TIME_ALIVE..........................................................................................................68
3.10.1.10 UTIL_LED_CONTROL................................................................................................68
3.10.1.11 UTIL_LOOPBACK ......................................................................................................68
3.10.1.12 UTIL_DATA_REQ .......................................................................................................69
3.10.1.13 UTIL_SRC_MATCH_ENABLE ....................................................................................69
3.10.1.14 UTIL_SRC_MATCH_ADD_ENTRY ............................................................................70
3.10.1.15 UTIL_SRC_MATCH_DEL_ENTRY .............................................................................70
3.10.1.16 UTIL_SRC_MATCH_CHECK_SRC_ADDR................................................................71
3.10.1.17 UTIL_SRC_MATCH_ACK_ALL_PENDING ...............................................................71
3.10.1.18 UTIL_SRC_MATCH_CHECK_ALL_PENDING .........................................................72
3.10.1.19 UTIL_ADDRMGR_EXT_ADDR_LOOKUP ................................................................72
3.10.1.20 UTIL_ADDRMGR_NWK_ADDR_LOOKUP ...............................................................72
3.10.1.21 UTIL_APSME_LINK_KEY_DATA_GET .....................................................................73
3.10.1.22 UTIL_APSME_LINK_KEY_NV_ID_GET....................................................................73
3.10.1.23 UTIL_APSME_REQUEST_KEY_CMD .......................................................................74
3.10.1.24 UTIL_ASSOC_COUNT ................................................................................................74
3.10.1.25 UTIL_ASSOC_FIND_DEVICE ....................................................................................75
3.10.1.26 UTIL_ASSOC_GET_WITH_ADDRESS .......................................................................75
3.10.1.27 UTIL_BIND_ADD_ENTRY ..........................................................................................76
3.10.1.28 UTIL_ZCL_KEY_EST_INIT_EST ................................................................................76
3.10.1.29 UTIL_ZCL_KEY_EST_SIGN .......................................................................................77

vi Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.10.1.30 UTIL_SRNG_GEN .......................................................................................................77

3.10.2 MT_UTIL Callbacks .........................................................................................................78
3.10.2.1 UTIL_SYNC_REQ ............................................................................................................78
3.10.2.2 UTIL_ZCL_KEY_ESTABLISH_IND .................................................................................78
3.11 MT_VERSION...........................................................................................................................78
3.12 MT_ZDO ....................................................................................................................................78
3.12.1 MT_ZDO Commands ........................................................................................................79
3.12.1.1 ZDO_NWK_ADDR_REQ .................................................................................................79
3.12.1.2 ZDO_IEEE_ADDR_REQ .................................................................................................79
3.12.1.3 ZDO_NODE_DESC_REQ ................................................................................................80
3.12.1.4 ZDO_POWER_DESC_REQ .............................................................................................80
3.12.1.5 ZDO_SIMPLE_DESC_REQ .............................................................................................81
3.12.1.6 ZDO_ACTIVE_EP_REQ ..................................................................................................81
3.12.1.7 ZDO_MATCH_DESC_REQ .............................................................................................82
3.12.1.8 ZDO_COMPLEX_DESC_REQ ........................................................................................82
3.12.1.9 ZDO_USER_DESC_REQ .................................................................................................83
3.12.1.10 ZDO_END_DEVICE_ANNCE .....................................................................................83
3.12.1.11 ZDO_USER_DESC_SET .............................................................................................84
3.12.1.12 ZDO_SERVER_DISC_REQ .........................................................................................84
3.12.1.13 ZDO_END_DEVICE_BIND_REQ...............................................................................85
3.12.1.14 ZDO_BIND_REQ.........................................................................................................85
3.12.1.15 ZDO_UNBIND_REQ ...................................................................................................86
3.12.1.16 ZDO_MGMT_NWK_DISC_REQ .................................................................................87
3.12.1.17 ZDO_MGMT_LQI_REQ ..............................................................................................88
3.12.1.18 ZDO_MGMT_RTG_REQ .............................................................................................88
3.12.1.19 ZDO_MGMT_BIND_REQ ...........................................................................................89
3.12.1.20 ZDO_MGMT_LEAVE_REQ ........................................................................................89
3.12.1.21 ZDO_MGMT_DIRECT_JOIN_REQ ............................................................................90
3.12.1.22 ZDO_MGMT_PERMIT_JOIN_REQ ...........................................................................90
3.12.1.23 ZDO_MGMT_NWK_UPDATE_REQ ..........................................................................91
3.12.1.24 ZDO_MSG_CB_REGISTER ........................................................................................92
3.12.1.25 ZDO_MSG_CB_REMOVE ..........................................................................................92
3.12.1.26 ZDO_STARTUP_FROM_APP .....................................................................................93
3.12.1.27 ZDO_STARTUP_FROM_APP_EX ..............................................................................93
3.12.1.28 ZDO_SET_LINK_KEY .................................................................................................94
3.12.1.29 ZDO_REMOVE_LINK_KEY ........................................................................................94
3.12.1.30 ZDO_GET_LINK_KEY ................................................................................................95
3.12.1.31 ZDO_NWK_DISCOVERY_REQ ..................................................................................95
3.12.1.32 ZDO_JOIN_REQ .........................................................................................................96
3.12.1.33 ZDO_SET_REJOIN_PARAMETERS ...........................................................................97
3.12.1.34 ZDO_SEC_ADD_LINK_KEY ......................................................................................97
3.12.1.35 ZDO_SEC_ENTRY_LOOKUP_EXT ............................................................................98
3.12.1.36 ZDO_SEC_DEVICE_REMOVE...................................................................................99
3.12.1.37 ZDO_EXT_ROUTE_DISC ...........................................................................................99
3.12.1.38 ZDO_EXT_ROUTE_CHECK.....................................................................................100
3.12.1.39 ZDO_EXT_REMOVE_GROUP .................................................................................100
3.12.1.40 ZDO_EXT_REMOVE_ALL_GROUP ........................................................................101
3.12.1.41 ZDO_EXT_FIND_ALL_GROUPS_ENDPOINT ........................................................101
3.12.1.42 ZDO_EXT_FIND_GROUP ........................................................................................102
3.12.1.43 ZDO_EXT_ADD_GROUP .........................................................................................102
3.12.1.44 ZDO_EXT_COUNT_ALL_GROUPS .........................................................................103
3.12.1.45 ZDO_EXT_RX_IDLE .................................................................................................103
3.12.1.46 ZDO_EXT_UPDATE_NWK_KEY .............................................................................104
3.12.1.47 ZDO_EXT_SWITCH_NWK_KEY ..............................................................................104
3.12.1.48 ZDO_EXT_NWK_INFO .............................................................................................104
3.12.1.49 ZDO_EXT_SEC_APS_REMOVE_REQ .....................................................................105

vii Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1.50 ZDO_FORCE_CONCENTRATOR_CHANGE...........................................................106
3.12.1.51 ZDO_EXT_SET_PARAMS .........................................................................................106
3.12.1.52 ZDO_NWK_ADDR_OF_INTEREST_REQ ................................................................106
3.12.2 MT_ZDO Callbacks ........................................................................................................107
3.12.2.1 ZDO_NWK_ADDR_RSP ................................................................................................107
3.12.2.2 ZDO_IEEE_ADDR_RSP ................................................................................................107
3.12.2.3 ZDO_NODE_DESC_RSP ...............................................................................................108
3.12.2.4 ZDO_POWER_DESC_RSP ............................................................................................109
3.12.2.5 ZDO_SIMPLE_DESC_RSP ............................................................................................109
3.12.2.6 ZDO_ACTIVE_EP_RSP .................................................................................................110
3.12.2.7 ZDO_MATCH_DESC_RSP ............................................................................................110
3.12.2.8 ZDO_COMPLEX_DESC_RSP .......................................................................................111
3.12.2.9 ZDO_USER_DESC_RSP ................................................................................................111
3.12.2.10 ZDO_USER_DESC_CONF .......................................................................................112
3.12.2.11 ZDO_SERVER_DISC_RSP ........................................................................................112
3.12.2.12 ZDO_END_DEVICE_BIND_RSP .............................................................................112
3.12.2.13 ZDO_BIND_RSP .......................................................................................................113
3.12.2.14 ZDO_UNBIND_RSP ..................................................................................................113
3.12.2.15 ZDO_MGMT_NWK_DISC_RSP ................................................................................113
3.12.2.16 ZDO_MGMT_LQI_RSP .............................................................................................114
3.12.2.17 ZDO_MGMT_RTG_RSP............................................................................................115
3.12.2.18 ZDO_MGMT_BIND_RSP ..........................................................................................116
3.12.2.19 ZDO_MGMT_LEAVE_RSP .......................................................................................116
3.12.2.20 ZDO_MGMT_DIRECT_JOIN_RSP...........................................................................117
3.12.2.21 ZDO_MGMT_PERMIT_JOIN_RSP ..........................................................................117
3.12.2.22 ZDO_STATE_CHANGE_IND ....................................................................................117
3.12.2.23 ZDO_END_DEVICE_ANNCE_IND ..........................................................................117
3.12.2.24 ZDO_MATCH_DESC_RSP_SENT ............................................................................118
3.12.2.25 ZDO_STATUS_ERROR_RSP.....................................................................................118
3.12.2.26 ZDO_SRC_RTG_IND ................................................................................................119
3.12.2.27 ZDO_BEACON_NOTIFY_IND ..................................................................................119
3.12.2.28 ZDO_JOIN_CNF .......................................................................................................120
3.12.2.29 ZDO_NWK_DISCOVERY_CNF ................................................................................120
3.12.2.30 ZDO_LEAVE_IND .....................................................................................................121
3.12.2.31 ZDO_MSG_CB_INCOMING .....................................................................................121
3.12.2.32 ZDO_TC_DEV_IND ..................................................................................................121
3.12.2.33 ZDO_PERMIT_JOIN_IND ........................................................................................122
3.13 MT_APP_CONFIG ..................................................................................................................122
3.13.1 MT_APP_CONFIG Commands ......................................................................................122
3.13.1.1 APP_CNF_SET_NWK_FRAME_COUNTER .................................................................122
3.13.1.2 APP_CNF_SET_DEFAULT_REMOTE_ENDDEVICE _TIMEOUT .............................123
3.13.1.3 APP_CNF_SET_ENDDEVICETIMEOUT .....................................................................123
3.13.1.4 APP_CNF_SET_ALLOWREJOIN_TC_POLICY ............................................................124
3.13.1.5 APP_CNF_BDB_START_COMMISSIONING ...............................................................125
3.13.1.6 APP_CNF_BDB_SET_CHANNEL .................................................................................125
3.13.1.7 APP_CNF_BDB_ADD_INSTALLCODE ........................................................................126
3.13.1.8 APP_CNF_BDB_SET_TC_REQUIRE_KEY_EXCHANGE ...........................................126
3.13.1.9 APP_CNF_BDB_SET_JOINUSESINSTALLCODEKEY ................................................127
3.13.1.10 APP_CNF_BDB_SET_ACTIVE_DEFAULT_CENTRALIZED_KEY ........................128
3.13.1.11 APP_CNF_BDB_ZED_ATTEMPT_RECOVER_NWK ..............................................128
3.13.2 MT_APP_CONFIG Callbacks ........................................................................................129
3.13.2.1 APP_CNF_BDB_COMMISSIONING_NOTIFICATION ................................................129
3.14 MT_GREENPOWER ...............................................................................................................130
3.14.1 MT_GP Commands.........................................................................................................130
3.14.1.1 GP_DATA_REQ .............................................................................................................130
3.14.1.2 GP_SEC_RSP .................................................................................................................131

viii Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.14.2 MT_GP Callbacks...........................................................................................................132

3.14.2.1 GP_DATA_CNF .............................................................................................................132
3.14.2.2 GP_SEC_REQ ................................................................................................................133
3.14.2.3 GP_DATA_IND ..............................................................................................................134

ix Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

 Z-Stack Monitor and Test API SWRA198 Revision 1.14

1. Introduction

1.1 Scope
This document describes the Monitor and Test (MT) interface that is used for communication between
the host tester and a ZigBee device through RS-232 serial port. Tester can issue MT commands to the
ZigBee target through a PC application called Z-Tool. The target must be programmed with the latest
Texas Instruments Z-Stack™.

1.2 Overview
MT interfaces are divided into categories, shown in the table below. Most interfaces can be disabled or
enabled by a compile flag. Depending on the desired interfaces, certain flags need to be enabled during
compilation. For a list of supported compile flags, check the “Z-Stack Compile Option” document.

Interface Description Compile flags

This interface allows tester to interact with AF layer MT_AF_FUNC
MT_AF of the target. MT_AF_CB_FUNC
This interface allows tester to interact with APP layer
MT_APP of the target to control custom tests such as test MT_APP_FUNC
profile or user-defined test.
This interface allows tester to control the debug-
MT_DEBUG messaging mechanism such as debug threshold, MT_DEBUG_FUNC
debug messages, etc.
This interface allows tester to interact with NWK MT_NWK_FUNC
MT_NWK layer of the target. MT_NWK_CB_FUNC
This interface allows tester to interact with simple MT_SAPI_FUNC
MT_SAPI API interface. MT_SAPI_CB_FUNC
This interface allows the tester to interact with the
MT_SYS target at system level such as reset, read/write MT_SYS_FUNC
memory, read/write extended address, etc.
This interface handles communication between the
MT_TASK Monitor Test interface and Z-Stack. Tester has no MT_TASK
control direct over this interface.
This interface handles communication between the
MT_UART target and Z-Tool. Tester has no direct control over N/A
this interface.
This interface provides tester supporting
MT_UTIL functionalities such as setting PanID, getting device MT_UTIL_FUNC
info, getting NV info, subscribing callbacks, etc.
This interface contains information about the release
MT_VERSION version of the software. N/A

This interface allows tester to interact with the ZDO

layer of the target. MT_ZDO_FUNC
MT_ZDO
MT_ZDO_CB_FUNC
This interface allows to interact with the commands
MT_APP_CNF introduced by Z3.0 Base Device Behavior. MT_APP_CNF_FUNC

This interface allows to interact with GP stubs.

MT_GP MT_GP_CB_FUNC

1 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

1.3 Requirements
There are several requirements for a tester to interact with the ZigBee target through the MT interface:
ZigBee target is programmed with Texas Instruments Z-Stack™ (ZStack-2.1.0 or newer).
Z-Tool 2.0 or newer installed on the tester PC.
PC is connected to ZigBee target though RS-232 serial port.

1.4 Acronyms
Table 1
ADC Analog to Digital Conversion
AF Application Framework
AREQ Asynchronous Request
FCS Frame Check Sequence
MT Monitor and Test
RPC Remote Procedure Call
SAPI Simple API
SOF Start of Frame
SREQ Synchronous Request
SRSP Synchronous Response
Z-Stack Texas Instruments ZigBee protocol stack
Z-Tool Texas Instruments ZigBee PC-based test tool

1.5 Reference Documents

[1] Z-Stack Compile Options (SWRA188).
[2] Z-Stack User’s Guides (SWRA161, SWRA162, SWRA163, SWRA164, SWRA165)
[3] Z-Stack Developer’s Guide (SWRA176)
[4] Z-Stack Application Programming Interface (SWRA195)

2 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

 Z-Stack Monitor and Test API SWRA198 Revision 1.14

2. Monitor and Test Transport Protocol

A transport protocol is necessary so that messages can be exchanged between the tester and target
over an RS-232 serial link. The purpose of the transport protocol is to frame the messages in packets
for proper transmission and reception and to ensure message integrity.
The physical transmission uses: no Parity; 8 data bits and 1 stop bits for each byte.
The transmission rate will be 38.4 kbps, 57.6kbps and 115.2kbps
The Z-Tool program must send one message at a time and wait for either the expected response
message to a timeout before sending the next message or resending the current message.
Fields that are multi-byte fields are transmitted Least Significant byte first (LSB). There is no
provision for retransmission of lost packets

2.1 Format

2.1.1 General Serial Packet

Serial packets are sent between the Z-Tool PC application and the target ZigBee device.
They contain an SOF (Start of Frame), followed by a variable-length MT packet, and
terminated by an FCS (Frame Check Sequence).
Building of the serial packets is handled by MT_TransportSend() where the SOF is
inserted at the beginning of the packet and FCS is computed and appended to the end of
the packet.

SOF MT CMD FCS

Byte: 1 3-256 1

SOF (Start of Frame): This is a one byte field with value equal to 0xFE that defines the
start of each general serial packet.

MT CMD (Monitor Test Command): This contains 1 byte for the length of the actual
data, 2 bytes for the MT command Id, and the data ranging from 0-250 bytes. Check
2.1.2 for more details.

FCS (Frame Check Sequence): This is a one byte field that is used to ensure packet
integrity. This field is computed as an XOR of all the bytes in the message starting with
LEN field and through the last byte of data. The receiver XORs all the received data
bytes as indicated above and then XORs the received FCS field. If the sum is not equal to
zero, the received packet is in error.

2.1.2 MT CMD
MT CMD is the actually Monitor and Test command. It contains information that Z-Tool
and Z-Stack need to control the target.
It contains 1 byte for the length of the actual data, 2 bytes for the command, and data
ranging from 0-250 bytes.

LEN CMD DATA

Byte: 1 2 0-250

LEN (Length): This one byte field is the number of bytes in the DATA field. If the
DATA field contains no information this LEN field has a value of 0 and the total length
of the MT CMD is 3 bytes (0 data message).

3 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

CMD (Command Id): This is a two byte field with a value denoting the Command
Identification (Id) for this message. This field is described in detail below.

CMD0 CMD1
Bit: 7-5 4-0 7-0
Type Subsystem Id

Type: Type for the command is described by bit 5, 6, 7 of CMD0 byte. The
command type has one of the following values:

Type CMD0Value
POLL 0x00
SREQ 0x20
AREQ 0x40
SRSP 0x60

0: POLL. A POLL command is used to retrieve queued data. This

command is only applicable to SPI transport. For a POLL command the
subsystem and Id are set to zero and data length is zero.
1: SREQ: A synchronous request that requires an immediate response. For
example, a function call with a return value would use an SREQ command.
2: AREQ: An asynchronous request. For example, a callback event or a
function call with no return value would use an AREQ command.
3: SRSP: A synchronous response. This type of command is only sent in
response to a SREQ command. For an SRSP command the subsystem and
Id are set to the same values as the corresponding SREQ. The length of an
SRSP is generally nonzero, so an SRSP with length=0 can be used to
indicate an error.
4-7: Reserved.

Subsystem: The subsystem of the command is described by bit 0, 1, 2, 3, 4

of CMD0. The command subsystem has one of the following values:

Subsystem Subsystem Value

Reserved 0x00
SYS interface 0x01
MAC interface 0x02
NWK interface 0x03
AF interface 0x04
ZDO interface 0x05
SAPI interface 0x06
UTIL interface 0x07
DEBUG interface 0x08
APP interface 0x09
APP config 0x0F
GreenPower 0x15

Id: The command Id. The Id maps to a particular interface message. Range: 0-
250.

4 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

DATA: This field contains the actual data to be transmitted. This is a field which varies
in size according to the command. It can be 0 to 250.

2.2 Example

SYS_PING command will look like 0xFE 0x00 0x21 0x01 0x20

SOF LEN CMD0 CMD1 DATA FCS

Byte: 1 1 1 1 0 1
0xFE 0x00 0x21 0x01 N/A 0x20

SYS_PING response will look like 0xFE 0x02 0x61 0x01 0x11 0x00 0x73

SOF LEN CMD0 CMD1 DATA0 DATA1 FCS

Byte: 1 1 1 1 1 1 1
0xFE 0x02 0x61 0x01 0x11 0x00 0x73

5 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

 Z-Stack Monitor and Test API SWRA198 Revision 1.14

3. Monitor and Test Commands

3.1 Introduction
Monitor and Test commands (MT commands) exchanged between the target and the tester via a
supported H/W medium (i.e.RS-232 or USB.) The tester controls the target using Z-Tool 2.0. In order
for the target to communicate with Z-Tool 2.0, Z-Stack must be compiled with MT_SYS_FUNC. This
enables the MT_SYS interface so Z-Tool 2.0 can communicate to establish the connection. Some MT
interfaces support callbacks. This requires MT_UTIL_FUNC to be compiled with Z-Stack in order for
the tester to subscribe callback. The corresponding MT interface must also be complied with the
correct flag in order for the callbacks to be received and processed correctly by Z-Stack and Z-Tool
2.0. For the complete details on MT flags, check section 1.2 or “Z-Stack Compile Option” document
(SWRA188).

Summary:
Z-Tool 2.0 installed and connected to target using the supported H/W interface.
Z-Stack must be compiled with MT_SYS_FUNC and MT_UTIL_FUNC.
Z-Stack must be compiled with MT interface what tester will use.
Z-Stack and Z-Tool must be set at the same baud rate, no Parity, 8 data-bits and 1
stop-bit for each byte.
If the target supports flow control, this must be set correctly as well in Z-Tool 2.0

3.2 MT_AF
This interface allows the tester to interact with the Application Framework layer (AF).

3.2.1 MT_AF Commands

3.2.1.1 AF_REGISTER
Description:
This command enables the tester to register an application’s endpoint description.

Usage:
SREQ:
1 1 1 1 2 2
Length = 0x09-0x49 Cmd0 = 0x24 Cmd1 = 0x00 EndPoint AppProfId AppDeviceId

1 1 1 0-32 1 0-32
AppDevVer LatencyReq AppNumInClusters AppInClusterList AppNumOutClusters AppOutClusterList

Attributes:
Attribute Length (byte) Description
EndPoint 1 Specifies the endpoint of the device
AppProfId 2 Specifies the profile Id of the application
AppDeviceId 2 Specifies the device description Id for this endpoint
AddDevVer 1 Specifies the device version number
Specifies latency.
0x00-No latency
LatencyReq 1
0x01-fast beacons
0x02-slow beacons
the number of Input cluster Id’s following in the
AppNumInClusters 1
AppInClusterList
AppInClusterList 32 Specifies the list of Input Cluster Id’s
Specifies the number of Output cluster Id’s following in the
AppNumOutClusters 1
AppOutClusterList
AppOutClusterList 32 Specifies the list of Output Cluster Id’s

6 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte:1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x00 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.2.1.2 AF_DATA_REQUEST
Description:
This command is used by the tester to build and send a message through AF layer.

Usage:
SREQ:
Byte: 1 1 1 2 1
Length = 0x0A-0x8A Cmd0 = 0x24 Cmd1 = 0x01 DstAddr DstEndpoint

Byte: 1 2 1 1 1 1 0-128
SrcEndpoint ClusterId TransId Options Radius Len Data

Attributes:
Attribute Length (byte) Description
DstAddr 2 Short address of the destination device
DstEndpoint 1 Endpoint of the destination device
SrcEndpoint 1 Endpoint of the source device
ClusterId 2 Specifies the cluster ID
TransId 1 Specifies the transaction sequence number of the message.
Transmit options bit mask according to the following defines
from AF.h: bit 1: sets ‘Wildcard Profile ID’; bit 4: turns on/off
Options 1
‘APS ACK’; bit 5 sets ‘discover route’; bit 6 sets ‘APS
security’; bit 7 sets ‘skip routing’.
Specifies the number of hops allowed delivering the message
Radius 1
(see AF_DEFAULT_RADIUS.)
Len 1 Length of the data.
Data 0-128 0-128 bytes data

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x01 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.2.1.3 AF_DATA_REQUEST_EXT
Description:
This extended form of the AF_DATA_REQUEST must be used to send an inter-pan message
(note that the target code must be compiled with the INTER_PAN flag defined.) This extended
data request must also be used when making a request with a huge data byte count which is
defined to be a size that would cause the RPC request to exceed the maximum allowed size:
MT_RPC_DATA_MAX – sizeof(AF_DATA_REQUEST_EXT)
Where sizeof(AF_DATA_REQUEST_EXT) counts everything but the data bytes and now stands at
20. When making an AF_DATA_REQUEST_EXT with a huge data byte count, the request shall
not contain any data bytes. The huge data buffer is sent over separately as a sequence of one or
more AF_DATA_STORE requests. Note that the outgoing huge message is timed-out in 15
seconds; thus all AF_DATA_STORE requests must be completed within 15 seconds of an

7 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

AF_DATA_REQUEST_EXT with a huge data byte count. And any AF_DATA_REQUEST_EXT

with a huge data byte count must be completed (or timed-out) before another will be started. The
default timeout can be changed by defining the following to other values:
#if !defined MT_AF_EXEC_CNT
#define MT_AF_EXEC_CNT 15
#endif
#if !defined MT_AF_EXEC_DLY
#define MT_AF_EXEC_DLY 1000
#endif

Usage:
SREQ:
1 1 1 1 8 1
Length = 0x14-0x93 Cmd0 = 0x24 Cmd1 = 0x02 DstAddrMode DstAddr DstEndpoint

2 1 2 1 1 1 2 0-128
DstPanId SrcEndpoint ClusterId TransId Options Radius Len Data

Attributes:
Attribute Length (byte) Description
A value of 3 (the enumeration value for ‘afAddr64Bit’) indicates 8-byte (64-bit)
DstAddrMode 1 address mode; otherwise a value of 2 indicates 2-byte (16-bit) address mode,
using only the 2 LSB’s of the DstAddr field to form a 2-byte short address.
LSB to MSB for the long or short address of the destination device (upper 6 bytes
DstAddr 8
are don’t care when short address.)
Endpoint of the destination device (but don’t care if the DstPanId is non-zero,
DstEndpoint 1
which indicates an inter-pan message.)
DstPanId 2 PanId of the destination device: 0x0000=Intra-Pan; otherwise, Inter-Pan.
SrcEndpoint 1 Endpoint of the source device.
ClusterId 2 Specifies the cluster ID
TransId 1 Specifies the transaction sequence number of the message.
Transmit options bit mask according to the following defines from AF.h: bit 1:
sets ‘Wildcard Profile ID’; bit 4: turns on/off ‘APS ACK’; bit 5 sets ‘discover
Options 1
route’; bit 6 sets ‘APS security’; bit 7 sets ‘skip routing’. (This doesn’t apply for
an inter-pan message.)
Specifies the number of hops allowed delivering the message (reference
Radius 1
DEF_NWK_RADIUS.)
Length of the data. If a large data length causes the MT command to exceed
MT_RPC_DATA_MAX, then zero bytes of the data shall be sent with this
Len 2
request and the data shall be transferred in as many MT_AF_DATA_STORE
requests as necessary.
Data 0-128 0-128 bytes data

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x02 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.2.1.4 AF_DATA_REQUEST_SRC_RTG
Description:
This command is used by the tester to build and send a message through AF layer using source
routing.

8 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1 2 1
Length = 0x0B-0xFA Cmd0 = 0x24 Cmd1 = 0x03 DstAddr DstEndpoint

Byte: 1 2 1 1 1 1 2N 1 0-128
SrcEndpoint ClusterId TransId Options Radius Relay Count (N) RelayList Len Data

Attributes:
Attribute Length (byte) Description
DstAddr 2 Short address of the destination device
DstEndpoint 1 Endpoint of the destination device
SrcEndpoint 1 Endpoint of the source device
ClusterId 2 Specifies the cluster ID
TransId 1 Specifies the transaction sequence number of the message.
Transmit options bit mask: Bit 0: turns on/off ‘APS ACK’; bit 2
Options 1
sets ‘APS security’; bit 3 sets ‘skip routing’.
Specifies the number of hops allowed delivering the message
Radius 1
(reference DEF_NWK_RADIUS.)
Specifies the number of devices in the relay list for source
Relay Count 1
routing
List of relay devices on the source routing path. For each
Relay List 2N
device, it contains 2 bytes short address for each device.
Len 1 Length of the data.
Data 0-128 0-128 bytes data

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x03 Status

Attributes:
Attribute Length (byte) Description
Status is either Success (0) or Memory
Status 1
Failure (0x01).

3.2.1.5 AF_INTER_PAN_CTL
Description:
Inter-Pan control command and data. The data content depends upon the command and the
available commands are enumerated as InterPanCtl_t.

Usage:
SREQ:
Byte: 1 1 1 1 0-3
Length = 0x01-0x04 Cmd0 = 0x24 Cmd1 = 0x10 Command Data

Data:
Data
Command Length Description
(byte)
Proxy call to StubAPS_SetIntraPanChannel() to switch channel back to
0: InterPanClr 0
the NIB-specified channel.
Proxy call to StubAPS_SetInterPanChannel() with the 1-byte channel
1: InterPanSet 1
specified.
If the 1-byte Endpoint specified by the data argument is found by
invoking afFindEndPointDesc(), then proxy a call to
2: InterPanReg 1
StubAPS_RegisterApp() with the pointer to the endPointDesc_t found
(i.e. the Endpoint must already be registered with AF).
Proxy a call to StubAPS_InterPan() with the 2-byte PanId (LSB:MSB)
3: InterPanChk 3
and 1-byte EndPoint data.

9 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x10 Status

Attributes:
Attribute Length (byte) Description
Success (0)
Failure (0x01) if a channel change is in progress
Status 1
Invalid_Parameter (0x02).
ZApsNotAllowed (0xBA) if MAC is not in an Idle state.

3.2.1.6 AF_ DATA_STORE

Description:
Huge AF data request data buffer store command and data.

Usage:
SREQ:
Byte: 1 1 1 2 1 0-252
Length = 0x03-0xFA Cmd0 = 0x24 Cmd1 = 0x11 Index Length Data

Attributes:
Length
Command Description
(byte)
Specifies the index into the outgoing data request data buffer to start the
Index 2
storing of this chunk of data.
Specifies the length of this data chunk to store.
Length 1 A length of zero is special and triggers the actually sending of the data
request OTA.
Data 0-252 Contains 0 to 252 bytes of data.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x11 AF-Status

Attributes:
Attribute Length (byte) Description
afStatus_SUCCESS 0x00
afStatus_FAILED 0x01
afStatus_MEM_FAIL 0x10
afStatus_INVALID_PARAMETER 0x02
Status 1
Note that the status is for storing a chunk
of data when Length is not zero and the
return value of the AF_DataRequest() when it
is zero.

3.2.1.7 AF_ DATA_RETRIEVE

Description:
Huge AF incoming message data buffer retrieve command.

Usage:
SREQ:
Byte: 1 1 1 4 2 1
Length = 0x07 Cmd0 = 0x24 Cmd1 = 0x12 Timestamp Index Length

Attributes:
Command Length Description
The timestamp of the incoming message in order to uniquely Identify it
Timestamp 4
in a queue of incoming huge messages.
Index 2 Specifies the index into the incoming message data buffer to start the

10 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

retrieving of this chunk of data.

Specifies the length of this data chunk to retrieve.
Length 1 A length of zero is special and triggers the freeing of the corresponding
incoming message.

SRSP:
Byte: 1 1 1 1 1 0-253
Length = 0x02-0xFA Cmd0 = 0x64 Cmd1 = 0x12 AF-Status Length Data

Attributes:
Attribute Length (byte) Description
afStatus_SUCCESS 0x00
afStatus_FAILED 0x01
Status 1
afStatus_MEM_FAIL 0x10
afStatus_INVALID_PARAMETER 0x02
Length 1 Specifies the length of this data chunk retrieved.
The length of data bytes requested from the specified index into the
Data 0-253
huge incoming message data buffer.

3.2.1.8 AF_APSF_CONFIG_SET
Description:
MT proxy for afAPSF_ConfigSet().

Usage:
SREQ:
Byte: 1 1 1 1 1 1
Length = 0x03 Cmd0 = 0x24 Cmd1 = 0x13 endPoint frameDelay windowSize

Attributes:
Command Length Description
endpoint 1 The specific EndPoint for which to set the fragmentation configuration.
The APS Fragmentation inter-frame delay in milliseconds (delay
frameDelay 1
between frame fragments within the window).
The APS Fragmentation window size (number of frames between APS
windowSize 1
acknowledge from receiving node).

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x64 Cmd1 = 0x13 AF-Status

Attributes:
Attribute Length (byte) Description
afStatus_SUCCESS 0x00
Status 1
afStatus_INVALID_PARAMETER 0x02

3.2.2 MT_AF Callbacks

3.2.1.1 AF_DATA_CONFIRM
Description:
This command is sent by the device to the user after it receives a data request.

Usage:
AREQ:
Byte: 1 1 1 1 1 1
Length = 0x03 Cmd0 = 0x44 Cmd1 = 0x80 Status Endpoint TransId

11 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).
Endpoint 1 Endpoint of the device
TransId 1 Specified the transaction sequence number of the message

3.2.1.2 AF_REFLECT_ERROR
Description:
This command is sent by the device to the user when it determines that an error occurred during a
reflected message.

Usage:
AREQ:
Byte: 1 1 1 1 1 1
Length = 0x06 Cmd0 = 0x44 Cmd1 = 0x83 Status Endpoint TransId
1 2
dstAddrMode dstAddr
Attributes:
Attribute Length (byte) Description
Status 1 Contains the error indication (ie. ZApsNoAck)
Endpoint 1 Endpoint of the device
TransId 1 Specified the transaction sequence number of the message
dstAddrMode 1 Destination address type: 0 - short address, 1 - group address
dstAddr 2 Destination address - depends on dstAddrMode

3.2.1.3 AF_INCOMING_MSG
Description:
This callback message is in response to incoming data to any of the registered endpoints on this
device.

Usage:
AREQ:
1 1 1 2 2 2 1
Length = 0x11-0x91 Cmd0 = 0x44 Cmd1 = 0x81 GroupId ClusterId SrcAddr SrcEndpoint

1 1 1 1 4 1 1 0-128
DstEndpoint WasBroadcast LinkQuality SecurityUse Timestamp TransSeqNumber Len Data

Attributes:
Attribute Length (byte) Description
GroupId 2 Specifies the group ID of the device
ClusterId 2 Specifies the cluster Id (only the LSB is used in V1.0 networks.)
Specifies the ZigBee network address of the source device sending the
SrcAddr 2
message.
SrcEndpoint 1 Specifies the source endpoint of the message
DstEndpoint 1 Specifies the destination endpoint of the message
WasBroadcast 1 Specifies if the message was a broadcast or not
LinkQuality 1 Indicates the link quality measured during reception
SecurityUse 1 Specifies if the security is used or not
TimeStamp 4 Specifies the timestamp of the message
TransSeqNumber 1 Specifies transaction sequence number of the message
Len 1 Specifies the length of the data.
Data 0-128 Contains 0 to 128 bytes of data.

3.2.1.4 AF_INCOMING_MSG_EXT
Description:
This callback message is in response to incoming data to any of the registered endpoints on this
device when the code is compiled with the INTER_PAN flag defined. This extended incoming

12 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

message indication must also be used when handling an incoming message with a huge data byte
count which is defined to be a size that would cause the RPC request to exceed the maximum
allowed size:
MT_RPC_DATA_MAX – sizeof(AF_INCOMING_MSG_EXT)
Where sizeof(AF_ INCOMING_MSG _EXT) counts everything but the data bytes and now
stands at 27. An AF_INCOMING_MSG_EXT with a huge data byte count indication shall not
contain any data bytes. The huge data buffer must be retrieved separately as a sequence of one or
more AF_DATA_RETRIEVE requests. Note that the incoming huge message is timed-out in 15
seconds after receiving it; thus all AF_DATA_ RETRIEVE requests must be completed within 15
seconds of an AF_ INCOMING_MSG _EXT with a huge data byte count. Note that multiple
AF_INCOMING_MSG_EXT indications with huge data byte counts may be queued, and each
will be timed-out separately. The default timeout can be changed by defining the following to
other values:
#if !defined MT_AF_EXEC_CNT
#define MT_AF_EXEC_CNT 15
#endif
#if !defined MT_AF_EXEC_DLY
#define MT_AF_EXEC_DLY 1000
#endif

Usage:
AREQ:
1 1 1 2 2 1 8 1
SrcAddr
Length = 0x1B-0x9A Cmd0 = 0x44 Cmd1 = 0x82 GroupId ClusterId SrcAddr SrcEndpoint
Mode

2 1 1 1 1 4 1 1 0-128
SrcPanId DstEndpoint WasBroadcast LinkQuality SecurityUse Timestamp TransSeqNumber Len Data

Attributes:
Attribute Length (byte) Description
GroupId 2 Specifies the group ID of the device
ClusterId 2 Specifies the cluster Id (only the LSB is used in V1.0 networks.)
A value of 3 (i.e. the enumeration value for ‘afAddr64Bit’) indicates 8-
SrcAddrMode 1 byte/64-bit address mode; otherwise, only the 2 LSB’s of the 8 bytes are
used to form a 2-byte short address.
LSB to MSB for the long or short address of the destination device (upper 6
SrcAddr 8
bytes are don’t care when short address.)
SrcEndpoint 1 Specifies the source endpoint of the message
SrcPanId 2 Specifies the source PanID of the message.
DstEndpoint 1 Specifies the destination endpoint of the message
WasBroadcast 1 Specifies if the message was a broadcast or not
LinkQuality 1 Indicates the link quality measured during reception
SecurityUse 1 Specifies if the security is used or not
TimeStamp 4 Specifies the timestamp of the message
TransSeqNumber 1 Specifies transaction sequence number of the message
Specifies the length of the data. If a large data length causes the MT
command to exceed MT_RPC_DATA_MAX, then zero bytes of the data
Len 2
shall be sent with this request and the host shall retrieve the data with as
many MT_AF_DATA_RETRIEVE requests as necessary.
Data 0-128 Contains 0 to 128 bytes of data.

3.3 MT_APP
This interface allows tester to interact with APP layer of the target to control custom tests such as test
profile or user-defined test.

13 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.3.1 MT_APP Commands

3.3.1.1 APP_MSG
Description:
This command is sent to the target in order to test the functions defined for individual applications.
This command sends a raw data to an application.

Usage:
SREQ:
Byte: 1 1 1 1 2
Length = 0x07-0x87 Cmd0 = 0x29 Cmd1 = 0x00 AppEndpoint DestAddress

1 2 1 0-128
DestEndpoint ClusterId MsgLen Message

Attributes:
Attribute Length (byte) Description
AppEndpoint 1 Application endpoint of the outgoing message
DestAddress 2 Destination address of the outgoing message
DestEndpoint 1 Destination endpoint of the outgoing message
ClusterId 2 Cluster Id of the outgoing message
MsgLen 1 Length of the outgoing message
Message 0-128 Raw data packet to send to the application

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x69 Cmd1 = 0x00 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.3.1.2 APP_USER_TEST
Description:
This command is used by tester to issue user’s defined commands to the application.

Usage:
SREQ:
Byte: 1 1 1 1 2 2 2
Length = 0x07 Cmd0 = 0x29 Cmd1 = 0x01 SrcEP CommandId Parameter1 Parameter2

Attributes:
Attribute Length (byte) Description
SrcEP 1 Source Endpoint of the user-defined command
CommandId 2 Command Id of the user-defined command
Parameter1 2 Parameter #1 of the command
Parameter2 2 Parameter #2 of the command

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x69 Cmd1 = 0x01 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

14 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.3.2 MT_APP Callbacks

NONE

3.4 MT_DEBUG
This interface allows tester to control the debug-messaging mechanism such as debug threshold, debug
messages, etc.

3.4.1 MT_DEBUG Commands

3.4.1.1 DEBUG_SET_THRESHOLD
Description:
This command allows the user to set the threshold for the debug message.

Usage:
SREQ:
Byte: 1 1 1 1 1
Length = 0x03 Cmd0 = 0x28 Cmd1 = 0x00 ComponentId Threshold

Attributes:
Attribute Length (byte) Description
ComponentId 1 Uniquely Identifies a particular software component on the target
Specifies the threshold value for reporting debug messages by
Threshold 1
that software component

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x68 Cmd1 = 0x00 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.4.1.2 DEBUG_MSG
Description:
This command sends a debug string to Z-Tool. The content of the string is defined by the
application.

Usage:
AREQ:
Byte: 1 1 1 1 0-254
Length = 0x01-0xFA Cmd0 = 0x48 Cmd1 = 0x00 Length String

Attributes:
Attribute Length (byte) Description
Length 1 Length of the string
String 0-254 String to be displayed by Z-Tool 2.0

3.4.2 MT_DEBUG Callbacks

NONE

15 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.5 MT_MAC
This interface allows tester to interact with the TI-MAC

3.5.1 MT_MAC Commands

3.5.1.1 MAC_RESET_REQ

Description:
This command is used to send a MAC Reset command to reset MAC state machine.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x02 Cmd0 = 0x22 Cmd1 = 0x01 SetDefault

Attributes:
Attribute Length (byte) Description
SetDefault 1 TRUE – Set the MAC PIB values to default values.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x00 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.2 MAC_INIT

Description:
This command is used to initialize the MAC.

Usage:
SREQ:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x22 Cmd1 = 0x02

Attributes:
None
SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x02 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.3 MAC_START_REQ

Description:
This command is used to start the MAC as a coordinator or end device.

Usage:

16 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SREQ:
Byte: 1 1 1 4 2 1 1
Length = 0x1C Cmd0 = 0x22 Cmd1 = 0x03 StartTime PanId LogicalChannel ChannelPage

Byte: 1 1 1 1 1 8
BeaconOrder SuperFrameOrder PanCoordinator BatteryLifeExt CoordRealignment RealignKeySource

Byte: 1 1 1 8 1
RealignSecurityLevel RealignKeyIdMode RealignKeyIndex BeaconKeySource BeaconSecurityLevel

Byte: 1 1
BeaconKeyIdMode BeaconKeyIndex

Attributes:
Attribute Length (byte) Description
StartTime 4 The time to begin transmitting beacons relative to the received beacon
PanId 2 The PAN Id to use. This parameter is ignored if Pan Coordinator is FALSE
The logical channel to use. This parameter is ignored if Pan Coordinator is
LogicalChannel 1
FALSE
ChannelPage 1 The channel page to use. This parameter is ignored if Pan Coordinator is FALSE
BeaconOrder 1 The exponent used to calculate the beacon interval
SuperFrameOrder 1 The exponent used to calculate the superframe duration
PanCoordinator 1 Set to TRUE to start a network as PAN coordinator
If this value is TRUE, the receiver is disabled after
BatteryLifeExt 1 MAC_BATT_LIFE_EXT_PERIODS full backoff periods following the
interframe spacing period of the beacon frame
CoordRealignment 1 Coordinator Realignment
RealignKeySource 8 Key Source of this data frame

Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
RealignSecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value
NOT_USED 0x00
RealignKeyIdMode 1
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03
RealignKeyIndex 1 Key Index of this data frame
BeaconKeySource 8 Key Source of this data frame
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
BeaconSecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07
BeaconKeyIdMode 1 Key Id Mode of this data frame
BeaconKeyIndex 1 Key Index of this data frame

17 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x03 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.4 MAC_SYNC_REQ

Description:
This command is used to request synchronization to the current network beacon

Usage:
SREQ:
Byte: 1 1 1 1 1 1
Length = 0x03 Cmd0 = 0x22 Cmd1 = 0x04 LogicalChannel ChannelPage TrackBeacon

Attributes:
Attribute Length (byte) Description
LogicalChannel 1 The logical channel to use.
ChannelPage 1 The channel page to use.
Set to TRUE to continue tracking beacons after synchronizing with the first
TrackBeacon 1
beacon. Set to FALSE to only synchronize with the first beacon

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x04 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.5 MAC_DATA_REQ

Description:
This command is used to send (on behalf of the next higher layer) MAC Data Frame packet.

Usage:
SREQ:
Byte: 1 1 1 1 8 2
Length = 0x15-0x114 Cmd0 = 0x22 Cmd1 = 0x05 DestAddressMode DestAddress DestPanId

Byte: 1 1 1 1 1 8 1 1
SrcAddressMode Handle TxOption LogicalChannel Power KeySource SecurityLevel KeyIdMode

Byte: 1 1 0-250
KeyIndex MSDULength MSDU

Attributes:
Length
Attribute Description
(byte)

18 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Specifies the format of the destination address.

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
DestAddressMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
DestAddress 8 Address of the destination.
DestPanId 2 PAN Id of the destination.
Specifies the format of the source address.

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
SrcAddressMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
Handle 1 Handle of the packet.
Transmitting options:

Option Value Description

Acknowledged transmission.
The MAC will attempt to
MAC_TXOPTION_ACK 0x01
retransmit the frame until it is
acknowledged
MAC_TXOPTION_GTS 0x02 GTS transmission (unused)
Indirect transmission. The
MAC will queue the data and
wait for the destination
MAC_TXOPTION_INDIRECT 0x04
device to poll for it. This can
only be used by a coordinator
device
TxOption 1
This proprietary option
MAC_TXOPTION_NO_RETRANS 0x10 prevents the frame from
being retransmitted
This proprietary option
prevents a
MAC_TXOPTION_NO_CNF 0x20 MAC_MCPS_DATA_CNF
event from being sent for this
frame
Use PIB value
MAC_TXOPTION_ALT_BE 0x40 MAC_ALT_BE for the
minimum backoff exponent
Use the power and channel
MAC_TXOPTION_PWR_CHAN 0x80 values in macDataReq_t
instead of the PIB values
LogicalChannel 1 Channel that data frame will be transmitted.
Power 1 Power level that data frame will be transmitted.
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

19 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

MSDULength 1 Length of the data.
MSDU 0-250 Actual data that will be sent.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x05 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.6 MAC_ASSOCIATE_REQ

Description:
This command is used to request (on behalf of the next higher layer) an association with a
coordinator

Usage:
SREQ:
Byte: 1 1 1 1 1 1
Length = 0x12 Cmd0 = 0x22 Cmd1 = 0x06 LogicalChannel ChannelPage CoordAddressMode

Byte: 8 2 1 8 1 1 1
CoordAddress CoordPanId CapabilityInformation KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Length
Attribute Description
(byte)
LogicalChannel 1 Channel that data frame will be transmitted.
ChannelPage 1 The channel page to be used.
Specifies the format of the coordinator address.

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
CoordAddressMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
CoordAddress 8 Address of the Coordinator.
CoordPanId 2 PAN Id of the coordinator.
Bit map which specifies the operational capabilities of the device.

Bit: 0 – Alternate PAN Coordinator

1 – Device type: 1- ZigBee Router; 0 – End Device
2 – Power Source: 1 Main powered
CapabilityInformation 1 3 – Receiver on when Idle
4 – Reserved
5 – Reserved
6 – Security capability
7 – Reserved

KeySource 8 Key Source of this data frame

20 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x06 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.7 MAC_ASSOCIATE_RSP

Description:
This command is sent by the host to response to the MAC_ASSOCIATE_IND.

Usage:
SREQ:
Byte: 1 1 1 8 2 1
Length = 0x0B Cmd0 = 0x42 Cmd1 = 0x50 ExtAddr AssocShortAddress AssocStatus

Attributes:
Attribute Length (byte) Description
ExtAddr 8 Extended Address of the device requesting association
AssocShortAddress 2 Short address for the associated device. Allocated by the coordinator.
Status of the association:

Status Value
AssocStatus 1
SUCCESSFUL_ASSOCIATION 0x00
PAN_AT_CAPACITY 0x01
PAN_ACCESS_DENIED 0x02

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x50 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

21 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.5.1.8 MAC_DISASSOCIATE_REQ

Description:
This command is used to request (on behalf of the next higher layer) a disassociation of the device
from the coordinator.

Usage:
SREQ:
Byte: 1 1 1 1 8 2
Length = 0x18 Cmd0 = 0x22 Cmd1 = 0x07 DeviceAddressMode DeviceAddress DevicePanId

Byte: 1 1 8 1 1 1
DisassociateReason TxIndirect KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description
Specifies the format of the device address.

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
DeviceAddressMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
DeviceAddress 8 Device Address.
DevicePanId 2 Network PAN Id of device.

Reason of disassociation:

Reason Value
DisassociateReason 1
RESERVED 0x00
COOR_WISHES_DEV_LEAVE 0x01
DEV_WISHES_LEAVE 0x02

TxIndirect 1 Tx indirect
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

22 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x07 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.9 MAC_GET_REQ

Description:
This command is used to read (on behalf of the next higher layer) a MAC PIB attribute.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x22 Cmd1 = 0x08 Attribute

Attributes:
Attribute Length (byte) Description

Specifies the MAC PIB Attributes:

MAC PIB Attribute Value

ZMAC_ACK_WAIT_DURATION 0x40
ZMAC_ASSOCIATION_PERMIT 0x41
ZMAC_AUTO_REQUEST 0x42
ZMAC_BATT_LIFE_EXT 0x43
ZMAC_BATT_LEFT_EXT_PERIODS 0x44
ZMAC_BEACON_MSDU 0x45
ZMAC_BEACON_MSDU_LENGTH 0x46
ZMAC_BEACON_ORDER 0x47
ZMAC_BEACON_TX_TIME 0x48
ZMAC_BSN 0x49
ZMAC_COORD_EXTENDED_ADDRESS 0x4A
ZMAC_COORD_SHORT_ADDRESS 0x4B
ZMAC_DSN 0x4C
ZMAC_GTS_PERMIT 0x4D
ZMAC_MAX_CSMA_BACKOFFS 0x4E
Attribute 1 ZMAC_MIN_BE 0x4F
ZMAC_PANID 0x50
ZMAC_PROMISCUOUS_MODE 0x51
ZMAC_RX_ON_IDLE 0x52
ZMAC_SHORT_ADDRESS 0x53
ZMAC_SUPERFRAME_ORDER 0x54
ZMAC_TRANSACTION_PERSISTENCE_TIME 0x55
ZMAC_ASSOCIATED_PAN_COORD 0x56
ZMAC_MAX_BE 0x57
ZMAC_FRAME_TOTAL_WAIT_TIME 0x58
ZMAC__MAC_FRAME_RETRIES 0x59
ZMAC_RESPONSE_WAIT_TIME 0x5A
ZMAC_SYNC_SYMBOL_OFFSET 0x5B
ZMAC_TIMESTAMP_SUPPORTED 0x5C
ZMAC_SECURITY_ENABLED 0x5D
ZMAC_PHY_TRANSMIT_POWER 0xE0
ZMAC_LOGICAL_CHANNEL 0xE1
ZMAC_EXTENDED_ADDRESS 0xE2
ZMAC_ALT_BE 0xE3

23 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1 16
Length = 0x11 Cmd0 = 0x62 Cmd1 = 0x08 Status Data

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).
Data 16 1-16 bytes value of the PIB attribute.

3.5.1.10 MAC_SET_REQ

Description:
This command is used to request the device to write a MAC PIB value.

Usage:
SREQ:
Byte: 1 1 1 1 16
Length = 0x11 Cmd0 = 0x22 Cmd1 = 0x09 Attribute AttributeValue

Attributes:
Length
Attribute Description
(byte)

Specified the MAC PIB Attribute:

MAC PIB Attribute Value

ZMAC_ACK_WAIT_DURATION 0x40
ZMAC_ASSOCIATION_PERMIT 0x41
ZMAC_AUTO_REQUEST 0x42
ZMAC_BATT_LIFE_EXT 0x43
ZMAC_BATT_LEFT_EXT_PERIODS 0x44
ZMAC_BEACON_MSDU 0x45
ZMAC_BEACON_MSDU_LENGTH 0x46
ZMAC_BEACON_ORDER 0x47
ZMAC_BEACON_TX_TIME 0x48
ZMAC_BSN 0x49
ZMAC_COORD_EXTENDED_ADDRESS 0x4A
ZMAC_COORD_SHORT_ADDRESS 0x4B
ZMAC_DSN 0x4C
ZMAC_GTS_PERMIT 0x4D
ZMAC_MAX_CSMA_BACKOFFS 0x4E
Attribute 1 ZMAC_MIN_BE 0x4F
ZMAC_PANID 0x50
ZMAC_PROMISCUOUS_MODE 0x51
ZMAC_RX_ON_IDLE 0x52
ZMAC_SHORT_ADDRESS 0x53
ZMAC_SUPERFRAME_ORDER 0x54
ZMAC_TRANSACTION_PERSISTENCE_TIME 0x55
ZMAC_ASSOCIATED_PAN_COORD 0x56
ZMAC_MAX_BE 0x57
ZMAC_FRAME_TOTAL_WAIT_TIME 0x58
ZMAC__MAC_FRAME_RETRIES 0x59
ZMAC_RESPONSE_WAIT_TIME 0x5A
ZMAC_SYNC_SYMBOL_OFFSET 0x5B
ZMAC_TIMESTAMP_SUPPORTED 0x5C
ZMAC_SECURITY_ENABLED 0x5D
ZMAC_PHY_TRANSMIT_POWER 0xE0
ZMAC_LOGICAL_CHANNEL 0xE1
ZMAC_EXTENDED_ADDRESS 0xE2
ZMAC_ALT_BE 0xE3

AttributeValue 16 1-16 bytes of the PIB attribute value.

24 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x09 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.11 MAC_SCAN_REQ

Description:
This command is used to send a request to the device to perform a network scan.

Usage:
SREQ:
Byte: 1 1 1 4 1 1
Length = 0x13 Cmd0 = 0x22 Cmd1 = 0x0C ScanChannels ScanType ScanDuration

Byte: 1 1 8 1 1 1
ChannelPage MaxResults KeySource SecurityLevel KeyIdMode KeyIndex
Attributes:
Attribute Length (byte) Description

This represents a bit-mask of channels to be scanned when starting the device:

Channel Value
NONE 0x00000000
ALL_CHANNELS 0x07FFF800
CHANNEL 11 0x00000800
CHANNEL 12 0x00001000
CHANNEL 13 0x00002000
CHANNEL 14 0x00004000
CHANNEL 15 0x00008000
ScanChannels 4 CHANNEL 16 0x00010000
CHANNEL 17 0x00020000
CHANNEL 18 0x00040000
CHANNEL 19 0x00080000
CHANNEL 20 0x00100000
CHANNEL 21 0x00200000
CHANNEL 22 0x00400000
CHANNEL 23 0x00800000
CHANNEL 24 0x01000000
CHANNEL 25 0x02000000
CHANNEL 26 0x04000000

Specifies the scan type:

Scan Type Value
ScanType 1 ENERGY_DETECT 0x00
ACTIVE 0x01
PASSIVE 0x02
ORPHAN 0x03

ScanDuration 1 Duration of the scan - The exponent used in the scan duration calculation.
ChannelPage 1 The channel page on which to perform the scan.
KeySource 8 Key Source of this data frame.

25 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x0C Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.12 MAC_ORPHAN_RSP

Description:
This command is sent by the host to response to the ORPHAN_IND.

Usage:
SREQ:
Byte: 1 1 1 8 2 1
Length = 0x0B Cmd0 = 0x42 Cmd1 = 0x51 ExtAddr AssocShortAddress AssociatedMember

Attributes:
Attribute Length (byte) Description
ExtAddr 8 Extended Address of the device sending the orphan notification
AssocShortAddress 2 Short address of the orphan device
AssociatedMember 1 TRUE if the orphan is an associated member. FALSE otherwise.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x51 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.13 MAC_POLL_REQ

Description:
This command is used to send a MAC data request poll.

26 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1 1 8 2
Length = 0x16 Cmd0 = 0x22 Cmd1 = 0x0D CoordAddressMode CoordAddress CoordPanId

8 1 1 1
KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
GROUP_ADDRESS 0x01 Group address
CoordAddressMode 1
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast

CoordAddress 8 64-bit Coordinator Address

CoordPanId 2 Coordinator PanId
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x0D Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.14 MAC_PURGE_REQ

Description:
This command is used to send a request to the device to purge a data frame

27 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x22 Cmd1 = 0x0E MsduHandle

Attributes:
Attribute Length (byte) Description
MsduHandle 1 Msdu Handle

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x0E Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.1.15 MAC_SET_RX_GAIN_REQ

Description:
This command is used to send a request to the device to set Rx gain.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x22 Cmd1 = 0x0F Mode

Attributes:
Attribute Length (byte) Description
Mode 1 PA/PNA mode – TRUE/FALSE

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x62 Cmd1 = 0x0F Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.5.2 MT_MAC Callbacks

3.5.2.1 MAC_SYNC_LOSS_IND
Description:
This callback is called by the MAC to send (on behalf of the next higher layer) an indication of the
synchronization loss.

Usage:
AREQ:
1 1 1 1 2 1 1
Length = 0x10 Cmd0 = 0x42 Cmd1 = 0x80 Status PanId LogicalChannel ChannelPage

8 1 1 1
KeySource SecurityLevel KeyIdMode KeyIndex

28 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
PanId 2 PAN Id of the device
LogicalChannel 1 Logical Channel of the device where the synchronization is lost
ChannelPage 1 Channel Page of the device where the synchronization is lost
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

3.5.2.2 MAC_ASSOCIATE_IND
Description:
This callback is called by the MAC to send (on behalf of the next higher layer) an association
indication message.

Usage:
AREQ:
1 1 1 8 1
Length = 0x14 Cmd0 = 0x42 Cmd1 = 0x81 DeviceExtendedAddress Capabilities

8 1 1 1
KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description
DeviceExtendedAddress 8 Extended address of the device
Specifies the operating capabilities of the device being directly joined.
Bit weighted values follow:
Bit: 0 – Alternate PAN Coordinator
1 – Device type: 1- ZigBee Router; 0 – End Device
2 – Power Source: 1 Main powered
Capabilities 1
3 – Receiver on when Idle
4 – Reserved
5 – Reserved
6 – Security capability
7 – Reserved
KeySource 8 Key Source of this data frame.

29 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

3.5.2.3 MAC_ASSOCIATE_CNF
Description:
This callback is called by the MAC to send (on behalf of the next higher layer) an association
confirmation message.

Usage:
AREQ:
1 1 1 1 2
Length = 0x0E Cmd0 = 0x42 Cmd1 = 0x82 Status DeviceShortAddress

8 1 1 1
KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
DeviceShortAddress 2 Short address of the device
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

30 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

3.5.2.4 MAC_BEACON_NOTIFY_IND

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC beacon
notify indication.

Usage:
AREQ:
1 1 1 1 4 1
Length = 0x24-0xBC Cmd0 = 0x42 Cmd1 = 0x83 BSN Timestamp CoordinatorAddressMode

8 2 2 1 1 1
CoordinatorExtendedAddress PanId SuperframeSpec LogicalChannel GTSPermit LinkQuality

1 8 1 1 1 1
SecurityFailure KeySource SecurityLevel KeyIdMode KeyIndex PendingAddrSpec
1 1 0-128
AddressList SDULength NSDU

Attributes:
Length
Attribute Description
(byte)
BSN 1 BSN
Timestamp 4 Timestamp of the message
Address mode of the coordinator
Mode Value Description
ADDRESS_NOT_PRESENT 0x00 Address Not Present
CoordinatorAddressMode 1 GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast

CoordinatorExtendedAddress 8 Extended address of the coordinator

PanId 2 Pan Id of the device
SuperframeSpec 2
LogicalChannel 1 Current logical channel
GTSPermit 1 TRUE/FALSE - Permit/Not permit GTS
LinkQuality 1 Link quality of the message
SecurityFailure 1
KeySource 8 Key Source of this data frame.

31 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

PendingAddrSpec 1
AddressList 1 List of address associate with the device
SDULength 1 Beacon Length
NSDU 0-128 Beacon payload

3.5.2.5 MAC_DATA_CNF

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC data
confirmation.

Usage:
AREQ:
1 1 1 1 1 4 2
Length = 0x08 Cmd0 = 0x42 Cmd1 = 0x84 Status Handle Timestamp Timestamp2

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
Handle 1 Handle of the message
Timestamp 4 64bit timestamp of the message
Timestamp2 2 16bit timestamp of the message

3.5.2.6 MAC_DATA_IND

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC data
indication.

Usage:
AREQ:
1 1 1 1 8 1 8
Length = 0x2C-0xAC Cmd0 = 0x42 Cmd1 = 0x85 SrcAddrMode SrcAddr DstAddrMode DstAddr

4 2 2 2 2 1 1 1
Timestamp Timestamp2 SrcPanId SrcPanId DstPanId LinkQuality Correlation RSSI

32 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

1 8 1 1 1 1 0-128
DSN KeySource SecurityLevel KeyIdMode KeyIndex Length Data

Attributes:
Attribute Length (byte) Description
Source address mode
Mode Value Description
ADDRESS_NOT_PRESENT 0x00 Address Not Present
SrcAddrMode 1 GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast

SrcAddr 8 Source address

DstAddrMode 1 Destination address mode
DstAddr 8 Destination address
Timestamp 4 32bit timestamp of the message
Timestamp2 2 16bit timestamp of the message
SrcPanId 2 Pan Id of the source address
DstPanId 2 Pan Id of the destination address
LinkQuality 1 Link quality
Correlation 1 Correlation
RSSI 1 RSSI
DSN 1 DSN
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03
KeyIndex 1 Key Index of this data frame.
Length 1 Data length
Data 0-128 Data

3.5.2.7 MAC_DISASSOCIATE_IND

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC
disassociation indication.

Usage:
AREQ:
1 1 1 8 1 8
Length = 0x14 Cmd0 = 0x42 Cmd1 = 0x86 ExtendedAddress DisassociateReason KeySource

33 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

1 1 1
SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description
ExtendedAddress 8 Extended address of the device leaving the network

Reason of the disassociation:

DisassociateReason 1 Reason Value

Coordinator wishes the device to disassociate 0x01
Device itself wishes to disassociate 0x02

KeySource 8 Key Source of this data frame.

Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

3.5.2.8 MAC_DISASSOCIATE_CNF

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC
disassociate confirm.

Usage:
AREQ:
1 1 1 1 1 8 2
Length = 0x0C Cmd0 = 0x42 Cmd1 = 0x87 Status DeviceAddrMode DeviceAddr DevicePanId

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
Address mode of the device
Mode Value Description
ADDRESS_NOT_PRESENT 0x00 Address Not Present
DeviceAddrMode 1 GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
DeviceAddr 8 Address of the device
DevicePanId 2 Pan Id of the device

34 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.5.2.9 MAC_ORPHAN_IND

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC orphan
indication.

Usage:
AREQ:
1 1 1 8
Length = 0x13 Cmd0 = 0x42 Cmd1 = 0x8A ExtendedAddr

8 1 1 1
KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description
ExtendedAddr 8 Extended address of the orphan device
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

3.5.2.10 MAC_POLL_CNF
Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC poll
confirmation.

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x42 Cmd1 = 0x8B Status

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

35 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.5.2.11 MAC_SCAN_CNF

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC scan
confirmation.

Usage:
AREQ:
1 1 1 1 1 1 1
Length = 0x0A-0x8A Cmd0 = 0x42 Cmd1 = 0x8C Status ED ScanType ChannelPage

4 1 1 0-128
UnscannedChannelList ResultListCount ResultListMaxLength ResultList

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
ED 1 ED max energy.
Specifies the scan type:
Scan Type Value
ScanType 1 ENERGY_DETECT 0x00
ACTIVE 0x01
PASSIVE 0x02
ORPHAN 0x03
ChannelPage 1 Channel Page
UnscannedChannelList 4 List of un-scanned channels
ResultListCount 1 Number of item in the result list
ResultListMaxLength 1 Max length of the result list in bytes
ResultList 0-128 Result list

3.5.2.12 MAC_COMM_STATUS_IND
Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC
communication indicator.

Usage:
AREQ:
1 1 1 1 8 1 8
Length = 0x24 Cmd0 = 0x42 Cmd1 = 0x8D Status SrcAddr DstAddrMode DstAddr

4 2 1 8 1 1 1
Timestamp DevicePanId Reason KeySource SecurityLevel KeyIdMode KeyIndex

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
Destination address mode
Mode Value Description
ADDRESS_NOT_PRESENT 0x00 Address Not Present
DstAddrMode 1 GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
SrcAddr 8 Source address
DstAddr 8 Destination address

36 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Timestamp 4 Timestamp of the message

DevicePanId 2 Pan Id of the device that generate the indication
Reason 1 Reason for this communication indication.
KeySource 8 Key Source of this data frame.
Security Level of this data frame:

Security Level Value

NO_SECURITY 0x00
MIC_32_AUTH 0x01
SecurityLevel 1 MIC_64_AUTH 0x02
MIC_128_AUTH 0x03
AES_ENCRYPTION 0x04
AES_ENCRYPTION_MIC_32 0x05
AES_ENCRYPTION_MIC_64 0x06
AES_ENCRYPTION_MIC_128 0x07

Key Id Mode of this data frame:

Key Id Mode Value

KeyIdMode 1 NOT_USED 0x00
KEY_1BYTE_INDEX 0x01
KEY_4BYTE_INDEX 0x02
KEY_8BYTE_INDEX 0x03

KeyIndex 1 Key Index of this data frame.

3.5.2.13 MAC_START_CNF

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC start
confirmation.

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x42 Cmd1 = 0x8E Status

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.5.2.14 MAC_RX_ENABLE_CNF

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC Rx enable
confirmation.

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x42 Cmd1 = 0x8F Status

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

37 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.5.2.15 MAC_PURGE_CNF

Description:
This callback is called by the MAC to send (on behalf of the next higher layer) a MAC purge
confirmation.

Usage:
AREQ:
1 1 1 1 1
Length = 0x01 Cmd0 = 0x42 Cmd1 = 0x9A Status Handle

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
Handle 1 Handle of this message

3.6 MT_NWK
Not supported.

3.7 MT_SAPI
This interface allows tester to interact with the simple API interface.

3.7.1 MT_SAPI Commands

3.7.1.1 ZB_SYSTEM_RESET
Description:
This command will reset the device by using a soft reset (i.e. a jump to the reset vector) vice a
hardware reset (i.e. watchdog reset.) This is especially useful in the CC2531, for instance, so that
the USB host does not have to contend with the USB H/W resetting (and thus causing the USB
host to re-enumerate the device which can cause an open virtual serial port to hang.)

Usage:
AREQ:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x46 Cmd1 = 0x09

Attributes:
None

3.7.1.2 ZB_START_REQUEST

Description:
This command starts the ZigBee stack. When the ZigBee stack starts, the device reads
configuration parameters from nonvolatile memory and the device joins its network. The ZigBee
stack calls the zb_StartConfirm callback function when the startup process completes. After the
start request process completes, the device is ready to send, receive, and route network traffic.

38 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x26 Cmd1 = 0x00

Attributes:
None

SRSP:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x66 Cmd1 = 0x00

Attributes:
None

3.7.1.3 ZB_PERMIT_JOINING_REQUEST

Description:
This command is used to control the joining permissions and thus allows or disallows new devices
from joining the network.

Usage:
SREQ:
Byte: 1 1 1 2 1
Length = 0x03 Cmd0 = 0x26 Cmd1 = 0x08 Destination Timeout

Attributes:
Attribute Length (byte) Description
The destination parameter indicates the address of the device for which the
joining permissions should be set. This is usually the local device address or
Destination 2 the special broadcast address that denotes all routers and coordinator
(0xFFFC). This way the joining permissions of a single device or the whole
network can be controlled.
Indicates the amount of time in seconds for which the joining permissions
should be turned on. If timeout is set to 0x00, the device will turn off the
Timeout 1
joining permissions indefinitely. If it is set to 0xFF, the joining permissions
will be turned on indefinitely.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x66 Cmd1 = 0x08 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.7.1.4 ZB_BIND_DEVICE

Description:
This command establishes or removes a ‘binding’ between two devices. Once bound, an
application can send messages to a device by referencing the commandId for the binding.

Usage:
SREQ:
1 1 1 1 2 8
Length = 0x0B Cmd0 = 0x26 Cmd1 = 0x01 Create CommandId Destination

39 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Create 1 TRUE to create a binding, FALSE to remove a binding.
CommandId 2 The Identifier of the binding
Destination 8 Specifies the 64-bit IEEE address of the device to bind to.

SRSP:
1 1 1
Length = 0x00 Cmd0 = 0x66 Cmd1 = 0x01

Attributes:
None

3.7.1.5 ZB_ALLOW_BIND

Description:
This command puts the device into the Allow Binding Mode for a given period of time. A peer
device can establish a binding to a device in the Allow Binding Mode by calling zb_BindDevice
with a destination address of NULL.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x26 Cmd1 = 0x02 Timeout

Attributes:
Attribute Length (byte) Description
The number of seconds to remain in the allow binding mode. Valid values range from 1
through 65. If 0, the Allow Bind mode will be set false without timeout. If greater than
Timeout 1
64, the Allow Bind mode will be true.

SRSP:
1 1 1
Length = 0x00 Cmd0 = 0x66 Cmd1 = 0x02

Attributes:
None

3.7.1.6 ZB_SEND_DATA_REQUEST
Description:
This command initiates transmission of data to a peer device.

Usage:
SREQ:
Byte: 1 1 1 2 2 1
Length = 0x08-0x5C Cmd0 = 0x26 Cmd1 = 0x03 Destination CommandId Handle

1 1 1 0-84
Ack Radius Len Data

Attributes:
Attribute Length (byte) Description
The destination of the data. The destination can be one of the following:
- 16-Bit short address of device [0-0xfffD]
Destination 2
- ZB_BROADCAST_ADDR sends the data to all devices in the network.
- ZB_BINDING_ADDR sends the data to a previously bound device.

40 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

The command Id to send with the message. If the ZB_BINDING_ADDR destination is

CommandId 2
used, this parameter also indicates the binding to use.
Handle 1 A handle used to Identify the send data request.
Ack 1 TRUE if requesting acknowledgement from the destination.
Radius 1 The max number of hops the packet can travel through before it is dropped.
Len 1 Specifies the size of the Data buffer in bytes.
Data 0-84 Data

SRSP:
1 1 1
Length = 0x00 Cmd0 = 0x66 Cmd1 = 0x03

Attributes:
None

3.7.1.7 ZB_READ_CONFIGURATION

Description:
This command is used to get a configuration property from non-volatile memory.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x26 Cmd1 = 0x04 ConfigId

Attributes:
Attribute Length (byte) Description
ConfigId 1 Specifies the Identifier for the configuration property.

SRSP:
Byte: 1 1 1 1 1 1 0-128
Length = 0x03-0x83 Cmd0 = 0x66 Cmd1 = 0x04 Status ConfigId Len Value

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
ConfigId 1 Specifies the Identifier for the configuration property.
Len 1 Specifies the size of the Value buffer in bytes.
Value 0-128 Buffer to hold the configuration property.

3.7.1.8 ZB_WRITE_CONFIGURATION

Description:
This command is used to write a Configuration Property to non-volatile memory.

Usage:
SREQ:
Byte: 1 1 1 1 1 1-128
Length = 0x03-0x83 Cmd0 = 0x26 Cmd1 = 0x05 ConfigId Len Value

Attributes:
Attribute Length (byte) Description
ConfigId 1 The Identifier for the configuration property
Len 1 Specifies the size of the Value buffer in bytes.
Value 1-128 The buffer containing the new value of the configuration property.

41 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x66 Cmd1 = 0x05 Status

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.7.1.9 ZB_GET_DEVICE_INFO
Description:
This command retrieves a Device Information Property.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x26 Cmd1 = 0x06 Param

Attributes:
Attribute Length (byte) Description
Param 1 The Identifier for the device information.

SRSP:
1 1 1 1 8
Length = 0x09 Cmd0 = 0x66 Cmd1 = 0x06 Param Value

Attributes:
Attribute Length (byte) Description
Param 1 The Identifier for the device information.
Value 2 A buffer to hold the device information

3.7.1.10 ZB_FIND_DEVICE_REQUEST

Description:
This command is used to determine the short address for a device in the network. The device
initiating a call to zb_FindDeviceRequest and the device being discovered must both be a member
of the same network. When the search is complete, the zv_FindDeviceConfirm callback function
is called.

SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x26 Cmd1 = 0x07 SearchKey

Attributes:
Attribute Length (byte) Description
SearchKey 8 Specifies the value to search on.

SRSP:
1 1 1
Length = 0x00 Cmd0 = 0x66 Cmd1 = 0x07

Attributes:
None

42 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.7.2 MT_SAPI Callbacks

3.7.2.1 ZB_START_CONFIRM
Description:
This callback is called by the ZigBee stack after a start request operation completes.

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x46 Cmd1 = 0x80 Status

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.7.2.2 ZB_BIND_CONFIRM
Description:
This callback is called by the ZigBee stack after a bind operation completes.

Usage:
AREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x46 Cmd1 = 0x81 CommandId Status

Attributes:
Attribute Length (byte) Description
CommandId 2 The command Id of the binding being confirmed.
Status 1 Specifies the status of the bind operation.

3.7.2.3 ZB_ALLOW_BIND_CONFIRM
Description:
This callback indicates another device attempted to bind to this device.

Usage:
AREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x46 Cmd1 = 0x82 Source

Attributes:
Attribute Length (byte) Description
Source 2 Contains the address of the device attempted to bind to this device.

3.7.2.4 ZB_SEND_DATA_CONFIRM

Description:
This callback indicates the data has been sent.

43 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x46 Cmd1 = 0x83 Handle Status

Attributes:
Attribute Length (byte) Description
Handle 1 Specifies the handle.
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.7.2.5 ZB_RECEIVE_DATA_INDICATION
Description:
This callback is called asynchronously by the ZigBee stack to notify the application when data is
received from a peer device.

Usage:
AREQ:
1 1 1 2 2 2 0-84
Length = 0x06-5A Cmd0 = 0x46 Cmd1 = 0x87 Source Command Len Data

Attributes:
Attribute Length (byte) Description
Source 2 Specifies the short address of the peer device that sent the data.
Command 2 The command Id associated with the data.
Len 2 Specifies the number of bytes in the Data parameter.
Data 0-84 The data sent by the peer device.

3.7.2.6 ZB_FIND_DEVICE_CONFIRM
Description:
This callback is called by the ZigBee stack when a find device operation completes.

Usage:
AREQ:
1 1 1 1 2 8
Length = 0x0B Cmd0 = 0x46 Cmd1 = 0x85 SearchType = 0x01 SearchKey Result

Attributes:
Attribute Length (byte) Description
SearchType 1 The type of search that was performed.
SearchKey 2 Value that the search was executed on.
Result 8 The result of the search.

3.8 MT_SYS
This interface allows the tester to interact with the target at system level such as reset, read/write
memory, read/write extended address, etc.

44 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1 MT_SYS Commands

3.8.1.1 SYS_RESET_REQ
Description:
This command is sent by the tester to reset the target device

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x41 Cmd1 = 0x00 Type

Attributes:
Attribute Length (byte) Description
This command will reset the device by using a hardware reset (i.e.
watchdog reset) if ‘Type’ is zero. Otherwise a soft reset (i.e. a jump to the
reset vector) is done. This is especially useful in the CC2531, for
Type 1
instance, so that the USB host does not have to contend with the USB
H/W resetting (and thus causing the USB host to re-enumerate the device
which can cause an open virtual serial port to hang.)

3.8.1.2 SYS_PING

Description:
This command issues PING requests to verify if a device is active and check the capability of the
device.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x01

Attributes:
None

SRSP:
1 1 1 2
Length = 0x02 Cmd0 = 0x61 Cmd1 = 0x01 Capabilities

Attributes:
Attribute Length (byte) Description

This field represents the interfaces that this device can handle (compiled into the
device). Bit weighted and defined as:

Capability Value
MT_CAP_SYS 0x0001
MT_CAP_MAC 0x0002
MT_CAP_NWK 0x0004
Capabilities 2
MT_CAP_AF 0x0008
MT_CAP_ZDO 0x0010
MT_CAP_SAPI 0x0020
MT_CAP_UTIL 0x0040
MT_CAP_DEBUG 0x0080
MT_CAP_APP 0x0100
MT_CAP_ZOAD 0x1000

45 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.3 SYS_VERSION

Description:
This command is used to request for the device’s version string.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x02

Attributes:
None

SRSP:
1 1 1 1 1 1 1 1
Length = 0x05 Cmd0 = 0x61 Cmd1 = 0x02 TransportRev Product MajorRel MinorRel MaintRel

Attributes:
Attribute Length (byte) Description
TransportRev 1 Transport protocol revision
Product 1 Product Id
MajorRel 1 Software major release number
MinorRel 1 Software minor release number
MaintRel 1 Software maintenance release number

3.8.1.4 SYS_SET_EXTADDR

Description:
This command is used to set the extended address of the device.

Usage:
SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x21 Cmd1 = 0x03 ExtAddress

Attributes:
Attribute Length (byte) Description
ExtAddress 8 The device’s extended address.

46 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x03 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (1) or Failure (0)

3.8.1.5 SYS_GET_EXTADDR

Description:
This command is used to get the extended address of the device.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x04

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (1) or Failure (0)

SRSP:
1 1 1 8
Length = 0x08 Cmd0 = 0x61 Cmd1 = 0x04 ExtAddress

Attributes:
Attribute Length (byte) Description
ExtAddress 8 The device’s extended address.

3.8.1.6 SYS_RAM_READ
Description:
This command is used by the tester to read a single memory location in the target RAM. The
command accepts an address value and returns the memory value present in the target RAM at that
address.

Usage:
SREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x21 Cmd1 = 0x05 Address Len

Attributes:
Attribute Length (byte) Description
Address 2 Address of the memory that will be read.
Len 1 The number of bytes that will be read from the target RAM.

SRSP:
1 1 1 1 1 0-128
Length = 0x02-0x82 Cmd0 = 0x61 Cmd1 = 0x05 Status Len Value

47 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).
Len 1 The number of bytes that will be read from the target RAM.
Value 0-128 The value read from the target RAM.

3.8.1.7 SYS_RAM_WRITE

Description:
This command is used by the tester to write to a particular location in the target RAM. The
command accepts an address location and a memory value. The memory value is written to the
address location in the target RAM.

Usage:
SREQ:
1 1 1 2 1 1-128
Length = 0x04-0x84 Cmd0 = 0x21 Cmd1 = 0x06 Address Len Value

Attributes:
Attribute Length (byte) Description
Address 2 Address of the memory that will be read.
Len 1 The number of bytes that will be read from the target RAM.
Value 1-128 The value written to the target RAMS.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x06 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.1.8 SYS_OSAL_NV_READ

Description:
This command is used by the tester to read a single memory item from the target non-volatile
memory. The command accepts an attribute Id value and data offset and returns the memory value
present in the target for the specified attribute Id.

Usage:
SREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x21 Cmd1 = 0x08 Id Offset

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.
Offset 1 Number of bytes offset from the beginning or the NV value.

SRSP:
1 1 1 1 1 0-248
Length = 0x02-0xFA Cmd0 = 0x61 Cmd1 = 0x08 Status Len Value

48 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).
Len 1 Length of the NV value.
Value 0-248 Value of the NV item.

3.8.1.9 SYS_OSAL_NV_WRITE

Description:
This command is used by the tester to write to a particular item in non-volatile memory. The
command accepts an attribute Id, data offset, data length, and attribute value. The attribute value is
written to the location specified for the attribute Id in the target.

Usage:
SREQ:
1 1 1 2 1 1 1-246
Length = 0x04-0xFA Cmd0 = 0x21 Cmd1 = 0x09 Id Offset Len Value

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.
Offset 1 Number of bytes offset from the beginning or the NV value.
Len 1 Length of the NV value.
Value 0-246 Value of the NV item.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x09 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.1.10 SYS_OSAL_NV_ITEM_INIT

Description
This command is used by the tester to create and initialize an item in non-volatile memory. The
NV item will be created if it does not already exist. The data for the new NV item will be left
uninitialized if the InitLen parameter is zero. When InitLen is non-zero, the data for the NV item
will be initialized (starting at offset of zero) with the values from InitData. Note that it is not
necessary to initialize the entire NV item (InitLen < ItemLen). It is also possible to create an NV
item that is larger than the maximum length InitData – use the SYS_OSAL_NV_WRITE
command to finish the initialization.

Usage
SREQ:
1 1 1 2 2 1 0-245
Length = 0x04-0xFA Cmd0 = 0x21 Cmd1 = 0x07 Id ItemLen InitLen InitData

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.
ItemLen 2 Number of bytes in the NV item.
InitLen 1 Number of bytes in the initialization data.
InitData 0-245 Value of the initialization data.

49 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x07 Status

Attributes:
Attribute Length (byte) Description
Status 1 0x00 = Item already exists, no action taken
0x09 = Success, item created and initialized
0x0A = Initialization failed, item not created

3.8.1.11 SYS_OSAL_NV_DELETE

Description
This command is used by the tester to delete an item from the non-volatile memory. The ItemLen
parameter must match the length of the NV item or the command will fail. Use this command with
caution – deleted items cannot be recovered.

Usage
SREQ:
1 1 1 2 2
Length = 0x04 Cmd0 = 0x21 Cmd1 = 0x12 Id ItemLen

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.
ItemLen 2 Length of the NV item.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x12 Status

Attributes:
Attribute Length (byte) Description
0x00 = Success, the item was deleted
Status 1
0x09 = No action taken, item did not exist
0x0A = Failure, item was not deleted
0x0C = Bad length, item was not deleted

3.8.1.12 SYS_OSAL_NV_LENGTH

Description
This command is used by the tester to get the length of an item in non-volatile memory. A
returned length of zero indicates that the NV item does not exist.

Usage
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x21 Cmd1 = 0x13 Id

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.

50 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 2
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x13 Length

Attributes:
Attribute Length (byte) Description
Length 2 0x0000 = item does not exist
0x0001-0xNNNN = number of bytes in NV item

3.8.1.13 SYS_OSAL_START_TIMER
Description
This command is used by the tester to start a timer event. The event will expired after the indicated
amount of time and a notification will be sent back to the tester.

Usage
SREQ:
1 1 1 1 2
Length = 0x03 Cmd0 = 0x21 Cmd1 = 0x0A Id Timeout

Attributes:
Attribute Length (byte) Description
Id 1 The Id of the timer event (0-3)
Timeout 2 Amount of time it will take before the event expired in milliseconds.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x0A Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.1.14 SYS_OSAL_STOP_TIMER
Description:
This command is used by the tester to stop a timer event.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x21 Cmd1 = 0x0B Id

Attributes:
Attribute Length (byte) Description
Id 1 The Id of the timer event (0-3).

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x0B Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

51 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.15 SYS_RANDOM
Description:
This command is used by the tester to get a random 16-bit number.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x0C

Attributes:
None

SRSP:
1 1 1 2
Length = 0x02 Cmd0 = 0x61 Cmd1 = 0x0C Value

Attributes:
Attribute Length (byte) Description
Value 2 The random value.

3.8.1.16 SYS_ADC_READ
Description
This command reads a value from the ADC based on specified channel and resolution.

Usage
SREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x21 Cmd1 = 0x0D Channel Resolution

Attributes:
Attribute Length (byte) Description
The channel of the ADC that will be used.

Channel Value
AIN0 0x00
AIN1 0x01
AIN2 0x02
Channel 1 AIN3 0x03
AIN4 0x04
AIN5 0x05
AIN6 0x06
AIN7 0x07
Temperature Sensor 0x0E
Voltage Reading 0x0F
Resolution of the reading. This can be 8-bit, 10-bit, 12-bit or 14-bit.

Resolution Value
Resolution 1 8-bit 0x00
10-bit 0x01
12-bit 0x02
14-bit 0x03

52 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 2
Length = 0x02 Cmd0 = 0x61 Cmd1 = 0x0D Value

Attributes:
Attribute Length (byte) Description
Value 2 Value of the ADC reading based on the specified information.

3.8.1.17 SYS_GPIO
Description
This command is used by the tester to control the 4 GPIO pins on the CC2530-ZNP build.

Usage
SREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x21 Cmd1 = 0x0E Operation Value

Operation – 1 byte – specifies the type of operation to perform on the GPIO pins. It can take the
values, shown in the table below, with effects dictated by the bit values of the value parameter:

Attributes:
Operation Description
Set direction ( 0x00 ) Configure the direction of the GPIO pins. A value of 0 in a bit position configures
the corresponding GPIO pin as an Input while a value of 1 configures it as Output.
Set Input mode ( 0x01 ) Configure the Input mode of the GPIO pins. A value of 0 in a bit position
configures it as pull-up mode while a 1 configures it in tri-state Input mode. ( Note:
P1_0 and P1_1 of the CC2530 can only be set in tri-state input mode ).
Set ( 0x02 ) A value of 1 in a bit position will set the corresponding GPIO pin ( writes a 1 ).
Clear ( 0x03 ) A value of 0 in a bit position will clear the corresponding GPIO pin ( writes a 0 ).
Toggle ( 0x04 ) A value of 1 in a bit position will toggle the corresponding GPIO pin.
Read ( 0x05 ) Reads the GPIO pins.

SRSP:
1 1 1 2
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x0E Value

Attributes:
Attribute Length (byte) Description
Value 1 The value read from the GPIO pins.

3.8.1.18 SYS_STACK_TUNE

Description
This command is used by the tester to tune stack parameters and adjust performance at runtime.

Usage
SREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x21 Cmd1 = 0x0F Operation Value

Attributes:

The tuning operation to be executed according to the STK_Tune_t enumeration:

53 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Operation Value
Set the transmitter power level according to the value of the Value parameter 0x00
which should correspond to the valid values specified by the
ZMacTransmitPower_t enumeration (0xFD – 0x16)
Set RxOnWhenIdle off/on if the value of Value is 0/1; otherwise return the 0x01
current setting of RxOnWhenIdle.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x0F Value

Attributes:
Attribute Length (byte) Description
Value 1 Applicable status of the tuning operation.

3.8.1.19 SYS_SET_TIME
Description
This command is used by the tester to set the target system date and time. The time can be
specified in “seconds since 00:00:00 on January 1, 2000” or in parsed date/time components.

Usage
SREQ:
1 1 1 4 1 1 1
Length = 0x0B Cmd0 = 0x21 Cmd1 = 0x10 UTCTime Hour Minute Second

1 1 2
Month Day Year

Attributes:
Attribute Length (bytes) Description
Number of seconds since 00:00:00 on January 1, 2000.
UTCTime 4
Set this parameter to zero to use date/time attributes below.
Hour 1 Hour of the day (0-23)
Minute 1 Minute of the hour (0-59)
Second 1 Second of the minute (0-59)
Month 1 Month of the year (1-12)
Day 1 Day of the month (1-31)
Year 2 Year (2000- )

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x10 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.1.20 SYS_GET_TIME

Description:
This command is used by the tester to get the target system date and time. The time is returned in
“seconds since 00:00:00 on January 1, 2000” and parsed date/time components.

54 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x11

Attributes:
None

SRSP:
1 1 1 4 1 1 1
Length = 0x0B Cmd0 = 0x61 Cmd1 = 0x11 UTCTime Hour Minute Second

1 1 2
Month Day Year

Attributes:
Attribute Length (bytes) Description
UTCTime 4 Number of seconds since 00:00:00 on January 1, 2000.
Hour 1 Hour of the day (0-23)
Minute 1 Minute of the hour (0-59)
Second 1 Second of the minute (0-59)
Month 1 Month of the year (1-12)
Day 1 Day of the month (1-31)
Year 2 Year (2000- )

3.8.1.21 SYS_SET_TX_POWER

Description:
This command is used by the tester to set the target system radio transmit power. The returned TX
power is the actual setting applied to the radio – nearest characterized value for the specific radio.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x21 Cmd1 = 0x14 TX Power

Attributes:
Attribute Length (bytes) Description
TX Power 1 Requested TX power setting, in dBm.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x14 TX Power

Attributes:
Attribute Length (byte) Description
TX Power 1 Actual TX power setting, in dBm.

3.8.1.22 SYS_ZDIAGS_INIT_STATS
Description:
This command is used to initialize the statistics table in NV memory.

55 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x17

Attributes:
None

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x17 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.1.23 SYS_ZDIAGS_CLEAR_STATS
Description:
This command is used to clear the statistics table. To clear data in NV (including the Boot
Counter) the clearNV flag shall be set to TRUE.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x21 Cmd1 = 0x18 clearNV

Attributes:
Attribute Length (bytes) Description
TRUE – Clears statistics in NV memory including Boot
Counter.
clearNV 1
FALSE – Clears statistics in RAM only. Boot Counter is
preserved.

SRSP:
1 1 1 4
Length = 0x04 Cmd0 = 0x61 Cmd1 = 0x18 SysClock

Attributes:
Attribute Length (byte) Description
SysClock 4 Milliseconds since last reset.

3.8.1.24 SYS_ZDIAGS_GET_STATS

Description:
This command is used to read a specific system (attribute) ID statistics and/or metrics value.

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x21 Cmd1 = 0x19 AttributeID

Attributes:
Attribute Length (bytes) Description

56 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

System Diagnostics (ZDiags) attribute ID, as defined in ZDiags.h

AttributeID 2
module.

SRSP:
1 1 1 4
Length = 0x04 Cmd0 = 0x61 Cmd1 = 0x19 AttributeValue

Attributes:
Attribute Length (byte) Description
AttributeValue 4 Value of the requested attribute.

3.8.1.25 SYS_ZDIAGS_RESTORE_STATS_NV

Description:
This command is used to restore the statistics table from NV into the RAM table.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x1A

Attributes:
None

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x1A Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.1.26 SYS_ZDIAGS_SAVE_STATS_TO_NV

Description:
This command is used to save the statistics table from RAM to NV.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x21 Cmd1 = 0x1B

Attributes:
None

SRSP:
1 1 1 4
Length = 0x04 Cmd0 = 0x61 Cmd1 = 0x1B SysClock

Attributes:
Attribute Length (byte) Description
SysClock 4 Milliseconds since last reset.

57 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.27 SYS_NV_CREATE

Description:
This command is used to attempt to create an item in non-volatile memory.

Usage:
SREQ:
1 1 1 1 2 2 4
Length = 0x09 Cmd0 = 0x21 Cmd1 = 0x30 SysID ItemID SubID Length

Attributes:
Attribute Length (bytes) Description
SysID 1 System ID of the NV item
ItemID 2 Item ID of the NV item
SubID 2 Sub ID of the NV item
Length 4 Number of bytes in the NV item

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x30 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of NV create

3.8.1.28 SYS_NV_DELETE

Description:
This command is used to attempt to delete an item in non-volatile memory.

Usage:
SREQ:
1 1 1 1 2 2
Length = 0x05 Cmd0 = 0x21 Cmd1 = 0x31 SysID ItemID SubID

Attributes:
Attribute Length (bytes) Description
SysID 1 System ID of the NV item
ItemID 2 Item ID of the NV item
SubID 2 Sub ID of the NV item

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x31 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of NV delete

58 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.29 SYS_NV_LENGTH

Description:
This command is used to get the length of an item in non-volatile memory.

Usage:
SREQ:
1 1 1 1 2 2
Length = 0x05 Cmd0 = 0x21 Cmd1 = 0x32 SysID ItemID SubID

Attributes:
Attribute Length (bytes) Description
SysID 1 System ID of the NV item
ItemID 2 Item ID of the NV item
SubID 2 Sub ID of the NV item

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x32 Length

Attributes:
Attribute Length (byte) Description
Length 1 Length of NV Item

3.8.1.30 SYS_NV_READ
Description:
This command is used to read an item in non-volatile memory.

Usage:
SREQ:
1 1 1 1 2 2 2 1
Length = Cmd0 = Cmd1 =
SysID ItemID SubID Offset Length
0x08 0x21 0x33

Attributes:
Attribute Length (bytes) Description
SysID 1 System ID of the NV item
ItemID 2 Item ID of the NV item
SubID 2 Sub ID of the NV item
Offset 2 Offset into NV
Length 1 Length of data to read

SRSP:
1 1 1 1 1 0-240
Length = 0x03- Cmd0 = 0x61 Cmd1 = 0x33 Status Length Value
0xF3

Attributes:
Attribute Length (byte) Description
Status 1 Status of read
Length 1 Length of NV Item
Value 0-240 Value of the NV Item read

59 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.31 SYS_NV_WRITE

Description:
This command is used to write an item in non-volatile memory

Usage:
SREQ:
1 1 1 1 2 2 2 2 0-240
Length = Cmd0 = Cmd1 =
SysID ItemID SubID Offset Length Value
0x09-0xF9 0x21 0x34

Attributes:
Attribute Length (bytes) Description
SysID 1 System ID of the NV item
ItemID 2 Item ID of the NV item
SubID 2 Sub ID of the NV item
Offset 2 Offset into NV
Length 1 Length of data to read
Value 0-240 Data Bytes to be written to NV item

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x34 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of NV write

3.8.1.32 SYS_NV_UPDATE
Description:
This command is used to update an item in non-volatile memory

Usage:
SREQ:
1 1 1 1 2 2 2 0-240
Length = 0x07-
Cmd0 = 0x21 Cmd1 = 0x35 SysID ItemID SubID Length Value
0xF7

Attributes:
Attribute Length (bytes) Description
SysID 1 System ID of the NV item
ItemID 2 Item ID of the NV item
SubID 2 Sub ID of the NV item
Length 1 Length of data to read
Value 0-240 Data Bytes to be written to NV item
SRSP:
1 1 1 1
Length = 0x04 Cmd0 = 0x61 Cmd1 = 0x35 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of NV Update

60 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.33 SYS_NV_COMPACT

Description:
This command is used to compact the active page in non-volatile memory

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x21 Cmd1 = 0x36 Threshold

Attributes:
Attribute Length (bytes) Description
Threshold 2 Compaction occurs when NV bytes are less than this value

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x36 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of compaction of active page

3.8.1.34 SYS_OSAL_NV_READ_EXT

Description:
This command is used by the tester to read a single memory item from the target non-volatile
memory. The command accepts an attribute Id value and data offset and returns the memory value
present in the target for the specified attribute Id.

Usage:
SREQ:
1 1 1 2 2
Length = 0x03 Cmd0 = 0x21 Cmd1 = 0x08 Id Offset

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.
Offset 2 Number of bytes offset from the beginning or the NV value.

SRSP:
1 1 1 1 1 0-248
Length = 0x02-0xFA Cmd0 = 0x61 Cmd1 = 0x08 Status Len Value

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).
Len 1 Length of the NV value.
Value 0-248 Value of the NV item.

61 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.1.35 SYS_OSAL_NV_WRITE_EXT

Description:
This command is used by the tester to write to a particular item in non-volatile memory. The
command accepts an attribute Id, data offset, data length, and attribute value. The attribute value is
written to the location specified for the attribute Id in the target.

Usage:
SREQ:
1 1 1 2 2 1 1-246
Length = 0x04-0xFA Cmd0 = 0x21 Cmd1 = 0x09 Id Offset Len Value

Attributes:
Attribute Length (byte) Description
Id 2 The Id of the NV item.
Offset 2 Number of bytes offset from the beginning or the NV value.
Len 1 Length of the NV value.
Value 0-246 Value of the NV item.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x61 Cmd1 = 0x09 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.8.2 MT_SYS Callbacks

3.8.2.1 SYS_RESET_IND

Description
This callback is sent by the device to indicate that a reset has occurred.

Usage
AREQ:
1 1 1 1 1 1
Length = 0x06 Cmd0 = 0x41 Cmd1 = 0x80 Reason TransportRev ProductId

1 1 1
MajorRel MinorRel HwRev

Attributes:
Attribute Length (byte) Description

Reason for the reset.

Resolution Value
Reason 1
Power-up 0x00
External 0x01
Watch-dog 0x02

TransportRev 1 Transport protocol revision.

Product 1 Major release number.
MinorRel 1 Minor release number.
HwRev 1 Hardware revision number.

62 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.8.2.2 SYS_OSAL_TIMER_EXPIRED

Description:
This callback is sent by the device to indicate that a specific timer has been expired.

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x41 Cmd1 = 0x81 Id

Attributes:
Attribute Length (byte) Description
Id 1 The Id of the timer event (0-3)

3.9 MT_UART
This interface handles communication between the target and Z-Tool. Tester has no direct control over
this interface. There is no direct command for the tester to interact with this interface.

3.10 MT_UTIL
This interface provides tester supporting functionalities such as setting PanId, getting device info,
getting NV info, subscribing callbacks…etc.

3.10.1 MT_UTIL Commands

3.10.1.1 UTIL_GET_DEVICE_INFO
Description:
This command is sent by the tester to retrieve the device info.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x27 Cmd1 = 0x00

Attributes:
None

SRSP:
1 1 1 1 8 2 1
Length = 0x02 Cmd0 = 0x67 Cmd1 = 0x00 Status IEEEAddr ShortAddr DeviceType

1 1 0-128
DeviceState NumAssocDevices AssocDeviceList

Attributes:
Attribute Length (byte) Description
Status is a one byte field and is either success (0) or fail (1). The fail status is
returned if the address value in the command message was not within the valid
Status 1
range.

IEEEAddr 8 IEEE address of the device

ShortAddr 2 Short address of the device
Indicates device type, where bits 0 to 2 indicate the capability for the device to
DeviceType 1
operate as a coordinator, router, or end device, respectively.
Indicates the state of the device with different possible states as shown below:
DeviceState 1

63 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

0x00: Initialized - not started automatically

0x01: Initialized - not connected to anything
0x02: Discovering PAN's to join
0x03: Joining a PAN
0x04: Rejoining a PAN, only for end devices
0x05: Joined but not yet authenticated by trust center
0x06: Started as device after authentication
0x07: Device joined, authenticated and is a router
0x08: Starting as ZigBee Coordinator
0x09: Started as ZigBee Coordinator
0x0A: Device has lost information about its parent
Specifies the number of Reduce Function Devices being associated to the target
NumAssocDevices 1
device.
Array of 16-bits of network addresses of Reduce Function Devices associated to
AssocDevicesList Array
the local device.

3.10.1.2 UTIL_GET_NV_INFO
Description:
This command is used by the tester to read a block of parameters from non-volatile storage of the
target device.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x27 Cmd1 = 0x01

Attributes:
None

SRSP:
1 1 1 1 8 4 2
Length = 0x20 Cmd0 = 0x67 Cmd1 = 0x01 Status IEEEAddr ScanChannels PanId

1 16
SecurityLevel PreConfigKey

Attributes:
Attribute Length (byte) Description
A value of zero indicates success. Failure is indicated by a non-zero value,
representing a bit mask of each item that failed to be retrieved from NV memory.
Status 1 Bit0 is used for the first item (IEEEAddress), bit1 for the second item
(ScanChannels), and so forth. Data values for failed items are returned as one or
more bytes of 0xFF, the typical value read from erased NV memory.
IEEEAddr 8 IEEE address of the device
ScanChannels 4 This represents a bit-mask of channels to be scanned when starting the device.
PanId 2 Specifies the Pan Id to start or join. Set to 0xFFFF to select a PAN after scanning.
SecurityLevel 1 This specifies the network messaging security level, zero disables security.
PreConfigKey 16 This specifies the pre-configured security key.

3.10.1.3 UTIL_SET_PANID
Description:
Store a PanId value into non-volatile memory to be used the next time the target device resets.

Usage:
SREQ:
1 1 1 2

64 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Length = 0x02 Cmd0 = 0x27 Cmd1 = 0x02 PanId

Attributes:
Attribute Length (byte) Description
PanId 2 PanId that will be set

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x02 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.4 UTIL_SET_CHANNELS

Description:
This command is used to store a channel select bit-mask into non-volatile memory to be used the
next time the target device resets.

Usage:
SREQ:
1 1 1 4
Length = 0x04 Cmd0 = 0x27 Cmd1 = 0x03 Channels

Attributes:
Attribute Length (byte) Description
Channels 4 A bit-mask representing the channel(s) to scan the next time the target device resets.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x03 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.5 UTIL_SET_SECLEVEL
Description:
This command is used to store a security level value into non-volatile memory to be used the next time the target device
resets.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x27 Cmd1 = 0x04 SecLevel

Attributes:
Attribute Length (byte) Description
Security level to use the next time the target device resets. Zero is used to disable
SecLevel 1
security.

65 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x04 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.6 UTIL_SET_PRECFGKEY
Description:
This command is used to store a pre-configured key array into non-volatile memory to be used the
next time the target device resets.

Usage:
SREQ:
1 1 1 16
Length = 0x10 Cmd0 = 0x27 Cmd1 = 0x05 PreCfgKey

Attributes:
Attribute Length (byte) Description
An array representing the pre-configured key to use the next time the target device
PreCfgKey 16
resets.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x05 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.7 UTIL_CALLBACK_SUB_CMD
Description:
This command subscribes/unsubscribes to layer callbacks. For particular subsystem callbacks to
work, the software must be compiled with a special flag that is unique to that subsystem to enable
the callback mechanism. For example to enable ZDO callbacks, MT_ZDO_CB_FUNC flag must
be compiled when the software is built. For complete list of callback compile flags, check section
1.2 or “Z-Stack Compile Options” document.

Usage:
SREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x27 Cmd1 = 0x06 SubsystemId Action

66 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description

Subsystem Id of the expected layer

Subsystem Id
MT_SYS 0x0100
MT_MAC 0x0200
MT_NWK 0x0300
SubsystemId 2 MT_AF 0x0400
MT_ZDO 0x0500
MT_SAPI 0x0600
MT_UTIL 0x0700
MT_DEBUG 0x0800
MT_APP 0x0900
ALL SUBSYSTEM 0xFFFF

Action 1 0: Disable, 1: Enable

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x06 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.8 UTIL_KEY_EVENT
Description:
Sends key and shift codes to the application that registered for key events. The keys parameter is a
bit mask, allowing for multiple keys in a single command. The return status indicates success if
the command is processed by a registered key handler, not whether the key code was used. Not all
applications support all key or shift codes but there is no indication when a key code is dropped.

Usage:
SREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x27 Cmd1 = 0x07 Keys Shift

Attributes:
Attribute Length (byte) Description
Keys 1 Key code bit mask:
0x01: key 1
0x02: key 2
0x04: key 3
0x08: key 4
0x10: key 5
0x20: key 6
0x40: key 7
0x80: key 8
Shift 1 0: No shift, 1: Shift

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x07 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

67 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.10.1.9 UTIL_TIME_ALIVE
Description:
This command is used by the tester to get the board’s time alive.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x27 Cmd1 = 0x09

Attributes:
None

SRSP:
1 1 1 4
Length = 0x04 Cmd0 = 0x67 Cmd1 = 0x09 Seconds

Attributes:
Attribute Length (byte) Description
Seconds 4 The time of the board’s live in seconds

3.10.1.10 UTIL_LED_CONTROL
Description:
This command is used by the tester to control the LEDs on the board.

Usage:
SREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x27 Cmd1 = 0x0A LedId Mode

Attributes:
Attribute Length (byte) Description
Laded 1 The LED number
Mode 1 0: OFF, 1: ON

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x0A Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.11 UTIL_LOOPBACK
Description:
This command is used by the tester to test data buffer loopback.

68 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
1 1 1 0 - 250
Length = 0x00 – 0xFA Cmd0 = 0x27 Cmd1 = 0x10 Data

Attributes:
Attribute Length (byte) Description
Data 0 – 250 The data bytes to be looped back.

SRSP:
1 1 1 0 - 250
Length = 0x00 – 0xFA Cmd0 = 0x67 Cmd1 = 0x10 Data

Attributes:
Attribute Length (byte) Description
Data 0 – 250 The looped back data bytes.

3.10.1.12 UTIL_DATA_REQ

Description:
This command is used by the tester to effect a MAC MLME Poll Request.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x27 Cmd1 = 0x11 SecurityUse

Attributes:
Attribute Length Description
SecurityUse 1 TRUE to request MAC security, but not used for now.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x11 Status

Attributes:
Attribute Length Description
Status 1 A MAC status value from ZComDef.h, but only ZMacSuccess for now.

3.10.1.13 UTIL_SRC_MATCH_ENABLE

Description:
This command is used to enable AUTOPEND and source address matching.

Usage:
SREQ:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x27 Cmd1 = 0x20

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x20 Status

69 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.14 UTIL_SRC_MATCH_ADD_ENTRY

Description:
This command is used to add a short or extended address to the source address table.

Usage:
SREQ:
Byte: 1 1 1 1 8
Length = 0x0B Cmd0 = 0x27 Cmd1 = 0x21 AddressMode Address

Attributes:
Attribute Length (byte) Description

Mode Value Description

AddressMode 1 ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit

Address of the device that will be added - Can be short or extended depends on
Address 8
the address mode.
PanId 2 PAN Id of the device. Only use when the address is a short address.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x21 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.15 UTIL_SRC_MATCH_DEL_ENTRY

Description:
This command is used to delete a short or extended address from the source address table.

Usage:
SREQ:
Byte: 1 1 1 1 8 2
Length = 0x0B Cmd0 = 0x27 Cmd1 = 0x22 AddressMode Address PanId

Attributes:
Attribute Length (byte) Description

Mode Value Description

AddressMode 1 ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit

Address of the device that will be deleted - Can be short or extended depends on the
Address 8
address mode.
PanId 2 PAN Id of the device. Only use when the address is a short address.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x22 Status

70 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.16 UTIL_SRC_MATCH_CHECK_SRC_ADDR

Description:
This command is used to check if a short or extended address is in the source address table.

Usage:
SREQ:
Byte: 1 1 1 1 8 2
Length = 0x0B Cmd0 = 0x27 Cmd1 = 0x23 AddressMode Address PanId

Attributes:
Length
Attribute Description
(byte)

Mode Value Description

AddressMode 1 ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit

Address of the device that will be checked - Can be short or extended depends on the
Address 8
address mode.
PanId 2 PAN Id of the device. Only use when the address is a short address.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x23 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.17 UTIL_SRC_MATCH_ACK_ALL_PENDING

Description:
This command is used to enable/disable acknowledging all packets with pending bit set.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x27 Cmd1 = 0x24 Option

Attributes:
Attribute Length (byte) Description
Option 1 TRUE - acknowledging all packets with pending field set. FALSE - Otherwise

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x24 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

71 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.10.1.18 UTIL_SRC_MATCH_CHECK_ALL_PENDING
Description:
This command is used to check if acknowledging all packets with pending bit set is enabled.

Usage:
SREQ:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x27 Cmd1 = 0x25

Attributes: None

SRSP:
Byte: 1 1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x25 Status Value

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).
Value 1 TRUE - acknowledging all packets with pending bit set is enabled. FALSE – otherwise.

3.10.1.19 UTIL_ADDRMGR_EXT_ADDR_LOOKUP

Description:
This command is a proxy call to the AddrMgrEntryLookupExt() function.

Usage:
SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x27 Cmd1 = 0x40 ExtAddr

Attributes:
Attribute Length (byte) Description
ExtAddr 8 Extended Address (LSB-MSB) of the device for which to lookup the Network Address.

SRSP:
1 1 1 2
Length = 0x02 Cmd0 = 0x67 Cmd1 = 0x40 NwkAddr

Attributes:
Attribute Length (byte) Description
Network Address (LSB-MSB) of the device that corresponds to the Extended Address
NwkAddr 2
sent as a parameter in the request.

3.10.1.20 UTIL_ADDRMGR_NWK_ADDR_LOOKUP
Description:
This command is a proxy call to the AddrMgrEntryLookupNwk() function.

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x27 Cmd1 = 0x41 NwkAddr

72 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
NwkAddr 2 Network Address (LSB-MSB) of the device for which to lookup the Extended Address.

SRSP:
1 1 1 8
Length = 0x08 Cmd0 = 0x67 Cmd1 = 0x41 ExtAddr

Attributes:
Attribute Length (byte) Description
Extended Address (LSB-MSB) of the device that corresponds to the Network Address sent
ExtAddr 8
as a parameter in the request.

3.10.1.21 UTIL_APSME_LINK_KEY_DATA_GET

Description:
This command retrieves APS link key data, Tx and Rx frame counters.

Usage:
SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x27 Cmd1 = 0x44 ExtAddr

Attributes:
Attribute Length (byte) Description
ExtAddr 8 The extended address for which to get the link key data.

SRSP:
1 1 1 1 16 4 4
Length = 0x19 Cmd0 = 0x67 Cmd1 = 0x44 Status SecKey TxFrmCntr RxFrmCntr

Attributes:
Attribute Length (byte) Description
Status 1 The ZStatus_t returned by the proxy call to APSME_LinkKeyNVIdGet().
SecKey 16 On success, the security key looked up; otherwise N/A.
TxFrmCntr 4 On success, the TX frame counter; otherwise N/A.
RxFrmCntr 4 On success, the RX frame counter, otherwise N/A.

3.10.1.22 UTIL_APSME_LINK_KEY_NV_ID_GET

Description:
This command is a proxy call to the APSME_LinkKeyNvIdGet() function.

Usage:
SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x27 Cmd1 = 0x45 ExtAddr

Attributes:
Attribute Length (byte) Description
ExtAddr 8 The extended address for which to get the link key NV Id.

SRSP:
1 1 1 1 2
Length = 0x03 Cmd0 = 0x67 Cmd1 = 0x45 Status LinkKeyNvId

73 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status of proxy call to APSME_LinkKeyNvIdGet().
LinkKeyNvId 2 On success, link key NV ID. Otherwise 0xFFFF

3.10.1.23 UTIL_APSME_REQUEST_KEY_CMD

Description:
This command is used to send a request key to the Trust Center from an originator device who
wants to exchange messages with a partner device.

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x27 Cmd1 = 0x4B PartnerAddr

Attributes:
Attribute Length (byte) Description
Specifies the extended address of the partner device the originator
PartnerAddr 8
wants to exchange messages with.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x4B Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.10.1.24 UTIL_ASSOC_COUNT

Description:
This command is a proxy call to the AssocCount() function.

Usage:
SREQ:
1 1 1 1 1
Length = 0x02 Cmd0 = 0x27 Cmd1 = 0x48 StartRelation EndRelation

Attributes:
Attribute Length (byte) Description
A valid node relation from AssocList.h:
// Node Relations
#define PARENT 0
#define CHILD_RFD 1
#define CHILD_RFD_RX_IDLE 2
StartRelation 1
#define CHILD_FFD 3
#define CHILD_FFD_RX_IDLE 4
#define NEIGHBOR 5
#define OTHER 6
The node relation at which to start counting.
EndRelation 1 Same as StartRelation, but the node relation at which to stop counting.

SRSP:
1 1 1 2
Length = 0x02 Cmd0 = 0x67 Cmd1 = 0x48 Count

74 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Count 2 The count returned by the proxy call to AssocCount().

3.10.1.25 UTIL_ASSOC_FIND_DEVICE

Description:
This command is a proxy call to the AssocFindDevice() function.

Usage:
SREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x27 Cmd1 = 0x49 Number

Attributes:
Attribute Length (byte) Description
Number 1 Nth active entry in the device list.

SRSP:
1 1 1 18
Length = 0x12 Cmd0 = 0x67 Cmd1 = 0x49 Device

Attributes:
Attribute Length (byte) Description
The packed (LSB-MSB) associated_devices_t structure returned by the
Device 18 proxy call to AssocFindDevice().The device short address is set to
INVALID_NODE_ADDR to indicate failure.

3.10.1.26 UTIL_ASSOC_GET_WITH_ADDRESS
Description:
This command is a proxy call to the AssocGetWithAddress() function.

Usage:
SREQ:
1 1 1 8 2
Length = 0x0A Cmd0 = 0x27 Cmd1 = 0x4A ExtAddr NwkAddr

Attributes:
Attribute Length (byte) Description
The extended address to use for the lookup or all zeroes to use the
ExtAddr 8
NwkAddr for the lookup.
Network Address (LSB-MSB) to use for the lookup if the ExtAddr is all
NwkAddr 2
zeroes.

SRSP:
1 1 1 18
Length = 0x12 Cmd0 = 0x67 Cmd1 = 0x4A Device

Attributes:
Attribute Length (byte) Description
The packed (LSB-MSB) associated_devices_t structure returned by the
Device 18 proxy call to AssocGetWithAddress (). The device short address is set to
INVALID_NODE_ADDR to indicate failure.

75 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.10.1.27 UTIL_BIND_ADD_ENTRY
Description:
This command is a proxy call to the bindAddEntry() function.

Usage:
SREQ:
1 1 1 1 8
Length = 0x0D-0x13 Cmd0 = 0x27 Cmd1 = 0x4D AddrMode DstAddr

1 1 2-8
DstEndpoint NumClusterIds ClusterIds

Attributes:
Attribute Length (byte) Description
AddrMode 1 The destination address mode according to the afAddrMode_t enumeration in AF.h.
If AddrMode is afAddr64Bit, the 8-byte extended destination address; otherwise the
DstAddr 8
2-byte network destination address.
DstEndpoint 1 Binding entry destination endpoint.
NumClusterIds 1 Specifies the number of IDs in the ClusterIds list.
ClusterIds 2-8 Contains the cluster IDs.

SRSP:
1 1 1 14
Length = 0x0E Cmd0 = 0x67 Cmd1 = 0x4D BindEntry

Attributes:
Attribute Length (byte) Description
The packed (LSB-MSB) BindingEntry_t structure returned by the proxy call to
BindEntry 14 bindAddEntry().The dstIdx in the BindEntry is set to INVALID_NODE_ADDR to
indicate failure.

3.10.1.28 UTIL_ZCL_KEY_EST_INIT_EST
Description:
This command is a proxy call to zclGeneral_KeyEstablish_InitiateKeyEstablishment().

Usage:
SREQ:
1 1 1 1 1 1 1 8
Length = 0x0C Cmd0 = 0x27 Cmd1 = 0x80 TaskId SeqNum EndPoint AddrMode Addr

Attributes:
Attribute Length (byte) Description
TaskId 1 The OSAL Task Id making the request.
SeqNum 1 The sequence number of the request.
EndPoint 1 The endpoint on the partner.
The address mode to the partner according to the afAddrMode_t enumeration in
AddrMode 1
AF.h.
If AddrMode is afAddr64Bit, the 8-byte extended address of the partner; otherwise
Addr 8
the 2-byte network address of the partner.

76 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x67 Cmd1 = 0x80 Status

Attributes:
Attribute Length (byte) Description
The ZStatus_t returned by the proxy call to
Status 1
zclGeneral_KeyEstablish_InitiateKeyEstablishment().

3.10.1.29 UTIL_ZCL_KEY_EST_SIGN

Description:
This command is a proxy call to zclGeneral_KeyEstablishment_ECDSASign().

Usage:
SREQ:
1 1 1 1 1
Length = 0x0C Cmd0 = 0x27 Cmd1 = 0x81 InputLen Input

Attributes:
Attribute Length (byte) Description
InputLen 1 The length of the input data.
Input InputLen The input data.

SRSP:
1 1 1 1 42
Length = 0x2B Cmd0 = 0x67 Cmd1 = 0x81 Status Key

Attributes:
Attribute Length (byte) Description
The ZStatus_t returned by the proxy call to
Status 1
zclGeneral_KeyEstablishment_ECDSASign ().
Key 42 The output key on success.

3.10.1.30 UTIL_SRNG_GEN
Description:
This command is used to generate Secure Random Number. It generates 1,000,000 bits in sets of
100 bytes. As in 100 bytes of secure random numbers are generated until 1,000,000 bits are
generated. 100 bytes are generated 1250 times. So 1250 SRSPs are generated. MT_SRNG has to
be defined to include this API.

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x27 Cmd1 = 0x4C

SRSP:
1 1 1 0x64
Length = 0x64 Cmd0 = 0x67 Cmd1 = 0x4C Secure Random Numbers

77 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.10.2 MT_UTIL Callbacks

3.10.2.1 UTIL_SYNC_REQ
Description:
This is an asynchronous request/response handshake.

Usage:
AREQ:
1 1 1
Length = 0x00 Cmd0 = 0x47 Cmd1 = 0xE0

3.10.2.2 UTIL_ZCL_KEY_ESTABLISH_IND
Description:
This is the RPC proxy indication for a ZCL_KEY_ESTABLISH_IND.

Usage:
AREQ:
1 1 1 1 1 1 1 2
Length = 0x06 Cmd0 = 0x47 Cmd1 = 0xE1 TaskId Event Status WaitTime Suite

Attributes:
Attribute Length (byte) Description
The OSAL Task Id registered to receive this indication (see
TaskId 1
UTIL_ZCL_KEY_EST_INIT_EST).
Event 1 The OSAL message event.
Status 1 The OSAL message status.
WaitTime 1 The wait time.
Suite 2 The key establishment suite.

3.11 MT_VERSION
This interface contains information about the release version of the software. There is no direct
command for tester to interact with this interface.

3.12 MT_ZDO
This interface allows the tester to issue commands to the ZDO layer in the target and receive
responses. Each of these messages has a corresponding message that is returned by the target. The
response message only indicates that the command message was received and executed. The result of
the command execution will be conveyed to the tester via a callback message interface.

78 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1 MT_ZDO Commands

3.12.1.1 ZDO_NWK_ADDR_REQ
Description:
This message will request the device to send a “Network Address Request”. This message sends a
broadcast message looking for a 16 bit address with a known 64 bit IEEE address. You must
subscribe to “ZDO Network Address Response” to receive the response to this message. Check
section 3.0.1.7 for more details on callback subscription. The response message listed below only
indicates whether or not the message was received properly.

Usage:
SREQ:
Byte: 1 1 1 8 1 1
Length = 0x0A Cmd0 = 0x25 Cmd1 = 0x00 IEEEAddress ReqType StartIndex

Attributes:
Attribute Length (byte) Description
IEEEAddress 8 64 bit IEEE address of the device.

Value that the search was executed on.

ReqType 1 Type Value

Single Device response 0x00
Extended, include associated devices 0x01

Starting index into the list of children. This is used to get more of the list if the list is
StartIndex 1
too large for one message.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x00 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.2 ZDO_IEEE_ADDR_REQ
Description:
This command will request a device’s IEEE 64-bit address. You must subscribe to “ZDO IEEE
Address Response” to receive the data response to this message. The response message listed
below only indicates whether or not the message was received properly.

Usage:
SREQ:
Byte: 1 1 1 2 1 1
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x01 ShortAddr ReqType StartIndex

Attributes:
Attribute Length (byte) Description
ShortAddr 2 Specifies the short address of the device.

79 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Value that the search was executed on.

ReqType 1 Type Value

Single Device response 0x00
Extended, include associated devices 0x01
Starting index into the list of children. This is used to get more of the list if the list is
StartIndex 1
too large for one message.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x01 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.3 ZDO_NODE_DESC_REQ

Description:
This command is generated to inquire about the Node Descriptor information of the destination
device.

Usage
SREQ:
1 1 1 2 2
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x02 DstAddr NWKAddrOfInterest

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x02 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.4 ZDO_POWER_DESC_REQ

Description:
This command is generated to inquire about the Power Descriptor information of the destination
device.

Usage:
SREQ:
Byte: 1 1 1 2 2
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x03 DstAddr NWKAddrOfInterest

80 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x03 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.5 ZDO_SIMPLE_DESC_REQ

Description:
This command is generated to inquire as to the Simple Descriptor of the destination device’s
Endpoint.

Usage:
SREQ:
Byte: 1 1 1 2 2 1
Length = 0x05 Cmd0 = 0x25 Cmd1 = 0x04 DstAddr NWKAddrOfInterest Endpoint

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.
Endpoint 1 Specifies the application endpoint the data is from.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x04 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.6 ZDO_ACTIVE_EP_REQ
Description:
This command is generated to request a list of active endpoint from the destination device.

Usage:
SREQ:
Byte: 1 1 1 2 2
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x05 DstAddr NWKAddrOfInterest

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.

81 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x05 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.7 ZDO_MATCH_DESC_REQ

Description:
This command is generated to request the device match descriptor.

Usage:
SREQ:
1 1 1 2 2 2
Length = 0x08-0x48 Cmd0 = 0x25 Cmd1 = 0x06 DstAddr NwkAddrOfInterest ProfileId

1 0-32 1 0-32
NumInClusters InClusterList NumOutClusters OutClusterList

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.
ProfileId 2 Specifies the profile Id of the device
NumInClusters 1 Specifies the number of Id’s in the InClusterList.
InClusterList 0-32 Contains the input cluster Id’s.
NumOutClusters 1 Specifies the number of Id’s in the OutClusterList.
OutClusterList 0-32 Contains the output cluster Id’s.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x06 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.8 ZDO_COMPLEX_DESC_REQ
Description:
This command is generated to request for the destination device’s complex descriptor.

Usage:
SREQ:
Byte: 1 1 1 2 2
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x07 DstAddr NWKAddrOfInterest

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.

82 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x07 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.9 ZDO_USER_DESC_REQ
Description:
This command is generated to request for the destination device’s user descriptor.

Usage:
SREQ:
1 1 1 2 2
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x08 DstAddr NWKAddrOfInterest

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x08 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.10 ZDO_END_DEVICE_ANNCE

Description:
This command will cause the device to issue an “End device announce” broadcast packet to the
network. This is typically used by an end-device to announce itself to the network.

Usage:
SREQ:
1 1 1 2 8 1
Length = 0x0B Cmd0 = 0x25 Cmd1 = 0x0A NwkAddr IEEEAddr Capabilites

Attributes:
Attribute Length (byte) Description
NwkAddr 2 Specifies network address of the device generating the request.
IEEEAddr 8 Specifies the 64 bit IEEE Address of the device being announced.
Specifies MAC capabilities
Bit: 0 – Alternate PAN Coordinator
1 – Device type: 1- ZigBee Router; 0 – End Device
2 – Power Source: 1 Main powered
Capabilites 1
3 – Receiver on when Idle
4 – Reserved
5 – Reserved
6 – Security capability

83 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

7 – Reserved

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x0A Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.11 ZDO_USER_DESC_SET

Description:
This command is generated to write a User Descriptor value to the targeted device.

Usage:
SREQ:
1 1 1 2 2 1 0-16
Length = 0x05-0x15 Cmd0 = 0x25 Cmd1 = 0x0B DstAddr NWKAddrOfInterest Len UserDescriptor

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies network address of the device generating the set request.
NWKAddrOfInterest 2 Specifies NWK address of the destination device being queried.
Len 1 Specifies the length of the user descriptor.
UserDescriptor 0-16 User descriptor array (can be up to 16 bytes).

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x0B Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.12 ZDO_SERVER_DISC_REQ

Description:
The command is used for local device to discover the location of a particular system server or
servers as indicated by the ServerMask parameter. The destination addressing on this request is
‘broadcast to all RxOnWhenIdle devices’.

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x25 Cmd1 = 0x0C ServerMask

Attributes:
Attribute Length (byte) Description
ServerMask 2 Specifies the system server capabilities of the device.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x0C Status

84 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.13 ZDO_END_DEVICE_BIND_REQ
Description:
This command is generated to request an End Device Bind with the destination device.

Usage:
SREQ:
1 1 1 2 2 1
Length = 0x09-0x49 Cmd0 = 0x25 Cmd1 = 0x20 DstAddr LocalCoordinator Endpoint

2 1 0-32 1 0-32
ProfileId NumInClusters InClusterList NumOutClusters OutClusterList

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies NWK address of the device generating the inquiry.
Specifies Specifies local coordinator’s short address. In the case of source
LocalCoordinator 2 binding, it’s the short address of the source address

IEEE 8 Local coordinator’s IEEE address

Endpoint 1 Device’s endpoint.
ProfileId 2 Specifies the profile Id of the device.
NumInClusters 1 Specifies the number of Id’s in the InClusterList.
InClusterList 0-32 Contains the input cluster Id’s.
NumOutClusters 1 Specifies the number of Id’s in the OutClusterList.
OutClusterList 0-32 Contains the output cluster Id’s.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x20 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.14 ZDO_BIND_REQ
Description:
This command is generated to request a Bind.

Usage:
SREQ:
1 1 1 2 8 1 2
Length = 0x10-0x17 Cmd0 = 0x25 Cmd1 = 0x21 DstAddr SrcAddress SrcEndpoint ClusterId

1 2/8 0/1
DstAddrMode DstAddress DstEndpoint

Attributes:
Attribute Length (byte) Description

85 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

DstAddr 2 Specifies the destination address of the device generating the bind request
SrcAddress 8 64 bit Binding source IEEE address
SrcEndpoint 1 Specifies the binding source endpoint.
ClusterId 2 Specifies the cluster Id to match in messages.
Specifies destination address mode

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
DstAddrMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast
DstAddress 8/2 Binding destination IEEE address. Not to be confused with DstAddr.
Specifies the binding destination endpoint. It is used only when DstAddrMode is
DstEndpoint 1/0
64 bits extended address

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x21 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.15 ZDO_UNBIND_REQ
Description:
This command is generated to request a un-bind.

Usage:
SREQ:
1 1 1 2 8 1 2
Length = 0x10-0x17 Cmd0 = 0x25 Cmd1 = 0x22 DstAddr SrcAddress SrcEndpoint ClusterId

1 2/8 0/1
DstAddrMode DstAddress DstEndpoint

Attributes:
Length
Attribute Description
(byte)
DstAddr 2 Specifies destination address of the device generating the bind request.
SrcAddress 8 Specifies 64 bit Binding source IEEE address.
SrcEndpoint 1 Specifies the binding source endpoint.
ClusterI 2 Specifies cluster Id to match in messages.

Specifies 64 bit Binding destination address mode:

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
DstAddrMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast

Specifies 64 bit Binding destination IEEE address. Not to be

DstAddress 8
confused with DstAddr.
DstEndpoint 1 Specifies the binding destination endpoint

86 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x22 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.16 ZDO_MGMT_NWK_DISC_REQ
Description:
This command is generated to request the destination device to perform a network discovery.

Usage:
SREQ:
1 1 1 2 4 1 1
Length = 0x08 Cmd0 = 0x25 Cmd1 = 0x30 DstAddr ScanChannels ScanDuration StartIndex

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies the network address of the device performing the discovery.
Specifies the Bit Mask for channels to scan:

Channel Value
NONE 0x00000000
ALL_CHANNELS 0x07FFF800
CHANNEL 11 0x00000800
CHANNEL 12 0x00001000
CHANNEL 13 0x00002000
CHANNEL 14 0x00004000
CHANNEL 15 0x00008000
ScanChannels 4 CHANNEL 16 0x00010000
CHANNEL 17 0x00020000
CHANNEL 18 0x00040000
CHANNEL 19 0x00080000
CHANNEL 20 0x00100000
CHANNEL 21 0x00200000
CHANNEL 22 0x00400000
CHANNEL 23 0x00800000
CHANNEL 24 0x01000000
CHANNEL 25 0x02000000
CHANNEL 26 0x04000000
ScanDuration 1 Specifies the scanning time.
Specifies where to start in the response array list. The result may contain more
StartIndex 1 entries than can be reported, so this field allows the user to retrieve the responses
anywhere in the array list.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x30 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

87 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1.17 ZDO_MGMT_LQI_REQ

Description:
This command is generated to request the destination device to perform a LQI query of other
devices in the network.

Usage:
SREQ:
Byte: 1 1 1 2 1
Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x31 DstAddr StartIndex

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies the network address of the device generating the query.
Specifies where to start in the response array list. The result may contain more
StartIndex 1 entries than can be reported, so this field allows the user to retrieve the responses
anywhere in the array list.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x31 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.18 ZDO_MGMT_RTG_REQ

Description:
This command is generated to request the Routing Table of the destination device.

Usage:
SREQ:
Byte: 1 1 1 2 1
Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x32 DstAddr StartIndex

Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies the network address of the device generating the query.
Specifies where to start in the response array list. The result may contain more
StartIndex 1 entries than can be reported, so this field allows the user to retrieve the responses
anywhere in the array list.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x32 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

88 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1.19 ZDO_MGMT_BIND_REQ

Description
This command is generated to request the Binding Table of the destination device.

Usage
SREQ:
Byte: 1 1 1 2 1
Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x33 DstAddr StartIndex
Attributes:
Attribute Length (byte) Description
DstAddr 2 Specifies the network address of the device being queried.
Specifies where to start in the response array list. The result may contain more entries
StartIndex 1 than can be reported, so this field allows the user to retrieve the responses anywhere in
the array list.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x33 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.20 ZDO_MGMT_LEAVE_REQ
Description:
This command is generated to request a Management Leave Request for the target device.

Usage:
SREQ:
1 1 1 2 8 1
Length = 0x0B Cmd0 = 0x25 Cmd1 = 0x34 DstAddr DeviceAddr RemoveChildren_Rejoin

Attributes:
Attribute Length (byte) Description
Short address of the device that will process the mgmt leave (remote or
DstAddr 2
self)
DeviceAddress 8 The 64-bit IEEE address of the entity to be removed from the network or
0x0000000000000000 if the device removes itself from the network.
Specifies actions to be performed by device when leaving the network:
Bit 0: rejoin
RemoveChildren_Rejoin 1
Bit 1: remove children

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x34 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

89 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1.21 ZDO_MGMT_DIRECT_JOIN_REQ

Description:
This command is generated to request the Management Direct Join Request of a designated
device.

Usage:
SREQ:
Byte: 1 1 1 2 8 1
Length = 0x0B Cmd0 = 0x25 Cmd1 = 0x35 DstAddr DeviceAddr CapInfo

Attributes:
Attribute Length (byte) Description
Network address of the device to which the device specified in DeviceAddress is
DstAddr 2
to join.
The 64 bit IEEE Address of the device you want to be joined to the device at
DeviceAddress 8
DstAddr.
Specifies the operating capabilities of the device being directly joined. Bit
weighted values follow:
Bit: 0 – Alternate PAN Coordinator
1 – Device type: 1- ZigBee Router; 0 – End Device
2 – Power Source: 1 Main powered
CapInfo 1
3 – Receiver on when Idle
4 – Reserved
5 – Reserved
6 – Security capability
7 – Reserved

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x35 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.22 ZDO_MGMT_PERMIT_JOIN_REQ
Description:
This command is generated to set the Permit Join for the destination device.

Usage:
SREQ:
1 1 1 1 2 1 1
Length = 0x05 Cmd0 = 0x25 Cmd1 = 0x36 AddrMode DstAddr Duration TCSignificance

Attributes:
Attribute Length (byte) Description
AddrMode Destination address type: 0x02 – Address 16 bit, 0xFF – Broadcast.
Specifies the network address of the destination device whose Permit Join
DstAddr 2
information is to be modified.
Specifies the duration to permit joining. 0 = join disabled. 0xff = join enabled.
Duration 1
0x01-0xfe = number of seconds to permit joining.
TCSignificance 1 Trust Center Significance.

90 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x36 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.23 ZDO_MGMT_NWK_UPDATE_REQ
Description:
This command is provided to allow updating of network configuration parameters or to request
information from devices on network conditions in the local operating environment.

Usage:
SREQ:
1 1 1 2 1 4
Length = 0x0B Cmd0 = 0x25 Cmd1 = 0x37 DstAddr DstAddrMode ChannelMask

1 1 2
ScanDuration ScanCount NwkManagerAddr

Attributes:
Attribute Length (byte) Description
Short address of the destination device(s). The destination addressing on this
DstAddr 2 primitive can be unicast or broadcast to all devices for which
macRxOnWhenIdle=TRUE (i.e., 0xFFFD)
Destination address mode:

Mode Value Description

ADDRESS_NOT_PRESENT 0x00 Address Not Present
DstAddrMode 1
GROUP_ADDRESS 0x01 Group address
ADDRESS_16_BIT 0x02 Address 16 bit
ADDRESS_64_BIT 0x03 Address 64 bit
BROADCAST 0xFF Broadcast

A bitmap indicating which channels are to be scanned:

Channel Value
NONE 0x00000000
ALL_CHANNELS 0x07FFF800
CHANNEL 11 0x00000800
CHANNEL 12 0x00001000
CHANNEL 13 0x00002000
CHANNEL 14 0x00004000
CHANNEL 15 0x00008000
ChannelMask 4 CHANNEL 16 0x00010000
CHANNEL 17 0x00020000
CHANNEL 18 0x00040000
CHANNEL 19 0x00080000
CHANNEL 20 0x00100000
CHANNEL 21 0x00200000
CHANNEL 22 0x00400000
CHANNEL 23 0x00800000
CHANNEL 24 0x01000000
CHANNEL 25 0x02000000
CHANNEL 26 0x04000000
ScanDuration 1 A value used to calculate the length of time to spend scanning each channel

91 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

ScanCount 1 This field represents the number of energy scans to be conducted and reported
Indicates the NWK address for the device with the Network Manager bit set in its
NwkManagerAddr 2
Node Descriptor

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x36 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.12.1.24 ZDO_MSG_CB_REGISTER

Description:
This command registers for a ZDO callback (see reference [3], “6. ZDO Message Requests” for
example usage).

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x25 Cmd1 = 0x3E ClusterId

Attributes:
Attribute Length (byte) Description
Specifies the ZDO Cluster Id for which to
ClusterId 2
receive a ZDO callback.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x3E Status

Attributes:
Attribute Length (byte) Description
Return value of the call to
Status 1
ZDO_RegisterForZDOMsg().

3.12.1.25 ZDO_MSG_CB_REMOVE

Description:
This command removes a registration for a ZDO callback (see reference [3], “6. ZDO Message
Requests” for example usage).

Usage:
SREQ:
1 1 1 2
Length = 0x02 Cmd0 = 0x25 Cmd1 = 0x3F ClusterId

Attributes:
Attribute Length (byte) Description
ClusterId 2 Specifies the ZDO Cluster Id for which to receive a ZDO callback.

92 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x3F Status

Attributes:
Attribute Length (byte) Description
Status 1 Return value of the call to ZDO_RemoveRegisteredCB ().

3.12.1.26 ZDO_STARTUP_FROM_APP

Description:
This command starts the device in the network.

Usage:
SREQ:
1 1 1 2
Length = 0x01 Cmd0 = 0x25 Cmd1 = 0x40 StartDelay

Attributes:
Attribute Length (byte) Description
StartDelay 2 Specifies the time delay before the device starts.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x40 Status

Attributes:
Attribute Length (byte) Description
0x00 – Restored network state
Status 1 0x01 – New network state
0x02 – Leave and not Started

3.12.1.27 ZDO_STARTUP_FROM_APP_EX
Description:
Extended version of ZDO to indicate to router devices to create a distributed network.

Usage:
SREQ:
1 1 1 1 1
Length = 0x01 Cmd0 = 0x25 Cmd1 = 0x54 StartDelay Mode

Attributes:
Attribute Length (byte) Description
StartDelay 1 Specifies the time delay before the device starts.
Flag for ZR devices to indicate to create a
distributed network if set to TRUE, if set to
Mode 1
FALSE or send to ZC or ZED has the same
effect as non-extended interface.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x40 Status

93 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
0x00 – Restored network state
Status 1
0x01 – New network state

3.12.1.28 ZDO_SET_LINK_KEY

Description:
This command sets the application link key for a given device.

Usage:
SREQ:
1 1 1 2 8 16
Length = 0x1A Cmd0 = 0x25 Cmd1 = 0x23 ShortAddr IEEEAddr LinkKeyData

Attributes:
Attribute Length (byte) Description
Specifies the short address of the pair device of
ShortAddr 2
the link key.
Specifies the IEEE address of the pair device of
IEEEAddr 8
the link key
LinkKeyData 16 128 bit link key data of the device.

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x23 Status

Attributes:
Attribute Length (byte) Description
0x00 – Success
Status 1 0x01 – Fail to add to address manager.
0x11 – Security manager key table full

3.12.1.29 ZDO_REMOVE_LINK_KEY
Description:
This command removes the application link key of a given device.

Usage:
SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x25 Cmd1 = 0x24 IEEEAddr

Attributes:
Attribute Length (byte) Description
Specifies the IEEE address of the pair device of
IEEEAddr 8
the link key

SRSP:
1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x24 Status

94 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
0x00 – Success
Status 1
0xC8 – Unknown device.

3.12.1.30 ZDO_GET_LINK_KEY

Description:
This command retrieves the application link key of a given device.

Usage:
SREQ:
1 1 1 8
Length = 0x08 Cmd0 = 0x25 Cmd1 = 0x25 IEEEAddr

Attributes:
Attribute Length (byte) Description
Specifies the IEEE address of the pair device of
IEEEAddr 8
the link key

SRSP:
1 1 1 1 8 16
Length = 0x19 Cmd0 = 0x65 Cmd1 = 0x25 Status IEEEAddr LinkKeyData

Attributes:
Attribute Length (byte) Description
0x00 – Success
Status 1
0xC8 – Unknown device.
IEEEAddr 8 IEEE address of the device
LinkKeyData 16 Link key data of the device.

3.12.1.31 ZDO_NWK_DISCOVERY_REQ
Description:
This command is used to initiate a network discovery (active scan).

Usage:
SREQ:
Byte: 1 1 1 4 1
Length = 0x05 Cmd0 = 0x25 Cmd1 = 0x26 Scan Channels Scan Duration

Attributes:
Attribute Length (byte) Description
Bit mask for channels to scan. Type: ZIGBEE_CHANNELS
Channel Value
NONE 0x00000000
ALL_CHANNELS 0x07FFF800
CHANNEL 11 0x00000800
Scan Channels 4 CHANNEL 12 0x00001000
CHANNEL 13 0x00002000
CHANNEL 14 0x00004000
CHANNEL 15 0x00008000
CHANNEL 16 0x00010000
CHANNEL 17 0x00020000

95 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

CHANNEL 18 0x00040000
CHANNEL 19 0x00080000
CHANNEL 20 0x00100000
CHANNEL 21 0x00200000
CHANNEL 22 0x00400000
CHANNEL 23 0x00800000
CHANNEL 24 0x01000000
CHANNEL 25 0x02000000
CHANNEL 26 0x04000000
A value used to calculate the length of time to spend scanning each
Scan Duration 1
channel

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x26 Status

Attributes:
Attribute Length (byte) Description
Success (0)
Invalid_Parameter (0x02).
ZNwkInvalidRequest (0xC2) if the device is already on a network.
User ZDO_MGMT_NWK_DISC_REQ instead. Or leave the
Status 1 network first, then initiate the request.
MAC_SCAN_IN_PROGRESS (0xFC) if a channel change is in
progress.
MAC_NO_RESOURCE (0x1A) if the operation could not
complete because no memory resource were available.

3.12.1.32 ZDO_JOIN_REQ
Description:
This command is used to request the device to join itself to a parent device on a network.

Usage:
SREQ:
Byte: 1 1 1 1 2
Length = 0x0F Cmd0 = 0x25 Cmd1 = 0x27 Logical Channel Pan ID
8 2 1 1
Extended Pan ID Chosen Parent Parent Depth Stack Profile

Attributes:
Attribute Length (byte) Description
Logical Channel 1 Channel where the PAN is located
Pan ID 2 Id of PAN to join
64-bit extended PAN ID (ver. 1.1 only). If not v1.1 or don't care,
Extended Pan ID 8
use all 0xFF
Chosen Parent 2 Short address of the parent device chosen to join
Parent Depth 1 Depth of the parent

96 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Stack Profile 1 Stack profile of the network to join

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x27 Status

Attributes:
Attribute Length (byte) Description
Success (0)
ZNwkInvalIdRequest (0xC2) if device is already on a network.
Status 1 Leave the network first, then try to join again.
ZNwkNotPermitted (0xC3) if chosen router is not a valid short
address.

3.12.1.33 ZDO_SET_REJOIN_PARAMETERS
Description:
This command is used to set rejoin backoff duration and rejoin scan duration for an end device

Usage:
SREQ:
Byte: 1 1 1 4 4

Length = 0x08 Cmd0 = 0x25 Cmd1 = 0x26 Backoff Duration Scan Duration

Attributes:
Attribute Length (byte) Description
Backoff Duration 4 Rejoin backoff duration for end device
Scan Duration 4 Rejoin scan duration for end device

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x27 Status

Attributes:
Attribute Length (byte) Description
Status 1 Success (0)

3.12.1.34 ZDO_SEC_ADD_LINK_KEY
Description:
This command handles the ZDO security add link key extension message.

Usage:
SREQ:
Byte: 1 1 1 2 8 16

97 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Length = 0x1A Cmd0 = 0x25 Cmd1 = 0x42 Short Address Extended Adress Key

Attributes:
Attribute Length (byte) Description
Short Address 2 short address of the partner device
Extended Address 8 extended address of the partner device
Key 16 Link key

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x42 Status

Attributes:
Attribute Length (byte) Description
Status 1 Success (0) or Failure(1)

3.12.1.35 ZDO_SEC_ENTRY_LOOKUP_EXT
Description:
This command handles the ZDO security entry lookup extended extension message.

Usage:
SREQ:
Byte: 1 1 1 8 5

Length = 0x013 Cmd0 = 0x25 Cmd1 = 0x43 Extended Adress Entry

Attributes:
Attribute Length (byte) Description
Extended Address 8 extended address
entry 5 Valid entry

SRSP:
Byte: 1 1 1 2 2 1
KeyNVID Authentication
Length = 0x05 Cmd0 = 0x65 Cmd1 = 0x42 AMI
option

98 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
AMI 2 Address manager index
KeyNVID 2 Index to link key table in NV
Authentication option 1 Authentication option for device

3.12.1.36 ZDO_SEC_DEVICE_REMOVE
Description:
This command handles the ZDO security remove device extended extension message.

Usage:
SREQ:
Byte: 1 1 1 8

Length = 0x08 Cmd0 = 0x25 Cmd1 = 0x44 Extended Adress

Attributes:
Attribute Length (byte) Description
Extended Address 8 extended address

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x44 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of device remove

3.12.1.37 ZDO_EXT_ROUTE_DISC
Description:
This command handles the ZDO route discovery extension message.

Usage:
SREQ:
Byte: 1 1 1 2 1 1
Destination Options Radius
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x45
Address

Attributes:
Attribute Length (byte) Description
Destination
2 Destination address
Address
Options 1 Route options
Radius 1 Broadcast radius

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x45 Status

99 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status of route discovery

3.12.1.38 ZDO_EXT_ROUTE_CHECK
Description:
This command handles the ZDO route check extension message.

Usage:
SREQ:
Byte: 1 1 1 2 1 1
Destination
Length = 0x04 Cmd0 = 0x25 Cmd1 = 0x46 RTStatus Options
Address

Attributes:
Attribute Length (byte) Description
Destination
2 Destination address
Address
RtStatus 1 Status value for routing entries
Options 1 Route options

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x46 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of route check

3.12.1.39 ZDO_EXT_REMOVE_GROUP
Description:
This command handles the ZDO extended remove group extension message.

Usage:
SREQ:
Byte: 1 1 1 1 2

Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x47 Endpoint GroupID

Attributes:
Attribute Length (byte) Description
Endpoint 1 Endpoint to look for
GroupID 2 ID to look for group

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x47 Status

100 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Status 1 Status of remove group

3.12.1.40 ZDO_EXT_REMOVE_ALL_GROUP
Description:
This command handles the ZDO extended remove all group extension message.

Usage:
SREQ:
Byte: 1 1 1 1

Length = 0x01 Cmd0 = 0x25 Cmd1 = 0x48 Endpoint

Attributes:
Attribute Length (byte) Description
Endpoint 1 Endpoint to look for

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x48 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of remove all groups

3.12.1.41 ZDO_EXT_FIND_ALL_GROUPS_ENDPOINT
Description:
This command handles the ZDO extension find all groups for endpoint message

Usage:
SREQ:
Byte: 1 1 1 1 2

Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x49 Endpoint GroupList

Attributes:
Attribute Length (byte) Description
Endpoint 1 Endpoint to look for
GroupList 2 List to hold group IDs

101 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
1+2*(number
Byte: 1 1 1
of groups)
Length =
0x01+2*(number Cmd0 = 0x65 Cmd1 = 0x49 Groups
of groups)

Attributes:
Attribute Length (byte) Description
1+2*(number
Groups Number of groups copied to group list
of groups)

3.12.1.42 ZDO_EXT_FIND_GROUP
Description:
This command handles the ZDO extension find group message

Usage:
SREQ:
Byte: 1 1 1 1 2

Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x4A Endpoint GroupID

Attributes:
Attribute Length (byte) Description
Endpoint 1 Endpoint to look for
GroupID 2 Group ID

SRSP:
Byte: 1 1 1 0-18
Length = 0x01-0x13 Cmd0 = 0x65 Cmd1 = 0x4A Group

Attributes:
Attribute Length (byte) Description
Group 0-18 Group information

3.12.1.43 ZDO_EXT_ADD_GROUP
Description:
This command handles the ZDO extension add group message.

Usage:
SREQ:
Byte: 1 1 1 1 2 16

Length = 0x013 Cmd0 = 0x25 Cmd1 = 0x4B Endpoint GroupID GroupName

Attributes:
Attribute Length (byte) Description
Endpoint 1 Endpoint to look for
GroupID 2 Group ID
GroupName 16 Group name

102 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x4B Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of adding group

3.12.1.44 ZDO_EXT_COUNT_ALL_GROUPS
Description:
This command handles the ZDO extension count all groups message.

Usage:
SREQ:
Byte: 1 1 1

Length = 0x00 Cmd0 = 0x25 Cmd1 = 0x4C

Attributes:
Attribute Length (byte) Description
None
SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x4C Status

Attributes:
Attribute Length (byte) Description
Status 1 Total number of groups

3.12.1.45 ZDO_EXT_RX_IDLE
Description:
This command handles the ZDO extension Get/Set RxOnIdle to ZMac message

Usage:
SREQ:
Byte: 1 1 1 1 1

Length = 0x02 Cmd0 = 0x25 Cmd1 = 0x4D SetFlag SetValue

Attributes:
Attribute Length (byte) Description
SetFlag 1 Set or get the value
SetValue 1 Value to be set to ZMac message

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x4D Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of get or set value

103 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1.46 ZDO_EXT_UPDATE_NWK_KEY
Description:
This command handles the ZDO security update network key extension message.

Usage:
SREQ:
Byte: 1 1 1 2 1 128
Destination
Length = 0x083 Cmd0 = 0x25 Cmd1 = 0x4E KeySeqNum Key
Address

Attributes:
Attribute Length (byte) Description
DestinationAddress 2 Destination address
KeySeqNum 1 Key Sequence number
Key 128 Network key

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x4E Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of key update

3.12.1.47 ZDO_EXT_SWITCH_NWK_KEY
Description:
This command handles the ZDO security switch network key extension message.

Usage:
SREQ:
Byte: 1 1 1 2 1
Destination
Length = 0x03 Cmd0 = 0x25 Cmd1 = 0x4F KeySeqNum
Address

Attributes:
Attribute Length (byte) Description
DestinationAddress 2 Destination address
KeySeqNum 1 Key Sequence number

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x4F Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of key switch

3.12.1.48 ZDO_EXT_NWK_INFO
Description:
This command handles the ZDO extension network message.

104 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1

Length = 0x00 Cmd0 = 0x25 Cmd1 = 0x50

Attributes:
Attribute Length (byte) Description
None
SRSP:
Byte: 1 1 1 2 2 2 8 8 2
PAN Parent Extended Extended Channel
Length = Short
Cmd0 = 0x65 Cmd1 = 0x50 ID address PAN ID Parent
0x18 Address
Address

Attributes:
Attribute Length (byte) Description
Short Address 2 Short address
PAN ID 2 PAN ID
Parent Address 2 Parent address
Extended PAN ID 8 Extended PAN ID
Extended Parent
8 IEEE address of parent
Address
Channel 2 Current channel

3.12.1.49 ZDO_EXT_SEC_APS_REMOVE_REQ

Description:
This command handles the ZDO extension Security Manager APS Remove Request message.

Usage:
SREQ:
Byte: 1 1 1 2 8 2
Extended
Length = 0x0c Cmd0 = 0x25 Cmd1 = 0x51 NWK Address Parent address
Address

Attributes:
Attribute Length (byte) Description
NWK Address 2 Device’s network address
Extended Address 8 IEEE address of device
Parent Address 2 Parent’s network address

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x51 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of removing device from the network

105 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.1.50 ZDO_FORCE_CONCENTRATOR_CHANGE
Description:
This command forces a network concentrator change by resetting zgConcentratorEnable and
zgConcentratorDiscoveryTime from NV and set nwk event.

Usage:
SREQ:
Byte: 1 1 1

Length = 0x00 Cmd0 = 0x25 Cmd1 = 0x52

Attributes:
Attribute Length (byte) Description
None
SRSP:
Byte: 1 1 1
Length = 0x00 Cmd0 = 0x65 Cmd1 = 0x52

Attributes:
Attribute Length (byte) Description
None

3.12.1.51 ZDO_EXT_SET_PARAMS
Description:
This command set parameters not settable through NV.
Usage:
SREQ:
Byte: 1 1 1 1
useMulticast
Length = 0x01 Cmd0 = 0x25 Cmd1 = 0x53

Attributes:
Attribute Length (byte) Description
useMulticast 1 Set or reset the use of multicast

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x53 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status of use of multicast

3.12.1.52 ZDO_NWK_ADDR_OF_INTEREST_REQ
Description:
This command handles ZDO network address of interest request.
Usage:

106 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

SREQ:
Byte: 1 1 1 2 2 1
destAddr nwkAddrofIntere cmd
Length = 0x05 Cmd0 = 0x25 Cmd1 = 0x29 st

Attributes:
Attribute Length (byte) Description
destAddr 2 Destination Address
nwkAddrofInterest 2 16 bit network address of interest
cmd 1 A valid cluster ID as specified by the Profile

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x65 Cmd1 = 0x29 Status

Attributes:
Attribute Length (byte) Description
Status 1 AF status

3.12.2 MT_ZDO Callbacks

3.12.2.1 ZDO_NWK_ADDR_RSP
Description:
This command is issued by the tester to return the results from a ZDO_NWK_ADDR_REQ.

Usage
AREQ:
1 1 1 1 8 2
Length = 0x0D-0x53 Cmd0 = 0x45 Cmd1 = 0x80 Status IEEEAddr NwkAddr

1 1 0-70
StartIndex NumAssocDev AssocDevList

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS or FAILURE.
IEEEAddr 8 64 bit IEEE address of source device.
NwkAddr 2 Specifies the short network address of responding device.
StartIndex 1 Specifies the starting index into the list of associated devices for this report.
NumAssocDev 1 Specifies the number of associated devices.
Contains the list of network address for associated devices. This list can be a
AssocDevList 0-70 partial list if the entire list doesn’t fit into a packet. If it is a partial list, the starting
index is StartIndex.

3.12.2.2 ZDO_IEEE_ADDR_RSP

Description:
This callback message is in response to the ZDO IEEE Address Request.

107 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
1 1 1 1 8 2
Length = 0x0D-0x53 Cmd0 = 0x45 Cmd1 = 0x81 Status IEEEAddr NwkAddr

1 1 0-70
StartIndex NumAssocDev AssocDevList

Attributes:
Attribute Length (byte) Description
Status 1 This field indicates either SUCCESS or FAILURE.
IEEEAddr 8 64 bit IEEE address of source device.
NwkAddr 2 Specifies the short network address of responding device.
StartIndex 1 Specifies the starting index into the list of associated devices for this report.
NumAssocDev 1 Specifies the number of associated devices.
Contains the list of network address for associated devices. This list can be a
AssocDevList 0-70 partial list if the entire list doesn’t fit into a packet. If it is a partial list, the starting
index is StartIndex.

3.12.2.3 ZDO_NODE_DESC_RSP

Description:
This callback message is in response to the ZDO Node Descriptor Request.

Usage:
AREQ:
1 1 1 2 1 2
Length = 0x12 Cmd0 = 0x45 Cmd1 = 0x82 SrcAddr Status NwkAddr

1 1 1 2
LogicalType/ APSFlags/ MACCapabilityFlags ManufacturerCode
ComplexDescAvailable/ FrequencyBand
UserDescAvailable

1 2 2 2 1
MaxBufferSize MaxTransferSize ServerMask MaxOutTransferSize DescriptorCapabilities

Attributes:
Length
Attribute Description
(byte)
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddrOfInterest 2 Device’s short address of this Node descriptor
Logical Type: Bit 0-2 –
Description Value
ZigBee Coordinator 0
ZigBee Router 1
LogicalType/ ZigBee End Device 2
ComplexDescriptorAvailable/ 1
ComplexDescriptorAvailable: Bit 3 – Indicates if
UserDescriptorAvailable
complex descriptor is available for the node
UserDescriptorAvailable: Bit 4 – Indicates if user
descriptor is available for the node
Reserved: Bit 5-7 – Reserved for future use
APSFlags – Bit 0-4 – Node Flags assigned for APS. For
V1.0 all bits are reserved.
APSFlags/FrequencyBand 1
NodeFrequencyBand – Bit 5-7 – Identifies node
frequency band capabilities

108 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Capability flags stored for the MAC:

Description Value
CAPINFO_DEVICETYPE_RFD 0x00
CAPINFO_ALTPANCOORD 0x01
MacCapabilitiesFlags 1 CAPINFO_DEVICETYPE_FFD 0x02
CAPINFO_POWER_AC 0x04
CAPINFO_RCVR_ON_IDLE 0x08
CAPINFO_SECURITY_CAPABLE 0x40
CAPINFO_ALLOC_ADDR 0x80

Specifies a manufacturer code that is allocated by the

ManufacturerCode 2 ZigBee Alliance, relating to the manufacturer to the
device.
Indicates size of maximum NPDU. This field is used as
MaxBufferSize 1
a high level indication for management.
Indicates maximum size of Transfer up to 0x7fff (This
MaxInTransferSize 2
field is reserved in version 1.0 and shall be set to zero).
Bit 0 - Primary Trust Center
1 - Backup Trust Center
2 - Primary Binding Table Cache
ServerMask 2
3 - Backup Binding Table Cache
4 - Primary Discovery Cache
5 - Backup Discovery Cache
Indicates maximum size of Transfer up to 0x7fff (This
MaxOutTransferSize 2
field is reserved in version 1.0 and shall be set to zero).
DescriptorCapabilities 1 Specifies the Descriptor capabilities

3.12.2.4 ZDO_POWER_DESC_RSP
Description:
This callback message is in response to the ZDO Power Descriptor Request.

Usage:
AREQ:
1 1 1 2 1 2
Length = 0x07 Cmd0 = 0x45 Cmd1 = 0x83 SrcAddr Status NwkAddr

1 1
CurrentPowerMode/AvailablePowerSources CurrentPowerSource/CurrentPowerSourceLevel

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Specifies the message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
Specifies Device’s short address that this response
NWKAddr 2
describes.
- CurrentPowerMode: bits 3-0
CurrentPowerMode/AvailablePowerSources 1 - AvailablePowerSources: bits 7-4

- CurrentPowerSource: bits 3-0

CurrentPowerSource/CurrentPowerSourceLevel 1 - CurrentPowerSourceLevel: bits 7-4

3.12.2.5 ZDO_SIMPLE_DESC_RSP

Description:
This callback message is in response to the ZDO Simple Descriptor Request

109 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
1 1 1 2 1 2 1
Length = 0x06-4E Cmd0 = 0x45 Cmd1 = 0x84 SrcAddr Status NwkAddr Len

1 2 2 1
Endpoint ProfileId DeviceId DeviceVersion

1 0-32 1 0-32
NumInClusters InClusterList NumOutClusters OutClusterList

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Specifies the message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddr 2 Specifies Device’s short address that this response describes.
Len 1 Specifies the length of the simple descriptor
Endpoint 1 Specifies Endpoint of the device
ProfileId 2 The profile Id for this endpoint.
DeviceId 2 The Device Description Id for this endpoint.
Defined as the following format
DeviceVersion 1 0 – Version 1.00
0x01-0x0F – Reserved.
NumInClusters 1 The number of input clusters in the InClusterList.
InClusterList 0-32 List of input cluster Id’s supported.
NumOutClusters 1 The number of output clusters in the OutClusterList.
OutClusterList 0-32 List of output cluster Id’s supported.

3.12.2.6 ZDO_ACTIVE_EP_RSP

Description:
This callback message is in response to the ZDO Active Endpoint Request.

Usage:
AREQ:
1 1 1 2 1 2 1
Length = 0x06-0x53 Cmd0 = 0x45 Cmd1 = 0x85 SrcAddr Status NwkAddr ActiveEPCount

0-77
ActiveEPList

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddr 2 Device’s short address that this response describes.
ActiveEPCount 1 Number of active endpoint in the list
ActiveEPList 0-77 Array of active endpoints on this device.

3.12.2.7 ZDO_MATCH_DESC_RSP

Description:
This callback message is in response to the ZDO Match Descriptor Request.

110 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
1 1 1 2 1 2 1
Length = 0x06-0x53 Cmd0 = 0x45 Cmd1 = 0x86 SrcAddr Status NwkAddr MatchLength

0-77
MatchList

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddr 2 Device’s short address that this response describes.
MatchLength 1 The count of endpoints on the remote device that match the request criteria
MatchList 0-77 List of bytes, each represents an 8 bit endpoint

3.12.2.8 ZDO_COMPLEX_DESC_RSP

Description:
This callback message is in response to the ZDO Complex Descriptor Request.

Usage:
AREQ:
1 1 1 2 1 2 1
Length = 0x06-0x53 Cmd0 = 0x45 Cmd1 = 0x87 SrcAddr Status NwkAddr ComplexLength

0-77
ComplexList

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddr 2 Device’s short address that this response describes.
ComplexLength 1 Length of the complex descriptor.
ComplexDescriptor 0-77 Array of bytes contains the complex descriptor.

3.12.2.9 ZDO_USER_DESC_RSP

Description:
This callback message is in response to the ZDO User Descriptor Request.

Usage:
AREQ:
1 1 1 2 1 2 1 0-77
Length = 0x06-0x16 Cmd0 = 0x45 Cmd1 = 0x88 SrcAddr Status NwkAddr Len UserDescriptor

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddr 2 Device’s short address that this response describes.
UserLength 1 Length of the complex descriptor.
UserDescriptor 0-77 Array of bytes contains user descriptor.

111 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.2.10 ZDO_USER_DESC_CONF

Description:
This confirmation notifies the user when the device receives a user descriptor.

Usage:
AREQ:
1 1 1 2 1 2
Length = 0x05 Cmd0 = 0x45 Cmd1 = 0x89 SrcAddr Status NwkAddr

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS or FAILURE.
NWKAddr 2 Device’s short address that this response describes.

3.12.2.11 ZDO_SERVER_DISC_RSP

Description:
This callback message is in response to the ZDO System Service Discovery Request. Upon
receiving the request, remote devices shall compare the ServerMask parameter to the Server Mask
field in their own Node descriptor. If no bits are found to match, no action is taken.

Usage:
AREQ:
1 1 1 2 1 2
Length = 0x05 Cmd0 = 0x45 Cmd1 = 0x8A SrcAddr Status ServerMask

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
Each bit signifies one system server capability of the node. The bit
setting is defined in the following table:

Bit Number Assignment

0 Primary Trust Center
1 Backup Trust Center
Server Mask 2 2 Primary Binding Table Cache
3 Backup Binding Table Cache
4 Primary Discovery Cache
5 Backup Discovery Cache
6– 15 Reserved

3.12.2.12 ZDO_END_DEVICE_BIND_RSP
Description:
This callback message is in response to the ZDO End Device Bind Request.

112 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x45 Cmd1 = 0xA0 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.12.2.13 ZDO_BIND_RSP
Description:
This callback message is in response to the ZDO Bind Request.

Usage:
AREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x45 Cmd1 = 0xA1 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.12.2.14 ZDO_UNBIND_RSP

Description:
This callback message is in response to the ZDO Unbind Request.

Usage:
AREQ:
Byte: 1 1 1 2 1
Length = 0x03 Cmd0 = 0x45 Cmd1 = 0xA2 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 The message’s source network address.
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.12.2.15 ZDO_MGMT_NWK_DISC_RSP

Description:
This callback message is in response to the ZDO Management Network Discovery Request.

Usage:
AREQ:
1 1 1 2 1 1 1
Length = 0x06-0x4E Cmd0 = 0x45 Cmd1 = 0xB0 SrcAddr Status NetworkCount StartIndex

1 0-72
NetworkListCount NetworkList Records

113 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Lengt
Attribute h Description
(byte)
SrcAddr 2 Source address of the message.
Status 1 This field indicates either SUCCESS or FAILURE.
NetworkCount 1 Total number of entries available in the device.
StartIndex 1 Where in the total number of entries this response starts.
NetworkListCou
1 Number of entries in this response.
nt

An array of NetworkList items. NetworkListCount contains the number of items in this

table

Name Size Description

PAN ID/Extended PAN 2 bytes PAN ID of the neighbor device
ID
Logical Channel 1 byte The current logical channel occupied by the
network.
NetworkList List Stack Profile / ZigBee 1 byte StackProfile: bits 3-0
Version ZigBeeVersion: bits 7-4
A ZigBee stack profile Identifier indicating the
stack profile in use in the discovered network.
The version of the ZigBee protocol in use in
the discovered network.
Beacon Order / Super 1 byte BeaconOrder: bits 3-0
frame Order SuperframeOrder: bits 7-4
Permit Joining 1 byte Permit joining flag

3.12.2.16 ZDO_MGMT_LQI_RSP

Description:
This callback message is in response to the ZDO Management LQI Request.

Usage:
AREQ:
1 1 1 2 1 1 1
Length = 0x06-0x48 Cmd0 = 0x45 Cmd1 = 0xB1 SrcAddr Status NeighborTableEntries StartIndex

1 0-66
NeighborTableListCount NeighborTableListRecords

Attributes:
Length
Attribute Description
(byte)
SrcAddr 2 Source address of the message.
Status 1 This field indicates either SUCCESS or FAILURE.
NeighborTableEntries 1 Total number of entries available in the device.
StartIndex 1 Where in the total number of entries this response starts.
NeighborLqiListCount 1 Number of entries in this response.

114 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

An array of NeighborLqiList items. NeighborLQICount contains the

number of items in this table.

Name Size Description

ExtendedPanID 8 bytes Extended PAN ID of the
neighbor device
ExtendedAddress 8 bytes Network extended address

NetworkAddress 2 bytes Device short address

NeighborLqiList 0-66
DeviceType/ 1 byte DeviceType: bits 1-0
RxOnWhenIdle/ RxOnWhenIdle: bits 3-2
Relationship Relationship: bits 6-4

PermitJoining 1 byte PermitJoining: bits 1-0

Depth 1 byte

LQI 1 byte

3.12.2.17 ZDO_MGMT_RTG_RSP

Description:
This callback message is in response to the ZDO Management Routing Table Request.

Usage:
AREQ:
1 1 1 2 1 1 1
Length = 0x06-0x51 Cmd0 = 0x45 Cmd1 = 0xB2 SrcAddr Status RoutingTableEntries StartIndex

1 0-75
RoutingTableListCount RoutingTableListRecords

Attributes:
Length
Attribute Description
(byte)
SrcAddr 2 Source address of the message.
Status 1 This field indicates either SUCCESS or FAILURE.
RoutingTableEntries 1 Total number of entries available in the device.
StartIndex 1 Where in the total number of entries this response starts.
RoutingTableListCount 1 Number of entries in this response.
An array of RtgList items. RtgListCount contains the number
of items in this table.

Name Size Description

Destination 2 bytes Network destination
Address address
Status 1 byte Route status: bits 2-0

RoutingTableList 0-75 0x00 Active

0x01 Discovery Underway
0x02 Discovery Failed
0x03 Inactive
0x04 – 0x07 Reserved
Next Hop 2 bytes Next hop network address

115 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.2.18 ZDO_MGMT_BIND_RSP

Description:
This callback message is in response to the ZDO Management Binding Table Request.

Usage:
AREQ:
Byte: 1 1 1 2 1 1 1
Length = 0x06-0x51 Cmd0 = 0x45 Cmd1 = 0xB3 SrcAddr Status BindingTableEntries StartIndex

1 0-75
BindingTableListCount BindingTableListRecords

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Source address of the message
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).
BindTableEntries 1 Total number of entries available in the device.
StartIndex 1 Where in the total number of entries this response starts.
BindTableListCount 1 Number of entries in this response.

An array of BindList items. BindListCount contains the number of items in

this table.
Name Size Description
SrcAddr 8 bytes Binding Entry’s source IEEE address
SrcEndpoint 1 byte Binding Entry’s source endpoint

ClusterId 1 byte Message Id in binding table

BindTableList List
DstAddrMode 1 byte Address mode for binding entry’s
destination address
DstAddr 8 bytes Binding Entry’s destination IEEE address
DstEndpoint 1 byte Binding Entry’s destination endpoint. For
V1.1, this field is only present when the
DestAddrMode is 64-bits extended
address.

3.12.2.19 ZDO_MGMT_LEAVE_RSP

Description:
This callback message is in response to the ZDO Management Leave Request.

Usage:
AREQ:
Byte: 1 1 1 2 1
Length = 0x03 Cmd0 = 0x45 Cmd1 = 0xB4 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Source address of the message
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

116 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.2.20 ZDO_MGMT_DIRECT_JOIN_RSP

Description:
This callback message is in response to the ZDO Management Direct Join Request.

Usage:
AREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x45 Cmd1 = 0xB5 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Source address of the message
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.12.2.21 ZDO_MGMT_PERMIT_JOIN_RSP
Description:
This callback message is in response to the ZDO Management Permit Join Request.

Usage:
AREQ:
1 1 1 2 1
Length = 0x03 Cmd0 = 0x45 Cmd1 = 0xB6 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Source address of the message.
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

3.12.2.22 ZDO_STATE_CHANGE_IND
Description:
This callback message indicates the ZDO state change.

Usage:
AREQ:
1 1 1 1
Length = 0x01 Cmd0 = 0x45 Cmd1 = 0xC0 State

Attributes:
Attribute Length (byte) Description
State 1 Specifies the changed ZDO state.

3.12.2.23 ZDO_END_DEVICE_ANNCE_IND

Description:
This callback indicates the ZDO End Device Announce.

117 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
Byte: 1 1 1 2 2 8 1
Length = 0x0D Cmd0 = 0x45 Cmd1 = 0xC1 SrcAddr NwkAddr IEEEAddr Capabilites

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Source address of the message.
NwkAddr 2 Specifies the device’s short address.
IEEEAddr 8 Specifies the 64 bit IEEE address of source device.
Specifies the MAC capabilities of the device.
Bit: 0 – Alternate PAN Coordinator
1 – Device type: 1- ZigBee Router; 0 – End Device
2 – Power Source: 1 Main powered
Capabilites 1 3 – Receiver on when Idle
4 – Reserved
5 – Reserved
6 – Security capability
7 – Reserved

3.12.2.24 ZDO_MATCH_DESC_RSP_SENT

Description:
This callback indicates that Match Descriptor Response has been sent.

Usage:
AREQ:
Byte: 1 1 1 2
Length = 0x04-0x44 Cmd0 = 0x45 Cmd1 = 0xC2 NwkAddr

1 0-32 1 0-32
NumInClusters InClusterList NumOutClusters OutClusterList

Attributes:
Attribute Length (byte) Description
NwkAddr 2 Specifies the device’s short address
NumInClusters 1 The number of input clusters in the InClusterList.
InClusterList 0-32 List of input cluster Id’s supported.
NumOutClusters 1 The number of output clusters in the OutClusterList.
OutClusterList 0-32 List of output cluster Id’s supported.

3.12.2.25 ZDO_STATUS_ERROR_RSP

Description:
This message is the default message for error status.

Usage:
AREQ:
Byte: 1 1 1 2 1
Length = 0x04-0x44 Cmd0 = 0x45 Cmd1 = 0xC3 SrcAddr Status

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Source address of the message
Status 1 This field indicates either SUCCESS (0) or FAILURE (1).

118 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.2.26 ZDO_SRC_RTG_IND
Description:
This message is an indication to inform host device the receipt of a source route to a given device.

Usage:
AREQ:
Byte: 1 1 1 2 1 2N
Length = 0x04-0x44 Cmd0 = 0x45 Cmd1 = 0xC4 dstAddr Relay Count (N) Relay List

Attributes:
Attribute Length (byte) Description
DstAddr 2 Short address of the destination of the source route
This field indicates number of devices in the relay list of
Relay Count 1
the source route.
This field contains the list of devices in the relay list of the
Relay List 2N source route. It includes a two bytes short address for each
device.

3.12.2.27 ZDO_BEACON_NOTIFY_IND
Description:
This message is an indication to inform host device the receipt of a beacon notification.

Usage:
AREQ:
Byte: 1 1 1 1 N*21
Length = 21 Cmd0 = 0x45 Cmd1 = 0xC5 BeaconCount BeaconList

Attributes:
Length
Attribute Description
(byte)
BeaconCount 1 Number of beacons in the packet.
An array of BeaconList items. BeaconCount contains the number of
items in this table.

Name Size Description

Short address of the
Source Address 2 source device of the
beacon
Pan ID 2 ID of the PAN
Channel where the PAN is
Logical Channel 1
located.
N*21 Flag to indicate whether
BeaconList (N is Permit Joining 1 the device accept
BeaconCount) association.
Flag to indicate whether
Router Capacity 1 the device accept other
router to associate
Flag to indicate whether
Device Capacity 1 the device accept other
device to associate
Version of the ZigBee
protocol. Value '1'
Protocol Version 1 represents ZigBee 2004.
Value '2' represents
ZigBee 2006/2007

119 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Stack profile of the PAN:

Stack Profile 1 for ZigBee
Stack Profile 1
and Stack Profile 2 for
ZigBee Pro.
LQI LQI (Link quality
1 indicator) measurement of
the beacon.
Depth Depth of the source
device, i.e. number of
1
hops from the device to
the ZigBee coordinator.
Update ID 1 Update ID of the device.
64 bit extended Pan ID of
Extended Pan ID 8
the Pan.

3.12.2.28 ZDO_JOIN_CNF
Description:
This message is an indication to inform host device the result of a ZDO join request.

Usage:
AREQ:
Byte: 1 1 1 1 2 2
Length = 0x05 Cmd0 = 0x45 Cmd1 = 0xC6 status Device Parent
Address Address

Attributes:
Attribute Length (byte) Description
Return status of the join request:
Success (0)
Status 1
ZMAC_NO_ACK (0xE9) if the chosen parent device dId
not respond to the association request.
Device Address 2 Short address of the device.
Parent Address 2 Short address of the parent device

3.12.2.29 ZDO_NWK_DISCOVERY_CNF
Description:
This message is an indication to inform host device the completion of network discovery scan.

Usage:
AREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x45 Cmd1 = 0xC7 status

Attributes:
Attribute Length (byte) Description
Return status of the network discovery.
Success (0)
Status 1 ZMAC_NO_BEACON (0xEA)
ZMAC_INVALID_PARAMETER (0xE8) if input
parameter is out of valid range.

120 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.12.2.30 ZDO_LEAVE_IND

Description:
This message is an indication to inform the host of a device leaving the network.

Usage:
AREQ:
Byte: 1 1 1 2 8 1 1 1
Length=0x0D Cmd0=0x45 Cmd1=0xC9 SrcAddr ExtAddr Request Remove Rejoin

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Short address (LSB-MSB) of the source of the leave indication.
ExtAddr 8 Extended address (LSB-MSB) of the source of the leave indication.
Request 1 Boolean, TRUE = request, FALSE = indication.
Remove 1 Boolean, TRUE = remove children.
Rejoin 1 Boolean, TRUE = rejoin.

3.12.2.31 ZDO_MSG_CB_INCOMING
Description:
This message is a ZDO callback for a Cluster Id that the host requested to receive with a ZDO_
MSG_CB_REGISTER request.

Usage:
AREQ:
Byte: 1 1 1 2 1 2
Length = 0x09-Max Cmd0 = 0x45 Cmd1 = 0xFF SrcAddr WasBroadcast ClusterId
MTU length

1 1 2 0-Max MTU length

SecurityUse SeqNum MacDstAddr Data

Attributes:
Attribute Length (byte) Description
SrcAddr 2 Short address (LSB-MSB) of the source of the ZDO message.
WasBroadcast 1 This field indicates whether or not this ZDO message was broadcast.
ClusterId 2 The ZDO Cluster Id of this message.
SecurityUse 1 N/A – not used.
SeqNum 1 The sequence number of this ZDO message.
The MAC destination short address (LSB-MSB) of the ZDO
MacDstAddr 2
message.
The data that corresponds to the Cluster Id of the message (see
0-Max MTU
Data reference [4], “ZDO Parsing Functions” for information on parsing
length.
the data that corresponds to each ZDO Cluster Id).

3.12.2.32 ZDO_TC_DEV_IND

Description:
This message is a ZDO callback for TC Device Indication.

121 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
AREQ:
Byte: 1 1 1 2 8 2
Length = 0x0C Cmd0 = 0x45 Cmd1 = 0xCA SrcNwkA SrcIEEEAddr Parent
ddr Nwk Addr

Attributes:
Attribute Length (byte) Description
SrcNwkAddr 2 Source network Address.
WasBroadcast 8 IEEE Address of the source
ParentNwkAddr 2 Network address of the parent

3.12.2.33 ZDO_PERMIT_JOIN_IND
Description:
This message is a ZDO callback for Permit Join Indication.

Usage:
AREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x45 Cmd1 = 0xCB PermitJoinDuration

Attributes:
Attribute Length (byte) Description
Permit Join
1 Duration for which joining is permitted
Duration

3.13 MT_APP_CONFIG

This interface allows the tester to issue commands to configure some parameters of the device, trust
center and BDB subsystem.

3.13.1 MT_APP_CONFIG Commands

3.13.1.1 APP_CNF_SET_NWK_FRAME_COUNTER

Description:
This message sets the network frame counter to the value specified in the Frame Counter Value.
For projects with multiple instances of frame counter, the message sets the frame counter of the
current network.

Usage:
This message should only be use for debugging purposes. Changing the network frame counter in
a production device, may cause the failures in the authentication process with other devices in the
network.
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0xFF Frame Counter Value

122 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Attribute Length (byte) Description
Set the network frame counter to the
Frame Counter Value 4
specified value

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0xFF Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.13.1.2 APP_CNF_SET_DEFAULT_REMOTE_ENDDEVICE
_TIMEOUT

Description:
Sets the default value used by parent device to expire legacy child devices.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0x01 Timeout Index

Attributes:
Attribute Length (byte) Description
Specifies the number of seconds until the timeout
Timeout Index 1 expires, according to the next list:

0x00 10 seconds
0x01 2 minutes
0x02 4 minutes
0x03 8 minutes
0x04 16 minutes
0x05 32 minutes
0x06 64 minutes
0x07 128 minutes
0x08 256 minutes (Default)
0x09 512 minutes
0x0A 1024 minutes
0x0B 2048 minutes
0x0C 4096 minutes
0x0D 8192 minutes
0x0E 16384 minutes
SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x01 Status

Attributes:
Attribute Length (byte) Description
Status is either Success (0) or Invalid
Status 1
Parameter (2).

3.13.1.3 APP_CNF_SET_ENDDEVICETIMEOUT

Description:
Sets in ZED the timeout value to be send to parent device for child expiring.

123 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0x02 Timeout Index

Attributes:
Attribute Length (byte) Description
Specifies the number of seconds until the timeout
Timeout Index 1 expires, according to the next list:

0x00 10 seconds
0x01 2 minutes
0x02 4 minutes
0x03 8 minutes
0x04 16 minutes
0x05 32 minutes
0x06 64 minutes
0x07 128 minutes
0x08 256 minutes (Default)
0x09 512 minutes
0x0A 1024 minutes
0x0B 2048 minutes
0x0C 4096 minutes
0x0D 8192 minutes
0x0E 16384 minutes
SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x02 Status

Attributes:
Attribute Length (byte) Description
Status is either Success (0) or Invalid
Status 1
Parameter (2).

3.13.1.4 APP_CNF_SET_ALLOWREJOIN_TC_POLICY

Description:
Sets the AllowRejoin TC policy.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0x03 Allow Rejoin

Attributes:
Attribute Length (byte) Description
This value specifies whether or not the Trust Center
Allow Rejoin 1
allows devices to rejoin.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x05 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

124 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.13.1.5 APP_CNF_BDB_START_COMMISSIONING

Description:
Set the commissioning methods to be executed. Initialization of BDB is executed with this call,
regardless of its parameters.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0x05 Commissioning
mode

Attributes:
Attribute Length (byte) Description
This value specifies the commissioning mode
Commissioning
1 according to this list:
Mode
0x00 Initialization
0x01 TouchLink
0x02 Network Steering
0x04 Network Formation
0x08 Finding and Binding

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x05 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.13.1.6 APP_CNF_BDB_SET_CHANNEL

Description:
Sets BDB primary or secondary channel masks.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x05 Cmd0 = 0x2F Cmd1 = 0x08 isPrimary
4
Channel

Attributes:
Attribute Length (byte) Description
This value specifies if the present channel set is
isPrimary 1
either primary or secondary.
This is the value of the channel set according to the
Channel 4
following list of masks.
Channel 11 0x00000800
Channel 12 0x00001000
Channel 13 0x00002000
Channel 14 0x00004000
Channel 15 0x00008000
Channel 16 0x00010000
Channel 17 0x00020000
Channel 18 0x00040000
Channel 19 0x00080000

125 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Channel 20 0x00100000
Channel 21 0x00200000
Channel 22 0x00400000
Channel 23 0x00800000
Channel 24 0x01000000
Channel 25 0x02000000
Channel 26 0x04000000

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x08 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.13.1.7 APP_CNF_BDB_ADD_INSTALLCODE

Description:
Add a preconfigured key (plain key or IC) to Trust Center device.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x19-0x1B Cmd0 = 0x2F Cmd1 = 0x04 installCodeFormat
8 16-18
IEEEAddress installCode

Attributes:
Attribute Length (byte) Description
This value specifies the format in which the install code is
installCodeFormat 1 being added. The following list contains the values
corresponding to the supported formats:
0x01 Install Code + CRC
0x02 Key derived from Install Code

IEEEAddress 8 Full IEEE address for the device joining the network
installCode 16-18 16 Bytes for the Key derived from the IC
18 Bytes for the Install Code +CRC

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x04 Status

Attributes:
Attribute Length (byte) Description
Status values:
0x00 Success
Status 1
0x01 Failure (IC not supported)
0x02 Invalid parameter (bad CRC)

3.13.1.8 APP_CNF_BDB_SET_TC_REQUIRE_KEY_EXCHANGE

Description:
Sets the policy flag on Trust Center device to mandate or not the TCLK exchange procedure.

126 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0x09 bdbTrustCenterRequireKeyExchange

Attributes:
Length
Attribute Description
(byte)
The bdbTrustCenterRequireKeyExchange
attribute specifies whether the Trust Center
requires a joining device to exchange its initial
link key with a new link key generated by the
Trust Center. If
bdbTrustCenterRequireKeyExchange is equal
to TRUE, the joining node must undergo the
link key exchange procedure; failure to
bdbTrustCenterRequireKeyExchange 1
exchange the link key will result in the node
being removed from the network. If
bdbTrustCenterRequireKeyExchange is equal
to FALSE, the Trust Center will permit the
joining node to remain on the network without
exchanging its initial link key. This attribute is
used by ZigBee coordinator nodes.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x09 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.13.1.9 APP_CNF_BDB_SET_JOINUSESINSTALLCODEKEY

Description:
Sets the policy to mandate or not the usage of an Install Code upon joining.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x2F Cmd1 = 0x06 bdbJoinUsesInstallCodeKey

Attributes:
Length
Attribute Description
(byte)
If it is equal to TRUE and the installation code
derived link key is not stored, the Trust Center
SHALL terminate the procedure for adding a new
node into the network. If bdbJoinUsesInstall-
CodeKey is equal to TRUE and the installation code
bdbJoinUsesInstallCodeKey 1 derived link key is stored, the Trust Center SHALL
first find the entry in apsDeviceKeyPairSet that
corresponds to the joining node and then overwrite
the LinkKey entry with the installation code derived
link key and set the KeyAttributes field to
PROVISIONAL_KEY. The Trust Center MAY then

127 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

set OutgoingFrame- Counter to 0 and SHALL set

IncomingFrameCounter to 0. If
bdbJoinUsesInstallCodeKey is equal to FALSE, the
Trust Center SHALL first find the entry in
apsDeviceKeyPairSet that corresponds to the joining
node and then overwrite the LinkKey entry with the
default global Trust Center link key and set the
KeyAttributes field to PROVISIONAL_KEY. The
Trust Center MAY then set OutgoingFrameCounter
to 0 and SHALL set IncomingFrameCounter to 0.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x06 Status

Attributes:
Attribute Length (byte) Description
Status 1 Status is either Success (0) or Failure (1).

3.13.1.10 APP_CNF_BDB_SET_ACTIVE_DEFAULT_CENTRALIZED_K
EY

Description:
On joining devices, set the default key or an install code to attempt to join the network.

Usage:
SREQ:
Byte: 1 1 1 1
Length = 0x13 Cmd0 = 0x2F Cmd1 = 0x07 useGlobal
18
InstallCode

Attributes:
Attribute Length (byte) Description
This parameter defines whether the device joining the
useGlobal 1 network will use a Default Global Key (if set to TRUE)
or an Install Code (if set to FALSE).
InstallCode 18 Value of the Install Code + CRC

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x07 Status

Attributes:
Attribute Length (byte) Description
Status values:
0x00 Success
Status 1
0x01 Failure (IC not supported)
0x02 Invalid Parameters (bad CRC)

3.13.1.11 APP_CNF_BDB_ZED_ATTEMPT_RECOVER_NWK

Description:
Instruct the ZED to try to rejoin its previews network. Use only in ZED devices.

128 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Usage:
SREQ:
1 1 1
Length = 0x00 Cmd0 = 0x2F Cmd1 = 0x0A

Attributes:

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x6F Cmd1 = 0x0A Status

Attributes:
Attribute Length (byte) Description
Status values:
0x00 Success
Status 1
0x01 Failure (Device not ZED or doesn’t
have network parameters)

3.13.2 MT_APP_CONFIG Callbacks

3.13.2.1 APP_CNF_BDB_COMMISSIONING_NOTIFICATION

Description:
Callback to receive notifications from BDB process.

Usage:
AREQ:
Byte: 1 1 1 1 1 1
Remaining
Commissioning
Length = 0x03 Cmd0 = 0x4F Cmd1 = 0x80 Status commissioning
mode
modes

Attributes:
Length
Attribute Description
(byte)
Status of the commissioning mode being notified:
0x00 BDB_COMMISSIONING_SUCCESS
0x01 BDB_COMMISSIONING_IN_PROGRESS
0x02 BDB_COMMISSIONING_NO_NETWORK
0x03 BDB_COMMISSIONING_TL_TARGET_FAILURE
0x04 BDB_COMMISSIONING_TL_NOT_AA_CAPABLE
0x05 BDB_COMMISSIONING_TL_NO_SCAN_RESPONSE
0x06 BDB_COMMISSIONING_TL_NOT_PERMITTED
Status 1
0x07 BDB_COMMISSIONING_TCLK_EX_FAILURE
0x08 BDB_COMMISSIONING_FORMATION_FAILURE
0x09 BDB_COMMISSIONING_FB_TARGET_IN_PROGRESS
0x0A BDB_COMMISSIONING_FB_INITIATOR_IN_PROGRESS
0x0B BDB_COMMISSIONING_FB_NO_IDENTIFY_QUERY_RESPONSE
0x0C BDB_COMMISSIONING_FB_BINDING_TABLE_FULL
0x0D BDB_COMMISSIONING_NETWORK_RESTORED
0x0E BDB_COMMISSIONING_FAILURE
Commissioning mode for which the notification is done and to which the status
is related:
Commissioning 0x00 BDB_COMMISSIONING_INITIALIZATION
1
mode 0x01 BDB_COMMISSIONING_NWK_STEERING
0x02 BDB_COMMISSIONING_FORMATION
0x03 BDB_COMMISSIONING_FINDING_BINDING

129 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

0x04 BDB_COMMISSIONING_TOUCHLINK
0x05 BDB_COMMISSIONING_PARENT_LOST
Bitmask of the remaining commissioning modes after this notification:
0x01 BDB_COMMISSIONING_MODE_INITIATOR_TL
Remaining 0x02 BDB_COMMISSIONING_MODE_NWK_STEERING
commissioning 1 0x04 BDB_COMMISSIONING_MODE_NWK_FORMATION
modes 0x08 BDB_COMMISSIONING_MODE_FINDING_BINDING
0x10 BDB_COMMISSIONING_MODE_INITIALIZATION
0x20 BDB_COMMISSIONING_MODE_PARENT_LOST

3.14 MT_GREENPOWER
This interface allows a host processor to interact with Green Power devices and Green Power
infrastructure.

3.14.1 MT_GP Commands

3.14.1.1 GP_DATA_REQ

Description:
Callback to receive notifications from BDB process.

Usage:
SREQ
Byte: 1 1 1 1 1 1 4
Length = 0x17- Cmd0 = 0x35 Cmd1 = 0x01 Action TxOptions Application ID SrcID
0x8C

8 1 1 1 0-116 1 3
GPD IEEE address EndPoint GPD GPD GPD ASU GPEP handle gpTxQueueEntry-
Command ID ASU Lifetime
Length

Attributes:
Length
Attribute Range Description
(byte)
TRUE: add GPDF into the queue
Action 1 TRUE/FALSE
FALSE: remove GPDF from queue
The transmission options for this GPDF. These are a
bitwise OR of one or more of the following:
b0 = Use gpTxQueue
b1 = Use CSMA/CA
b2 = Use MAC ACK
TxOptions 1 AnyValid b3-b4 = GPDF frame type for Tx (can take non-reserved
values as defined in Table 10)
b5 = Tx on matching endpoint
b6 – b7 – reserved

ApplicationID of the GPD to which the ASDU will be sent;

ApplicationID 0x00 indicates the usage of the SrcID;
Application ApplicationID 0x02 indicates the usage of the GPD IEEE
1 0x00, 0x02
ID address.

The identifier of the GPD entity to which the ASDU will be

SrcID 4 0x00000000 - 0xffffffff sent if ApplicationID = 0b000.

130 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

The identifier of the GPD entity to which the ASDU will be

GPD IEEE sent if ApplicationID = 0b010.
8 Any valid
address

The identifier of the GPD endpoint used in combination with

the GPD IEEE address if ApplicationID = 0b010.
Endpoint 1 0x00 - 0xf0, 0xff If ApplicationID = 0b000 this parameter is ignored.

The identifier of the command, within the GP specification,

GPD which defines the application semantics of the ASDU.
1 0x00- 0xff
Command ID

0x00 -
GPD ASDU
1 (aMaxMACFrameSize - The number of octets in the transmitted GPD ASDU.
Length
9)
GPD
GPD ASDU ASU - The sequence of octets forming the transmitted GPD ASDU.
Length
The handle used between Green Power EndPoint and dGP
GPEP handle 1 0x00-0xff stub, to match the request with the confirmation.

The lifetime of this packet in the gpTxQueue, in

gpTxQueueE milliseconds.
ntry- 0x000000 indicates immediate transmission.
Lifetime 3 0x000000-0xffffff 0xffffff indicates infinity.
In a Basic Proxy/Sink, the default lifetime MAY be 0xffffff.

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x75 Cmd1 = 0x01 Status

Attributes:
Attribute Length (byte) Description
Status values:
0x00 Success
Status 1
0x01 Failure (Out of memory)
0x02 Invalid Parameters (Invalid App ID)

3.14.1.2 GP_SEC_RSP

Description:
This message provides a mechanism for the Green Power EndPoint to provide security data into
the dGP stub.

Usage:
SREQ
Byte: 1 1 1 1 1 1 4
Length = 0x26 Cmd0 = 0x35 Cmd1 = 0x02 Status dGP stub handle ApplicationID SrcID

8 1 1 1 16 4
GPD IEEE EndPoint GPDFScurityLevel GPDFKeyType GPDKey GPDSecurityFrameCounter
address

Attributes:
Length
Attribute Range Description
(byte)
The status code, as returned by the Green Power EndPoint.
The following are supported:
MATCH
Status 1 Any valid
DROP_FRAME
PASS_UNPROCESSED
TX_THEN_DROP

131 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

The handle used between dGP stub and the higher layers, to
dGP stub handle 1 0x00-0xff match the request with the response.

ApplicationID of the GPD entity from which the ASDU was

received. ApplicationID 0x00 indicates the usage of the
Application ID 1 0x00, 0x02 SrcID; ApplicationID 0x02 indicates the usage of the GPD
IEEE address.

The identifier of the GPD entity from which the ASDU was
0x00000001 - received if ApplicationID = 0b000.
SrcID 4
0xfffffffe

The identifier of the GPD entity from which the ASDU was
GPD IEEE received if ApplicationID = 0b010.
8 Any valid
address
The identifier of the GPD endpoint used in combination with
the GPD IEEE address if ApplicationID = 0b010.
Endpoint 1 0x00 - 0xf0, 0xff If ApplicationID = 0b000 this parameter is ignored.

GPDFSecurityL
1 0x00 - 0x07 The security level to be used for GPDF security processing.
evel

The security key type to be used for GPDF security

GPDFKeyType 1 Any valid
processing.

GPD Key 16 Any valid The security key to be used for GPDF security processing.

The security frame counter value to be used for GPDF

GPD security security processing.
4 Any valid
frame counter

SRSP:
Byte: 1 1 1 1
Length = 0x01 Cmd0 = 0x75 Cmd1 = 0x02 Status

Attributes:
Attribute Length (byte) Description
Status values:
0x00 Success
Status 1
0x01 Failure (Out of memory)
0x02 Invalid Parameters (Invalid App ID)

3.14.2 MT_GP Callbacks

3.14.2.1 GP_DATA_CNF

Description:
Green power confirm is a message that provides a mechanism for the Green Power EndPoint in
the host processor to understand the status of a previous request to send a GPDF.

Usage:
AREQ
Byte: 1 1 1 1 1
Length = 0x02 Cmd0 = 0x55 Cmd1 = 0x05 Status GP MPDU handle

132 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

Attributes:
Length
Attribute Range Description
(byte)
Status code, as returned by the MAC layer (see Table 28 of [15]).
Status 1 Any valid
The handle used between dGP/dLPED stub and cGP stub, to
GP MPDU 1 0x00 - 0xff match the request with the confirmation.

3.14.2.2 GP_SEC_REQ

Description:
This message provides a mechanism for dGP stub to request security data from the Green Power
EndPoint in the host processor.

Usage:
AREQ
Byte: 1 1 1 1 4 8
Length = 0x12-0x15 Cmd0 = 0x53 Cmd1 = 0x03 ApplicationID SrcID GPD IEEE address

1 1 1 1, 4 1
Endpoint GPDFScurityLevel GPDFKeyType GPD Security Frame Counter dGP stub handle

Attributes:
Length
Attribute Range Description
(byte)
ApplicationID of the GPD entity from which the ASDU was
received.
ApplicationID 1 0x00, 0x02 ApplicationID 0x00 indicates the usage of the SrcID; ApplicationID
0x02 indicates the usage of the GPD IEEE address.

The identifier of the GPD entity from which the ASDU was received
0x00000001 - if ApplicationID = 0b000.
SrcID 4
0xfffffffe
The identifier of the GPD entity from which the ASDU was
GPD IEEE received if ApplicationID = 0b010.
8 Any valid
address
The identifier of the GPD endpoint used in combination with
the GPD IEEE address if ApplicationID = 0b010.
EndPoint 1 0x00 - 0xf0, 0xff If ApplicationID = 0b000 this parameter is ignored.

The security level, corresponding to the received MPDU.

GPDFSecurity
1 0x00, 0x02 - 0x03
Level

GPDFKey
1 0x00 - 0x01 The security key type, corresponding to the received MPDU.
Type
GPD Security As specified by the The security frame counter value corresponding to the received
Frame 1, 4 GPDF Security MPDU.
Counter Level parameter
The handle used between dGP stub and the higher layers, to
match the request with the response.
dGP stub
1 0x00-0xff
handle

133 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

3.14.2.3 GP_DATA_IND

Description:
This message provides a mechanism for identifying and conveying a received GPDF to the Green
Power EndPoint in the host processor.

Usage:
AREQ
Byte: 1 1 1 1 1 1 1 4
Length = 0x11- Cmd0 = 0x55 Cmd1 = 0x04 Status RSSI LinkQuality SeqNumber SrcAddrMode
0x91

2 2, 8 1 2 2, 8 1 0-116
SrcPANID SrcAddress DstAddrMode DstPANId DstAddress GP MPDU Length GP MPDU

Attributes:
Length
Attribute Range Description
(byte)
Status code, as returned by dGP stub. It can have the following
Status 1 Any Valid values: SECURITY_SUCCESS NO_SECURITY
COUNTER_FAILURE AUTH_FAILURE UNPROCESSED
RSSI 1 0x00 - 0xff The RSSI delivered by the MAC on receipt of this frame.
Link Quality 1 0x00 - 0xff The LQI delivered by the MAC on receipt of this frame.
The sequence number from MAC header of the received
SeqNumber 1 0x00 - 0xff
MPDU.
The source addressing mode for this primitive corresponding
to the received MPDU. This value can take one of the following
values:
0 x 00 = no address (SrcPANId and SrcAddress omitted).
SrcAddrMode 1 0x00 - 0x03 0 x 01 = reserved.
0 x 02 = 16 bit short address.
0 x 03 = 64 bit extended address.

The 16-bit PAN identifier of the GPD entity from which the
SrcPANId 2 0x0000 - 0xffff
ASDU was received.
As specified by the
SrcAddrMode The device address of the GPD entity from which the ASDU was
SrcAddress 2, 8 parameter received.

The addressing mode for the destination address used in this

primitive. This parameter can take one of the values from the
following list:
0 x 00 = no address (DstPANId and DstAddress omitted)
DstAddrMode 1 0x01 - 0x03 0x01 = reserved
0x02 = 16-bit NWK address, normally the broadcast address
0xffff
0x03 = 64-bit extended address

The 16-bit PAN identifier of the entity or entities to which

the ASDU is being transferred or the broadcast PAN ID
DstPANId 2 0x0000 - 0xffff 0xffff.

As specified by the
The address of the entity or entities to which the ASDU is
DstAddrMode
DstAddress 2, 8 being transferred or the broadcast address 0xffff.
parameter

0x00 – The number of octets in the received GP MPDU.

GP MPDU (aMaxMACFrameSi
1 ze - 9)
Length

134 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.

Z-Stack Monitor and Test API SWRA198 Revision 1.14

GP MPDU 0 - 116 - The sequence of octets forming the received GP MPDU.

135 Copyright 2008-2016 Texas Instruments, Inc. All rights reserved.