Digi XBee-PRO S3 User Manual

Digi XBee-PRO S3 User Manual

900hp/xsc rf modules
Hide thumbs Also See for XBee-PRO S3:
Table of Contents

Advertisement

XBee®-PRO 900HP/XSC RF Modules
S3 and S3B
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee-PRO S3 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Digi XBee-PRO S3

  • Page 1 XBee®-PRO 900HP/XSC RF Modules S3 and S3B User Guide...
  • Page 2 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.
  • Page 3    Trace (if possible)    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 techcomm@digi.com...
  • Page 4: Table Of Contents

    Contents About the XBee-PRO 900HP RF Module User guide structure Technical specifications Performance specifications Power requirements General specifications Networking specifications Regulatory conformity summary Serial communication specifications UART pin assignments SPI pin assignments GPIO specifications Secondary processor specifications Hardware Mechanical drawings Pin signals Design notes Power supply design...
  • Page 5 Operation Basic operational design Serial interface UART data flow Serial data Configuration considerations Select the serial port Force UART operation Select the SPI port Serial port selection Serial receive buffer Serial transmit buffer UART flow control CTS flow control RTS flow control SPI operation SPI communications SPI implementation...
  • Page 6 Indirect messaging Polling Sleeping routers Sleep coordinator sleep modes in the DigiMesh network Synchronization messages Become a sleep coordinator Select sleep parameters Start a sleeping synchronous network Add a new node to an existing network Change sleep parameters Rejoin nodes that lose sync Diagnostics Query sleep cycle Sleep status...
  • Page 7 %8 (MAC Broadcast One Hop Time) Network commands CE (Node Messaging Options) BH (Broadcast Hops) NH (Network Hops) NN (Network Delay Slots) MR (Mesh Unicast Retries) RN (Delay Slots) Addressing commands SH (Serial Number High) SL (Serial Number Low) DH (Destination Address High) DL (Destination Address Low) TO (Transmit Options) NI (Node Identifier)
  • Page 8 M0 (PWM0 Duty Cycle) M1 (PWM1 Duty Cycle) LT (Associate LED Blink Time) RP (RSSI PWM Timer) I/O sampling commands AV (Analog Voltage Reference) IC (DIO Change Detection) IF (Sleep Sample Rate) IR (I/O Sample Rate) IS (Force Sample) TP (Board Temperature) %V (Voltage Supply Monitoring) Sleep commands SM (Sleep Mode)
  • Page 9 Frame descriptions Legacy TX Request frame - 0x00 AT Command frame - 0x08 AT Command - Queue Parameter Value frame - 0x09 Transmit Request frame - 0x10 Explicit Addressing Command frame - 0x11 Remote AT Command Request frame - 0x17 Legacy RX Indicator frame - 0x80 AT Command Response frame - 0x88 TX Status frame - 0x89...
  • Page 10 FIRMWARE_VERIFY_RESPONSE (0x85) FIRMWARE_VERIFY _AND_INSTALL_RESPONSE (0x86) Work with flash memory XSC firmware XBee-PRO XSC RF Module overview Pin signals Electrical characteristics Timing specifications XBee-PRO XSC specifications Performance specifications Power requirements Networking specifications General specifications Antenna options Regulatory conformity summary XBee-PRO XSC RF Module operation Serial communications UART-interfaced data flow Serial data...
  • Page 11 PC (Power-up to Transparent operating mode) Networking and security commands AM (Auto-set MY) MD (RF Mode) MY (Source Address) Network commands DT (Destination Address) HP (Preamble ID) HT (Time before Wake-up Initializer) ID (Network ID) MK (Address Mask) RN (Delay Slots) RR (Unicast Mac Retries) SY (Time Before Initialization) TT (Streaming Limit)
  • Page 12 Acknowledged mode S3B hardware certifications Agency certifications - United States United States (FCC) OEM labeling requirements XBee-PRO 900HP and XBee-PRO XSC FCC notices Limited modular approval Fixed base station and mobile applications Portable applications and SAR testing RF exposure statement FCC-approved antennas (900 MHz) Antennas approved for use with the XBee-PRO 900HP RF Module FCC publication 996369 related information...
  • Page 13: About The Xbee-Pro 900Hp Rf Module

    The XBee-PRO 900HP RF Module is not backward compatible with the legacy XBee-PRO 900 (Part Number: XBP09-DP…) or XBee-PRO DigiMesh 900 (Part Number: XBP09-DM…) RF Modules. The following table describes how to use this user guide based on the Digi part number for the module:...
  • Page 14 About the XBee-PRO 900HP RF Module User guide structure Pre- Digi Part Hardware installed Firmware Regulatory Numbers FCC ID Platform Firmware Available Information XBP09-XC… MCQ- Legacy S3B hardware XBEEXSC certifications XBP9B-XC*T-001 (revision G MCQ- Legacy S3B hardware and earlier) XBPS3B...
  • Page 15 Technical specifications Performance specifications Power requirements General specifications Networking specifications Regulatory conformity summary Serial communication specifications GPIO specifications Secondary processor specifications XBee®-PRO 900HP/XSC RF Modules...
  • Page 16: Technical Specifications

    Technical specifications Performance specifications Performance specifications This table describes the performance specifications for the devices. Note Range figure estimates are based on free-air terrain with limited sources of interference. Actual range will vary based on transmitting power, orientation of transmitter and receiver, height of transmitting antenna, height of receiving antenna, weather conditions, interference sources in the area, and terrain between receiver and transmitter, including indoor and outdoor structures such as walls, trees, buildings, hills, and mountains.
  • Page 17: General Specifications

    Technical specifications General specifications General specifications The following table describes the general specifications for the devices. Specification Value Operating frequency band 902 to 928 MHz (software selectable channels) Dimensions 3.29 cm x 2.44 cm x 0.546 cm (1.297" x 0.962" x 0.215) Dimensions do not include connector/antenna or pin lengths Weight 5 to 8 grams, depending on the antenna option...
  • Page 18: Serial Communication Specifications

    Technical specifications Serial communication specifications Country Approval Australia Brazil ANATEL 3727-12-1209 Singapore License No. DA105737 (XB900HP only) Mexico IFETEL (XB900HP listed in Mexico IFETEL) RoHS2 Compliant Serial communication specifications The XBee-PRO 900HP RF Module supports both Universal Asynchronous Receiver / Transmitter (UART) and Serial Peripheral Interface (SPI) serial connections.
  • Page 19: Secondary Processor Specifications

    Technical specifications Secondary processor specifications GPIO electrical specification Value Voltage - supply 2.1 - 3.6 V (3.0 V or higher required for optimal performance) Low Schmitt switching threshold 0.3 x V High Schmitt switching threshold 0.7 x V Input pull-up resistor value 40 kΩ...
  • Page 20 Technical specifications Secondary processor specifications Add these numbers to power requirement specifications (add to RX, TX, and sleep currents Optional secondary processor specification depending on mode of operation) Minimum reset pulse for programmable variant 100 nS Minimum reset pulse to radio 50 nS Voltage reference (VREF) range 1.8 VDC to VCC...
  • Page 21: Hardware

    Hardware Mechanical drawings Pin signals Design notes XBee®-PRO 900HP/XSC RF Modules...
  • Page 22: Mechanical Drawings

    Hardware Mechanical drawings Mechanical drawings The following figures show the mechanical drawings for the XBee-PRO 900HP RF Module. The drawings do not show antenna options. XBee®-PRO 900HP/XSC RF Modules...
  • Page 23: Pin Signals

    Hardware Pin signals Pin signals The following table shows the pin signals and their descriptions. The table specifies signal direction with respect to the device. For more information on pin connections, see Design notes. Default Pin # Name Direction state Description Power supply XBee®-PRO 900HP/XSC RF Modules...
  • Page 24 Hardware Pin signals Default Pin # Name Direction state Description DOUT/DIO13 Both Output GPIO/UART data out DIN/CONFIG Both Input GPIO/UART data in /DIO14 DIO12/SPI_ Both Output GPIO/SPI slave out MISO RESET Input Device reset. Drive low to reset the device. This is also an output with an open drain configuration with an internal 20 kΩ...
  • Page 25: Design Notes

    Hardware Design notes Design notes The XBee modules do not require any external circuitry or specific connections for proper operation. However, there are some general design guidelines that we recommend to build and troubleshoot a robust design. Power supply design A poor power supply can lead to poor radio performance, especially if you do not keep the supply voltage within tolerance or if the noise is excessive.
  • Page 26: Recommended Pin Connections

    Hardware Design notes Microwave ovens Batteries Tall electrolytic capacitors Use the following additional guidelines for optimal antenna performance: Do not place XBee modules with the chip antenna inside a metal enclosure. Do not place any ground planes or metal objects above or below the antenna. For the best results, mount the device at the edge of the host PCB.
  • Page 27: Module Operation For The Programmable Variant

    For the secondary processor to sample with ADCs, the XBee 14 (VREF) must be connected to a reference voltage. Digi provides a bootloader that can take care of programming the processor over-the-air or through the serial interface. This means that over-the-air...
  • Page 29: Programmable Xbee Sdk

    Programmable XBee SDK: http://ftp1.digi.com/support/sampleapplications/40003003_D.exe If these revisions change, search for the part number on Digi’s website. For example, search for 40003003. Install the IDE first, and then install the SDK. The documentation for the Programmable XBee SDK is built into the SDK, so the Getting Started guide appears when you open CodeWarrior.
  • Page 30: Configure The Xbee-Pro 900Hp Rf Module

    Configure the XBee-PRO 900HP RF Module Software libraries Configure the device using XCTU Over-the-air firmware updates XBee Multi Programmer XBee®-PRO 900HP/XSC RF Modules...
  • Page 31: Software Libraries

    XBee Configuration and Test Utility (XCTU) is a multi-platform program that enables users to interact with Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices.
  • Page 32: Verify The New Application

    Configure the XBee-PRO 900HP RF Module Over-the-air firmware updates file should be stored in order in the appropriate GPM memory blocks. The number of bytes that are sent in an individual GPM WRITE frame is flexible and can be catered to the user application. Example The example firmware version has an .ebin file of 55,141 bytes in length.
  • Page 33: Xbee Multi Programmer

    Each XBee Multi Programmer board allows you to program up to six devices simultaneously. Connect more boards to increase the programming concurrency. Different board variants cover all the XBee form factors to program almost any Digi RF device. Download the XBee Multi Programmer application from: digi.com/support/productdetail?pid=5641...
  • Page 34 Operation Basic operational design Serial interface UART data flow Configuration considerations Serial port selection UART flow control XBee®-PRO 900HP/XSC RF Modules...
  • Page 35: Operation

    Operation Basic operational design Basic operational design The XBee-PRO 900HP RF ModuleRF Module uses a multi-layered firmware base to order the flow of data, dependent on the hardware and software configuration that you choose. The following graphic shows a configuration block diagram, with the host serial interface as the physical starting point and the antenna as the physical endpoint for the transferred data.
  • Page 36: Serial Data

    Operation Configuration considerations Serial data A device sends data to the XBee-PRO 900HP RF Module's UART through pin 3 DIN as an asynchronous serial signal. When the device is not transmitting data, the signals should idle high. For serial communication to occur, you must configure the UART of both devices (the microcontroller and the XBee-PRO 900HP RF Module) with compatible settings for the baud rate, parity, start bits, stop bits, and data bits.
  • Page 37: Force Uart Operation

    Operation Configuration considerations If both interfaces are configured, serial data goes out the UART until the SPI_SSEL signal is asserted. After that, all serial communications operate on the SPI interface. If you enable only the UART, then the device only uses the UART and ignores SPI_SSEL. If you only enable the SPI, then the device uses only the SPI.
  • Page 38: Serial Port Selection

    Operation Serial port selection Serial port selection To enable the UART port, configure DIN and DOUT (P3 and P4 parameters) as peripherals. To enable the SPI port, enable SPI_MISO, SPI_MOSI, SPI_SSEL , and SPI_CLK (P5 through P9) as peripherals. If you enable both ports then output goes to the UART until the first input on SPI.
  • Page 39 Operation UART flow control the serial transmit buffer does not have enough space for all of the data bytes, it discards the entire RF data packet. The UART Data Present Indicator is a useful feature when using RTS flow control. When enabled, the DIO1 line asserts (low asserted) when UART data is queued to be transmitted from the module.
  • Page 40: Spi Operation

    SPI operation SPI communications SPI implementation SPI signals Full duplex operation Low power operation SPI and API mode SPI parameters XBee®-PRO 900HP/XSC RF Modules...
  • Page 41: Spi Communications

    SPI operation SPI communications SPI communications The XBee-PRO 900HP RF Module supports SPI communications in slave mode. Slave mode receives the clock signal and data from the master and returns data to the master. The following table shows the signals that the SPI port uses on the device. Signal Function SPI_MOSI...
  • Page 42: Spi Signals

    SPI operation SPI signals The device transmits and receives data with the most significant bit first using SPI mode 0. This means the CPOL and CPHA are both 0. We chose Mode 0 because it is the typical default for most microcontrollers and simplifies configuring the master.
  • Page 43: Low Power Operation

    By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.
  • Page 44: Spi Parameters

    SPI operation SPI parameters SPI parameters Most host processors with SPI hardware allow you to set the bit order, clock phase and polarity. For communication with all XBee-PRO 900HP RF Modules, the host processor must set these options as follows: Bit order: send MSB first Clock phase (CPHA): sample data on first (leading) edge Clock polarity (CPOL): first (leading) edge rises...
  • Page 45: Modes

    Modes Serial modes Modes of operation XBee®-PRO 900HP/XSC RF Modules...
  • Page 46: Serial Modes

    Modes Serial modes Serial modes The firmware operates in several different modes. Two top-level modes establish how the device communicates with other devices through its serial interface: Transparent operating mode and API operating mode. Use the AP command to choose Serial mode. XBee-PRO 900HP RF Modules use Transparent operation as the default serial mode.
  • Page 47 Modes Serial modes Feature Description Transparent mode features Simple interface All received serial data is transmitted unless the device is in Command mode Easy to support It is easier for an application to support Transparent operation and Command mode API mode features Transmitting RF data to multiple remote devices only requires the Easy to manage data application to change the address in the API frame.
  • Page 48: Modes Of Operation

    Modes Modes of operation Modes of operation Idle mode When not receiving or transmitting data, the device is in Idle mode. During Idle mode, the device listens for valid data on both the RF and serial ports. The device shifts into the other modes of operation under the following conditions: Transmit mode (serial data in the serial receive buffer is ready to be packetized).
  • Page 49 Modes Modes of operation commands. When you want to read or set any parameter of the XBee-PRO 900HP RF Module using this mode, you have to send an AT command. Every AT command starts with the letters AT followed by the two characters that identify the command and then by some optional configuration values. The operating modes of the XBee-PRO 900HP RF Module are controlled by the AP (API Mode) setting,...
  • Page 50 Modes Modes of operation The preceding example changes NI (Node Identifier) to My XBee. Multiple AT commands You can send multiple AT commands at a time when they are separated by a comma in Command mode; for example, ATNIMy XBee,AC<cr>. The preceding example changes the NI (Node Identifier) to My XBee and makes the setting active through AC (Apply Changes).
  • Page 51: Sleep Mode

    Modes Modes of operation Exit Command mode 1. Send CN (Exit Command Mode) followed by a carriage return. 2. If the device does not receive any valid AT commands within the time specified by CT (Command Mode Timeout), it returns to Transparent or API mode. The default Command mode timeout is 10 seconds.
  • Page 52 Sleep modes About sleep modes Normal mode Asynchronous pin sleep mode Asynchronous cyclic sleep mode Asynchronous cyclic sleep with pin wake up mode Synchronous sleep support mode Synchronous cyclic sleep mode The sleep timer Indirect messaging and polling Sleeping routers Diagnostics XBee®-PRO 900HP/XSC RF Modules...
  • Page 53: Sleep Modes

    Sleep modes About sleep modes About sleep modes A number of low-power modes exist to enable devices to operate for extended periods of time on battery power. Use the SM command to enable these sleep modes. The sleep modes are characterized as either: Asynchronous (SM = 1, 4, 5).
  • Page 54: Asynchronous Pin Sleep Mode

    Sleep modes Asynchronous pin sleep mode When synchronized, a device in Normal mode relays sync messages that sleep-compatible nodes generate, but does not generate sync messages itself. Once a device in Normal mode synchronizes with a sleeping network, you can put it into a sleep- compatible sleep mode at any time.
  • Page 55: Synchronous Cyclic Sleep Mode

    Sleep modes Synchronous cyclic sleep mode When you use them as preferred sleep coordinator nodes. As aids in adding new nodes to a sleeping network. Note Because sleep support nodes do not sleep, they should be mains powered. Synchronous cyclic sleep mode Set SM to 8 to enter synchronous cyclic sleep mode.
  • Page 56: Polling

    Sleep modes Sleeping routers poller for more than 2.5 times its SP value, then the packet is purged. We suggest setting the SP of the coordinator to the same value as the highest SP time that exists among the pollers in the network.
  • Page 57: Synchronization Messages

    Sleep modes Sleeping routers Synchronization messages A sleep coordinator regularly sends sync messages to keep the network in sync. Unsynchronized nodes also send messages requesting sync information. Sleep compatible nodes use Deployment mode when they first power up and the sync message has not been relayed.
  • Page 58 Sleep modes Sleeping routers XBee®-PRO 900HP/XSC RF Modules...
  • Page 59: Become A Sleep Coordinator

    Sleep modes Sleeping routers Become a sleep coordinator In DigiMesh networks, a device can become a sleep coordinator in one of four ways: Define a preferred sleep coordinator A potential sleep coordinator misses three or more sync messages Press the Commissioning Pushbutton twice on a potential sleep coordinator Change the sleep timing values on a potential sleep coordinator Preferred sleep coordinator option You can specify that a node always act as a sleep coordinator.
  • Page 60 Sleep modes Sleeping routers 1. Newer sleep parameters: the network considers a node using newer sleep parameters (SP and ST) as higher priority to a node using older sleep parameters. See Change sleep parameters. 2. Preferred sleep coordinator: a node acting as a preferred sleep coordinator is higher priority to other nodes.
  • Page 61: Select Sleep Parameters

    Sleep modes Sleeping routers Auto-early wake-up sleep option If you have nodes that are missing sync messages and could be going out of sync with the rest of the network, enabling an early wake gives the device a better chance to hear the sync messages that are being broadcast.
  • Page 62: Add A New Node To An Existing Network

    Sleep modes Sleeping routers 1. Set SO to 1 to enable the preferred sleep coordinator option on one of the nodes. 2. Set its SM to a synchronous sleep compatible mode (7 or 8) with its SP and ST set to a quick cycle time.
  • Page 63: Change Sleep Parameters

    Sleep modes Sleeping routers If you do not use one of these two methods, you must wait for the network to wake up before adding the new node. Place the new node in range of the network with a sleep/wake cycle that is shorter than the wake period of the network.
  • Page 64: Diagnostics

    Sleep modes Diagnostics When you use the default DigiMesh sleep parameters, separated subnets do not drift out of phase with each other. Subnets can drift out of phase with each other if you configure the network in one of the following ways: If you disable the non-sleep coordinator bit in the SO command on multiple devices in the network, they are eligible for the network to nominate them as a sleep coordinator.
  • Page 65: Missed Sync Messages Command

    Sleep modes Diagnostics Missed sync messages command Use the MS command to query the number of cycles that elapsed since the device received a sync message. Sleep status API messages When you use the SO command to enable this option, a device that is in API operating mode outputs modem status frames immediately after it wakes up and prior to going to sleep.
  • Page 66 Networking methods This section explains the basic layers and the three networking methods available on the XBee-PRO 900HP RF Modules, building from the simplest to the most complex. The MAC and PHY layers 64-bit addresses Make a unicast transmission Make a broadcast transmission Delivery methods XBee®-PRO 900HP/XSC RF Modules...
  • Page 67: Networking Methods

    Networking methods The MAC and PHY layers The MAC and PHY layers The PHY layer defines the physical and electrical characteristics of the network. It is responsible for managing the hardware that modulates and demodulates the RF bits. The MAC layer is responsible for sending and receiving RF frames. As part of each packet, there is a MAC layer data header that has addressing information as well as packet options.
  • Page 68: Make A Unicast Transmission

    Make a unicast transmission Use the SH and SL commands to read this address. The form of the address is: 0x0013A2XXXXXXXXXX. The first six digits are the Digi Organizationally Unique Identifier (OUI). The broadcast address is 0x000000000000FFFF. Make a unicast transmission To transmit to a specific device in Transparent operating mode: Set DH:DL to the SH:SL of the destination device.
  • Page 69: Repeater/Directed Broadcast

    Point to point unicast, encryption enabled 105.4 kb/s Digi made data throughput measurements setting the serial interface rate to 115200 b/s, and measuring the time to send 100,000 bytes from source to destination. During the test, no route discoveries or failures occurred.
  • Page 70: Digimesh Networking

    Networking methods Delivery methods DigiMesh networking A mesh network is a topology in which each node in the network is connected to other nodes around it. Each node cooperates in transmitting information. Mesh networking provides these important benefits: Routing. With this technique, the message is propagated along a path by hopping from node to node until it reaches its final destination.
  • Page 71 Networking methods Delivery methods Related command: MR In the same manner as the repeater delivery method, DigiMesh builds on P2MP and repeater modes. In DigiMesh, broadcasts always use the repeater delivery method, but unicasts use meshing technologies. In the DigiMesh network layer, there are additional network layer ACKs and NACKs. Mesh networking allows messages to be routed through several different nodes to a final destination.
  • Page 72 Networking methods Delivery methods 1. The source node does not have a route to the requested destination. 2. A route fails. This happens when the source node uses up its network retries without receiving an ACK. Route discovery begins by the source node broadcasting a route request (RREQ). We call any router that receives the RREQ and is not the ultimate destination, an intermediate node.
  • Page 73 Networking methods Delivery methods A number of configured parameters. Whether the transmission is a unicast or a broadcast. If the route to the destination address is known. Timeouts or timing information is provided for the following transmission types: Broadcast transmission Unicast transmission on a known route Unicast transmission on an unknown route Unicast transmission on a broken route...
  • Page 74 Networking methods Delivery methods brokenRouteUnicastTime=BroadcastTxTime+(NH*unicastOneHopTime)+ (2*knownRouteUnicastTime) XBee®-PRO 900HP/XSC RF Modules...
  • Page 75: At Commands

    AT commands Special commands MAC/PHY commands Diagnostic commands Network commands Addressing commands Addressing discovery/configuration commands Security commands Serial interfacing commands I/O settings commands I/O sampling commands Sleep commands Diagnostic - sleep status/timing commands Command mode options Firmware commands XBee®-PRO 900HP/XSC RF Modules...
  • Page 76: Special Commands

    AT commands Special commands Special commands The following commands are special commands. AC (Apply Changes) Immediately applies new settings without exiting Command mode. Parameter range Default FR (Force Reset) If you issue FR while the device is in Command Mode, the reset effectively exits Command mode. Resets the device through the UART.
  • Page 77: Mac/Phy Commands

    AT commands MAC/PHY commands MAC/PHY commands The following Binary commands are MAC/PHY commands. AF (Available Frequencies) You can query this read-only command to return a bitfield of the frequencies that are available in the device’s region of operation. This command returns a bitfield. Each bit corresponds to a physical channel.
  • Page 78: Mf (Minimum Frequency Count)

    AT commands MAC/PHY commands more active channels enabled than required by MF, then the device uses the first MF frequencies; higher active frequencies may be unused in favor of lower ones. Exactly MF (Minimum Frequency Count) number of channels must be made available for the device to communicate on.
  • Page 79: Id (Network Id)

    AT commands MAC/PHY commands ID (Network ID) Set or read the user network identifier. Devices must have the same network identifier to communicate with each other. Devices can only communicate with other devices that have the same network identifier and channel configured.
  • Page 80: Rr (Unicast Mac Retries)

    AT commands Diagnostic commands RR (Unicast Mac Retries) Set or read the maximum number of MAC level packet delivery attempts for unicasts. If RR is non- zero, the sent unicast packets request an acknowledgment from the recipient. Unicast packets can be retransmitted up to RR times if the transmitting device does not receive a successful acknowledgment.
  • Page 81: Er (Received Error Count)

    AT commands Diagnostic commands DB only indicates the signal strength of the last hop. It does not provide an accurate quality measurement for a multihop link. If the XBee-PRO 900HP RF Module has been reset and has not yet received a packet, DB reports 0. This value is volatile (the value does not persist in the device's memory after a power-up sequence).
  • Page 82: Tr (Transmission Failure Count)

    AT commands Diagnostic commands TR (Transmission Failure Count) This count increments whenever a MAC transmission attempt exhausts all MAC retries without ever receiving a MAC acknowledgment message from the destination node. Once the number reaches 0xFFFF, it does not count further events. To reset the counter to any 16-bit value, append a hexadecimal parameter to the command.
  • Page 83: Network Commands

    AT commands Network commands Network commands The following commands are network commands. CE (Node Messaging Options) The routing and messaging mode bit field of the device. A routing device repeats broadcasts. Indirect Messaging Coordinators do not transmit point-to- multipoint unicasts until an Indirect Messaging Poller requests them. Setting a device as an Indirect Messaging Poller causes it to regularly send polls to its Indirect Messaging Coordinator.
  • Page 84: Nn (Network Delay Slots)

    AT commands Network commands Parameter range 1 - 0x20 Default NN (Network Delay Slots) Set or read the maximum random number of network delay slots before rebroadcasting a network packet. Parameter range 1 - 0x05 Default MR (Mesh Unicast Retries) Set or read the maximum number of network packet delivery attempts.
  • Page 85: Addressing Commands

    AT commands Addressing commands Parameter range 0 - 0xFF [slots] Default 0 (no delay slots inserted) Addressing commands SH (Serial Number High) Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XBee-PRO in the factory.
  • Page 86: To (Transmit Options)

    AT commands Addressing commands Parameter range 0 - 0xFFFFFFFF Default 0x0000FFFF TO (Transmit Options) The bitfield that configures the transmit options for Transparent mode. Parameter range 0 - 0xFF Bit field: Meaning Description b’00 = <invalid option> Delivery method b’01 = Point-multipoint b'10 = Directed Broadcast (0x80) b’11 = DigiMesh (not available in the 10k product) Reserved...
  • Page 87: Nt (Node Discover Time)

    0 - 0x07 (bit field) Bit field Option Description Append the DD (Digi Device Identifier) value to ND responses or API node identification 0x01 frames. Local device sends ND or FN (Find Neighbors) response frame when the ND is issued.
  • Page 88: Ci (Cluster Id)

    0x11 (Transparent data cluster ID) DE (Destination Endpoint) Sets or displays the application layer destination ID value. The value is used as the destination endpoint for all data transmissions. The default value (0xE8) is the Digi data endpoint. Parameter range 0 - 0xFF...
  • Page 89: Dn (Discover Node)

    AT commands Addressing discovery/configuration commands The DH and DL of the receiving node update to the address of the originating node if the AG parameter matches the current DH/DL of the receiving node. API-enabled devices with updated DH and DL send an Aggregate Addressing Update frame (0x8E) out the serial port.
  • Page 90: Fn (Find Neighbors)

    Addressing discovery/configuration commands MANUFACTURER_ID<CR> (2 bytes) DIGI DEVICE TYPE<CR> (4 bytes. Optionally included based on NO settings.) RSSI OF LAST HOP<CR> (1 byte. Optionally included based on NO settings.) After (NT * 100) milliseconds, the command ends by returning a <CR>. ND also accepts...
  • Page 91: Security Commands

    AT commands Security commands Security commands The following AT commands are security commands. EE (Security Enable) Enables or disables 128-bit Advanced Encryption Standard (AES) encryption. Set this command parameter the same on all devices in a network. Parameter range 0 - 1 Parameter Description Encryption Disabled...
  • Page 92: Nb (Parity)

    AT commands Serial interfacing commands Value Description 2,400 b/s 4,800 b/s 9,600 b/s 19,200 b/s 38,400 b/s 57,600 b/s 115,200 b/s 230,400 b/s Default 0x03 (9600 b/s) NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x02 Parameter Description...
  • Page 93: Packetization Timeout)

    AT commands Serial interfacing commands Parameter Configuration One stop bit Two stop bits Default RO (Packetization Timeout) Set or read the number of character times of inter-character silence required before transmission begins when operating in Transparent mode. Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet. Parameter range 0 - 0xFF (x character times) Default...
  • Page 94: Ao (Api Options)

    AT commands I/O settings commands Parameter Description API Mode With Escapes. The device is in API mode and inserts escaped sequences to allow for control characters. The device passes XON, XOFF, Escape, and the 0x7E delimiter as data. Default AO (API Options) The API data frame output format for RF packets received.
  • Page 95: D1 (Dio1/Ad1)

    AT commands I/O settings commands Parameter range 0 - 5 Parameter Description Disabled Commissioning Pushbutton Digital input Digital output, low Digital output, high Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (pin 19). Parameter range 0 - 6 Parameter Description Disabled Commissioning button...
  • Page 96: D3 (Dio3/Ad3)

    AT commands I/O settings commands Parameter range 0 - 5 0 - 1 Parameter Description Disabled SPI_CLK Digital input Digital output, low Digital output, high Default D3 (DIO3/AD3) Sets or displays the DIO3/AD3 configuration (pin 17). Parameter range 0 - 5 Parameter Description Disabled...
  • Page 97: D5 (Dio5/Associated_Indicator)

    AT commands I/O settings commands Parameter Description Disabled SPI_MOSI Digital input Digital output, low Digital output, high Default D5 (DIO5/ASSOCIATED_INDICATOR) Sets or displays the DIO5/ASSOCIATED_INDICATOR configuration (pin 15). Parameter range 0, 1, 3 - 5 Parameter Description Disabled Associate LED indicator - blinks when associated Digital input Digital output, default low Digital output, default high...
  • Page 98: D7 (Dio7/Cts)

    AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (pin 12). Parameter range 0, 1, 3 - 7 Parameter Description Disabled CTS flow control Digital input Digital output, low Digital output, high RS-485 Tx enable, low Tx (0 V on transmit, high when idle)
  • Page 99: D9 (Dio9/On_Sleep)

    AT commands I/O settings commands Parameter Description Disabled Sleep request Digital input Digital output, low Digital output, high Default D9 (DIO9/ON_SLEEP) Sets or displays the DIO9/ON_SLEEP configuration (pin 13). Parameter range 0, 1, 3 - 5 Parameter Description Disabled ON/SLEEP output Digital input Digital output, low Digital output, high...
  • Page 100: P1 (Dio11/Pwm1 Configuration)

    AT commands I/O settings commands Parameter Description RSSI PWM0 output PWM0 output Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11/PWM1 configuration (pin 7). Parameter range 0 - 5 Parameter Description Disabled 32.768 kHz clock output PWM1 output Digital input...
  • Page 101: P3 (Dio13/Dout)

    AT commands I/O settings commands Parameter Description Digital output, low Digital output, high Default P3 (DIO13/DOUT) Sets or displays the DIO13/DOUT configuration (pin 2). Parameter range 0, 1 Parameter Description Disabled UART DOUT output Default P4 (DIO14/DIN) Sets or displays the DIO14/DIN configuration (pin 3). Parameter range 0, 1 Parameter...
  • Page 102: Pr (Pull-Up/Down Resistor Enable)

    AT commands I/O settings commands PR (Pull-up/Down Resistor Enable) The bit field that configures the internal pull-up/down resistor status for the I/O lines. If you set a PR bit to 1, it enables the pull-up/down resistor; 0 specifies no internal pull-up/down resistor. The following table defines the bit-field map for PR command.
  • Page 103: M1 (Pwm1 Duty Cycle)

    AT commands I/O sampling commands M1 (PWM1 Duty Cycle) The duty cycle of the PWM1 line (pin 7). Use the P1 command to configure the line as a PWM output. Parameter range 0 - 0x3FF Default LT (Associate LED Blink Time) Set or read the Associate LED blink time.
  • Page 104: Ic (Dio Change Detection)

    AT commands I/O sampling commands Parameter Description 1.25 V reference 2.5 V reference Default IC (DIO Change Detection) Set or read the digital I/O pins to monitor for changes in the I/O state. IC works with the individual pin configuration commands (D0 - D9, P0 - P2) . If you enable a pin as a digital I/O, you can use the IC command to force an immediate I/O sample transmission when the DIO state changes.
  • Page 105: If (Sleep Sample Rate)

    AT commands I/O sampling commands IF (Sleep Sample Rate) Set or read the number of sleep cycles that must elapse between periodic I/O samples. This allows the firmware to take I/O samples only during some wake cycles. During those cycles, the firmware takes I/O samples at the rate specified by IR.
  • Page 106: Tp (Board Temperature)

    AT commands Sleep commands Default TP (Board Temperature) The current module temperature in degrees Celsius in 8-bit two’s compliment format. For example 0x1A = 26 °C, and 0xF6 = -10 °C. Parameter range 0x00 - 0xFF [read-only] Default %V (Voltage Supply Monitoring) Displays the supply voltage of the device in mV units.
  • Page 107: So (Sleep Options)

    AT commands Sleep commands Default SO (Sleep Options) Set or read the sleep options bit field of a device. This command is a bitmask. You can set or clear any of the available sleep option bits. You cannot set bit 0 and bit 1 at the same time. Parameter range For synchronous sleep devices, the following sleep bit field options are defined: Bit Option...
  • Page 108: Sp (Sleep Period)

    AT commands Diagnostic - sleep status/timing commands SP (Sleep Period) Sets or displays the device's sleep time. This command defines the amount of time the device sleeps per cycle. For a node operating as an Indirect Messaging Coordinator: If non-zero, SP determines the time to hold an indirect message for an Indirect Messaging Poller before discarding it.
  • Page 109: Ss (Sleep Status)

    AT commands Diagnostic - sleep status/timing commands SS (Sleep Status) Queries a number of Boolean values that describe the device's status. Description This bit is true when the network is in its wake state. This bit is true if the node currently acts as a network sleep coordinator. This bit is true if the node ever receives a valid sync message after it powers on.
  • Page 110: Ms (Missed Sync Messages)

    AT commands Command mode options Default 0xBB8 MS (Missed Sync Messages) Reads the number of sleep or wake cycles since the device received a sync message. Supported in the mesh firmware variant only. Parameter range [read-only] Default SQ (Missed Sleep Sync Count) Counts the number of sleep cycles in which the device does not receive a sleep sync.
  • Page 111: Ct (Command Mode Timeout)

    AT commands Firmware commands Parameter range Default CT (Command Mode Timeout) Sets or displays the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode. Parameter range 2 - 0x1770 (x 100 ms) Default...
  • Page 112: Hv (Hardware Version)

    0 - 0xFFFF [read-only] Default Set in the firmware DD (Device Type Identifier) Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. If you change DD, RE (Restore Defaults) will not restore defaults. The only way to get DD back to default values is to explicitly set it to defaults.
  • Page 113: Ck (Configuration Crc)

    AT commands Firmware commands CK (Configuration CRC) Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. This command allows you to detect an unexpected configuration change on a device. Use the code that the device returns to determine if a node has the configuration you want. After a firmware update this command may return a different value.
  • Page 114 Operate in API mode API mode overview API frame format Data bytes that need to be escaped: API serial exchanges Calculate and verify checksums XBee®-PRO 900HP/XSC RF Modules...
  • Page 115: Operate In Api Mode

    Operate in API mode API mode overview API mode overview As an alternative to Transparent operating mode, you can use API operating mode. API mode provides a structured interface where data is communicated through the serial interface in organized packets and in a determined order.
  • Page 116: Data Bytes That Need To Be Escaped

    Operate in API mode Data bytes that need to be escaped: Escape characters When you are sending or receiving a UART data frame, specific data values must be escaped (flagged) so they do not interfere with the data frame sequencing. To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped XOR’d with 0x20.
  • Page 117: Api Serial Exchanges

    Operate in API mode API serial exchanges API frame names and IDs sent to the module API frame names API ID AT Command 0x08 AT Command - Queue Parameter Value 0x09 TX Request 0x10 Explicit TX Request 0x11 Remote Command Request 0x17 API frame names and IDs received from the device API frame names...
  • Page 118: Transmit And Receive Rf Data

    Operate in API mode API serial exchanges Transmit and Receive RF data The following image shows the API frames exchange that take place at the UART interface when sending RF data to another device. The transmit status frame is always sent at the end of a data transmission unless the frame ID is set to 0 in the TX request.
  • Page 119: Device Registration

    Operate in API mode Calculate and verify checksums Device Registration The following image shows the API frame exchanges that take place at the serial interface when registering a joining device to a trust center. Calculate and verify checksums To calculate the checksum of an API frame: 1.
  • Page 120 Operate in API mode Calculate and verify checksums 7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F B8 Add these hex bytes: 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F = 247 Now take the result of 0x247 and keep only the lowest 8 bits which in this example is 0x47 (the two far right digits).
  • Page 121: Frame Descriptions

    Description This frame causes the device to send payload data as an RF packet. This packet format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. We encourage you to use Transmit Request frame - 0x10 to initiate API transmissions.
  • Page 122: At Command Frame - 0X08

    Frame descriptions AT Command frame - 0x08 Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x11 Frame type 0x00 Frame ID 0x01 Destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0xC5 LSB 12 0x07 Options 0x00...
  • Page 123 Frame descriptions AT Command frame - 0x08 Frame data fields Offset Description Frame 0x08 type Identifies the data frame for the host to correlate with a subsequent ACK Frame ID (0x88). If set to 0, the device does not send a response. Command name: two ASCII characters that identify the AT command.
  • Page 124: At Command - Queue Parameter Value Frame - 0X09

    Frame descriptions AT Command - Queue Parameter Value frame - 0x09 AT Command - Queue Parameter Value frame - 0x09 Description This frame allows you to query or set device parameters. In contrast to the AT Command (0x08) frame, this frame queues new parameter values and does not apply them until you issue either: The AT Command (0x08) frame (for API type) The AC command Format...
  • Page 125 Frame descriptions AT Command - Queue Parameter Value frame - 0x09 Frame data fields Offset Example AT command 0x42 (B) 0x44 (D) Parameter value (BD7 = 115200 baud) 0x07 Checksum 0x68 XBee®-PRO 900HP/XSC RF Modules...
  • Page 126: Transmit Request Frame - 0X10

    Frame descriptions Transmit Request frame - 0x10 Transmit Request frame - 0x10 Description This frame causes the device to send payload data as an RF packet to a specific destination. For broadcast transmissions, set the 64-bit destination address to 0x000000000000FFFF . For unicast transmissions, set the 64 bit address field to the address of the desired destination node.
  • Page 127 Frame descriptions Transmit Request frame - 0x10 Meaning Description NACK Enable NACK messages on all DigiMesh API packets Trace route Enable a Trace Route on all DigiMesh API packets Reserved <set this bit to 0> Reserved <set this bit to 0> b’00 = <invalid option>...
  • Page 128 Frame descriptions Transmit Request frame - 0x10 Frame data fields Offset Example RF data 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 Checksum 0x13 If you enable escaping (AP = 2), the frame should look like: 0x7E 0x00 0x16 0x10 0x01 0x00 0x7D 0x33 0xA2 0x00 0x40 0x0A 0x01 0x27 0xFF 0xFE 0x00 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x7D 0x33 The device calculates the checksum (on all non-escaped bytes) as [0xFF - (sum of all bytes from API frame type through data payload)].
  • Page 129: Explicit Addressing Command Frame - 0X11

    Frame descriptions Explicit Addressing Command frame - 0x11 Explicit Addressing Command frame - 0x11 Description This frame is similar to Transmit Request (0x10), but it also requires you to specify the application- layer addressing fields: endpoints, cluster ID, and profile ID. This frame causes the device to send payload data as an RF packet to a specific destination, using specific source and destination endpoints, cluster ID, and profile ID.
  • Page 130 Frame descriptions Explicit Addressing Command frame - 0x11 Transmit Options bit field Bit field: Meaning Description Disable ACK Disable acknowledgments on all unicasts Disable RD Disable Route Discovery on all DigiMesh unicasts NACK Enable NACK messages on all DigiMesh API packets Trace Route Enable a Trace Route on all DigiMesh API packets Reserved...
  • Page 131 Frame descriptions Explicit Addressing Command frame - 0x11 Frame data fields Offset Example 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x01 0x23 0x84 LSB12 0x00 Reserved 0xFF 0xFE Source endpoint 0xE8 Destination endpoint 0xE8 Cluster ID 0x00 0x11 Profile ID 0xC1 0x05...
  • Page 132: Remote At Command Request Frame - 0X17

    Frame descriptions Remote AT Command Request frame - 0x17 Remote AT Command Request frame - 0x17 Description Used to query or set device parameters on a remote device. For parameter changes on the remote device to take effect, you must apply changes, either by setting the Apply Changes options bit, or by sending an AC command to the remote.
  • Page 133 Frame descriptions Remote AT Command Request frame - 0x17 Frame data fields Offset Example Length MSB 1 0x00 LSB 2 0x10 0x17 Frame type Frame ID 0x01 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF...
  • Page 134: Legacy Rx Indicator Frame - 0X80

    Frame descriptions Legacy RX Indicator frame - 0x80 Legacy RX Indicator frame - 0x80 Description When a device in Legacy Packet Mode (AO = 2) receives an RF data packet, it sends this frame out the serial interface. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.
  • Page 135 Frame descriptions Legacy RX Indicator frame - 0x80 Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x11 Frame type 0x80 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0xC5 LSB 11 0x07 RSSI 0x28...
  • Page 136: At Command Response Frame - 0X88

    Frame descriptions AT Command Response frame - 0x88 AT Command Response frame - 0x88 Description A device sends this frame in response to an AT Command (0x08 or 0x09) frame. Some commands send back multiple frames; for example, the ND command. Format The following table provides the contents of the frame.
  • Page 137 Frame descriptions AT Command Response frame - 0x88 Frame data fields Offset Example AT command 0x42 (B) 0x44 (D) Command status 0x00 Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 XBee®-PRO 900HP/XSC RF Modules...
  • Page 138: Tx Status Frame - 0X89

    Frame descriptions TX Status frame - 0x89 TX Status frame - 0x89 Description When a (0x00) is complete, the device sends a TX Status frame. This message indicates if the packet transmitted successfully or if there was a failure. Format The following table provides the contents of the frame.
  • Page 139: Modem Status Frame - 0X8A

    Frame descriptions Modem Status frame - 0x8A Modem Status frame - 0x8A Description Devices send the status messages in this frame in response to specific conditions. Format The following table provides the contents of the frame. For details on frame structure, see API frame format.
  • Page 140: Transmit Status Frame - 0X8B

    Frame descriptions Transmit Status frame - 0x8B Transmit Status frame - 0x8B Description When a Transmit Request (0x10, 0x11) completes, the device sends a Transmit Status message out of the serial interface. This message indicates if the Transmit Request was successful or if it failed. Note Broadcast transmissions are not acknowledged and always return a status of 0x00, even if the delivery failed.
  • Page 141 Frame descriptions Transmit Status frame - 0x8B Frame Fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x07 Frame type 0x8B Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E XBee®-PRO 900HP/XSC RF Modules...
  • Page 142: Route Information Packet Frame - 0X8D

    Frame descriptions Route Information Packet frame - 0x8D Route Information Packet frame - 0x8D Description If you enable NACK or the Trace Route option on a DigiMesh unicast transmission, a device can output this frame for the transmission. Format The following table provides the contents of the frame. For details on frame structure, see API frame format.
  • Page 143 Frame descriptions Route Information Packet frame - 0x8D This particular frame indicates that the network successfully forwards the transmission from one device (serial number 0x0013A200 4052BBBB) to another device (serial number 0x0013A200 4052CCCC). Frame data fields Offset Example Start delimiter 0x7E Length MSB 1...
  • Page 144 Frame descriptions Route Information Packet frame - 0x8D Frame data fields Offset Example Source address MSB 21 0x00 0x13 0xA2 0x00 0x40 0x52 0xDD LSB 28 0xDD Responder address MSB 29 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 36 0xBB Receiver address MSB 37...
  • Page 145: Aggregate Addressing Update Frame - 0X8E

    Frame descriptions Aggregate Addressing Update frame - 0x8E Aggregate Addressing Update frame - 0x8E Description The device sends out an Aggregate Addressing Update frame on the serial interface of an API-enabled node when an address update frame (generated by the AG command being issued on a node in the network) causes the node to update its DH and DL registers.
  • Page 146 Frame descriptions Aggregate Addressing Update frame - 0x8E Frame data fields Offset Example New address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 12 0xBB Old address 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA 0xAA Checksum 0x19 XBee®-PRO 900HP/XSC RF Modules...
  • Page 147: Receive Packet Frame - 0X90

    Frame descriptions Receive Packet frame - 0x90 Receive Packet frame - 0x90 Description When a device configured with a standard API Rx Indicator (AO = 0) receives an RF data packet, it sends it out the serial interface using this message type. Format The following table provides the contents of the frame.
  • Page 148 Frame descriptions Receive Packet frame - 0x90 Frame data fields Offset Example Length MSB 1 0x00 LSB 2 0x12 0x90 Frame type MSB 4 0x00 64-bit source address 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Receive options 0x01 Received data...
  • Page 149: Explicit Rx Indicator Frame - 0X91

    Frame descriptions Explicit Rx Indicator frame - 0x91 Explicit Rx Indicator frame - 0x91 Description When a device configured with explicit API Rx Indicator (AO = 1) receives an RF packet, it sends it out the serial interface using this message type. Note If a Transmit Request frame - 0x10...
  • Page 150 Frame descriptions Explicit Rx Indicator frame - 0x91 If a device sends the transmission: With source and destination endpoints of 0xE0 Cluster ID = 0x2211 Profile ID = 0xC105 If AO = 1 on the receiving device, it sends the following frame out its serial interface. Frame data fields Offset Example...
  • Page 151 Frame descriptions Explicit Rx Indicator frame - 0x91 Frame data fields Offset Example Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x56 XBee®-PRO 900HP/XSC RF Modules...
  • Page 152: I/O Data Sample Rx Indicator Frame - 0X92

    Frame descriptions I/O Data Sample Rx Indicator frame - 0x92 I/O Data Sample Rx Indicator frame - 0x92 Description When the modem receives an I/O sample RF packet, it is sent out the UART using this message type (when AO = 1). Format The following table provides the contents of the frame.
  • Page 153 Frame descriptions I/O Data Sample Rx Indicator frame - 0x92 The configuration of the transmitting device takes a digital sample of a number of digital I/O lines and an analog sample of AD1. It reads the digital lines to be 0x0014 and the analog sample value is 0x0225. The complete example frame is: 7E00 1492 0013 A200 4052 2BAA FFFE 0101 001C 0200 1402 25F9 Frame fields...
  • Page 154: Node Identification Indicator Frame - 0X95

    1 = Normal Mode 2 = End Device For more options, see NO (Node Discovery Options). Source event 1 = Frame sent by node identification pushbutton event. Digi Profile ID 31-32 Set to the Digi application profile ID. XBee®-PRO 900HP/XSC RF Modules...
  • Page 155 Node Identification Indicator frame - 0x95 Frame data fields Offset Description Digi 33-34 Set to the Digi Manufacturer ID. Manufacturer Digi DD value Reports the DD value of the responding device. Use the NO command to 35-38 (optional) enable this field.
  • Page 156 0x74 0x02 0xAC LSB 24 NI string 0x20 0x00 Reserved 0xFF 0xFE Device type 0x01 Source event 0x01 Digi Profile ID 0xC1 0x05 Digi Manufacturer ID 0x10 0x1E Digi DD value 0x00 (optional) 0x0C 0x00 0x00 RSSI (optional) 0x2E Checksum 0x33 XBee®-PRO 900HP/XSC RF Modules...
  • Page 157: Remote Command Response Frame - 0X97

    Frame descriptions Remote Command Response frame - 0x97 Remote Command Response frame - 0x97 Description If a device receives this frame in response to a Remote Command Request (0x17) frame, the device sends an AT Command Response (0x97) frame out the serial interface. Some commands, such as the ND command, may send back multiple frames.
  • Page 158 Frame descriptions Remote Command Response frame - 0x97 Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x13 Frame type 0x97 Frame ID 0x55 64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12...
  • Page 159 Advanced application features Remote configuration commands Network commissioning and diagnostics I/O line monitoring XBee®-PRO 900HP/XSC RF Modules...
  • Page 160: Advanced Application Features

    Advanced application features Remote configuration commands Remote configuration commands A device in API mode has provisions to send configuration commands to remote devices using the Remote Command Request API frame. For more information, see Operate in API mode. You can use this API frame to send commands to a remote module to read or set command parameters.
  • Page 161: Network Link Establishment And Maintenance

    Advanced application features Network commissioning and diagnostics Network link establishment and maintenance Build aggregate routes In many applications it is necessary for many or all of the nodes in the network to transmit data to a central aggregator node. In a new DigiMesh network the overhead of these nodes discovering routes to the aggregator node can be extensive and taxing on the network.
  • Page 162: Place Devices

    Advanced application features Network commissioning and diagnostics To update only the routing table information without affecting the DH/DL registers, use Example 2. To update the DH/DL registers of the network, use the method in the following example. Example: Use the device with serial number 0x0013a2004052c507 as a network aggregator and replace it with a device with serial number 0x0013a200f5e4d3b2.
  • Page 163: Link Reliability

    Advanced application features Network commissioning and diagnostics node which sent the FN command to the target node. The device outputs the response packet on the initiating radio in the same format as a network discovery frame. Link reliability To install a successful mesh network, you must be able to determine where to place individual XBee devices to establish reliable links throughout the mesh network.
  • Page 164 Advanced application features Network commissioning and diagnostics Number of bytes Field name Description Destination The address the device tests its link with. address Payload size The size of the test packet. Use the MP command to query the maximum payload size for this device. Iterations The number of packets to send.
  • Page 165: Commissioning Pushbutton And Associate Led

    Advanced application features Network commissioning and diagnostics If the result field is not equal to zero then an error occurred. Ignore the other fields in the packet. If the Success field is equal to zero then ignore the RSSI fields. Trace routing Determining the route a DigiMesh unicast takes to its destination is useful when setting up a network or diagnosing problems within a network.
  • Page 166 Advanced application features Network commissioning and diagnostics associate LED behaviors. The following features can be supported in hardware: TH RF Module Connect a pushbutton and an LED to XBee-PRO 900HP RF Module pins 20 and 15 respectively to support the commissioning pushbutton and associate LED functionalities. SMT RF Module Commissioning pushbutton The commissioning pushbutton definitions provide a variety of simple functions to help with deploying...
  • Page 167 Advanced application features Network commissioning and diagnostics Sleep Button configuration and presses sync status Action Configured for Wakes the device for 30 seconds (or until the synchronized synchronous sleep network goes to sleep). Queues a Node Identification broadcast transmission sent at the beginning of the next network wake cycle.
  • Page 168: I/O Line Monitoring

    Advanced application features I/O line monitoring Sleep mode LED status Meaning On, solid The network is asleep, or the device has not synchronized with the network, or has lost synchronization with the network 7, 8 On, slow blinking The device is acting as the network sleep coordinator and is (500 ms blink time) operating properly 7, 8...
  • Page 169 Advanced application features I/O line monitoring Device pin name Device pin number Configuration command CD / DIO12 PWM0 / RSSI / DIO10 PWM1 / DIO11 DTR / SLEEP_RQ / DIO8 AD4 / DIO4 CTS / DIO7 ON/ SLEEP / DIO9 ASSOC / AD5 / DIO5 RTS / DIO6 AD3 / DIO3...
  • Page 170 Advanced application features I/O line monitoring Field Name Description Indicates which digital I/O lines have sampling enabled. Each bit corresponds to Digital one digital I/O line on the device. channel mask bit 0 = AD0/DIO0 bit 1 = AD1/DIO1 bit 2 = AD2/DIO2 bit 3 = AD3/DIO3 bit 4 = DIO4 bit 5 = ASSOC/DIO5...
  • Page 171: Periodic I/O Sampling

    Advanced application features I/O line monitoring Periodic I/O sampling Periodic sampling allows a device to take an I/O sample and transmit it to a remote device at a periodic rate. Use the IR command to set the periodic sample rate. To disable periodic sampling, set IR to 0.
  • Page 172: General Purpose Flash Memory

    General Purpose Flash Memory General Purpose Flash Memory Access General Purpose Flash Memory General Purpose Flash Memory commands Work with flash memory XBee®-PRO 900HP/XSC RF Modules...
  • Page 173: General Purpose Flash Memory

    General Purpose Flash Memory General Purpose Flash Memory General Purpose Flash Memory XBee-PRO 900HP RF Modules provide 119 512-byte blocks of flash memory that an application can read and write to. This memory provides a non-volatile data storage area that an application uses for many purposes.
  • Page 174: General Purpose Flash Memory Commands

    General Purpose Flash Memory General Purpose Flash Memory commands Byte offset in Number of payload bytes Field name General field description GPM_CMD_ID This field is the same as the request field. GPM_STATUS Status indicating whether the command was successful. GPM_BLOCK_NUM The block number addressed in the GPM.
  • Page 175: Erase (0X01)

    General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_STATUS A 1 in the least significant bit indicates an error occurred. All other bits are reserved at this time. GPM_BLOCK_NUM Indicates the number of GPM blocks available. GPM_START_INDEX Indicates the size, in bytes, of a GPM block.
  • Page 176: Write (0X02) And Erase_Then_Write (0X03)

    General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_CMD_ID Should be set to ERASE_RESPONSE (0x81). GPM_STATUS A 1 in the least significant bit indicates an error occurred. All other bits are reserved at this time. GPM_BLOCK_NUM Matches the parameter passed in the request frame.
  • Page 177: Write _Response (0X82) And Erase_Then_Write_Response (0X83)

    General Purpose Flash Memory General Purpose Flash Memory commands WRITE _RESPONSE (0x82) and ERASE_THEN_WRITE_RESPONSE (0x83) When a WRITE or ERASE_THEN_WRITE command request has been unicast to a node, that node sends a response in the following format to the source endpoint specified in the requesting frame. Field name Command-specific description GPM_CMD_ID...
  • Page 178: Read_Response (0X84)

    General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_NUM_BYTES Set to the number of data bytes to be read. Only one GPM block can be operated on per command. For this reason, GPM_START_INDEX + GPM_NUM_BYTES cannot be greater than the GPM block size. The number of bytes sent in an explicit API frame (including the GPM command fields) cannot exceed the maximum payload size of the device.
  • Page 179: Firmware_Verify_Response (0X85)

    General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_CMD_ID Should be set to FIRMWARE_VERIFY (0x05) or FIRMWARE_ VERIFY_AND_INSTALL (0x06) GPM_OPTIONS There are currently no options defined for this command. Set this field to 0. GPM_BLOCK_NUM This field is unused for this command.
  • Page 180: Work With Flash Memory

    Flash memory has a limited lifetime. The flash memory on which the GPM is based is rated at 20,000 erase cycles before failure. Take care to ensure that the frequency of erase/write operations allows for the desired product lifetime. Digi's warranty does not cover products that have exceeded the allowed number of erase cycles.
  • Page 181: Xsc Firmware

    XSC firmware This section provides an overview of the XBee-PRO XSC firmware and the technical specifications. XBee-PRO XSC RF Module overview Pin signals Electrical characteristics XBee®-PRO 900HP/XSC RF Modules...
  • Page 182: Xbee-Pro Xsc Rf Module Overview

    XSC firmware XBee-PRO XSC RF Module overview XBee-PRO XSC RF Module overview The XBee-PRO XSC RF Modules are engineered to afford integrators with an easy-to-use RF solution that provides reliable delivery of critical data between remote devices. These modules come configured to sustain reliable long-range wireless links.
  • Page 183: Electrical Characteristics

    XSC firmware Electrical characteristics Public When signal active Function Do not connect DI3 / High By default, DI3 pin is not used. To configure this pin to support SLEEP sleep modes, see Sleep mode, SM (Sleep Mode) PW (Pin Wakeup). Ground Driven high Do not connect DO2 /...
  • Page 184: Timing Specifications

    XSC firmware Electrical characteristics Timing specifications The following figure illustrates the timing specifications. Host A and Host B correspond to a transmitting device (Host A) and receiving device (Host B). XBee®-PRO 900HP/XSC RF Modules...
  • Page 185 XSC firmware Electrical characteristics The following table provides typical AC characteristics when SY = 0. The symbols correspond with the previous two figures. 9600 baud rate Symbol Description (32 byte packet) Latency from the time data is transmitted until received 72.0 ms Time that TX/PWR pin is driven low 16.8 ms...
  • Page 186 XSC firmware Electrical characteristics Symbol Parameter Condition Typical Max Units Input low voltage All input signals -0.3 0.3 VCC Input high voltage All input signals VCC + 0.3 V Output low-level Iout = Iout_Max voltage Output high-level Iout = Iout_Max -0.4 voltage Input leakage current With pull-up resistors disabled Output current Pins 2, 15 (DOUT, TX/PWR)
  • Page 187 XBee-PRO XSC specifications Performance specifications Power requirements Networking specifications General specifications Antenna options Regulatory conformity summary XBee®-PRO 900HP/XSC RF Modules...
  • Page 188: Performance Specifications

    XBee-PRO XSC specifications Performance specifications Performance specifications The following table describes the performance specifications for the devices. Note Range figure estimates are based on free-air terrain with limited sources of interference. Actual range will vary based on transmitting power, orientation of transmitter and receiver, height of transmitting antenna, height of receiving antenna, weather conditions, interference sources in the area, and terrain between receiver and transmitter, including indoor and outdoor structures such as walls, trees, buildings, hills, and mountains.
  • Page 189: Networking Specifications

    XBee-PRO XSC specifications Networking specifications Networking specifications The following table provides the networking specifications for the device. XBee-PRO XSC (S3* XBee-PRO XSC (S3B Specification hardware) hardware) Frequency range 902-928 MHz (located in the 900 MHz ISM band) Spread spectrum Frequency hopping Network topology Point-to-point, peer-to-peer, point-to-multipoint Channel capacity...
  • Page 190: Regulatory Conformity Summary

    XBee-PRO XSC specifications Regulatory conformity summary Regulatory conformity summary This table describes the agency approvals for the XBee-PRO XSC. Specification XBee-PRO XSC (S3* and S3B hardware) FCC Part 15.247 FCC ID: MCQ-XB900HP Innovation, Science and Economic Development IC: 1846A-XB900HP Canada (ISED) Australia Brazil ANATEL 3727-12-1209...
  • Page 191: Xbee-Pro Xsc Rf Module Operation

    XBee-PRO XSC RF Module operation Serial communications UART-interfaced data flow Serial data Flow control Operating modes XBee®-PRO 900HP/XSC RF Modules...
  • Page 192: Serial Communications

    XBee-PRO XSC RF Module operation Serial communications Serial communications The XBee module interfaces to a host device through a CMOS-level asynchronous serial port. Through its serial port, the module can communicate with any UART voltage compatible device or through a level translator to any RS-232/485/422 device.
  • Page 193: Data In (Din) Buffer And Flow Control

    XBee-PRO XSC RF Module operation Flow control Data In (DIN) buffer and flow control When serial data enters the device through the DIN pin (pin ), it stores the data in the DIN buffer until it can process the data. When the firmware satisfies the RB and RO parameter thresholds, the device attempts to initialize an RF transmission.
  • Page 194: Data Out (Do) Buffer And Flow Control

    XBee-PRO XSC RF Module operation Operating modes Data Out (DO) buffer and flow control When a device receives RF data, the data enters the DOUT buffer and the device sends it out the serial port to a host device. Once the DOUT buffer reaches capacity, it loses any additional incoming RF data. In the following situations, the DOUT buffer may become full and overflow: 1.
  • Page 195: Transmit Mode

    XBee-PRO XSC RF Module operation Operating modes Command mode (Command mode sequence issued, not available with Smart Energy software or when using the SPI port). Transmit mode When the device received the first byte of serial data from the UART in the DI buffer, the modem attempts to shift to Transmit Mode and initiate an RF connection with other modems.
  • Page 196 XBee-PRO XSC RF Module operation Operating modes Pin sleep Cyclic sleep For the device to transition to Sleep Mode, the module must have a non-zero SM (Sleep Mode) Parameter and one of the following must occur: The device is idle (no data transmission or reception) for a user-defined period of time. Refer to ST (Wake Time) The device asserts SLEEP (only for Pin Sleep option).
  • Page 197 XBee-PRO XSC RF Module operation Operating modes Once in Pin Sleep, the device de-asserts (high) CTS (pin ) , indicating that other devices should not send data to the device. The device also de-asserts (low) the TX_PWR line (pin ) when the device is in Pin Sleep mode.
  • Page 198: Command Mode

    XBee-PRO XSC RF Module operation Operating modes Incorrect configuration (LH < SM) Length of wake-up initializer is shorter than the time interval of Cyclic Sleep. This configuration is vulnerable to the receiver waking and missing the wake-up initializer (and therefore also the accompanying payload data).
  • Page 199 Assert (low) the CONFIG pin and either turn the power going to the device off and back on. If using a Digi XBIB-R Interface Board, you can also hold the Data-In line low (also known as a break) while rebooting the device by pressing the reset button on the device assembly [device assembly = device mounted to an interface board.
  • Page 200 XBee-PRO XSC RF Module operation Operating modes Returns to Idle Mode Send CN (Exit Command Mode) Command For an example of programming the XBee-PRO XSC RF Module using AT Commands and descriptions of each configurable parameter, refer to Configuration and commands.
  • Page 201 XBee-PRO XSC RF Module operation Operating modes Signal #4 is CMD (pin 16) Signal #1 is the DIN (pin 3) signal to the radio Signal #2 is the DOUT (pin 2) signal from the radio Signal #3 is CTS (pin 12) This graph shows a value written to a register and then read out to verify it.
  • Page 202 Configuration and commands Programming examples Send binary commands Special commands Command mode options Networking and security commands Network commands Serial interfacing commands Diagnostic commands Sleep commands XBee®-PRO 900HP/XSC RF Modules...
  • Page 203: Programming Examples

    Connect the device to a PC The programming examples that follow require the installation of XCTU and a serial connection to a PC. Digi stocks connector boards to facilitate interfacing with a PC. 1. Download XCTU from the Digi website: digi.com/products/xbee-rf-solutions/xctu-software/xctu#resources...
  • Page 204: Special Commands

    Configuration and commands Special commands The default flow control is NONE, so if you are using XCTU, CTS is not an issue. However, you can still observe the behavior of the CTS line by monitoring the CTS indicator in the terminal or console. Special commands The following commands are special commands.
  • Page 205: At (Guard Time After)

    Configuration and commands Command mode options AT (Guard Time After) Sets or displays the time-of-silence that follows the CC (Command Sequence Character) of the Command mode sequence (BT + CC + AT). By default, one second must elapse before and after the command sequence character.
  • Page 206: Cd (Do3 Configuration)

    Configuration and commands Command mode options Recommended: 0x20 - 0x7F (ASCII) Default 0x2B (ASCII “+”) Bytes returned CD (DO3 Configuration) Selects or reads the behavior of the DO3/RX LED line. Parameter range 0 - 3 Parameter Configuration RX LED Default high Default low Reserved Assert only when you have sent the packet addressed to the device.
  • Page 207: Ct (Command Mode Timeout)

    Configuration and commands Command mode options CT (Command Mode Timeout) Set or read the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode. Use the CN (Exit Command mode) command to exit Command mode manually. Binary command 0x06 (6 decimal) Parameter range...
  • Page 208: Pc (Power-Up To Transparent Operating Mode)

    Configuration and commands Networking and security commands Bytes returned PC (Power-up to Transparent operating mode) Sets the device to power-up directly into Command mode from reset or power-on. If you enable the PC Command with the SM Parameter set to 1, you can use the DI3 (pin 9) to enter Command mode. If the PC command is enabled with the SM parameter set to 1, DI3 (pin 9) can be used to enter the module into Command mode.
  • Page 209: Md (Rf Mode)

    Configuration and commands Networking and security commands Bytes returned MD (RF Mode) Sets or displays the settings that enable the Peer-to-peer or Repeater modes on the device. Repeater Mode enables longer range via an intermediary device. When MD=3, the module acts as a “store and forward”...
  • Page 210: Network Commands

    Configuration and commands Network commands Network commands The following commands are network commands. DT (Destination Address) Sets or displays the networking address of a device. The devices use three filtration layers: Vendor ID Number (ID) Channel (HP) Destination Address (DT) The DT command assigns an address to a device that enables it to communicate with only devices that have the same address.
  • Page 211: Ht (Time Before Wake-Up Initializer)

    Configuration and commands Network commands HT (Time before Wake-up Initializer) Sets or displays the time of inactivity (no serial or RF data is sent or received) before a transmitting (TX) RF device sends a wake-up initializer. The main purpose of this command is to prevent devices from sending the Long Header with every data packet.
  • Page 212: Rn (Delay Slots)

    Configuration and commands Network commands the Destination Address or Address Mask of the RX device for the packet to be received and sent out the RX device's DO (Data Out) pin. If the combined value does not match the Destination Address or Address Mask of the RX device, it discards the packet.
  • Page 213: Sy (Time Before Initialization)

    Configuration and commands Network commands After transmitting a packet, the transmitting device waits to receive an ACK from a receiving device. If it does not receive the ACK in the time that RN specifies, it transmits the original packet again. The transmitting device transmits the RF packet repeatedly until it receives an ACK or until it sends the packet RR times.
  • Page 214: Tt (Streaming Limit)

    Configuration and commands Serial interfacing commands Default 0 (Disabled - channel initialization information is sent with each RF packet.) Bytes returned TT (Streaming Limit) Sets or displays the limit on the number of bytes that a device can send before issuing a random delay. If a device is sending a continuous stream of RF data, it inserts a delay that stops its transmission and gives other devices time to transmit once it sends TT bytes of data.
  • Page 215: Cs (Do2 Configuration)

    Configuration and commands Serial interfacing commands BD parameter to vary from the sent parameter. Sending ATBD without an associated parameter value returns the value actually stored in the device’s BD register. The following table provides the parameters sent versus the parameters stored. BD parameter sent Interface data rate S3* BD parameter...
  • Page 216: Fl (Software Flow Control)

    Configuration and commands Serial interfacing commands Binary command 0x1F (31 decimal) Parameter range 0 - 4 Parameter Configuration RS-232 CTS flow control RS-485 TX enable low Static high RS-485 TX enable high Static low Default Bytes returned FL (Software Flow Control) Configures software flow control.
  • Page 217: Ft (Flow Control Threshold)

    Configuration and commands Serial interfacing commands FT (Flow Control Threshold) Sets or displays the flow control threshold. De-assert CTS when the number of bytes specified by the FT parameter are in the DIN buffer. Re- assert CTS when less than FT - 16 bytes are in the UART receive buffer. Binary command 0x24 (36 decimal) Parameter range...
  • Page 218: Rb (Packetization Threshold)

    Configuration and commands Serial interfacing commands Changes to the PK parameter may have a secondary effect on the RB (Packetization Threshold) parameter. RB must always be less than or equal to PK. If you change PK to a value that is less than the current value of RB, the RB value lowers to be equal to PK.
  • Page 219: Rt (Di2 Configuration)

    Configuration and commands Diagnostic commands After a device receives a serial byte and it receives no other byte before the RO timeout, the tranmission begins. Binary command 0x21 (33 decimal) Parameter range 0 - 0xFFFF [x 200 µs] Default Bytes returned RT (DI2 Configuration) Sets or displays the behavior of the DI2/RTS/CMD line.
  • Page 220: Gd (Receive Good Count)

    Configuration and commands Diagnostic commands Once the “Receive Error Count” reaches its maximum value (up to 0xFFFF), it remains at its maximum count value until the maximum count value is explicitly changed or you reset the device. To reset the counter to any 16-bit unsigned value, append a hexadecimal parameter to the command. This value is volatile (the value does not persist in the device's memory after a power-up sequence).
  • Page 221: Rp (Rssi Pwm Timer)

    Configuration and commands Diagnostic commands RP (RSSI PWM Timer) Enables a pulse-width modulated (PWM) output on the CONFIG pin. We calibrate the pin to show the difference between received signal strength and the sensitivity level of the device. PWM pulses vary from zero to 95 percent.
  • Page 222: Rs (Rssi)

    Configuration and commands Diagnostic commands Parameter range Read-only Default Bytes returned Note This command is only supported on S3B modules. RS (RSSI) Returns the signal level of the last packet received. You can use this reading to determine range characteristics of devices under various conditions of noise and distance.
  • Page 223: Tr (Transmission Failure Count)

    Configuration and commands Diagnostic commands Binary command 0x26 (38 decimal) Parameter range 0 - 0xFFFF [read-only] Default Bytes returned TR (Transmission Failure Count) Records the number of retransmit failures. The device increments this number each time a packet is not acknowledged within the number of retransmits specified by the RR (Retries) Command.
  • Page 224: Sleep Commands

    Configuration and commands Sleep commands Sleep commands The following commands are sleep commands. FH (Force Wakeup Initializer) Forces the device to send a wake-up initializer on the next transmission. Only use FH with cyclic sleep modes active on remote devices. You do not need to issue the WR (Write) command with FH.
  • Page 225: Lh (Wakeup Initializer Timer)

    Configuration and commands Sleep commands LH (Wakeup Initializer Timer) Sets or displays the duration of time during which the wake-up initializer is sent. When receiving devices are in Cyclic Sleep Mode, they power-down after a period of inactivity as specified by the ST parameter and will periodically wake and listen for data transmissions.
  • Page 226: Sm (Sleep Mode)

    Configuration and commands Sleep commands Bytes returned SM (Sleep Mode) Sets or displays the device's sleep mode settings, which configure the device to run in states that require minimal power consumption. By default, Sleep Mode is disabled and the device remains continually active. The SM command allows the device to run in a lower-power state and be configured in one of the eight settings.
  • Page 227 Configuration and commands Sleep commands You can only use this command if you use SM to select Cyclic Sleep or Serial Port Sleep mode settings; SM (Sleep Mode). Binary command 0x02 (2 decimal) Parameter range 0x10 – 0xFFFF [x 100 milliseconds] Default 0x64 (10 seconds) Bytes returned...
  • Page 228 Network configurations Network topologies Addressing Basic communications XBee®-PRO 900HP/XSC RF Modules...
  • Page 229: Network Topologies

    Network configurations Network topologies Network topologies The device supports three different network topologies: Point-to-point Point-to-multipoint Peer-to-peer Point-to-point networks This following section provides the RF communication type and RF mode for point-to-point networks. Definition Point-to-point means that an RF data link exists between two devices. Sample network profile (Broadcast communications) Use default values for all devices.
  • Page 230: Peer To Peer Networks

    Network configurations Network topologies Sample network profile (Broadcast communications) Note Assume default values for all parameters that are not in this list. These profiles do not reflect addressing implementations. Base: 1. Send MY 0 to set the source address to 0x00. 2.
  • Page 231: Addressing

    In Peer-to-peer networks, devices remain synchronized without the use of master/slave dependencies. Each device shares the roles of master and slave. Digi's peer-to-peer architecture features fast synch times (35 ms to synchronize devices) and fast cold start times (50 ms before transmission).
  • Page 232: Address Recognition

    Network configurations Basic communications Address recognition Transmissions can be addressed to a specific device or group of devices using the DT (Destination Address) and MK (Address Mask) parameters. The transmitting device dictates whether the packet is intended for a specific device (local address) or multiple devices (global address) by comparing the packet’s DT parameter to its own MK parameter.
  • Page 233: Repeater Mode

    Network configurations Basic communications Streaming Mode data flow Streaming Mode state diagram (TX Module) Events and processes in this mode are common to all of the other RF Modes. Note When the device is streaming data, RB and RO parameters are only observed on the first packet. After transmission begins, the TX event continues uninterrupted until the DI buffer is empty or it reaches the streaming limit (TT Command).
  • Page 234 Network configurations Basic communications Constraints Requires that each device have a unique MY (Source Address) parameter. System must introduce just one packet at a time to the network for transmission (256 bytes max). Each hop (H) decreases the network throughput by a factor of 1/(H+1). Additional repeaters add network redundancy without decreasing throughput.
  • Page 235 Network configurations Basic communications Configure remote nodes as destinations (MD = 4). This ensures that the remote node waits for the repeater traffic to subside before transmitting a response. The preceding configuration instructions reflect configuration for a Basic Broadcast Repeater system. To configure a Basic Addressed Repeater system, use the DT (Destination Address) parameter to assign unique addresses to each device in the network.
  • Page 236 Network configurations Basic communications of the original packet. To reduce collisions, both repeater and end node radios in a repeater network delay transmission of data shifted in the serial port allowing any repeaters within range to complete their retransmissions. The time for this delay is computed by the followinformula: Maximum Delay (ms) = L * DS DS = (((41(-100))/10)*RN)+RN+1 Where:...
  • Page 237: Acknowledged Mode

    Network configurations Basic communications Acknowledged mode Characteristics: Reliable delivery through positive acknowledgments for each packet Throughput, latency, and jitter vary depending on the quality of the channel and the strength of the signal. Recommended use: Acknowledge Mode configuration is appropriate when reliable delivery is required between modules.
  • Page 238 Network configurations Basic communications The device counts each packet only once toward TT, no matter how many times the packet is retransmitted. Subsequent packets in acknowledged mode are similar to those in streaming mode, with the addition of an acknowledgment between each packet, and the possibility of retransmissions. The device sends subsequent packets without an RF initializer, because the receiving devices are already synchronized to the transmitting device from the preceding packets and they remain synchronized for the duration of the transmission event.
  • Page 239 Network configurations Basic communications XBee®-PRO 900HP/XSC RF Modules...
  • Page 240 S3B hardware certifications Agency certifications - United States ISED (Innovation, Science and Economic Development Canada) Brazil ANATEL Mexico IFETEL IDA (Singapore) certification XBee®-PRO 900HP/XSC RF Modules...
  • Page 241: Agency Certifications - United States

    IMPORTANT: The XBee/XBee-PRO RF Module has been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment. IMPORTANT: OEMs must test final product to comply with unintentional radiators (FCC section 15.107 and 15.109) before declaring compliance of their final product to Part 15 of the FCC rules.
  • Page 242: Limited Modular Approval

    Final antenna installation and operating configurations of this transmitter including antenna gain and cable loss must not exceed the EIRP of the configuration used for calculating MPE. Grantee (Digi) must coordinate with OEM integrators to ensure the end-users and installers of products operating with the module are provided with operating instructions to satisfy RF exposure requirements.
  • Page 243: Portable Applications And Sar Testing

    S3B hardware certifications Agency certifications - United States Portable applications and SAR testing If the module will be used at distances closer than 20cm to all persons, the device may be required to undergo SAR testing. Co-location with other transmitting antennas closer than 20cm should be avoided.
  • Page 244: Fcc-Approved Antennas (900 Mhz)

    FCC-approved antennas (900 MHz) The antennas in the tables below have been approved for use with this device. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
  • Page 245 Cable loss or power reduction for S3B Part number Type Connector Gain Application device A09-F1 RPSMA 1.0 dBi Fixed Fiberglass Base Station A09-F2 RPSMA 2.1 dBi Fixed Fiberglass Base Station A09-F3 RPSMA 3.1 dBi Fixed Fiberglass Base Station A09-F4 RPSMA 4.1 dBi Fixed Fiberglass Base Station...
  • Page 246 Cable loss or power reduction for S3B Part number Type Connector Gain Application device A09-HSM-7 Straight half-wave RPSMA 3.0 dBi Fixed / Mobile A09-HASM-675 Articulated half-wave RPSMA 2.1 dBi Fixed/ Mobile 0dB A09-HABMM-P6I Articulated half-wave w/ 6” pigtail MMCX 2.1 dBi Fixed/ Mobile 0dB A09-HABMM-6- Articulated half-wave w/ 6”...
  • Page 247 Cable loss or power reduction for S3B Part number Type Connector Gain Application device A09-QHRN Miniature Helical Right Angle solder Permanent -1 dBi Fixed/ Mobile 0dB A09-QHSN Miniature Helical Right Angle solder Permanent -1 dBi Fixed/ Mobile 0dB A09-QHSM-2 2” Straight RPSMA 1.9 dBi Fixed/ Mobile 0dB...
  • Page 248 Cable loss or power reduction for S3B Part number Type Connector Gain Application device A09-M5SM Mag Mount RPSMA 5.1 dBi Fixed A09-M7SM Mag Mount RPSMA 7.1 dBi Fixed A09-M8SM Mag Mount RPSMA 8.1 dBi Fixed A09-M0TM Mag Mount RPTNC 0 dBi Fixed A09-M2TM Mag Mount...
  • Page 249 Cable loss or power reduction for S3B Part number Type Connector Gain Application device A09-Y14 10 Element Yagi 14.1 Fixed/ Mobile 1.8dB A09-Y14 12 Element Yagi 14.1 Fixed/ Mobile 1.8dB A09-Y15 13 Element Yagi 15.1 Fixed/ Mobile 2.8dB A09-Y15 15 Element Yagi 15.1 Fixed/ Mobile 2.8dB A09-Y6TM...
  • Page 250 Cable loss or power reduction for S3B Part number Type Connector Gain Application device A09-Y15TM 13 Element Yagi RPTNC 15.1 Fixed/ Mobile 2.8dB A09-Y15TM 15 Element Yagi RPTNC 15.1 Fixed/ Mobile 2.8dB...
  • Page 251: Fcc Publication 996369 Related Information

    FCC grant which includes significant extra testing and cost. If an embedded trace or chip antenna is desired, contact a Digi sales representative for information on how to engage with a lab to get the modified FCC grant.
  • Page 252 S3B hardware certifications Agency certifications - United States Part 15 Subpart B compliance testing is still required for the final host product. This testing is required for all end products. XBee-PRO 900HP RF Module Part 15 Subpart B compliance does not affirm the end product’s compliance.
  • Page 253: Ised (Innovation, Science And Economic Development Canada)

    S3B hardware certifications ISED (Innovation, Science and Economic Development Canada) ISED (Innovation, Science and Economic Development Canada) This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device.
  • Page 254: Brazil Anatel

    S3B hardware certifications Brazil ANATEL Brazil ANATEL XBee®-PRO 900HP/XSC RF Modules...
  • Page 255: Mexico Ifetel

    IDA (Singapore) certification Labeling The labeling of equipment is per Info-communications Development Authority of Singapore (Singapore IDA, www.ida.gov.sg/). This license is only for the Digi XB900HP radio and not the final product, so XBee®-PRO 900HP/XSC RF Modules...
  • Page 256: Frequency Band

    Singapore IDA. The license number is DA105737. Frequency band The available frequency band for Singapore is 920 MHz to 925 MHz. The Digi radio cannot interfere with other services and is not in a protected band. Antenna gain The maximum allowed antenna gain is 2.1 dBi, which is the gain of a dipole.
  • Page 257 Legacy S3B hardware certifications Agency certifications - United States ISED (Innovation, Science and Economic Development Canada) Brazil ANATEL XBee®-PRO 900HP/XSC RF Modules...
  • Page 258: Agency Certifications - United States

    Agency certifications - United States United States (FCC) The XBee-PRO XSC RF Modules comply with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. To fulfill FCC certification requirements, the OEM must comply with the following regulations: The system integrator must ensure that the text on the external label provided with this device is placed on the outside of the final product.
  • Page 259: Fcc Notices

    Final antenna installation and operating configurations of this transmitter including antenna gain and cable loss must not exceed the EIRP of the configuration used for calculating MPE. Grantee (Digi) must coordinate with OEM integrators to ensure the end-users and installers of products operating with the module are provided with operating instructions to satisfy RF exposure requirements.
  • Page 260: Fixed Base Station And Mobile Applications

    Agency certifications - United States Fixed base station and mobile applications Digi RF Modules are pre-FCC approved for use in fixed base station and mobile applications. When the antenna is mounted at least 20cm (8") from nearby persons, the application is considered a mobile application.
  • Page 261: Ised (Innovation, Science And Economic Development Canada)

    Legacy S3B hardware certifications ISED (Innovation, Science and Economic Development Canada) ISED (Innovation, Science and Economic Development Canada) This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device.
  • Page 262: Antenna Options: 900 Mhz Antenna Listings

    Antenna options: 900 MHz antenna listings The antennas in the tables below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
  • Page 263 Cable Loss or power reduction for S3B Connector Gain Part number Type Application device A09-F3 Fiberglass Base Station RPSMA Fixed A09-F4 Fiberglass Base Station RPSMA 4.1 dBi Fixed A09-F5 Fiberglass Base Station RPSMA 5.1 dBi Fixed A09-F6 Fiberglass Base Station RPSMA 6.1 dBi Fixed...
  • Page 264 Cable Loss or power reduction for S3B Connector Gain Part number Type Application device A09-HABMM-P61 Articulated half-wave w/6" pigtail MMCX 2-1 dBi Fixed/Mobile 0dB A09-HABMM-6- Articulated half-waAve w/6" pigtail MMCX 2-1 dBi Fixed/Mobile 0dB 2-1 dBi Fixed/Mobile 0dB A09-HBMM-P61 Straight half-wave w/6" pigtail MMCX A09-HRSM Right angle half-wave...
  • Page 265 Cable Loss or power reduction for S3B Connector Gain Part number Type Application device A09-QSPM-3 3" Straight screw mount Permanent 1.9 dBi Fixed/Mobile 0dB A09-QAPM-3 3" Articulated screw mount Permanent 1.9 dBi Fixed/Mobile 0dB A09-QAPM-3H 3" Articulated screw mount Permanent 1.9 dBi Fixed/Mobile 0dB A09-DPSM-P12F omni directional permanent mount w/12 ft...
  • Page 266 Cable Loss or power reduction for S3B Connector Gain Part number Type Application device A09-M7TM Mag mount RPTNC 7.1 dBi Fixed A09-M8TM Mag mount RPTNC 8.1 dBi Fixed Yagi antennas A09-Y6 2 Element Yagi 6.1 dBi Fixed/Mobile 0dB A09-Y7 3 Element Yagi 7.1 dBi Fixed/Mobile 0dB A09-Y8...
  • Page 267: Transmitters With Detachable Antennas

    Cable Loss or power reduction for S3B Connector Gain Part number Type Application device A09-Y6TM 2 Element Yagi RPTNC 6.1 dBi Fixed/Mobile 0dB A09-Y7TM 3 Element Yagi RPTNC 7.1 dBi Fixed/Mobile 0dB A09-Y8TM 4 Element Yagi RPTNC 8.1 dBi Fixed/Mobile 0dB A09-Y9TM 4 Element Yagi RPTNC...
  • Page 268: Detachable Antenna

    Le présent émetteur radio a été approuvé par Industrie Canada pour fonctionner avec les types d'antenne énumérés ci-dessous et ayant un gain admissible maximal et l'impédance requise pour chaque type d'antenne. Les types d'antenne non inclus dans cette liste, ou dont le gain est supérieur au gain maximal indiqué, sont strictement interdits pour l'exploitation de l'émetteur.
  • Page 269: Brazil Anatel

    Legacy S3B hardware certifications Brazil ANATEL Brazil ANATEL XBee®-PRO 900HP/XSC RF Modules...

This manual is also suitable for:

Xbee-pro s3b

Table of Contents