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

Digi XBee XTC User Manual

Digimesh radio frequency (rf) module
Hide thumbs Also See for XBee XTC:
Table of Contents

Advertisement

Quick Links

Download this manual
XBee®/XBee-PRO XTC DigiMesh
Radio Frequency (RF) Module
User Guide

Advertisement

Table of Contents
loading

Related Manuals for Digi XBee XTC

Summary of Contents for Digi XBee XTC

  • Page 1 XBee®/XBee-PRO XTC DigiMesh Radio Frequency (RF) Module 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 XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide Applicable firmware Technical specifications Performance specifications Power requirements Cyclic sleep current (mA, average) Networking and security specifications General specifications Regulatory conformity summary Hardware Mechanical drawings Pin signals Recommended pin connections Modes Transparent and API operating modes Transparent operating mode...
  • Page 5 UART data flow Serial flow control Networking methods The MAC and PHY layers 64-bit addresses Make a unicast transmission Delivery methods Point to Point / Point to Multipoint (P2MP) Repeater/directed broadcast DigiMesh networking AT commands Addressing commands CI (Cluster ID) DH (Destination Address High) DL (Destination Address Low) NI (Node Identifier)
  • Page 6 RT (GPI1 Configuration) I/O diagnostic commands TP (Board Temperature) MAC/PHY commands HP (Preamble ID) ID (Network ID) MT (Broadcast Multi-Transmits) PL (TX Power Level) RR (Unicast Mac Retries) Network commands BH (Broadcast Hops) CE (Routing / Messaging Mode) MR (Mesh Unicast Retries) NH (Network Hops) NN (Network Delay Slots) Security commands...
  • Page 7 FCC (United States) OEM labeling requirements FCC notices RF exposure statement FCC antenna certifications XBee-PRO XTC antenna options XBee XTC antenna options FCC publication 996369 related information ISED (Innovation, Science and Economic Development Canada) Labeling requirements Transmitters for detachable antennas Detachable antennas...
  • Page 8 PCB design and manufacturing Recommended footprint and keepout Design notes Host board design Improve antenna performance RF pad version Recommended solder reflow cycle Flux and cleaning Rework XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 9: Xbee®/Xbee-Pro Xtend Compatible (Xtc) Digimesh Rf Module User

    RF data rates of 10 kb/s and 125 kb/s. As the name suggests, the XTC is over-the-air compatible with Digi's XTend module. The XTC is not a drop-in replacement for the XTend. If you require form factor compatibility, you must use the XTend vB RF Module.

  • Page 10: Applicable Firmware

    XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide Applicable firmware Applicable firmware This manual supports the following firmware: 0x800x for XTC DigiMesh XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 11: Technical Specifications

    Technical specifications The following tables provide the device's technical specifications. WARNING! When operating at 1 W power output, observe a minimum separation distance of 6 ft (2 m) between devices. Transmitting in close proximity of other devices can damage the device's front end. Performance specifications Power requirements Networking and security specifications...

  • Page 12: Performance Specifications

    Specification XBee XTC XBee-PRO XTC ISM 902 to 928 MHz Frequency range...

  • Page 13: Cyclic Sleep Current (Ma, Average)

    Technical specifications Networking and security specifications Cyclic sleep current (mA, average) Sleep mode Cycle time RF data rate Cyclic sleep current (mA, average) SM = 8 16 seconds BR = 0 0.65 BR = 1 0.23 SM = 7 8 seconds BR = 0 1.13 BR = 1...
  • Page 14 Technical specifications General specifications Specification Value RoHS Compliant Manufacturing ISO 9001:2000 registered standards Connector 37 castellated SMT pads Antenna connector options U.FL or RF pad Antenna impedance 50 Ω unbalanced Maximum input RF level at antenna port 6 dBm Operating temperature -40 °C to 85 °C Digital outputs Two (2) output lines...

  • Page 15: Regulatory Conformity Summary

    Technical specifications Regulatory conformity summary Regulatory conformity summary This table describes the agency approvals for the devices. Country XBee XTC XBee-PRO XTC United States FCC ID: MCQ-XBSX FCC ID: MCQ-XBPSX Canada IC: 1846A-XBSX IC: 1846A-XBPSX Australia Mexico RCPDIXB19-1819 RCPDIXB19-2288 XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 16: Hardware

    Hardware Mechanical drawings Pin signals XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 17: Mechanical Drawings

    Mechanical drawings The following images show the XTC mechanical drawings. The XTC has the same form factor as other Digi surface-mount (SMT) XBee devices, except there is an additional copper ground pad on the bottom. XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 18: Pin Signals

    Hardware Pin signals Pin signals The following table describes the pin signals. Low-asserted signals have a horizontal line over the signal name. Pin Designation I/O Function Ground Power supply DOUT UART Data Out UART Data In XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...
  • Page 19 Hardware Pin signals Pin Designation I/O Function GPO2/RX LED General Purpose Output / RX LED RESET Module reset RSSI RX Signal Strength Indicator Disabled Reserved NC Do not connect SLEEP (DTR) Pin Sleep Control Line Ground Disabled Ground Disabled Disabled Disabled Disabled Reserved...

  • Page 20: Recommended Pin Connections

    Hardware Pin signals Pin Designation I/O Function Reserved Reserved Ground I/O RF I/O for RF pad variant Ground pad for heat transfer to host PCB Note If you integrate the XTC RF Module with a host PC board, leave all lines you do not use disconnected (floating).

  • Page 21: Modes

    Modes The XTC RF Module is in Receive Mode when it is not transmitting data. 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) Sleep mode Command Mode (Command mode sequence is issued (not available when using the SPI port)) Transparent and API operating modes...

  • Page 22: Transparent And Api Operating Modes

    Modes Transparent and API operating modes Transparent and API operating 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. Transparent operating mode Devices operate in this mode by default.

  • Page 23: Transmit Mode

    Modes Transmit mode Transmit mode When DigiMesh data is transmitted from one node to another, the destination node transmits a network-level acknowledgment back across the established route to the source node. This acknowledgment packet indicates to the source node that the destination node received the data packet.

  • Page 24: Troubleshooting

    Modes Command mode Note Do not press Return or Enter after typing +++ because it interrupts the guard time silence and prevents you from entering Command mode. When the device is in Command mode, it listens for user input and is able to receive AT commands on the UART.

  • Page 25: Response To At Commands

    Modes Command mode 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 26 Modes Command mode For an example of programming the device using AT Commands and descriptions of each configurable parameter, see commands. 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.

  • Page 27: Operation

    Operation WARNING! When operating at 1 W power output, observe a minimum separation distance of 6 ft (2 m) between devices. Transmitting in close proximity of other devices can damage the device's front end. Serial interface XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 28: Serial Interface

    Operation Serial interface Serial interface The XTC RF Module provides a serial interface to an RF link. The XTC RF Module converts serial data to RF data and sends that data to any over-the-air compatible device in an RF network. The device can communicate through its serial port with any logic and voltage compatible universal asynchronous receiver/transmitter (UART), or through a level translator to any serial device.
  • Page 29 Operation Serial interface CTS flow control CTS flow control is enabled by default; you can disable it with the D7 command. When the serial receive buffer fills with the number of bytes specified by the FT parameter, the device de-asserts CTS (sets it high) to signal the host device to stop sending serial data.

  • Page 30: Networking Methods

    Networking methods The MAC and PHY layers 64-bit addresses Make a unicast transmission Delivery methods XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 31: The Mac And Phy Layers

    Networking methods The MAC and PHY layers The MAC and PHY layers Most network protocols use the concept of layers to separate different components and functions into independent modules that developers can assemble in different ways. 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.

  • Page 32: 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 33: Digimesh Networking

    Networking methods Delivery methods MAC layer The MAC layer is the building block that is used to build repeater capability. To implement Repeater mode, we use a network layer header that comes after the MAC layer header in each packet. In this network layer there is additional packet tracking to eliminate duplicate broadcasts.
  • Page 34 Networking methods Delivery methods With mesh networking, the distance between two nodes does not matter as long as there are enough nodes in between to pass the message along. When one node wants to communicate with another, the network automatically calculates the best path. A mesh network is also reliable and offers redundancy.
  • Page 35 Networking methods Delivery methods If a message has a broadcast address, it is broadcast to all neighbors, then all routers that receive the message rebroadcast the message MT+1 times. Eventually, the message reaches the entire network. Packet tracking prevents a node from resending a broadcast message more than MT+1 times. This means that a node that relays a broadcast will only relay it after it receives it the first time and it will discard repeated instances of the same packet.
  • Page 36 Networking methods Delivery methods Transmit a broadcast All of the routers in a network must relay a broadcast transmission. The maximum delay occurs when the sender and receiver are on the opposite ends of the network. The NH and %H parameters define the maximum broadcast delay as follows: BroadcastTxTime = NH * NN * %8 Unless BH <...

  • Page 37: At Commands

    AT commands Addressing commands Command mode options Diagnostic commands Firmware commands I/O settings commands I/O diagnostic commands MAC/PHY commands Network commands Security commands Serial interfacing commands Special commands XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 38: Addressing Commands

    AT commands Addressing commands Addressing commands The following AT commands are addressing commands. CI (Cluster ID) The application layer cluster ID value. The device uses this value as the cluster ID for all data transmissions. If you set this value to 0x12 (loopback Cluster ID), the destination node echoes any transmitted packet back to the source device.

  • Page 39: Network Discovery Options)

    Parameter range 0x0 - 0x7 (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 response frame out the serial interface when ND is issued.

  • Page 40: Sh (Serial Number High)

    AT commands Addressing commands SH (Serial Number High) Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XTend in the factory. The 64-bit source address is always enabled. This value is read-only and it never changes. Parameter range 0 - 0xFFFFFFFF [read-only] Default...

  • Page 41: Command Mode Options

    AT commands Command mode options Bits 6 and 7 cannot be set to DigiMesh on the 10k build. Bits 4 and 5 must be set to 0. Bits 1, 2, and 3 cannot be set on the 10k build. When you set BR to 0 the TO option has the DigiMesh and Repeater mode disabled automatically. Default 0xC0 Command mode options...

  • Page 42: Diagnostic Commands

    AT commands Diagnostic commands Diagnostic commands The following AT commands are diagnostic commands. Diagnostic commands are typically volatile and will not persist across a power cycle. %H (MAC Unicast One Hop Time) The MAC unicast one hop time timeout in milliseconds. If you change the MAC parameters it can change this value.

  • Page 43: Db (Last Packet Rssi)

    AT commands Diagnostic commands Parameter range 0 - 0xFFFF Default DB (Last Packet RSSI) Reports the RSSI in -dBm of the last received RF data packet. DB returns a hexadecimal value for the - dBm measurement. For example, if DB returns 0x60, then the RSSI of the last packet received was -96 dBm. The RSSI measurement is accurate from approximately -50 to -100 dBm.

  • Page 44: Gd (Good Packets Received)

    AT commands Diagnostic commands GD (Good Packets Received) This count increments when a device receives a good frame with a valid MAC header on the RF interface. Received MAC ACK packets do not increment this counter. Once the number reaches 0xFFFF, it does not count further events.

  • Page 45: Tr (Transmit Error Count)

    After a firmware update this command may return a different value. Parameter range Default 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.

  • Page 46: Np (Maximum Packet Payload Bytes)

    AT commands Firmware commands NP (Maximum Packet Payload Bytes) Reads the maximum number of RF payload bytes that you can send in a transmission. Using APS encryption (API transmit option bit enabled), reduces the maximum payload size by 9 bytes. Using source routing (AR <...

  • Page 47: I/O Settings Commands

    AT commands I/O settings commands Default Set in firmware I/O settings commands The following AT commands are I/O settings commands. CD (GP02 Configuration) Selects or reads the behavior of the GPO2 line (pin 5). Parameter range 0 - 4 Parameter Configuration RX LED Static high Static low...

  • Page 48: Rp (Rssi Pwm Timer)

    AT commands I/O diagnostic commands RP (RSSI PWM Timer) Enables a pulse-width modulated (PWM) output on the RSSI pin (pin 7). 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 49: Mac/Phy Commands

    AT commands MAC/PHY commands MAC/PHY commands The following AT commands are MAC/PHY commands. HP (Preamble ID) The preamble ID for which the device communicates. Only devices with matching preamble IDs can communicate with each other. Different preamble IDs minimize interference between multiple sets of devices operating in the same vicinity.

  • Page 50: Rr (Unicast Mac Retries)

    AT commands Network commands Power supply Output power @ PL = 3 3.3 to 3.6 V 30 dBm typical 3.0 V 29 dBm typical 2.6 V 27 dBm typical Parameter range 0 - 4 These parameters equate to the following settings for the XTC DigiMesh module: Setting XTC power level XTC PRO Power level...

  • Page 51: Ce (Routing / Messaging Mode)

    AT commands Network commands Default CE (Routing / Messaging Mode) The routing and messaging mode of the device. End devices do not propagate broadcasts and will not become intermediate nodes on a route. Parameter range 0 - 2 Parameter Description Routes packets Standard router End device...

  • Page 52: Nn (Network Delay Slots)

    AT commands Security commands Default NN (Network Delay Slots) Set or read the maximum random number of network delay slots before rebroadcasting a network packet. Parameter range 1 - 0xA network delay slots Default Security commands The following AT commands are security commands. EE (Encryption Enable) Enables or disables 128-bit Advanced Encryption Standard (AES) encryption.

  • Page 53: Serial Interfacing Commands

    AT commands Serial interfacing commands Serial interfacing commands The following AT commands are serial interfacing commands. AO (API Options) The API data frame output format for RF packets received. This parameter applies to both the UART and SPI interfaces. Use AO to enable different API output frames. Parameter range 0 - 2 Parameter...

  • Page 54: Bd (Baud Rate)

    AT commands Serial interfacing commands BD (Baud Rate) To request non-standard baud rates with values above 0x80, you can use the Serial Console toolbar in XCTU to configure the serial connection (if the console is connected), or click the Connect button (if the console is not yet connected).

  • Page 55: Nb (Parity)

    AT commands Serial interfacing commands NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x04 Parameter Description 0x00 No parity 0x01 Even parity 0x02 Odd parity 0x03 Mark parity (forced high) 0x04 Space parity (forced low) Default 0x00 RB (Packetization Threshold)

  • Page 56: Sb (Stop Bits)

    AT commands Special commands Default SB (Stop Bits) Parameter range 0 - 1 Parameter Configuration One stop bit Two stop bits Default Special commands The following commands are special commands. AC (Apply Changes) Immediately applies new settings without exiting Command mode. Parameter range Default CN (Exit Command Mode)

  • Page 57: Re (Restore Defaults)

    AT commands Special commands RE (Restore Defaults) Restore device parameters to factory defaults. Parameter range Default WR (Write) Writes parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. Note Once you issue a WR command, do not send any additional characters to the device until after you receive the OK response.

  • Page 58: Operate In Api Mode

    Operate in API mode API mode overview XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 59: Api Mode Overview

    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 60 For more information on using this API mode, refer to the following knowledge base article: http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2 The following table shows the structure of an API frame with escaped characters:...

  • Page 61: Calculate And Verify Checksums

    Operate in API mode API mode overview Frame data Start Frame delimiter Length type Checksum Data API frame type Single byte 0x7E Data Frame type is the API frame type identifier. It determines the type of API frame and indicates how the Data field organizes the information. Data contains the data itself.

  • Page 62: Escaped Characters In Api Frames

    Operate in API mode API mode overview Byte(s) Description 48 65 6C 6C 6F Data packet Checksum To calculate the check sum you add all bytes of the packet, excluding the frame delimiter 7E and the length (the second and third bytes): 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...

  • Page 63: Api Frames

    API frames The following sections document API frame types. API frame exchanges Code to support future API frames AT Command frame - 0x08 AT Command - Queue Parameter Value frame - 0x09 Legacy TX Request frame - 0x00 Transmit Request frame - 0x10 Explicit Addressing Command frame - 0x11 Remote AT Command Request frame - 0x17 AT Command Response frame - 0x88...

  • Page 64: Api Frame Exchanges

    API frames API frame exchanges API frame exchanges Every outgoing API frame has a corresponding response (or ACK) frame that indicates the success or failure of the outgoing API frame. This section details some of the common API exchanges that occur. You can use the Frame ID field to correlate between the outgoing frames and associated responses.

  • Page 65: Device Registration

    API frames Code to support future API frames generated and you can use it to identify if the remote device successfully received and applied the command. 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.

  • Page 66: At Command Frame - 0X08

    API frames AT Command frame - 0x08 break; AT Command frame - 0x08 Description Use this frame to query or set device parameters on the local device. This API command applies changes after running the command. You can query parameter values by sending the 0x08 AT Command frame with no parameter value field (the two-byte AT command is immediately followed by the frame checksum).

  • Page 67: At Command - Queue Parameter Value Frame - 0X09

    API frames AT Command - Queue Parameter Value frame - 0x09 Frame data fields Offset Example Frame ID 0x52 AT command 0x4E (N) 0x48 (H) Parameter value (NH2 = two network hops) 0x02 Checksum 0x0D AT Command - Queue Parameter Value frame - 0x09 Description This frame allows you to query or set device parameters.

  • Page 68: Legacy Tx Request Frame - 0X00

    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 69: Transmit Request Frame - 0X10

    API frames Transmit Request frame - 0x10 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 70 API frames Transmit Request frame - 0x10 You can read the maximum number of payload bytes with the NP command. Format The following table provides the contents of the frame. For details on the frame structure, see frame specifications. Frame data fields Offset Description Frame type...
  • Page 71 API frames Transmit Request frame - 0x10 Example The example shows how to send a transmission to a device if you disable escaping (AP = 1), with destination address 0x0013A200 400A0127, and payload “TxData0A”. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1...

  • Page 72: Explicit Addressing Command Frame - 0X11

    API frames Explicit Addressing Command frame - 0x11 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 73 API frames Explicit Addressing Command frame - 0x11 Frame data fields Offset Description Sets the maximum number of hops a broadcast transmission can Broadcast radius traverse. If set to 0, the transmission radius set to the network maximum hops value. If the broadcast radius exceeds the value of NH then the devices use the value of NH as the radius.
  • Page 74 API frames Explicit Addressing Command frame - 0x11 Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x1A Frame type 0x11 Frame ID 0x01 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x01 0x23 0x84 LSB12 0x00...

  • Page 75: Remote At Command Request Frame - 0X17

    API frames 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 76: At Command Response Frame - 0X88

    API frames AT Command Response frame - 0x88 Frame data fields Offset Example Frame ID 0x01 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF 0xFE Remote command options 0x02 (apply changes) AT command 0x42 (B) 0x48 (H)

  • Page 77: Modem Status Frame - 0X8A

    API frames Modem Status frame - 0x8A Frame data fields Offset Description 0 = OK Command 1 = ERROR status 2 = Invalid command 3 = Invalid parameter Command The register data in binary format. If the host sets the register, the device data does not return this field.

  • Page 78: Transmit Status Frame - 0X8B

    API frames Transmit Status frame - 0x8B Frame data fields Offset Description Frame type 0x8A Status Example When a device powers up, it returns the following API frame. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 LSB 2 0x02...

  • Page 79: Legacy Tx Status Frame - 0X89

    API frames Legacy TX Status frame - 0x89 Frame data fields Offset Description The number of application transmission retries that occur. Transmit retry count Delivery 0x00 = Success 0x01 = MAC ACK failure status 0x02 = Collision avoidance failure 0x21 = Network ACK failure 0x25 = Route not found 0x31 = Internal resource error 0x32 = Internal error...

  • Page 80: Route Information Packet Frame - 0X8D

    API frames Route Information Packet frame - 0x8D Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications. Frame data fields Offset Description Frame type 0x89 Identifies the Legacy TX Request frame being reported. Frame ID Status 0x00 = standard...
  • Page 81 API frames Route Information Packet frame - 0x8D Frame data fields Offset Description 0x11 = NACK Source event 0x12 = Trace route Length The number of bytes that follow, excluding the checksum. If the length increases, new items have been added to the end of the list for future revisions.
  • Page 82 API frames Route Information Packet frame - 0x8D Frame data fields Offset Example Timestamp MSB 6 0x9C 0x93 0x81 LSB 9 0x7F ACK timeout count 0x00 TX blocked count 0x00 Reserved 0x00 Destination address MSB 13 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA...

  • Page 83: Aggregate Addressing Update Frame - 0X8E

    API frames Aggregate Addressing Update frame - 0x8E Frame data fields Offset Example Responder address MSB 29 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 36 0xBB Receiver address MSB 37 0x00 0x13 0xA2 0x00 0x40 0x52 0xCC LSB 44 0xCC Checksum 0xD2...
  • Page 84 API frames Aggregate Addressing Update frame - 0x8E Frame data fields Offset Description Frame 0x8E type Byte reserved to indicate the format of additional packet information which may Format be added in future firmware revisions. In the current firmware revision, this field returns 0x00.

  • Page 85: Legacy Rx Indicator Frame - 0X80

    API frames Legacy RX Indicator frame - 0x80 Frame data fields Offset Example Old address 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA 0xAA Checksum 0x19 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.
  • Page 86 API frames Legacy RX Indicator frame - 0x80 Frame data fields Offset Description Options Bit field: bit 0: Packet was acknowledged bit 1: Broadcasted packet bits 6,7: b’01 - Point-Multipoint b’10 - Repeater mode (directed broadcast) b’11 - DigiMesh Ignore all other bits. Received 14-n Received RF data...

  • Page 87: Rx Indicator Frame - 0X90

    API frames RX Indicator frame - 0x90 Frame data fields Offset Example 0x52 Received data 0x78 0x44 0x61 0x74 0x61 Checksum 0xFF RX Indicator 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.

  • Page 88: Explicit Rx Indicator Frame - 0X91

    API frames Explicit Rx Indicator frame - 0x91 Frame data fields Offset Example Start delimiter 0x7E 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...
  • Page 89 API frames Explicit Rx Indicator frame - 0x91 Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications. Frame data fields Offset Description Frame type 0x91 64-bit source address MSB first, LSB last. The sender's 64-bit address. 4-11 Reserved 12-13...

  • Page 90: Node Identification Indicator Frame - 0X95

    API frames Node Identification Indicator frame - 0x95 Frame data fields Offset Example 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Source endpoint 0xE0 Destination endpoint 0xE0 Cluster ID 0x22 0x11 Profile ID 0xC1...
  • Page 91 NO (Network Discovery Options). Source event 1 = Frame sent by node identification pushbutton event. Digi Profile ID 31-32 Set to the Digi application profile ID. 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...
  • Page 92 API frames Node Identification Indicator frame - 0x95 Example If you press the commissioning pushbutton on a remote device with 64-bit address 0x0013A200407402AC and a default NI string sends a Node Identification, all devices on the network receive the following node identification indicator: A remote device with 64-bit address 0x0013A200407402AC and a default NI string sends a Node Identification, all devices on the network receive the following node identification indicator: If you press the commissioning button on a remote router device with 64-bit address 0x0013A200...

  • Page 93: Remote Command Response Frame - 0X97

    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...
  • Page 94 API frames Remote Command Response frame - 0x97 Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications. Frame data fields Offset Description Frame type 0x97 Frame ID This is the same value that is passed in to the request. 64-bit source (remote) address 5-12 The address of the remote device returning this response.
  • Page 95 API frames Remote Command Response frame - 0x97 Frame data fields Offset Example 64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12 0xAA Reserved 0xFF 0xFE 16-bit source (remote) address MSB 13 0x7D LSB 14 0x84 AT commands 0x53 (S)
  • Page 96 Work with networked devices Network commissioning and diagnostics Local configuration Remote configuration Establish and maintain network links Test links in a network - loopback cluster Test links between adjacent devices XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 97: Work With Networked Devices

    Work with networked devices Network commissioning and diagnostics Network commissioning and diagnostics We call the process of discovering and configuring devices in a network for operation, "network commissioning." Devices include several device discovery and configuration features. In addition to configuring devices, you must develop a strategy to place devices to ensure reliable routes. To accommodate these requirements, modules include features to aid in placing devices, configuring devices, and network diagnostics.

  • Page 98: Establish And Maintain Network Links

    Work with networked devices Establish and maintain network links 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: 1.

  • Page 99: Replace Nodes

    Work with networked devices Test links in a network - loopback cluster Example two: If you want all of the nodes in the network to build routes to an aggregator node with a MAC address of 0x0013A200 4052C507 without affecting the DH and DL registers of any nodes in the network: 1.

  • Page 100: Test Links Between Adjacent Devices

    Work with networked devices Test links between adjacent devices The configuration steps for sending data to the loopback cluster ID depend on what mode the device is in. For details on setting the mode, see AP (API Enable). The following sections list the steps based on the device's mode.

  • Page 101: Example

    Work with networked devices Test links between adjacent devices Number of bytes Field name Description Destination The address the device used to test its link. address Payload size The size of the test packet device A sent to test the link. Iterations The number of packets that device A sent.

  • Page 102: Rssi Indicators

    Work with networked devices Test links between adjacent devices frames can be sent by either device A, device B or device C and in all cases the test is the same: device A sends data to device B and reports the results. RSSI indicators The received signal strength indicator (RSSI) measures the amount of power present in a radio signal.

  • Page 103: Trace Route Option

    Work with networked devices Test links between adjacent devices The device you use to send FN transmits a zero-hop broadcast to all of its immediate neighbors. All of the devices that receive this broadcast send an RF packet to the device that transmitted the FN command.

  • Page 104: Nack Messages

    Work with networked devices Test links between adjacent devices NACK messages Transmit Request (0x10 and 0x11) frames contain a negative-acknowledge character (NACK) API option (Bit 2 of the Transmit Options field). If you use this option when transmitting data, when a MAC acknowledgment failure occurs on one of the hops to the destination device, the device generates a Route Information Packet (0x8D) frame and sends it to the originator of the unicast.

  • Page 105: Regulatory Information

    Regulatory information FCC (United States) ISED (Innovation, Science and Economic Development Canada) IFETEL (Mexico) XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 106: Fcc (United States)

    These 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. In order to operate under Digi’s FCC Certification, integrators must comply with the following regulations: 1.
  • Page 107 Regulatory information FCC (United States) Increase the separation between the equipment and receiver, Connect equipment and receiver to outlets on different circuits, or Consult the dealer or an experienced radio/TV technician for help. XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

  • Page 108: Rf Exposure Statement

    Section 15.247 (emissions). Fixed base station and mobile applications Digi devices are pre-FCC approved for use in fixed base station and mobile applications. When the antenna is mounted at least 34 cm from nearby persons, the application is considered a mobile application.

  • Page 109: Xbee-Pro Xtc Antenna Options

    Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. Dipole antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number...
  • Page 110 9.0 dB Fixed/mobile A09-Y14TM* 14 element Yagi 14.0 dBi RPTNC 9.9 dB Fixed/mobile 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.
  • Page 111 Part number Type Gain Connector Required antenna cable loss Application A09-F0NF* Fiberglass base station 0 dBi Fixed A09-F1NF* Fiberglass base station 1.0  dBi Fixed A09-F2NF-M Fiberglass base station 2.1 dBi Fixed A09-F3NF* Fiberglass base station 3.1 dBi Fixed A09-F4NF* Fiberglass base station 4.1 dBi Fixed A09-F5NF-M...
  • Page 112 7.1 dBi RPTNC 1.9 dB Fixed Dome antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
  • Page 113 Part number Type Gain Connector Required antenna cable loss Application A09-QRAMM 3" Quarter wave wire 2.1 dBi MMCX Fixed/mobile A09-QRSM-2.1* Quarter wave 2.1" right angle 3.3 dBi RPSMA 0.4 dB Fixed/mobile A09-QW* Quarter wave wire 1.9 dBi Permanent Fixed/mobile A09-QSM-3* Quarter wave straight 1.9 dBi RPSMA...

  • Page 114: Xbee Xtc Antenna Options

    XBee XTC antenna options The following tables cover the antennas that are approved for use with the XBee XTC RF modules. If applicable, the tables show the required cable loss between the device and the antenna. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.
  • Page 115 Part number Type Gain Connector Required antenna cable loss Application A09-Y6NF* 2 element Yagi 6.1 dBi Fixed/mobile A09-Y7NF* 3 element Yagi 7.1 dBi Fixed/mobile A09-Y8NF 4 element Yagi 8.1 dBi Fixed/mobile A09-Y9NF* 4 element Yagi 9.1 dBi Fixed/mobile A09-Y10NF* 5 element Yagi 10.1 dBi Fixed/mobile A09-Y11NF...
  • Page 116 15.1 dBi RPTNC 0.7 dB Fixed/mobile 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. Part number Type Gain Connector Required antenna cable loss...
  • Page 117 Wire Base Station 7.1 dBi RPTNC Fixed Dome antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
  • Page 118 3.0 dBi RPSMA 0.4 dB Fixed/mobile Monopole antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...

  • Page 119: Fcc Publication 996369 Related Information

    Host product manufacturers need to provide end-users a copy of the “RF Exposure” section of the manual: RF exposure statement. 2.7 Antennas A list of approved antennas is provided for the XTC product. For the XBee XTC DigiMesh RF Module, see XBee XTC antenna options. For the XBee-PRO XTC, see XBee-PRO XTC antenna options.
  • Page 120 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 XTC DigiMesh/XBee-PRO XTC DigiMesh Part 15 Subpart B compliance does not affirm the end product’s compliance.

  • Page 121: Ised (Innovation, Science And Economic Development Canada)

    (2) l'utilisateur de l'appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d'en compromettre le fonctionnement. Labeling requirements XBee XTC Labeling requirements for Industry Canada are similar to those of the FCC. A clearly visible label on the outside of the final product must display the following text: Contains Model XBSX Radio, IC: 1846A-XBSX The integrator is responsible for its product to comply with IC ICES-003 and FCC Part 15, Sub.

  • Page 122: Ifetel (Mexico)

    “Este equipo contiene el módulo XBP9X con IFT #: RCPDIXB19-2288” The IFETEL number for the XBee XTC product must be listed either on the end product, on the packaging, in the manual, or in the software with the following phrase: “Este equipo contiene el módulo XBPModel: XB9X con Número IFETEL: RCPDIXB19-1819”...
  • Page 123 PCB design and manufacturing The XTC RF Module is designed for surface-mount on the OEM PCB. It has castellated pads to allow for easy solder attach inspection. The pads are all located on the edge of the module, so there are no hidden solder joints on these modules.

  • Page 124: Recommended Footprint And Keepout

    PCB design and manufacturing Recommended footprint and keepout Recommended footprint and keepout We designed the XTC RF Module for surface-mounting on the OEM printed circuit board (PCB). It has castellated pads around the edges and one ground pad on the bottom. Mechanical drawings includes a detailed mechanical drawing.
  • Page 125 PCB design and manufacturing Recommended footprint and keepout The recommended footprint includes an additional ground pad that you must solder to the corresponding pad on the device. This ground pad transfers heat generated during transmit mode away from the device’s power amplifier. The pad must connect through vias to a ground plane on the host PCB.

  • Page 126: Design Notes

    PCB design and manufacturing Design notes Design notes The following guidelines help to ensure a robust design. Host board design A good power supply design is critical for proper device operation. If the supply voltage is not kept within tolerance, or is excessively noisy, it may degrade device performance and reliability. To help reduce noise, we recommend placing both a 1 uF and 100 pF capacitor as near to VCC (pin 2) as possible.

  • Page 127: Improve Antenna Performance

    PCB design and manufacturing Design notes Improve antenna performance The choice of antenna and antenna location is important for optimal performance. In general, antenna elements radiate perpendicular to the direction they point. Thus a vertical antenna, such as a dipole, emit across the horizon.

  • Page 128: Recommended Solder Reflow Cycle

    PCB design and manufacturing Recommended solder reflow cycle Number Description XBee pin 36 50 Ω microstrip trace Back off ground fill at least twice the distance between layers 1 and 2 RF connector Stitch vias near the edges of the ground plane Pour a solid ground plane under the RF trace on the reference layer Implementing these design suggestions helps ensure that the RF pad device performs to specifications.

  • Page 129: Flux And Cleaning

    PCB design and manufacturing Flux and cleaning Time (seconds) Temperature (degrees C) The maximum temperature should not exceed 260 °C. The XTC device will reflow during this cycle, and therefore must not be reflowed upside down. Take care not to jar the XTC while the solder is molten, as this can remove components under the shield from their required locations.
  • Page 130 PCB design and manufacturing Rework CAUTION! Any modification to the device voids the warranty coverage and certifications. XBee®/XBee-PRO XTend Compatible (XTC) DigiMesh RF Module User Guide...

This manual is also suitable for:

Xbee-pro xtc

Table of Contents