Digi XBee Manual de usuario

XBee®/XBee-PRO S2C ZigBee®

RF Module

User Guide

Revision history—90002002

Revision Date Description

U December2015 Updated XBee-PRO surface-mount agency approvals. Added missing

Extended Modem Status status code descriptions to the 0x98 frame.

Added ANATEL labels.

V July 2016 Updated the firmware release notes section. Updated several

hardware specifications with S2D hardware information. Updated

regulatory information. Revised the Programmable XBee SDK section.

Added the ED command. Updated the BD command. Added antennas

for the S2D hardware. Added a section on loading ZB firmware. Added

“S2C” to the product name on the title page and throughout the

document. Updated the number of supported address table entries.

W February 2017 Added South Korea certification data for the S2C TH and S2C SMT

devices.

X May 2017 Removed the XBee-PRO S2C SMT programmable modules from the

Brazilian certified list.

Y June 2017 Modified regulatory and certification information as required by RED

(Radio Equipment Directive).

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.

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

Send comments

Documentation feedback: To provide feedback on this document, send your comments to

techcomm@digi.com.

XBee/XBee-PRO® S2C ZigBee® RF Module 2

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 952.912.3444 or visit us at www.digi.com/support.

XBee/XBee-PRO® S2C ZigBee® RF Module 3

Contents

XBee/XBee-PRO® S2C ZigBee® RF Module

Note on product naming 14

Applicable firmware and hardware 14

Firmware release notes 14

Technical specifications

Performance specifications 16

Power requirements 16

General specifications 16

Networking and security specifications 17

Communication interface specifications 17

Regulatory conformity summary 18

Serial communication specifications 19

UART pin assignments 19

SPI pin assignments 19

GPIO specifications 19

Hardware specifications for the programmable variant 20

Hardware

Mechanical drawings 23

Pin signals for the surface-mount module 24

Pin signals for the through-hole module 26

EM357 pin mappings 27

Design notes 28

Power supply design 28

Board layout 29

Antenna performance 29

Recommended pin connections 30

Design notes for PCB antenna devices 30

Design notes for SMT RF pad devices 32

Module operation for the programmable variant 35

Programmable XBee SDK

Programmable connections 37

XBee/XBee-PRO® S2C ZigBee® RF Module 4

XBee/XBee-PRO® S2C ZigBee® RF Module 5

Operation

Serial interface 40

UART data flow 40

Serial data 40

SPI communications 41

SPI operation 41

Serial port selection 42

Serial buffers 42

Serial receive buffer 42

Serial transmit buffer 43

UART flow control 43

CTS flow control 43

RTS flow control 43

Break control 44

Serial interface protocols 44

Transparent operating mode 44

API operating mode 44

Compare Transparent and API operation 45

Modes of operation 47

Idle mode 48

Transmit mode 48

Receive mode 49

Command mode 49

Sleep mode 50

ZigBee networks

About the ZigBee specification 52

ZigBee stack layers 52

ZigBee networking concepts 53

Device types 53

PAN ID 55

Operating channels 56

Zigbee application layers: in depth 56

Application Support Sublayer (APS) 56

Application profiles 56

ZigBee coordinator operation 58

Form a network 58

Security policy 58

Channel selection 58

PAN ID selection 58

Persistent data 58

Coordinator startup 59

Permit joining 60

Reset the coordinator 60

Leave a network 61

Replace a coordinator (security disabled only) 61

Example: start a coordinator 62

Example: replace a coordinator (security disabled) 62

ZigBee router operation 62

Discover ZigBee networks 63

Join a network 63

Persistent data 63

XBee/XBee-PRO® S2C ZigBee® RF Module 6

ZigBee router joining 64

Permit joining 65

Router network connectivity 65

End device operation 68

Discover ZigBee networks 69

Join a network 69

End device capacity 69

Persistent data 70

Orphan scans 70

End device joining 70

Parent connectivity 71

Reset the end device 71

Leave a network 72

Example: join a network 72

ZigBee channel scanning 73

Manage multiple ZigBee networks 73

Filter PAN ID 73

Configure security keys 73

Prevent unwanted devices from joining 73

Application messaging framework 74

Transmission, addressing, and routing

Addressing 76

64-bit device addresses 76

16-bit device addresses 76

Application layer addressing 76

Data transmission 76

Broadcast transmissions 76

Unicast transmissions 77

Address resolution 78

Address table 78

Group table 79

Binding transmissions 79

Address resolution 79

Binding table 80

Multicast transmissions 80

Address resolution 80

Fragmentation 80

Data transmission examples 80

AT firmware 81

API firmware 81

API frame 82

RF packet routing 83

Link status transmission 83

AODV mesh routing 84

Many-to-One routing 87

High/Low RAM Concentrator mode 87

Source routing 87

Encrypted transmissions 92

Maximum RF payload size 92

Throughput 94

ZDO transmissions 95

ZDO 95

Sending a ZDO command 95

XBee/XBee-PRO® S2C ZigBee® RF Module 7

Receiving ZDO command and responses 95

Transmission timeouts 97

Unicast timeout 98

Extended timeout 98

Transmission examples 99

ZigBee security

Security modes 102

ZigBee security model 102

Network layer security 102

APS layer security 103

Trust center 105

Forming or joining a secure network 105

Implementing security on the XBee/XBee-PRO ZigBee RF Module 105

Enabling security 106

Setting the network security key 106

Set the APS trust center link key 106

Enable APS encryption 106

Use a trust center 107

Security examples 107

Network commissioning and diagnostics

Place devices 109

Test links in a network - loopback cluster 109

RSSI indicators 110

Device discovery 110

Network discovery 110

ZDO discovery 110

Joining Announce 111

Commissioning pushbutton and associate LED 111

Commissioning pushbutton 111

Associate LED 112

Binding 113

End_Device_Bind_req 113

Example of a End_Device_Bind_req 116

Group Table API 116

Add Group command 116

View group 118

Get Group Membership 119

Remove Group 121

Remove All Groups 123

Default responses 124

Common status codes 125

Manage End Devices

End Device operation 127

Parent operation 127

End Device poll timeouts 128

Packet buffer usage 128

Non-Parent device operation 129

XBee/XBee-PRO® S2C ZigBee® RF Module 8

End Device configuration 129

Pin sleep 130

Cyclic sleep 131

Recommended sleep current measurements 136

Achieve the lowest sleep current 136

Compensate for switching time 136

Internal pin pull-ups 137

Transmitting RF data 137

Receiving RF data 137

I/O sampling 138

Waking end devices with the Commissioning Pushbutton 138

Parent verification 138

Rejoining 138

Router/Coordinator configuration 139

RF packet buffering timeout 139

Child poll timeout 139

Transmission timeout 140

Putting it all together 141

Short sleep periods 141

Extended sleep periods 141

Sleep examples 141

Analog and digital I/O lines

Configurable I/O pins and configuration commands 144

XBee ZB through-hole RF module 144

I/O Configuration 145

I/O sampling 146

Queried sampling 147

Periodic I/O sampling 148

Change detection sampling 148

RSSI PWM 148

I/O examples 149

PWM1 149

API Operation

API frame format 151

API operation (AP parameter = 1) 151

API operation-with escaped characters (AP parameter = 2) 151

Data bytes that need to be escaped: 152

Length 152

Frame data 152

Calculate and verify checksums 153

API examples 154

API serial exchanges 155

AT commands 155

Transmit and Receive RF data 156

Remote AT commands 156

Source routing 157

Frame descriptions 158

AT Command Frame - 0x08 158

AT Command - Queue Parameter Value frame - 0x09 160

Transmit Request frame - 0x10 162

XBee/XBee-PRO® S2C ZigBee® RF Module 9

Explicit Addressing Command frame - 0x11 166

Remote AT Command Request frame - 0x17 169

Create Source Route - 0x21 171

AT Command Response frame - 0x88 174

Modem Status frame - 0x8A 176

Transmit Status frame - 0x8B 177

Receive Packet frame - 0x90 179

Explicit Rx Indicator frame - 0x91 181

Data Sample Rx Indicator frame - 0x92 183

XBee Sensor Read Indicator - 0x94 186

Node Identification Indicator frame - 0x95 189

Remote Command Response frame - 0x97 192

Extended Modem Status frame - 0x98 194

Over-the-Air Firmware Update Status - 0xA0 201

Route Record Indicator - 0xA1 203

Many-to-One Route Request Indicator - 0xA3 205

Send ZDO commands with the API 206

Example 208

Send ZigBee Cluster Library (ZCL) commands with the API 209

Example 212

Send Public Profile Commands with the API 214

Frame specific data 214

Example 217

AT commands

Addressing commands 221

DH (Destination Address High) 221

DL (Destination Address Low) 221

MY (16-bit Network Address) 221

MP (16-bit Parent Network Address) 221

NC (Number of Remaining Children) 222

SH (Serial Number High) 222

SL (Serial Number Low) 222

NI (Node Identifier) 222

SE (Source Endpoint) 223

DE (Destination Endpoint) 223

CI (Cluster ID) 223

TO (Transmit Options) 223

NP (Maximum Packet Payload Bytes) 224

DD (Device Type Identifier) 224

CR (Conflict Report) 224

Network commands 225

CH (Operating Channel) 225

CE (Coordinator Enable) 225

ID (Extended PAN ID) 225

OP (Operating Extended PAN ID) 226

NH (Maximum Unicast Hops) 226

BH (Broadcast Hops) 226

OI (Operating 16-bit PAN ID) 226

NT (Node Discover Timeout) 226

NO(Network Discovery Options) 227

SC (Scan Channels) 227

SD (Scan Duration) 228

ZS (ZigBee Stack Profile) 229

XBee/XBee-PRO® S2C ZigBee® RF Module 10

NJ (Node Join Time) 230

JV (Channel Verification) 230

NW(Network Watchdog Timeout) 230

JN (Join Notification) 230

AR (Aggregate Routing Notification) 231

Security commands 231

EE (Encryption Enable) 231

EO (Encryption Options) 231

NK (Network Encryption Key) 232

KY (Link Key) 232

RF interfacing commands 232

PL (TX Power Level) 232

PM (Power Mode) 233

DB (Received Signal Strength) 233

PP (Peak Power) 234

Serial interfacing commands 234

API Enable 234

AO (API Options) 234

BD (Interface Data Rate) 235

NB (Parity) 236

SB (Stop Bits) 236

RO (Packetization Timeout) 237

D6 (DIO6/RTS) 237

I/O settings commands 238

IR (I/O Sample Rate) 238

IC (Digital Change Detection) 238

P0 (RSSI/PWM0 Configuration) 239

P1 (DIO11/PWM1 Configuration) 239

P2 (DIO12 Configuration) 240

P3 (DIO13/DOUT Configuration) 240

P4 (DIO14/DIN) 241

P5 (DIO15/SPI_MISO) 241

P6 (SPI_MOSI Configuration) 241

P7 (DIO17/SPI_SSEL ) 242

P8 (DIO18/SPI_SCLK) 242

P9 (DIO19/SPI_ATTN/PTI_DATA) 242

D0 (AD0/DIO0 Configuration) 243

D1 (AD1/DIO1/PTI_En Configuration) 243

D2 (AD2/DIO2 Configuration) 244

D3 (AD3/DIO3 Configuration) 244

D4 (DIO4 Configuration) 245

D5 (DIO5/Associate Configuration) 245

D8 (DIO8/DTR/SLP_RQ) 246

D9 (DIO9/ON_SLEEP) 246

LT (Associate LED Blink Time) 246

PR (Pull-up/Down Resistor Enable) 247

PD (Pull Up/Down Direction) 248

RP(RSSI PWM Timer) 248

DC (Device Controls) 248

DO (Device Options) 249

%V (Voltage Supply Monitoring) 249

V+ (Voltage Supply Monitoring) 249

TP (Temperature) 250

Diagnostic commands 250

VR (Firmware Version) 250

Otros manuales para XBee

Este manual sirve para los siguientes modelos

Tabla de contenidos

Otros manuales de Unidad de control de Digi

Digi

Digi XBee SX 868 Manual de usuario

Digi

Digi ConnectCore Guía rápida de usuario

Digi

Digi XBee 3 ZigBee Manual de usuario

Digi

Digi ConnectCore Series Guía de aplicación

Digi

Digi ConnectCore 7U Guía de aplicación

Digi

Digi Connect Wi-ME 9210 Manual de usuario

Digi

Digi XBee Manual de usuario

Digi

Digi ConnectCore 6UL Guía rápida de usuario

Digi

Digi WB-20 Manual de usuario

Digi

Digi XBee XTC Manual de usuario

Digi

Digi Digi Conntect ME Guía de aplicación

Digi

Digi INFOTAG 2.13 Manual de usuario

Digi

Digi XBee 868LP Manual de usuario

Digi

Digi XBee-PRO Manual de usuario

Digi

Digi XTend Manual de usuario

Digi

Digi XBee3-PRO Micro Guía rápida de usuario

Digi

Digi XBee3 802.15.4 Manual de usuario

Digi

Digi Connect ME 9210 Manual de usuario

Digi

Digi XBee 3802.15.4 Manual de usuario

Digi

Digi XBee 868LP Manual de usuario

Digi

Digi XBee Manual de usuario

Digi

Digi ConnectCore 8X Guía rápida de usuario

Digi

Digi 5400-RM Manual de usuario

Digi

Digi Connect Wi-Wave Guía de aplicación

Manuales populares de Unidad de control de otras marcas

Festo

Festo Compact Performance CP-FB6-E Manual de lista de piezas

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Manual de usuario

JS Automation

JS Automation MPC3034A Manual de usuario

JAUDT

JAUDT SW GII 6406 Series Guía rápida

Spektrum

Spektrum Air Module System Manual de usuario

BOC Edwards

BOC Edwards Q Series Manual de usuario

KHADAS

KHADAS BT Magic Manual de usuario

Etherma

Etherma eNEXHO-IL Manual de usuario

PMFoundations

PMFoundations Attenuverter Manual de usuario

GEA

GEA VARIVENT Manual de usuario

Walther Systemtechnik

Walther Systemtechnik VMS-05 Manual de usuario

Altronix

Altronix LINQ8PD Instrucciones de montaje

Eaton

Eaton Powerware Series Manual de usuario

WAGO

WAGO 750-407/040-000 Manual de usuario

Sony

Sony CCU-590 Manual de usuario

Graco

Graco 25D614 Manual de usuario

Task Force Tips

Task Force Tips YE-RF-900 Manual de programación

Shini

Shini SPV-U Series Manual de usuario