1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. XBee XR 900
  6. User manual

Digi XBee XR 900 User Manual

Rf module
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee® XR 900
RF Module
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee XR 900 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Digi XBee XR 900

Summary of Contents for Digi XBee XR 900

  • Page 1 Digi XBee® XR 900 RF Module User Guide...

  • Page 2: Trademarks And Copyright

    November 2022 Initial release. Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.
  • Page 3 To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (Digi XBee® XR 900 RF Module User Guide, 90002474 A) in the subject line of your email. Digi XBee® XR 900 RF Module User Guide...

  • Page 4: Table Of Contents

    Contents About the XBee XR 900 RF Module Applicable firmware and hardware Digi RF resources Safety instructions Safety instructions XBee modules Consignes de sécurité Modules XBee Configure the XBee XR 900 RF Module Configure the device using XCTU XBee bootloader...
  • Page 5 Power supply design Board layout Antenna performance Pin signals Pin signals for the surface-mount XBee XR 900 RF Module Pin signals for the micro-mount XBee XR 900 RF Module Pin signals for the through-hole XBee XR 900 RF Module Recommended pin connections...
  • Page 6 SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Networking Network identifiers Delivery methods Point-to-multipoint DigiMesh networking Broadcast addressing Unicast addressing Route discovery Routing Routers Digi XBee® XR 900 RF Module User Guide...
  • Page 7 Sleep coordinator sleep modes in the network Synchronization messages Become a sleep coordinator Set the sleep coordinator option Resolution criteria and selection option Commissioning Pushbutton option Overriding syncs Sleep guard times Auto-early wake-up sleep option Digi XBee® XR 900 RF Module User Guide...
  • Page 8 MR (Mesh Unicast Retries) NN (Network Delay Slots) AG (Aggregator Support) SE (Source Endpoint) DE (Destination Endpoint) CI (Cluster ID) Addressing commands SH (Serial Number High) SL (Serial Number Low) DH (Destination Address High) Digi XBee® XR 900 RF Module User Guide...
  • Page 9 UART pin configuration commands D6 (DIO6/RTS Configuration) D7 (DIO7/CTS Configuration) P3 (DIO13/DOUT Configuration) P4 (DIO14/DIN Configuration) SMT/MMT SPI interface commands P5 (DIO15/SPI_MISO Configuration) P6 (DIO16/SPI_MOSI Configuration) P7 (DIO17/SPI_SSEL Configuration) P8 (DIO18/SPI_CLK Configuration) P9 (DIO19/SPI_ATTN Configuration) Digi XBee® XR 900 RF Module User Guide...
  • Page 10 Diagnostic commands – firmware/hardware Information VR (Firmware Version) VH (Bootloader Version) HV (Hardware Version) %C (Hardware/Software Compatibility) %V (Voltage Supply Monitoring) DD (Device Type Identifier) NP (Maximum Packet Payload Bytes) CK (Configuration CRC) %P (Invoke Bootloader) Digi XBee® XR 900 RF Module User Guide...
  • Page 11 Reserved profile IDs Transmit options bit field Examples Remote AT Command Request - 0x17 Description Format Examples Secure Session Control - 0x2E Description Format Examples 64-bit Receive Packet - 0x80 Description Format Examples Digi XBee® XR 900 RF Module User Guide...
  • Page 12 Node Identification Indicator - 0x95 Description Format Examples Remote AT Command Response- 0x97 Description Format Examples Extended Modem Status - 0x98 Description Format Secure Session status codes Examples Secure Session Response - 0xAE Description Format Examples Digi XBee® XR 900 RF Module User Guide...
  • Page 13 ISED (Innovation, Science and Economic Development Canada) ISED-approved antennas Labeling requirements Transmitters for detachable antennas Detachable antennas RF exposure ACMA (Australia) Power requirements RSM (New Zealand) Power requirements Module support Custom defaults Set custom defaults Restore factory defaults Limitations Digi XBee® XR 900 RF Module User Guide...
  • Page 14 Manufacturing information Recommended solder reflow cycle Handling and storage Recommended footprint Surface-mount recommended footprint XBee XR Micro recommended footprint Flux and cleaning Reworking Digi XBee® XR 900 RF Module User Guide...

  • Page 15: About The Xbee Xr 900 Rf Module

    About the XBee XR 900 RF Module Applicable firmware and hardware Digi RF resources Digi XBee® XR 900 RF Module User Guide...

  • Page 16: Applicable Firmware And Hardware

    This user guide supports the following firmware: v.90xx It supports the following hardware: XBee XR 900 Digi RF resources There are many resources to further your understanding of Digi's RF devices. You can: Read the XBee Buying Guide. Ask questions on the Digi Support Forum.

  • Page 17: Safety Instructions

    Safety instructions Safety instructions Consignes de sécurité Digi XBee® XR 900 RF Module User Guide...

  • Page 18: Safety Instructions

    Utilisez la protection ESD standard de l'industrie lors de la manipulation du module XBee. Soyez prudent lors de la manipulation afin d'éviter des dommages électriques au circuit imprimé et aux composants. N'exposez pas les modules radio XBee à l'eau ou à l'humidité. Digi XBee® XR 900 RF Module User Guide...
  • Page 19 Utilisez ce produit avec les antennes spécifiées dans les guides d'utilisation du module XBee. L'utilisateur final doit savoir comment couper l'alimentation du module radio XBee ou placer les antennes à 26 cm des humains ou des animaux. Digi XBee® XR 900 RF Module User Guide...

  • Page 20: Configure The Xbee Xr 900 Rf Module

    Configure the XBee XR 900 RF Module Configure the device using XCTU XBee bootloader Send a firmware image Software libraries XBee Network Assistant XBee Multi Programmer Digi XBee® XR 900 RF Module User Guide...

  • Page 21: Configure The Device Using Xctu

    XCTU User Guide XBee bootloader You can update firmware on the XBee XR 900 RF Module serially. This is done by invoking the XBee bootloader and transferring the firmware image using XMODEM. This process is also used for updating a local device's firmware using XCTU.

  • Page 22: Software Libraries

    Software libraries One way to communicate with the XBee XR 900 RF Module is by using a software library. The libraries available for use with the XBee XR 900 RF Module include: XBee Java library XBee Python library The XBee Java Library is a Java API.

  • Page 23: 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 24: Specifications

    Specifications The following tables provide general specifications for the hardware. Power, sensitivity, and performance specifications Serial interface specifications RF communications specifications General specifications Electrical characteristics Regulatory conformity summary Electro Static Discharge (ESD) Digi XBee® XR 900 RF Module User Guide...

  • Page 25: Power, Sensitivity, And Performance Specifications

    Digi XBee® XR 900 RF Module User Guide...

  • Page 26: Serial Interface Specifications

    921,600 Non-standard 967,680 SPI Timing Unit SCLK Speed SCLK Period SCLK SCLK High Time SCLK_HI SCLK Low Time SCLK_LO SSEL to MISO Active * SS_A_MI SSEL to MISO Disabled SS_D_MI MOSI Setup Time 12.5 S_MO MOSI Hold Time H_MO SCLK Edge to MISO Update SCLK_MI Digi XBee® XR 900 RF Module User Guide...
  • Page 27 Specifications Serial interface specifications Digi XBee® XR 900 RF Module User Guide...

  • Page 28: Rf Communications Specifications

    We estimate rural ranges based on a 14.5 km (9 mi) range test with dipole antennas. Range estimated assuming that the urban noise floor is approximately 15 dB higher than rural. The actual range depends on the setup and level of interference in your location. Digi XBee® XR 900 RF Module User Guide...
  • Page 29 Specifications RF communications specifications Specification Condition XBee value XBee-PRO value Receiver RF Below 900 MHz and above > 50 dB selectivity 930 MHz Digi XBee® XR 900 RF Module User Guide...

  • Page 30: General Specifications

    3.0 grams TH RPSMA weight 6.1 grams TH U.FL weight 3.0 grams Operating temperature -40 to 85 °C (industrial) RF pad, chip antenna, or U.FL connector Antenna options Analog-to-digital converter 4 10-bit analog inputs (ADC) Digi XBee® XR 900 RF Module User Guide...

  • Page 31: Electrical Characteristics

    Electrical characteristics The following table lists the electrical characteristics for the XBee XR 900 RF Module. XBee XR 900 RF Modules have 15 General Purpose Input / Output (GPIO) ports available. The exact list depends on the device configuration as some GPIO pads are used for purposes such as serial communication.

  • Page 32: Regulatory Conformity Summary

    Regulatory conformity summary XBee XR 900 RF Module Approval ID number FCC (USA) FCC ID: MCQ-XB9XR ISED (Canada) IC: 1846A-XB9XR Australia New Zealand Brazil Europe UKCA...

  • Page 33: Electro Static Discharge (Esd)

    Specifications Electro Static Discharge (ESD) Electro Static Discharge (ESD) XBee XR 900 RF Module pins are tolerant to human-body model ± 1.0 kV. Note Take care to limit all electrostatic discharges to the device. Digi XBee® XR 900 RF Module User Guide...

  • Page 34: Secure Access

    Secure access By default, the XBee XR 900 RF Module is easy to configure and allows for rapid prototyping. For deployment, you can encrypt networks to prevent unauthorized access. This can prevent entities outside of the network from accessing data on that network. Some customers may also desire a way to restrict communication between nodes from inside the same network.

  • Page 35: Secure Sessions

    (not a broadcast address), the options bit field set to 0x00, the timeout for the session, and the password that was previously set on the server. Digi XBee® XR 900 RF Module User Guide...

  • Page 36: End A Secure Session

    In this example, the password is pickle. 1. The salt is randomly generated and the verifier is derived from the salt and password as follows: *S = 0x1938438E *V = 0x0771F57C397AE4019347D36FD1B9D91FA05B2E5D7365A161318E46F72942A45D *W = 0xD4E44C664B5609C6D2BE3258211A7A20374FA65FC7C82895C6FD0B3399E7377 Digi XBee® XR 900 RF Module User Guide...

  • Page 37: Remotely Configure A Node That Has Been Secured

    7E 00 12 2E 00 13 A2 00 41 7B 21 62 00 0B B8 70 69 63 6B 6C 65 A2 3. Wait for a Secure Session Response - 0xAE to indicate the session establishment succeeded or failed with the reason. Digi XBee® XR 900 RF Module User Guide...

  • Page 38: Send Data To A Secured Remote Node

    1. Send a Secure Session Control - 0x2E to the server node with: The client's 64-bit address. The options field set to 0x02 for server side session termination. Set the timeout to 0x0000. Digi XBee® XR 900 RF Module User Guide...

  • Page 39: Secure Session Api Frames

    These frames will contain the status that caused them to be emitted as well as the address of the node that initiated the session, the session options, and the timeout value. Frame exchanges: Digi XBee® XR 900 RF Module User Guide...

  • Page 40: Secure Transmission Failures

    0x0C Encryption Error There was an internal encryption error on the radio. 0x0D TO Bit Not Set The client has a session with the server but forgot to set the TO bit. Digi XBee® XR 900 RF Module User Guide...

  • Page 41: Xbib-C Development Boards

    XBIB-C development boards This section describes the XBIB-C development boards and how to interact with them. XBIB-C Micro Mount reference Attach the XBee XR 900 RF Module Digi XBee® XR 900 RF Module User Guide...

  • Page 42: Xbib-C Micro Mount Reference

    This board is sold separately. WARNING! Connecting one pin off will destroy the unit under test! Always disconnect USB and power before changing one unit for another. See the following images for examples. Incorrect Digi XBee® XR 900 RF Module User Guide...

  • Page 43: Correct

    XBIB-C development boards XBIB-C Micro Mount reference Correct Digi XBee® XR 900 RF Module User Guide...
  • Page 44 XBIB-C development boards XBIB-C Micro Mount reference Digi XBee® XR 900 RF Module User Guide...
  • Page 45 Pin 1: I2C_CLK/XBee DIO1 Pin2: I2C_SDA/XBee DIO11 Pin3: VCC Pin4: GND Temp/Humidity This as a Texas Instruments HDC1080 temperature and humidity Sensor sensor. This part is accessible through I2C. Be sure that the XBee Digi XBee® XR 900 RF Module User Guide...

  • Page 46: Attach The Xbee Xr 900 Rf Module

    WARNING! Make sure the board is NOT powered when you plug in the XBee XR 900 RF Module. Never insert or remove the XBee XR 900 RF Module while the power is on! Make sure the XBee XR 900 RF Module is oriented correctly and not upside down when you attach it to the board.

  • Page 47: Design Notes

    Design notes XBee XR 900 RF 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 Board layout Antenna performance Digi XBee®...

  • Page 48: Power Supply Design

    To help reduce noise, place a 1.0 µF and 47 pF capacitor as near as possible to the VCC connection on the XBee XR 900 RF Module (pad 2 for micro and surface-mount, and pin 1 for through-hole). Adding a 10 µF decoupling capacitor is also recommended.
  • Page 49 Design notes Antenna performance For the best results, mount the device at the edge of the host PCB. Ensure that the ground, power, and signal planes are vacant immediately below the antenna section. Digi XBee® XR 900 RF Module User Guide...

  • Page 50: Pin Signals

    Pin signals Pin signals for the surface-mount XBee XR 900 RF Module Pin signals for the micro-mount XBee XR 900 RF Module Pin signals for the through-hole XBee XR 900 RF Module Recommended pin connections Connect the UART for flow control...

  • Page 51: Pin Signals For The Surface-Mount Xbee Xr 900 Rf Module

    Pin signals Pin signals for the surface-mount XBee XR 900 RF Module Pin signals for the surface-mount XBee XR 900 RF Module The following drawing shows the surface-mount (SMT) pin locations. The following table shows the pin signals and their descriptions for the surface-mount device.
  • Page 52 Pin signals Pin signals for the surface-mount XBee XR 900 RF Module Pin# Name Direction Default state Description /DIO8 Line/GPIO. Ground. Serial peripheral SPI_ATTN/ Output Output interface attention . BOOTMODE/DIO19 Do not tie low on reset. Ground. SPI_CLK /DIO18 Input...
  • Page 53 Pin signals Pin signals for the surface-mount XBee XR 900 RF Module Pin# Name Direction Default state Description RTS/DIO6 Both Input Request to send flow control /GPIO. AD3/DIO3 Both Disabled Analog input/GPIO. AD2/DIO2 Both Disabled Analog input/GPIO AD1/DIO1/I2C SCL Both...

  • Page 54: Pin Signals For The Micro-Mount Xbee Xr 900 Rf Module

    Pin signals for the micro-mount XBee XR 900 RF Module Pin signals for the micro-mount XBee XR 900 RF Module The following drawing shows the micro pin locations. The following table shows the pin signals and their descriptions for the XBee XR 900 RF Module device. Default...
  • Page 55 Pin signals Pin signals for the micro-mount XBee XR 900 RF Module Default Pin# Name Direction state Description Ground. Serial peripheral SPI_ATTN/ BOOTMODE/DIO19 Output Output interface attention Do not tie low on reset. Ground. SPI_CLK /DIO18 Input Input Serial peripheral interface clock/GPIO.
  • Page 56 Pin signals Pin signals for the micro-mount XBee XR 900 RF Module Default Pin# Name Direction state Description AD2/DIO2 Both Disabled Analog input/GPIO. AD1/DIO1/I2C SCL Both Disabled Analog input/GPIO/I2C SCL. AD0 /DIO0 Both Input Analog input / GPIO / Commissioning button.

  • Page 57: Pin Signals For The Through-Hole Xbee Xr 900 Rf Module

    Pin signals for the through-hole XBee XR 900 RF Module Pin signals for the through-hole XBee XR 900 RF Module The following drawing shows the through-hole pin locations. The following table shows the pin signals and their descriptions for the XBee XR 900 RF Module though-hole device. Default...

  • Page 58: Recommended Pin Connections

    Connect the UART for flow control The RS-232 and UART specification has been around for a long time. Despite its longevity, confusion remains about how to connect pinouts. There are two different types of communication devices: Digi XBee® XR 900 RF Module User Guide...
  • Page 59 RTS and CTS. Below are some diagrams on how to connect RS- 232/UARTs in general as well as with Digi XBee products. There are other signal lines, like DTR, DSR and DCD which have loose definitions of the original use, but these often are used as other signals and are not uniform across the market.
  • Page 60 Pin signals Connect the UART for flow control Digi XBee® XR 900 RF Module User Guide...
  • Page 61 Pin signals Connect the UART for flow control Digi XBee® XR 900 RF Module User Guide...
  • Page 62 Pin signals Connect the UART for flow control Digi XBee® XR 900 RF Module User Guide...

  • Page 63: Mechanical Drawings

    Mechanical drawings The following mechanical drawings of the XBee XR 900 RF Modules show all dimensions in inches. XBee XR 900 RF Module surface-mount antennas XBee XR 900 RF Module through-hole antennas XBee XR 900 RF Module micro antennas Copper keepout for test points...

  • Page 64: Xbee Xr 900 Rf Module Surface-Mount Antennas

    XBee XR 900 RF Module surface-mount antennas XBee XR 900 RF Module surface-mount antennas The following mechanical drawings are for the XBee XR 900 RF Module surface-mount antennas. XBee XR 900 RF Module surface-mount - U.FL/RF pad antenna Digi XBee® XR 900 RF Module User Guide...

  • Page 65: Xbee Xr 900 Rf Module Surface-Mount - Embedded Antenna

    Mechanical drawings XBee XR 900 RF Module surface-mount antennas XBee XR 900 RF Module surface-mount - embedded antenna Digi XBee® XR 900 RF Module User Guide...

  • Page 66: Xbee Xr 900 Rf Module Through-Hole Antennas

    XBee XR 900 RF Module through-hole antennas XBee XR 900 RF Module through-hole antennas The following mechanical drawings are for the XBee XR 900 RF Module through-hole antennas. XBee XR 900 RF Module through-hole - PCB antenna XBee XR 900 RF Module through-hole - U.FL antenna...

  • Page 67: Xbee Xr 900 Rf Module Through-Hole - Rpsma Antenna

    Mechanical drawings XBee XR 900 RF Module through-hole antennas XBee XR 900 RF Module through-hole - RPSMA antenna Digi XBee® XR 900 RF Module User Guide...

  • Page 68: Xbee Xr 900 Rf Module Micro Antennas

    Mechanical drawings XBee XR 900 RF Module micro antennas XBee XR 900 RF Module micro antennas The following mechanical drawing is for theXBee XR 900 RF Module micro antennas. U.FL/RF Pad Copper keepout for test points The following keepouts are required for all surface-mount or micro-mount devices. These keepouts are in addition to the other keepouts if using a PCB or chip antenna.
  • Page 69 Mechanical drawings Copper keepout for test points Copper keepout for the XBee XR Digi XBee® XR 900 RF Module User Guide...

  • Page 70: Modes

    Modes Transparent operating mode API operating mode Command mode Transmit mode Receive mode Digi XBee® XR 900 RF Module User Guide...

  • Page 71: Transparent Operating Mode

    AT commands. When you want to read or set any parameter of the XBee XR 900 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.

  • Page 72: Troubleshooting

    AC (Apply Changes). Parameter format Refer to the list of AT commands for the format of individual AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF. Digi XBee® XR 900 RF Module User Guide...

  • Page 73: Response To At Commands

    Receive mode This is the default mode for the XBee XR 900 RF Module. The device is in Receive mode when it is neither transmitting data nor sleeping. If a destination node receives a valid RF data packet, the destination node transfers the data to its serial transmit buffer.
  • Page 74 Monitor I/O lines I/O sample data format API frame support On-demand sampling Periodic I/O sampling Digital I/O change detection I/O line passing Digital line passing Output sample data I/O behavior during sleep Digi XBee® XR 900 RF Module User Guide...

  • Page 75: Digital I/O Support

    4 is digital output low. 5 is digital output high. Analog I/O support Analog input is available on D0 through D3. Configure these pins to 2 (ADC) to enable analog sampling. Digi XBee® XR 900 RF Module User Guide...

  • Page 76: Monitor I/O Lines

    (IC (DIO Change Detect)) Samples are generated when the state of specified digital input pin(s) change Sample data is sent to DH+DL destination address Can be used with line passing Requires API mode on receiver Digi XBee® XR 900 RF Module User Guide...

  • Page 77: I/O Sample Data Format

    ERROR. On-demand sampling can be useful when performing initial deployment, as you can send IS locally to verify that the device and connected sensors are correctly configured. The format of the sample Digi XBee® XR 900 RF Module User Guide...

  • Page 78: Example: Command Mode

    This ID corresponds to the Frame ID of the 0x08 request 49 53 Indicates the AT command that this response corresponds to 0x49 0x53 = IS Command Status Indicates success or failure of the AT command 00 = OK Digi XBee® XR 900 RF Module User Guide...

  • Page 79: Example: Remote At Command In Api Mode

    Indicates the AT command that this response corresponds to 0x49 0x53 = IS Command Status Indicates success or failure of the AT command 00 = OK if no I/O lines are enabled, this will return 01 (ERROR) Digi XBee® XR 900 RF Module User Guide...

  • Page 80: Periodic I/O Sampling

    In the top graph, the humps indicate that the sample was not taken at that exact moment and needed to wait for the next IR sample period. Digi XBee® XR 900 RF Module User Guide...

  • Page 81: I/O Line Passing

    Digital line passing is only available on pins D0 through P2. You cannot use UART and SPI pins for line passing. Example: Digital line passing A sampling XBee XR 900 RF Module is configured with the following settings (where DH/DL specifies the address of the node that outputs the the inputs from the sampling node): AT command...

  • Page 82: Output Sample Data

    Digital I/O lines that have been set using I/O line passing hold their values during sleep, however the digital timeout timer (T0 through T9, and Q0 through Q2) are suspended during sleep and resume upon wake. Digi XBee® XR 900 RF Module User Guide...

  • Page 83: Serial Communication

    Serial communication Serial interface Serial receive buffer Serial transmit buffer UART operation Digi XBee® XR 900 RF Module User Guide...

  • Page 84: Serial Interface

    UART operation Devices that have a UART interface connect directly to the pins of the XBee XR 900 RF Module as shown in the following figure. The figure shows system data flow in a UART-interfaced environment.

  • Page 85: Clear-To-Send (Cts) Flow Control

    UART operation Flow control The XBee XR 900 RF Module maintains buffers to collect serial and RF data that it receives. The serial receive buffer collects incoming serial characters and holds them until the device can process them. The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial port.
  • Page 86 UART operation You can configure the UART baud rate, parity, and stop bits settings on the device with the BD, NB, and SB commands respectively. For more information, see UART interface commands. Digi XBee® XR 900 RF Module User Guide...

  • Page 87: Spi Operation

    SPI communications The XBee XR 900 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.

  • Page 88: Full Duplex Operation

    XBee development evaluation boards included in the development kit. Full duplex operation When using SPI on the XBee XR 900 RF Module the device uses API operation without escaped characters to packetize data. The device ignores AP configuration because SPI does not operate in any other mode.

  • Page 89: Select The Spi Port

    1) at the time of reset, then output goes to the UART until the host sends the first input to the SPI interface. As soon as the first input comes on the SPI port, then all subsequent output goes to the SPI port and the UART is disabled. Digi XBee® XR 900 RF Module User Guide...

  • Page 90: Force Uart Operation

    Command mode on the UART port. You can then send the appropriate commands to the device to configure it for UART operation. If you write those parameters, the device comes up with the UART enabled on the next reset. Digi XBee® XR 900 RF Module User Guide...

  • Page 91: Networking

    Networking Network identifiers Delivery methods DigiMesh networking Repeater/directed broadcast Encryption Maximum payload Digi XBee® XR 900 RF Module User Guide...

  • Page 92: Network Identifiers

    Transparent mode. In API mode, the TxOptions field of the API frame overrides the TO command, if non-zero. The XBee XR 900 RF Module supports three delivery methods: Point-to-multipoint (TO = 0x40). Repeater (directed broadcast) (TO = 0x80).

  • Page 93: Broadcast Addressing

    The broadcast address is a 64 bit address with the lowest 16 bits set to 1. The upper bits are set to 0. To send a broadcast transmission: Set DH to 0. Set DL to 0xFFFF. In API operating mode, this sets the destination address to 0x000000000000FFFF. Digi XBee® XR 900 RF Module User Guide...

  • Page 94: Unicast Addressing

    A device sends a message to the next hop address, and the message either reaches its destination or forwards to an intermediate router that routes the message on to its destination. Digi XBee® XR 900 RF Module User Guide...

  • Page 95: Routers

    + 1 times. Encryption The XBee XR 900 RF Module supports 256-bit keys and AES encryption. CTR mode encryption is the default. You can use the C8 command to specify ECB encryption with a 128-bit key for compatibility with older products.

  • Page 96: Network Commissioning And Diagnostics

    Local configuration Remote configuration Build aggregate routes RSSI indicators Associate LED The Commissioning Pushbutton Node discovery Digi XBee® XR 900 RF Module User Guide...

  • Page 97: Local Configuration

    1. The status of the command, which is either success or the reason for failure. 2. In the case of a command query, it includes the register value. The device that sends a remote command does not receive a remote command response frame if: Digi XBee® XR 900 RF Module User Guide...

  • Page 98: Build Aggregate Routes

    1. Send the ATAGFFFE command to the aggregator node. This sends an AG broadcast to all of the nodes in the network. None of the nodes in the network will update DH/DL because none of the will have DH/DL set to 0xFFFE. Digi XBee® XR 900 RF Module User Guide...

  • Page 99: Replace Nodes

    The number of packets to send. This must be a number between 1 and 4000. 4. Device B should transmit test link packets. 5. When device B completes transmitting the test link packets, it sends the following data Digi XBee® XR 900 RF Module User Guide...
  • Page 100 = -82 dBm. If the Result field does not equal zero, an error has occurred. Ignore the other fields in the packet. If the Success field equals zero, ignore the RSSI fields. Digi XBee® XR 900 RF Module User Guide...

  • Page 101: Trace Route Option

    D transmits a Route Information Packet frame to device A (through device C and device B). When device A receives the Route Information packet, it outputs it over its serial interface. Digi XBee® XR 900 RF Module User Guide...

  • Page 102: Nack Messages

    On, blinking The device has power and is operating properly 1, 4, 5 The device is asleep 1, 4, 5 On, blinking The device has power, is awake and is operating properly Digi XBee® XR 900 RF Module User Guide...

  • Page 103: The Commissioning Pushbutton

    The Commissioning Pushbutton The Commissioning Pushbutton The XBee XR 900 RF Module supports a set of commissioning and LED functions to help you deploy and commission devices. These functions include the Commissioning Pushbutton definitions and the associated LED functions. The following diagram shows how the hardware can support these features.

  • Page 104: Use The Commissioning Pushbutton

    When a device receives the network discovery command, it waits a random time before sending its own response. You can use the NT command to set the maximum time delay on the device that you use to send the ND command. Digi XBee® XR 900 RF Module User Guide...

  • Page 105: Directed Node Discovery

    The FN (Find Neighbor) command works the same as the ND (Node Discovery) except that it is limited to neighboring devices (devices that are only one hop away). See FN (Find Neighbors) details. Digi XBee® XR 900 RF Module User Guide...
  • Page 106 If you sent FN remotely, the target devices respond directly to the device that sent the FN command. The device that sends FN outputs a response packet in the same format as an Local AT Command Response - 0x88. Digi XBee® XR 900 RF Module User Guide...

  • Page 107: Sleep Support

    Synchronization messages Become a sleep coordinator Select sleep parameters Sleep immediate Start a sleeping synchronous network Add a new node to an existing network Change sleep parameters Rejoin nodes that lose sync Diagnostics Digi XBee® XR 900 RF Module User Guide...

  • Page 108: Sleep Modes

    SPI_SSEL for sleep control while communicating on the UART, SPI pins—P5, P6, and P8—must not be set to 1 (peripheral). See Low power operation for information on using SPI_SSEL for sleep control while communicating over SPI. Digi XBee® XR 900 RF Module User Guide...

  • Page 109: Asynchronous Cyclic Sleep Mode (Sm = 4)

    The Cyclic Sleep modes allow devices to periodically check for RF data. When the SM parameter is set to 4, the XBee XR 900 RF Module is configured to sleep, then wakes once per cycle to check for data from a coordinator. The Cyclic Sleep Remote sends a poll request to the coordinator at a...

  • Page 110: Synchronous Sleep Support Mode (Sm = 7)

    The following AT commands are associated with the sleep modes. See the linked commands for the parameter's description, range and default values. SM (Sleep Mode) SN (Number of Sleep Periods) SO (Sleep Options) ST (Cyclic Sleep Wake Time) SP (Cyclic Sleep Period) WH (Wake Host Delay) Digi XBee® XR 900 RF Module User Guide...

  • Page 111: Sleep Pins

    In addition, the wake time is extended by an additional ST time when new OTA data or serial data is received. 2. Sleep Request pin is not asserted when operating in pin sleep mode 3. Data is waiting to be sent OTA. Digi XBee® XR 900 RF Module User Guide...

  • Page 112: The Sleep Timer

    When a polling device is also an asynchronous sleeping device, that device sends a poll shortly after waking from sleep. After that first poll is sent, the device sends polls in the normal manner described previously until it returns to sleep. Digi XBee® XR 900 RF Module User Guide...

  • Page 113: Sleep Coordinator Sleep Modes In The Network

    The following diagram illustrates the synchronization behavior of sleep compatible devices. Digi XBee® XR 900 RF Module User Guide...
  • Page 114 Sleep support Synchronization messages Digi XBee® XR 900 RF Module User Guide...

  • Page 115: Become A Sleep Coordinator

    Pushbutton option. Note that when SP and/or ST is changed, it increments the sequence number such that it sends the newest sync message and it has priority to become the sleep coordinator. Digi XBee® XR 900 RF Module User Guide...

  • Page 116: Commissioning Pushbutton Option

    As a node misses more and more consecutive sync messages, the sleep guard time increases in duration and decreases the available transmission time. Digi XBee® XR 900 RF Module User Guide...

  • Page 117: Auto-Early Wake-Up Sleep Option

    Budget a large enough ST time to allow for the device to miss a few sync messages and still have time for normal data transmissions. Digi XBee® XR 900 RF Module User Guide...

  • Page 118: Sleep Immediate

    Commissioning Pushbutton twice. This causes the node to begin emitting sync messages. 3. Verify that the first node is emitting sync messages by watching its associate LED. A slow blink indicates that the node is acting as a sleep coordinator. Digi XBee® XR 900 RF Module User Guide...

  • Page 119: Add A New Node To An Existing Network

    That node broadcasts an overriding sync to the network to advertise the new sleep cycle. That node nominates itself to become the sleep coordinator. That node will remain the sleep coordinator unless another node in the network designates Digi XBee® XR 900 RF Module User Guide...

  • Page 120: Rejoin Nodes That Lose Sync

    6. The subnets will now be in sync. You can remove the sleep support node. 7. You can also change the sleep cycle settings back to the previous settings. If you only need to replace a few nodes, you can use this method: Digi XBee® XR 900 RF Module User Guide...

  • Page 121: Diagnostics

    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. Digi XBee® XR 900 RF Module User Guide...
  • Page 122 UART interface commands AT Command options UART pin configuration commands SMT/MMT SPI interface commands I/O settings commands I/O sampling commands I/O line passing commands Diagnostic commands – firmware/hardware Information Custom Default commands Digi XBee® XR 900 RF Module User Guide...

  • Page 123: Memory Access Commands

    Immediately writes parameter values to non-volatile flash memory so they persist through a power cycle. Operating network parameters are persistent and do not require a WR command for the device to reattach to the network. Digi XBee® XR 900 RF Module User Guide...

  • Page 124: Mac/Phy Commands

    DR changes must be applied to be effective, whether for receiving data, doing an energy detect, or doing LBT before a transmission. Whatever DR does to the LNA applies in all cases until it is changed again. Parameter range 0 - 2 Digi XBee® XR 900 RF Module User Guide...

  • Page 125: Ed (Energy Detect)

    This command returns a bitfield. Each bit corresponds to a physical channel. Note that the least significant bit in the bitmask selects the channel in the lowest frequency in the range. Digi XBee® XR 900 RF Module User Guide...

  • Page 126: Cm (Channel Mask)

    Default Default CM when BR is 0 or 1 Default CM when BR is 2 0x05 5555 5555 5555 5555 5555 5555 0x00 0000 0000 0003 FFFF FFFF FFFF Digi XBee® XR 900 RF Module User Guide...

  • Page 127: Br (Rf Data Rate)

    ID, as it is encoded in the preamble, and the network ID is encoded in the MAC header. Parameter range 0 - 9 (usually) 0 - 7 (For some regions and values of BR. See BR (RF Data Rate) for details.) Digi XBee® XR 900 RF Module User Guide...

  • Page 128: Rr (Unicast Mac Retries)

    0 - 0xFFFFFFFF Default N/A (0 after reset) DB (Last Packet RSSI) Reports the RSSI in -dBm of the last received RF data packet. DB returns a hexadecimal value for -dBm measurement. Digi XBee® XR 900 RF Module User Guide...

  • Page 129: Gd (Good Packets Received)

    If the XBee XR 900 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 130: Ua (Unicasts Attempted Count)

    The time to send a broadcast between two nodes in the network should not exceed the product of the broadcast one hop time (%8) and the number of hops between those two nodes. Parameter range [read-only] Default Digi XBee® XR 900 RF Module User Guide...

  • Page 131: Networking Commands

    CBC mode and should be used when backwards compatibility is not needed. All other bits should be 0 for future compatibility. Meaning Setting Description When encryption is enabled, AES Counter mode is used with a 256-bit key. compatibility Digi XBee® XR 900 RF Module User Guide...

  • Page 132: Bh (Broadcast Hops)

    Set or read the maximum random number of network delay slots before rebroadcasting a network packet. %8 (MAC Broadcast One Hop Time) to get the timing for a network delay slot. Parameter range 1 - 5 Digi XBee® XR 900 RF Module User Guide...

  • Page 133: Ag (Aggregator Support)

    This command only affects outgoing transmissions in Transparent mode (AP = 0). Note Endpoints 0xDC - 0xEE are reserved for special use by Digi and should not be used in an application outside of the listed purpose. The reserved Digi endpoints are:...

  • Page 134: Ci (Cluster Id)

    0x0013A200 - 0x0013A2FF [read-only] Default Set in the factory SL (Serial Number Low) This value is read-only and it never changes. Parameter range 0 - 0xFFFFFFFF [read-only] Default Set in the factory Digi XBee® XR 900 RF Module User Guide...

  • Page 135: Dh (Destination Address High)

    The node identifier is a user-defined name or description of the device. Use this string with network discovery commands in order to easily identify devices on the network. Use the ND (Network Discover) command with this string as an argument to filter network discovery results. Digi XBee® XR 900 RF Module User Guide...

  • Page 136: Nt (Network Discovery Back-Off)

    Use NO to suppress or include a self-response to ND (Node Discover) commands. When NO bit 1 = 1, a device performing a Node Discover includes a response entry for itself. Bit field: 0x0 - 0x7 (bit field) Digi XBee® XR 900 RF Module User Guide...

  • Page 137: Discovery Commands

    AT commands Discovery commands Meaning Append the DD (Digi Device Identifier) value to ND responses or API node identification frames. Local device sends ND response frame out the serial interface when ND is issued. Append the RSSI of the last hop to ND, FN, and responses or API node identification frames.

  • Page 138: Nd (Network Discover)

    PROFILE_ID<CR> (2 bytes) 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.) If you send the ND command in Command mode, after (NT*100) ms + overhead time, the command ends by returning a carriage return, represented by <CR>.

  • Page 139: Security Commands

    DEVICE_TYPE<CR> (1 Byte: 0 = Coordinator, 1 = Router, 2 = End Device) STATUS<CR> (1 Byte: Reserved) PROFILE_ID<CR> (2 Bytes) MANUFACTURER_ID<CR> (2 Bytes) DIGI DEVICE TYPE<CR> (4 Bytes. Optionally included based on NO (Network Discovery Options) settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on...

  • Page 140: Secure Session Commands

    *S (Secure Session Salt) The Secure Remote Password (SRP) Salt is a 32-bit number used to create an encrypted password for the XBee XR 900 RF Module. The *S command contains the salt value in the salt/verifier pair used for secure session authentication.

  • Page 141: V, *W, *X, *Y (Secure Session Verifier)

    Asynchronous cyclic sleep with pin wakeup Unused Synchronous sleep support mode Synchronous cyclic sleep Default SO (Sleep Options) A bitfield that contains advanced sleep options that do not have dedicated AT commands. Digi XBee® XR 900 RF Module User Guide...

  • Page 142: Sn (Number Of Sleep Periods)

    The coordinator will hold the message for (2.5 * SP). Parameter range 0x0 - 0x15F900 (x 10 ms) (4 hours) Default 0x12C (3 seconds) Digi XBee® XR 900 RF Module User Guide...

  • Page 143: St (Cyclic Sleep Wake Time)

    This bit is true if you alter the sleep settings on the device so that the node nominates itself and sends a sync message with the new settings at the beginning of the next wake cycle. Digi XBee® XR 900 RF Module User Guide...

  • Page 144: Os (Operating Sleep Time)

    If the device synchronizes with a sleeping router network, OW may differ from ST. Parameter range Default MS (Missed Sync Messages) Reads the number of sleep or wake cycles since the device received a sync message. Parameter range Default Digi XBee® XR 900 RF Module User Guide...

  • Page 145: Sq (Missed Sleep Sync Count)

    The device does not actually calculate and check the parity. It only interfaces with devices at the configured parity and stop bit settings for serial error detection. Parameter range 0 - 2 Parameter Description No parity Even parity Odd parity Default Digi XBee® XR 900 RF Module User Guide...

  • Page 146: Sb (Stop Bits)

    CTS is not toggling rapidly when close to FT bytes are in the UART receive buffer. Parameter range 0x47 - 0x3B9 bytes Default 0x2F6 AP (API Enable) Parameter range 0 - 2 Digi XBee® XR 900 RF Module User Guide...

  • Page 147: Ao (Api Options)

    Unused bits must be set to 0. These bits may be logically OR'ed together: Description Reserved Reserved Reserved Output Extended Modem Status (0x98) frames instead of Modem Status (0x8A) frames when a Secure Session status change occurs Digi XBee® XR 900 RF Module User Guide...

  • Page 148: At Command Options

    GT (Guard Times) Set the required period of silence before and after the command sequence characters of the Command mode sequence, GT + CC + GT. The period of silence prevents inadvertently entering Digi XBee® XR 900 RF Module User Guide...

  • Page 149: Uart Pin Configuration Commands

    RTS flow control Digital input Digital output, low Digital output, high Default D7 (DIO7/CTS Configuration) Sets or displays the DIO7/CTS configuration. Parameter range 0, 1, 3 - 7 Parameter Description Disabled CTS flow control Digi XBee® XR 900 RF Module User Guide...

  • Page 150: P3 (Dio13/Dout Configuration)

    UART DOUT Digital input Digital output, low Digital output, high Default P4 (DIO14/DIN Configuration) Sets or displays the DIO14/UART_DIN configuration. Parameter range 0, 1, 3 - 5 Parameter Description Disabled UART DIN Digi XBee® XR 900 RF Module User Guide...

  • Page 151: Smt/Mmt Spi Interface Commands

    Default P7 (DIO17/SPI_SSEL Configuration) Sets or displays the DIO17/SPI_SSEL configuration. Parameter range 0, 1, 4, 5 Default P8 (DIO18/SPI_CLK Configuration) Sets or displays the DIO18/SPI_CLK configuration. Parameter range 0, 1, 4, 5 Digi XBee® XR 900 RF Module User Guide...

  • Page 152: P9 (Dio19/Spi_Attn Configuration)

    Parameter range 0, 1, 4, 5 Default I/O settings commands The following commands configure the various I/O lines available on the XBee XR 900 RF Module. Note Digital I/O support for physical I/O pin mapping for the supported module form factors.

  • Page 153: D1 (Ad1/Dio1/Th_Spi_Attn Configuration)

    Parameter range 0, 2 - 6 Parameter Description Disabled SPI_CLK for through-hole devices N/A for surface-mount devices Digital input Digital output, low Digital output, high Command mode indicator (high while in Command mode) Default Digi XBee® XR 900 RF Module User Guide...

  • Page 154: D3 (Dio3/Ad3/Th_Spi_Ssel Configuration)

    Sets or displays the DIO4/TH_SPI_MOSI configuration. Parameter range 0, 3 - 5 Parameter Description Disabled SPI_MOSI for the through-hole device N/A for the surface-mount and micro device Digital input Digital output, low Digital output, high Default Digi XBee® XR 900 RF Module User Guide...

  • Page 155: D5 (Dio5/Associate Configuration)

    Parameter range 0, 1, 3 - 5 Parameter Description Disabled DTR/Sleep_Request (used with pin sleep and cyclic sleep with pin wake) Digital input Digital output, low Digital output, high Default Digi XBee® XR 900 RF Module User Guide...

  • Page 156: D9 (Dio9/On_Sleep Configuration)

    1 kHz Parameter range 0 - 5 Parameter Description Disabled RSSI PWM output PWM0 output. M0 (PWM0 Duty Cycle) I/O line passing control the value. Digital input Digital output, low Digital output, high Digi XBee® XR 900 RF Module User Guide...

  • Page 157: P1 (Dio11/Pwm1 Configuration)

    Sets or displays the DIO12/TH_SPI_MISO configuration. Parameter range 0, 3 - 5 Parameter Description Disabled SPI_MISO for the through-hole device N/A for the surface-mount and micro device Digital input Digital output, low Digital output, high Default Digi XBee® XR 900 RF Module User Guide...

  • Page 158: Pr (Pull-Up/Down Resistor Enable)

    The following table defines the bit-field map for PR and PD commands. I/O line DIO4 DIO3 DIO2 DIO1 DIO0 DIO6 DIO8 DIO14 DIO5 DIO9 DIO12 DIO10 DIO11 DIO7 DIO13 DIO15 DIO16 DIO17 DIO18 DIO19 Parameter range 0 - 0xFFFFF Default 0xFFFF Digi XBee® XR 900 RF Module User Guide...

  • Page 159: Pd (Pull Up/Down Direction)

    Set or read the Associate LED blink time. If you use D5 (DIO5/Associate Configuration) to enable the Associate LED functionality (DIO5/Associate pin), this value determines the on and off blink times for the LED when the device has joined the network. Digi XBee® XR 900 RF Module User Guide...

  • Page 160: Rp (Rssi Pwm Timer)

    The analog voltage reference used for A/D sampling. Parameter range 0 - 2 Parameter Description 1.25 V reference 2.5 V reference VDD reference Default IC (DIO Change Detect) Bit field I/O line Micro pin DIO0 DIO1 Digi XBee® XR 900 RF Module User Guide...

  • Page 161: If (Sleep Sample Rate)

    The sample rate is measured in milliseconds. For more information, see the following commands: D0 (DIO0/AD0/Commissioning Button Configuration) through D9 (DIO9/ON_SLEEP Configuration) P0 (DIO10/RSSI/PWM0 Configuration) through P4 (DIO14/DIN Configuration) Parameter range 0 – 0xFF (x 1 ms) Default Digi XBee® XR 900 RF Module User Guide...

  • Page 162: Ir (Sample Rate)

    The source address of the device to which outputs are bound. To disable I/O line passing, set all bytes to 0xFF. To allow any I/O packet addressed to this device (including broadcasts) to change the outputs, set IA to 0xFFFF. Digi XBee® XR 900 RF Module User Guide...

  • Page 163: T0 (D0 Timeout)

    Specifies how long pin D3 (DIO3/AD3/TH_SPI_SSEL Configuration) holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default Digi XBee® XR 900 RF Module User Guide...

  • Page 164: T4 (D4 Output Timeout)

    Specifies how long pin D8 (DIO8/DTR/SLP_Request Configuration) holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Digi XBee® XR 900 RF Module User Guide...

  • Page 165: T9 (D9 Timeout)

    0 - 0x1770 (x 100 ms) Default Q3 (P3 Timeout) Specifies how long pin P3 (DIO13/DOUT Configuration) (pin 3) holds a given value before it reverts to configured value. If set to 0, there is no timeout. Digi XBee® XR 900 RF Module User Guide...

  • Page 166: Q4 (P4 Timeout)

    VR (Firmware Version) Reads the firmware version on a device. Parameter range 0xA000 - 0xA0FF Default Set in the firmware Shows detailed version information including the application build date and time. Parameter range Default Digi XBee® XR 900 RF Module User Guide...

  • Page 167: Vh (Bootloader Version)

    If an explanation for the revision number is not found in the release notes and it is a concern, contact Digi Support. In most cases the revision number does not relay any useful information to the consumer and it can be ignored.

  • Page 168: Dd (Device Type Identifier)

    Default DD (Device Type Identifier) Stores the Digi device type identifier value. Use this value to differentiate between multiple types of devices (for example, sensors or lights). This command can optionally be included in network discovery responses by setting bit 1 of NO.

  • Page 169: R? (Region Code)

    0x17. %F (Set Custom Default) When %F is received, the XBee XR 900 RF Module takes the next command received and applies it to both the current configuration and the custom defaults, so that when defaults are restored with Digi XBee® XR 900 RF Module User Guide...

  • Page 170: C (Clear Custom Defaults)

    RE (Restore Defaults) restores settings to the factory values. Parameter range Default R1 (Restore Factory Defaults) Restores factory defaults, ignoring any custom defaults set using %F (Set Custom Default). Parameter range Default Digi XBee® XR 900 RF Module User Guide...
  • Page 171 Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee® XR 900 RF Module User Guide...

  • Page 172: Api Mode Overview

    Frame fields Byte Description Start delimiter 0x7E Length 2 - 3 Most Significant Byte, Least Significant Byte Frame data 4 - number (n) API-specific structure Checksum n + 1 1 byte Digi XBee® XR 900 RF Module User Guide...

  • Page 173: Api Operation With Escaped Characters (Ap Parameter = 2)

    0x13 in the API frame isn't a reason to use AP = 2. Since 0x7D is the escape character itself, the only value of AP = 2 is to distinguish a 0x7E in the data compared to the start delimiter 0x7E. Digi XBee® XR 900 RF Module User Guide...
  • Page 174 Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines. Multi-byte values are sent big-endian. Digi XBee® XR 900 RF Module User Guide...

  • Page 175: Calculate And Verify Checksums

    Subtract 0x47 from 0xFF and you get 0x3B (0xFF - 0xC4 = 0x3B). 0x3B is the checksum for this data packet. If an API data packet is composed with an incorrect checksum, the XBee XR 900 RF Module will consider the packet invalid and will ignore the data.

  • Page 176: Frame Descriptions

    Extended Transmit Status - 0x8B Route Information - 0x8D Aggregate Addressing Update - 0x8E Receive Packet - 0x90 Explicit Receive Indicator - 0x91 I/O Sample Indicator - 0x92 Node Identification Indicator - 0x95 Remote AT Command Response- 0x97 Digi XBee® XR 900 RF Module User Guide...

  • Page 177: 64-Bit Transmit Request - 0X00

    This frame type is used to send serial payload data as an RF packet to a remote device with a corresponding 64-bit IEEE address. Note This frame format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. For new designs, we encourage you to use Transmit Request - 0x10 to initiate API transmissions.

  • Page 178: Examples

    0x88 frame is populated with the parameter value that is currently set on the device. The Frame ID of the 0x88 response is the same one set by the command in the 0x08 request frame. Digi XBee® XR 900 RF Module User Guide...

  • Page 179: Format

    Query the temperature of the module—TP command. The corresponding Local AT Command Response - 0x88 with a matching Frame ID will return the temperature value. 7E 00 04 08 17 54 50 3C Digi XBee® XR 900 RF Module User Guide...
  • Page 180 Frame descriptions Local AT Command Request - 0x08 Frame type Frame ID AT command Parameter value 0x08 0x17 0x5450 (omitted) Request Matches response "TP" Query the parameter Digi XBee® XR 900 RF Module User Guide...

  • Page 181: Queue Local At Command Request - 0X09

    (between length and checksum). Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. Digi XBee® XR 900 RF Module User Guide...
  • Page 182 Response frame with a matching Frame ID will return the temperature value. 7E 00 04 09 17 54 50 3B Frame type Frame ID AT command Parameter value 0x09 0x17 0x5450 (omitted) Request Matches response "TP" Query the parameter Digi XBee® XR 900 RF Module User Guide...

  • Page 183: Transmit Request - 0X10

    This parameter is only used for broadcast transmissions. If set to 0—recommended—the value of NHspecifies the broadcast radius. Payload Data to be sent to the destination device. Up to NP bytes 17-n variable data per packet. Digi XBee® XR 900 RF Module User Guide...

  • Page 184: Transmit Options Bit Field

    7E 00 17 10 00 00 00 00 00 00 00 FF FF FF FE 01 00 42 72 6F 61 64 63 61 73 74 60 Frame Bcast radius type Frame ID 64-bit dest Options RF data 0x00000000 0x10 0x00 0x01 0x00 0x42726F616463617374 0000FFFF Request Suppress Broadcast Single hop Will use "Broadcast" response address broadcast Digi XBee® XR 900 RF Module User Guide...

  • Page 185: Explicit Addressing Command Request - 0X11

    0x0023 - General Purpose Memory cluster ID: allows for reading and writing flash on the device. Reserved profile IDs The Digi profile ID of 0xC105 should be used when sending serial data between XBee devices. Digi XBee® XR 900 RF Module User Guide...

  • Page 186: Transmit Options Bit Field

    The available transmit options vary depending on the protocol being used. Bitfield options can be combined. Set all unused bits to 0. Sending a unicast message with MAC ACKs disabled is not intended to be a reliable form of communication, as no ACKs are produced by recipients. Digi XBee® XR 900 RF Module User Guide...

  • Page 187: Examples

    7E 00 1A 11 F8 00 13 A2 00 12 34 56 78 FF FE E8 E8 00 12 C1 05 00 01 54 78 44 61 74 61 41 Bcast Frame Frame 64-bit Sourc Dest Cluste radiu option Command type dest e EP Profile data 0x0013A2 0x11 0xF8 0xE8 0x001 0xC10 0x00 0x01 0x547844617 461  12345678 Digi XBee® XR 900 RF Module User Guide...
  • Page 188 Explicit Addressing Command Request - 0x11 Bcast Frame Frame 64-bit Sourc Dest Cluste radiu option Command type dest e EP Profile data Explici Matche Destinatio Digi Digi Data Digi Disabl "TxData" data data profile reque respons retries Digi XBee® XR 900 RF Module User Guide...

  • Page 189: Remote At Command Request - 0X17

    0x97 frame is populated with the parameter value that is currently set on the device. The Frame ID of the 0x97 response is the same one set by the command in the 0x17 request frame. XBee XR 900 RF Module firmwares support secured remote configuration through a Secure Session. Refer to Secured remote AT...

  • Page 190: Examples

    Change the PAN ID of a remote device so it can migrate to a new PAN, since this change would cause network disruption, the change is queued so that it can be made active later with a Digi XBee® XR 900 RF Module User Guide...
  • Page 191 7E 00 0F 17 FA 00 13 A2 00 12 34 56 78 FF FE 00 54 50 84 Frame Command type Frame ID 64-bit dest options command Parameter value 0x17 0xFA 0x0013A200 0x00 0x5450 (omitted) 12345678 Request Matches "TP" Query the response parameter Digi XBee® XR 900 RF Module User Guide...

  • Page 192: Secure Session Control - 0X2E

    When set, all other options, the timeout field, and password will be ignored. Bit 1: Server-side control: [0x02] = Terminate Session - If this bit is set, the server will end active incoming session(s). Digi XBee® XR 900 RF Module User Guide...

  • Page 193: Examples

    Session Response - 0xAE will indicate whether the login attempt succeeded. 7E 00 14 2E 00 13 A2 00 12 34 56 78 00 0B B8 50 41 53 53 57 4F 52 44 D2 Digi XBee® XR 900 RF Module User Guide...
  • Page 194 7E 00 13 2E 00 00 00 00 00 00 00 00 04 02 58 52 6F 73 33 62 75 64 D1 Frame type 64-bit dest Session options Timeout Password 0x2E 0x00000000 0x04 0x0258 0x526F7333627564 00000000 Request Zigbee coordinator Login  60 seconds "Ros3bud" Inter-packet Digi XBee® XR 900 RF Module User Guide...

  • Page 195: 64-Bit Receive Packet - 0X80

    RF data packet from a device configured to use 64-bit source addressing—MY = 0xFFFE. Note This frame format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. For new designs, we encourage you to use Receive Packet - 0x90 for reception of API transmissions.

  • Page 196: Examples

    The following table provides the contents of the frame. For details on frame structure, see frame format. Offset Size Frame Field Description 8-bit Start Indicates the start of an API frame. Delimiter Digi XBee® XR 900 RF Module User Guide...

  • Page 197: Examples

    The corresponding Local AT Command Response - 0x88 with a matching Frame ID is emitted with the temperature value as a response: 7E 00 07 88 01 54 50 00 FF FE D5 Digi XBee® XR 900 RF Module User Guide...

  • Page 198: Transmit Status - 0X89

    0x02 = LBT failure (couldn't find a clear channel for transmission) 0x03 = Message purged (no spectrum available) 0x20 = Invalid cluster ID specified 0x21 = Network ACK failure 0x25 = Route not found 0x31 = Internal resource error Digi XBee® XR 900 RF Module User Guide...

  • Page 199: Example

    The corresponding 0x89 Transmit Status with a matching Frame ID is emitted as a response to the request: 7E 00 03 89 52 00 24 Frame type Frame ID Delivery status 0x89 0x52 0x00 Response Matches request Success Digi XBee® XR 900 RF Module User Guide...

  • Page 200: Modem Status - 0X8A

    Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. Boot status When a device powers up, it returns the following API frame: 7E 00 02 8A 00 75 Digi XBee® XR 900 RF Module User Guide...
  • Page 201 Frame descriptions Modem Status - 0x8A Frame type Modem Status 0x8A 0x00 Status Hardware Reset Digi XBee® XR 900 RF Module User Guide...

  • Page 202: Extended Transmit Status - 0X8B

    0x21 = Network ACK failure 0x25 = Route not found 0x31 = Internal resource error 0x32 = Resource error lack of free buffers, timers, etc. 0x34 = No Secure Session connection 0x35 = Secure Session Encryption failure Digi XBee® XR 900 RF Module User Guide...
  • Page 203 Complete list of delivery statuses: 8-bit Discovery 0x00 = No discovery overhead status 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). Digi XBee® XR 900 RF Module User Guide...

  • Page 204: Route Information - 0X8D

    8-bit Reserved Not used. Destination The 64-bit IEEE address of the final destination node of this 64-bit address network-level transmission. 64-bit Source The 64-bit IEEE address of the source node of this network- Digi XBee® XR 900 RF Module User Guide...

  • Page 205: Examples

    0x12 0x2 0x6BEB 0x00 0x00 0x00 0x0013 0x0013A 0x0013 A200 CA93 A200 A200 4052AA 4052BBB 4052CC 4052DD Trac Destinat Source Node that Next minutes retrie error sent Rout s this this infor mation Digi XBee® XR 900 RF Module User Guide...

  • Page 206: Aggregate Addressing Update - 0X8E

    In the following example, a device with destination address (DH/DL) of 0x0013A200 4052AAAA updates its destination address to 0x0013A200 4052BBBB. 7E 00 12 8E 00 00 13 A2 00 40 52 BB BB 00 13 A2 00 40 52 AA AA 19 Digi XBee® XR 900 RF Module User Guide...
  • Page 207 Frame descriptions Aggregate Addressing Update - 0x8E Frame type Reserved New address Old address 0x0013A200 0x8E 0x00 0x0013A200 4052BBBB 4052AAAA What DH/DL is now set to What DH/DL was set to Update Digi XBee® XR 900 RF Module User Guide...

  • Page 208: Receive Packet - 0X90

    0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. Digi XBee® XR 900 RF Module User Guide...

  • Page 209: Explicit Receive Indicator - 0X91

    0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. Digi XBee® XR 900 RF Module User Guide...

  • Page 210: I/O Sample Indicator - 0X92

    1: DIO1 bit 2: DIO2 bit 3: DIO3 bit 4: DIO4 bit 5: DIO5 bit 6: DIO6 bit 7: DIO7 bit 8: DIO8 bit 9: DIO9 bit 10: DIO10 bit 11: DIO11 Digi XBee® XR 900 RF Module User Guide...

  • Page 211: Examples

    7E 00 16 92 00 13 A2 00 12 34 56 78 FF FE C1 01 00 38 06 00 28 02 25 00 F8 E8 Digital Analog Analo Analo chann chann Digital Frame 64-bit Reserve option sample sample sampl sampl type source mask mask 0x0013A2 0x92 0x87AC 0xC1 0x01 0x0038 0x06 0x0028 0x022 0x00F Digi XBee® XR 900 RF Module User Guide...
  • Page 212 12345678 Unused b'00 b'0110 b'00 Sampl Single 101000 data sample data DIO3 sent in (typical) DIO3, mesh DIO4, enable DIO5 networ DIO5 HIGH; enable DI04 is Digi XBee® XR 900 RF Module User Guide...

  • Page 213: Node Identification Indicator - 0X95

    The Digi Manufacturer ID— 0x101E . 33+NI 16-bit Digi Manufacturer The user-defined device type on the remote device set 35+NI 32-bit Device type DD (Device Type Identifier). identifier Only included if the receiving device has the (optional) Digi XBee® XR 900 RF Module User Guide...

  • Page 214: Examples

    NI String type G ID 0x0013 0x0013 0x95 0xFF 0xC2 0xFF 0x4C483 0xFF 0x10 A200 A200 735 00 123456 123456 Identifi Unkn DigiM Unkn "LH75" + Unkn Butt Digi Digi cation null broad cast Digi XBee® XR 900 RF Module User Guide...

  • Page 215: Remote At Command Response- 0X97

    8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). Digi XBee® XR 900 RF Module User Guide...

  • Page 216: Examples

    The corresponding 0x97 Remote AT Command Response with a matching Frame ID is emitted with the temperature value as a response: 7E 00 11 97 27 00 13 A2 00 12 34 56 78 FF FE 54 50 00 00 2F A8 Digi XBee® XR 900 RF Module User Guide...
  • Page 217 Frame descriptions Remote AT Command Response- 0x97 Command Command Frame type Frame ID 64-bit source command Status data 0x97 0x27 0x0013A200 0x4944 0x00 0x002F 12345678 Response Matches "TP" Success +47 °C request Digi XBee® XR 900 RF Module User Guide...

  • Page 218: Extended Modem Status - 0X98

    The address of the other node in this ended session. The reason the session was ended: Reason 8-bit 0x00 - Session was terminated by the other node 0x01 - Session Timed out 0x02 - Received a transmission with Digi XBee® XR 900 RF Module User Guide...

  • Page 219: Examples

    7E 00 0D 98 3B 00 13 A2 00 12 34 56 78 00 46 50 CD Frame type Status code Status data 0x98 0x3B 0x0013A20012345678 0x00 0x4650 Extended status Secure Session established Address Options Timeout (30 min) Digi XBee® XR 900 RF Module User Guide...

  • Page 220: Secure Session Response - 0Xae

    0x80 - Server received a packet that was intended for a client or vice-versa 0x81 - Received an SRP packet we were not expecting 0x82 - Offset for a split value (A/B) came out of order 0x83 - Unrecognized or invalid SRP frame type Digi XBee® XR 900 RF Module User Guide...

  • Page 221: Examples

    The following Secure Session Response - 0xAE is emitted as a response: 7E 00 0B AE 00 00 13 A2 00 12 34 56 78 00 88 Frame type Response type 64-bit source Status 0x2E 0x00 0x0013A200 0x00 12345678 Response Login success Digi XBee® XR 900 RF Module User Guide...

  • Page 222: General Purpose Flash Memory

    General Purpose Flash Memory General Purpose Flash Memory Access General Purpose Flash Memory General Purpose Flash Memory commands Possible Errors Returned from GPM Commands Digi XBee® XR 900 RF Module User Guide...

  • Page 223: General Purpose Flash Memory

    General Purpose Flash Memory General Purpose Flash Memory XBee XR 900 RF Module provides 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 224: General Purpose Flash Memory Commands

    No data bytes should be specified for this command. PLATFORM_INFO (0x80) When a PLATFORM_INFO_REQUEST 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. Digi XBee® XR 900 RF Module User Guide...

  • Page 225: Erase (0X01)

    (not just the one specified with GPM_BLOCK_NUM). In all other cases, the GPM_NUM_BYTES field should be set to the GPM flash block size. GPM_DATA No data bytes are specified for this command. Digi XBee® XR 900 RF Module User Guide...

  • Page 226: Erase_Response (0X81)

    Set to the index of the GPM block that should be written. GPM_START_INDEX Set to the byte index within the GPM block where the given data should be written. GPM_NUM_BYTES Set to the number of bytes specified in the GPM_DATA field. Digi XBee® XR 900 RF Module User Guide...

  • Page 227: Write _Response (0X82) And Erase_Then_Write_Response (0X83)

    7E 0007 8B 01 FFFE 00 00 00 76 READ (0x04) You can use the READ command to read the specified number of bytes from the GPM location specified. Data can be queried from only one GPM block per command. Digi XBee® XR 900 RF Module User Guide...

  • Page 228: Read_Response (0X84)

    API packets would be output the source node's serial interface: 7E 0007 8B 01 FFFE 00 00 00 76 7E 0029 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 84 00 0016 0000 000F 0102030405060708090A0B0C0D0E0F C3 Digi XBee® XR 900 RF Module User Guide...

  • Page 229: Firmware_Verify (0X05) And Firmware_Verify_And_Install (0X06)

    FIRMWARE_VERIFY _AND_INSTALL_RESPONSE (0x86) When a FIRMWARE_VERIFY_AND_INSTALL 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. Digi XBee® XR 900 RF Module User Guide...

  • Page 230: Possible Errors Returned From Gpm Commands

    Tried to access memory block beyond the max available 0x04 Attempted to read/write across a block boundary 0x05 Attempted to read/write with a valid file system mounted 0x06 Unrecognized GPM command 0x07 GPM is currently busy executing another GPM command Digi XBee® XR 900 RF Module User Guide...
  • Page 231 Verify and install failures 0x40 Firmware verify operation failed 0x41 The given image is not compatible with this device 0x42 The given image appears corrupted or invalid 0x50 Firmware install operation failed Digi XBee® XR 900 RF Module User Guide...

  • Page 232: Update The Firmware Over-The-Air

    Update the firmware over-the-air The XBee XR 900 RF Module supports firmware over-the-air (FOTA) updates. To perform an FOTA update, the device to be updated must be associated and communicable with a network. In this section, the node performing the update is considered the server and the node being updated is the client.

  • Page 233: Over-The-Air Firmware Updates

    Load the new firmware image in the target node's GPM prior to installation. XBee XR 900 RF Modules use a a Gecko Bootloader (.gbl) file for both serial and over-the-air firmware updates. These firmware files are available on the Digi Support website and via XCTU.

  • Page 234: Verify The New Application

    Because explicit API Tx frames can be addressed to a local node (accessible via the SPI or UART) or a remote node (accessible over the RF port) the same process can be used to update firmware on a device in either case. Digi XBee® XR 900 RF Module User Guide...

  • Page 235: Regulatory Information

    Regulatory information United States (FCC) ISED (Innovation, Science and Economic Development Canada) ACMA (Australia) RSM (New Zealand) Digi XBee® XR 900 RF Module User Guide...

  • Page 236: United States (Fcc)

    United States (FCC) United States (FCC) XBee XR 900 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, the OEM must comply with the following regulations: 1.
  • Page 237 Re-orient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect equipment and receiver to outlets on different circuits. Consult the dealer or an experienced radio/TV technician for help. Digi XBee® XR 900 RF Module User Guide...

  • Page 238: Fcc-Approved Antennas

    SAR testing measures emissions from the module and how they affect the person. FCC-approved antennas The following tables cover the antennas that are approved for use with the XBee XR 900 RF Module. If applicable, the tables show the required cable loss between the device and the antenna.
  • Page 239 13 element 15.1 dBi 0.62 Fixed/mobile Y15NF* Yagi Omni-directional base station antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Required antenna Part number Type Gain...
  • Page 240 The module can be placed vertically, as long as the module's antenna is mounted towards other radios in the network. Flexible (flat) antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Required...
  • Page 241 Taoglas antenna can be fastened to glass or plastic surfaces. The Taoglas FXUB65 datasheet provides these preferred orientations. Place the cable as shown: The Taoglas datasheet does not recommend the following cable orientations: Digi XBee® XR 900 RF Module User Guide...
  • Page 242 United States (FCC) Recommended usage of Molex antenna Orient this antenna upright. This gives an antenna pattern similar to a dipole. The Molex antenna can be fastened to a glass or plastic surface. Digi XBee® XR 900 RF Module User Guide...
  • Page 243 United States (FCC) The cable should be bent as shown in the first two figures below. Do not place the cable to the side of the antenna, as shown in the third figure. Digi XBee® XR 900 RF Module User Guide...
  • Page 244 Regulatory information United States (FCC) Digi XBee® XR 900 RF Module User Guide...

  • Page 245: Rf Exposure

    Question 11 of 996369 D02 Module Q&A. See Question and Answer 11. If you decide to use a trace antenna, you must request assistance from Digi to obtain a “change in FCC ID”. You will then work with a lab of your choice to obtain the testing and documentation needed to file for your product with the trace antenna in a Class II Permissive filing.

  • Page 246: Rf Exposure Considerations

    No “PORTABLE” use is allowed by the FCC Grant. Please request assistance from Digi to obtain a “change in FCC ID”. You will then work with a lab of your choice to obtain the testing and documentation needed to file for your product for the specific “PORTABLE”...

  • Page 247: Over-Voltage Detection

    FCC Part 15 Subpart B compliance testing is still required for the final host product. This testing is required for all end products, and XBee XR 900 RF Module Part 15 Subpart B compliance does not affirm the end product’s compliance.

  • Page 248: Ised-Approved Antennas

    ISED-approved antennas The following tables cover the antennas that are approved for use with the XBee XR 900 RF Module. If applicable, the tables show the required cable loss between the device and the antenna.
  • Page 249 Regulatory information ISED (Innovation, Science and Economic Development Canada) Omni-directional base station antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Required antenna Part number...
  • Page 250 The module can be placed vertically, as long as the module's antenna is mounted towards other radios in the network. Flexible (flat) antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Required...
  • Page 251 Taoglas antenna can be fastened to glass or plastic surfaces. The Taoglas FXUB65 datasheet provides these preferred orientations. Place the cable as shown: The Taoglas datasheet does not recommend the following cable orientations: Digi XBee® XR 900 RF Module User Guide...
  • Page 252 ISED (Innovation, Science and Economic Development Canada) Recommended usage of Molex antenna Orient this antenna upright. This gives an antenna pattern similar to a dipole. The Molex antenna can be fastened to a glass or plastic surface. Digi XBee® XR 900 RF Module User Guide...
  • Page 253 ISED (Innovation, Science and Economic Development Canada) The cable should be bent as shown in the first two figures below. Do not place the cable to the side of the antenna, as shown in the third figure. Digi XBee® XR 900 RF Module User Guide...
  • Page 254 Regulatory information ISED (Innovation, Science and Economic Development Canada) Digi XBee® XR 900 RF Module User Guide...

  • Page 255: Labeling Requirements

    To ensure compliance, operations at closer than this distance are not recommended. The antenna used for this transmitter must not be co-located in conjunction with any other antenna or transmitter. Digi XBee® XR 900 RF Module User Guide...

  • Page 256: Acma (Australia)

    Australia. b. have a company/distributor/agent in Australia that will sponsor the import of the end product. Contact Digi for questions related to locating a contact in Australia. RSM (New Zealand) Power requirements No antenna with gain greater that 2.1 dBi (dipole) can be used with this radio in New Zealand.

  • Page 257: Module Support

    Module support Custom defaults Set custom defaults Restore factory defaults Limitations Digi XBee® XR 900 RF Module User Guide...

  • Page 258: Custom Defaults

    Identifier). Set custom defaults %F (Set Custom Default) to set custom defaults. When the XBee XR 900 RF Module receives %F it takes the next command it receives and applies it to both the current configuration and the custom defaults.

  • Page 259: Manufacturing Information

    Manufacturing information Manufacturing information The micro XBee XR 900 RF Module is designed for surface-mounting on the OEM PCB. It has castellated pads to allow for easy solder attaching and inspection. The pads are all located on the edge of the device so there are no hidden solder joints on these devices.

  • Page 260: Recommended Solder Reflow Cycle

    Hand soldering is possible and should be done in accordance with approved standards. Handling and storage The XBee XR 900 RF Modules are level 3 Moisture Sensitive Devices. When using this kind of device, consider the relative requirements in accordance with standard IPC/JEDEC J-STD-020.

  • Page 261: Surface-Mount Recommended Footprint

    Manufacturing information Recommended footprint Surface-mount recommended footprint Digi XBee® XR 900 RF Module User Guide...

  • Page 262: Xbee Xr Micro Recommended Footprint

    Place the component last and set the placement speed to the slowest setting. Flux and cleaning Digi recommends that a “no clean” solder paste be used in assembling these devices. This eliminates the clean step and ensures unwanted residual flux is not left under the device where it is difficult to remove.

  • Page 263: Reworking

    Be careful not to overheat the device. During rework, the device temperature may rise above its internal solder melting point and care should be taken not to dislodge internal components from their intended positions. Digi XBee® XR 900 RF Module User Guide...

Table of Contents