Preface
This manual provides a single point of reference for information relating to the ZigBee 3.0 wireless networking protocol and its associated stack, when implemented on the NXP K32W041, K32W061, K32W1, MCXW71, MCXW72, RW612, and JN518x family of wireless microcontrollers. It supports the NXP hardware platforms:- K32W148-EVK, FRDM-MCXW71, FRDM-MCXW72, MCX-W71-EVK, MCX-W72-EVK, FRDM-RW612, and RD-RW612-BGA. The manual provides both conceptual and practical information concerning the ZigBee 3.0 protocol and the supporting NXP software. Guidance is provided on the use of the NXP Application Programming Interfaces (APIs) for ZigBee 3.0. The API resources (such as functions, network parameters, enumerations, data types and events) are described in detail. The document can be used as a reference resource during ZigBee 3.0 application development.
Note:
The ZigBee 3.0 protocol employs the ZigBee PRO stack - in particular, Revision 22/ZigBee 2017 of this stack. Therefore, this User Guide relates to this stack revision.
This User Guide is concerned with the development of applications that operate over the ZigBee PRO stack. These applications may conform to ZigBee 3.0 or may use ZigBee or manufacturer-specific application profiles. ZigBee 3.0 applications are based on ZigBee device types for which users should also refer to the ZigBee 3.0 Devices User Guide (JNUG3131).
For more detailed information on the ZigBee 3.0 standard, refer to the protocol specifications available from the ZigBee Alliance.
Organization of this manual
This manual is divided into four parts:
Part I: Concept and Operational Information consists of six chapters:
Chapter 1: Preface provides an overview of the document contents, conventions, support resources, and compatibility information.
Chapter 2: ZigBee overview introduces the ZigBee 3.0 wireless network protocol.
Chapter 3: ZigBee PRO architecture and operation describes the architecture and features of ZigBee 3.0.
Chapter 4: ZigBee Stack Software introduces the NXP ZigBee PRO stack software.
Chapter 5: Application development overview provides an overview of the ZigBee 3.0 application development environment and process.
Chapter 6: Application coding with ZigBee PRO APIs describes how to perform common wireless network operations using the functions of the NXP ZigBee 3.0 APIs.
Part II: Reference Information consists of six chapters:
Chapter 7: ZigBee Device Objects (ZDO) API details the functions and associated resources of the ZigBee Device Objects (ZDO) API.
Chapter 8: Application Framework (AF) API details the functions and associated resources of the Application Framework (AF) API.
Chapter 9: ZigBee Device Profile (ZDP) API details the functions and associated resources of the ZigBee Device Profile (ZDP) API.
Chapter 10: General ZPS Resources details the general functions and associated resources provided with the NXP ZigBee PRO stack.
Chapter 11: Event and Status Codes details the stack events and the return/status codes used by the ZigBee PRO APIs.
Chapter 12: ZigBee network parameters details the ZigBee network parameters.
Part III: Network Configuration consists of one chapter:
Chapter 13: ZPS Configuration Editor describes how to use the ZPS Configuration Editor.
Part IV: contains various ancillary information that include the following:
Appendix A: Appendix A: Handling stack events: a description of the handling of ZigBee PRO stack events.
Appendix B: Appendix B: Application design notes: a set of design application notes.
Appendix C: Appendix C: Implementation of frame counters: a description of frame counters.
Appendix D: Appendix D: storing applications in device flash memory: a description of application storage in Flash memory.
Appendix E: a glossary of terms used in ZigBee 3.0 networks.
Appendix F: Revision History for the document.
Parent topic:Preface
Conventions
Files, folders, functions and parameter types are represented in bold type. Function parameters are represented in italicstype.
Code fragments are represented in the Courier Newtypeface.
Note: A note represents an important fact, guideline, or information.
Parent topic:Preface
Acronyms and abbreviations
The table below lists the acronyms and abbreviations used in this document.
Acronym |
Description |
|---|---|
AF |
Application Framework |
AIB |
APS Information Base |
APDU |
Application Protocol Data Unit |
API |
Application Programming Interface |
APS |
Application Support (sub-layer) |
APSDE |
Application Support (sub-layer) Data |
APSME |
Application Support (sub-layer) Management |
BDB |
Base Device Behavior |
DIO |
Digital Input/Output |
EPID |
Extended PAN ID |
HA |
Home Automation |
HVAC |
Heating, Ventilation, and Air-Conditioning |
IO |
Input/Output |
ISR |
Interrupt Service Routine |
MAC |
Media Access Control |
PAN |
Personal Area Network |
NIB |
NWK Information Base |
NPDU |
Network Protocol Data Unit |
NVM |
Non-Volatile Memory Manager |
NWK |
Network |
OS |
Operating System |
PDU |
Protocol Data Unit |
PDUM |
Protocol Data Unit Manager |
PIC |
Programmable Interrupt Controller |
RF |
Radio Frequency |
SAP |
Service Access Point |
SDK |
Software Developer’s Kit |
UART |
Universal Asynchronous Receiver-Transmitter |
ZCL |
ZigBee Cluster Library |
ZCP |
ZigBee Compliant Platform |
ZDO |
ZigBee Device Objects |
ZDP |
ZigBee Device Profile |
ZCP |
ZigBee Compliant Platform |
ZDO |
ZigBee Device Objects |
ZDP |
ZigBee Device Profile |
Parent topic:Preface
Support resources
To access online support resources such as SDKs, Application Notes, and User Guides, visit the Wireless Connectivity page of the NXP website: https://www.nxp.com/products/wireless:WIRELESS-CONNECTIVITY
ZigBee resources can be accessed from the ZigBee page, whose URL is: https://www.nxp.com/pages/jn516x-7x-zigbee-3-0:ZIGBEE-3-0.
All NXP resources referred to in this manual can be found at the above addresses, unless otherwise stated.
Parent topic:Preface
Trademarks
All trademarks are the property of their respective owners.
Parent topic:Preface
Chip compatibility
The software described in this manual can be used on the NXP K32W041, K32W061, K32W1, MCXW71, MCXW72, RW612, and JN518x family of wireless microcontrollers.
Parent topic:Preface