reference manual - digchip ic database
TRANSCRIPT
Document Number: ZTCRMRev. 1.410/2008
Freescale ZigBee™ Test Client(ZTC)
Reference Manual
How to Reach Us:
Home Page:www.freescale.com
E-mail:[email protected]
USA/Europe or Locations Not Listed:Freescale SemiconductorTechnical Information Center, CH3701300 N. Alma School RoadChandler, Arizona 85224+1-800-521-6274 or [email protected]
Europe, Middle East, and Africa:Freescale Halbleiter Deutschland GmbHTechnical Information CenterSchatzbogen 781829 Muenchen, Germany+44 1296 380 456 (English)+46 8 52200080 (English)+49 89 92103 559 (German)+33 1 69 35 48 48 (French)[email protected]
Japan:Freescale Semiconductor Japan Ltd.HeadquartersARCO Tower 15F1-8-1, Shimo-Meguro, Meguro-ku,Tokyo 153-0064, Japan0120 191014 or +81 3 5437 [email protected]
Asia/Pacific:Freescale Semiconductor Hong Kong Ltd.Technical Information Center2 Dai King StreetTai Po Industrial EstateTai Po, N.T., Hong Kong+800 2666 [email protected]
For Literature Requests Only:Freescale Semiconductor Literature Distribution CenterP.O. Box 5405Denver, Colorado 802171-800-521-6274 or 303-675-2140Fax: [email protected]
Information in this document is provided solely to enable system and software implementers to use Freescale Semiconductor products. There are no express or implied copyright licenses granted hereunder to design or fabricate any integrated circuits or integrated circuits based on the information in this document.Freescale Semiconductor reserves the right to make changes without further notice to any products herein. Freescale Semiconductor makes no warranty, representation or guarantee regarding the suitability of its products for any particular purpose, nor does Freescale Semiconductor assume any liability arising out of the application or use of any product or circuit, and specifically disclaims any and all liability, including without limitation consequential or incidental damages. “Typical” parameters that may be provided in Freescale Semiconductor data sheets and/or specifications can and do vary in different applications and actual performance may vary over time. All operating parameters, including “Typicals”, must be validated for each customer application by customer’s technical experts. Freescale Semiconductor does not convey any license under its patent rights nor the rights of others. Freescale Semiconductor products are not designed, intended, or authorized for use as components in systems intended for surgical implant into the body, or other applications intended to support or sustain life, or for any other application in which the failure of the Freescale Semiconductor product could create a situation where personal injury or death may occur. Should Buyer purchase or use Freescale Semiconductor products for any such unintended or unauthorized application, Buyer shall indemnify and hold Freescale Semiconductor and its officers, employees, subsidiaries, affiliates, and distributors harmless against all claims, costs, damages, and expenses, and reasonable attorney fees arising out of, directly or indirectly, any claim of personal injury or death associated with such unintended or unauthorized use, even if such claim alleges that Freescale Semiconductor was negligent regarding the design or manufacture of the part.
Freescale™ and the Freescale logo are trademarks of Freescale Semiconductor, Inc. All other product or service names are the property of their respective owners.
© Freescale Semiconductor, Inc. 2006, 2007, 2008. All rights reserved.
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor i
ContentsAbout This Book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiAudience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiOrganization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiConventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ivDefinitions, Acronyms, and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ivRevision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vSuggested Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter 1 Introduction
1.1 ZigBee Test Client Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21.2 ZigBee Network Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21.3 SAP Handler and API Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31.4 Typical ZigBee Test Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41.5 Basic PC Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41.5.1 Freescale Development Boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Chapter 2 Creating the Test Environment
2.1 Configuring the ZigBee Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22.2 Creating BeeKit Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22.2.1 Basic Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32.2.2 Exporting Created BeeKit Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-82.3 Importing Project Code to CodeWarrior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-82.3.1 Compiling Code Using CodeWarrior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-92.3.2 Setting Up the Background Debug Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-92.3.3 Loading Code Image into HCS08 Based Devices (MC1319x, MC1320x, MC1321x) . . . 2-112.4 Importing Project Code to IAR Embedded Workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-122.4.1 Compiling Code Using IAR Embedded Workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-142.4.2 Loading Code Image into ARM7 Based Devices (MC1322x). . . . . . . . . . . . . . . . . . . . . . 2-14
Chapter 3 Making New ZTC Commands
3.1 XML Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13.2 ZTC Target Side Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Chapter 4 Wireless Network Monitoring and ZTC
4.1 Monitoring RF Interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14.2 Wireless Network Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
ZigBee™ Test Client Reference Manual, Rev. 1.4
ii Freescale Semiconductor
Chapter 5 ZTC Frame Format
5.0.1 Acknowledgement and Time-out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Appendix A Commands and Events
ZigBee™ Text Client Reference Manual, Rev. 1.4
Freescale Semiconductor iii
About This BookThe ZigBee Test Client Reference Manual describes the Freescale BeeStack ZigBee Test Client diagnostic tool. This manual additionally serves as the users’ guide for the ZigBee Test Client for testing the BeeStack/Freescale IEEE 802.15.4 MAC protocol suite. This document describes the ZTC by itself, for reference on how to use ZTC please refer to the Freescale Test Tool User’s Guide.
The complete BeeKit test environment requires the following: • BeeKit software installed on host PC with the BeeStack/MAC codebase• CodeWarrior Integrated Development Environment for HCS08 installed on host PC• IAR Embedded Workbench for ARM installed on host PC• Freescale Test Tool software installed on host PC• Freescale development boards for testing• Optional wireless sniffer for testing
For more information about BeeKit, see the BeeKit Wireless Connectivity Toolkit User’s Guide, for more information about Test Tool, see the Freescale Test Tool User’s Guide.
AudienceThis document is intended for developers testing applications and programming routines in a ZigBee wireless sensor network.
OrganizationThis document contains the following chapters.Chapter 1 Introduction - Presents an overview of the BeeKit development environment and
the BeeStack protocol layers, including tools and system requirements.Chapter 2 Creating the Test Environment - Outlines the required BeeKit development tools,
their installation, and provides step-by-step installation and setup instructions to prepare both the host computer and ZigBee devices for a test network.
Chapter 3 Making New ZTC Commands - Details how users can modify the Test Tool for new applications.
Chapter 4 Wireless Network Monitoring and ZTC - Gives several examples of standard wireless sniffer tests for monitoring packets between wireless network devices.
Chapter 5 ZTC Frame Format - Describes the protocol frame format used by the ZTC.Appendix A Commands and Events - Includes the full list of commands and events supplied
with this software, including the OpCode group identification number, the OpCode number, and the associated primitive.
ZigBee™ Text Client Reference Manual, Rev. 1.4
iv Freescale Semiconductor
ConventionsThis document uses the following font style conventions:
Courier monospaced type indicates commands, command parameters, and code examples.Bold type indicates the elements of command lines that must be entered exactly as shown.Italic type emphasizes text, and in the context of programs indicates replaceable command parameters that the user must provide.
All source code examples are in C.
Definitions, Acronyms, and AbbreviationsThe following list defines the abbreviations used in this document.API application programming interfaceAPS application support sub-layerASP application support servicesBDM background debug moduleDUT device under testEW Embedded WorkspaceFCS frame checksumGUI graphical user interfaceIDE integrated development environmentMAC media access control layerMLME media access control sub-layer management entityNHLE next higher layer entityNLME network layer management entityNN network nodeNWK network layerPC personal computerPDU protocol data unitSAP service access pointSN sensor nodeUART universal asynchronous receiver transmitterZC ZigBee coordinatorZDO ZigBee device objectZDP ZigBee device profileZED ZigBee end deviceZR ZigBee router
ZigBee™ Text Client Reference Manual, Rev. 1.4
Freescale Semiconductor v
ZTC ZigBee test client
Revision HistoryThe following table summarizes revisions to this manual since the previous release (Rev. 1.3).
Suggested Reading• Freescale BeeStack Software Reference Manual, Document BSSRM.• The data sheets for the MC13193, MC13203, MC1321x, and MC1322x radios• Freescale MC9S08GB/GT Data Sheet, Document MC9S08GB60• Freescale MC9S08QE128 Reference Manual, Document MC9S08QE128RM• Freescale MC1322x Reference Manual, Document MC1322xRM
Revision History
Location Revision
Entire document Updated for MC1322x EVK.
ZigBee™ Text Client Reference Manual, Rev. 1.4
vi Freescale Semiconductor
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 1-1
Chapter 1 IntroductionThe Freescale ZigBee Test Client (ZTC) diagnostic tool allows extensive testing of the BeeStack protocol layer interfaces. With the Freescale Test Tool software and the ZTC, a user can start a ZigBee network, join devices to the network, and run any of the over 300 commands to test the BeeStack application services and interfaces.
Designed to run in the Freescale BeeKit Wireless Connectivity Toolkit development environment, additional software tools permit device configuration and setup for testing. These software tools are:
• BeeKit software plus the BeeStack codebase, containing the libraries and some source code• Freescale CodeWarrior IDE for HCS08 based devices serving as the compiler, linker, and debugger• IAR Embedded Workbench for ARM7 based devices serving as the compiler, linker, and debugger• Freescale Test Tool software to initiate the ZTC tests
The BeeStack architecture builds on the OSI Seven-Layer model, ensuring interoperability between networked devices. In the ZigBee implementation, the IEEE 802.15.4 stack provides the physical (PHY) and media access control (MAC) layers. Those, along with the ZigBee stack’s network (NWK) layer, create the foundation for the application (APL) layers. The application layer environment supports ZigBee-specific elements, including the ZigBee Device Objects (ZDO) in addition to other components. The combined PHY, MAC, NWK, and application layer elements comprise the full BeeStack implementation.
The BeeStack layers communicate by sending primitives via service access points (SAP). The ZTC permits the developer to test specific SAP handlers and SAPs.
The user should be very familiar with the concepts employed throughout this ZigBee Test Client Reference Manual. For additional reading, see the BeeStack Software Reference Manual, and the Freescale CodeWarrior and/or IAR Embedded Workbench for ARM7 and BeeKit documentation for assistance in understanding the BeeKit development requirements. To properly use the ZTC, see the Freescale Test Tool User’s Guide where many examples are provided.
NOTECompiler choice depends on the device being used. The Freescale MC1322x (ARM7 based) uses the IAR Embedded Workbench IDE for compiling, linking and debugging. The MC1319x, MC1320x, and MC1321x (HCS08 based) use the CodeWarrior IDE for compiling, linking and debugging.
Introduction
ZigBee™ Test Client Reference Manual, Rev. 1.4
1-2 Freescale Semiconductor
1.1 ZigBee Test Client Architecture The ZTC is a small application running in the APS layer of each node, whether that node is a ZigBee Coordinator (ZC), ZigBee Router (ZR), or ZigBee end device (ZED). The host PC connects to the device under test (DUT) via a USB or RS-232 cable (depending on the development board type) in serial mode. The device can then be controlled by API calls generated by the host computer to test the interfaces between BeeStack layers.
The ZTC enables common service features for each device and allows monitoring of specific BeeStack interfaces and API calls. Additionally, the ZTC injects or calls specific events and commands into the interfaces between layers.
The ZTC architecture as shown in Figure 1-1, includes the ZTC compile-time test client on any device under test. The ZTC communicates directly with the SAP handlers serving as the interfaces between the BeeStack protocol layers.
Figure 1-1. ZTC Design Architecture
1.2 ZigBee Network InterfacesThe BeeStack protocol suite provides the building blocks, or layers, that drive the functionality of a ZigBee network. Designed to support a wireless sensor network, BeeStack exposes each layer to the next through a service access point (SAP).
Data entities provide data transport services between layers, while the management entities handle management services. For example, the NWK Layer Data Entity (NLDE) provides transport services for application protocol data units (APDU), or packets. The NWK Layer Management Entity (NLME) maintains a database of managed objects and provides management services through the NLME-SAP.
H o s t P C
D e v e l o p m e n t B o a r d
T e s t T o o l
U A R TZ T C
A P S la y e r
N W K la y e r
M A C la y e r
Z D O
App
licat
ion
BeeS
tack
Introduction
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 1-3
Each SAP provides primitives that an upper layer uses to access services provided by the lower layers. Through these primitives, one layer can request information from another layer, and that layer can confirm in response, returning an indication when required.
A SAP or SAP handler, depending on the direction, passes data or manages data passed to it. SAPs are implemented as functions in an application, although only the request can be called directly.
This manual includes a detailed but partial list of the primitives used in the testing procedures outlined in . For the full list of primitives used in BeeStack, see the BeeStack Software Reference Manual.
1.3 SAP Handler and API TestingThe ZTC utilizes a series of commands enabling the host PC to make API calls to SAP handlers and SAPs. Those control modes, selected as parameters in the software, include:DisableMode Ignores the BeeStack layer when running the tests.HookMode Allows the ZTC to exclusively control a specific BeeStack layer. The ZTC hooks
only SAPs that receive messages from a lower layer. In this mode, the ZTC replaces the layer whose SAP is hooked, and returns, but does not process, messages sent to a specific BeeStack SAP.
MonitorMode Allows the ZTC to capture all messages received by a SAP. This feature does not impact the flow of message between BeeStack layers. When in monitor mode, the ZTC receives all messages except those disabled at compile time and those filtered out.
NOTEMonitoring a large number of SAPs can cause serial overflow and potentially disable test network devices. Monitor only the SAP calls required, usually only one or two at a time.
Depending on the compile-time options used, some SAPs or commands may not be available. ZTC can be configured through BeeKit properties.
Introduction
ZigBee™ Test Client Reference Manual, Rev. 1.4
1-4 Freescale Semiconductor
1.4 Typical ZigBee Test NetworkA typical test network includes the host PC, one development board acting as a ZigBee coordinator, and one or more additional boards acting as ZigBee end devices and routers.
In a small test network, the user configures a ZigBee coordinator and at least one other device; the test network as shown in Figure 1-2, includes a ZigBee coordinator, end device, and router. Each device for this test network connects to the host PC with USB cables running in serial mode.
Figure 1-2. Typical ZigBee Test Client Setup
Once the user completes device assignments, the test network is ready for testing. This manual details standard commands used in testing a ZigBee wireless sensor network.
1.5 Basic PC RequirementsThe Freescale Test Tool requires a Windows® operating system on a personal computer (PC) platform with at least 380MB RAM, and a minimum 1GB available hard drive space.
NOTEThe test network environment requires neither TCP/IP nor internet access, so users may choose to isolate the test environment with a stand-alone PC. For assistance configuring the PC for software installation, including appropriate Administrator Rights, users must consult their local IT support personnel.
Z C
Z RH o s tP C
Z T C
Z T C
U S Bw ir e le s sZ E D
Z T C
Z ig B e e E n d D e v ic e Z E D Z ig B e e C o o r d in a to r
Z ig B e e R o u te rZ C Z R
Introduction
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 1-5
1.5.1 Freescale Development BoardsThe Freescale development boards provide a platform for defining the full function test devices required in a wireless sensor network. The Freescale development boards, 1321x-SRB, 13192-EVB, 13213-NCB, 13192-SARD, 1320x-QE128-EVB, 1322x-LPB, 1322x-SN, 1322x-NN or 1322x-USB, connect via USB or RS232 cables to a host PC for all of the tests described in this document. The examples in this manual use the 1321x-SRB as shown in Figure 1-3.
Figure 1-3. Freescale 1321x SRB Development Board
Figure 1-4. Freescale 1322x SN Development Board
Table 1-1 lists available development boards for configuring and creating a ZigBee wireless network.Table 1-1. Freescale HCS08 Platform Development Boards
Device Type Board Number Interface
RF transceiver and MCU MC13192-EVB USB and RS232
RF transceiver and MCU MC13192-SARD RS232 only
RF and HCS08 in one SiP MC1321x-NCB USB and RS232
RF and HCS08 in one SiP MC1321x-SRB USB only
RF transceiver and MCU MC1320x-QE128-EVB USB and RS232
RF transceiver and MCU in one PiP MC1322x-USB USB only
RF transceiver and MCU in one PiP MC1322x-SN USB only
RF transceiver and MCU in one PiP MC1322x-NN USB only
Introduction
ZigBee™ Test Client Reference Manual, Rev. 1.4
1-6 Freescale Semiconductor
The 13213 NCB development board shown in Figure 1-5 serves as an example of the types of devices used for testing purposes.
Figure 1-5. MC13213 NCB Development Board
Figure 1-6. MC1322x NN Development Board
Figure 1-7. MC1322x USB Development Board
The examples given throughout this manual include network diagrams and typical screens displayed during the testing process.
For instructions on installing the Test Tool software and configuring the devices for a ZigBee test network, see the Freescale Test Tool User’s Guide and the online help available in Test Tool.
For more detailed help, see the MC13213EVK User’s Guide, and the BeeKit Wireless Connectivity Toolkit User’s Guide.
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-1
Chapter 2 Creating the Test EnvironmentThis section takes users through configuring device profiles and downloading the profiles to the development boards used for testing. The ZTC test environment procedures require users to perform the following tasks:
• Set up a project using BeeKit (see the BeeKit Wireless Connectivity Toolkit User’s Guide)• Export the project from BeeKit and import it into CodeWarrior or IAR Embedded Workbench• Compile the libraries and source code into binary images using CodeWarrior or IAR Embedded
Workbench• Download the binary images to devices using CodeWarrioror or IAR Embedded Workbench• Configure devices with at least one coordinator and additional devices acting as ZigBee end
devices or routers• Installation of Freescale Test Tool, device configuration for testing and a few practical examples
are described in detail in the Freescale Test Tool User’s Guide.
Four software programs provide the means of setting up a ZigBee wireless test network: • BeeKit• CodeWarrior or IAR Embedded Workbench (Depending on which device is being used.)• Test Tool
The BeeKit test environment requires the BeeKit IDE software, its BeeStack libraries, and source code. For detailed BeeKit installation instructions, refer to the documentation provided with that software. The steps outlined in Section 2.1, “Configuring the ZigBee Devices” takes users through configuring device definitions to be compiled for use on the development board.
The host computer additionally must have an installed version of the Freescale CodeWarrior (at minimum, version 6.0) Integrated Development Environment for HCS08 or an installed version of IAR Embedded Workbench for ARM, which contains a compiler, linker and debugger. The steps included in Section 2.3, “Importing Project Code to CodeWarrior” or in Section 2.4, “Importing Project Code to IAR Embedded Workbench”, outlines only the hardware configuration portion of the debugger. The CodeWarrior/IAR Embedded Workbench documentation included with the software provides answers to common installation issues.
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-2 Freescale Semiconductor
2.1 Configuring the ZigBee DevicesThe following devices are required for creating a ZigBee network node:
• P&E Multilink BDM pod/J-Link• Host PC• Device to be programmed
The hardware portion of the debugger consists of:• A standard USB cable and the P&E USB Multilink device, referred to throughout this manual as
the background debug module (BDM) for CodeWarrior• A standard USB cable and the J-Link device for IAR Embedded Workbench
NOTEConfirm that BeeKit and CodeWarrior or IAR Embedded Workbench are installed on the host PC. BeeKit and the required IDE software programs are used in configuring the devices and loading the compiled XML files.
Each ZigBee network must have one device configured as a coordinator, and may have other devices acting as routers or end devices. Users create a new BeeKit Project for each device by following the sequence of steps in this section.
For the examples in this manual, the 1321x-SRB will be configured as the ZigBee coordinator, and the 1321x-SRB will be configured as the router, but the same steps apply for any Freescale reference board including the QE128-EVB, SARD, EVB, NCB, SRB, 1322x-USB, 1322x-LPB, 1322x-SN, 1322x-NN, or 1322x-USB boards.
2.2 Creating BeeKit ProjectsStart BeeKit.
1. Select the BeeStack Codebase: File -> Select Codebase...
2. From the menu, create a new project to configure a new device by selectingFile -> Project
3. Select the following template:Test Profile 2 (TP2) template
For this example:
Project name: ZigBee Test Client SRB ZCSolution Name: ZTCLocation: BeeKit_Tests (sub directory on host PC)
4. Enter the project name and the solution name for the device being created, for example ZigBee Test Client SRB ZC as project name and ZTC as solution name.
5. Enter a location to save the Solution files to by navigating to a directory at the root level; type BeeKit_Tests.
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-3
6. Select OK to create the project for the first device.
2.2.1 Basic OptionsThe Project Wizard appears as shown in Figure 2-1 and displays the Basic Options.
Figure 2-1. BeeKit Project Wizard – Basic Options
NOTEBefore accepting the default options, verify that the default board is the same as the board being used for the test. If it is not, then use the custom configuration options as shown in Section 2.2.1.1, “Custom Configuration Options”.
7. The wizard allows the Finish button to be selected on the first pane, which will leave the rest of the wizard settings at their defaults. Depending on the board selected, it may be necessary to visit each pane of the wizard. Using every pane in the wizard is termed in this document as “Custom Configuration Options”.
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-4 Freescale Semiconductor
2.2.1.1 Custom Configuration OptionsUsers can modify any of the device configurations by clicking on the Next button in the “Welcome” screen displayed in Figure 2-1 which will open the Hardware Target window shown in Figure 2-2.
Figure 2-2. Hardware Board Selection Screen
If a MC1322x platform is selected, the IAR Embedded Workbench IDE will be used for compiling, linking and debugging. Otherwise, the CodeWarrior IDE is used.
To change the device to a specific platform, for this example, complete the following steps:1. Select the radio button MC1321x-SRB and click on the Next button.2. The Platform Modules selection page appears as shown in Figure 2-3.
Figure 2-3. Platform Modules Selection Screen
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-5
3. Keep the default modules selection configuration and click the Next button.4. The UART parameters page appears as shown in Figure 2-4. Make sure that the check box for
Enable ZTC is selected. 5. Keep the default settings selected and click the Next button.
Figure 2-4. UART Parameters Selection Screen
6. The ZigBee Device Type window shown in Figure 2-5 displays the Coordinator as the device. Click on the Next button.
Figure 2-5. ZigBee Device Type Selection Screen
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-6 Freescale Semiconductor
NOTEEach network requires one coordinator. When repeating these steps for additional devices select the ZigBee Device type (Router or End Device) being configured.
7. Leave the Security radio button set to No security without mesh routing, as shown in Figure 2-6.
Figure 2-6. BeeStack Network Type Selection Screen
8. Click on the Next button.9. For development purposes, leave the Extended Address option with all zeros. BeeKit will
automatically generate a random address. Alternatively, enter the full MAC address from the label on the development board. Keep the default setting for PAN ID and click the Next button.
Figure 2-7. Extended Address and PAN ID Selection Screen
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-7
10. At the Set Channels screen, shown in Figure 2-8, change the Channel 14 (default) to Channel 15.
Figure 2-8. Set Channels Selection Screen
WARNINGThe channel must be the same for all devices on the network. If setting the channel to something other than the default, verify in the setup for subsequent devices that the channel is the same one selected for this initial device.
11. Click on the Finish button.
The setup concludes when BeeKit returns to the Project Screen. At this time additional devices can be created with the outlined steps for the board just configured.
2.2.1.2 Creating Additional DevicesTo set up the wireless test network, the coordinator needs other devices to communicate with. Create additional devices with the following steps:
1. From the solution menu, choose Solution/Add Project…2. Repeat the steps 1 through 11 in Section 2.2.1.1, “Custom Configuration Options” to create a
second device, which may be an end device or router (select this at the Configure Options screen).3. Complete the options for the second device and press Finish.
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-8 Freescale Semiconductor
2.2.2 Exporting Created BeeKit ProjectsOnce all the devices to be used for testing have been created as BeeKit Projects and saved as a BeeKit Solution, the files must be exported into a format for importing into CodeWarrior.
To export the saved solution:1. From the Solution menu, select Export Solution.... The window that opens displays all the created
devices, each with a checked box as in Figure 2-9.
Figure 2-9. Export Beekit Project Solution Screen
2. Click on the button OK to start the export process.3. The export process window displays the source files and libraries required to configure the physical
devices.4. Click on the Save button.5. Exit BeeKit by choosing File -> Exit.
BeeKit displays all elements of the configured devices in the Project Screen.
2.3 Importing Project Code to CodeWarriorThe Project files code must be compiled before being downloaded into the device memory. The Project files created in BeeKit and saved as Solutions must now be imported into CodeWarrior for the compile process.
To import the code for the devices, follow these steps:1. Start CodeWarrior, which opens to a blank window and the menu at the top.2. Select File -> Import Project....3. Navigate to the file directory created in the BeeKit export procedure.4. Select the BeeKit export file to be imported (it will have .xml extension).
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-9
5. Click on the Open button, which launches a Save As window. Either create a new file name, or if using the existing ZigBee Test Client SRB ZC, delete the .xml extension if it appears in the filename window. CodeWarrior will add the .mcp extension.
6. Click on the Save button to complete the import process.7. The project is now loaded into the CodeWarrior IDE for the compile process.
2.3.1 Compiling Code Using CodeWarriorWith CodeWarrior open on the desktop, begin the compile process by using the hot key F7, clicking on the “make” icon, or from the menu choose Project -> Make. The compiled files display in a separate window.
2.3.2 Setting Up the Background Debug ModuleBefore using the devices to build a test network, the compiled code must be loaded into each device. Included in BeeKit is the P&E MultiLink Background Debug Module (BDM) pod, which will be used for downloading images into each device.
Connect the BDM pod to the host computer using the USB cable. A lighted blue LED indicates the BDM has power and a successful connection.
NOTEIf the computer opens the Hardware Wizard, select Next, and the Wizard will configure and install the driver for the “USB – Multilink USB” device.
The following Hardware Wizard window will open automatically to install the drivers for the MultiLink BDM. Each screen requires that users perform the following tasks:
1. For the first screen shown in Figure 2-10, select the “No, not this time” radio button and then click on the Next button.
Figure 2-10. New Hardware Wizard Screen
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-10 Freescale Semiconductor
2. As shown in Figure 2-11, click on the “Install the software automatically (Recommended)” radio button to install the P&E software and then click on the Next button.
Figure 2-11. P&E USB Driver Installation Screen
3. To complete the driver and software installation, click on the Continue Anyway button as shown in Figure 2-12.
Figure 2-12. Hardware Installation Warning Screen
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-11
2.3.3 Loading Code Image into HCS08 Based Devices (MC1319x, MC1320x, MC1321x)
To use the development boards in a test network, the images created in BeeKit must be downloaded into each device. The following steps must be repeated for each device:
1. Make sure the power to the board is turned off.2. With the BDM’s USB cable connected to the host PC, connect the flat cable from the BDM to the
first device.3. Align pin 1 (marked on most boards; if not, then the BDM port pin closest to the antennae) with
the red wire of the flat cable connector. 4. Turn on the board.5. The amber LED on the BDM will now light up, and the LED on the development board will also
light up. If not, switch the power off and on again on the board. Recheck the connection to the BDM port. Check the power adapter connection to the board or verify that the batteries are charged.
6. Download the compiled image to the board by pressing the F5 hot key, clicking on the “debug” icon which looks like a bug, or from the menu selecting Project -> Debug.
7. Click on the Connect button. The Connection Manager displays the running status in a window as shown below in Figure 2-13 and then closes automatically.
Figure 2-13. Status Window for Connection Manager
NOTEIf the Status window does not display the line “programming and verifying Address,” either the BDM or USB cables are not properly connected. Correct the problem before repeating Step 6.
8. Close the debugger by selecting File -> Exit.
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-12 Freescale Semiconductor
WARNINGExit the debug mode to avoid multiple debug appearances; having multiple appearances while setting up boards can produce unexpected results.
9. Disconnect the board and exit the CodeWarrior project, leaving CodeWarrior running.
NOTEConfigure additional devices to create a test network by repeating Steps 1 through 9 for each device, confirming that each one is specific to the board in use and the device, a ZigBee end device or router.
2.4 Importing Project Code to IAR Embedded WorkbenchThe Project files code must be compiled before being downloaded into the device’s FLASH. The Project files created in BeeKit and saved as Solutions must now be imported into the IAR Embedded Workbench for the compile process.
NOTEImporting BeeKit projects into the IAR Embedded Workbench IDE is for MC1322x devices only.
To import the code for the devices, follow these steps:1. Start the IAR Embedded Workbench software. The main window appears as shown in Figure 2-14.
Figure 2-14. IAR Main Window
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 2-13
2. Select File -> Open->Workspace.... as shown in Figure 2-15.
Figure 2-15. Open Workspace
3. Navigate to the file directory created in the BeeKit export procedure.4. Select the BeeKit export file to open as shown in Figure 2-16. (.eww extension.)
Figure 2-16. File Selection
5. Click on the Open button to complete the import process.
The project is now loaded into the IAR Embedded Workbench IDE for the compile process.
Creating the Test Environment
ZigBee™ Test Client Reference Manual, Rev. 1.4
2-14 Freescale Semiconductor
2.4.1 Compiling Code Using IAR Embedded WorkbenchWith the IAR Embedded Workbench window open on the desktop, begin the compile process by performing either of the following?
• Click the F7 hot key• Click on the “Make” icon• Choose Project -> Make from the menu.
The compiled files display in a separate window.
2.4.2 Loading Code Image into ARM7 Based Devices (MC1322x)To use the development boards in a test network, the images created in BeeKit must be downloaded into each device. The following steps must be repeated for each device:
1. Make sure the power to the board is turned off.2. With the J-Link’s USB cable connected to the host PC, connect the flat cable from the J-Link to
the first device.3. Align pin 1 (marked on most boards; if not, then the JTAG port pin closest to the antennae) with
the blue wire of the flat cable connector. 4. Turn on the board.5. If the workspace contains more than one project, set the project as active by right clicking on the
project name and choosing the “Set as Active“ option.6. Download the compiled image to the board by pressing the Ctrl+D keys, clicking on the “debug”
icon, or from the menu selecting Project -> Debug.7. When the download is finished, the Progress Dialog closes automatically.8. Stop debugging by pressing the Ctrl+Shift+D keys, clicking on the “Stop Debugging“ icon, or from
the menu selecting Debug->Stop Debugging.9. Disconnect the board and leave the IAR Embedded Workbench software running.
NOTEConfigure additional devices to create a test network by repeating Steps 1 through 9 for each device, confirming that each one is specific to the board in use and the device, a ZigBee end device or router.
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 3-1
Chapter 3 Making New ZTC CommandsBeeKit development allows users to modify the Test Tool for new applications. Any new commands or events must be updated for both the XML code and the application.
All commands require these four elements: • an opcode group ID• an opcode• payload length• data (buffer)
The ZTC and XML files can be extended using standard text editors, CodeWarrior, Notepad, or other commercial software editors.
3.1 XML ModificationsThe XML files contain three sections:
• Commands• Events• Settings
To make changes in the files, open any XML editor (CodeWarrior, for example) and update the appropriate lines of the code.
NOTESome XML editors have difficulty handling long lines of text that lack line wraps and carriage returns. The Settings section of the ZTC XML includes long lines of text, some as large as 4K. Keep this caution in mind when selecting the XML editor. Also, it is strongly recommended to keep a copy of the most recent working version, because XML is easily damaged, especially in editors not specifically intended for XML.
To update, add or change the XML for any outgoing commands, open the editor and the XML files and navigate to the section between the “<Commands>” and “</ Commands>” tags. A new Group Description name can be used, for example replacing the “Test Profile 2”, as in the following example code.
<Commands>... other commands <TP> <GroupDesc>Test Profile 2 Commands</GroupDesc> <Cmd>
Making New ZTC Commands
ZigBee™ Test Client Reference Manual, Rev. 1.4
3-2 Freescale Semiconductor
<CmdName>TransmitCountedPackets.Req</CmdName> <CmdDesc>TransmitCountedPackets.Req</CmdDesc> <CmdHeader>69 00</CmdHeader> <CmdParms> <Parm> <ParmName>Network_Address</ParmName> <ParmDesc>Network Address</ParmDesc> <ParmSize>2</ParmSize> <ParmType>tEdit</ParmType> <ParmLastValue>00 02</ParmLastValue> <ParmDefaultValue>00 00</ParmDefaultValue> </Parm> <Parm> <ParmName>PacketLength</ParmName> <ParmDesc>The number of payload bytes</ParmDesc> <ParmSize>1</ParmSize> <ParmType>tEdit</ParmType> <ParmLastValue>05</ParmLastValue> <ParmDefaultValue>01</ParmDefaultValue> </Parm> <Parm> <ParmName>Interval</ParmName> <ParmDesc>Interval between packets in 10msec resolution</ParmDesc> <ParmSize>1</ParmSize> <ParmType>tEdit</ParmType> <ParmLastValue>01</ParmLastValue> <ParmDefaultValue>01</ParmDefaultValue> </Parm> <Parm> <ParmName>NumOfPackets</ParmName> <ParmDesc>Number of packets to be send</ParmDesc> <ParmSize>2</ParmSize> <ParmType>tEdit</ParmType> <ParmLastValue>00 04</ParmLastValue> <ParmDefaultValue>00 01</ParmDefaultValue> </Parm> </CmdParms> </Cmd> </TP></Commands>
Similarly, to change events, which are the incoming data from target to Test Tool on the host PC, modify or add Commands only in the EVENTS section between the beginning and end tags, as shown in the following example code.
<Events>...other events <TP> <Cmd> <CmdName>TransmitCountedPackets.confirm</CmdName> <CmdDesc>TransmitCountedPackets confirm</CmdDesc> <CmdHeader>69 01</CmdHeader> <CmdParms> <Parm> <ParmName>PayloadLength</ParmName> <ParmDesc>Length of the Payload</ParmDesc>
Making New ZTC Commands
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 3-3
<ParmSize>1</ParmSize> <ParmType>tEdit</ParmType> </Parm> <Parm> <ParmName>status</ParmName> <ParmDesc>Status</ParmDesc> <ParmSize>1</ParmSize> <ParmType>tEdit</ParmType> </Parm> </CmdParms> </Cmd></TP></Events>
When creating a new OpCode, select a group number in the range between c0 and ff, and refer to Table A-1 in the Appendix to ensure the number is not already assigned.
Save the XML files and overwrite the existing versions.
WARNINGDo not modify the “<Settings>” section of the XML files.
3.2 ZTC Target Side ModificationsWhen new OpCode Groups are defined in XML, an application must register with the ZTC to receive the ZTC messages, using the function ZTC_RegisterAppInterfaceToTestClient(), found in ZTCInterface.h.
The data structure used in the message for the application must follow the format shown in the following example code.
/* Use ZTCQueue_QueueToTestClient() routine to send any arbitrary data (events) to test tool. Return TRUE if worked, FALSE if failed.*/bool_t ZTCQueue_QueueToTestClient ( uint8_t const *const pData, uint8_t const opcodeGroup, uint8_t const msgType, uint8_t const dataLen );/**/ /* ZTC message */typedef struct ZTCMessage_tag { ztcOpcodeGroup_t opCode; ztcMsgType_t opCodeId; uint8_t length; uint8_t data[1]; /* Place holder. */} ZTCMessage_t;/* Example ZTC handler for application*/
Making New ZTC Commands
ZigBee™ Test Client Reference Manual, Rev. 1.4
3-4 Freescale Semiconductor
void Tp2ReceiveZtcMessage(ZTCMessage_t* pMsg){ // check opcode group and opcode in pMsg. Free mes if(!Tp2OurOpcodeAndGroup(pMsg)) { MSG_Free(pMsg); return; } switch(pMsg->opCodeId) { // handle ZTC commands here.... } // prepare for confirm... // send back confirm to ZTC ZTCQueue_QueueToTestClient(pData,opcodeGroup,opcode,lengthOfData);}
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 4-1
Chapter 4 Wireless Network Monitoring and ZTCThe ZigBee wireless sensor network can be monitored using standard wireless network protocol analyzers. The analyzers typically capture the packets during transmission between devices, allowing users to observe and troubleshoot the network nodes.
4.1 Monitoring RF Interactions The following text shows the Test Tool initiated a free form request on the router’s behalf, and the router indicates the following expected primitives:
• Request• APSDE request• Respective confirm• Indication
The following shows the free form request results for the router.Tx [13:28:52] FreeformReq 69 0A 03 00 00 00
Header [2 bytes] = 69 0aNetwork_Address [2 bytes] = 00 00 RequestType [1 byte ] = 00
Rx [13:28:52] APSDE-DATA.Request 9C 00 13 02 00 00 00 E5 AA 1A 23 C8 F0 01 7F A8 A0 01 01 00 00 0A
Header [2 bytes] = 9C 00PayloadLength [1 byte ] = 13 DstAddrMode [1 byte ] = 02 DstAddress [8 bytes] = C8 23 1A AA E5 00 00 00 DstEndpoint [1 byte ] = F0 Profileld [2 bytes] = 7F 01 ClusterId [2 bytes] = A0 A8 SrcEndpoint [1 byte ] = 01 asduLength [1 byte ] = 01 Asdu [1 byte ] = 00
Asdu[0] = 00TxOptions [1 byte ] = 00 RadiusCounter [1 byte ] = 0A
Rx [13:28:52] Freeform.confirm 69 0A 01 00
Header [2 bytes] = 69 0aPayloadLength [1 byte ] = 01
Wireless Network Monitoring and ZTC
ZigBee™ Test Client Reference Manual, Rev. 1.4
4-2 Freescale Semiconductor
Rx [13:28:52] APSDE-DATA.Confirm 9D 00 0D 02 00 00 00 E5 AA 1A 23 C8 F0 01 00 73
Header [2 bytes] = 9D 00PayloadLength [1 byte ] = 0D DstAddrMode [1 byte ] = 02 DstAddress [8 bytes] = C8 23 1A AA E5 00 00 00 DstEndpoint [1 byte ] = F0 SrcEndpoint [1 byte ] = 01 Status [1 byte ] = 00 (gSuccess)ConfirmID [1 byte ] = 73
Rx [13:28:52] APSDE-DATA.Indication 9D 01 12 02 01 00 01 02 00 00 F0 01 7F 00 E0 02 00 42 00 00 DE
Header [2 bytes] = 9D 01PayloadLength [1 byte ] = 12 DestAddrMode [1 byte ] = 02 (16bit Addr and DstEndpoint)DstAddress [2 bytes] = 00 01 DstEndpoint [1 byte ] = 01 SrcAddrMode [1 byte ] = 02 SrcAddress [2 bytes] = 00 00 SrcEndpoint [1 byte ] = F0 ProfileId [2 bytes] = 7F 01 ClusterId [2 bytes] = E0 00 asduLength [1 byte ] = 02 asdu [2 bytes] = 00 42
asdu[0] = 00asdu[1] = 42
WasBroadcast [1 byte ] = 00 (FALSE)SecurityStatus [1 byte ] = 00 (gUnsecured)LinkQuality [1 byte ] = DE
Wireless Network Monitoring and ZTC
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 4-3
4.2 Wireless Network MonitorsWireless monitoring permits users to verify connectivity for a wireless sensor network. Several different manufacturers offer packet sniffers designed for wireless radio transmission.
Several third party vendors offer a variety of protocol analyzers. Figure 4-1 shows one of the many network analyzers available. Notice that the network as shown (detailed in Section 4.1, “Monitoring RF Interactions ”) appears as a graphic with packet decode information. This includes time stamps on the packets.
Figure 4-1. Wireless Monitor for Viewing Traffic
Wireless Network Monitoring and ZTC
ZigBee™ Test Client Reference Manual, Rev. 1.4
4-4 Freescale Semiconductor
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor 5-1
Chapter 5 ZTC Frame FormatThis section describes the protocol frame format used by ZTC.
All communication with the ZTC is accomplished through the Freescale Test Tool using the UART or USB interface. The BDM is not supported. Figure 5-1 shows the data format.
For communication between upper (host) and lower (embedded) software. The data frame consists of a data field, augmented with a header containing the opcode and length field. The same format is used in both directions.
Figure 5-1. Data Format
• Byte 0 — Opcode group • Byte 1 — Opcode • Byte 2 — Length of data field (excluding header)• Byte 3 to (n+3) — Data, including timestamps where applicable
The USB/UART driver modules append sync word and error checking to the generic frame format, as shown in Figure 5-2.
Figure 5-2. Generic Frame Format
• Sync byte — Frame delimiter indicating packet start. Constant value = STX = 0x02.• FCS byte — Frame checksum calculated as the XOR of all bytes in the opcode group, opcode,
length, and data fields.
Opcodegroup Opcode Data
1 1 nSize:
0 1 3...(n+3)Byte:
Length
2
1
Opcodegroup Opcode
Size:
Sync FCS
1
Length
1
Data
ZTC Frame Format
ZigBee™ Test Client Reference Manual, Rev. 1.4
5-2 Freescale Semiconductor
5.0.1 Acknowledgement and Time-outThe received command packets are verified by the UART/USB driver to detect transmission errors. If an error is detected, a NACK containing the error code is returned and the UART driver attempts to re-sync the communication. Table 5-1 shows the error codes that could be returned.
Most messages passed to the embedded system trigger a response message. For example, a NACK, or another proper response from the target entity may be received.
Table 5-1. Error Codes
Address Error Code
0xF0 Rx Sync Error
0xF1 Rx Length Error
0xF2 Rx FCS Error
0xF3 Tx Overflow Error
0xF4 Unknown Command
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-1
Appendix A Commands and EventsThe XML files that run in the background for the Freescale Test Tool use Commands and Events to differentiate between API calls that are outbound to the Test Client or inbound to the host PC. Table A-1 includes the full list supplied with this software, including the OpCode group identification number, the OpCode number, and the associated primitive.
Table A-1. Commands and Events
Type Opcode Group OpCode Name
COMMAND 00 10 PowerOn.Request
COMMAND 69 00 TransmitCountedPackets.Req
COMMAND 69 01 ResetPacketCount.Req
COMMAND 69 02 RetrievePacketCount.Req
COMMAND 69 04 BufferTest.Req
COMMAND 69 05 BufferTestGroupReq
COMMAND 69 08 RouteDiscoveryReq
COMMAND 69 0A FreeformReq
COMMAND 69 0D BroadcastReq
COMMAND 69 11 RetrieveAFRequestAndDataConfirmCount.req
COMMAND 69 4F TransmitFragmentedPackets.Req
COMMAND 69 50 AddDeviceToExclusionListinTC.Req
COMMAND 69 51 ToggleLeds
COMMAND 70 00 ReadAttribute
COMMAND 70 02 WriteAttribute
COMMAND 70 06 ConfigureReporting
COMMAND 70 08 ReadReportingConfiguration
COMMAND 70 0C DiscoverAttr_Cmd
COMMAND 70 10 BasicCmd_Reset
COMMAND 70 20 IdentifyCmd_Identify
COMMAND 70 21 IdentifyCmd_Query
COMMAND 70 30 GroupCmd_AddGroup
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-2 Freescale Semiconductor
COMMAND 70 31 GroupCmd_ViewGroup
COMMAND 70 32 GroupCmd_GetGroupMembership
COMMAND 70 33 GroupCmd_RemoveGroup
COMMAND 70 34 GroupCmd_RemoveAllGroups
COMMAND 70 35 GroupCmd_AddGroupIfIdentifying
COMMAND 70 40 SceneCmd_AddScene
COMMAND 70 41 SceneCmd_ViewScene
COMMAND 70 42 SceneCmd_RemoveScene
COMMAND 70 43 SceneCmd_RemoveAllScene
COMMAND 70 44 SceneCmd_StoreScene
COMMAND 70 45 SceneCmd_RecallScene
COMMAND 70 46 SceneCmd_GetSceneMembership
COMMAND 70 50 OnOffCmd_SetState
COMMAND 70 60 LevelControl_MoveToLevel
COMMAND 70 61 LevelControl_Move
COMMAND 70 62 LevelControl_Step
COMMAND 70 63 LevelControl_Stop
COMMAND 70 64 LevelControl_MoveToLevel_OnOff
COMMAND 70 65 LevelControl_Move_OnOff
COMMAND 70 66 LevelControl_Step_OnOff
COMMAND 70 67 LevelControl_Stop_OnOff
COMMAND 70 70 ZclCommissioning_RestartDeviceReq
COMMAND 70 71 ZclCommissioning_SaveStartupParametersReq
COMMAND 70 72 ZclCommissioning_RestoreStartupParametersReq
COMMAND 70 73 ZclCommissioning_ResetStartupParametersReq
COMMAND 70 81 ZclMessaging_DisplayMessageReq
COMMAND 70 82 ZclMessaging_CancelMessageReq
COMMAND 70 83 ZclMessaging_GetLastMessageReq
COMMAND 70 84 ZclMessaging_MessageConfirmationReq
COMMAND 70 85 ZclSimpleMetering_GetProfileReq
COMMAND 70 86 ZclSimpleMetering_GetProfileRsp
COMMAND 70 87 LoadControlDemandResponse_ReportEventStatusReq
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-3
COMMAND 70 88 ZclLoadControlDemandResponse_LoadControlEventReq
COMMAND 70 89 ZclLoadControlDemandResponse_CancelLoadControlEventReq
COMMAND 70 8A ZclCmdLoadControlDemandResponse_CancelAllLoadControlEventReq
COMMAND 70 8B zclPrice_GetCurrentPriceReq
COMMAND 70 8C zclPrice_GetSheduledPricesReq
COMMAND 70 8D zclPrice_PublishPriceRsp
COMMAND 70 8E zclKeyEstab_InitKeyEstabReq
COMMAND 70 8F KeyEstab_EphemeralDataReq
COMMAND 70 90 KeyEstab_ConfirmKeyDataReq
COMMAND 70 91 KeyEstab_TerminateKeyEstabServer
COMMAND 70 92 zclKeyEstab_InitKeyEstabRsp
COMMAND 70 93 KeyEstab_EphemeralDataRsp
COMMAND 70 94 KeyEstab_ConfirmKeyDataRsp
COMMAND 70 95 KeyEstab_TerminateKeyEstabClient
COMMAND 70 A1 ZclMsg_InterPanDisplayMessageReq
COMMAND 70 A2 ZclMsg_InterPanCancelMessageReq
COMMAND 70 A3 ZclMsg_InterPanGetLastMessageReq
COMMAND 70 A4 ZclMsg_InterPanMessageConfirmationReq
COMMAND 70 A8 zclPrice_ScheduleServerPriceEvents
COMMAND 70 A9 zclPrice_UpdateServerPrice
COMMAND 70 AA zclPrice_DeleteServerScheduledPrices
COMMAND 70 AB zclPrice_InterPanGetCurrentPriceReq
COMMAND 70 AC zclPrice_InterPanGetSheduledPricesReq
COMMAND 70 AD zclPrice_InterPanPublishPriceRsp
COMMAND 70 AE SE_ESPRegisterDevice.Request
COMMAND 70 AF SE_ESPDeRegisterDevice.Request
COMMAND 70 B0 TimeInit.Request
COMMAND 85 00 MacAssociate.Request
COMMAND 85 01 MacAssociate.Response
COMMAND 85 02 MacDisassociate.Request
COMMAND 85 03 MacGetPIBAttribute.Request
COMMAND 85 04 MacGTS.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-4 Freescale Semiconductor
COMMAND 85 05 MacOrphan.Response
COMMAND 85 06 MacReset.Request
COMMAND 85 07 MacRxEnable.Request
COMMAND 85 08 MacScan.Request
COMMAND 85 09 MacSetPIBAttribute.Request
COMMAND 85 0A MacStart.Request
COMMAND 85 0B MacSync.Request
COMMAND 85 0C MacPoll.Request
COMMAND 87 00 MacData.Request
COMMAND 87 01 MacPurge.Request
COMMAND 95 00 AspGetTime.Request
COMMAND 95 01 AspGetInactiveTime.Request
COMMAND 95 02 AspGetMacState.Request
COMMAND 95 03 AspDoze.Request
COMMAND 95 04 AspAutoDoze.Request
COMMAND 95 05 AspAcome.Request
COMMAND 95 06 AspHibernate.Request
COMMAND 95 07 AspWake.Request
COMMAND 95 08 AspEvent.Request
COMMAND 95 09 AspClko.Request
COMMAND 95 0A AspTrim.Request
COMMAND 95 0B AspDdr.Request
COMMAND 95 0C AspPort.Request
COMMAND 95 0D AspSetMinDozeTime.Request
COMMAND 95 0E AspSetNotify.Request
COMMAND 95 0F AspSetPowerLevel.Request
COMMAND 95 10 TelecTest
COMMAND 95 11 TelecSetFreq
COMMAND 96 34 NLME-NETWORK-DISCOVERY.Request
COMMAND 96 35 NLME-NETWORK-FORMATION.Request
COMMAND 96 36 NLME-PERMIT-JOINING.Request
COMMAND 96 37 NLME-START-ROUTER.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-5
COMMAND 96 38 NLME-JOIN.Request
COMMAND 96 39 NLME-DIRECT_JOIN.Request
COMMAND 96 3A NLME-LEAVE.Request
COMMAND 96 3B NLME-RESET.Request
COMMAND 96 3C NLME-SYNC.Request
COMMAND 96 4F NLME-ROUTE-DISCOVERY.Request
COMMAND 96 55 NLME-ENERGY-SCAN.Request
COMMAND 96 57 NLME-SetChannel.Request
COMMAND 96 67 NETWORK-STATUS.Request
COMMAND 99 00 APSME-BIND.Request
COMMAND 99 09 APSME-UNBIND.Request
COMMAND 99 0B APSME-RESET.Request
COMMAND 99 CF APSME-ESTABLISH-KEY.Request
COMMAND 99 D0 APSME-ESTABLISH-KEY.response
COMMAND 99 D1 APSME-TRANSPORT-KEY.Request
COMMAND 99 D3 APSME-REQUEST-KEY.Request
COMMAND 99 D4 APSME-SWITCH-KEY.Request
COMMAND 99 E8 APSME-ADD-GROUP.Request
COMMAND 99 E9 APSME-REMOVE-GROUP.Request
COMMAND 99 EA APSME-REMOVE-ALL-GROUPS.Request
COMMAND 99 F3 APSME-UPDATE-DEVICE.Request
COMMAND 99 F4 APSME-REMOVE-DEVICE.Request
COMMAND 99 F5 APSME-AUTHENTICATE.Request
COMMAND 9A 33 NLDE-DATA.Request
COMMAND 9C 00 APSDE-DATA.Request
COMMAND 9C 10 ResetFragments.Request
COMMAND 9C 11 LoadFragment.Request
COMMAND 9C 12 SetFragAckMask.Request
COMMAND 9C 13 SetMaxFragmentLength.Request
COMMAND 9C 14 SetWindowSize.Request
COMMAND 9C 15 SetInterframeDelay.Request
COMMAND 9F 02 AFDE-ZCL-DATA.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-6 Freescale Semiconductor
COMMAND 9F 03 AFDE-MSG-DATA.Request
COMMAND 9F 06 AFDE-MSG-DATA-Aggregation.Request
COMMAND A2 00 ZDP-NWK_addr_req.Request
COMMAND A2 01 ZDP-IEEE_addr_req.Request
COMMAND A2 02 ZDP-NodeDescriptor.Request
COMMAND A2 03 ZDP-PowerDescriptor.Request
COMMAND A2 04 ZDP-SimpleDescriptor.Request
COMMAND A2 05 ZDP-Active_EP_req.Request
COMMAND A2 06 ZDP-Match_Desc_req.Request
COMMAND A2 10 ZDP-Complex_Desc_req
COMMAND A2 11 ZDP-User_Desc_req.Request
COMMAND A2 12 ZDP-Discovery_Cache.request
COMMAND A2 13 ZDP-EndDeviceAnnounce.Request
COMMAND A2 14 ZDP-User_Desc_set
COMMAND A2 15 ZDP-System_Server_Discovery.Request
COMMAND A2 16 ZDP-Discovery_Store.Request
COMMAND A2 17 ZDP-Node_Desc_Store.Request
COMMAND A2 18 ZDP-Power_Desc_Store.Request
COMMAND A2 19 ZDP-Active_EP_Store.Request
COMMAND A2 1A ZDP-Simple_Desc_Store.Request
COMMAND A2 1B ZDP-Remove_Node_Cache.Request
COMMAND A2 1C ZDP-Find_Node_Cache.Request
COMMAND A2 1D ZDP-ExtendedSimpleDescriptor.Request
COMMAND A2 1E ZDP-Extended_Active_EP_req.Request
COMMAND A2 20 ZDP-End_Device_Bind.Request
COMMAND A2 21 ZDP-BIND.Request
COMMAND A2 22 ZDP-UNBIND.Request
COMMAND A2 23 ZDP-Bind_Register.Request
COMMAND A2 24 ZDP-Replace_Device.Request
COMMAND A2 25 ZDP-Store_Bkup_Bind_entry.Request
COMMAND A2 26 ZDP-Remove_Bkup_Bind_Entry.Request
COMMAND A2 27 ZDP-Backup_Bind_Table.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-7
COMMAND A2 28 ZDP-Recover_Bind_Table.Request
COMMAND A2 29 ZDP-Backup_Source_Bind.Request
COMMAND A2 2A ZDP-Recover_Source_Bind.Request
COMMAND A2 30 ZDP-Mgmt_Nwk_Disc.Request
COMMAND A2 31 ZDP-Mgmt_Lqi.Request
COMMAND A2 32 ZDP-Mgmt_Rtg.Request
COMMAND A2 33 ZDP-Mgmt_Bind.Request
COMMAND A2 34 ZDP-Mgmt_Leave.Request
COMMAND A2 35 ZDP-Mgmt_Direct_Join.Request
COMMAND A2 36 ZDP-Mgmt_Permit_Joining.Request
COMMAND A2 37 ZDP-Mgmt_Cache.Request
COMMAND A2 38 ZDP-Mgmt_Nwk_Update.Request
COMMAND A2 3C ZDP-NLME-SYNC.Request
COMMAND A2 79 ZDP-NLME-PERMIT-JOINING.Request
COMMAND A2 B8 ZDP-Mgmt_Nwk_Update.Notify
COMMAND A2 FA SetApsSecurityMaterials.Request
COMMAND A2 FC SetNwkSecurityMaterials.Request
COMMAND A2 FE Check-NeighborTable-ForRouting.Request
COMMAND A3 00 ZTC-ModeSelect.Request
COMMAND A3 02 ZTC-GetMode.Request
COMMAND A3 05 ZTC-AFReset.Request
COMMAND A3 06 ZTC-APSReset.Request
COMMAND A3 08 ZTC-CPU_Reset.Request
COMMAND A3 0A ZTC-DeregisterEndPoint.Request
COMMAND A3 0B ZTC-RegisterEndPoint.Request
COMMAND A3 0C ZTC-GetNumberOfEndPoints.Request
COMMAND A3 0D ZTC-GetEndPointDescription.Request
COMMAND A3 0E ZTC-GetEndPointIdList.Request
COMMAND A3 10 ZTC-GetICanHearYoutTable.Request
COMMAND A3 11 ZTC-SetICanHearYouTable.Request
COMMAND A3 12 ZTC-GetChannel.Request
COMMAND A3 13 ZTC-SetChannel.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-8 Freescale Semiconductor
COMMAND A3 16 ZTC-GetPermissionsTable.Req
COMMAND A3 17 ZTC-SetPermissionsTable.Req
COMMAND A3 18 ZTC-RemoveFromPermissionsTable.Req
COMMAND A3 19 ZTC-AddDeviceToPermissionsTable.Req
COMMAND A3 20 APSME-GET.Request
COMMAND A3 21 APSME-SET.Request
COMMAND A3 22 NLME-GET.Request
COMMAND A3 23 NLME-SET.Request
COMMAND A3 24 GetNumOfMsgs.Request
COMMAND A3 25 ZTC-FreeDiscoveryTables.Request
COMMAND A3 26 ZTC-SetJoinFilterFlag.Request
COMMAND A3 27 GetMaxApplicationPayload.Request
COMMAND A3 30 ZTC-WriteRAMMemoryBlock.Request
COMMAND A3 31 ZTC-ReadMemoryBlock.Request
COMMAND A3 38 ZTC-Ping.Request
COMMAND A3 39 ZTC-AbelWrite.Request
COMMAND A3 3A ZTC-AbelRead.Request
COMMAND A3 D2 ZTC-ReadExtAddr.Request
COMMAND A3 DB ZTC-WriteExtAddr.Request
COMMAND A3 DC ZTC-StopNwk.Request
COMMAND A3 DF ZTC-StartNwk.Request
COMMAND A3 E0 ZTC-RestartNwk.Request
COMMAND A3 E4 ZTC-NVSave.Request
COMMAND A3 E5 ZTC-NVGetDataSetDesc.Request
COMMAND A3 E6 ZTC-NVGetPageHeaders.Request
COMMAND A3 E7 ZTC-StartNwkEx.Request
COMMAND A3 E8 ZTC-StopNwkEx.Request
COMMAND A5 00 INTERPAN-DATA.Request
EVENT 00 10 PowerOn.Request
EVENT 51 05 SerialPortNoise
EVENT 69 00 TransmitCountedPackets.confirm
EVENT 69 01 ResetPacketCount.confirm
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-9
EVENT 69 02 RetrievePacketCount.confirm
EVENT 69 03 RetrievePacketCount.response
EVENT 69 04 BufferTest.confirm
EVENT 69 05 BufferTestGroup.confirm
EVENT 69 06 BufferTest.response
EVENT 69 07 BufferTestGroup.response
EVENT 69 08 RouteDiscovery.confirm
EVENT 69 09 RouteDiscovery.response
EVENT 69 0A Freeform.confirm
EVENT 69 0B Freeform.response
EVENT 69 0C FreeformNoData.response
EVENT 69 0D Broadcast.confirm
EVENT 69 0E BroadcastAllDevices.Response
EVENT 69 0F BroadcastRxOnIdle.Response
EVENT 69 10 BroadcastRouters.Response
EVENT 69 21 TP2.InvalidCluster
EVENT 69 4F TransmitFragmentedPackets.confirm
EVENT 69 50 AddDeviceToExclusionListinTC.Confirm
EVENT 70 00 ReadAttribute
EVENT 70 02 WriteAttribute
EVENT 70 06 ConfigureReporting
EVENT 70 08 ReadReportingConfiguration
EVENT 70 0C DiscoverAttr_Cmd
EVENT 70 10 BasicCmd_Reset
EVENT 70 20 IdentifyCmd_Identify
EVENT 70 21 IdentifyCmd_Query
EVENT 70 30 GroupCmd_AddGroup
EVENT 70 31 GroupCmd_ViewGroup
EVENT 70 32 GroupCmd_GetGroupMembership
EVENT 70 33 GroupCmd_RemoveGroup
EVENT 70 34 GroupCmd_RemoveGroup
EVENT 70 35 GroupCmd_AddGroupIfIdentifying
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-10 Freescale Semiconductor
EVENT 70 40 SceneCmd_AddScene
EVENT 70 41 SceneCmd_ViewScene
EVENT 70 42 SceneCmd_RemoveScene
EVENT 70 43 SceneCmd_RemoveAllScene
EVENT 70 44 SceneCmd_StoreScene
EVENT 70 45 SceneCmd_RecallScene
EVENT 70 46 SceneCmd_GetSceneMembership
EVENT 70 50 OnOffCmd_SetState
EVENT 70 60 LevelControl_MoveToLevel
EVENT 70 61 LevelControl_Move
EVENT 70 62 LevelControl_Step
EVENT 70 70 ZclCommissioning_RestartDevice.Confirm
EVENT 70 71 ZclCommissioning_SaveStartupParameters.Confirm
EVENT 70 72 ZclCommissioning_RestoreStartupParameters.Confirm
EVENT 70 73 ZclCommissioning_ResetStartupParameters.Confirm
EVENT 70 81 ZclMessaging_DisplayMessage.Confirm
EVENT 70 82 ZclMessaging_CancelMessage.Confirm
EVENT 70 83 ZclMessaging_GetLastMessageRequest.Confirm
EVENT 70 84 ZclMessaging_MessageConfirmationReq.Confirm
EVENT 70 85 ZclSimpleMetering_GetProfileReq.Confirm
EVENT 70 86 ZclSimpleMetering_GetProfileRsp.Confirm
EVENT 70 87 ZclLoadControlDemandResponse_ReportEventStatusReq.Confirm
EVENT 70 88 ZclLoadControlDemandResponse_LoadControlEventReq.Confirm
EVENT 70 89 ZclLoadControlDemandResponse_CancelLoadControlEventReq.Confirm
EVENT 70 8A ZclCmdLoadControlDemandResponse_CancelAllLoadControlEventReq.Confirm
EVENT 70 8B zclPrice_GetCurrentPriceReq.Confirm
EVENT 70 8C zclPrice_GetSheduledPricesReq.Confirm
EVENT 70 8D zclPrice_PublishPriceRsp.Confirm
EVENT 70 8E zclKeyEstab_InitKeyEstabReq.Confirm
EVENT 70 8F KeyEstab_EphemeralDataReq.Confirm
EVENT 70 90 KeyEstab_ConfirmKeyDataReq.Confirm
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-11
EVENT 70 91 KeyEstab_TerminateKeyEstabServer.Confirm
EVENT 70 92 zclKeyEstab_InitKeyEstabRsp.Confirm
EVENT 70 93 KeyEstab_EphemeralDataRsp.Confirm
EVENT 70 94 KeyEstab_ConfirmKeyDataRsp.Confirm
EVENT 70 95 KeyEstab_TerminateKeyEstabClient.Confirm
EVENT 70 A1 ZclMsg_InterPanDisplayMessage.Confirm
EVENT 70 A2 ZclMsg_InterPanCancelMessage.Confirm
EVENT 70 A3 ZclMsg_InterPanGetLastMessageRequest.Confirm
EVENT 70 A4 ZclMsg_InterPanMessageConfirmationReq.Confirm
EVENT 70 A8 zclPrice_ScheduleServerPriceEventsConfirm
EVENT 70 A9 zclPrice_UpdateServerPrice.Confirm
EVENT 70 AA zclPrice_DeleteServerScheduledPrices.Confirm
EVENT 70 AB zclPrice_InterPanGetCurrentPriceReq.Confirm
EVENT 70 AC zclPrice_InterPanGetSheduledPricesReq.Confirm
EVENT 70 AD zclPrice_InterPanPublishPriceRsp.Confirm
EVENT 70 AE SE_ESPRegisterDevice.Confirm
EVENT 70 AF SE_ESPDeRegisterDevice.Confirm
EVENT 70 B0 TimeInit.Confirm
EVENT 84 00 MacAssociate.Indication
EVENT 84 01 MacAssociate.Confirm
EVENT 84 02 MacDisassociate.Indication
EVENT 84 03 MacDisassociate.Confirm
EVENT 84 04 MacBeaconNotify.Indication
EVENT 84 05 MacGetPIBAttribute.Confirm
EVENT 84 06 MacGTS.Indication
EVENT 84 07 MacGTS.Confirm
EVENT 84 08 MacOrphan.Indication
EVENT 84 09 MacReset.Confirm
EVENT 84 0A MacRxEnable.Confirm
EVENT 84 0B MacScan.Confirm
EVENT 84 0C MacCommStatus.Indication
EVENT 84 0D MacSetPIBAttribute.Confirm
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-12 Freescale Semiconductor
EVENT 84 0E MacStart.Confirm
EVENT 84 0F MacSyncLoss.Indication
EVENT 84 10 MacPoll.Confirm
EVENT 84 11 MacInputError.Confirm
EVENT 84 14 MacPollNotify.Indication
EVENT 85 00 MacAssociate.Request
EVENT 85 01 MacAssociate.Response
EVENT 85 08 MacScan.Request
EVENT 85 0A MacStart.Request
EVENT 85 0C MacPoll.Request
EVENT 86 00 MacData.Confirm
EVENT 86 01 MacData.Indication
EVENT 86 02 MacPurge.Confirm
EVENT 86 03 Promiscuous
EVENT 87 00 MacData.Request
EVENT 87 00 MacData.Request
EVENT 94 00 AspGetTime.Confirm
EVENT 94 01 AspWake.Indication
EVENT 94 02 AspIdle.Indication
EVENT 94 03 AspInactive.Indication
EVENT 94 04 AspEvent.Indication
EVENT 94 05 AspAcome.Confirm
EVENT 94 06 AspHibernate.Confirm
EVENT 94 07 AspWake.Confirm
EVENT 94 08 AspEvent.Confirm
EVENT 94 09 AspClko.Confirm
EVENT 94 0A AspTrim.Confirm
EVENT 94 0B AspDdr.Confirm
EVENT 94 0C AspPort.Confirm
EVENT 94 0D AspSetMinDozeTime.Confirm
EVENT 94 0E AspSetNotify.Confirm
EVENT 94 0F AspSetPowerLevel.Confirm
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-13
EVENT 94 10 AspTelectTest.Confirm
EVENT 94 11 AspTelecSetFreq.Confirm
EVENT 94 12 AspGetInactiveTime.Confirm
EVENT 94 13 AspGetMacState.Confirm
EVENT 94 14 AspDoze.Confirm
EVENT 94 15 AspAutoDoze.Confirm
EVENT 94 A0 AspNvRam.Confirm
EVENT 94 A1 AspBattery.Confirm
EVENT 95 00 AspGetTime.Request
EVENT 95 01 AspGetInactiveTime.Request
EVENT 95 02 AspGetMacState.Request
EVENT 95 03 AspDoze.Request
EVENT 95 04 AspAutoDoze.Request
EVENT 95 06 AspHibernate.Request
EVENT 95 07 AspWake.Request
EVENT 95 08 AspEvent.Request
EVENT 95 09 AspClko.Request
EVENT 95 0A AspTrim.Request
EVENT 95 0B AspDdr.Request
EVENT 95 0C AspPort.Request
EVENT 96 34 NLME-NETWORK-DISCOVERY.Request
EVENT 96 35 NLME-NETWORK-FORMATION.Request
EVENT 96 36 NLME-PERMIT-JOINING.Request
EVENT 96 37 NLME-START-ROUTER.Request
EVENT 96 38 NLME-JOIN.Request
EVENT 96 39 NLME-DIRECT.Request
EVENT 96 3A NLME-LEAVE.Request
EVENT 96 3B NLME-RESET.Request
EVENT 96 3C NLME-SYNC.Request
EVENT 96 4F NLME-ROUTE-DISCOVERY.Request
EVENT 96 55 NLME-ENERGY-SCAN.Request
EVENT 96 67 NETWORK-STATUS.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-14 Freescale Semiconductor
EVENT 97 41 NLME-NETWORK-DISCOVERY.Confirm
EVENT 97 42 NLME-NETWORK-FORMATION.Confirm
EVENT 97 43 NLME-PERMIT-JOINING.Confirm
EVENT 97 44 NLME-START-ROUTER.Confirm
EVENT 97 45 NLME-JOIN.Indication
EVENT 97 46 NLME-JOIN.Confirm
EVENT 97 47 NLME-DIRECT_JOIN.Confirm
EVENT 97 48 NLME-LEAVE.Confirm
EVENT 97 49 NLME-LEAVE.Indication
EVENT 97 4A NLME-RESET.Confirm
EVENT 97 4B NLME-SYNC.Indication
EVENT 97 4C NLME-SYNC.Confirm
EVENT 97 4E NLME-SET-NEIGHBOR-TABLE.Confirm
EVENT 97 50 NLME-ROUTE-DISCOVERY.confirm
EVENT 97 51 NLME-NWK-STATUS.Indication
EVENT 97 56 NLME-ENERGY-SCAN.confirm
EVENT 97 58 NLME-SET-CHANNEL.confirm
EVENT 97 68 NETWORK-STATUS.confirm
EVENT 98 06 ZDOtoApplication.indication
EVENT 98 07 APSME-BIND.Confirm
EVENT 98 08 APSME-UNBIND.Confirm
EVENT 98 0B APSME-RESET.Confirm
EVENT 98 D5 APSME-ESTABLISH-KEY.Confirm
EVENT 98 D6 APSME-ESTABLISH-KEY.Indication
EVENT 98 D7 APSME-UPDATE-DEVICE.Indication
EVENT 98 D8 APSME-REMOVE-DEVICE.Indication
EVENT 98 D9 APSME-REQUEST-KEY.Indication
EVENT 98 E8 APSME-ADD-GROUP.Confirm
EVENT 98 E9 APSME-REMOVE-GROUP.Confirm
EVENT 98 EA APSME-REMOVE-ALL-GROUPS.Confirm
EVENT 98 F1 APSME-SWITCH-KEY.Indication
EVENT 98 F2 APSME-TRANSPORT-KEY.Indication
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-15
EVENT 98 F6 APSME-AUTHENTICATE.Indication
EVENT 98 F7 APSME-AUTHENTICATE.Confirm
EVENT 99 00 APSME-BIND.Request
EVENT 99 09 APSME-UNBIND.Request
EVENT 99 0B APSME-RESET.Request
EVENT 99 CF APSME-ESTABLISH-KEY.Request
EVENT 99 D0 APSME-ESTABLISH-KEY.response
EVENT 99 D1 APSME-TRANSPORT-KEY.Request
EVENT 99 D3 APSME-REQUEST-KEY.Request
EVENT 99 D4 APSME-SWITCH-KEY.Request
EVENT 99 E8 APSME-ADD-GROUP.Request
EVENT 99 E9 APSME-REMOVE-GROUP.Request
EVENT 99 EA APSME-REMOVE-ALL-GROUPS.Request
EVENT 99 F3 APSME-UPDATE-DEVICE.Request
EVENT 99 F4 APSME-REMOVE-DEVICE.Request
EVENT 99 F5 APSME-AUTHENTICATE.Request
EVENT 9A 33 NLDE-DATA.Request
EVENT 9B 3F NLDE-DATA.Confirm
EVENT 9B 40 NLDE-DATA.Indication
EVENT 9C 00 APSDE-DATA.Request
EVENT 9C 01 DataRequestFragment
EVENT 9D 00 APSDE-DATA.Confirm
EVENT 9D 01 APSDE-DATA.Indication
EVENT 9D 02 DataIndicationFragment
EVENT 9D 10 ResetFragments.Confirm
EVENT 9D 11 LoadFragment.Confirm
EVENT 9D 12 SetFragAckMask.Confirm
EVENT 9D 13 SetMaxFragmentLength.Confirm
EVENT 9D 14 SetWindowSize.Confirm
EVENT 9D 15 SetInterframeDelay.Confirm
EVENT 9E 00 AFDE-DATA.Confirm
EVENT 9E 01 AFDE-MSG-DATA.Indication
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-16 Freescale Semiconductor
EVENT A0 47 NLME-APP-DIRECT_JOIN.Confirm
EVENT A0 4B ZDP-NLME-SYNC.Indication
EVENT A0 4C ZDP-NLME-SYNC.Confirm
EVENT A0 80 ZDP-NWK_addr.response
EVENT A0 81 ZDP-IEEE_addr.response
EVENT A0 82 ZDP-NodeDescriptor.Response
EVENT A0 83 ZDP-PowerDescriptor.Response
EVENT A0 84 ZDP-SimpleDescriptor.Response
EVENT A0 85 ZDP-Active_EP_rsp.response
EVENT A0 86 ZDP-Match_Desc_resp.response
EVENT A0 90 ZDP-Complex_Desc_rsp
EVENT A0 91 ZDP-UserDescriptor.Response
EVENT A0 92 ZDP-Discovery_Cache_response ZB1.1
EVENT A0 94 ZDP-User_Desc_conf
EVENT A0 95 ZDP-System_Server_Discovery.response ZB1.1
EVENT A0 96 ZDP-Discovery_store.response ZB1.1
EVENT A0 97 ZDP-Node_Desc_store.response ZB1.1
EVENT A0 98 ZDP-Power_Desc_store.response ZB1.1
EVENT A0 99 ZDP-Active_EP_store.response ZB1.1
EVENT A0 9A ZDP-Simple_Desc_store.response ZB1.1
EVENT A0 9B ZDP-Remove_node_cache.response ZB1.1
EVENT A0 9C ZDP-Find_node_cache.response ZB1.1
EVENT A0 9D ZDP-ExtendedSimpleDescriptor.Response
EVENT A0 9E ZDP-Extended_Active_EP_rsp.response
EVENT A0 A0 ZDP-ENDDEV_BIND.Resp
EVENT A0 A0 ZDP-End_Device_Bind.response ZB1.1
EVENT A0 A1 ZDP-BIND.Resp
EVENT A0 A2 ZDP-UNBIND.Response
EVENT A0 A3 ZDP-Bind_Register.response
EVENT A0 A4 ZDP-Replace_Device.response ZB1.1
EVENT A0 A5 ZDP-Store_Bkup_Bind_entry.response ZB1.1
EVENT A0 A6 ZDP-Remove_Bkup_Bind_entry.response ZB1.1
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-17
EVENT A0 A7 ZDP-Backup_Bind_Table.response ZB1.1
EVENT A0 A8 ZDP-Recover_Bind_Table.response ZB1.1
EVENT A0 A9 ZDP-Backup_Source_Bind.response ZB1.1
EVENT A0 AA ZDP-Recover_Source_Bind.response ZB1.1
EVENT A0 B0 ZDP-Mgmt_Nwk_Disc.Response
EVENT A0 B1 ZDP-Mgmt_Lqi.Response
EVENT A0 B2 ZDP-Mgmt_Rtg.Response
EVENT A0 B3 ZDP-Mgmt_Bind.Response
EVENT A0 B4 ZDP-Mgmt_Leave.Response
EVENT A0 B5 ZDP-Mgmt_Direct_Join.response ZB1.1
EVENT A0 B6 ZDP-Mgmt_Permit_Join.response ZB1.1
EVENT A0 B7 ZDP-Mgmt_Cache.response ZB1.1
EVENT A0 B8 ZDP-Mgmt_Nwk_Update.Notify
EVENT A0 D5 ZDP-ESTABLISH-KEY.Confirm
EVENT A0 D6 ZDP-ESTABLISH-KEY.indication
EVENT A0 D7 ZDP-UPDATE-DEVICE.Indication
EVENT A0 D8 ZDP-REMOVE-DEVICE.Indication
EVENT A0 D9 ZDP-REQUEST-KEY.Indication
EVENT A0 E1 AddressMapIndex.Confirm
EVENT A0 E3 AddressMap.Confirm
EVENT A0 E6 ZDO_EventOccurred.Indication
EVENT A0 F1 ZDP-SWITCH-KEY.Indication
EVENT A0 F2 ZDP-TRANSPORT-KEY.Indication
EVENT A0 F6 ZDP-AUTHENTICATE.Indication
EVENT A0 F7 ZDP-AUTHENTICATE.Confirm
EVENT A0 F9 ZDP-NLME-PERMIT-JOINING.Confirm
EVENT A0 FB SetApsSecMats.Confirm
EVENT A0 FD SetNwkSecMats.Confirm
EVENT A1 00 ReturnActiveNumOfEndPoints
EVENT A1 01 FindEndPointDesc.Confirmation
EVENT A1 02 EndPointIdsList
EVENT A2 00 ZDP-NWK_addr_req.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-18 Freescale Semiconductor
EVENT A2 01 ZDP-IEEE_addr_req.Request
EVENT A2 02 ZDP-NodeDescriptor.Request
EVENT A2 03 ZDP-PowerDescriptor.Request
EVENT A2 04 ZDP-SimpleDescriptor.Request
EVENT A2 05 ZDP-Active_EP_req.Request
EVENT A2 06 ZDP-Match_Desc_req.Request
EVENT A2 10 ZDP-Complex_Desc_req
EVENT A2 11 ZDP-User_Desc_req.Request
EVENT A2 12 ZDP-Discovery_Cache.request ZB1.1
EVENT A2 13 ZDP-EndDeviceAnnounce.Request
EVENT A2 14 ZDP-User_Desc_set
EVENT A2 15 ZDP-System_Server_Discovery.Request
EVENT A2 16 ZDP-Discovery_Store.Request
EVENT A2 17 ZDP-Node_Desc_Store.Request
EVENT A2 18 ZDP-Power_Desc_Store.Request
EVENT A2 19 ZDP-Active_EP_Store.Request
EVENT A2 1A ZDP-Simple_Desc_Store.Request
EVENT A2 1B ZDP-Remove_Node_Cache.Request
EVENT A2 1C ZDP-Find_Node_Cache.Request
EVENT A2 20 ZDP-End_Device_Bind.Request
EVENT A2 21 ZDP-BIND.Request
EVENT A2 22 ZDP-UNBIND.Request
EVENT A2 23 ZDP-Bind_Register.Request
EVENT A2 24 ZDP-Replace_Device.Request
EVENT A2 25 ZDP-Store_Bkup_Bind_entry.Request
EVENT A2 26 ZDP-Remove_Bkup_Bind_Entry.Request
EVENT A2 27 ZDP-Backup_Bind_Table.Request
EVENT A2 28 ZDP-Recover_Bind_Table.Request
EVENT A2 29 ZDP-Backup_Source_Bind.Request
EVENT A2 2A ZDP-Recover_Source_Bind.Request
EVENT A2 30 ZDP-Mgmt_Nwk_Disc.Request
EVENT A2 31 ZDP-Mgmt_Lqi.Request
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-19
EVENT A2 32 ZDP-Mgmt_Rtg.Request
EVENT A2 33 ZDP-Mgmt_Bind.Request
EVENT A2 34 ZDP-Mgmt_Leave.Request
EVENT A2 35 ZDP-Mgmt_Direct_Join.Response
EVENT A2 36 ZDP-Mgmt_Permit_Joining.Request
EVENT A2 37 ZDP-Mgmt_Cache.Request
EVENT A2 38 ZDP-Mgmt_Nwk_Update.Request
EVENT A2 3C ZDP-NLME-SYNC.Request
EVENT A2 79 ZDP-NLME-PERMIT-JOINING.Request
EVENT A2 B8 ZDP-Mgmt_Nwk_Update.Notify
EVENT A2 FA SetApsSecurityMaterials.Request
EVENT A2 FC SetNwkSecurityMaterials.Request
EVENT A2 FE Check-NeighborTable-ForRouting.Request
EVENT A3 20 APSME-GET.Request
EVENT A3 21 APSME-SET.Request
EVENT A3 22 NLME-GET.Request
EVENT A3 23 NLME-SET.Request
EVENT A3 DA ZTC-ConfigurationAttrib.Confirm
EVENT A3 DA ConfigurationAttributes.Init
EVENT A3 E4 BeeStackSave.Request
EVENT A4 00 ZTC-ModeSelect.Confirm
EVENT A4 02 ZTC-GetMode.Confirm
EVENT A4 04 ZTC-Event
EVENT A4 05 ZTC-AFReset.Confirm
EVENT A4 06 ZTC-APSReset.Confirm
EVENT A4 07 ZTC-SetAPSReady.Confirm
EVENT A4 0A ZTC-DeregisterEndPoint.Confirm
EVENT A4 0B ZTC-RegisterEndPoint.Confirm
EVENT A4 0C ZTC-GetNumberOfEndPoints.Confirm
EVENT A4 0D ZTC-GetEndPointDescription.Confirm
EVENT A4 0E ZTC-GetEndPointIdList.Confirm
EVENT A4 10 ZTC-GetICanHearYouTable.Confirm
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-20 Freescale Semiconductor
EVENT A4 11 ZTC-SetICanHearYoutTable.Confirm
EVENT A4 12 ZTC-GetChannel.Confirm
EVENT A4 13 ZTC-SetChannel.Confirm
EVENT A4 16 ZTC-GetPermissionsTable.Confirm
EVENT A4 17 ZTC-SetPermissionsTable.Confirm
EVENT A4 18 ZTC-RemoveFromPermissionsTable.Confirm
EVENT A4 19 ZTC-AddDeviceToPermissionsTable.Confirm
EVENT A4 20 APSME-GET.Confirm
EVENT A4 21 APSME-SET.Confirm
EVENT A4 22 NLME-GET.Confirm
EVENT A4 23 NLME-SET.Confirm
EVENT A4 24 GetNumOfMsgs.Confirm
EVENT A4 25 ZTC-FreeDiscoveryTables.Confirm
EVENT A4 26 ZTC-SetJoinFilterFlag.Confirm
EVENT A4 27 GetMaxApplicationPayload.Confirm
EVENT A4 30 ZTC-WriteMemoryBlock.Confirm
EVENT A4 31 ZTC-ReadMemoryBlock.Confirm
EVENT A4 38 ZTC-Ping.Confirm
EVENT A4 39 ZTC-AbelWrite.Confirm
EVENT A4 3A ZTC-AbelRead.Confirm
EVENT A4 D2 ZTC-ReadExtAddr.Confirm
EVENT A4 DB ZTC-WriteExtAddr.Confirm
EVENT A4 DC ZTC-StopNwk.Confirm
EVENT A4 DF ZTC-StartNwk.Confirm
EVENT A4 E0 ZTC-RestartNwk.Confirm
EVENT A4 E4 ZTC-NVSave.Confirm
EVENT A4 E4 ZTC-BeeStackSave.Confirm
EVENT A4 E5 ZTC-NVGetDataSetDesc.Confirm
EVENT A4 E6 ZTC-NVGetPageHeaders.Confirm
EVENT A4 E7 ZTC-StartNwkEx.Confirm
EVENT A4 E8 ZTC-StopNwkEx.Confirm
EVENT A4 FE ZTC-Error.event
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
Freescale Semiconductor A-21
EVENT A4 FF ZTC-Debug.event
EVENT A5 00 INTERPAN-DATA.Request
EVENT A6 01 INTERPAN-Data.Confirm
EVENT A6 02 INTERPAN-DATA.Indication
Table A-1. Commands and Events (continued)
Type Opcode Group OpCode Name
Commands and Events
ZigBee™ Test Client Reference Manual, Rev. 1.4
A-22 Freescale Semiconductor