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

Digi XBee XTC User Manual

Radio frequency module
Hide thumbs Also See for XBee XTC:
Table of Contents

Advertisement

Quick Links

Download this manual
XBee/XBee-PRO XTC
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 Radio Frequency (RF) Module User Guide...

  • Page 2: Revision History

    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 Toll-free US and Canada: 866.912.3444 Worldwide: +1 952.912.3456 Online: www.digi.com/support/eservice XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 4: Table Of Contents

    Contents Revision history The XBee/XBee-PRO XTend Compatible (XTC) RF module About the XTC RF module Applicable firmware Technical specifications Performance specifications Power requirements Networking and security specifications Physical specifications Regulatory approvals Hardware Mechanical drawings Pin signals Recommended pin connections Modes Transparent and API operating modes Transparent operating mode API operating mode Additional modes...
  • Page 5 Sleep modes Transmit mode Enter Command mode Send AT commands Exit Command mode Enter Binary Command mode Exit Binary Command mode Binary Command mode FAQs Sleep modes Pin Sleep (SM = 1) Serial Port Sleep (SM = 2) Cyclic Sleep Mode (SM = 4-8) Operation Serial interface UART data flow...
  • Page 6 CF (Number Base) CN (Exit Command Mode) CT (Command Mode Timeout) E0 (Echo Off) E1 (Echo On) Diagnostic commands %V (Board Voltage) DB (Received Signal Strength) GD (Receive Good Count) HV (Hardware Version) RC (Ambient Power - Single Channel) RE (Restore Defaults) RM (Ambient Power) RP (RSSI PWM Timer) SH (Serial Number High)
  • Page 7 PE (Polling End Address) PK (Maximum RF Packet Size) PL (TX Power Level) TX (Transmit Only) Security commands KY (AES Encryption Key) Serial interfacing commands AP (API Enable) BD (Interface Data Rate) CD (GP02 Configuration) CS (GP01 Configuration) FL (Software Flow Control) FT (Flow Control Threshold) NB (Parity) RB (Packetization Threshold)
  • Page 8 Polling mode (acknowledged) Certifications FCC (United States) OEM labeling requirements FCC notices FCC antenna certifications XBee-PRO XTC Antenna options XBee XTC antenna options Industry Canada (IC) Labeling requirements Transmitters for detachable antennas Detachable antennas ACMA (Australia) Power requirements PCB design and manufacturing...
  • Page 9 Rework XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 10: The Xbee/Xbee-Pro Xtend Compatible (Xtc) Rf Module

    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 11: Technical Specifications

    Performance specifications The following table provides the performance specifications for the device. They cover the standard (XBee- PRO) and low-power (XBee) versions of the device. Specification XBee XTC XBee-PRO XTC Frequency range ISM 902 to 928 MHz RF data rate (software selectable)

  • Page 12: Power Requirements

    Technical specifications Power requirements The following table provides the power requirements for the device. Specification XBee XTC XBee-PRO XTC Supply voltage 2.4 to 3.6 VDC, 3.3 V typical 2.6 to 3.6 VDC, 3.3 V typical Receive current VCC = 3.3 V...

  • Page 13: Networking And Security Specifications

    Technical specifications Sleep Cycle RF data rate Cyclic sleep current (mA, mode time average) SM = 5 2 seconds BR = 0 4.16 BR = 1 0.72 SM = 4 1 second BR = 0 7.50 BR = 1 1.40 Networking and security specifications The following table provides the networking and security requirements for the device.

  • Page 14: Regulatory Approvals

    Maximum input RF level at antenna port 6 dBm Operating temperature -40°C to 85°C Regulatory approvals The following table provides the regulatory approvals for the device. Country XBee XTC XBee-PRO XTC United States FCC ID: MCQ-XBSX FCC ID: MCQ-XBPSX Canada IC: 1846A-XBSX...

  • Page 15: Hardware

    Hardware 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) RF Module User Guide...

  • Page 16: Pin Signals

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

  • Page 18: Recommended Pin Connections

    Pin signals Designation Function GPO1/CTS/RS- General Purpose Output / Clear-to-Send Flow Control / 485 TX_EN RS-485 Transmit Enable ON/SLEEP Module sleep status indicator Reserved Do not connect TX_PWR Transmit power RTS/CMD Request-to-Send Flow Control / Binary Command Control Disabled Disabled CONFIG Configuration Disabled...

  • Page 19: Modes

    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. We also call this mode “AT mode.” The device acts as a serial line replacement when it is in Transparent operating mode.

  • Page 20: Command Mode

    Additional modes Command mode Command mode is a state in which the firmware interprets incoming characters as commands. Command mode allows you to modify the device’s firmware using parameters you can set using AT commands. When you want to read or set any setting of the device, you have to send it an AT command. Every AT command starts with the letters "AT"...

  • Page 21: Transmit Mode

    Additional modes Cyclic Sleep: wakes when it detects RF activity For more information, see Sleep modes on page Transmit mode When the device receives serial data and is ready to packetize it, the device exits Idle mode and attempts to transmit the serial data. Enter Command mode There are two ways to enter Command mode: 1.

  • Page 22: Exit Command Mode

    Additional modes Respond to AT commands When you send a command to the device, the device parses and runs the command. If the command runs successfully, the device returns an OK message. If the command errors, the device returns an ERROR message.

  • Page 23: Sleep Modes

    Sleep modes The firmware does not allow control over when the device receives data, except by waiting for dead time between bursts of communication. If the command is sent in the middle of a stream of payload data, the device executes the command in the order it is received.

  • Page 24: Pin Sleep (Sm = 1)

    Sleep modes 2. The host asserts SLEEP (pin 10). This only applies to the Pin Sleep option. When in Sleep mode, the device does not transmit or receive data until it transitions to Idle mode. Use the SM command to enable or disable all Sleep modes. The following table shows the transitions into and out of Sleep modes.

  • Page 25: Serial Port Sleep (Sm = 2)

    Sleep modes When the host asserts the SLEEP pin, the device finishes any transmitting or receiving activity, enters Idle mode, then enters a sleep state. When in Pin Sleep mode, the device does not respond to serial or RF activity. After enabling Pin Sleep, the SLEEP pin controls whether the device is active or sleeping.
  • Page 26 Sleep modes transitions into Receive mode and receives the incoming RF packets. The device then returns to Sleep mode after a period of inactivity determined by the ST parameter. You can also configure the device to wake from cyclic sleep when the SLEEP pin is de-asserted. To configure a device to operate in this manner, you must issue the PW (Pin Wake-up) command.

  • Page 27: Operation

    Operation 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 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.

  • Page 28: Flow Control

    Flow control Flow control The RTS and CTS device pins provide RTS and/or CTS flow control. CTS flow control signals the host to stop sending serial data to the device. RTS flow control lets the host signal the device so it will not send the data in the serial transmit buffer out the UART.

  • Page 29: Data Out (Do) Buffer And Flow Control

    Flow control 1. The device does not receive any serial characters for the amount of time set with in the RO command; see RO (Packetization Timeout) on page 2. The device receives the maximum number of characters that fits in an RF packet. 3.
  • Page 30 Flow control host. 2. If the host does not allow the device to transmit data out from the DOUT buffer because of being held off by hardware or software flow control. XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 31: Configure The Xtc Rf Module

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

  • Page 32: Program The Xtc Rf Module

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

  • Page 33: Modify A Device Address

    XTC RF Module programming examples Modify a device address The following programming example shows you how to modify the device's destination address. 1. Once you add the device in XCTU, click on it in the Radio Modules pane to display the Configuration working mode.

  • Page 34: Query Binary Commands

    XTC RF Module programming examples 2. Drive pin 29 high to assert CMD. To accomplish this, de-assert the RTS line in XCTU. The device enters Binary Command mode. 3. Send hexadecimal bytes (parameter bytes must be 2 bytes long). The next four lines are examples, not required values: 00 (Send binary command DT) 0D (Least significant byte of parameter bytes)

  • Page 35: Xtc Rf Module Commands

    XTC RF Module commands The following table lists the AT and binary commands in the XTC RF Module firmware and links to the description of the individual command. By default, the device expects numerical values in hexadecimal since the default value of the CF (Number Base) Parameter is 1.
  • Page 36 AT command Binary command CF (Number Base) on page 40 CN (Exit Command Mode) on page 41 0x09 (9d) CS (GP01 Configuration) on page 75 0x1F (31d) CT (Command Mode Timeout) on page 42 0x06 (6d) DB (Received Signal Strength) on page 44 0x36 (54d) DT (Destination Address) on page 57 0x00 (0d)
  • Page 37 AT command Binary command KY (AES Encryption Key) on page 71 0x43 (67d) LH (Wakeup Initializer Timer) on page 82 0x0C (12d) MD (RF Mode) on page 64 0x31 (49d) MK (Address Mask) on page 59 0x12 (18d) MT (Multi-transmit) on page 59 0x3E (62d) MY (Source Address) on page 60 0x2A (42d)
  • Page 38 AT command Binary command RO (Packetization Timeout) on page 79 0x21 (33d) RP (RSSI PWM Timer) on page 49 0x22 (34d) RR (Retries) on page 62 0x18 (24d) RT (GPI1 Configuration) on page 79 0x16 (22d) SB (Stop Bits) on page 80 0x37 (55d) SH (Serial Number High) on page 50 0x25 (37d)

  • Page 39: Command Mode Options

    Command mode options AT command Binary command WS (Sticky Warning Numbers) on page 56 Command mode options The following AT commands are Command mode option commands. AT (Guard Time After) Sets or reads the time-of-silence that follows the CC (Command Sequence Character) of the Command mode sequence (BT + CC + AT).

  • Page 40: Cc (Command Sequence Character)

    Command mode options Command type Command mode options Parameter range 0 - 0x1770 [x 100ms] Default 0x0A (1 second) Bytes returned CC (Command Sequence Character) The ASCII character value you use to enter Command mode. Use CC to set or read the character used between guard times of the Command mode sequence (BT + CC + AT).

  • Page 41: Cn (Exit Command Mode)

    Command mode options VR (Firmware Version) HV (Hardware Version) KY (AES Encryption Key) Binary command Command type Command mode options Parameter range 0 - 2 Parameter Configuration Commands use the default number base; decimal commands may output units. All commands are forced to unsigned, unit-less hex. Commands use their default number base;...

  • Page 42: Ct (Command Mode Timeout)

    Command mode options Parameter range Default Bytes returned CT (Command Mode Timeout) Set or read the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode. Use the CN (Exit Command mode) command to exit Command mode manually.

  • Page 43: E1 (Echo On)

    Diagnostic commands Command type Command mode options Parameter range Default Bytes returned E1 (Echo On) Enables character echo in Command mode. Each character that you type echoes back to the terminal when E1 is active. E0 (Echo Off) is the default. Binary command 0x0B (11 decimal) Command type...

  • Page 44: Db (Received Signal Strength)

    Diagnostic commands The conversion of the hex value returned by %V to Volts is VAL/65536 = Volts. Example: 2.8 VDC = 2.8 * 65536 = 0x2CCCD 3.3 VDC = 3.3 * 65536 = 0x34CCD Sample output 3.27 V (when CF = 0) 345E3 (when CF = 1) 3.27 (when CF = 2) Binary command...

  • Page 45: Gd (Receive Good Count)

    Diagnostic commands Sample output -88 dBm (when CF = 0) 58 (when CF = 1) -88 (when CF = 2) Note: If the firmware reads the DB register before the device receives an RF packet, the devices returns a value of 0x8000. Binary command 0x36 (54 decimal) Command type...

  • Page 46: Hv (Hardware Version)

    Diagnostic commands Command type Diagnostics Parameter range 0 - 0xFFFF Default Bytes returned HV (Hardware Version) Reads the device's hardware version number. Binary command Command type Diagnostics Parameter range (read-only): 0 - 0xFFFF Default Bytes returned RC (Ambient Power - Single Channel) Reads and reports the power level on a given channel.

  • Page 47: Re (Restore Defaults)

    Diagnostic commands -78 (when CF = 2) Binary command Parameter range (read-only): 0 - 0x31 [dBm] Default Bytes returned RE (Restore Defaults) Restore device parameters to factory defaults. RE does not cause the device to store default values to non-volatile (persistent) memory. You must send the WR command prior to power-down or reset to save the default settings in the device's non-volatile memory.

  • Page 48: Rm (Ambient Power)

    Diagnostic commands RM (Ambient Power) Reads and reports power levels on all channels. If you do not provide a parameter, the device scans the channels one time. If you do provide a parameter, the device scans the channels repeatedly for the number of seconds that the parameter calls for.

  • Page 49: Rp (Rssi Pwm Timer)

    Diagnostic commands Command type Diagnostics Parameter range no parameter - 0x7D0 Default Bytes returned RP (RSSI PWM Timer) Enables a pulse-width modulated (PWM) output on the RSSI pin (pin 7 of the device). 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 50: Sh (Serial Number High)

    Diagnostic commands Parameter range 0 - 0xFF [x 100 milliseconds] Default 0x20 (3.2 seconds) Bytes returned SH (Serial Number High) Sets or reads the device's serial number high word. Binary command 0x25 (37 decimal) Command type Diagnostics Parameter range 0 - 0xFFFF Default Varies Bytes returned...

  • Page 51: Tp (Board Temperature)

    Diagnostic commands Parameter range (read-only): 0 - 0xFFFF Default Varies Bytes returned TP (Board Temperature) The current module temperature in degrees Celsius in 8-bit two’s compliment format. For example 0x1A = 26°C, and 0xF6 = -10°C. Sample output 26 C when CF = 0 1A when CF = 1 26 when CF = 2 Binary command...

  • Page 52: Vl (Firmware Version - Verbose)

    Diagnostic commands This value is volatile (the value does not persist in the device's memory after a power-up sequence). Binary command 0x1B (27 decimal) Parameter range 0 - 0xFFFF Default Bytes returned VL (Firmware Version - Verbose) Reads the verbose firmware version of the device. Binary command Parameter range Returns a string...

  • Page 53: Wa (Active Warning Numbers)

    Diagnostic commands Command type Diagnostics Parameter range (read-only): 0 - 0xFFFF Default Bytes returned WA (Active Warning Numbers) Reports the warning numbers of all active warnings, one warning number per line. It does not show further information and does not reset warning counts. For information on what the warning numbers mean, see WN (Warning Data) on the next page.

  • Page 54: Wn (Warning Data)

    Diagnostic commands WN (Warning Data) Reports the following data for all active and sticky warnings: Warning number and description Number of occurrences since the last WN or WS command Whether the warning is currently active WN does not display warnings that are not currently active and have not been active since the last issuance of the WN or WS commands.
  • Page 55 Diagnostic commands Warning Description Default configuration parameters in flash. This is caused if user-modifiable parameters (i.e. those stored by WR) in flash are all the compiled-in default values. This is caused if the user configuration is found to be not present or invalid at power-up and there is no custom configuration, or if no user-modifiable parameters have been modified from the compiled- in defaults.

  • Page 56: Ws (Sticky Warning Numbers)

    MAC/PHY commands WS (Sticky Warning Numbers) Reports warning numbers of all warnings active since the last use of WS or WN, including any warnings that are currently active. WS also resets all non-zero warning counts, except for warnings that are presently active, which are set to 1.

  • Page 57: Dt (Destination Address)

    MAC/PHY commands Default Bytes returned DT (Destination Address) Sets or reads the networking address of a device. The devices use three filtration layers: Vendor ID Number (ATID) Channel (ATHP) Destination Address (ATDT) The DT command assigns an address to a device that enables it to communicate with other devices in the network.

  • Page 58: Hp (Preamble Id)

    MAC/PHY commands HP (Preamble ID) Set or read the device's hopping channel number. A channel is one of three layers of filtration available to the device. In order for devices to communicate with each other, the devices must have the same channel number since each channel uses a different hopping sequence.

  • Page 59: Mk (Address Mask)

    MAC/PHY commands Bytes returned MK (Address Mask) Sets or read the device's Address Mask. All RF data packets contain the Destination Address of the transmitting (TX) device. When a device receives a packet, the TX device's Destination Address is logically combined bitwise (in other words, joined with AND) with the Address Mask of the receiving (RX) device.

  • Page 60: My (Source Address)

    MAC/PHY commands When a receiving device receives a packet with remaining forced retransmissions, it calculates the length of the packet and inhibits transmission for the amount of time required for all retransmissions. From that time on, the device inserts a random number of delay slots between 0 and RN before allowing transmission from the receiving devices.

  • Page 61: Rn (Delay Slots)

    MAC/PHY commands Default 0xFFFF (Disabled - DT (Destination Address) parameter serves as both source and destination address). Bytes returned RN (Delay Slots) Sets or reads the time delay that the transmitting device inserts before attempting to resend a packet. If the transmitting device fails to receive an acknowledgment after sending a packet, it inserts a random number of delay slots (ranging from 0 to (RN minus 1)) before attempting to resend the packet.

  • Page 62: Rr (Retries)

    MAC/PHY commands RR (Retries) Sets or reads the maximum number of retries sent for a given RF packet. When you enable RR (RR > 0), it enables RF packet retries and ACKs. Exceptions: If you enable the MT command (MT > 0) or if you use a broadcast destination address (DT = 0xFFFF) it disables RF packet retries and ACKs.

  • Page 63: Rf Interfacing Commands

    RF interfacing commands Command type MAC/PHY Parameter range 0 - 0xFFFF [bytes] Default Bytes returned RF interfacing commands The following AT commands are RF interfacing commands. BR (RF Data Rate) Sets and reads the device's RF data rate (the rate at which the device transmits and receives RF data over-the-air).

  • Page 64: Fs (Forced Synch Time)

    RF interfacing commands FS (Forced Synch Time) The FS command only applies to streaming data. Normally, only the first packet of a continuous stream contains the full RF initializer. The RF devices then remain synchronized for subsequent packets of the stream.

  • Page 65: Pb (Polling Begin Address)

    RF interfacing commands Command type RF interface Parameter range 0 - 6 Parameter Configuration Transparent Operation (Repeater Base) Reserved - not used Reserved - not used Polling Base Polling Remote Repeater Repeater End Node Default Bytes returned PB (Polling Begin Address) Sets or reads the device’s Polling Begin Address, which is the first address polled when you enable Polling mode.

  • Page 66: Pd (Minimum Polling Delay)

    RF interfacing commands Parameter range 0 - 0xFFFF Default Bytes returned PD (Minimum Polling Delay) Sets or reads the Polling Delay (Base, MD = 3) or Polling Timeout (Remote, MD = 4). Polling Delay (Base) is the time between polling cycles. The Polling Base starts the polling cycle after sending the first poll.

  • Page 67: Pk (Maximum Rf Packet Size)

    RF interfacing commands Binary command 0x46 (70 decimal) Command type RF interface Parameter range 0 - 0xFFFF Default Bytes returned PK (Maximum RF Packet Size) Sets or reads the maximum size of RF packets that a device in Transparent operating mode (AP = 0) transmits.
  • Page 68 RF interfacing commands Default 0x100 (BR=0) 0x800 (BR=1) Bytes returned When BR = 0 (9600 baud), the maximum PK value is 0x100 (256 bytes). When BR = 1 (115,200 baud), the maximum PK value is 0x800 (2048 bytes). XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 69: Tx Power Level)

    RF interfacing commands PL (TX Power Level) Sets or reads the power level at which the device transmits conducted power. The PRO XTC device requires the power supply to be above 3.3 V to ensure 30 dBm output power. The following table shows the typical values over supply voltage.

  • Page 70: Tx (Transmit Only)

    RF interfacing commands XB9XT (non-PRO) XBP9XT (PRO) Parameter Configuration Configuration 13 dBm 30 dBm (1 Watt) Default Bytes returned TX (Transmit Only) Sets or reads the transmit or receive behaviors of the device. Setting a device to TX-only (TX = 1) may reduce latency because the you can not limit the transmitting device to receiving data from other devices.

  • Page 71: Security Commands

    Security commands Security commands The following AT commands are security commands. KY (AES Encryption Key) Sets the 256-bit Advanced Encryption Standard (AES) key for encrypting or decrypting data. Once set, you cannot read the key cannot out of the device by any means. The firmware encrypts the entire payload of the packet using the key and computes the CRC across the ciphertext.

  • Page 72: Serial Interfacing Commands

    Serial interfacing commands Serial interfacing commands The following AT commands are serial interfacing commands. AP (API Enable) The API mode setting. The device can format the RF packets it receives into API frames and send them out the serial port. When you enable API, you must format the serial data as API frames because Transparent operating mode is disabled.
  • Page 73 Serial interfacing commands When you make an update to the interface data rate, the change does not take effect until the host issues the CN command and the device returns the OK response. The BD parameter does not affect the RF data rate. If you set the interface data rate higher than the RF data rate, you may need to implement a flow control configuration.

  • Page 74: Cd (Gp02 Configuration)

    Serial interfacing commands 0x4B0 - 0x1C9468 (non-standard rates; ; 0x2581 to 0x4AFF not supported) Parameter Configuration (b/s) 1200 2400 4800 9600 19200 38400 57600 115200 230400 Default Bytes returned CD (GP02 Configuration) Selects or reads the behavior of the GPO2 line (pin 5). Binary command 0x28 (40 decimal) Parameter range...

  • Page 75: Cs (Gp01 Configuration)

    Serial interfacing commands Parameter Configuration RX LED Static high Static low Reserved RX LED (valid address only) Default Bytes returned CS (GP01 Configuration) Sets or reads the behavior of the GPO1 line (pin 25). This output can provide RS-232 flow control and controls the TX enable signal for RS-485 or RS-422 operations.

  • Page 76: Fl (Software Flow Control)

    Serial interfacing commands Parameter Configuration RS-485 TX enable high Static low Default Bytes returned FL (Software Flow Control) Configures software flow control. Use the CS and RT commands to implement Hardware Flow Control. Set FL to 1 to enable Software flow control (XON/XOFF). Set FL to 0 to disable Software flow control.

  • Page 77: Ft (Flow Control Threshold)

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

  • Page 78: Rb (Packetization Threshold)

    Serial interfacing commands Parameter Configuration 8-bit mark 8-bit space Default Bytes returned RB (Packetization Threshold) Sets or reads the character threshold value. RF transmission begins after a device receives data in the DIN buffer and meets either of the following criteria: The UART receives RB characters The UART receive lines detect RO character times of silence after receiving at least 1 byte...

  • Page 79: Packetization Timeout)

    Serial interfacing commands Bytes returned RO (Packetization Timeout) Set or read the number of character times of inter-character silence required before transmission begins. For information on how RO works with the RB command, see RB (Packetization Threshold) on the previous page. When RO is the transmission-beginning criteria: The actual time between the reception of the last character from the UART and the beginning of RF transmission is at least 800 µsec longer than the actual RO time to allow for transmission setup.

  • Page 80: Sb (Stop Bits)

    Serial interfacing commands Binary command 0x16 (22 decimal) Parameter range 0 - 2 Parameter Configuration Disabled Binary Command enable RTS flow control Default 0 (disabled) Bytes returned SB (Stop Bits) Sets or reads the number of stop bits in the data packet. Binary command 0x37 (55 decimal) Parameter range...

  • Page 81: Sleep Commands

    Sleep commands Default Bytes returned Sleep commands The following AT commands are sleep commands. FH (Force Wakeup Initializer) Forces the device to send a wake-up initializer on the next transmission. Only use FH with cyclic sleep modes active on remote devices. FH will not send a long header if HT = 0xFFFF.

  • Page 82: Lh (Wakeup Initializer Timer)

    Sleep commands For RX devices operating in Cyclic Sleep mode (SM = 4-8), set HT to be shorter than the ST command. The TX device sends a wake-up initializer, which instructs all receiving (RX) devices to remain awake to receive RF data. From the perspective of the RX device: after HT time elapses and the inactivity timeout (ST command) is met, the RX device goes into cyclic sleep.

  • Page 83: Pw (Pin Wakeup)

    Sleep commands Binary command 0x0C (12 decimal) Command type Sleep Parameter range 0 - 0xFF [x100 milliseconds] Default Bytes returned PW (Pin Wakeup) Enables or disables the sleep pin. Under normal operation, a device in Cyclic Sleep mode cycles from an active state to a low-power state at regular intervals until it is ready to receive data.

  • Page 84: Sm (Sleep Mode)

    Sleep commands Parameter Configuration Disabled Enabled Default Bytes returned SM (Sleep Mode) Sets or reads the device's sleep mode settings, which configure the device to run in states that require minimal power consumption. Binary command 0x01 Command type Sleep Parameter range 0 - 8 (3 is reserved) Parameter Description...

  • Page 85: St (Time Before Sleep)

    Sleep commands Parameter Description Cyclic 2 second sleep Cyclic 4 second sleep Cyclic 8 second sleep Cyclic 16 second sleep Default Bytes returned ST (Time before Sleep) Sets or reads the amount of time (in milliseconds) that the device remains inactive before entering Sleep mode.

  • Page 86: Xtc Rf Modulespecial Commands

    XTC RF ModuleSpecial commands XTC RF ModuleSpecial commands The following AT commands are special commands. WR (Write) Writes parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. If you make changes without writing them to non-volatile memory, the device reverts to previously saved parameters the next time it is powered on.

  • Page 87: Xtc Rf Module Api Operation

    XTC RF Module API operation API mode overview By default, the XTC RF Module acts as a serial line replacement (Transparent operation), it queues all UART data that it receive through the DI pin for RF transmission. When the device receives an RF packet, it sends the data out the DO pin with no additional information.
  • Page 88 API mode 2 is rarely necessary to use. API mode 1 is fully capable of transmitting all characters including those that can be escaped. If you think you need to use API mode 2, contact Digi Support so we can discuss your application.
  • Page 89 API mode overview Frame fields Byte Description Length 2 - 3 Most Significant Byte, Least Significant Byte Characters escaped if needed Frame Data 4 - n API-specific structure Checksum n + 1 1 byte The following paragraphs explain what the fields within the API frame mean. Start delimiter The first byte of a frame consists of a special sequence of bits that indicate the beginning of a data frame.

  • Page 90: Calculate And Verify Checksums

    API mode overview Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines. The Frame Type byte indicates which API messages the data bytes (Identifier-specific data) will contain. Checksum The value 0xFF minus the 8-bit sum of bytes from offset 3 to this byte.
  • Page 91 API mode overview In API operating mode with escaped characters, the length field does not include any escape characters in the frame and the firmware calculates the checksum with non-escaped data. XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 92: Xtc Rf Moduleapi Frame Overview

    XTC RF ModuleAPI frame overview Example: escape an API frame To express the following API non-escaped frame in API operating mode with escaped characters: Start delimiter Length Frame type Frame Data Checksum Data 00 0F 17 01 00 13 A2 00 40 AD 14 2E FF FE 02 4E 49 6D You must escape the 0x13 byte: 1.

  • Page 93: Transmit Request: 16-Bit Address 0X01

    XTC RF ModuleAPI frame overview Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications on page Frame fields Byte(s) Description Frame type 0x8A Status 0x00 = Hardware reset 0x01 = Watchdog timer reset Example When a device powers up, it returns the following API frame: Frame fields...
  • Page 94 XTC RF ModuleAPI frame overview Frame fields Byte(s) Description Frame type 0x01 Frame ID Identifies the data frame for the host to correlate with a subsequent ACK. Setting Frame ID to 0 disables the response frame. Destination MSB first, LSB last. Broadcast = 0xFFFF.

  • Page 95: Transmit Status Frame 0X89

    XTC RF ModuleAPI frame overview Frame fields Offset Example RF data 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 Checksum 0xAE Transmit Status frame 0x89 Description When a TX Request is completed, the device sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure.

  • Page 96: Receive Packet: 16-Bit Address 0X81

    XTC RF ModuleAPI frame overview Frame Byte Description fields Frame Identifies the data frame for the host to correlate with a subsequent ACK. Setting Frame ID to 0 disables the response frame. Status 0 = success. 1 = all retries expired and no ACK received. 3 = a packet is purged due to a Polled Remote not receiving a poll.
  • Page 97 XTC RF ModuleAPI frame overview Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications on page Frame Byte Description fields Frame 0x81 type Source MSB first LSB last address RSSI RSSI = hexadecimal equivalent of -dBm value.
  • Page 98 XTC RF ModuleAPI frame overview Frame fields Offset Example Source address MSB 4 0xA3 LSB5 0x5E RSSI 0x5D Options 0x01 RF data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0xDB XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 99: Network Configurations

    Network configurations network topologies The XTC RF Module supports three different network topologies: point-to-point, point-to-multipoint and peer-to-peer. Point-to-point networks This following section provides the RF communication type and RF mode for XTC RF Module point-to-point networks. Definition Point-to-point means an RF data link between two devices. Sample network profile (Broadcast communications) Use the default values for all devices.

  • Page 100: Point-To-Multipoint Networks

    network topologies Acknowledged RF mode Acknowledged mode. Point-to-multipoint networks This following section provides the RF communication type and RF mode for XTC RF Module point-to- multipoint networks. Definition Point-to-multipoint means a network with RF data links between one base and multiple remotes. Sample network profile (Broadcast communications) Note: Assume the default value for all parameters that are not in this list.

  • Page 101: Peer To Peer Networks

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

  • Page 102: Addressing

    Addressing 1. Send ATMY 0 to set the source address to 0x00. 2. Send ATDT FFFF to set the destination address to 0xFFFF. 3. Send ATRR 3 to set the number of retries to 3. Basic RF modes Streaming. Acknowledged RF mode Acknowledged.

  • Page 103: Basic Communications

    Basic communications The transmitting device determines whether the packet is for a specific node (local address) or multiple nodes (global address) by comparing the packet's destination address (DT) and its own address mask (MK). This assumes you program the address masks on the transmitting device and receiving device to the same value for proper operation in each RF communication mode.

  • Page 104: Multi-Transmit Mode

    Basic communications After transmission begins, the transmission event continues without interruption until the DIN buffer is empty or the device reaches the streaming limit (TT parameter). As with the first packet, the payload of each subsequent packet includes up to the maximum packet size (PK parameter). The TX (transmitting) device specifies the TT parameter as the maximum number of bytes the TX device can send in one transmission event.

  • Page 105: Repeater Mode

    Basic communications follow-on packets, each of which retransmit MT times. Devices ignore the Forced Sync (FS) parameter in Multi-Transmit Mode. The firmware does not apply the RB and RO parameters to follow-on packets, meaning that once transmission has begun, it continues without interruption until the DIN buffer is empty or the device reaches the streaming limit (TT parameter).
  • Page 106 Basic communications Characteristics Low power consumption. Minimizes interference Tags each RF packet with a unique Packet ID (PID). Each repeater only repeats a packet once (the PID tracks the packet). Increases latency and decreases throughput. The number of hops determine latency and throughput, not the number of repeaters.
  • Page 107 Basic communications network, the repeater system uses a sophisticated algorithm to propagate each RF packet through the entire network. The network supports RF packets up to 2048 bytes when the RF data rate is set at 9600 bps (BR = 0). The repeater network can operate using broadcast or addressed communications for multi-drop networks, and it works well in many systems with no special configuration.
  • Page 108 Basic communications 3. Configure PK, RO and RB to ensure that the RF packet aligns with the protocol packet. For example: PK=0x100 RB=0x100 RO depends on baud rate 4. Set MD = 5 to configure one or more devices that you do not intend to be repeaters as repeater End Nodes in the system.
  • Page 109 Basic communications The algorithm maintains a list of messages previously received in a buffer. The firmware discards messages already in the buffer. This eliminates End Nodes receiving multiple copies of a packet from more than one source, and also eliminates multiple repeaters within range of each other from continually passing messages in an infinite loop.

  • Page 110: Polling Mode (Basic)

    Basic communications Response packet delay As a packet propagates through the repeater network, if any node receives the data and generates a quick response, the network needs to delay the response so as not to collide with subsequent retransmissions of the original packet. To reduce collisions, both repeater and end node devices in a repeater network delay transmission of data shifted in the serial port to allow any repeaters within range to complete their retransmissions.
  • Page 111 Basic communications Characteristics Uses a high percentage of available network bandwidth. Eliminates collisions. Works with reliable delivery (RR or MT parameters). Supports binary data transfers. Base device requests packets from remote device by polling a sequential range of addresses. Base device is configured to specify the range of addresses being polled. Uses inter-character delay to create RF packet lengths aligned with protocol packet lengths up to 2048 bytes long.

  • Page 112: Acknowledged Communications: Acknowledged Mode

    Acknowledged communications: Acknowledged mode Configure a Polling Base To configure a device as a Polling Base: 1. Set MD = 3. 2. Set MY = 0. 3. Set the sequential range of polling addresses using PB and PE. 4. (Optional) Enable Basic Reliable Delivery (MT ≥ 0). The firmware also supports Acknowledged Reliable Delivery.

  • Page 113: Acknowledged Mode Connection Sequence

    Acknowledged communications: Acknowledged mode Acknowledged mode connection sequence After sending a packet while in Acknowledged mode, the TX (transmitting) device listens for an acknowledgment (ACK). If it receives the ACK, it either moves on to sending a subsequent packet if more transmit data is pending or waits for exactly RN random delay slots before allowing another transmission if no more data is pending transmit.

  • Page 114: Polling Mode (Acknowledged)

    Acknowledged communications: Acknowledged mode to a non-zero value. The RX device does not transmit for a random number of delay slots between 0 and (RN-1), if the local RN parameter is set to a non-zero value. The intent of these delays is to lessen congestion following long bursts of packets from a single TX device, during which several RX devices may have themselves become ready to transmit.
  • Page 115 Acknowledged communications: Acknowledged mode Required MD (RF Mode) = 4 parameter values (Remote) Related Networking (RR, PD, DT, MY, AM) commands For configuration and theory of operation information, see Polling mode theory of operation on page 111, Configure a Polling Base on page 112 Configure a Polling Remote on page 112.

  • Page 116: 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. The integrator must ensure that the text provided with this device (in the labeling requirements section that follows) is placed on the outside of the final product and within the final product operation manual.

  • Page 117: Fcc Notices

    (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 20cm (8") from nearby persons, the application is considered a mobile application.

  • Page 118: 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.
  • Page 119 Half-wave RPSMA 2.1 dBi 0.4 dB Fixed dipole Yagi antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part Type Gain Connector Required Antenna Application...
  • Page 120 FCC (United States) Part Type Gain Connector Required Antenna Application Number Cable Loss A09-Y8NF 4 element 8.1 dBi 4.0 dB Fixed/Mobile Yagi A09-Y9NF* 4 element 9.1 dBi 5.0 dB Fixed/Mobile Yagi A09- 5 element 10.1 dBi 6.0 dB Fixed/Mobile Y10NF* Yagi A09-Y11NF 6 element...
  • Page 121 9.9 dB Fixed/Mobile Y14TM* element 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. Part Type Gain Connector Required Antenna Cable...
  • Page 122 FCC (United States) Part Type Gain Connector Required Antenna Cable Application Number Loss A09-F3NF* Fiberglass Base Fixed Station A09-F4NF* Fiberglass Base Fixed Station A09-F5NF- Fiberglass Base Fixed Station A09-F6NF* Fiberglass Base 0.9 dB Fixed Station A09-F7NF* Fiberglass Base 1.9 dB Fixed Station A09-F8NF-...
  • Page 123 FCC (United States) Part Type Gain Connector Required Antenna Cable Application Number Loss A09-F5SM* Fiberglass Base RPSMA Fixed Station A09-F6SM* Fiberglass Base RPSMA 0.9 dB Fixed Station A09-F7SM* Fiberglass Base RPSMA 1.9 dB Fixed Station A09-F8SM* Fiberglass Base RPSMA 2.9 dB Fixed Station A09-F0TM*...
  • Page 124 Fixed A09-W7TM* Wire Base Station 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 Type Gain Connector Required Antenna...
  • Page 125 FCC (United States) 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 Type Gain Connector Required Antenna Application Number Cable Loss A09-QRAMM 3" Quarter wave wire...

  • Page 126: 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 127 Fixed wave A09-H* Half-wave dipole RPSMA 0.4 dB Fixed Yagi antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part Type Gain Connector Required Application...
  • Page 128 FCC (United States) Part Type Gain Connector Required Application Number Antenna Cable Loss A09-Y8NF 4 element 8.1 dBi Fixed/Mobile Yagi A09-Y9NF* 4 element 9.1 dBi Fixed/Mobile Yagi A09-Y10NF* 5 element 10.1 dBi Fixed/Mobile Yagi A09-Y11NF 6 element 11.1 dBi Fixed/Mobile Yagi A09-Y12NF* 7 element...
  • Page 129 FCC (United States) Part Type Gain Connector Required Application Number Antenna Cable Loss A09-Y7TM* 3 element 7.1 dBi RPTNC Fixed/Mobile Yagi A09-Y8TM* 4 element 8.1 dBi RPTNC Fixed/Mobile Yagi A09-Y9TM* 4 element 9.1 dBi RPTNC Fixed/Mobile Yagi A09-Y10TM- 5 element 10.1 dBi RPTNC Fixed/Mobile...
  • Page 130 FCC (United States) 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 Type Gain Connector Required Antenna Cable Application Number Loss...
  • Page 131 FCC (United States) Part Type Gain Connector Required Antenna Cable Application Number Loss A09-F1SM* Fiberglass Base RPSMA Fixed Station A09-F2SM* Fiberglass Base RPSMA Fixed Station A09-F3SM* Fiberglass Base RPSMA Fixed Station A09-F4SM* Fiberglass Base RPSMA Fixed Station A09-F5SM* Fiberglass Base RPSMA Fixed Station...
  • Page 132 Fixed A09-W7TM* Wire Base Station 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. XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...
  • Page 133 Omnidirectional RPSMA 0.4 dB Fixed/Mobile D3PSM* permanent mount 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 Type Gain Connector Required Antenna Application...

  • Page 134: Industry Canada (Ic)

    Industry Canada (IC) Part Type Gain Connector Required Antenna Application Number Cable Loss A09-QBMM- Quarter wave w/ 6" MMCX Fixed/Mobile P6I* pigtail A09-QHSM- 2" straight RPSMA Fixed/Mobile A09-QHRSM- 2" right angle RPSMA Fixed/Mobile A09-QHRSM- 1.7" right angle RPSMA Fixed/Mobile 170* A09-QRSM- 3.8"...

  • Page 135: Labeling Requirements

    Industry Canada (IC) 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 136: 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. XBee/XBee-PRO XTend Compatible (XTC) RF Module User Guide...

  • Page 137: Pcb Design And Manufacturing

    PCB design and manufacturing 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 on page 15 includes a detailed mechanical drawing.
  • Page 138 Recommended footprint and keepout power amplifier. The pad must connect through vias to a ground plane on the host PCB. Connecting to planes on multiple layers will further improve the heat transfer performance and we recommend doing this for applications that will be in transmit mode for sustained periods. We recommend using nine 0.012 inch diameter vias in the pad as shown.

  • Page 139: Design Notes

    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 140 Design notes For the transmission line, we recommend either a microstrip or coplanar waveguide trace on the PCB. We provide a microstrip example below, because it is simpler to design and generally requires less area on the host PCB than coplanar waveguide. We do not recommend using a stripline RF trace because that requires routing the RF trace to an inner PCB layer, and via transitions can introduce matching and performance problems.
  • Page 141 Design notes 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 suggestion will help ensure that the RF Pad module performs to specifications.

  • Page 142: Recommended Solder Reflow Cycle

    Recommended solder reflow cycle Recommended solder reflow cycle The following table provides the recommended solder reflow cycle. The table shows the temperature setting and the time to reach the temperature; It does not show the cooling cycle. Time (seconds) Temperature (degrees C) The maximum temperature should not exceed 260°C.

  • Page 143: Flux And Cleaning

    Flux and cleaning Flux and cleaning We recommend that you use a “no clean” solder paste in assembling these devices. This eliminates the clean step and ensures that you do not leave unwanted residual flux under the device where it is difficult to remove.

This manual is also suitable for:

Xbee-pro xtc

Table of Contents