Zigbee RF Modules - Digi International

1 Zigbee RF Modules XBEE2, XBEEPRO2, PRO S2B. User Guide Revision history 90000976. Revision Date Description Y July 2016 Removed Key Features section and made minor content updates. Updated the bootloader section. Update the certifications section. Z June 2017 Modified regulatory and certification information as required by RED (Radio Equipment Directive). AA May 2018 Added explanation of range estimates. AB March 2022 Added translated safety statements. Trademarks and copyright Digi, Digi International , and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners. 2022 Digi International . All rights reserved. Disclaimers Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International .

2 Digi provides this document as is, without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose. Digi may make improvements and/or changes in this manual or in the product(s) and/or the program(s) described in this manual at any time. Warranty To view product warranties online, visit Send comments Documentation feedback: To provide feedback on this document, send your comments to Customer support Digi Technical Support: Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and pricing, contact us at +1. or visit XBee/XBee-PRO Zigbee RF Modules User Guide 2. Contents Overview The difference between XBee and Zigbee .

3 10. Specifications of the XBee/XBee-PRO ZB RF Module .. 11. Hardware specifications for programmable variant .. 13. Mechanical drawings .. 14. SIF header interface .. 15. Mounting considerations .. 15. Pin signals .. 16. EM250 pin mappings .. 17. Design notes .. 18. Power supply design .. 18. Recommended pin connections .. 18. Board layout .. 19. External antenna positioning guidelines .. 19. Wire whip antenna positioning .. 19. Chip antenna positioning .. 19. Electrical characteristics .. 21. Module operation for the Programmable variant .. 21. Programmable XBee SDK .. 23. Module operation Serial communications .. 25. UART data flow .. 25. Serial buffers .. 26. Serial flow control .. 27. Serial interface protocols .. 27. Comparing Transparent and API operation .. 29. Modes of operation .. 30. Idle Mode .. 30. Transmit Mode.

4 30. Receive Mode .. 31. Command Mode .. 31. Sleep Mode .. 32. Zigbee networks Introduction to Zigbee .. 34. Zigbee stack layers .. 34. Networking concepts .. 35. Device types .. 35. Node types / sample of a basic Zigbee network topology .. 35. PAN ID .. 36. Operating channel .. 36. Zigbee application layers: in depth .. 36. Application Support Sublayer (APS) .. 37. Application profiles .. 37. Coordinator operation .. 38. Forming a network .. 38. Channel selection .. 38. XBee/XBee-PRO Zigbee RF Modules User Guide 3. PAN ID selection .. 38. Security policy .. 39. Persistent data .. 39. XBee ZB Coordinator startup .. 39. Permit joining .. 40. Resetting the Coordinator .. 40. Leaving a network .. 40. Replacing a Coordinator (security disabled only) .. 41. Example: starting a Coordinator .. 41. Example: replacing a Coordinator (security disabled).

5 42. Router operation .. 42. Discovering Zigbee networks .. 42. Joining a network .. 43. Authentication .. 43. Persistent data .. 43. XBee ZB router joining .. 43. Permit joining .. 44. Joining always enabled .. 44. Joining temporarily enabled .. 44. Router network connectivity .. 44. Leaving a network .. 46. Resetting the router .. 47. Example: joining a network .. 47. End Device operation .. 47. Discovering Zigbee networks .. 47. Joining a network .. 48. Parent child relationship .. 48. End Device capacity .. 48. Authentication .. 48. Persistent data .. 49. Orphan scans .. 49. XBee ZB End Device joining .. 49. Parent connectivity .. 50. Resetting the End Device .. 50. Leaving a network .. 50. Example: joining a network .. 51. Channel scanning for the XBee/XBee-PRO ZB RF Module .. 51. Managing multiple Zigbee networks.

6 51. PAN ID filtering .. 52. Preconfigured security keys .. 52. Permit joining .. 52. Application messaging .. 52. Transmission, addressing, and routing Addressing .. 54. 64-bit device addresses .. 54. 16-bit device addresses .. 54. Application layer addressing .. 54. Data transmission .. 54. Broadcast transmissions .. 54. Unicast transmissions .. 55. Data transmission examples .. 57. RF packet routing .. 60. XBee/XBee-PRO Zigbee RF Modules User Guide 4. Link status transmission .. 60. AODV mesh routing .. 61. Many-to-one routing .. 63. Source routing .. 63. Encrypted transmissions .. 67. Maximum RF payload size .. 67. Throughput .. 68. ZDO transmissions .. 68. ZDO .. 68. Sending a ZDO command .. 69. Receiving ZDO commands and responses .. 69. Transmission timeouts .. 71. Unicast timeout .. 71. Extended timeout .. 71. Transmission examples.

7 72. ZB security Security modes .. 75. Zigbee security model .. 75. Network layer security .. 75. Frame counter .. 76. Message integrity code .. 76. Network layer encryption and decryption .. 76. Network key updates .. 76. APS layer security .. 76. Message integrity code .. 77. APS link keys .. 77. APS layer encryption and decryption .. 77. Network and APS layer encryption .. 77. Trust center .. 78. Forming and joining a secure network .. 78. Implementing security on the XBee .. 78. Enabling security .. 79. Setting the network security key .. 79. Setting the APS trust center link key .. 79. Enabling APS encryption .. 79. Using a trust center .. 80. XBee security examples .. 80. Example 1: forming a network with security (pre-configured link keys) .. 80. Example 2: forming a network with security (obtaining keys during joining).

8 81. Network commissioning and diagnostics Device configuration .. 83. Device placement .. 83. Link testing .. 83. RSSI indicators .. 84. Device discovery .. 84. Network discovery .. 84. ZDO discovery .. 84. Joining announce .. 84. Commissioning pushbutton and associate LED .. 85. Commissioning pushbutton .. 85. XBee/XBee-PRO Zigbee RF Modules User Guide 5. Associate LED .. 86. Managing End Devices End Device operation .. 89. Parent operation .. 89. End Device poll timeouts .. 90. Packet buffer usage .. 90. Non-parent device operation .. 90. XBee End Device configuration .. 91. Pin sleep .. 91. Cyclic sleep .. 93. Transmitting RF data .. 96. Receiving RF data .. 97. IO sampling .. 97. Waking End Devices with the Commissioning Pushbutton .. 97. Parent verification .. 97. Rejoining .. 97. XBee ZB Router/Coordinator configuration.

9 98. RF packet buffering timeout .. 98. Child poll timeout .. 98. Transmission timeout .. 99. Putting It all together .. 99. Short sleep periods .. 99. Extended sleep periods .. 99. Sleep examples .. 99. Example 1 .. 100. Example 2 .. 100. Example 3 .. 100. Analog and digital IO lines IO configuration .. 103. IO sampling .. 103. Queried sampling .. 105. Periodic IO sampling .. 106. Change detection sampling .. 106. RSSI PWM .. 106. IO examples .. 107. API operation API frame specifications .. 109. API examples .. 111. API UART exchanges .. 112. AT commands .. 112. Transmitting and receiving RF data .. 113. Remote AT commands .. 113. Source routing .. 113. Supporting the API .. 114. API frames .. 115. AT command .. 115. AT command - Queue Parameter Value .. 116. Zigbee Transmit Request .. 116. XBee/XBee-PRO Zigbee RF Modules User Guide 6.

10 Explicit Addressing Zigbee Command frame .. 119. Remote AT Command Request .. 121. Create Source Route .. 123. AT Command Response .. 124. Modem Status .. 125. Zigbee Transmit Status .. 126. Zigbee Receive Packet .. 127. Zigbee Explicit Rx Indicator .. 128. Zigbee IO Data Sample Rx Indicator .. 129. XBee Sensor Read Indicator .. 131. Node Identification Indicator .. 133. Remote Command Response .. 135. Over-the-Air Firmware Update Status .. 135. Route Record Indicator .. 138. Many-to-One Route Request Indicator .. 139. Sending Zigbee Device Objects (ZDO) commands with the API .. 139. Sending Zigbee Cluster Library (ZCL) commands with the API .. 142. Sending public profile commands with the API .. 146. Device Authenticated Indicator .. 150. Register Joining Device Status .. 151. Register Joining Device .. 152. Command reference tables Addressing commands.