Digi XBEE-PRO S3 Manual de usuario

XBee®-PRO 900HP/XSC RF Modules

S3 and S3B

User Guide

Revision history—90002173

Revision Date Description

S October

2016

Replaced the Programmable bootloader section with the Programmable XBee

SDK section. Updated the indoor range spec. Corrected the SPand ST

parameter default values.

T May

2018

Added note on range estimation. Changed ICto ISED.

U July

2018

Added the 0x00, 0x80 and 0x89 frames for the 900HP.

V June

2019

Added FCC publication 996369 related information.

W January

2020

Added IFETEL certifications.

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

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)

XBee®-PRO 900HP/XSC RF Modules 2

Logs (from time of reported issue)

Trace (if possible)

Description of issue

Steps to reproduce

Contact Digi technical support: Digi offers multiple technical support plans and service packages.

Feedback

To provide feedback on this document, email your comments to

techcomm@digi.com

Include the document title and part number (XBee®-PRO 900HP/XSC RF Modules, 90002173 W) in the

subject line of your email.

XBee®-PRO 900HP/XSC RF Modules 3

Contents

About the XBee-PRO 900HP RF Module

User guide structure 13

Technical specifications

Performance specifications 16

Power requirements 16

General specifications 17

Networking specifications 17

Regulatory conformity summary 17

Serial communication specifications 18

UART pin assignments 18

SPI pin assignments 18

GPIO specifications 18

Secondary processor specifications 19

Hardware

Mechanical drawings 22

Pin signals 23

Design notes 25

Power supply design 25

Board layout 25

Antenna performance 25

Recommended pin connections 26

Module operation for the programmable variant 27

Programmable XBee SDK 29

Configure the XBee-PRO 900HP RF Module

Software libraries 31

Configure the device using XCTU 31

Over-the-air firmware updates 31

Distribute the new application 31

Verify the new application 32

Install the application 32

XBee Multi Programmer 33

XBee®-PRO 900HP/XSC RF Modules 4

XBee®-PRO 900HP/XSC RF Modules 5

Operation

Basic operational design 35

Serial interface 35

UART data flow 35

Serial data 36

Configuration considerations 36

Select the serial port 36

Force UART operation 37

Select the SPI port 37

Serial port selection 38

Serial receive buffer 38

Serial transmit buffer 38

UART flow control 38

CTS flow control 38

RTS flow control 38

SPI operation

SPI communications 41

SPI implementation 41

SPI signals 42

Full duplex operation 42

Low power operation 43

SPI and API mode 43

SPI parameters 44

Modes

Serial modes 46

Transparent operating mode 46

API operating mode 46

Comparing Transparent and API modes 46

Modes of operation 48

Idle mode 48

Transmit mode 48

Receive mode 48

Command mode 48

Sleep mode 51

Sleep modes

About sleep modes 53

Asynchronous modes 53

Synchronous modes 53

Normal mode 53

Asynchronous pin sleep mode 54

Asynchronous cyclic sleep mode 54

Asynchronous cyclic sleep with pin wake up mode 54

Synchronous sleep support mode 54

Synchronous cyclic sleep mode 55

The sleep timer 55

Indirect messaging and polling 55

XBee®-PRO 900HP/XSC RF Modules 6

Indirect messaging 55

Polling 56

Sleeping routers 56

Sleep coordinator sleep modes in the DigiMesh network 56

Synchronization messages 57

Become a sleep coordinator 59

Select sleep parameters 61

Start a sleeping synchronous network 61

Add a new node to an existing network 62

Change sleep parameters 63

Rejoin nodes that lose sync 63

Diagnostics 64

Query sleep cycle 64

Sleep status 64

Missed sync messages command 65

Sleep status API messages 65

Networking methods

The MAC and PHY layers 67

64-bit addresses 67

Make a unicast transmission 68

Make a broadcast transmission 68

Delivery methods 68

Point to Point / Point to Multipoint (P2MP) 68

Repeater/directed broadcast 69

DigiMesh networking 70

AT commands

Special commands 76

AC (Apply Changes) 76

FR (Force Reset) 76

RE (Restore Defaults) 76

WR (Write) 76

MAC/PHY commands 77

AF (Available Frequencies) 77

CM (Channel Mask) 77

MF (Minimum Frequency Count) 78

HP (Preamble ID) 78

ID (Network ID) 79

MT(Broadcast Multi-Transmits) 79

PL (TX Power Level) 79

RR (Unicast Mac Retries) 80

ED (Energy Detect) 80

Diagnostic commands 80

BC (Bytes Transmitted) 80

DB (Last Packet RSSI) 80

ER (Received Error Count) 81

GD (Good Packets Received) 81

EA (MAC ACK Failure Count) 81

TR (Transmission Failure Count) 82

UA (MAC Unicast Transmission Count) 82

%H (MAC Unicast One Hop Time) 82

XBee®-PRO 900HP/XSC RF Modules 7

%8 (MAC Broadcast One Hop Time) 82

Network commands 83

CE (Node Messaging Options) 83

BH (Broadcast Hops) 83

NH (Network Hops) 83

NN (Network Delay Slots) 84

MR (Mesh Unicast Retries) 84

RN (Delay Slots) 84

Addressing commands 85

SH (Serial Number High) 85

SL (Serial Number Low) 85

DH (Destination Address High) 85

DL (Destination Address Low) 85

TO (Transmit Options) 86

NI (Node Identifier) 86

NT (Node Discover Time) 87

NO (Node Discovery Options) 87

CI (Cluster ID) 88

DE (Destination Endpoint) 88

SE (Source Endpoint) 88

Addressing discovery/configuration commands 88

AG (Aggregator Support) 88

DN (Discover Node) 89

ND (Network Discover) 89

FN (Find Neighbors) 90

Security commands 91

EE (Security Enable) 91

KY (AES Encryption Key) 91

Serial interfacing commands 91

BD (Baud Rate) 91

NB (Parity) 92

SB (Stop Bits) 92

RO (Packetization Timeout) 93

FT (Flow Control Threshold) 93

AP (API Mode) 93

AO (API Options) 94

I/O settings commands 94

CB (Commissioning Pushbutton) 94

D0 (DIO0/AD0) 94

D1 (DIO1/AD1) 95

D2 (DIO2/AD2) 95

D3 (DIO3/AD3) 96

D4 (DIO4) 96

D5 (DIO5/ASSOCIATED_INDICATOR) 97

D6 (DIO6/RTS) 97

D7 (DIO7/CTS) 98

D8 (DIO8/SLEEP_REQUEST) 98

D9 (DIO9/ON_SLEEP) 99

P0 (DIO10/RSSI/PWM0 Configuration) 99

P1 (DIO11/PWM1 Configuration) 100

P2 (DIO12 Configuration) 100

P3 (DIO13/DOUT) 101

P4 (DIO14/DIN) 101

PD (Pull Up/Down Direction) 101

PR (Pull-up/Down Resistor Enable) 102

XBee®-PRO 900HP/XSC RF Modules 8

M0 (PWM0 Duty Cycle) 102

M1 (PWM1 Duty Cycle) 103

LT (Associate LED Blink Time) 103

RP (RSSI PWM Timer) 103

I/O sampling commands 103

AV (Analog Voltage Reference) 103

IC (DIO Change Detection) 104

IF (Sleep Sample Rate) 105

IR (I/O Sample Rate) 105

IS (Force Sample) 105

TP (Board Temperature) 106

%V (Voltage Supply Monitoring) 106

Sleep commands 106

SM (Sleep Mode) 106

SO (Sleep Options) 107

SN (Number of Sleep Periods) 107

SP (Sleep Period) 108

ST (Wake Time) 108

WH (Wake Host Delay) 108

Diagnostic - sleep status/timing commands 108

SS (Sleep Status) 109

OS (Operating Sleep Time) 109

OW (Operating Wake Time) 109

MS (Missed Sync Messages) 110

SQ (Missed Sleep Sync Count) 110

Command mode options 110

CC (Command Character) 110

CN (Exit Command Mode) 110

CT (Command Mode Timeout) 111

GT (Guard Times) 111

Firmware commands 111

VL (Version Long) 111

VR (Firmware Version) 111

HV (Hardware Version) 112

HS (Hardware Series) 112

DD (Device Type Identifier) 112

NP (Maximum Packet Payload Bytes) 112

CK (Configuration CRC) 113

Operate in API mode

API mode overview 115

API frame format 115

API operation (AP parameter = 1) 115

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

Data bytes that need to be escaped: 116

Length 116

Frame data 116

API serial exchanges 117

AT commands 117

Transmit and Receive RF data 118

Remote AT commands 118

Device Registration 119

Calculate and verify checksums 119

Example 119

XBee®-PRO 900HP/XSC RF Modules 9

Frame descriptions

Legacy TX Request frame - 0x00 121

AT Command frame - 0x08 122

AT Command - Queue Parameter Value frame - 0x09 124

Transmit Request frame - 0x10 126

Explicit Addressing Command frame - 0x11 129

Remote AT Command Request frame - 0x17 132

Legacy RX Indicator frame - 0x80 134

AT Command Response frame - 0x88 136

TX Status frame - 0x89 138

Modem Status frame - 0x8A 139

Transmit Status frame - 0x8B 140

Route Information Packet frame - 0x8D 142

Aggregate Addressing Update frame - 0x8E 145

Receive Packet frame - 0x90 147

Explicit Rx Indicator frame - 0x91 149

I/O Data Sample Rx Indicator frame - 0x92 152

Node Identification Indicator frame - 0x95 154

Remote Command Response frame - 0x97 157

Advanced application features

Remote configuration commands 160

Send a remote command 160

Apply changes on remote devices 160

Remote command responses 160

Network commissioning and diagnostics 160

Configure devices 160

Network link establishment and maintenance 161

Place devices 162

Device discovery 162

Link reliability 163

Commissioning pushbutton and associate LED 165

I/O line monitoring 168

I/O samples 168

Queried sampling 168

Periodic I/O sampling 171

Detect digital I/O changes 171

General Purpose Flash Memory

General Purpose Flash Memory 173

Access General Purpose Flash Memory 173

General Purpose Flash Memory commands 174

PLATFORM_INFO_REQUEST (0x00) 174

PLATFORM_INFO (0x80) 174

ERASE (0x01) 175

ERASE_RESPONSE (0x81) 175

WRITE (0x02) and ERASE_THEN_WRITE (0x03) 176

WRITE _RESPONSE (0x82) and ERASE_THEN_WRITE_RESPONSE (0x83) 177

READ (0x04) 177

READ_RESPONSE (0x84) 178

FIRMWARE_VERIFY (0x05) and FIRMWARE_VERIFY_AND_INSTALL(0x06) 178

XBee®-PRO 900HP/XSC RF Modules 10

FIRMWARE_VERIFY_RESPONSE (0x85) 179

FIRMWARE_VERIFY _AND_INSTALL_RESPONSE (0x86) 179

Work with flash memory 180

XSC firmware

XBee-PRO XSC RF Module overview 182

Pin signals 182

Electrical characteristics 183

Timing specifications 184

XBee-PRO XSC specifications

Performance specifications 188

Power requirements 188

Networking specifications 189

General specifications 189

Antenna options 189

Regulatory conformity summary 190

XBee-PRO XSC RF Module operation

Serial communications 192

UART-interfaced data flow 192

Serial data 192

Flow control 192

Data In (DIN) buffer and flow control 193

Data Out (DO) buffer and flow control 194

Operating modes 194

Idle mode 194

Transmit mode 195

Receive mode 195

Sleep mode 195

Command mode 198

Configuration and commands

Programming examples 203

Connect the device to a PC 203

Send binary commands 203

Example 203

Special commands 204

FR (Force Reset) 204

PL (TX Power Level) 204

Command mode options 204

AT (Guard Time After) 205

BT (Guard Time Before) 205

CC (Command Sequence Character) 205

CD (DO3 Configuration) 206

CN (Exit Command Mode) 206

CT (Command Mode Timeout) 207

E0 (Echo Off) 207

E1 (Echo On) 207

Este manual sirve para los siguientes modelos

Tabla de contenidos

Otros manuales de Unidad de control de Digi

Digi

Digi ConnectCore 6 Manual de usuario

Digi

Digi XBee-PRO XSC Manual de usuario

Digi

Digi RabbitCore RCM2100 Series Manual de usuario

Digi

Digi ConnectCore 9P 9215 Guía de aplicación

Digi

Digi XBee Manual de usuario

Digi

Digi XTend vB DigiMesh Manual de usuario

Digi

Digi XLR PRO Manual de usuario

Digi

Digi XBee Manual de usuario

Digi

Digi XBee DigiMesh 2.4 Manual de usuario

Digi

Digi Connect ME 9210 Manual de usuario

Digi

Digi XBee ZNet 2.5 Manual de usuario

Digi

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

Digi

Digi XBee SX 868 Manual de usuario

Digi

Digi XBee Wi-Fi Cloud Kit Manual de usuario

Digi

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

Digi

Digi ConnectCore XP 270 Guía de aplicación

Digi

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

Digi

Digi PS2CSM Manual de usuario

Digi

Digi XBee Manual de usuario

Digi

Digi Connect ME Guía de aplicación

Digi

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

Digi

Digi XLR PRO Manual de usuario

Digi

Digi MiniCore RCM5700 Series Manual de usuario

Digi

Digi XBEE PRO S2C Manual de usuario

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