Digi PS2CSM User manual

Digi International Inc.

11001 Bren Road East

Minnetonka, MN 55343

877 912-3444 or 952 912-3444

www.digi.com

XBee®/XBee-PRO®ZB RF Modules

ZigBee RF Modules by Digi International

Models: XBEE S2C, PS2CSM, S2CTH, PS2CTH, Legacy PRO S2C

Hardware: S2C

Firmware: 401x, 402x, 403x, 404x, 405x

90002002_P

10/10/2014

XBee®/XBee‐PRO®ZBRFModules

©2014DigiInternationalInc. 2

Digi, Digi International, the Digi logo, XBee®and XBee-PRO®are trademarks or registered trademarks of Digi International

Inc. in the United Sates and other countries worldwide. ZigBee®is a registered trademark of the ZigBee alliance. All other

trademarks mentioned in this document are the property of their respective owners.

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.

This product could include technical inaccuracies or typographical errors. Changes are periodically made to the information

herein; these changes may be incorporated in new editions of the publication.

For basic information to help get you started on the XBee/XBee-PRO ZB RF Module, navigate to the Getting Started Guide at

digi.com/support. Enter the keyword 'XBee-PRO ZB' and select the Documentation tab. Under the Documentation tab, you

will find the XBee-PRO ZB RF Module Development Kit Getting Started Guide.

Technical Support: Phone: (866) 765-9885 toll-free U.S.A. & Canada

(801) 765-9885 Worldwide

8:00 am - 5:00 pm [U.S. Mountain Time]

Online Support: www.digi.com/support/eservice

Contents

XBee®/XBee‐PRO®ZBRFModules

©2014DigiInternationalInc. 3

Overview of the XBee ZigBee RF Module 7

Worldwide Acceptance 7

What’s New in 40xx Firmware 7

Specifications of the XBee ZigBee RF Module 8

Hardware Specifications 8

Agency Approvals 9

Serial Communications Specifications of the XBee

ZigBee RF Module 9

UART 9

SPI 9

GPIO Specifications 9

Hardware Specifications for Programmable Variant

Mechanical Drawings of the XBee ZigBee RF Modules

Pin Signals for the XBee ZigBee Surface Mount Mod-

ule 14

Pin Signals for the XBee ZigBee Through-hole Module

EM357 Pin Mappings 16

Design Notes for the XBee ZigBee RF Module 16

Power Supply Design 16

Recommended Pin Connections 16

Board Layout 17

Module Operation for Programmable Variant 21

XBee Programmable Bootloader 24

Overview 24

Bootloader Software Specifics 24

Bootloader Menu Commands 30

Firmware Updates 31

Output File Configuration 32

XBee ZigBee RF Module Operation 33

XBee ZigBee Serial Communications 33

UART Data Flow 33

XBee ZigBee SPI Communications 33

XBee ZigBee Serial Buffers 35

UART Flow Control 35

XBee ZigBee Break Control 36

Serial Interface Protocols 36

XBee ZigBee Modes of Operation 38

Idle Mode 38

Transmit Mode 38

Receive Mode 39

Command Mode 39

Sleep Mode 40

XBee ZigBee Networks 41

Introduction to ZigBee 41

ZigBee Stack Layers 41

ZigBee Networking Concepts 41

Device Types 41

PAN ID 43

Operating Channel 43

ZigBee Application Layers: In Depth 43

Application Support Sublayer (APS) 43

Application Profiles 43

ZigBee Coordinator Operation 45

Forming a Network 45

Channel Selection 45

PAN ID Selection 45

Security Policy 45

Persistent Data 45

XBee ZigBee Coordinator Startup 45

Permit Joining 46

Resetting the Coordinator 47

Leaving a Network 47

Replacing a Coordinator (Security Disabled Only) 47

Example: Starting a Coordinator 48

Example: Replacing a Coordinator (Security Disabled) 48

ZigBee Router Operation 48

Discovering ZigBee Networks 48

Joining a Network 49

Authentication 49

Persistent Data 49

XBee ZB Router Joining 49

Permit Joining 50

Joining Always Enabled 50

Joining Temporarily Enabled 50

Router Network Connectivity 50

Leaving a Network 52

Network Locator Option 52

Resetting the Router 53

Example: Joining a Network 53

End Device Operation 53

Discovering ZigBee Networks 53

Joining a Network 54

Parent Child Relationship 54

End Device Capacity 54

Authentication 54

Persistent Data 54

Contents

XBee®/XBee‐PRO®ZBRFModules

©2014DigiInternationalInc. 4

Orphan Scans 54

XBee ZigBee End Device Joining 55

Parent Connectivity 55

Resetting the End Device 56

Leaving a Network 56

Example: Joining a Network 56

ZigBee Channel Scanning 56

Managing Multiple ZigBee Networks 57

PAN ID Filtering 57

Pre-configured Security Keys 57

Permit Joining 57

Application Messaging 57

Transmission, Addressing, and Routing 58

Addressing 58

64-bit Device Addresses 58

16-bit Device Addresses 58

Application Layer Addressing 58

Data Transmission 58

Broadcast Transmissions 59

Unicast Transmissions 59

Binding Transmissions 61

Multicast Transmissions 61

Fragmentation 61

Data Transmission Examples 62

RF Packet Routing 64

Link Status Transmission 64

AODV Mesh Routing 65

Many-to-One Routing 67

High/Low Ram Concentrator Mode 68

Source Routing 68

Encrypted Transmissions 71

Maximum RF Payload Size 71

Throughput 72

Latency Timing Specifications 72

ZDO Transmissions 72

ZigBee Device Objects (ZDO) 72

Sending a ZDO Command 73

Receiving ZDO Commands and Responses 73

Transmission Timeouts 75

Unicast Timeout 75

Extended Timeout 75

Transmission Examples 76

XBee ZigBee Security 78

Security Modes 78

ZigBee Security Model 78

Network Layer Security 78

Frame Counter 79

Message Integrity Code 79

Network Layer Encryption and Decryption 79

Network Key Updates 79

APS Layer Security 79

Message integrity Code 80

APS Link Keys 80

APS Layer Encryption and Decryption 80

Network and APS Layer Encryption 80

Trust Center 81

Forming and Joining a Secure Network 81

Implementing Security on the XBee 81

Enabling Security 82

Setting the Network Security Key 82

Setting the APS Trust Center Link Key 82

Enabling APS Encryption 82

Using a Trust Center 82

XBee Security Examples 83

Example 1: Forming a network with security (pre-con-

figured link keys) 83

Example 2: Forming a network with security (obtain-

ing keys during joining) 83

Network Commissioning and Diagnostics 85

Device Configuration 85

Device Placement 85

Link Testing 85

RSSI Indicators 86

Device Discovery 86

Network Discovery 86

ZDO Discovery 86

Joining Announce 86

Commissioning Pushbutton and Associate LED 86

Commissioning Pushbutton 87

Associate LED 88

Binding 89

Group Table API 91

Managing End Devices 101

End Device Operation 101

Parent Operation 101

End Device Poll Timeouts 102

Packet Buffer Usage 102

Contents

XBee®/XBee‐PRO®ZBRFModules

©2014DigiInternationalInc. 5

Non-Parent Device Operation 102

XBee End Device Configuration 103

Pin Sleep 103

Cyclic Sleep 105

Transmitting RF Data 108

Receiving RF Data 108

I/O Sampling 109

Waking End Devices with the Commissioning Pushbut-

ton 109

Parent Verification 109

Rejoining 109

XBee Router/Coordinator Configuration 109

RF Packet Buffering Timeout 110

Child Poll Timeout 110

Transmission Timeout 110

Putting It All Together 111

Short Sleep Periods 111

Extended Sleep Periods 111

Sleep Examples 111

XBee Analog and Digital I/O Lines 113

XBee ZB Through Hole RF Module 113

I/O Configuration 114

I/O Sampling 115

Queried Sampling 116

Periodic I/O Sampling 116

Change Detection Sampling 116

RSSI PWM 117

I/O Examples 117

PWM1 117

XBee ZigBee API Operation 118

API Frame Specifications 118

API Examples 120

API Serial Port Exchanges 121

AT Commands 121

Transmitting and Receiving RF Data 121

Remote AT Commands 121

Source Routing 122

Supporting the API 122

API Frames 122

AT Command 122

AT Command - Queue Parameter Value 123

ZigBee Transmit Request 123

Explicit Addressing ZigBee Command Frame 125

Remote AT Command Request 127

Create Source Route 128

AT Command Response 129

Modem Status 129

ZigBee Transmit Status 130

ZigBee Receive Packet 131

ZigBee Explicit Rx Indicator 132

ZigBee IO Data Sample Rx Indicator 133

XBee Sensor Read Indicator 134

Node Identification Indicator 136

Remote Command Response 137

Extended Modem Status 137

Over-the-Air Firmware Update Status 140

Route Record Indicator 142

Many-to-One Route Request Indicator 143

Sending ZigBee Device Objects (ZDO) Commands

with the API 144

Sending ZigBee Cluster Library (ZCL) Commands

with the API 146

Sending Public Profile Commands with the API 148

XBee Command Reference Tables 151

XBee ZigBee Module Support 162

XCTU Configuration Tool 162

Customizing XBee ZB Firmware 162

Design Considerations for Digi Drop-In Networking

162

XBee Bootloader 162

Programming XBee Modules 163

Serial Firmware Updates 163

Invoke XBee Bootloader 163

Send Firmware Image 163

Writing Custom Firmware 163

Regulatory Compliance 163

Enabling GPIO 1 and 2 164

Detecting XBee vs. XBee-PRO 164

Special Instructions For Using the JTAG Interface 164

Appendix A: Agency Certifications 166

United States FCC 166

OEM Labeling Requirements 166

FCC Notices 166

FCC-Approved Antennas (2.4 GHz) 167

Europe (ETSI) 172

OEM Labeling Requirements 172

Restrictions 172

Declarations of Conformity 172

Contents

XBee®/XBee‐PRO®ZBRFModules

©2014DigiInternationalInc. 6

Antennas 173

Canada (IC) 173

Transmitters for Detachable Antennas 173

Detachable Antenna 173

Australia (RCM/C-Tick) 174

Appendix B:Migrating from XBee Through-hole to

XBee Surface Mount Modules 175

Appendix C:Manufacturing Information 178

Appendix D:Warranty Information 181

Appendix E:Definitions 182

©2014DigiInternationalInc. 7

1.OverviewoftheXBeeZigBeeRFModule

This manual describes the operation of the XBee/XBee-PRO ZB RF module, which consists of ZigBee firmware loaded

onto XBee S2C and PRO S2C hardware.

XBee®and XBee-PRO®ZB embedded RF modules provide wireless connectivity to end-point devices in ZigBee mesh

networks. Utilizing the ZigBee PRO Feature Set, these modules are inter-operable with other ZigBee devices, including

devices from other vendors. With the XBee, users can have their ZigBee network up-and-running in a matter of minutes

without configuration or additional development.

The XBee/XBee-PRO ZB modules are compatible with other devices that use XBee ZB technology. These include Connect-

PortX gateways, XBee and XBee-PRO Adapters, Wall Routers, XBee Sensors, and other products with the ZB name.

Worldwide Acceptance

• FCC Approval (USA): Refer to Appendix A for FCC Requirements. Systems that

contain XBee/XBee-PRO ZB RF Modules inherit Digi Certifications

• ISM (Industrial, Scientific & Medical) 2.4 GHz frequency band

• Manufactured under ISO 9001:2000 registered standards

• XBee/XBee-PRO ZB RF Modules are optimized for use in US, Canada, Australia, Europe (XBee

only) and Japan (XBee only). Contact Digi for a complete list of agency approvals

What’s New in 40xx Firmware

• An alternative serial port is available using SPI slave mode operation.

• Six software images (Coordinator AT, Coordinator API, Router AT, Router API, End Device AT,

and End Device API) are combined into a single software

• Fragmentation is now available in both API mode and transparent mode

• P3 (DOUT), P4 (DIN), D8 (SleepRq), and D9 (On-Sleep) are now available for I/O sampling

• Both pull-up and pull-down resistors can now be applied to pins configured for inputs

• 401D - ATVL command added for long version information

• 401E - ATDO command added for configuring device options

• 4020 - ATAS command added for Active Scan

• 4021 - Self addressed Tx Status messages return a status code of 0x23

• ATDO has HIGH_RAM_CONCENTRATOR and NO_ACK_IO_SAMPLING options added

• 4040 - Binding and Multicasting transmissions are supported

• AT&X command added to clear binding and group tables

• Added Tx options 0x04 (indirect addressing) and 0x08 (multicast addressing)

• A 5 second break will reset the XBee. Then it will boot with default baud settings into com-

mand mode

• BD range increased from 0-7 to 0-0x0A, and nonstandard baud rates are permitted, but not

guaranteed

• NI, DN, ND string parameters support upper and lower case

• TxOption 0x01 disables retries and route repair. RxOption 0x01 indicates the transmitter dis-

abled retries

• 4050 - FR returns 0x00 modem status code instead of 0x01

• S2C TH and S2C TH PRO supported

• DC10 - verbose joining mode option

• Self addressed fragmentable messages now return the self-addressed Tx Status code (0x23)

instead of simply success (0x00)

XBee®/XBee‐PRO®ZBRFModules

©2014DigiInternationalInc. 8

Specifications of the XBee ZigBee RF Module

Hardware Specifications

SpecificationsoftheXBee®/XBee‐PRO®ZBRFModule

Specification XBee ZB XBee-PRO ZB

Performance

Indoor/Urban Range Up to 200 ft. (60 m) Up to 300 ft. (90 m)

Outdoor RF line-of-sight Range Up to 4000 ft. (1200 m) Up to 2 miles (3200 m)

Transmit Power Output 

(maximum)

6.3mW (+8dBm), Boost mode

3.1mW (+5dBm), Normal mode

Channel 26 max power is +3dBm

63mW (+18 dBm)

RF Data Rate 250,000 bps

Receiver Sensitivity -102 dBm, Boost mode

-100 dBm, Normal mode -101 dBm

Power Requirements

Adjustable Power Yes

Supply Voltage 2.1 - 3.6 V

2.2 - 3.6 V for Programmable Version 2.7 - 3.6 V

Operating Current (Transmit) 45mA (+8 dBm, Boost mode)

33mA (+5 dBm, Normal mode) 120mA @ +3.3 V, +18 dBm

Operating Current (Receive) 31mA (Boost mode)

28mA (Normal mode) 31mA

Power-down Current < 1 µA @ 25°C

General

Operating Frequency Band ISM 2.4 - 2.5 GHz

Form Factor Through-Hole, Surface Mount

Dimensions Through-Hole: 0.960 x 1.087 in (2.438 x 2.761 cm)

SMT: 0.866 x 1.33 x 0.120 in (2.199 x 3.4 x 0.305 cm)

Through-Hole: 0.960 x 1.297 in (2.438 x 3.294 cm)

SMT: 0.866 x 1.33 x 0.120 in (2.199 x 3.4 x 0.305 cm)

Operating Temperature -40 to 85°C (industrial)

Antenna Options Through-Hole: PCB Antenna, U.FL Connector, RPSMA Connector, or Integrated Wire

SMT: RF Pad, PCB Antenna, or U.FL Connector

Networking & Security

Supported Network Topologies Point-to-point, Point-to-multipoint, Peer-to-peer, and Mesh

Number of Channels 16 Direct Sequence Channels 15 Direct Sequence Channels

Interface Immunity DSSS (Direct Sequence Spread Spectrum)

Channels 11 to 26 11 to 25

Addressing Options PAN ID and Addresses, Cluster IDs and Endpoints (optional)

Interface Options

UART 1 Mbps maximum (burst)

SPI 5 Mbps maximum (burst)

XBee®/XBee‐PRO®ZBRFModules

Agency Approvals

Serial Communications Specifications of the XBee ZigBee RF Module

XBee RF modules support both UART (Universal Asynchronous Receiver / Transmitter) and SPI (Serial

Peripheral Interface) serial connections.

UART

The SC1 (Serial Communication Port 1) of the Ember 357 is connected to the UART port.

More information on UART operation is found in the UART section in Chapter 2.

SPI

The SC2 (Serial Communication Port 2) of the Ember 357 is connected to the SPI port.

For more information on SPI operation, see the SPI section in Chapter 2.

GPIO Specifications

XBee RF modules have 15 GPIO (General Purpose Input / Output) ports available. The exact list will depend on

the module configuration, as some GPIO pads are used for purposes such as serial communication.

AgencyApprovals

Approval XBee (Surface Mount) XBee-PRO (Surface

Mount) XBee (Through-hole) XBee-PRO (Through-hole)

United States (FCC

Part 15.247) FCC ID: MCQ-XBS2C FCC ID: MCQ-PS2CSM FCC ID: MCQ-S2CTH FCC ID: MCQ-PS2CTH

Industry Canada (IC) IC: 1846A-XBS2C IC: 1846A-PS2CSM IC: 1846A-S2CTH IC: 1846A-PS2CTH

FCC/IC Test Transmit

Power Output range -26 to +8 dBm -0.7 to +19.4 dBm -26 to +8 dBm +1 to +19 dBm

Europe (CE) ETSI ETSI

Australia C-Tick RCM RCM RCM

Japan R201WW10215369 Pending

RoHS Compliant

UARTPinAssignments

Specifications Module Pin Number

UART Pins XBee (Surface Mount) XBee (Through-hole)

DOUT 3 2

DIN / CONFIG 43

CTS / DIO7 25 12

RTS / DIO6 29 16

SPIPinAssignments

Specifications Module Pin Number

SPI Pins XBee (Surface Mount) XBee (Through-hole)

SPI_SCLK 14 18

SPI_SSEL 15 17

SPI_MOSI 16 11

SPI_MISO 17 4

XBee®/XBee‐PRO®ZBRFModules

See GPIO section for more information on configuring and using GPIO ports.

Hardware Specifications for Programmable Variant

If the module has the programmable secondary processor, add the following table values to the specifications

listed on page 8. For example, if the secondary processor is running at 20 MHz and the primary processor is in

receive mode then the new current value will be Itotal = Ir2 + Irx = 14 mA + 9 mA = 23 mA, where Ir2 is the

runtime current of the secondary processor and Irx is the receive current of the primary.

ElectricalSpecificationsforGPIOLines

GPIO Electrical Specification Value

Voltage - Supply 2.1 - 3.6 V

Low Schmitt switching threshold 0.42 - 0.5 x VCC

High Schmitt switching threshold 0.62 - 0.8 x VCC

Input current for logic 0 -0.5 A

Input current for logic 1 0.5 A

Input pull-up resistor value 29 k

Input pull-down resistor value 29 k

Output voltage for logic 0 0.18 x VCC (maximum)

Output voltage for logic 1 0.82 x VCC (minimum)

Output source/sink current for pad numbers 3, 4, 5, 10, 12, 14, 15, 16, 17,

25, 26, 28, 29, 30, and 32 on the SMT modules 4 mA

Output source/sink current for pin numbers 2, 3, 4, 9, 12, 13, 15, 16, 17,

and 19 on the TH modules 4 mA

Output source/sink current for pad numbers 7, 8, 24, 31, and 33 on the

SMT modules 8 mA

Output source/sink current for pin numbers 6, 7, 11, 18, and 20 on the TH

modules 8 mA

Total output current (for GPIO pads) 40 mA

Specificationsoftheprogrammablesecondaryprocessor

Optional Secondary Processor Specification

These numbers add to specifications

(Add to RX, TX, and sleep currents depending on

mode of operation)

Runtime current for 32k running at 20MHz +14mA

Runtime current for 32k running at 1MHz +1mA

Sleep current +0.5A typical

For additional specifications see Freescale Datasheet and

Manual MC9SO8QE32

Minimum Reset low pulse time for EM357 +26S

VREF Range 1.8VDC to VCC

This manual suits for next models

Table of contents

Other Digi Control Unit manuals

Popular Control Unit manuals by other brands

Festo

Festo Compact Performance CP-FB6-E Brief description

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Quick installation guide

JS Automation

JS Automation MPC3034A user manual

JAUDT

JAUDT SW GII 6406 Series Translation of the original operating instructions

Spektrum

Spektrum Air Module System manual

BOC Edwards

BOC Edwards Q Series instruction manual

KHADAS

KHADAS BT Magic quick start

Etherma

Etherma eNEXHO-IL Assembly and operating instructions

PMFoundations

PMFoundations Attenuverter Assembly guide

GEA

GEA VARIVENT Operating instruction

Walther Systemtechnik

Walther Systemtechnik VMS-05 Assembly instructions

Altronix

Altronix LINQ8PD Installation and programming manual

Eaton

Eaton Powerware Series user guide

WAGO

WAGO 750-407/040-000 manual

Sony

Sony CCU-590 Operation manual

Graco

Graco 25D614 instructions

Task Force Tips

Task Force Tips YE-RF-900 Instructions for installation, safe operation and maintenance

Shini

Shini SPV-U Series manual