XBee®/XBee-PRO S2C Zigbee® RF Module User Guide Revision history—90002002 Revision Date Description AD June 2019 Added FCC publication 996369 related information. AE October Enhancement to the network watchdog, fixes for a number of customer 2019 reported issues. AF November Added Brazilian ANATEL certification information. 2019 AG January Added IFETEL certifications. 2020 AH July 2021 Added safety instructions and UKCA labeling requirements. 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. © 2020 Digi International Inc. 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. 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 warranty information, go to the following website: www.digi.com/howtobuy/terms Customer support Gather support information: Before contacting Digi technical support for help, gather the following information: Product name and model Product serial number (s) Firmware version Operating system/browser (if applicable) Logs (from time of reported issue) Trace (if possible) XBee/XBee-PRO® S2C Zigbee® RF Module 2 Description of issue Steps to reproduce Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support. Feedback To provide feedback on this document, email your comments to [email protected] Include the document title and part number (XBee/XBee-PRO® S2C Zigbee® RF Module, 90002002 AH) in the subject line of your email. XBee/XBee-PRO® S2C Zigbee® RF Module 3 Contents XBee/XBee-PRO® S2C Zigbee® RF Module Note on product naming 15 Applicable firmware and hardware 15 Firmware release notes 15 Safety instructions 15 XBee modules 15 Technical specifications Performance specifications 17 Power requirements 17 General specifications 17 Networking and security specifications 18 Communication interface specifications 18 Regulatory conformity summary 19 Serial communication specifications 21 UART pin assignments 21 SPI pin assignments 21 GPIO specifications 21 Hardware specifications for the programmable variant 22 Hardware Mechanical drawings 25 Pin signals for the surface-mount module 26 Pin signals for the through-hole module 29 EM357 pin mappings 30 Design notes 31 Power supply design 31 Board layout 31 Antenna performance 32 Recommended pin connections 32 Design notes for PCB antenna devices 33 Design notes for RF pad devices 34 Module operation for the programmable variant 37 Programmable XBee SDK Programmable connections 39 XBee/XBee-PRO® S2C Zigbee® RF Module 4 Operation Serial interface 42 UART data flow 42 Serial data 42 SPI communications 43 SPI operation 43 Serial port selection 44 Serial buffers 44 Serial receive buffer 45 Serial transmit buffer 45 UART flow control 45 CTS flow control 45 RTS flow control 46 Break control 46 Serial interface protocols 46 Transparent operating mode 46 API operating mode 46 Compare Transparent and API operation 47 Modes 48 Idle mode 49 Transmit mode 49 Receive mode 50 Command mode 50 Sleep mode 52 Zigbee networks About the Zigbee specification 54 Definitions 54 Zigbee node types 54 Zigbee protocol 55 Zigbee stack layers 56 Zigbee networking concepts 57 Device types 57 PAN ID 59 Operating channels 59 Zigbee application layers: in depth 60 Application Support Sublayer (APS) 60 Application profiles 60 Zigbee coordinator operation 61 Form a network 61 Security policy 62 Channel selection 62 PAN ID selection 62 Persistent data 62 Coordinator startup 62 Permit joining 63 Reset the coordinator 64 Leave a network 64 Replace a coordinator (security disabled only) 65 Example: start a coordinator 65 Example: replace a coordinator (security disabled) 66 Router operation 66 XBee/XBee-PRO® S2C Zigbee® RF Module 5 Discover Zigbee networks 66 Join a network 67 Persistent data 67 Zigbee router joining 67 Permit joining 68 Router network connectivity 69 End device operation 71 Discover Zigbee networks 71 Join a network 72 End device capacity 72 Persistent data 73 Orphan scans 73 End device joining 73 Parent connectivity 74 Reset the end device 74 Leave a network 75 Example: join a network 75 Zigbee channel scanning 75 Manage multiple Zigbee networks 76 Filter PAN ID 76 Configure security keys 76 Prevent unwanted devices from joining 76 Application messaging framework 77 Transmission, addressing, and routing Addressing 79 64-bit device addresses 79 16-bit device addresses 79 Application layer addressing 79 Data transmission 79 Broadcast transmissions 79 Unicast transmissions 80 Address resolution 80 Address table 81 Group table 82 Binding transmissions 82 Address resolution 82 Binding table 82 Multicast transmissions 83 Address resolution 83 Fragmentation 83 Data transmission examples 83 Transparent mode 83 API mode 84 API frame 85 RF packet routing 85 Link status transmission 86 AODV mesh routing 87 Many-to-One routing 90 High/Low RAM Concentrator mode 90 Source routing 90 Encrypted transmissions 95 Maximum RF payload size 95 Throughput 97 XBee/XBee-PRO® S2C Zigbee® RF Module 6 Latency timing specifications 98 ZDO transmissions 98 Send a ZDO command 98 Receiving ZDO command and responses 99 Transmission timeouts 101 Unicast timeout 101 Extended timeout 102 Transmission examples 102 Zigbee security Security modes 106 Zigbee security model 106 Network layer security 106 APS layer security 108 Trust center 109 Forming or joining a secure network 109 Implement security on the XBee/XBee-PRO Zigbee RF Module 109 Enabling security 110 Setting the network security key 110 Set the APS trust center link key 110 Enable APS encryption 110 Use a trust center 111 Security examples 111 Network commissioning and diagnostics Place devices 113 Test links in a network - loopback cluster 113 RSSI indicators 114 Device discovery 114 Network discovery 114 ZDO discovery 114 Joining Announce 115 Commissioning pushbutton and associate LED 115 Commissioning pushbutton 115 Associate LED 116 Binding 117 End_Device_Bind_req 117 Example of a End_Device_Bind_req 119 Group Table API 119 Add Group command 120 View group 121 Get Group Membership 122 Remove Group 125 Remove All Groups 126 Default responses 127 Common status codes 127 Manage End Devices End device operation 130 Parent operation 130 XBee/XBee-PRO® S2C Zigbee® RF Module 7 End Device poll timeouts 131 Packet buffer usage 131 Non-Parent device operation 132 End Device configuration 132 Pin sleep 133 Cyclic sleep 135 Recommended sleep current measurements 139 Achieve the lowest sleep current 139 Compensate for switching time 139 Internal pin pull-ups 140 Transmit RF data 140 Receiving RF data 140 I/O sampling 141 Wake end devices with the Commissioning Pushbutton 141 Parent verification 141 Rejoining 141 Router/Coordinator configuration 142 RF packet buffering timeout 142 Child poll timeout 142 Transmission timeout 143 Short sleep periods 143 Extended sleep periods 143 Sleep examples 143 Example 1: Configure a device to sleep for 20 seconds, but set SN such that the On/sleep line will remain de-asserted for up to 1 minute 143 Example 2: Configure an end device to sleep for 20 seconds, send 4 I/O samples in 2 seconds, and return to sleep 144 Example 3: configure a device for extended sleep: to sleep for 4 minutes 144 Analog and digital I/O lines Configurable I/O pins and configuration commands 147 XBee ZB through-hole RF module 147 I/O configuration 148 I/O sampling 149 Queried sampling 150 Periodic I/O sampling 151 Change detection sampling 151 RSSI PWM 151 I/O examples 152 PWM1 152 API Operation API frame format 154 API operation (AP parameter = 1) 154 API operation-with escaped characters (AP parameter = 2) 154 Data bytes that need to be escaped: 155 Length 155 Frame data 155 Calculate and verify checksums 156 API examples 157 API serial exchanges 158 AT commands 158 XBee/XBee-PRO® S2C Zigbee® RF Module 8 Transmit and Receive RF data 159 Remote AT commands 159 Source routing 160 Device Registration 160 Send ZDO commands with the API 160 Example 162 Send Zigbee cluster library (ZCL) commands with the API 163 Example 166 Send Public Profile Commands with the API 168 Frame specific data 168 Example 171 Frame descriptions Local AT Command Request - 0x08 175 Description 175 Format 175 Examples 175 Queue Local AT Command Request - 0x09 177 Description 177 Examples 177 Transmit Request - 0x10 179 Description 179 Transmit options bit field 180 Examples 181 Explicit Addressing Command Request - 0x11 183 Description 183 64-bit addressing 183 16-bit addressing 183 Zigbee-specific addressing information 183 Reserved endpoints 184 Reserved cluster IDs 184 Reserved profile IDs 184 Transmit options bit field 185 Examples 186 Remote AT Command Request - 0x17 189 Description 189 Format 189 Examples 190 Create Source Route - 0x21 192 Description 192 Format 192 Examples 193 Local AT Command Response - 0x88 194 Description 194 Examples 194 Modem Status - 0x8A 196 Description 196 Modem status codes 197 Examples 198 Extended Transmit Status - 0x8B 199 Description