电子工程世界电子工程世界电子工程世界

关键词

搜索

型号

搜索

X24-019NMT

器件型号:X24-019NMT
器件类别:模块/解决方案   
厂商名称:Digi International
下载文档 在线购买

X24-019NMT在线购买

供应商 器件名称 价格 最低购买 库存  
X24-019NMT - - 点击查看 点击购买

器件描述

RF Modules 24XStream 50mW tran r w/MMCX 19200 bps

参数
产品种类
Product Category
RF Modules
制造商
Manufacturer
Digi International
RoHSDetails
工厂包装数量
Factory Pack Quantity
1
单位重量
Unit Weight
7.054792 oz

X24-019NMT器件文档内容

XStream™ OEM RF Module

Product Manual v5.x00

For XStream OEM RF Module Part Numbers:  X09-001…    X24-009…             XH9-001…

                                         X09-009…    X24-019…             XH9-009…

                                         X09-019…                         XH9-019…

Reliable 900 MHz and 2.4 GHz OEM RF Modules by Digi  International  Inc.
XStream™ OEM RF Module – Product Manual v5.x00

XStream OEM RF Module           –  Product Manual v5.x00

(Part number 90002209 B)

Revision   Date                                 Description

B          10/15/14                             Minor changes and new  part  number

© 2014 Digi International Inc. All rights reserved

Digi, Digi International, the Digi logo, and XStream® are

trademarks or registered trademarks of Digi International Inc.

in the United States and other countries worldwide. All other

trademarks mentioned in this document are the property of

their respective owners.

Information in this document is subject to change without

notice and does not represent a commitment on the part of

Digi International. Digi provides this document “as is,”

without warranty of any kind, expressed or implied,

including, but not limited to, the implied warranties of fitness

or merchantability for a particular purpose. Digi may make

improvements and/or changes in this manual or in the

product(s) and/or the program(s) described in this manual at

any time.

© 2014 Digi International Inc.                                                       ii
    XStream™ OEM RF Module – Product Manual v5.x00

Contents

                                                        IC (Industry Canada) Certification         53

1.  XStream OEM RF Module                           4   Appendix B: Development Guide              54

    1.1.    Features                                4   XStream OEM Development Kit Contents       54

    1.1.1.  Worldwide Acceptance                    5   Interfacing Hardware                       54

    1.2.    Specifications                          5   Adapters                                   58

    1.3.    Mechanical Drawings                     6   Antennas                                   59

    1.4.    Pin Signals                             6   Interfacing Protocols                      60

    1.5.    Electrical Characteristics              8   RS-232 Operation                           60

    1.5.1.  Timing Specifications                   8   RS-485 (2-wire) Operation                  62

2.  RF Module Operation                             10  RS-485 (4-wire) and RS-422 Operation       63

    2.1.    Serial Communications                   10  XCTU Software                              65

    2.1.1.  UART-Interfaced Data Flow               10  Using the XCTU Software                    65

    2.1.2.  Flow Control                            11  Appendix C: Additional Information         66

    2.2.    Modes of Operation                      12  1-Year Warranty                            66

    2.2.1.  Idle Mode                               12  Ordering Information                       66

    2.2.2.  Transmit Mode                           12  Contact Digi                               67

    2.2.3.  Receive Mode                            14

    2.2.4.  Sleep Mode                              14

    2.2.5.  Command Mode                            17

3.  RF Module Configuration                         19

    3.1.    Hands-on Programming Examples           19

    3.1.1.  AT Command Example                      19

    3.1.3.  Binary Command Example                  20

    3.2.    Command Reference Table                 21

    3.3.    XStream Command Descriptions            22

4.  RF Communication Modes                          37

    4.1.    Addressing                              38

    4.1.1.  Address Recognition                     38

    4.2.    Basic Communications                    39

    4.2.1.  Streaming Mode (Default)                39

    4.2.2.  Repeater Mode                           40

    4.3.    Acknowledged Communications             44

    4.3.1.  Acknowledged Mode                       44

    4.3.2.  Multi-Streaming Mode                    46

Appendix A:  Agency Certifications                  50

    FCC Certification                               50

    OEM Labeling Requirements                       51

    Antenna Usage                                   51

    FCC-Approved Antennas                           52

© 2014 Digi International Inc.                                                                iii
XStream™ OEM RF Module – Product Manual v5.x00

1.  XStream OEM RF Module

          The XStream OEM RF Module is a drop-in wireless data solution that

          transfers a standard asynchronous serial data stream over-the-air

          between devices. The module was engineered to provide OEMs and

          integrators with an easy-to-use wireless solution that yields reliable,

          long range and low cost wireless links.

    1.1.  Features

          Long Range                                                              Easy-to-Use

          9XStream (900 MHz) Range:                                               No configuration required

                                •  Indoor/Urban: up to 1500’ (450 m)              Advanced configurations supported

                                •  Outdoor line-of-sight: up to 7 miles (11 km)   through standard AT and binary

                                   w/ 2.1 dBm dipole antenna                      Commands

                                •  Outdoor line-of-sight: up to 20 miles (32 km)  5 VDC (± 0.25 V) power supply

                                   w/ high gain antenna

          24XStream (2.4 GHz) Range:                                              Continuous RF data stream

                                •  Indoor/Urban: up to 600’ (180 m)               up to 19.2 kbps

                                •  Outdoor line-of-sight: up to 3 miles (5 km)    Portable (small form factor easily

                                   w/ 2.1 dBm dipole antenna                      designed into a wide range of data radio

                                •  Outdoor line-of-sight: up to 10 miles (16 km)  systems)

                                   w/ high gain antenna                           Software-selectable serial interfacing

          Receiver Sensitivity: -110 dBm (900 MHz),                               rates

          -105 dBm (2.4 GHz)                                                      MODBUS, CTS, RTS, DTR, DCD (and

          Advanced Networking and Security                                        more) I/O Support

          True peer-to-peer (no “master” required), point-                        Support for multiple data formats (parity,

          to-point, point-to-multipoint, multidrop                                start and stop bits, etc.)

          Retries and Acknowledgements                                            XII™ Interference Immunity

          7 hopping channels, each with over 65,000                               Power-saving Sleep Modes

          available network addresses

          FHSS (Frequency Hopping Spread Spectrum)

          Fast network synchronization (~ 35 ms)

          Streaming, Repeater, Multi-Streaming and

          Acknowledged Modes supported

© 2014 Digi International Inc.                                                                                            4
XStream™ OEM RF Module – Product Manual v5.x00

                  1.1.1.             Worldwide Acceptance

                            FCC Certified (USA) – Refer to Appendix A for FCC Requirements.

                            Systems that include XStream Modules automatically inherit Digi Certifications

                            ISM (Industrial, Scientific and Medical) frequency band

                            Manufactured under ISO 9001:2000 registered standards

                            9XStream (900 MHz) OEM RF Modules are approved for use in US, Canada, Australia,

                            Israel.

1.2.                   Specifications

Table 1‐01.        XStream OEM       RF Module Specifications

Specification                        9XStream (900 MHz) OEM RF Module                                24XStream (2.4 GHz) OEM RF Module

Performance

Indoor/Urban Range                                       up to 1500’ (450 m)                                              up to 600’ (180 m)

Outdoor line-of-sight Range          Up to 7 miles (11 km) w/ dipole antenna                                  Up to 3 miles (5 km) w/ dipole antenna

                                     Up to 20 miles (32 km) w/ high-gain antenna                              Up to 10 miles (16 km) w/ high-gain antenna

Interface Data Rate                                      1200 – 57,600 bps                                                1200 – 57,600 bps

                                     (non-standard baud rates also supported)                                 (non-standard baud rates also supported)

Throughput Data Rate                 9,600 bps                                19,200 bps                      9,600 bps                       19,200 bps

RF Data Rate                         10,000 bps                               20,000 bps                      10,000 bps                      20,000 bps

Transmit Power Output                100 mW (20 dBm)                  100 mW (20 dBm)                50 mW (17 dBm)                    50 mW (17 dBm)

Receiver Sensitivity                 -110 dBm                                 -107 dBm                        -105 dBm                        -102 dBm

Power Requirements

Supply Voltage                       5 VDC (± 0.25 V) regulated                                                     5 VDC (± 0.25 V) regulated

Receive Current                                          50 mA                                                            80 mA

Transmit Current                                         140 mA                                                           150 mA

Power Down Current                                       < 26 µA                                                          < 26 µA

General

Frequency Range                                          902-928 MHz                                                      2.4000-2.4835 GHz

Spread Spectrum                                                             Frequency Hopping, Wide band FM modulator

Network Topology                                         Peer-to-Peer, Point-to-Multipoint, Point-to-Point, Multidrop

Channel Capacity                                                              7 hop sequences share 25 frequencies

Serial Data Interface                                                                     CMOS UART

Physical Properties

Module Board Size                                                 1.600” x 2.825” x 0.350” (4.06 cm x 7.18 cm x 0.89 cm)

Weight                                                                         0.8 oz (24 g)

Connector                                                11-pin and 4-pin, 0.1” spaced male Berg-type headers

Operating Temperature                                                 0 to 70º C (commercial), -40 to 85º C (industrial)

Antenna

Integrated Wire (optional)                               ¼ wave monopole, 3” (7.62 cm) length, 1.9 dBi Gain

Connector (optional)                                                          Reverse-polarity SMA or MMCX

Impedance                                                                                 50 ohms unbalanced

Certifications (visit www.digi.com   for complete list)

FCC Part 15.247                                          OUR9XSTREAM                                                      OUR-24XSTREAM

Industry Canada (IC)                                     4214A-9XSTREAM                                                   4214A 12008

© 2014 Digi International Inc.                                                                                                                             5
XStream™ OEM RF Module – Product Manual v5.x00

1.3.  Mechanical Drawings

      Figure 1‐01.              XStream Module Mechanical Drawings (shown with RPSMA antenna connector  option)

1.4.  Pin Signals

      Figure 1‐02.              XStream OEM RF Module Pin Numbers (bottom view, pins protruding)

© 2014 Digi International Inc.                                                                                   6
XStream™  OEM  RF  Module – Product Manual v5.x00

                   Table 1‐02.      J1 Pin Signal Descriptions

                   (Low‐asserted    signals distinguished with a horizontal line  over signal name.)

                   Module Pin       Signal Name         I/O     When Active       Function

                                                                                        (clear-to-send) flow control – When pin is driven low,

                                                                                  UART host is permitted to send serial data to the module.

                                    DO2 /            /                            Refer to the Serial Communications (p9) and CS Command

                                1   RS-485 Enable       O*      low               (p23) sections for more information.

                                                                                  RS-485 Enable – To configure this pin to enable RS-485

                                                                                  (2-wire or 4--wire) communications, refer to the Serial

                                                                                  Communications (p9) and CS Command (p23) sections.

                                                                                  By default, DI3 pin is not used. To configure this pin to support

                                2   DI3 / SLEEP         I*      high              Sleep Modes, refer to the Sleep Mode (p13), SM Command

                                                                                  (p32) and PW Command (p29) sections.

                                3   DO (data out)       O*      n/a               Serial data exiting the module (to the UART host). Refer to the

                                                                                  Serial Communications (p9) section for more information.

                                4   DI (data in)        I       n/a               Serial data entering the module (from UART host). Refer to the

                                                                                  Serial Communications (p9) section for more information.

                                                                                        (request-to-send) flow control – By default, this pin is not

                                                                                  used. To configure this pin to regulate the flow of serial data

                                5   DI2 /  / CMD        I**     low               exiting the module, refer to the Serial Communications (p9) and

                                                                                  RT Command (p31) sections.

                                                                                  CMD –Refer to Binary Commands (p17) and RT Command

                                                                                  (p31) sections to enable binary command programming.

                                6                       I*      low               Re-boot module.

                                7   DO3 / RX LED        O       high              Pin is driven high during RF data reception; otherwise, the pin

                                                                                  is driven low. Refer to the CD Command (p22) to enable.

                                8          / PWR        O       low               - Pin pulses low during RF transmission.

                                                                high              PWR – Indicates power is on and module is not in Sleep Mode.

                                                                                  Pin can be used as a backup method for entering Command

                                9                       I***    low               Mode during power-up. Primary method is with “+++”. Refer to

                                                                                  the Command Mode (p16) section for more information.

                                10         VCC          I       -                 5 VDC regulated (± 0.25)

                                11         GND          -       -                 Ground

                   *                Module has 10K Ω internal pull‐up resistor

                   **               Module has 10K Ω internal pull‐down resistor

                   ***              Module has 100K Ω internal pull‐up resistor

                   Note:            When integrating the XStream Module with a Host       PC Board, all     lines       that  are  not     used

                   should be left disconnected (floating).

                   Table 1‐03.      J2 Pin Signal Descriptions

                   Module Pin       Signal Name

                                1          reserved

                                2          GND

                                3          GND

                                4          GND

                   J2 Pins are used primarily for mechanical stability and may be left    disconnected.

© 2014 Digi International Inc.                                                                                                                     7
XStream™ OEM RF Module – Product Manual v5.x00

         1.5.         Electrical Characteristics

                      Figure 1‐03.                   System Block Diagram

                      Basic wireless link between hosts

                      The data flow sequence is initiated when the first byte of data is received in the DI Buffer of the

                      transmitting module (XStream Module A). As long as XStream Module A is not already receiving

                      RF data, data in the DI Buffer is packetized, then transmitted over-the-air to XStream Module B-0

                      1.5.1.       Timing Specifications

                      Figure 1‐04.                   Timing Specifications (“A” and “B” refer to Figure 1‐03.)

         Table 1‐04.  AC Characteristics (SY parameter = 0,            symbols correspond to        Figure 1‐03 and Figure 1‐04.)

         Symbol       Description                    19200 baud rate       19200 timing             9600 baud rate    9600 timing

                                                     (32 byte packet)      (B=number of bytes)      (32 byte packet)  (B=number of bytes)

                                                                           For 0 < B < 64,                            For 0 < B < 40,

         TTX          Latency from the time data is  54.0 ms               T = 41.6 + (0.4 * B) ms  72.0 ms           T = 46.27 + (0.73 * B) ms

                      transmitted until received                           For B > 63,                                For B >= 39 bytes,

                                                                           T = 66.8 ms                                T = 74.80 ms

                                                                           For 0 < B < 14,                            For 0 < B < 14,

         TTL          Time that   /PWR pin is        8.4 ms                T = 3.24 + (0.4 * B) ms  16.8 ms           T = 6.50 + (0.8 * B) ms

                      driven low                                           For B > 13,                                For B > 13,

                                                                           T = 8.48 ms                                T = 16.80 ms

                                                                           For 0 < B < 65,                            For 0 < B < 37,

         TRL          Time that RX LED pin is        13.6 ms               T = 0.79 + (0.408 * B)   25.6 ms           T = 1.63 + (0.794 * B)

                      driven high                                          For B > 64,                                For B > 36,

                                                                           T = 26.9 ms                                T = 30.2 ms

         TST          Channel Initialization Time    35.0 ms               35.0 ms                  35.0 ms                        35.0 ms

©  2014  Digi International Inc.                                                                                                            8
XStream™ OEM RF  Module – Product Manual v5.x00

Table 1‐05.      DC  Characteristics (Vcc = 4.75 – 5.25         VDC)

Symbol               Parameter            Condition                   Min        Typical             Max        Units

VIL                  Input Low Voltage    All input signals           -0.5                           0.3 * Vcc  V

VIH                  Input High Voltage   All except                  0.6 * Vcc                      Vcc + 0.5  V

                                                    pin

VIH2                 Input High Voltage      pin *                    0.9 * Vcc                      Vcc + 0.5  V

VOL                  Output Low Voltage   IOL = 20 mA,                                               0.7        V

                                          Vcc = 5V                                                   0.5

VOH                  Output High Voltage  IOH = -20 mA,               4.0                                       V

                                          Vcc = 5V                    2.0

IIL                  Input Leakage        Vcc = 5.5V, pin low                                        3          µA

                     Current I/O Pin      (absolute value)

IIH                  Input Leakage        Vcc = 5.5V, pin high                                       3          µA

                     Current I/O Pin      (absolute value)

IIL2                                      ,         , DO                         (Vcc – VI) / 10 **             mA

IIL3                                      CONFIG                                 (Vcc – VI) / 47 **             mA

IIH2                                                                             (Vcc – VI) / 10 **             mA

* Reset pulse must last at least 250 nanoseconds

** VI = the input voltage on the pin

© 2014 Digi International Inc.                                                                                      9
XStream™ OEM RF Module – Product Manual v5.x00

2.  RF Module Operation

    2.1.  Serial Communications

          The XStream OEM RF Module interfaces to a host device through a CMOS-level asynchronous

          serial port. Through its serial port, the module can communicate with any UART voltage

          compatible device or through a level translator to any RS-232/485/422 device.

          2.1.1.                UART-Interfaced Data Flow

          Devices that have a UART interface can connect directly through the pins of the XStream Module

          as is shown in the figure below.

          Figure 2‐01.          System Data Flow Diagram in a UART‐interfaced environment

                                (Low‐asserted signals distinguished with horizontal line over signal name.)

          Serial Data

          Data enters the XStream Module through the DI pin (pin 4) as an asynchronous serial signal. The

          signal should idle high when no data is being transmitted.

          The UART performs tasks, such as timing and parity checking, that are needed for data

          communications. Serial communication consists of two UARTs configured with compatible

          parameters (baud rate, parity, start bits, stop bits, data bits) to have successful communication.

          Each data packet consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit

          (high). The following figure illustrates the serial bit pattern of data passing through the module.

          Figure 2‐02.          UART data packet 0x1F (decimal number “31”) as transmitted through the XStream

          Module

                                Example Data Format is 8‐N‐1 (bits – parity ‐ # of stop bits)

© 2014 Digi International Inc.                                                                                      10
XStream™ OEM RF Module – Product Manual v5.x00

               2.1.2.              Flow Control

                   Figure 2‐03.    Internal Data Flow Diagram (The five most commonly‐used pin signals shown.)

               DI  (Data In) Buffer and Flow Control

                   When serial data enters the XStream Module through the DI Pin (pin 4), then the data is stored         in

                   the DI Buffer until it can be transmitted.

                   When the RB and RO parameter thresholds are satisfied (refer to Transmit Mode section (p11)

                   and command descriptions for more information), the module attempts to initialize an RF

                   connection. If the module is already receiving RF data, the serial data is stored in the DI Buffer.

                   The size of the DI Buffer can be determined by issuing the RZ (DI Buffer Size) Command. If the

                   DI buffer becomes full, hardware or software flow control must be implemented in order to

                   prevent overflow (loss of data between the host and XStream Module).

                   How to eliminate the need for flow control:

                   1.  Send messages that are smaller than the DI buffer size. The size of the DI buffer varies

                       according to the packet size (PK parameter) and the parity setting (NB parameter) used.

                   2.  Interface at a lower baud rate (BD parameter) than the fixed RF data rate.

                   Two cases in which the DI Buffer may become full and possibly overflow:

                   1.  If the serial interface data rate is set higher than the RF data rate of the module, the module

                       will receive data from the host faster than it can transmit the data over-the-air.

                   2.  If the module is receiving a continuous stream of RF data or monitoring data on a network,

                       any serial data that arrives on the DI pin is placed in the DI Buffer. The data in the DI buffer

                       will be transmitted over-the-air when the module no longer detects RF data in the network.

                   Hardware Flow Control (         ). When the DI buffer is 17 bytes away from being full; by default,

                   the module de-asserts (high)           to signal to the host device to stop sending data (refer to FT

                   (Flow Control Threshold) and CS (DO2 Configuration) Commands).            is re-asserted after the DI

                   Buffer has 34 bytes of memory available.

                   Software Flow Control (XON). XON/XOFF software flow control can be enabled using the FL

                   (Software Flow Control) Command. This option only works with ASCII data.

               DO (Data Out) Buffer and Flow Control

                   When RF data is received, the data enters the DO buffer and is then sent out the serial port to a

                   host device. Once the DO Buffer reaches capacity, any additional incoming RF data is lost. The

                   size of the DO Buffer can be determined by issuing the RZ (DI Buffer Size) Command, then

                   multiplying the result by 1.5.

                   Two cases in which the DO Buffer may become full and possibly overflow:

                   1.  If the RF data rate is set higher than the interface data rate of the module, the module will

                       receive data from the transmitting module faster than it can send the data to the host.

                   2.  If the host does not allow the module to transmit data out from the DO buffer because of

                       being held off by hardware or software flow control.

                   Hardware Flow Control (         ). If  is enabled for flow control (RT Parameter = 2), data will not

                   be sent out the DO Buffer as long as        (pin 5) is de-asserted

©  2014  Digi  International Inc.                                                                                         11
XStream™ OEM   RF Module – Product Manual v5.x00

               Software Flow Control (XOFF). XON/XOFF software flow control                     can be enabled  using  the  FL

               (Software Flow Control) Command. This option only works with                     ASCII data.

   2.2.        Modes of Operation

                       XStream OEM RF Modules operate in five modes.

                       Figure 2‐04.   XStream Modes of Operation

                                      The module can only be in one mode at a time.

               2.2.1.              Idle Mode

                       When not receiving or transmitting data, the module is in Idle Mode. The module uses the same

                       amount of power in Idle Mode as it does in Receive Mode.

                       The module shifts into the other modes of operation under the following conditions:

                                   •  Serial data is received in the DI Buffer (Transmit Mode)

                                   •  Valid RF data is received through the antenna (Receive Mode)

                                   •  Command Mode Sequence is issued (Command Mode)

                                   •  Sleep Mode condition is met (Sleep Mode)

                       After responding to any of the preceding conditions, the module automatically transitions back

                       into Idle Mode.

               2.2.2.              Transmit Mode

                       After the first byte of serial data is received in the DI buffer (from the               Note: RF reception

                       UART), the module attempts to shift to Transmit Mode and initiate RF                     must complete before

                       connections with other modules. After transmission is complete, the                      the module is able to

                       module returns to Idle Mode.                                                             enter into Transmit

                       RF transmission begins after either of the following criteria is                         Mode.

                       met:

                       1.             RB bytes have been received in the DI buffer and are pending for RF transmission (refer to

                                      RB (Packetization Threshold) Command, p29).

                                      The RB parameter may be set to any value between 1 and the RF packet size (PK), inclusive.

                                      When RB = 0, the packetization threshold is ignored.

                       2.             At least one character has been received in the DI buffer (pending for RF transmission) and

                                      RO time has been observed on the UART (refer to RO (Packetization Timeout) Command).

                                      The timeout can be disabled by setting RO to zero. In this case, transmission will begin after

                                      RB bytes have been received in the DI buffer.

©  2014  Digi  International Inc.                                                                                                     12
XStream™       OEM  RF  Module – Product Manual v5.x00

                                   After either RB or RO conditions are met, the module then initializes a communications

                                   channel. (Channel Initialization is the process of sending an RF initializer that synchronizes

                                   receiving modules with the transmitting module. During channel initialization, incoming

                                   serial data accumulates in the DI buffer.)

                                   Serial data in the DI buffer is grouped into RF packets (refer to PK (RF Packet Size));

                                   converted to RF data; then transmitted over-the-air until the DI buffer is empty.

                                   RF data, which includes the payload data, follows the RF initializer. The payload includes up to

                                   the maximum packet size (PK Command) bytes. As the transmitting module nears the end of

                                   the transmission, it inspects the DI buffer to see if more data exists to be transmitted. This

                                   could be the case if more than PK bytes were originally pending in the DI buffer or if more

                                   bytes arrived from the UART after the transmission began. If more data is pending, the

                                   transmitting module assembles a subsequent packet for transmission.

                        Figure 2‐05.    Data Transmission Sequence

                        RF Data Packet

                        Figure 2‐06.    RF Data Packet

                        * When streaming multiple RF packets, the RF Initializer is only sent in front of the first packet.

                        RF Initializer

                        An RF initializer is sent each time a new connection sequence begins. The RF initializer contains

                        channel information that notifies receiving modules of information such as the hopping pattern

                        used by the transmitting module. The first transmission always sends an RF initializer.

                        An RF initializer can be of various lengths depending on the amount of time determined to be

                        required to prepare a receiving module. For example, a wake-up initializer is a type of RF

                        initializer used to wake remote modules from Sleep Mode (Refer to the FH, LH, HT and SM

©  2014  Digi  International Inc.                                                                                                  13
XStream™  OEM  RF Module – Product Manual v5.x00

                        Commands for more information). The length of the wake-up initializer should be longer than the

                        length of time remote modules are in cyclic sleep.

                        Header

                        The header contains network addressing information that filters incoming RF data. The receiving

                        module checks for a matching Hopping Channel (HP parameter), Vendor Identification Number

                        (ID parameter) and Destination Address (DT parameter). Data that does not pass through all

                        three network filter layers is discarded.

                        CRC (Cyclic Redundancy Check)

                        To verify data integrity and provide built-in error checking, a 16-bit CRC (Cyclic Redundancy

                        Check) is computed for the transmitted data and attached to the end of each RF packet. On the

                        receiving end, the receiving module computes the CRC on all incoming RF data. Received data

                        that has an invalid CRC is discarded. (See Receive Mode section.)

               2.2.3.              Receive Mode

                        If the module detects RF data while in Idle Mode, the module transitions into Receive

                        Mode to receive RF packets. Once a packet is received, the module checks the CRC to

                        ensure that the data was transmitted without error. If the CRC data bits on the

                        incoming packet are invalid, the packet is discarded. If the CRC is valid, the packet

                        proceeds to the DO Buffer.

                        The module returns to Idle Mode when valid

                        RF data is no longer detected or after an error

                        is detected in the received RF data.

                        Figure 2‐07.  Data Reception Sequence Æ

                        * Refer to the Addressing section (p36) of the

                        RF Communication Modes chapter for more information

                        regarding address recognition.

Note: If serial data exists in the DI buffer while the module

is in Receive Mode, the UART data will be transmitted after

the module is finished receiving the RF data and has

returned to Idle Mode.

               2.2.4.              Sleep Mode

                        Sleep Modes enable the XStream Module to operate at minimal power consumption

                        when not in use. Three Sleep Mode options are available:

                                •  Pin Sleep (Host Controlled)

                                •  Serial Port Sleep (Wake on Serial Port activity)

                                •  Cyclic Sleep (Wake on RF activity)

                        For the module to transition into Sleep Mode, the module must have a non-zero SM

                        (Sleep Mode) Parameter and one of the following must occur:

                        1.         The module is idle (no data transmission or reception) for a user-defined period  of  time  (See

                                   ST (Time before Sleep) Command)

                        2.         DI3 (pin 2) is asserted (only for Pin Sleep option)

© 2014 Digi International Inc.                                                                                                 14
XStream™  OEM  RF  Module – Product Manual v5.x00

                   In Sleep Mode, the module will not transmit or receive data until the module first

                   transitions to Idle Mode. All Sleep Modes are enabled and disabled using SM Command.

                   Transitions into and out of Sleep Modes are triggered by various mechanisms as shown

                   in the table below.

                   Table 2‐01.        Summary of Sleep Mode Configurations

                   Sleep Mode           Transition into                                Transition out of       Related      Typical Power

                   Setting              Sleep Mode                                     Sleep Mode              Commands     Consumption

                                        Microcontroller can shut down and wake

                   Pin Sleep            modules by asserting (high) SLEEP (pin 2).     De-assert (low)         SM           26 µA

                   (SM = 1)             Note: Module will complete transmission /      SLEEP (pin 2).

                                        reception before activating Pin Sleep.

                                        Automatic transition to Sleep Mode occurs

                   Serial Port Sleep    after a user-defined period of inactivity (no  When serial byte is

                   (SM = 2)             transmitting or receiving of data). The        received on the DI pin  SM, ST       1 mA

                                        period of activity is defined using the ST     (pin 4).

                                        (Time before Sleep) Command.

                                        Automatic transition to Sleep Mode occurs      After the cyclic sleep

                                        in cycles as defined by the SM (Sleep          time interval elapses.

                   Cyclic Sleep         Mode) Command.                                 Note: Module can be     SM, ST, HT,  76 µA

                   (SM = 3-8)           Note: The cyclic sleep time interval must be   forced into Idle Mode   LH, PW       when sleeping

                                        shorter than the “Wake-up Initializer Timer”   if PW (Pin Wake-up)

                                        (set by LH Command).                           Command is issued.

                   For more information about Sleep Modes, refer to the individual commands listed in “Related Commands”

                   column of the table. The SM command is central to all Sleep Mode configurations.

                   Pin Sleep (SM = 1)

                   Pin Sleep requires the least amount of power. In order to achieve this state, SLEEP pin must be

                   asserted (high). The module remains in Pin Sleep until the SLEEP pin is de-asserted.

                   After enabling Pin Sleep Mode, the SLEEP pin controls whether the module is active or in Sleep

                   Mode. When SLEEP is de-asserted (low), the module is fully operational. When SLEEP is asserted

                   (high), the module transitions to Sleep Mode and remains in its lowest power-consuming state

                   until the SLEEP pin is de-asserted. SLEEP is only active if the module is setup to operate in this

                   mode; otherwise the pin is ignored.

                   Once in Pin Sleep Mode,          is de-asserted (high), indicating that data should not be sent to the

                   module. The PWR pin is also de-asserted (low) when the module is in Pin Sleep Mode.

                   Note: The module will complete a transmission or reception before activating Pin Sleep.

                   Serial Port Sleep (SM = 2)

                   Serial Port Sleep is a Sleep Mode in which the XStream Module runs in a low power state until

                   serial data is detected on the DI pin.

                   When Serial Port Sleep is enabled, the module goes into Sleep Mode after a user-defined period

                   of inactivity (no transmitting or receiving of data). This period of time is determined by ST (Time

                   before Sleep) Command. Once a character is received through the DI pin, the module returns to

                   Idle Mode and is fully operational.

                   Cyclic Sleep (SM = 3-8)

                   Cyclic Sleep is the Sleep Mode in which the XStream Module enters into a low-power state and

                   awakens periodically to determine if any transmissions are being sent.

                   When Cyclic Sleep settings are enabled, the XStream Module goes into Sleep Mode after a user-

                   defined period of inactivity (no transmission or reception on the RF channel). The user-defined

                   period is determined by ST (Time before Sleep) Command.

                   While the module is in Cyclic Sleep Mode,                        is de-asserted (high) to indicate that data should

                   not be sent to the module during this time. When the module awakens to listen for data,                                 is

                   asserted and any data received on the DI Pin is transmitted. The PWR pin is also de-asserted

                   (low) when the module is in Cyclic Sleep Mode.

© 2014 Digi International Inc.                                                                                                     15
XStream™  OEM  RF  Module – Product Manual v5.x00

                   The module remains in Sleep Mode for a user-defined period of time ranging from 0.5 seconds to

                   16 seconds (SM Parameters 3 through 8). After this interval of time, the module returns to Idle

                   Mode and listens for a valid data packet for 100 ms. If the module does not detect valid data (on

                   any frequency), the module returns to Sleep Mode. If valid data is detected, the module

                   transitions into Receive Mode and receives incoming RF packets. The module then returns to

                   Sleep Mode after a Period of inactivity that is determined by ST “Time before Sleep” Command.

                   The module can also be configured to wake from cyclic sleep when SLEEP (pin 2) is de-asserted

                   (low). To configure a module to operate in this manner, PW (Pin Wake-up) Command must be

                   issued. Once SLEEP is de-asserted, the module is forced into Idle Mode and can begin

                   transmitting or receiving data. It remains active until no data is detected for the period of time

                   specified by the ST Command, at which point it resumes its low-power cyclic state.

                   Note: The cyclic interval time defined by SM (Sleep Mode) Command must be shorter than the

                   interval time defined by LH (Wake-up Initializer Timer).

                   For example: If SM=4 (Cyclic 1.0 second sleep), the LH Parameter should equal 0x0B (“1.1”

                   seconds). With these parameters set, there is no risk of the receiving module being asleep for the

                   duration of wake-up initializer transmission. “Cyclic Scanning” explains in further detail the

                   relationship between “Cyclic Sleep” and “Wake-up Initializer Timer”

                   Cyclic Scanning. Each RF transmission consists of an RF Initializer and payload. The wake-up

                   initializer contains initialization information and all receiving modules must wake during the

                   wake-up initializer portion of data transmission in order to be synchronized with the transmitting

                   module and receive the data.

                   Figure 2‐08.  Correct Configuration (LH > SM)

                   Length of the wake‐up initializer exceeds the time interval of Cyclic Sleep. The receiver is guaranteed to detect

                   the wake‐up initializer and receive the accompanying payload data.

                   Figure 2‐09.  Incorrect Configuration (LH < SM)

                   Length of wake‐up initializer is shorter than the time interval of Cyclic Sleep. This configuration is vulnerable

                   to the receiver waking and missing the wake‐up initializer (and therefore also the accompanying payload data).

© 2014 Digi International Inc.                                                                                                        16
XStream™       OEM  RF Module – Product Manual v5.x00

                    2.2.5.            Command Mode

                        To modify or read module parameters, the module must first enter into Command Mode (a state

                        in which incoming characters are interpreted as commands). Two command types are supported:

                                   •  AT Commands

                                   •  Binary Commands

                    AT  Commands

                        To Enter AT Command Mode:

                        1.            Send the 3-character command sequence “+++” and observe guard times before and after

                                      the command characters. (Refer to the “Default AT Command Mode Sequence” below.) The

                                      “Terminal” tab (or other serial communications software) of the XCTU Software can be used

                                      to enter the sequence.

                                      (OR)

                        2.            Assert (low) the CONFIG pin and either turn the power going to the module off and back on.

                                      (If using a Digi XIB-R Interface Board, the same result can be achieved by keeping the

                                      configuration switch pressed while turning off, then on again the power supplying the module

                                      assembly (module assembly = module mounted to an interface board))

                        Default AT Command Mode Sequence (for transitioning to Command Mode):

                                   •  No characters sent for one second (BT (Guard Time Before) parameter = 0x0A)

                                   •  Input three plus characters (“+++”) within one second (CC (Command Sequence Character)

                                      Command = 0x2B-0)

                                   •  No characters sent for one second (AT (Guard Time After) parameter = 0x0A)

                        To Send AT Commands:

                        Send AT commands and parameters using the syntax shown below.

                        Figure 2‐10.        Syntax for sending AT Commands

                        The preceding example would change the module Destination Address to “0x1F”. For modified

                        parameter values to persist in the module registry, changes must be saved to non-volatile

                        memory using WR (Write) Command. Otherwise, parameters are restored to previously saved

                        values after the module is powered off and then on again.

                        Note: To read the current value of a module parameter, leave the parameter field blank. For

                        example, the following command will return the current destination address:       ATDT

                        System Response. When a command is sent to the module, the module will parse and execute

                        the command. Upon successful execution of a command, the module returns an “OK” message.                      If

                        execution of a command results in an error, the module returns an “ERROR” message.

                        To Exit AT Command Mode:

                        1.            Send ATCN (Exit Command Mode) Command.

                                      (OR)

                        2.            If no valid AT Commands are received within the time specified by CT (Command Mode

                                      Timeout) Command, the Module automatically returns to Idle Mode.

                        For an example that illustrates programming the module using AT Commands, refer to the

                        Module Configuration chapter (p18).

©  2014  Digi  International Inc.                                                                                                 17
XStream™  OEM  RF  Module – Product Manual v5.x00

                   Binary Commands

                   Sending and receiving parameter values using binary commands is the fastest way to change

                   operating parameters of the module. Binary commands are used most often to sample signal

                   strength (RS parameter) and/or error counts; or to change module addresses and channels for

                   polling systems when a quick response is necessary. Since the sending and receiving of

                   parameter values takes place through the same serial data path as “live” data (received RF

                   payload), interference between the two types of data can be a concern.

                   Common questions about using binary commands:

                   What are the implications of asserting CMD while live data is being sent or received?

                   After sending serial data, is there a minimum time delay before CMD can be asserted?

                   Is a time delay required after CMD is de-asserted before payload data can be sent?

                   How does one discern between live data and data received in response to a command?

                   The CMD pin (pin 5) must be asserted in order to send binary commands to the module. The

                   CMD pin can be asserted to recognize binary commands anytime during the transmission or

                   reception of data. The status of the CMD signal is only checked at the end of the stop bit as the

                   byte is shifted into the serial port. The application does not allow control over when data is

                   received, except by waiting for dead time between bursts of communication.

                   CMD (pin 5) must be asserted in order to send binary commands to an XStream Module. CMD

                   can be asserted to recognize commands anytime during transmission or reception of data. A

                   minimum time delay of 100 µs (after the stop bit of the command byte has been sent) must be

                   observed before pin 5 can be de-asserted. The command executes after all parameters

                   associated with the command have been sent. If all parameters are not received within 0.5

                   seconds, the module aborts the command and returns to Idle Mode. Note: When parameters are

                   sent, they are always two bytes long with the least significant byte sent first.

                   Commands can be queried for their current value by sending the command logically ORed with

                   the value 0x80 (hexadecimal) with CMD asserted. When the binary value is sent (with no

                   parameters), the current value of the command parameter is sent back through the DO pin.

                   Figure 2‐11.  Binary Command Write then Read

                   Signal #4 is CMD (pin 5)

                   Signal #1 is the DIN (pin 4) signal to the radio

                   Signal #2 is the DOUT (pin 3) signal from the radio

                   Signal #3 is  (pin 1)

                   In this graph, a value was written to a register and

                   then read out to verify it. While not in the middle

                   of other received data, note that the  signal

                   outlines the data response out of the module.

                   IMPORTANT:    For the XStream Module to recognize a binary command, RT (DI2 Configuration)

                                 Command must be issued. If binary programming is not enabled (RT ≠ 1), the

                                 module will not recognize that the CMD pin (Pin 5) is asserted and therefore will not

                                 recognize the data as binary commands.

© 2014 Digi International Inc.                                                                                        18
XStream™ OEM RF Module – Product Manual v5.x00

3.  RF Module Configuration

    3.1.  Hands-on Programming Examples

                  For information about entering and exiting AT and Binary Command Modes, refer to the

                  Command Mode section (p16).

          3.1.1.                AT Command Example

                  To Send AT Commands (Using the Terminal tab of Digi’s XCTU Software)

                  Example: Both of the following examples change the module’s destination address to 0x1A0D and

                  save the new address to non-volatile memory.

                  Method 1 (One line per command)

                                Send AT Command                 System Response

                                +++                             OK  (Enter into Command Mode)

                                ATDT                     current Destination Address  (Read)

                                ATDT1A0D                 OK  (Change destination address)

                                ATWR                     OK  (Write to non-volatile memory)

                                ATCN                     OK  (Exit Command Mode)

                  Method 2 (Multiple commands on one line)

                                Send AT Command                 System Response

                                +++                             OK  (Enter into Command Mode)

                                ATDT                     current Destination Address  (Read)

                                ATDT1A0D,WR,CN           OK  (Execute commands)

                  Digi’s XCTU Software facilitates module programming. To install, double-click the “setup_X-CTU.exe”

                  file that is located at www.digi.com.

                  Note:         In order to use a host PC and the XCTU Software Terminal tab to send data to the module, PC

                  com port settings must match the baud, parity and stop bit parameters stored in the module.

                  Use the “PC Settings” tab to configure PC com port settings to match module parameter values.

© 2014 Digi International Inc.                                                                                               19
XStream™ OEM RF Module – Product Manual v5.x00

3.1.3.                          Binary Command Example

        To Send Binary Commands:

        Example: Use binary commands to change the XStream Module’s destination address to 0x1A0D

        and save the new address to non-volatile memory.

        1.                      RT Command must be set to “1” in AT Command Mode to enable binary programming.

        2.                      Assert CMD (Pin 5 is driven high).   (Enter Binary Command Mode)

        3.                      Send Bytes (parameter bytes must be 2 bytes long):

                                00                                   (Send DT (Destination Address) Command)

                                0D                                   (Least significant byte of parameter bytes)

                                1A                                   (Most significant byte of parameter bytes)

                                08                                   (Send WR (Write) Command)

        4.                      De-assert CMD (Pin 5 is driven low)  (Exit Binary Command Mode)

        Note:                   (pin 1) is de-asserted high when commands are being executed. Hardware flow control

        must be disabled as                     will hold off parameter bytes.

© 2014 Digi International Inc.                                                                                       20
XStream™ OEM RF Module – Product Manual v5.x00

             3.2.        Command Reference Table

Table 3‐01.  XStream Commands (The module expects numerical values in hexadecimal. “d” denotes decimal            equivalent.)

AT           Binary      AT Command Name                  Range                          Command Category         # Bytes       Factory

Command      Command                                                                                              Returned      Default

AM v4.30*    0x3A (58d)  Auto-set MY                      -                              Networking and Security  -             -

AT           0x05 (5d)   Guard Time After                 0x02 – 0xFFFF (x 100 msec)     Command Mode Options     2             0x0A (10d)

BD v4.2B*    0x15 (21d)  Baud Rate                        Standard baud rates: 0 – 6     Serial Interfacing       2             factory-set

                                                          (custom rates also supported)                                         RF data rate

BK v4.30*    0x2E (46d)  Serial Break Passing             0–1                            Serial Interfacing       1             0

BO v4.30*    0x30 (48d)  Serial Break Timeout             0 - 0xFFFF (x 1 second)        Serial Interfacing       2             0

BT           0x04 (4d)   Guard Time Before                0 – 0xFFFF (x 100 msec)        Command Mode Options     2             0x0A (10d)

CB v4.30*    0x33 (51d)  Connection Duration Timeout      0x01 – 0xFFFF (x 100 msec)     Networking and Security  2             0x28 (4d sec)

CC           0x13 (19d)  Command Sequence Character       0x20 – 0x7F                    Command Mode Options     1             0x2B (“+”)

CD v4.2B*    0x28 (40d)  DO3 Configuration                0–4                            Serial Interfacing       1             0

CE v4.30*    0x34 (52d)  Connection Inactivity Timeout    0 – 0xFFFF (x 10 msec)         Networking and Security  2             0x64 (1d sec)

CF v4.30*    0x35 (53d)  Connection Failure Count         0 – 0xFFFF                     Networking and Security  2             0

CL v4.30*    0x39 (57d)  Last Connection Address          (read-only)                    Diagnostics              2             -

CM v4.30*    0x38 (56d)  Connection Message               0–1                            Networking and Security  1             0

CN           0x09 (9d)   Exit AT Command Mode             -                              Command Mode Options     -             -

CO v4.30*    0x2F (47d)  DO3 Timeout                      0 - 0xFFFF (x 1 second)        Serial Interfacing       2             0x03

CS v4.27D*   0x1F (31d)  DO2 Configuration                0–4                            Serial Interfacing       1             0

CT           0x06 (6d)   Command Mode Timeout             0x02 – 0xFFFF (x 100 msec)     Command Mode Options     2             0xC8 (200d)

DC v4.30*    0x37 (55d)  Disconnect                       -                              Networking and Security  -             -

DR v4.30*    0x2D (45d)  DI3 Configuration                0–4                            Serial Interfacing       1             0

DT           0x00 (0d)   Destination Address              0 – 0xFFFF                     Networking and Security  2             0

E0           0x0A (10d)  Echo Off                         -                              Command Mode Options     -             -

E1           0x0B (11d)  Echo On                          -                              Command Mode Options     -             -

ER           0x0F (15d)  Receive Error Count              0 – 0xFFFF                     Diagnostics              2             0

FH           0x0D (13d)  Force Wake-up Initializer        -                              Sleep (Low Power)        -             -

FL           0x07 (7d)   Software Flow Control            0–1                            Serial Interfacing       1             0

FT v4.27B*   0x24 (36d)  Flow Control Threshold           0 – 0xFF (bytes)               Serial Interfacing       2             varies

GD           0x10 (16d)  Receive Good Count               0 – 0xFFFF                     Diagnostics              2             0

HP           0x11 (17d)  Hopping Channel                  0–6                            Networking and Security  1             0

HT           0x03 (3d)   Time before Wake-up Initializer  0 – 0xFFFF (x 100 msec)        Sleep (Low Power)        2             0xFFFF

ID v4.2B*    0x27 (39d)  Modem VID                        User-settable: 0x10 - 0x7FFF   Networking and Security  2             -

                                                          Read-only: 0x8000 – 0xFFFF

IU v4.30*    0x3B (59d)  DI2, DI3 Update Timer            0 - 0xFFFF (x 100 msec)        Serial Interfacing       2             0x0A (10d)

LH           0x0C (12d)  Wake-up Initializer Timer        0 – 0xFF (x 100 msec)          Sleep (Low Power)        1             0x01

MD v4.30*    0x32 (50d)  RF Mode                          0–4                            Networking and Security  1             0

MK           0x12 (18d)  Address Mask                     0 – 0xFFFF                     Networking and Security  2             0xFFFF

MY v4.30*    0x2A (42d)  Source Address                   0 – 0xFFFF                     Networking and Security  2             0xFFFF

NB v4.30*    0x23 (35d)  Parity                           0–5                            Serial Interfacing       1             0

PC v4.22*    0x1E (30d)  Power-up Mode                    0–1                            Command Mode Options     1             0

PK v4.30*    0x29 (41d)  RF Packet Size                   0 - 0x100 (bytes)              Serial Interfacing       2             0x40 (64d)

PW v4.22*    0x1D (29d)  Pin Wake-up                      0–1                            Sleep (Low Power)        1             0

RB v4.30*    0x20 (32d)  Packetization Threshold          0 - 0x100 (bytes)              Serial Interfacing       2             0x01

RE           0x0E (14d)  Restore Defaults                 -                              (Special)                -             -

RN v4.22*    0x19 (25d)  Delay Slots                      0 – 0xFF (slots)               Networking and Security  1             0

RO v4.2A*    0x21 (33d)  Packetization Timeout            0 – 0xFFFF (x 200 µsec)        Serial Interfacing       2             0

RP v4.2A*    0x22 (34d)  RSSI PWM Timer                   0 - 0x7F (x 100 msec)          Diagnostics              1             0

RR v4.22*    0x18 (24d)  Retries                          0 – 0xFF                       Networking and Security  1             0

RS v4.22*    0x1C (28d)  RSSI                             0x06 – 0x36 (read-only)        Diagnostics              1             -

RT           0x16 (22d)  DI2 Configuration                0-2                            Serial Interfacing       1             0

RZ v4.30*    0x2C (44d)  DI Buffer Size                   (read-only)                    Diagnostics              -             -

SB v4.2B*    0x36 (54d)  Stop Bits                        0-1                            Serial Interfacing       1             0

SH v4.27C*   0x25 (37d)  Serial Number High               0 – 0xFFFF (read-only)         Diagnostics              2             -

SL v4.27C*   0x26 (38d)  Serial Number Low                0 – 0xFFFF (read-only)         Diagnostics              2             -

SM           0x01 (1d)   Sleep Mode                       0–8                            Sleep (Low Power)        1             0

ST           0x02 (2d)   Time before Sleep                0x10 – 0xFFFF (x 100 msec)     Sleep (Low Power)        2             0x64 (100d)

SY           0x17 (23d)  Time before Initialization       0 – 0xFF (x 100 msec)          Networking and Security  1             0 (disabled)

TO v4.30*    0x31 (49d)  DO2 Timeout                      0 - 0xFFFF (x 1 sec)           Serial Interfacing       2             0x03

TR v4.22*    0x1B (27d)  Transmit Error Count             0 – 0xFFFF                     Diagnostics              2             0

TT v4.22*    0x1A (26d)  Streaming Limit                  0 – 0xFFFF (0 = disabled)      Networking and Security  2             0xFFFF

VR           0x14 (20d)  Firmware Version                 0 x 0xFFFF (read-only)         Diagnostics              2             -

WR           0x08 (8d)   Write                            -                              (Special)                -             -

* Firmware version in which command and parameter options were first supported.

Note: AT Commands issued without a parameter value will return the currently stored parameter.

© 2014 Digi International Inc.                                                                                                          21
XStream™ OEM  RF  Module – Product Manual v5.x00

3.3.              XStream Command Descriptions

                  Command descriptions in this section are listed alphabetically. Command categories are

                  designated within “< >” symbols that follow each command title. XStream Modules expect

                  parameter numerical values in hexadecimal (designated by the “0x” prefix).

                  AM (Auto-set MY) Command

                   AM Command is                     AT Command: ATAM
                                                                              Binary Command: 0x3A (58 decimal)
                  used to automatically set the MY (Source
                                                                              Minimum firmware version required: 4.40
                  Address) parameter from the factory-set

                  module serial

                  number. The address is formed with bits 29, 28 and 13-0 of the serial number (in that order).

                  AT (Guard Time After) Command

                   AT Command is used                   AT Command: ATAT

                  to set the DI time-of-silence that follows the AT           Binary Command: 0x05 (5 decimal)

                  command sequence character (CC Command).                    Parameter Range:  0x02 – 0xFFFF
                                                                                                (x 100 milliseconds)
                  By default, AT Command Mode will activate after
                                                                              Number of bytes returned: 2
                  one second of silence.
                                                                              Default Parameter Value: 0x0A (10 decimal)

                  Refer to the AT Commands section (p16) to view              Related Commands: BT (Guard Time Before),
                                                                              CC (Command Sequence Character)
                  the default AT Command Mode Sequence.

                  BD (Interface Data Rate) Command

                   BD Command allows the                  AT Command: ATBD

                  user to adjust the UART interface data rate and             Binary Command: 0x15 (21 decimal)

                  thus modify the rate at which serial data is sent           Parameter Range (Standard baud rates):    0–6

                  to the RF module. The new baud rate does not                (Non-standard baud rates): 0x7D – 0xFFFF

                  take effect until the CN command is issued. The                Parameter               Configuration (bps)

                  RF data rate is unaffected by the BD parameter.                   0                         1200

                                                                                    1                         2400

                  Most applications will require one of the seven                   2                         4800

                  standard baud rates; however, non-standard                        3                         9600

                  baud rates are also supported.                                    4                         19200

                  Note: If the interface data rate is set to exceed                 5                         38400

                  the fixed RF data rate of the module,       flow                  6                         57600

                  control may need to be implemented as                       Number of bytes returned: 2

                  described in the Pin Signals (p6), Flow Control             Default Parameter Value: Set to equal module’s
                                                                              factory-set RF data rate.

                  (p10) and CS (DO2 Configuration) sections.                  Related Commands: CN (Exit Command Mode)

                  Non-standard Interface Data Rates: When                     Minimum firmware version required: 4.2B
                                                                              (Custom baud rates not previously supported.)
                  parameter values outside the range of standard

                  interface data rates are sent, the closest rate represented by the number is stored in the BD

                  register. For example, a rate of 19200 bps can be set by sending the following command line

                  "ATBD4B00". Note: When using Digi’s XCTU Software, non-standard interface data rates

                  can only be set and read using the XCTU “Terminal” tab.

                  When the BD command is sent with a non-standard interface data rate, the UART will adjust to

                  accommodate the requested interface rate. In most cases, the clock resolution will cause the

                  stored BD parameter to vary from the parameter that was sent (refer to the table below).

                  Reading the BD command (send "ATBD" command without an associated parameter value) will

                  return the value that was actually stored in the BD register.

                  Table 3‐02.    Parameter Sent vs. Parameter Stored

                                BD Parameter Sent (HEX)  Interface Data Rate (bps)          BD Parameter Stored (HEX)

                                 0                                   1200                                  0

                                 4                                   19,200                                4

                                 7                                   115,200                               7

                                 12C                                 300                                   12B

                                 1C200                               115,200                               1B207

© 2014 Digi International Inc.                                                                                            22
XStream™ OEM RF Module – Product Manual v5.x00

               BK (Serial Break Passing) Command

                Pass a serial break condition  AT Command:  ATBK

               on the DI pin to the DO pin of another module.      Binary Command:      0x2E (46 decimal)

                                                                   Parameter Range:     0–1

                                                                   Parameter                        Configuration

                                                                                     0                 disable

                                                                                     1                 enable

                                                                   Default Parameter Value: 0

                                                                   Number of bytes returned: 1

                                                                   Related Commands: BO (Serial Break Timeout)

                                                                   Minimum Firmware Version Required: 4.30

               BO (Serial Break Timeout) Command

                DO pin will return to default  AT Command:  ATBO

               after no serial break status information is         Binary Command:      0x30 (48 decimal)

               received during the timeout period.                 Parameter Range:     0 – 0xFFFF  (x 1 second)

               Use with BK parameter = 1.                          Default Parameter Value: 0

                                                                   Number of bytes returned: 2

                                                                   Related Commands: BK (Serial Break Passing)

                                                                   Minimum Firmware Version Required: 4.30

               BT (Guard Time Before) Command

                BT Command is used           AT Command:  ATBT

               to set the DI pin silence time that must precede    Binary Command:      0x04 (4 decimal)

               the command sequence character (CC                  Parameter Range:     0 – 0xFFFF

               Command) of the AT Command Mode Sequence.                                (x 100 milliseconds)

               Refer to the AT Commands section (p16) to view      Default Parameter Value:    0x0A (10 decimal)

               the default AT Command Mode sequence.               Number of bytes returned: 2

                                                                   Related Commands:    AT (Guard Time After), CC
                                                                   (Command Sequence Character)

               CB (Connection Duration Timeout) Command

                Set/Read the              AT Command: ATCB

               maximum amount of time an exclusive                 Binary Command: 0x33 (51 decimal)

               connection between a base and remote module         Parameter Range:     0x01 – 0xFFFF

               in a point-to-multipoint network is sustained. The                       (x 100 milliseconds)

               remote module will disconnect when this timeout     Default Parameter Value: 0x28 (4d seconds)

               expires.                                            Number of bytes returned: 2

                                                                   Related Commands: CE (Connection Inactivity
                                                                   Timeout), DC (Disconnect), MD (RF Mode)

                                                                   Minimum Firmware Version Required: 4.30

               CC (Command Sequence Character) Command

                CC Command is used           AT Command: ATCC

               to set the ASCII character to be used between       Binary Command: 0x13 (19 decimal)

               Guard Times of the AT Command Mode Sequence         Parameter Range:     0x20 – 0x7F

               (BT+ CC + AT). The AT Command Mode                  Default Parameter Value: 0x2B (ASCII “+” sign)

               Sequence activates AT Command Mode (from            Number of bytes returned: 1

               Idle Mode).                                         Related Commands: AT (Guard Time After), BT

               Refer to the AT Commands section (p16) to view      (Guard Time Before)

               the default AT Command Mode sequence.

©  2014  Digi  International Inc.                                                                               23
XStream™ OEM RF Module – Product Manual v5.x00

CD (DO3 Configuration) Command

CD Command is used to           AT Command: ATCD

redefine the behavior of the DO3 (Data Output        Binary Command:   0x28 (40 decimal)

3)/RX LED line.                                      Parameter Range: 0 – 4

                                                     Parameter                   Configuration

                                                     0                             RX LED

                                                     1                            Default high

                                                     2                            Default low

                                                     3                            (reserved)

                                                     4                 Assert only when packet

                                                                       addressed to module sent

                                                     Default Parameter Value: 0

                                                     Number of bytes returned: 1

                                                     Minimum Firmware Version Required: 4.2B

CE (Connection Inactivity Timeout) Command

Set/Read the               AT Command: ATCE

duration of inactivity that will cause a break in a  Binary Command: 0x34 (52 decimal)

connection between modules. The base module          Parameter Range:  0 – 0xFFFF
                                                                       (x 10 milliseconds)
will disconnect when no payload has been
                                                     Default Parameter Value: 0x64 (1d second)
transferred for the time specified by the CE
                                                     Number of bytes returned: 2
parameter.
                                                     Related Commands: CB ( Connection Duration
                                                     Timeout), DC (Disconnect), MD (RF Mode)

                                                     Minimum Firmware Version Required: 4.30

CF (Connection Failure Count) Command

Set/Read the number of times the       AT Command: ATCF

base module expired retries attempting to send a     Binary Command:   0x35 (53 decimal)

Connection Grant Packet. Set to zero to clear the    Parameter Range:  0 – 0xFFFF

register.                                            Default Parameter Value: 0

                                                     Number of bytes returned: 2

                                                     Minimum Firmware Version Required: 4.30

CL (Last Connection Address) Command

Read           AT Command: ATCL

the address of the remote module that last           Binary Command:   0x39 (57 decimal)

connected to the base module. A remote module        Parameter Range:  0 – 0xFFFF (read-only)

will return its DT (Destination Address)             Number of bytes returned: 2

parameter.                                           Minimum Firmware Version Required: 4.30

CM (Connection Message) Command

Select whether base        AT Command: ATCM

sends connect messages to the host when a            Binary Command: 0x38 (56 decimal)

connection is established. When enabled, a           Parameter Range:  0–1

“CONNECTXXXX” string is sent to the host of the      Parameter                   Configuration

base module. “XXXX” is the MY (Source Address)       0                             enable

of the connected remote module.                      1                             disable

                                                     Default Parameter Value: 0

                                                     Number of bytes returned: 1

                                                     Minimum Firmware Version Required: 4.30

© 2014 Digi International Inc.                                                                  24
XStream™ OEM RF Module – Product Manual v5.x00

CN (Exit AT Command Mode) Command

CN Command is used                   AT Command: ATCN

to explicitly exit AT Command Mode.                         Binary Command: 0x09 (9 decimal)

CO (DO3 Timeout) Command

DO3 (Data Output 3) output             AT Command: ATCO

will return to default after no DI3 (Data Input 3)          Binary Command:   0x2F (47 decimal)

status information is received during the timeout           Parameter Range:  0 – 0xFFFF (x 1 second)

period.                                                     Default Parameter Value: 3

Use with CD = 1 or 2, DR = 1.                               Number of bytes returned: 2

                                                            Related Commands: CD (DO3 Configuration),

                                                            DR (DI3 Configuration)

                                                            Minimum Firmware Version Required: 4.30

CS (DO2 Configuration) Command

CS Command is used to                  AT Command: ATCS

select the behavior of the DO2 (Data Output 2)              Binary Command: 0x1F (31 decimal)

pin signal. This output can provide RS-232 flow             Parameter Range:  0–4

control, control the TX enable signal (for RS-485           Parameter                   Configuration

or RS-422 operations), or set the default level for

the I/O line passing function.                              0                 RS-232          flow control

By default, DO2 provides RS-232                 (Clear-to-  1                       RS-485 TX enable low

Send) flow control.                                         2                             high

                                                            3                       RS-485 TX enable high

                                                            4                             low

                                                            Default Parameter Value: 0

                                                            Number of bytes returned: 1

                                                            Related Commands: RT (DI2 Configuration),

                                                            TO (DO2 Timeout)

                                                            Minimum Firmware Version Required: 4.27D

CT (Command Mode Timeout) Command

CT Command is used                   AT Command: ATCT

to set the amount of time of inactivity before AT           Binary Command:   0x06 (6 decimal)

Command Mode automatically terminates. After a              Parameter Range:  2 – 0xFFFF
                                                                              (x 100 milliseconds)
CT time of inactivity, the module exits AT

Command Mode and returns to Idle Mode. AT                   Default Parameter Value: 0xC8 (200 decimal,
                                                            20 seconds)
Command Mode can also be exited manually
                                                            Number of bytes returned: 2
using the CN (Exit AT Command Mode)

Command.

DC (Disconnect) Command

DC Command is                     AT Command: ATDC

used (when in Multi-Streaming Mode (MD = 1                  Binary Command: 0x37 (55 decimal)

or 2)) to explicitly force the disconnection of an          Related Commands: CB (Connection Duration

active exclusive connection. If MD = 1, the base            Timeout), CE (Connection Inactivity Timeout),

module will force the disconnection of an                   MD (RF Mode)

exclusive connection. If MD = 2, the remote                 Minimum Firmware Version Required: 4.30

module will send a “Disconnect Request Packet”

to the base module.

© 2014 Digi International Inc.                                                                         25
XStream™ OEM RF Module – Product Manual v5.x00

DR (DI3 Configuration) Command

DR Command is used to           AT Command: ATDR

configure DI3 (pin 2, SLEEP) for I/O line passing    Binary Command: 0x2D (45 decimal)

(use with CD = 1 or 2 and CO) or controlling         Parameter Range:   0–4

connection status (use with MD = 1 or 2).            Parameter                   Configuration

                                                     0                            Disabled

                                                     1                  DI3 I/O passing enabled

                                                     2                           Connect on low

                                                     3                     Disconnect on high

                                                     4                  Connect and Disconnect

                                                     Default Parameter Value: 0

                                                     Number of bytes returned: 1

                                                     Related Commands: CD (DO3 Configuration),

                                                     CO (DO3 Timeout),  MD (RF Mode)

                                                     Minimum Firmware Version Required: 4.30

DT (Destination Address) Command

DT Command is              AT Command: ATDT

used to set the networking address of an             Binary Command: 0x00

XStream Module. XStream Modules use three            Parameter Range:   0 – 0xFFFF

filtration layers: Channels (ATHP), Vendor           Default Parameter Value: 0

Identification Number (ATID) and Destination         Number of bytes returned: 2

Addresses (ATDT). DT Command assigns an              Related Commands: HP (Hopping Channel), ID

address to a module that enables it to               (Module VID), MK (Address Mask)

communicate only with other modules having the

same addresses. All

modules that share the same Destination Address can communicate freely with each other.

Modules in the same network with a different Destination Address (than that of the transmitter)

will listen to all transmissions to stay synchronized, but will not send any of the data out their

serial ports.

E0 (Echo Off) Command

The E0 command                AT Command: ATE0

turns off character echo in AT Command Mode.         Binary Command: 0x0A (10 decimal)

By default, echo is off.

E1 (Echo On) Command

E1 Command turns              AT Command: ATE1

on the echo in AT Command Mode. Each typed           Binary Command: 0x0B (11 decimal)

character will be echoed back to the terminal

when ATE1 is active. E0 is the default.

ER (Receive Error Count) Command

Set/Read the receive error count.      AT Command: ATER

The error-count records the number of packets        Binary Command: 0x0F (15 decimal)

partially received then aborted on reception         Parameter Range:   0 – 0xFFFF

error. This value returns to 0 after a reset and is  Default Parameter Value: 0

not non-volatile (value does not persist in the      Number of bytes returned: 2

module’s memory after a power-up sequence).          Related Commands: GD (Receive Good Count)

Once the receive error count reaches its

maximum value (up to 0xFFFF), it remains at its maximum count value until the maximum count

value is explicitly changed or the module is reset.

© 2014 Digi International Inc.                                                                      26
XStream™  OEM  RF  Module – Product Manual v5.x00

                   FH (Force Wake-up Initializer) Command

                    FH Command is used to           AT Command: ATFH

                   force a Wake-up Initializer to be sent on the next  Binary Command: 0x0D (13 decimal)

                   transmission. WR (Write) Command does not

                   need to be issued with FH Command.

                   Use only with cyclic sleep modes active on remote   modules.

                   FL (Software Flow Control) Command

                    FL Command is used to          AT Command: ATFL

                   configure of module with software flow control.     Binary Command: 0x07 (7 decimal)

                   Hardware flow control is implemented with the       Parameter Range:  0–1

                   XStream Module as the DO2 pin (     ), which        Parameter                   Configuration

                   regulates when serial data can be transferred to

                   the module. FL Command is used to allow                       0              Disable software

                   software flow control. XON character used is                                     flow control

                   0x11 (17 decimal). XOFF character used is 0x13                1                 Enable software

                   (19 decimal).                                                                    flow control

                                                                       Default Parameter Value: 0

                                                                       Number of bytes returned: 1

                   FT (Flow Control Threshold) Command

                    Set/Read the flow control      AT Command: ATFT

                   threshold. When FT bytes have accumulated in        Binary Command: 0x24 (36 decimal)

                   the DI buffer,  is de-asserted or the XOFF          Parameter Range:  0 – 0xFF (bytes)
                                                                       (Maximum value equals the receiving module
                   software flow control character is transmitted.
                                                                       DO buffer size minus 0x11 bytes)

                                                                       Default Parameter Value: Receiving module DO

                                                                       Buffer size minus 0x11

                                                                       Number of bytes returned: 2

                                                                       Minimum Firmware Version Required: 4.27B

                   GD (Receive Good Count) Command

                    Set/Read the count of good            AT Command: ATGD

                   received RF packets. Parameter value is reset to    Binary Command:   0x10 (16 decimal)

                   0 after every reset and is not non-volatile (value  Parameter Range:  0 – 0xFFFF

                   does not persist in the module’s memory after a     Default Parameter Value: 0

                   power-up sequence). Once the “Receive Good          Number of bytes returned: 2

                   Count” reaches its maximum value (up to             Related Commands: ER (Receive Error  Count)

                   0xFFFF), it remains at its maximum count value

                   until the maximum count value is manually changed   or the module is reset.

                   HP (Hopping Channel) Command

                    HP Command is             AT Command: ATHP

                   used to set the module hopping channel number.      Binary Command: 0x11 (17 decimal)

                   A channel is one of three layers of addressing      Parameter Range:  0–6

                   available to the module. In order for modules to    Default Parameter Value: 0

                   communicate with each other, the modules must       Number of bytes returned: 1

                   have the same channel number since each             Related Commands: DT (Destination Address),

                   network uses a different hopping sequence.          ID (Module VID), MK (Address Mask)

                   Different channels can be used to prevent

                   modules in one network from listening to transmissions of another.

© 2014 Digi International Inc.                                                                                      27
XStream™ OEM RF Module – Product Manual v5.x00

HT (Time before Wake-up Initializer) Command

If any modules within          AT Command: ATHT

range are running in a “Cyclic Sleep” setting, a   Binary Command: 0x03 (3 decimal)

wake-up initializer must be used by the            Parameter Range:     0 – 0xFFFF

transmitting module for sleeping modules to                             (x 100 milliseconds)

remain awake (refer to the LH (“Wake-up            Default Parameter Value: 0xFFFF (means that
                                                   long wake-up initializer will not be sent)
Initializer Timer”) Command). When a receiving
                                                   Number of bytes returned: 2
module in Cyclic Sleep wakes, it must detect the
                                                   Related Commands: LH (Wake-up Initializer
wake-up initializer in order to remain awake and   Timer), SM (Sleep Mode), ST (Time before

receive data. The value of HT Parameter tells the  Sleep)

transmitter, “After a period of inactivity (no

transmitting or receiving) lasting HT amount of time, send a long wake-up initializer”. HT

Parameter should be set to match the inactivity timeout (specified by ST (Time before Sleep)

Command) used by the receiver(s).

From the receiving module perspective, after HT time elapses and the inactivity timeout (ST

command) is met, the receiver goes into cyclic sleep. In cyclic sleep, the receiver wakes once per

sleep interval to check for a wake-up initializer. When a wake-up initializer is detected, the

module will stay awake to receive data. The wake-up initializer must be longer than the cyclic

sleep interval to ensure that sleeping modules detect incoming data. When HT time elapses, the

transmitter then knows that it needs to send a long Wake-up Initializer for all receivers to be able

to remain awake and receive the next transmission. Matching HT to the time specified by ST on

the receiving module guarantees that all receivers will detect the next transmission.

ID (Modem VID) Command

Set/Read the VID         AT Command: ATID

(Vendor Identification Number). Only modules       Binary Command:      0x27 (39 decimal)

with matching VIDs can communicate with each       Parameter Range (user-settable):
                                                                        0x10 - 0x7FFFF
other. Modules with non-matching VIDs will not
                                                   (Factory-set and read-only) :
receive unintended data transmission.
                                                                        0x8000 – 0xFFFF

                                                   Number of bytes returned: 2

                                                   Minimum Firmware Version Required: 4.2B

                                                   (previous firmware versions did not support

                                                   user-settable IDs.)

IU (DI2, DI3 Update Timer) Command

Set/Read the interval at      AT Command: ATIU

which the status of DI2, DI3 and Break is          Binary Command: 0x3B (59 decimal)

transmitted. Additionally, status is transmitted   Parameter Range:     0 - 0xFFFF (x 100 ms)

whenever there is a transition. A setting of “0”   Default Parameter Value: 0x0A (10 decimal)

disables periodic update. DI2 or DI3 passing       Number of bytes returned: 2

must be enabled for the update to take place.      Related Commands: BK (Serial Break Passing),

                                                   BO (Serial Break Timeout), CO (DO3 Timeout),

                                                   DR (Disconnect), RT (DI2 Configuration), TO

                                                   (DO2 Timeout)

                                                   Minimum Firmware Version Required: 4.30

© 2014 Digi International Inc.                                                                      28
XStream™ OEM RF Module – Product Manual v5.x00

LH (Wake-up Initializer Timer) Command

Set/Read the amount of          AT Command: ATLH

time during which the RF initializer is sent. When  Binary Command:    0x0C (12 decimal)

receiving modules are put into Cyclic Sleep Mode,   Parameter Range:   0 – 0xFF

they power-down after a period of inactivity                           (x 100 milliseconds)

(specified by ST (Time before Sleep) Command)       Default Parameter Value: 1

and will periodically awaken and listen for         Number of bytes returned: 1

transmitted data. In order for the receiving        Related Commands: HT (Time before Wake-up

modules to remain awake, they must detect           Initializer), SM (Sleep Mode), ST (Time before

~35ms of the wake-up initializer.                   Sleep)

LH Command must be used whenever a receiver is operating in Cyclic Sleep Mode. This lengthens

the Wake-up Initializer to a specific amount of time (in tenths of a second). The Wake-up

Initializer Time must be longer than the cyclic sleep time that is determined by SM (Sleep Mode)

Command. If the wake-up initializer time were less than the Cyclic Sleep interval, the connection

would be at risk of missing the wake-up initializer transmission.

Refer to the figures in the Sleep Mode sections (p13) to view correct and incorrect configuration

diagrams. The images help visualize the importance that the LH value be greater than the SM cyclic

sleep value.

MD (RF Mode) Command

The MD command is         AT Command: ATMD

used to select/read the RF Mode (Peer-to-peer,      Binary Command: 0x32 (50 decimal)

Multi-Stream or Repeater Modes) of the module.      Parameter Range:   0–4

Multi-Streaming Mode enables exclusive                      Parameter           Configuration

connections in point-to-multipoint networks.                                     Peer-to-Peer

Refer to the Multi-Streaming Mode section (p43)                    0   (transparent operation)

for more information regarding how these                           1        Multi-Stream Base

parameter values affect other parameter values.                    2   Multi-Stream Remote

Repeater Mode enables longer range via an                          3   Repeater and End Node

intermediary module. When MD=3, the module                         4             End Node

will act as a “store and forward” repeater. Any     Default Parameter Value: 0

packets not addressed to this node will be          Number of bytes returned: 1

repeated. A Repeater End Node (MD=4) handles        Related Commands: CB (Connection Duration

repeated messages, but will not forward the data    Timeout), CE (Connection Inactivity Timeout),

over-the-air. Refer to the Repeater Mode section    CM (Connection Message), DC (Disconnect)

(p38) for more information.                         Minimum Firmware Version Required: 4.30

MK (Address Mask) Command

MK Command is             AT Command: ATMK

used to set/read the address mask of the            Binary Command: 0x12 (18 decimal)

module.                                             Parameter Range:   0 – 0xFFFF

All data packets contain the destination address    Default Parameter Value: 0xFFFF
                                                    (Destination address (DT parameter) of the
(DT Parameter) of the transmitting module.
                                                    transmitting module must exactly match the

When an RF data packet is received, the             destination address of the receiving module.)

transmitter’s destination address is logically      Number of bytes returned: 2

“ANDed” (bitwise) with the Address Mask of the      Related Commands: DT (Destination Address),

receiver. The resulting value must match the        HP (Hopping Channel), ID (Module VID), MY

destination address or the address mask of the      (Source Address)

receiver for the packet to be received and sent

out the module DO serial port. If the “ANDed”

value does not match either the destination address or the address mask of the receiver, the

packet is discarded. (All “0” values are treated as “irrelevant” values and are ignored.)

Refer to the Addressing Options section (p36) for more information.

© 2014 Digi International Inc.                                                                      29
XStream™  OEM  RF  Module – Product Manual v5.x00

                   MY (Source Address) Command

                    Set/Read the            AT Command: ATMY

                   source address of the module.                     Binary Command:   0x2A (42 decimal)

                   Refer to the Addressing section (p36) of the RF   Parameter Range:  0 – 0xFFFF

                   Communication Modes chapter for more              Default Parameter Value: 0xFFFF (Disabled –
                                                                     the DT (Destination Address) parameter serves
                   information.
                                                                     as both source and destination address.)

                                                                     Number of bytes returned: 2

                                                                     Related Commands: DT (Destination Address),

                                                                     HP (Hopping Channel), ID (Modem VID), MK

                                                                     (Address Mask), AM (Auto-set MY)

                                                                     Minimum Firmware Version Required: 4.30

                   NB (Parity) Command

                    Select/Read parity settings  AT Command: ATNB

                   for UART communications.                          Binary Command: 0x23 (35 decimal)

                                                                     Parameter Range:  0–5

                                                                     Parameter                        Configuration

                                                                     0                      8-bit (no parity or
                                                                                                      7-bit (any parity)

                                                                     1                                8-bit even

                                                                     2                                8-bit odd

                                                                     3                                8-bit mark

                                                                     4                                8-bit space

                                                                     5                                9-bit

                                                                     Default Parameter Value: 0

                                                                     Number of bytes returned: 1

                                                                     Minimum Firmware Version Required: 4.30

                                                                     (previous versions did not support the 9th bit.

                   PC (Power-up Mode) Command

                    PC Command allows          AT Command: ATPC

                   the module to power-up directly into AT           Binary Command: 0x1E (30 decimal)

                   Command Mode from reset or power-on. If PC        Parameter Range:  0–1

                   Command is enabled with SM Parameter set to 1,    Parameter                        Configuration

                   DI3 (pin 2) can be used to enter the module into  0                 Power-up to Idle Mode

                   AT Command Mode. When the DI3 pin is de-          1                                Power-up to

                   asserted (low), the module will wake-up in AT                       AT Command Mode

                   Command Mode. This behavior allows module         Default Parameter Value: 0

                   DTR emulation.                                    Number of bytes returned: 1

                                                                     Minimum Firmware Version Required: 4.22

                   PK (RF Packet Size) Command

                    Set/Read the maximum size    AT Command: ATPK

                   of the RF packets sent out a transmitting         Binary Command:   0x29 (41 decimal)

                   module. The maximum packet size can be used       Parameter Range:  0 – 0x100 (Bytes)

                   along with the RB and RO parameters to            Default Parameter Value: 0x40 (64 decimal)

                   implicitly set the channel dwell time.            Number of bytes returned: 2

                   Changes to this parameter may have a              Related Commands: RB (Packetization
                                                                     Threshold), RO (Packetization Timeout)
                   secondary effect on the RB (Packet Control

                   Characters) parameter. RB must always be less     Minimum Firmware Version Required: 4.30

                   than or equal to PK. If PK is changed to a value

                   less than the current value of RB, RB is automatically lowered to be equal to PK.

© 2014 Digi International Inc.                                                                                            30
XStream™ OEM RF Module – Product Manual v5.x00

PW (Pin Wake-up) Command

Under normal operation, a                               AT Command: ATPW

module in Cyclic Sleep Mode cycles from an                                  Binary Command: 0x1D (29 decimal)

active state to a low-power state at regular                                Parameter Range:   0–1

intervals until data is ready to be received. If the                        Parameter                      Configuration

PW Parameter is set to 1, SLEEP (pin 2) can be                              0                              Disabled

used to wake the module from Cyclic Sleep. If the

SLEEP pin is de-asserted (low), the module will                             1                              Enabled

be fully operational and will not go into Cyclic                            Default Parameter Value: 0

Sleep. Once SLEEP is asserted, the module will                              Number of bytes returned: 1

remain active for the period of time specified by                           Related Commands: SM (Sleep Mode), ST         (Time

ST (Time before Sleep) Command and will return                              before Sleep)

to Cyclic Sleep Mode (if no data is ready to be                             Minimum Firmware Version Required: 4.22

transmitted). PW Command is only valid if Cyclic

Sleep has been enabled.

RB (Packetization Threshold) Command

RF transmission will                                   AT Command: ATRB

commence when data is in the DI Buffer and                                  Binary Command: 0x20 (32 decimal)

either of the following criteria are met:                                   Parameter Range:   0 – 0x100 (bytes)

                                •  RO times out on the UART receive lines   (Maximum value equals the current value of PK

                                   (ignored if RO = 0)                      Parameter (up to 0x100 HEX (800 decimal))

                                •  RB characters have been received by the  Default Parameter Value: 1

                                   UART (ignored if RB = 0)                 Number of bytes returned: 2

If PK is lowered below the value of RB; RB is                               Related Commands: PK (RF Packet Size), RO
                                                                            (Packetization Timeout)

automatically lowered to match PK.                                          Minimum Firmware Version Required: 4.30

Note: RB and RO criteria only apply to the first

packet of a multi-packet transmission. If data remains in the DI Buffer after the first packet,

transmissions will continue in streaming manner until there is no data left in the DI Buffer (UART

receive buffer).

RE (Restore Defaults) Command

RE Command restores all                                       AT Command: ATRE

configurable parameters to factory default                                  Binary Command:    0x0E (14 decimal)

settings. However, RE Command will not write

the restored values to non-volatile (persistent) memory. Issue the WR (Write) Command after

the RE command to save restored parameter values to non-volatile memory.

RN (Delay Slots) Command

RN Command is only                                AT Command: ATRN

applicable if retries have been enabled (RR                                 Binary Command:    0x19 (25 decimal)

(Retries) parameter > 0), or if forced delays will                          Parameter Range:   0 – 0xFF (slots)

be inserted into a transmission (TT (Streaming                              Default Parameter Value: 0
                                                                            (no delay slots are inserted)
Limit) parameter > 0). RN Command is used to
                                                                            Number of bytes returned: 1
adjust the time delay that the transmitter inserts
                                                                            Related Commands: RR (Retries), TT
before attempting to resend a packet. If the
                                                                            (Streaming Limit)
transmitter fails to receive an acknowledgement
                                                                            Minimum Firmware Version Required: 4.22
after sending a packet, it will insert a random

number of delay slots (ranging from 0 to (RN

minus 1)) before attempting to resend the packet.                           Each delay slot lasts for a period of 38ms.

If two modules attempted to transmit at the same time, the random time delay after packet

failure would allow one of the two modules to transmit the packet successfully, while the other

would wait until the channel opens up to begin transmission.

© 2014 Digi International Inc.                                                                                            31
XStream™ OEM RF Module – Product Manual v5.x00

RO (Packetization Timeout) Command

Set/Read the time of silence                      AT Command: ATRO

(no bytes received) after which transmission                           Binary Command: 0x21 (33 decimal)

begins. After a serial byte is received and if no                      Parameter Range:  0 – 0xFFFF                  (x 200 µs)

other byte is received before the RO timeout, the                      Default Parameter Value: 0

transmission will start.                                               Number of bytes returned: 2

                                                                       Minimum Firmware Version Required: 4.2A

RP (RSSI PWM Timer) Command

RP Command is used to enable                             AT Command: ATRP

PWM (Pulse Width Modulation) output on the                             Binary Command: 0x22 (34 decimal)

CONFIG pin. The output is calibrated to show the                       Parameter Range:  0 - 0x7F
                                                                                         (x 100 milliseconds)
level the received RF signal is above the

sensitivity level of the module. The PWM pulses                        Default Parameter Value: 0 (disabled)

vary from zero to 95 percent. Zero percent                             Number of bytes returned: 1

means the received RF signal is at or below the                        Minimum Firmware Version Required: 4.2A

published sensitivity level of the module. The

following table shows levels above sensitivity and            PWM values.

The total period of the PWM output is 8.32 ms. Because there are 40 steps in the PWM output;

the minimum step size is 0.208 ms.

Table 3‐03.                     PWM Chart

                                dBm above Sensitivity  PWM percentage

                                                       (high period / total period)

                                10                     47.5%

                                20                     62.5%

                                30                     77.5%

A non-zero value defines the time that the PWM output will be active with the RSSI value of the

last received RF packet. After the set time when no RF packets are received, the PWM output will

be set low (0 percent PWM) until another RF packet is received. The PWM output will also be set

low at power-up. A parameter value of 0xFF permanently enables the PWM output and it will

always reflect the value of the last received RF packet.

PWM output shares the Config input pin. When the module is powered, the Config pin will be an

input. During the power-up sequence, the Config pin will be read to determine whether the

module is going into AT Command Mode. After this, if RP parameter is a non-zero value, the

Config pin will be configured as an output and set low until the first RF packet is received. With a

non-zero RP parameter, the Config pin will be an input for RP ms after power up.

RR (Retries) Command

Set/Read the number of retries                            AT Command: ATRR

that can be sent for a given RF packet. Once RR                        Binary Command: 0x18 (24 decimal)

command is enabled (set to a non-zero value),                          Parameter Range:  0 – 0xFF

RF packet acknowledgements and retries are                             Default Parameter Value: 0 (disabled)

enabled. After transmitting a packet, the                              Number of bytes returned: 1

transmitter will wait to receive an                                    Minimum Firmware Version Required: 4.22

acknowledgement from a receiver. If the

acknowledgement is not received in the period of time specified by the RN (Delay Slots)

Command, the transmitter will transmit the original packet again. The packet will be transmitted

repeatedly until an acknowledgement is received or until the packet has been sent RR times.

Note:                           For retries to work correctly, all modules in the system must have retries enabled.

© 2014 Digi International Inc.                                                                                                   32
XStream™ OEM RF Module – Product Manual v5.x00

RS (RSSI) Command

Read the signal level of the last                AT Command: ATRS

packet received. This reading is useful for                    Binary Command: 0x1C (28 decimal)

determining range characteristics of the modules               Parameter Range: 0x06 – 0x36  (read-only)

under various conditions of noise and distance.                Number of bytes returned: 1

Once the command is issued, the module will                    Minimum Firmware Version Required: 4.22

return a value between 0x06 and 0x36.

(“0x36” represents a very strong signal level

and “0x06” indicates a low signal level.)

RT (DI2 Configuration) Command

RT command is used to                     AT Command: ATRT

dictate the behavior of the DI2/                /CMD line. RT  Binary Command: 0x16 (22 decimal)

Command must be issued to enable                flow           Parameter Range:  0–2

control or binary programming.                                 Parameter                   Configuration

                                                               0                            disabled

                                                               1                 Enable Binary Programming

                                                               2                 Enable      Flow Control

                                                               Default Parameter Value: 0

                                                               Number of bytes returned: 1

RZ (DI Buffer Size) Command

The RZ command is used to read                   AT Command: ATRZ

the size of the DI buffer (UART RX (Receive)).                 Binary Command:   0x2C (44 decimal)

Note: The DO buffer size can be determined by                  Parameter Range:  Read-only

multiplying the DI buffer size by 1.5.                         Number of bytes returned: 2

                                                               Minimum Firmware Version Required: 4.30

SB (Stop Bits) Command

Set/Read the number of                    AT Command: ATSB

stop bits in the RF data packets.                              Binary Command: 0x36 (54 decimal)

                                                               Parameter Range:  0–1

                                                               Parameter                   Configuration

                                                               0                            1 stop bits

                                                               1                            2 stop bits

                                                               Default Parameter Value: 0

                                                               Number of bytes returned: 1

                                                               Minimum Firmware Version Required: 4.2B

SH (Serial Number High) Command

Set/Read the serial number high                  AT Command: ATSH

word of the module.                                            Binary Command:   0x25 (37 decimal)

                                                               Parameter Range:  0 – 0xFFFF (read-only)

                                                               Number of bytes returned: 2

                                                               Related Commands: SL (Serial Number Low)

                                                               Minimum Firmware Version Required: 4.27C

© 2014 Digi International Inc.                                                                            33
XStream™ OEM RF Module – Product Manual v5.x00

SL (Serial Number Low) Command

Set/Read the serial number low          AT Command: ATSH

word of the module.                                   Binary Command: 0x26 (38 decimal)

                                                      Parameter Range:      0 – 0xFFFF  (read-only)

                                                      Number of bytes returned: 2

                                                      Related Commands: SH (Serial Number High)

                                                      Minimum Firmware Version Required: 4.27C

SM (Sleep Mode) Command

Set/Read Sleep Mode          AT Command: ATSM

Settings. By default, Sleep Mode is disabled and      Binary Command: 0x01

the module remains continually active.                Parameter Range:      0–8

SM Command allows the module to run in a              Parameter                   Configuration

lower-power state and to be configured in one of                0                  Disabled

eight settings.                                                 1                  Pin Sleep

Cyclic Sleep settings wake the module after the                 2                Serial Port Sleep

amount of time designated by SM Command. If                                 Cyclic 0.5 second sleep

the module detects a wake-up initializer during                 3                 (Module wakes

the time it is awake, it will synchronize with the                          every 0.5 seconds)

transmitter and start receiving data after the                  4           Cyclic 1.0 second sleep

wake-up initializer runs its duration. Otherwise, it            5           Cyclic 2.0 second sleep

returns to Sleep Mode and continues to cycle in                 6           Cyclic 4.0 second sleep

and out of inactivity until the Wake-up Initializer             7           Cyclic 8.0 second sleep

is detected. If a Cyclic Sleep setting is chosen,               8           Cyclic 16.0 second sleep

the ST, LH and HT parameters must also be set         Default Parameter Value: 0

as described in the “Sleep Mode” section of this      Number of bytes returned: 1

manual.                                               Related Commands:

Refer to the Sleep Mode sections for more             Pin Sleep – PC (Power-up Mode), PW (Pin

information.                                          Wake-up)

                                                      Serial Port Sleep – ST (Time before Sleep)

                                                      Cyclic Sleep – ST (Time before Sleep), LH

                                                      (Wake-up Initializer Timer), HT (Time Before

                                                      Wake-up Initializer), PW (Pin Wake-up)

ST (Time before Sleep) Command

Set/Read the period          AT Command: ATST

of time in which the module remains inactive          Binary Command: 0x02

before entering into Sleep Mode. For example: If      Parameter Range:      0x10 – 0xFFFF

the ST parameter is set to 0x64 (100 decimal),                              (x 100 milliseconds)

the module will enter into Sleep mode after 10        Default Parameter Value: 0x64 (100 decimal)

seconds of inactivity (no transmitting or             Number of bytes returned: 2

receiving). This command can only be used if          Related Commands: SM (Sleep Mode), LH

Cyclic Sleep or Serial Port Sleep Mode settings       (Wake-up Initializer Timer), HT (Time before
                                                      Wake-up Initializer)
have been selected using the SM command.

© 2014 Digi International Inc.                                                                      34
XStream™ OEM RF Module – Product Manual v5.x00

SY (Time before Initialization) Command

SY Command keeps a             AT Command: ATSY

communication channel open as long as module             Binary Command: 0x17 (23 decimal)

transmits or receives before the active connection       Parameter Range:  0 – 0xFF

expires. It can be used to reduce latency in a                             (x 100 milliseconds)

query/response sequence and should be set 100            Default Parameter Value: 0 (Disabled - channel

ms longer than the delay between transmissions.          initialization info sent with each RF packet.)

This command allows multiple XStream Modules             Number of bytes returned: 1

to share a hopping channel for a given amount of time after receiving data. By default, all

packets include an RF initializer that contains channel information used to synchronize any

listening receivers to the transmitter’s hopping pattern. Once a new module comes within range,

it is able to instantly synchronize to the transmitter and start receiving data. If no new modules

are introduced into the system, the synchronization information becomes redundant once

modules have become synchronized.

SY Command allows the modules to remove this information from the RF Initializer after the

initial synchronization. For example, changing the SY Parameter to 0x14 (20 decimal) allows all

modules to remain in sync for 2 seconds after the last data packet was received. Synchronization

information is not re-sent unless transmission stops for more than 2 seconds. This command

allows significant savings in packet transmission time.

Warning: Not recommended for use in an interference-prone environment. Interference can break up

the session and the communications channel will not be available again until SY time expires.

With SY set to zero, the channel session is opened and closed with each transmission - resulting

in a more robust link with more latency.

TO (DO2 Timeout) Command

DO2 output will return to            AT Command: ATTO

default after no DI2 status information is               Binary Command: 0x31 (49 decimal)

received during the timeout period.                      Parameter Range:  0 – 0xFFFF    (x 1 second)

Use with CS = 2 or 4.                                    Default Parameter Value: 3

                                                         Number of bytes returned: 2

                                                         Minimum Firmware Version Required: 4.30

TR (Transmit Error Count) Command

Read number of retransmit                  AT Command: ATTR

failures. The number of retransmit errors is             Binary Command: 0x1B (27 decimal)

incremented each time a packet is not                    Parameter Range:  0 – 0xFFFF

acknowledged within the number of retransmits            Default Parameter Value: 0

specified by the RR (Retries) parameter. It              Number of bytes returned: 2

therefore counts the number of packets that were         Related Commands: RR (Retries)

not successfully received and have been dropped.         Minimum Firmware Version Required: 4.22

The TR parameter is not non-volatile and therefore       is reset to zero each time the module is reset.

© 2014 Digi International Inc.                                                                           35
XStream™  OEM  RF  Module – Product Manual v5.x00

                   TT (Streaming Limit) Command

                    Set/Read the                AT Command: ATTT

                   number of bytes that can be sent out before a         Binary Command: 0x1A (26 decimal)

                   random delay is issued. TT Command is used to         Parameter Range:  0 – 0xFFFF (bytes)

                   simulate full-duplex behavior.                        Default Parameter Value: 0xFFFF (65535d)

                                                                         Number of bytes returned: 2

                   If a module is sending a continuous stream of RF      Related Commands: RN (Delay Slots)

                   data, a delay is inserted (transmission is stopped,   Minimum Firmware Version Required: 4.22

                   allowing other modules time to transmit (once it

                   sends number of bytes specified by TT Command). Inserted random delay lasts between 1 and           ‘RN

                   + 1’ delay slots, where each delay slot lasts 38 ms.

                   VR (Firmware Version) Command

                    Read the Firmware Version of the        AT Command: ATVR

                   module.                                               Binary Command: 0x14 (20 decimal)

                                                                         Parameter Range:  0 – 0xFFFF  (read-only)

                                                                         Number of bytes returned: 2

                   WR (Write) Command

                    WR Command writes configurable            AT Command: ATWR

                   parameters to the module’s non-volatile memory        Binary Command: 0x08

                   (Parameter values remain in the module’s

                   memory until overwritten by future use of WR Command).

                   If changes are made without writing them to non-volatile memory, the module reverts back to

                   previously saved parameters the next time the module is powered-on.

© 2014 Digi International Inc.                                                                                     36
XStream™ OEM RF Module – Product Manual v5.x00

   4.    RF Communication Modes

                              Network configurations covered in this chapter are described in terms of the following:

                                    •  Network Topology (Point-to-Point, Point-to-Multipoint or Peer-to-Peer)

                                    •  RF Communication Type (Basic or Acknowledged)

                                    •  RF Mode (Streaming, Repeater, Acknowledged or Multi-Streaming)

                              The following table provides a summary of the network configurations supported.

                              Table 4‐01.     Summary of network configurations supported by the XStream OEM RF Module

                              Point-to-Point

                                                   Definition                           An RF data link between two modules.

                                                   Sample Network Profile *             Use default values for all modules.

                                                   (Broadcast Communications)

                                                   Sample Network Profile *             All Modules: ATAM (auto-set MY (Source Address) parameter) **

                                                   (Acknowledged Communications)                  ATDT FFFF (set Destination Address to 0xFFFF)

                                                   Basic Communication RF Modes         Streaming Mode (p37), Repeater Mode (p38)

                                                   Acknowledged Communication RF Mode   Acknowledged Mode (p41)

                              Point-to-Multipoint

                                                   Definition                           RF data links between one base and multiple remotes.

                                                                                        Base:     ATMY 0 (set Source Address to 0x00)

                                                   Sample Network Profile *                       ATDT FFFF (set Destination Address to 0xFFFF)

                                                   (Basic Communications)               Remotes:  ATAM (auto-set MY (Source Address) parameter) **

                                                                                                  ATDT 0 (set Destination Address to 0x00)

                                                                                        Base:     ATMY 0 (set Source Address to 0x00)

                                                                                                  ATDT FFFF (set Destination Address to 0xFFFF)

                                                   Sample Network Profile *                       ATRR 3 (set number of Retries to 3)

                                                   (Acknowledged Communications)        Remotes:  ATAM (auto-set MY (Source Address) parameter) **

                                                                                                  ATDT 0 (set Destination Address to 0x00)

                                                                                                  ATRR 3 (set number of Retries to 3)

                                                   Basic Communication RF Modes         Streaming Mode (p37), Repeater Mode (p38)

                                                   Acknowledged Communication RF Modes  Acknowledged Mode (p41), Multi-Streaming Mode (p43)

                              Peer-to-Peer

                                                                                        Modules remain synchronized without use of a master/server. Each

                                                   Definition                           module shares the roles of master and slave. Digi’s peer-to-peer

                                                                                        architecture features fast synch times (35ms to synchronize

                                                                                        modules) and fast cold start times (50ms before transmission).

                                                   Sample Network Profile *             Use default values for all modules.

                                                   (Basic Communications)

                                                   Sample Network Profile *             All Modules: ATAM (auto-set MY (Source Address) parameter) **

                                                   (Acknowledged Communications)                  ATDT FFFF (set Destination Address to 0xFFFF)

                                                                                                  ATRR 3 (set number of Retries to 3)

                                                   Basic Communication RF Mode          Streaming Mode (p37)

                                                   Acknowledged Communication RF Mode   Acknowledged Mode (p41)

                              * Assume default values for parameters not listed. Profiles do not reflect addressing implementations.

                              ** AM (Auto‐set MY) Command must be issued through a terminal program such as the one incorporated in

                              the XCTU “Terminal” tab.

©  2014  Digi  International  Inc.                                                                                                                   37
XStream™ OEM         RF  Module – Product Manual v5.x00

               4.1.      Addressing

                         Each RF packet contains addressing information that is used to filter incoming RF data. Receiving

                         modules inspect the Hopping Channel (HP parameter), Vendor Identification Number (ID

                         parameter) and Destination Address (DT parameter) contained in each RF packet. Data that does

                         not pass through all three network security layers is discarded.

                         Figure 4‐01.  Filtration layers contained in the RF packet header

                     4.1.1.        Address Recognition

                         Transmissions can be addressed to a specific module or group of modules using the DT

                         (Destination Address) and MK (Address Mask) parameters. The transmitting module dictates

                         whether the packet is intended for a specific module (local address) or multiple modules (global

                         address) by comparing the packet’s DT parameter to its own MK parameter.

                         Figure 4‐02.  Local Packets vs. Global Packets (Transmitting Module)

                         TX_DT = Transmitter Destination Address

                         TX_MK = Transmitter Address Mask

                         Note: When TX_DT = 0xFFFF (default), RF packets are global and

                         are received by all modules within range. (Receivers do not send

                         ACKs.)

                         A receiving module will only accept a packet if a packet is addressed to it (either as a global or

                         local packet). The RX module makes this determination by inspecting the destination address of

                         the RF packet and comparing it to its own address and mask. The Destination Address of the TX

                         module is logically “ANDed” with the Address Mask of the RX module.

                         Figure 4‐03.  Address Recognition (Receiving Module)

                         TX_DT = Transmitter Destination Address

                         RX_DT = Receiver Destination Address

                         RX_MY = Receiver Source Address

                         Note: For more information regarding addressing and masks, refer to Application Note “XST-

                         AN004b” (located on the web at: www.digi.com.)

©  2014  Digi  International Inc.                                                                                            38
XStream™ OEM RF Module – Product Manual v5.x00

4.2.  Basic Communications

      Basic Communications are accomplished through two sub-types:

                                •  Broadcast - By default, XStream Modules communicate through Broadcast

                                   communications and within a peer-to-peer network topology. When any module

                                   transmits, all other modules within range will receive the data and pass it directly to

                                   their host device.

                                •  Addressed - If addressing parameters match, received RF data is forwarded to the DO      (Data

                                   Out) buffer; otherwise, the RF data is discarded.

      When using Basic Communications, any functions such as acknowledgements are handled

      at the application layer by the OEM/integrator. The Broadcast Modes provide transparent

      communications, meaning that the RF link simply replaces a wired link.

      4.2.1.                       Streaming Mode (Default)

      Characteristics:                           Highest data throughput

                                                 Lowest latency

                                                       and jitter

                                                       Reduced immunity to

                                                       interference

                                                 Transmissions never acknowledged (ACK) by receiving module(s)

      Required Parameter Values (TX Module): RR (Retries) = 0

      Related Commands: Networking (DT, MK, MY), Serial Interfacing (PK, RB, RO, TT)

      Recommended Use: Mode is most appropriate for data systems more sensitive to

      latency and/or jitter than to occasional packet loss. For example: streaming audio or

      video.

      Streaming Mode Data Flow

      Figure 4‐04.                 Streaming Mode State Diagram (TX Module)

      Events and processes in this mode are common to all of the

      other RF Modes.

      Note: When streaming data, RB and RO parameters are only

      observed on the first packet.

      After                        transmission        begins,  the  TX     event  will  continue

      uninterrupted until the DI buffer is empty or the streaming limit

      (TT Command) is reached. As with the first packet, the payload

      of each subsequent packet includes up to the maximum packet

      size (PK Command).

      The streaming limit (TT Command) is specified by the

      transmitting module as the maximum number of bytes the

      transmitting module can send in one transmission event. After

      the TT parameter threshold is reached, the transmitting module

      will force a random delay of 1 to RN delay slots (exactly 1 delay

      slot if RN = 0).

      Subsequent packets are sent without an RF initializer since

      receiving modules stay synchronized with the transmitting

      module for the duration of the transmission event (from

      preceding packet information). However, due to interference,

      some receiving modules may lose data (and synchronization

      to the transmitting module), particularly during long

      transmission events.

© 2014 Digi International Inc.                                                                                              39
XStream™ OEM RF Module – Product Manual v5.x00

Once the transmitting module has sent all pending data or has

reached the TT limit, the transmission event ends. The

transmitting module will not transmit again for exactly RN delay

slots if the local (i.e. transmitting module’s) RN parameter is set

to a non-zero value. The receiving module(s) will not transmit

for a random number of delay slots between 0 and (RN-1) if the

local (i.e. receiving module’s) RN parameter is set to a non-zero

value. These delays are intended to lessen congestion following

long bursts of packets from a single transmitting module, during

which several receiving modules may have become ready to

transmit.

4.2.2.                          Repeater Mode

Characteristics:                Self-organizing - No route configuration is necessary

                                Self-healing / Fault-tolerant

                                Low power consumption and Minimized interference

                                Network throughput is determined by number of hops, not by number of

                                repeaters. Multiple repeaters within range of source node count as one hop.

                                Supports “transparent” multi-drop mode or addressed data filtering mode.

                                Duplicate RF packets are automatically filtered out.

                                All packets propagate to every node in the network (filtering rules apply).

                                Broadcast communications - each packet comes out every node exactly once.

                                Addressed communications - all radios see every packet. Only the module

                                with a matching address will forward it to the DO buffer (UART IN).

                                Data entering the network on any module is transmitted and forwarded

                                through every repeater module until it reaches the ends of the network.

                                Each repeater will repeat a packet only once.

Constraints:                    Requires that each module have a unique MY (Source Address) parameter.

                                System must introduce just one packet at a time to the network for

                                transmission (256 bytes max).

                                Each hop (H) decreases network throughput by a factor of 1/(H+1).

                                Additional repeaters add network redundancy without decreasing throughput.

Required Parameter Values (TX Module): MD = 3 or 4, MY = unique value (can be

accomplished by issuing the AM (Auto-set MY) and WR (Write) commands to all modules in the

network)

Related Commands: Networking (MD, DT, MY, AM), Serial Interfacing (RN, PK, RO, RB)

Recommended Use: Use in networks where intermediary nodes are needed to relay data to

modules that are beyond the transmission range of the base module.

Theory of Operation

OEMs and integrators can extend the effective range and reliability of a data radio system by

forwarding traffic through one or more repeaters.

Instead of using routing tables and path discovery to establish dynamic paths through a network,

the repeater system uses a sophisticated algorithm to propagate each RF packet through the

entire network.

The network supports RF packets up to 256 bytes. The repeater network can operate using

broadcast or addressed communications for multi-drop networks and works well in many systems

with no special configuration.

When in Repeater Mode, the network repeats each message among all available nodes exactly

one time. This mechanism eliminates the need for configuring specific routes. The network is self-

organizing and self-healing so that the system is able to receive transmissions in the event of a

module going down.

© 2014 Digi International Inc.                                                                               40
XStream™     OEM RF Module – Product Manual v5.x00

             Figure 4‐05.                   Sample Repeater Network Topology

             Repeater Network Configuration

             A network may consist of End Nodes (EN), End/Repeater Nodes (ERN) and a Base Node (BN).

             The base node initiates all communications.

             The repeater network can be configured to operate using Basic Broadcast or Basic Addressed

             communications. The addressing capabilities of the modules allow integrators to send a packet as

             a global packet (DT = 0xFFFF) and shift out of every radio in the network (Basic Broadcast).

             Alternatively, the packet can be sent with a specific DT (Destination Address) parameter so that it

             is only accepted by a specific remote node (Basic Addressed).

             Configuration Instruction (Basic Broadcast Communications)

                                 Assign each module a unique MY (source) address. (The AM (Auto-set MY) command will

                                 configure a unique source address that is based on module serial number.)

                                 Enable Basic Broadcast Communications (DT = 0xFFFF) or Addressed Broadcast Communications

                                 (ATDT specifies a specific destination)

                                 Configure PK, RO and RB to ensure that RF packet aligns with protocol packet. (ex. PK=0x100,

                                 RB=0x100, RO depends on baud rate).

                                 Configure one or more repeaters in the system (ATMD = 3).

                                 Configure remote nodes as destinations (MD = 4). This will ensure that the remote node waits for

                                 the repeater traffic to subside before it transmits a response.

             Assign each module a unique MY (source) address. (The AM (Auto-set MY) command will

             configure a unique source address that is based on module serial number.)

             Enable Basic Broadcast Communications (DT = 0xFFFF) or Addressed Broadcast Communications

             (ATDT specifies a specific destination)

             Configure PK, RO and RB to ensure that RF packet aligns with protocol packet. (ex. PK=0x100,

             RB=0x100, RO depends on baud rate).

             Configure one or more repeaters in the system (ATMD = 3).

             Configure remote nodes as destinations (MD = 4). This will ensure that the remote node waits for

             the repeater traffic to subside before it transmits a response.

             The configuration instructions above reflect configuration for a Basic Broadcast Repeater system.

             To configure a Basic Addressed Repeater system, use the DT (Destination Address) parameter to

             assign unique addresses to each module in the network.

             Algorithm details

                                 •  Packet ID (PID) is composed of transmitting module MY address and packet serial number.

                                 •  Incoming packets with a PID already found in the PID buffer will be ignored.

                                 •  Each module maintains a PID buffer 8 deep of previously received packets (managed as

                                    FIFO).

             Packets may be shifted out the serial port and/or repeated depending on the DT parameter

             contained in the RF packet.

© 2014 Digi  International Inc.                                                                                                41
XStream™     OEM  RF  Module – Product Manual v5.x00

                      Table 4‐02.    DT  (Destination Address) parameter     truth

                      table

                      Address Match                   Send out serial port?  Repeat?

                      Global                          Yes                    Yes

                      Local                           Yes                    No

                      None                            No                     Yes

                      Repeat delay based on RSSI

                      A transmitted packet may be received by more that one repeater at the same time. In order to

                      reduce the probability that the repeaters will transmit at the same instant, resulting in a collision

                      and possible data loss; an algorithm has been developed that will allow a variable back-off prior

                      to retransmission of the packet by a repeater. The algorithm allows radios that receive the packet

                      with a stronger RF signal (RSSI) to have the first opportunity to retransmit the packet.

                      The RN (Delay Slots) parameter is used to configure this delay. Set RN=0 (no delays) for small

                      networks with few repeaters or repeaters that are not within range of each other. Set RN=1 for

                      systems with 2 to 5 repeaters that may be within range of each other.

                      The actual length of the delay is computed by the formula:

                                 Delay (ms) = L * DS

                                 DS = (-41-RSSI)/10*RN)+RandomInt(0,RN)

                      Where L is the length of the transmitted packet in milliseconds, DS is the number of delay slots

                      to wait, RSSI is the received signal strength in dBm, RN is the value of the RN register and

                      RandomInt(A,B) is a function that returns a random integer from A to B-0

© 2014 Digi  International Inc.                                                                                              42
XStream™     OEM  RF  Module – Product Manual v5.x00

                      Response packet delay

                      As a packet propagates through the repeater network, if any node receives the data and

                      generates a quick response, the response needs to be delayed so as not to collide with

                      subsequent retransmissions of the original packet. To reduce collisions, both repeater and end

                      node radios in a repeater network will delay transmission of data shifted in the serial port to allow

                      any repeaters within range to complete their retransmissions.

                      The time for this delay is computed by the formula:

                                 Maximum Delay (ms) = L * DS

                                 DS = ((-41-(-100))/10)*RN)+RN+1

                      Where L is the length of the transmitted packet in milliseconds, DS is the number of delay slots

                      to wait, RSSI is the received signal strength in dBm, and RN is the value of the RN register.

                      Use Case - Broadcast Repeater Network

                      Consider modules R1 through R10 each communicating to a PLC using the ModBus protocol and

                      spaced evenly in a line. All ten nodes are configured as “destinations and repeaters” within the

                      scope of Basic Broadcast Communications (MD=3, AM, DT=0xFFFF, PK=0x100, RO=0x03,

                      RB=0x100, RN=1). The Base Host (BH) shifts payload that is destined for R10 to R1. R1

                      initializes RF communication and transmits payload to nodes R2 through R5 which are all within

                      range of R1. Modules R2 through R5 receive the RF packet and retransmit the packet

                      simultaneously. They also send the data out the serial ports, to the PLC's.

                      Table 4‐03.  Commands used to configure repeater functions

                      AT           Binary             AT Command Name             Range             # Bytes          Factory

                      Command      Command                                                          Returned         Default

                      AM           0x3A (58d)         Auto-set MY                 -                 -                -

                      DT           0x00 (0d)          Destination Address         0 – 0xFFFF        2                0

                      MD           0x3C (60d)         RF Mode                     3-4               1                0

                      MY           0x2A (42d)         Source Address              0 – 0xFFFF        2                0xFFFF

                      RN           0x19 (25d)         Delay Slots                 0 – 0xFF (slots)  1                0

                      WR           0x08 (8d)          Write                       -                 -                -

                      Bandwidth Considerations

                      Using broadcast repeaters in a network reduces the overall network data throughput as each

                      repeater must buffer an entire packet before retransmitting it. For example: if the destination is

                      within range of the transmitter and the packet is 32 bytes long, the transmission will take 72ms

                      on a 9600 baud XStream Module (much faster modules are available). If that same packet has to

                      propagate through two repeaters, it will take 72ms to arrive at the first repeater, another 72 ms

                      to get to the second and a final 72ms to get to the destination for a total of 216ms. Taking into

                      account UART transfer times (~1ms/byte at 9600 baud), a server to send a 32 byte query and

                      receive a 32 byte response is ~200ms, allowing for 5 polls per second. With the two repeaters in

                      the path, the same query/response sequence would take about 500ms for 2 polls per second.

                      To summarize, this system is sending and receiving 64 bytes 5 times per second for a throughput

                      of 320 bytes per second with no repeaters and 128 bytes per second with 2 repeaters. Generally,

                      the network throughput will decrease by a factor of 1/(R+1), with R representing the number of

                      repeaters between the source and destination.

                      Note that these numbers are absolutely worst case to illustrate how the system would perform in

                      a typical, low bandwidth system. As a counter example the 115kbps 9XTend radio can transfer

                      the same 32 byte packet in 12 ms for a round trip with UART transfer times of ~30ms or 33 polls

                      per second (1066 bytes per second) with no repeaters. With two repeaters the time would be

                      ~100ms round trip time for 10 polls per second or 320 bytes per second network throughput with

                      two repeaters.

© 2014 Digi  International Inc.                                                                                              43
XStream™ OEM RF Module – Product Manual v5.x00

4.3.  Acknowledged Communications

      4.3.1.                    Acknowledged Mode

      Characteristics:          Reliable delivery through positive acknowledgements for each packet

                                Throughput, latency and jitter vary depending on the quality of the

                                channel and the strength of the signal.

      Recommended Use: Acknowledge Mode configuration is appropriate when reliable

      delivery is required between modules. If messages are smaller than 256 bytes, use RB

      and RO commands to align RF packets with application packets.

      Required Parameter Values (TX Module): RR (Retries) >= 1

      Related Commands: Networking (DT, MK, RR), Serial Interfacing (PK, RN, TT, RO, RB)

      Table 4‐04.               Sample Network Profile

      Module                     Parameter Settings (assume default values for parameters not listed)

      All                        ATRR A         (set number of Retries to 0x0A)

                                 ATRN 5         (set number of Delay Slots to 5)

      Acknowledged Mode Connection Sequence

      Figure 4‐06.              Acknowledged Mode State Diagram

      After sending a packet

      while in Acknowledged

      Mode, the transmitting

      module listens for an ACK

      (acknowledgement). If it

      receives the ACK, it will

      either send a subsequent

      packet (if more transmit

      data is pending), or will

      wait for exactly RN

      random delay slots

      before allowing another

      transmission (if no more

      data is pending for

      transmission).

© 2014 Digi International Inc.                                                                         44
XStream™ OEM RF Module – Product Manual v5.x00

If the transmitting module does not receive the ACK within the allotted time, it will retransmit the

packet with a new RF initializer following the ACK slot. There is no delay between the first ACK slot

and the first retransmission. Subsequent retransmissions incur a delay of a random number of

delay slots, between 0 and RN. If RN is set to 0 on the transmitting module, there are never any

back-off delays between retransmissions. Note that during back-off delays, the transmitting module

will go into Idle Mode and may receive RF data. This can have the effect of increasing the

back-off delay, as the radio cannot return to RF transmit (or retransmit) mode as long as it is

receiving RF data.

After receiving and acknowledging a packet, the receiving module will move to the next frequency

and listen for either a retransmission or new data for a specific period of time. Even if the

transmitting module has indicated that it has no more pending transmit data, it may have not

received the previous ACK, and so it may retransmit the packet (potentially with no delay after

the ACK slot). In this case, the receiving module will always detect the immediate retransmission,

which will hold off the communications channel and thereby reduce collisions. Receiving modules

acknowledge each retransmission they receive, but they only pass the first copy of a packet they

receive out the UART.

RB and RO parameters are not applied to subsequent packets. This means that once transmission

has begun, it will continue uninterrupted until the DI buffer is empty or the streaming limit (TT)

has been reached. As with the first packet, the payload of each subsequent packet includes up to

the maximum packet size (PK parameter). The transmitting module checks for more pending

data near the end of each packet.

The streaming limit (TT parameter) specifies the maximum number of bytes that the transmitting

module will send in one transmission event, which may consist of many packets and retries. If

the TT parameter is reached, the transmitting module will force a random delay of 1 to RN delay

slots (exactly 1 delay slot if RN is zero). Each packet is counted only once toward TT, no matter

how many times the packet is retransmitted.

Subsequent packets in acknowledged mode are similar to those in streaming mode, with the

addition of an acknowledgement between each packet, and the possibility of retransmissions.

Subsequent packets are sent without an RF initializer, as the receiving modules are already

synchronized to the transmitting module from the preceding packet(s) and they remain

synchronized for the duration of the transmission event. Each retransmission of a packet includes

an RF initializer.

Once the transmitting module has sent all pending data or has reached the TT limit, the

acknowledged transmission event is completed. The transmitting module will not transmit again

for exactly RN delay slots, if the local RN parameter is set to a nonzero value. The receiving

module will not transmit for a random number of delay slots between 0 and (RN-1), if the local

RN parameter is set to a nonzero value. These delays are intended to lessen congestion following

long bursts of packets from a single transmitting module, during which several receiving modules

may have themselves become ready to transmit.

© 2014 Digi International Inc.                                                                        45
XStream™     OEM  RF Module – Product Manual v5.x00

                  4.3.2.         Multi-Streaming Mode

                  Characteristics:     Enables exclusive connections (refer to “Operation” section for

                                       definition) Supports the passing of large data streams (> 256 bytes)

                                       from multiple remote modules to a base module (If a complete data

                                       stream from a remote module is less than 256 bytes, data can be

                                       sent from several remotes to a base location without enabling this

                                       mode and latencies will be much less.)

                                       Transmissions never acknowledged (ACK) by receiving module(s)

                  Required Parameter Values (TX Module): MD = 1 (Base), MD = 2 (Remote), RN > 0, RR

                  > 0, MY ≠ 0xFFFF

                  Recommended Use: Use this mode in point-to-multipoint networks where remote

                  modules initiate communications and require exclusive (uninterrupted) connections to the

                  base module.

                  Table 4‐05.    Sample Network Profile

                  Module               Parameter Settings (assume default values for parameters not listed)

                  Base                 ATMD 1        (configure module as Multi-Stream Base) *

                  Remotes              ATMD 2        (configure module as Multi-Stream Remote) *

                  * When Multi‐Streaming is enabled, the following parameters are consequently modified (if they have

                  not already been modified from their default states): RR, RN, MY, CD, AT and BT. (refer to Table 4‐

                  06)

                  Theory of Operation

                  When in Multi-Streaming Mode, all remote modules can initiate communications with the

                  base module at the same time, but only one remote is granted an exclusive connection.

                  After an exclusive connection begins, data is transferred exclusively between two modules

                  without interruption from any other modules in the network.

                  An exclusive connection is a bi-directional connection that can only be established when in

                  Multi- Streaming Mode. An exclusive connection is immune to other remote modules

                  interrupting the connection and interleaving data (The interleaved data potentially renders

                  the base module unable to discern from which remote module the data was transmitted).

                  When an exclusive connection is granted to a single remote, the other remotes are notified

                  that the connection exists. The notification causes the remote modules to postpone

                  transmissions until the base module sends notification that the exclusive connection has

                  ended.

                  Figure 4‐07.   Sample Connection Sequence Diagram                               CRP = Connection Request Packet

                                                                                                  CGP = Connection Grant Packet

                                                                                                  DRP = Disconnect Request Packet (not

                                                                                                  shown in diagram – applicable when

                                                                                                  remote connection is disconnected using

                                                                                                  the pin sleep I/O line.

                                                                                                  DGP = Disconnect Grant Packet

                                                                                                  ACK = Acknowledgement of reception.

                                                                                                  Base module = The central

                                                                                                  transmitting/receiving module in a network

                                                                                                  of modules that maintains communications

                                                                                                  with remote modules.

                                                                                                  Remote module = A module in a network

                                                                                                  that sends data to and receives data from a

                                                                                                  base module.

                                                                                                  Payload = Data contained inside the RF

                                                                                                  Data of the RF Packet that originates from a

                                                                                                  host to be transmitted over‐the‐air.

© 2014 Digi  International Inc.                                                                                                         46
XStream™ OEM RF Module – Product Manual v5.x00

In the connection sequence above, an exclusive connection is first granted to “Remote m”.

The CGP (Connection Grant Packet) is broadcast to all remote modules in the network to

communicate the base in engaged in an exclusive connection. Upon receipt of the CGP

notification, remote modules will wait for a DGP (Disconnect Grant Packet) before

attempting again to send data to the base module.

Initiating a Connection

Connection Guidelines:

                                •  A remote module can only request a connection with the base module.

                                •  The base module may hold off or grant a connection request to another module.

                                •  A remote module will not try to establish a connection if one already exists.

                                •  A connection fails if no response is received after RR (Retries) CRP packets. After a failure,

                                   whatever condition was causing a connection to be established is cleared. If the condition

                                   was data to be sent, all data in the DI buffer will be flushed. If the condition was DI3

                                   transition, then no connection will be attempted until another correct DI3 transition.

                                •  A global connection cannot fail. (Definition is on next page.)

Once in Multi-Streaming Mode (MD > 0), several events can initiate an exclusive connection:

                                Remote module has payload to transmit. After a remote module receives data from its host,

                                the module will attempt to establish a connection with the base module. The connection is

                                defined by the remote’s DT (Destination Address) parameter. If another remote has a

                                connection with the base, no connection will be established until the connection runs its

                                course. Any remotes requesting a connection will then arbitrate for the next connection. RR

                                (Retries) and RN (Random back-off) parameters control this arbitration.

                                Base sets the DT (Destination Address) parameter. When the base module sets the DT

                                (Destination Address) parameter, an exclusive connection is immediately initiated with the

                                remote module that has a matching DT parameter. After the DT command is sent (If

                                ATCM=1), the base module indicates a successful connection with a “CONNECT XXXX” string

                                where "XXXX" is the remote's address. An unsuccessful connection is indicated with an

                                “ERROR” string. If the connection is successful, the module immediately exits AT Command

                                Mode and data can be sent to and received from the connected remote module. If an error is

                                returned, the module stays in AT Command Mode. If a base is connected to a remote when

                                the DT command is executed, the current connection is disconnected before a new connection

                                is created.

                                DI3 pin (pin 2, SLEEP) is asserted (set low). Both base and remote modules can create a

                                connection (defined by the current DT (Destination Address) parameter) when the DI3 pin is

                                asserted (driven high). DR (DI3 Configuration) Command is used to establish this mode. If a

                                remote asserts DI3, a connection request will be sent when no connection is active. If the

                                base asserts DI3, a connection will immediately be established with the remote after any

                                connection.

© 2014 Digi International Inc.                                                                                                     47
XStream™ OEM RF Module – Product Manual v5.x00

Initiating a Disconnection

To disconnect, the base module sends a DGP (disconnect grant packet). A remote module can

only request a disconnect. The following conditions cause a disconnect:

                                No over-the-air data sent or received for CE (Connection Inactivity Timeout) time. If no over-

                                the-air data is successfully sent (no acknowledgement received) or received (any good

                                packet) for CE time, the connection will be dropped. Only a base module can detect this

                                condition. Refer to CE Command.

                                Absolute CB (Connection Duration Timeout). The CB parameter defines an absolute timeout.

                                A timer is started on the remote units when a connection is established. When the

                                connection has been active for CB time, the base will close the connection. A remote that

                                detects this condition will automatically disconnect (it will not send a DRP (disconnect request

                                packet)). Remotes that monitor a connection between the base and another remote

                                will disregard any connection after the CB time. Refer to CB Command.

                                DI3 pin (pin 2, SLEEP) is de-asserted (set high). A base or remote module can cause a

                                disconnect by setting the DI3 line high. If no connection is active, the de-assertion is

                                ignored. A remote will request a disconnect if DI3 is de-asserted and the remote is currently

                                connected the base. Refer to DR (DI3 Configuration) Command.

                                A remote or a base module receives the ATDC (Disconnect) Command.

Configuration

AT Command Mode

AT command mode is used for all commands on base and remote modules. Binary

command mode is not available when MD = 1 or 2.

The base is in AT command mode when not engaged in an exclusive connection with a remote.

No AT Command Mode sequence is needed. When a base module is connected to a remote

module, the AT Command Mode sequence is used to enter AT command mode. The connection

with the remote is maintained. Care should be taken that the CE (Connection Inactivity)

timeout does not occur while in AT Command Mode.

The remote must use the AT command sequence to enter AT Command Mode. When a

connection exists with a base module, the connection is maintained. Care must be taken that the

CB (Connection Duration) timeout does not occur while in AT Command Mode.

As of firmware version, 4.30, a faster method is available for entering AT Command Mode. If the

BT and AT parameters are set to 0, BT (Guard Time Before) and AT (Guard Time After) times are

set to 6 milliseconds.

Beware that this will also mean that AT Command Mode cannot be entered by manually

typing the AT command sequence (usually “+++”), because the AT time will occur faster than

the characters can be typed.

Auto Configuration

When enabling Multi-Streaming Modes (by setting the MD (RF Mode) parameter to 1 or 2), other

parameter values are automatically modified to support the mode. For example, when the MD

parameter is changed to 1 or 2, the RR parameter is changed to 0x0A (hex). The modification

only occurs if the RR parameter is 0 (its default) before the MD command was executed. If any

other value is found for the RR parameter, the RR parameter will not be changed. Auto

configuration occurs every time the module is powered-up.

© 2014 Digi International Inc.                                                                                                    48
XStream™     OEM  RF  Module – Product Manual v5.x00

                      Table 4‐06.       Auto Configurations

                      Parameter changed               Condition for modification        Resulting Parameter Value

                      when MD = 1 or 2                to take place (default values)

                      RR (Retries)                    If RR = 0                         RR = 0x0A (10 decimal)

                      RN (Delay Slots)                If RN = 0                         RN = 5

                      MY (Source Address)             If MY = 0xFFFF (and MD = 2)       Unique value based on serial number *

                      CD (DO3 Configuration)          If CD = 0                         CD = 3

                      BT (Guard Time Before)          If BT = 0x0A                      BT = 0

                      AT (Guard Time After)           If AT = 0x0A                      AT = 0

                      * The system requires that each remote have a unique address. The automatic address is based on the serial

                      number and is not guaranteed unique, although the chances for a duplicate address are 1 in 16,000. No

                      method currently exists for detecting and reassigning duplicate remote addresses.

                      Global Connection

                      The base module can connect to all remote modules (to send a broadcast message) by

                      connecting with a DT address of 0xFFFF (hex). There will be no acknowledgements from the

                      remote radios and each packet from the base will be sent RR times. A remote cannot send

                      messages to a base during a global connect.

                      The CGP and DGP packets will be sent RR times to begin and end the global connection

                      respectively. The connection can be terminated by CE, CB timers, DI3 or ATDC Command as any

                      other connections.

                      Sleep Modes and Connections

                      Cyclic sleep can be used with the remote modules to conserve power. ST “Time before Sleep”

                      Parameter defines how long after a disconnect a remote will stay awake. A module is not allowed

                      to enter sleep mode when it is engaged in a connection. A module will wake as defined by SM

                      parameter and check for an RF message. If a message is detected, the module will stay awake

                      only if the message is a connect message from the base for this module. DI3 (pin 2) wake-up can

                      be used to wake a remote module. Usually the connection on DI3 should also be enabled so that

                      a connection is established on wake-up.

                      Note: The ST (Time Before Sleep) time must be set long enough to account for the time it could take

                      to make a connection if several remote modules get a connection before a remote’s ST times out.

                      Pin sleep can also be used with a remote module. A module will not be allowed into pin sleep

                      while a connection is active. Usually the connection on DI3 (DR = 4) should also be enabled so

                      that a connection is established on wakeup. Pin wake-up could also be used to scan for a

                      connection at an interval not defined by the cyclic sleep modes.

                      I/O Passing and Connections

                      I/O lines can be passed between a remote and base module by enabling I/O line passing (see the

                      RT, DR, CD, CO, CS, BK, BO commands). When a connection is not active, the output lines on the

                      base and remote modules will be in their default state. When a connection is established, the

                      base and remote output line will be set to reflect the corresponding input lines.

                      Monitoring Connections

                      The DO3 pin (RX LED) can be used to show when a connection is active on both remote and base

                      modules. This is the default condition. This line will be asserted (high) during a connection and

                      de-asserted (low) when there is no connection.

                      A base module can also be set to send the “CONNECT XXXX” string (where “XXXX” is the

                      connecting module’s MY (Source Address) parameter) anytime a connection is established. Refer

                      to CM (Connection Message) Command.

© 2014 Digi  International Inc.                                                                                                   49
XStream™ OEM RF Module – Product Manual v5.x00

   Appendix A: Agency Certifications

         FCC  Certification

              The XStream OEM RF Module complies with Part 15 of the FCC rules and regulations. Compliance

              with the labeling requirements, FCC notices and antenna usage guidelines is required.

              To fulfill the FCC Certification requirements, the OEM must comply with the following FCC

              regulations:

                                  The system integrator must ensure that the text on the external label provided with this

                                  device is placed on the outside of the final product (Figure A.1 for 900 MHz operations or

                                  Figure A.2 for 2.4 GHz operations).

                                  The XStream OEM RF Module may be used only with Approved Antennas that have been

                                  tested with this module. (Table A-01 or Table A-02)

              FCC Notices:

              IMPORTANT:             The 9XStream (900 MHz) and 24XStream (2.4 GHz) OEM Modules have been certified by

              the FCC for use with other products without any further certification (as per FCC section 2.1091).

              Changes or modifications not expressly approved by Digi could void the user’s authority to operate

              the equipment.

              IMPORTANT:             OEMs must test their final product to comply with unintentional radiators (FCC section
              15.107 and 15.109) before declaring compliance of their final product to Part 15 of the FCC Rules.

              IMPORTANT:             The XStream OEM RF Modules have been certified for remote and base radio

              applications. If the XStream will be used for portable applications, the device must undergo SAR

              testing.

              This equipment has been tested and found to comply with the limits for a Class B digital device,

              pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection

              against harmful interference in a residential installation. This equipment generates, uses and can

              radiate radio frequency energy and, if not installed and used in accordance with the instructions,

              may cause harmful interference to radio communications. However, there is no guarantee that

              interference will not occur in a particular installation. If this equipment does cause harmful

              interference to radio or television reception, which can be determined by turning the equipment

              off and on, the user is encouraged to try to correct the interference by one or more of the

              following measures:

                                  •  Re-orient or relocate the receiving antenna.

                                  •  Increase the separation between the equipment and receiver.

                                  •  Connect the equipment into an outlet on a circuit different from that to which the receiver is

                                     connected.

                                  •  Consult the dealer or an experienced radio/TV technician for help.

©  2014  Digi International Inc.                                                                                              50
XStream™     OEM  RF Module – Product Manual v5.x00

                  OEM Labeling Requirements

                  Label Warning

                                 WARNING: The Original Equipment Manufacturer (OEM) must ensure that FCC labeling

                                 requirements are met. This includes a clearly visible label on the outside of the final
                                 product enclosure that displays the contents shown in the figure below.

                  Figure A‐01. Required FCC Label for OEM products containing 9XStream (900 MHz) OEM RF Module

                  Contains FCC ID: OUR9XSTREAM

                  The enclosed device complies with Part 15 of the FCC Rules. Operation is subject to the following two

                  conditions: (1) this device may not cause harmful interference and (2) this device must accept any

                  interference received, including interference that may cause undesired operation.

                  Figure A‐02. Required FCC Label for OEM products containing 24XStream (2.4 GHz) OEM RF Module

                  Contains FCC ID: OUR-24XSTREAM

                  The enclosed device complies with Part 15 of the FCC Rules. Operation is subject to the following two

                  conditions: (1) this device may not cause harmful interference and (2) this device must accept any

                  interference received, including interference that may cause undesired operation.

                  Antenna Usage

                  Antenna Warning

                                 WARNING: This device has been tested with Reverse Polarity SMA connectors with the antennas

                                 listed in Tables A.1 and A.2 of Appendix A. When integrated in OEM products, fixed

                                 antennas require installation preventing end-users from replacing them with non-

                                 approved antennas. Antennas not listed in the tables must be tested to comply with
                                 FCC Section 15.203 (unique antenna connectors) and Section 15.247 (emissions).

                  RF Exposure

                                 WARNING: This equipment is approved only for mobile and base station transmitting devices,

                                 separation distances of (i) 20 centimeters or more for antennas with gains < 6 dBi or

                                 (ii) 2 meters or more for antennas with gains ≥ 6 dBi should be maintained between

                                 the antenna of this device and nearby persons during operation.     To ensure
                                 compliance, operation at distances closer than this is not recommended.

                  The preceding statement must be included as a CAUTION statement in manuals for OEM products

                  to alert users on FCC RF Exposure compliance.

                  Digi Modules are pre-FCC approved for use in fixed base station and mobile applications. As long

                  as the antenna is mounted at least 20 cm (8 in) from nearby persons, the application is

                  considered a mobile application. If the antenna will be mounted closer than 20 cm to nearby

                  persons, then the application is considered “portable” and requires an additional test performed

                  on the final product. This test is called the Specific Absorption Rate (SAR) testing and measures

                  the emissions from the module and how they affect the person.

                  Over 100 additional antennas have been tested and are approved for use with Digi 900

                  MHz Modules (including “Mag Mount”, “Dome”, “Multi-path” and “Panel” antennas). Because of

                  the large number of approved antennas, Digi requests that you send specific information about

                  an antenna you would like to use with the module and Digi will evaluate whether the antenna is

                  covered under the FCC certification.

© 2014 Digi  International Inc.                                                                                               51
XStream™ OEM RF Module – Product Manual v5.x00

              FCC-Approved Antennas

Table A‐01.  Antennas approved for use   with 9XStream (900         MHz) OEM RF   Modules.

Manufacturer  Part Number                      Type                 Gain                        Application      Min.  Separation  Distance

      *                         *              Yagi                 6.2 dBi                     Fixed/Mobile **        20 cm

      *                         *              Yagi                 7.2 dBi                     Fixed/Mobile **        20 cm

Digi          A09-Y8                           Yagi                 8.2 dBi                     Fixed/Mobile **        20 cm

      *                         *              Yagi                 9.2 dBi                     Fixed/Mobile **        20 cm

      *                         *              Yagi                 10.2 dBi                    Fixed/Mobile **        20 cm

Digi          A09-Y11 (FCC pending)            Yagi                 11.2 dBi                    Fixed/Mobile **        20 cm

Digi          A09-F2                           Omni Direct.         2.2 dBi                     Fixed **               20 cm

Digi          A09-F5                           Omni Direct.         5.2 dBi                     Fixed **               20 cm

Digi          A09-F8                           Omni Direct.         8.2 dBi                     Fixed **               20 cm

      *                         *              Omni Direct.         9.2 dBi                     Fixed **               20 cm

      *                         *              Omni Direct.         7.2 dBi                     Fixed **               20 cm

Digi          A09-M7                           Omni Direct.         7.2 dBi                     Fixed **               20 cm

Digi          A09-H                      1/2 wave antenna           2.1 dBi                     Fixed/Mobile **        20 cm

Digi          A09-HBMM-P5I               1/2 wave antenna           2.1 dBi                     Fixed/Mobile **        1 cm

Digi          A09-QBMM-P5I               1/4 wave antenna           1.9 dBi                     Fixed/Mobile **        1 cm

      *                         *        1/4 wave integrated        1.9 dBi                     Fixed/Mobile **        1 cm

                                               wire antenna

Table A‐02.  Antennas approved for  use  with  24XStream      (2.4  GHz) OEM  RF  Modules.

Manufacturer  Part Number                      Type                 Gain                       Application       Min.  Separation  Distance

      *       *                                Yagi                 6 dBi                       Fixed **               2m

      *       *                                Yagi                 8.8 dBi                     Fixed **               2m

      *       *                                Yagi                 9 dBi                       Fixed **               2m

      *       *                                Yagi                 10 dBi                      Fixed **               2m

      *       *                                Yagi                 11 dBi                      Fixed **               2m

      *       *                                Yagi                 12 dBi                      Fixed **               2m

      *       *                                Yagi                 12.5 dBi                    Fixed **               2m

      *       *                                Yagi                 13.5 dBi                    Fixed **               2m

      *       *                                Yagi                 15 dBi                      Fixed **               2m

      *       *                                Omni Direct          2.1 dBi                    Fixed/Mobile **         20 cm

      *       *                                Omni Direct          3 dBi                      Fixed/Mobile **         20 cm

      *       *                                Omni Direct          5 dBi                      Fixed/Mobile **         20 cm

      *       *                                Omni Direct          7.2 dBi                     Fixed **               2m

      *       *                                Omni Direct          8 dBi                       Fixed **               2m

      *       *                                Omni Direct          9.5 dBi                     Fixed **               2m

      *       *                                Omni Direct          10 dBi                      Fixed **               2m

      *       *                                Omni Direct          12 dBi                      Fixed **               2m

      *       *                                Omni Direct          15 dBi                      Fixed **               2m

Digi          A24-P8                           Panel                8.5 dBi                     Fixed **               2m

Digi          A24-P13                          Panel                13 dBi                      Fixed **               2m

      *       *                                Panel                14 dBi                      Fixed **               2m

      *       *                                Panel                15 dBi                      Fixed **               2m

      *       *                                Panel                16 dBi                      Fixed **               2m

Digi          A24-P19                          Panel                19 dBi                      Fixed **               2m

Digi          A24-HABMM-P6I                    Dipole               2.1 dBi                    Fixed/Mobile **         20 cm

Digi          A24-HBMM-P6I                     Dipole               2.1 dBi                    Fixed/Mobile **         20 cm

Digi          A24-HABSM                        Dipole               2.1 dBi                    Fixed/Mobile **         20 cm

Digi          A24-QABMM-P6I                    Monopole             1.9 dBi                    Fixed/Mobile **         20 cm

      *       A24-Q1                           Monopole             1.9 dBi                    Fixed/Mobile **         20 cm

      *       *                                Monopole             1.9 dBi                    Fixed/Mobile **         20cm

* FCC‐approved antennas not inventoried by Digi – Contact Digi (866) 765‐9885 for information.

** Can be approved for portable applications if integrator gains approval through SAR testing

© 2014 Digi International Inc.                                                                                                     52
XStream™ OEM RF Module – Product Manual v5.x00

IC  (Industry Canada) Certification

    Labeling requirements for Industry Canada are similar to those of the FCC. A clearly visible label

    on the outside of the final product enclosure must display the following text:

                                Contains Model 9XStream Radio (900 MHz), IC: 4214A-9XSTREAM

                                Contains Model 24XStream Radio (2.4 GHz), IC: 4214A 12008

    Integrator is responsible for its product to comply with IC ICES-003 and FCC Part 15, SuB-0 B

    - Unintentional Radiators. ICES-003 is the same as FCC Part 15 SuB-0 B and Industry Canada

    accepts FCC test report or CISPR 22 test report for compliance with ICES-003.

© 2014 Digi International Inc.                                                                          53
XStream™ OEM RF Module – Product Manual v5.x00

Appendix          B: Development Guide

         XStream  OEM Development Kit Contents

                  The Development Kit includes all the hardware and software needed for a robust                         wireless link:

                  Table B‐01.         XStream Development Kit Contents

                  Item                     Qty.  Description                                                             Part Number

                  Quick Start Guide        1     Familiarizes users with some of the module’s most important functions.  MD0016

                  CD                       1     Contains documentation, software and tools needed for RF operation.     MD0030

                  XStream OEM RF Module    1     Long Range OEM RF Module w/ RPSMA Connector                             varies

                  XStream OEM RF Module    1     Long Range OEM RF Module w/ attached wire antenna                       varies

                  Digi Interface Board     2     Enables communication to RS-232/485/422 devices                         XIB-R

                  Antenna                  1     900 MHz RPSMA, 6" Half-Wave, dipole, articulating                       A09-HASM-675

                                                 Connects to the female RS-232 (DB-9) serial connector of the Digi

                  Serial Loopback Adapter  1     Interface Board and can be used to configure the module to function as  JD2D3-CDL-A

                                                 a repeater (for range testing)

                  NULL Modem Adapter             Connects to the female RS-232 (DB-9) serial connector of the Digi

                  (male-to-male)           1     Interface Board and can be used to connect the module to another        JD2D2-CDN-A

                                                 DCE (female DB9) device

                  NULL Modem Adapter       1     Used to bypass radios to verify serial cabling is functioning properly  JD3D3-CDN-A

                  (female-to-female)

                  Male DB-9 to             1     Facilitates adapting the DB-9 Connector of the Digi Interface           JE1D2-CDA-A

                  RJ-45 Adapter                  Board to a CAT5 cable (male DB9 to female RJ45)

                  Female DB-9 to           1     Facilitates adapting the DB-9 Connector of the Digi Interface           JE1D3-CDA-A

                  RJ-45 Adapter                  Board to a CAT5 cable (female DB9 to female RJ45)

                  Power Adapter            2     Allows Interface Board to be powered by a 110 Volt AC power supply      JP4P2-9V10-6F

                  RS-232 Cable (6’)        2     Connects interface board to devices having an RS-232 serial port        JD2D3-CDS-6F

         Interfacing Hardware

                  Digi developed proprietary interface boards to facilitate      the connection between XStream

                  OEM RF Modules and serial devices. Digi has developed          an interface board that supports the                 RS-

                  232/485/422 protocols (Digi part number: XIB-R).

©  2014  Digi International Inc.                                                                                                       54
XStream™ OEM RF Module – Product Manual v5.x00

The following section illustrates properties of the Digi XIB-R Interface Board. The Digi Interface

board provides means for connecting the XStream Module to any node that has an available RS-

232 or RS-485/422 connection. Since the module requires signals to enter at CMOS voltages, one

of the main functions of the interface board is to convert signals between CMOS and RS-232

levels.

© 2014 Digi International Inc.                                                                      55
XStream™ OEM RF Module – Product Manual            v5.x00

                       Digi RS-232/485             Interface Board

                                                           B-01a. Power Switch

Figure B‐01.    Front                                      Move the Power Switch to the on (up) position to power the

View                                                       Interface Board. DIP Switch (B.2a) settings are only read

                                                           during a power-up sequence.

                                                           B-01b. LEDs

                                                           The LED indicators visualize diagnostic status information. The

B‐01a.                                                     module’s status is represented as follows:

Power                  B‐01c.                              Yellow (top LED) = Serial Data Out (to host)

Switch                 Serial Port                         Green (middle) = Serial Data In (from host)

                                        B‐0d.

        B‐01b.                          Power              Red (bottom) =       Power/TX Indicator (Red light is on when

        LEDs                            Connector          powered, off briefly during RF transmission)

                                                           B-01c. Serial Port

                                                           Standard female DB-9 (RS-232) DCE connector – This connector

                                                           can be also used for RS-485 and RS-422 connections.

                                                           B-01d. Power Connector

                                                           7-18 VDC Power Connector (Center positive, 5.5/2.1mm) – Power

                                                           can also be supplied through Pin 9 of the DB-9 Serial Port.

                                                           B-02a. DIP Switch

Figure  B‐02.   Back   View                                The DIP Switch automatically configures the XStream OEM RF

                                                           Module to operate in different modes. Each time the module

                                                           assembly (interface board + the RF Module) is powered-on,

                                                           intelligence on the XIB-R interface board programs the module

                                                           according to the positions of the DIP Switch. (See figure below

                                                           for DIP Switch settings)

                       B‐02b.                              Note: In cases where AT Commands should not be sent each time

        B‐02a.         Config   Switch                     the module assembly is powered-on, the processor must be

        DIP Switch                                         disabled by populating J7 on the interface board.

                                                           B-02b. Config (Configuration) Switch

                                                           The Configuration Switch provides an alternate way to enter “AT

                                                           Command Mode”. To enter “AT Command Mode” at the module’s

                                                           default baud rate, hold the Configuration Switch down while

                                                           powering on the module using the Power Switch (B-01a).

Figure  B‐03.   Digi XIB‐R (RS‐232/485)  Interface  Board  DIP Switch Settings

                                                                                                 Refer to table in the

                                                                                                 Automatic DIP Switch

                                                                                                 Configurations section (next

                                                                                                 page) for more information

                                                                                                 regarding configurations

                                                                                                 triggered by the DIP Switch.

© 2014 Digi International Inc.                                                                                               56
XStream™  OEM  RF  Module – Product Manual v5.x00

                   Automatic DIP Switch Configurations

                   Each time the module assembly (XStream Module mounted to an XIB-R Interface Board) is

                   powered on, intelligence on the Digi Interface Board sends AT Commands that program the

                   module based on positions of the DIP Switch. Automatic configurations that take place during

                   the power-on sequence affect module parameter values as shown below.

                   To avoid overwriting previously stored custom configurations (due to the automatic configurations

                   that take place each time the module assembly is powered on), it is necessary to disable a

                   processor located on the XIB-R interface board. To disable the processor, populate J7 of

                   the XIB-R Interface Board. By default, J7 jumper is not populated.

                   Table B‐02.         Module Power‐up Options (J7 jumper and Config Switch)

                   Condition                                  Behavior

                   If J7 is populated                         Processor is disabled and AT Commands are not sent to the Module.

                   If Config Switch is pressed                Processor is disabled and Module enters into AT Command Mode.

                   If J7 is NOT populated and Config Switch   Execute logic as shown in table below.

                   is NOT pressed

                   Table B‐03.         AT Commands Sent as result of DIP Switch Settings (SW = DIP Switch)

                   Condition                                  Behavior

                   Restore Default Parameter Values  of  the  Module

                   If SW1 and SW2 are ON (up)                 AT      Commands  sent:  ATRE (Restore Defaults) Command

                                                                                       ATWR (Write) Command

                   Serial Interfacing Options

                                                              AT      Commands  sent:  ATCS 0 (RS-232 Operation: CTS function for CTS line,

                   If SW1 is ON (up)                                                   DB-9 pin 8)

                                                                                       ATCD 2 (DO3 - RX LED = low)

                   If SW1 is OFF (down)                       AT      Commands  sent:  ATCS 3 (RS-485 or RS-422 Operation)

                                                                                       ATCD 2 (DO3 - RX LED = low)

                   Parity Options

                   If SW5 and SW6 are OFF (down)              AT      Commands  sent:  ATNB 0 (parity = none)

                   If SW5 is OFF (down) and SW6 is ON (up)    AT Commands sent:        ATNB 1 (parity = even)

                   If SW5 is ON (up) and SW6 is OFF (down)    AT Commands sent:        ATNB 2 (parity = odd)

                   If SW5 is ON (up) and SW6 is ON (up)       AT Commands sent:        ATNB 5 (parity = 9th bit data over-the-air)

                   Exit AT Command Mode

                   Always                                     AT Commands sent:        ATCN (Exit AT Command Mode)

© 2014 Digi International Inc.                                                                                                               57
XStream™  OEM  RF Module – Product Manual v5.x00

                        Adapters

                            The XStream Development Kit comes with several adapters that support the following functions:

                                •  Performing Range Tests

                                •  Testing Cables

                                •  Connecting to other RS-232 DCE and DTE devices

                                •  Connecting to terminal blocks or RJ-45 (for RS-485/422 devices)

                        NULL Modem Adapter (male-to-male)

                            Part Number: JD2D2-CDN-A (Black, DB-9 M-M) The male-to-male NULL modem adapter is used

                            to connect two DCE devices. A DCE device connects with a straight-through cable to the male

                            serial port of a computer (DTE).

                            Figure B‐04.  Male NULL modem adapter and pinouts

                            Figure B‐05.  Example of a module assembly (DCE Device) connecting to another DCE device)

                        NULL Modem Adapter (female-to-female)

                            Part Number: JD3D3-CDN-A (Gray, DB-9 F-F) The female-to-female NULL modem adapter is

                            used to verify serial cabling is functioning properly. To test cables, insert the female-to-female

                            NULL modem adapter in place of a pair of module assemblies (XIB-R-R interface board +

                            XStream Module) and test the connection without radio modules in the connection.

                            Figure B‐06.  Female NULL modem adapter and pinouts

                        Serial Loopback Adapter

                            Part Number: JD2D3-CDL-A (Red, DB-9 M-F) The serial loopback adapter is used for range

                            testing. During a range test, the serial loopback adapter configures the module assembly to

                            function as a repeater by looping serial data back into the radio for retransmission.

                            Figure B‐07.  Serial loopback adapter and pinouts

For use in RS‐485/422

systems: DB‐9 to RJ‐45

adapters are documented on

p45.

© 2014 Digi International Inc.                                                                                                  58
XStream™  OEM  RF Module – Product Manual v5.x00

               Antennas

               (Refer to Appendix A for a list of FCC-Approved Antennas)

               Factors that determine wireless link range:

                                •  Ambient RF noise (interference)

                                •  Line-of-sight obstructions

                                •  Transmit power

                                •  Receive sensitivity

                                •  Antenna configuration

               XStream Antenna Connector Options

               To comply with the FCC rules and obtain a “modular” certification, it is required that XStream

               Modules utilize a “non standard” connector. This is to ensure the modules are used only with

               approved antennas. The XStream Modules have two connector options:

                                •  RPSMA

                                •  MMCX

               Alternatively, the XStream Module can be order with an attached wire antenna.

               RPSMA

               The Reverse Polarity SMA (RPSMA) connector uses the same body as a

               regular SMA connector. In order to be a “non standard” connector, the

               gender of the center conductor is changed. The female RPSMA actually

               has a male center conductor.

               MMCX

               The Micro-Miniature Connector (MMCX) is a good solution for

               high volume, price-sensitive applications. The small size and

               snap on connection make it suitable for attaching an external

               mounted antenna to a module inside an enclosure.

               Antenna Cables

               RF cables are typically used to connect a radio installed in a cabinet to an antenna mounted

               externally. As a general rule, it is best to keep the RF cable as short as possible. All cables

               promote signal loss which is usually measured in dB loss per 100 ft. Digi provides LMR-

               195 rated cables. Common cables and dB losses are included in this table:

               Table B‐04.                Potential Signal Strength Loss due to Antenna Cable Length

                                Cable     Loss at 900 MHz per 100’    Loss at 2.4 GHz per 100’        Diameter

                                Type               (loss per 100m)    (loss per 100m)

                                RG-58              14.5 dB (47.4 dB)  25.3 dB (83.2 dB)               0.20” (4.95 mm)

                                RG-174             25.9 dB (85.0 dB)  44.4 dB (145.8 dB)              0.10” (2.54 mm)

                                RG-316             24.7 dB (81.0 dB)  42.4 dB (139.0 dB)              0.10” (2.59 mm)

                                LMR-195            11.1 dB (36.5 dB)  19.0 dB (62.4 dB)               0.20” (4.95 mm)

                                LMR-240            7.6 dB (24.8 dB)   12.9 dB (42.4 dB)               0.24“ (6.10 mm)

                                LMR-600            2.5 dB (8.2 dB)    4.4 dB (14.5 dB)                0.59” (15.0 mm)

© 2014 Digi International Inc.                                                                                         59
XStream™ OEM RF Module – Product Manual v5.x00

         Interfacing Protocols

                  The Module Assembly supports the following interfacing        protocols:

                                   •  RS-232

                                   •  RS-485 (2-wire) Half-Duplex

                                   •  RS-485 (4-wire) and RS-422

               RS-232 Operation

               DIP Switch Settings and Serial Port Connections

                  Figure B‐08.                                                               Figure B‐09

                  RS‐232 DIP Switch Settings                                    Pins used on the                  female  RS‐232     (DB‐9)

                                                                                Serial Connector

                  DIP Switch settings are read and applied

                  only while powering‐on.

                  Table B‐05.         RS‐232 Signals and their implementations on the XStream Module Assembly

                                      (Low‐asserted signals are distinguished by horizontal line over pin name.)

               DB-9 Pin               RS-232 Name  AT  Command Reference*       Description                       Implementation

               1                      DCD                          DO3          Data-Carrier-Detect               Connected to DSR (pin6)

               2                      RXD                          DO           Received Data                     Serial data exiting the Module Assembly

                                                                                                                          (to host)

               3                              TXD                  DI           Transmitted Data                  Serial data entering into the Module

                                                                                                                  Assembly (from host)

               4                              DTR                  DI3     Data-Terminal-Ready                    Can enable POWER-DOWN on the

                                                                                                                  Module Assembly

               5                      GND                          -            Ground Signal                             Ground

               6                      DSR                          DO3          Data-Set-Ready                    Connected to DCD (pin1)

               7                      RTS/CMD                      DI2          Request-to-Send                   Provides RTS flow control or enables

                                                                                                                  “Command Mode” on the Module

               8                              CTS                  DO2          Clear-to-Send                     Provides CTS flow control

                                                                                                                  Optional power input that is connected

               9                              DI                   -            Ring Indicator                    internally to the positive lead of the front

                                                                                                                  power connector

               * The AT Command Reference provides as associative tag when using the AT commands to program the

                  Module. “DI” stands for Data Input and “DO” for Data Output.

©  2014  Digi  International Inc.                                                                                                    60
XStream™     OEM  RF  Module – Product Manual v5.x00

                      Wiring Diagram: RS-232 DTE Device to a DCE Module Assembly

                      Figure B‐10.  RS‐232 DTE (male connector) device wired to an XStream Module Assembly (female

                      connector)

                      Wiring Diagram: DCE Module Assembly to an RS-232 DCE Device

                      Figure B‐11.  XStream Module Assembly (female connector) wired to an RS‐232 DTE (male connector)

                      device

                      Sample Wireless Connection: DTE  DCE -------- DCE  DCE

                      Figure B‐12   Typical wireless connection used for serial communications  between  DTE  and  DCE devices

© 2014 Digi  International Inc.                                                                                     61
XStream™  OEM  RF Module – Product Manual v5.x00

               RS-485 (2-wire) Operation

               DIP Switch Settings and Serial Port Connections

               Figure B‐13.                                                             Figure B‐14.

               RS‐485 (2‐wire) Half‐Duplex                                              Pins used on the female RS‐232 (DB‐9)

               DIP Switch Settings                                                      Serial Connector

               Figure B‐15

               RS‐485 (2‐wire) with Termination (optional)

               Termination is the 120 Ω resistor between T+ and T-.

               DIP Switch settings are read and applied only while powering-on.

               Note: Refer to Figure B-022 and Figure B-023 (p45) for RJ-45 connector pin designations used in

               RS-485/422 environments.

               Table B‐06.         RS‐485 (2‐wire  half‐duplex) Signals  and  their implementations on the XStream Module

                                   Assembly

               DB-9 Pin            RS-485 Name     Description                          Implementation

                                2  T/R- (TRA)      Negative Data Line                   Transmit serial data to and from the

                                                                                        XStream Module Assembly

                                5  GND             Ground Signal                        Ground

                                8  T/R+ (TRB)      Positive Data Line                   Transmit serial data to and from the

                                                                                        XStream Module Assembly

                                9  PWR             Power                      Optional power input that is connected internally

                                                                                        to the front power connector

               1, 3, 4, 6, 7                                                  not used

               Wiring Diagram: RS-485 (2-wire) Half-Duplex

               Figure B‐16.        XStream Module Assembly in an RS‐485 (2‐wire) half‐duplex environment

© 2014 Digi International Inc.                                                                                                   62
XStream™  OEM  RF Module – Product Manual v5.x00

               RS-485 (4-wire) and RS-422 Operation

               DIP Switch Settings and Serial Port Connections

               Figure B‐17                                                                  Figure B‐18

               RS‐485 (4‐wire) and RS‐422                                                   Pins used on the female RS‐232 (DB‐9)

               DIP Switch Settings                                                          Serial Connector

               Figure B‐19

               RS‐485 (4‐wire) and RS‐422 with Termination (optional)

               Termination is the 120 Ω resistor between T+ and T-.

               DIP Switch settings are read and applied only while powering-on.

               Table B‐07.               RS‐485/422  (4‐wire) Signals and  their  implementations with the Module Assembly

               DB-9 Pin                  RS-485/422  Description                            Implementation

                                         Name

                                2        T- (TA)     Transmit Negative            Serial data sent from the XStream Module Assembly

                                                     Data Line

                                3        R- (RA)     Receive Negative             Serial data received by the XStream Module Assembly

                                                     Data Line

                                5        GND         Signal Ground                          Ground

                                7        R+ (RB)     Receive Positive             Serial data received by the XStream Module Assembly

                                                     Data Line

                                8        T+ (TB)     Transmit Positive            Serial data sent from the XStream Module Assembly

                                                     Data Line

                                9        PWR         Power                        Optional power input that is connected internally

                                                                                            to the front power connector

                                1, 4, 6                                           not used

               Wiring Diagram: RS-485 (4-wire) Half-Duplex

               Figure B‐20.              XStream Module Assembly in an RS‐485 (4‐wire) environment

© 2014 Digi International Inc.                                                                                                         63
XStream™ OEM RF Module – Product Manual v5.x00

Wiring Diagram: RS-422

Figure B‐21.                    XStream Module Assembly in an RS‐485 (4‐wire) environment

RS-485/422 Connection Guidelines

The RS-485/422 protocol provides a solution for wired communications that can tolerate high

noise and push signals over long cable lengths. RS-485/422 signals can communicate as far as

4000 feet (1200 m). RS-232 signals are suitable for cable distances up to 100 feet (30.5 m).

RS-485 offers multi-drop capability in which up to 32 nodes can be connected. The RS-422

protocol is used for point-to-point communications.

Suggestions for integrating the XStream Module with the RS-485/422 protocol:

                                When using Ethernet twisted pair cabling: Select wires so that T+ and T- are connected to

                                each wire in a twisted pair. Likewise, select wires so that R+ and R- are connected to a

                                twisted pair. (For example, tie the green and white/green wires to T+ and T-.)

                                For straight-through Ethernet cable (not cross-over cable) – The following wiring pattern

                                works well: Pin3 to T+, Pin4 to R+, Pin5 to R-, Pin6 to T-

                                Note that the connecting cable only requires 4 wires (even though there are 8 wires).

                                When using phone cabling (RJ-11) – Pin2 in the cable maps to Pin3 on opposite end of cable

                                and Pin1 maps to Pin4 respectively.

Figure B‐22                     Male (yellow) DB‐9 to RJ‐45 Adapters

Figure B‐23.                    Female (green) DB‐9 to RJ‐45 Adapters

© 2014 Digi International Inc.                                                                                              64
   XStream™ OEM RF Module – Product Manual v5.x00

               XCTU Software

               Using the XCTU Software

               XCTU is Digi-provided software used to interface with and configure XStream OEM RF

               Modules. The software application is organized into the following four tabs:

                                   •  PC Settings tab - Setup PC serial ports to interface with an XStream Module assembly

                                   •  Range Test tab – Test XStream Module's range and monitor packets sent and received

                                   •  Terminal tab – Set and read XStream Module parameters using AT Commands

                                   •  Modem Configuration tab – Set and read XStream Module parameters

               Figure B‐24            X‐CTU User Interface (PC Settings, Range Test, Terminal and Modem Configuration tabs)

               Install XCTU software

               Navigate to: www.digi.com/support. Then select “XCTU” under the product list. Select the

               appropriate driver to install the XCTU software.

               Setup

               To use the XCTU software, a module assembly (XStream Module mounted to a Digi XIB- R-R

               Interface Board) must be connected to the serial port of a PC. The data rate and parity settings

               of the serial port (“PC Settings” tab) must match those of the module (BD (Baud Rate) and NB

               (Parity) Commands).

               Serial Communications Software

               A terminal program is built into the XCTU Software. Other terminal programs such as

               “HyperTerminal” can also be used. When issuing AT Commands through a terminal program

               interface, use the following syntax:

               Figure B‐25            Syntax for sending AT Commands:

               Note: To read a parameter value stored in a register, leave the parameter field blank.

               The example above issues DT Command to change destination address of the module to “0x1F”.

               To save the new value to the module’s non-volatile (long term) memory, issue WR (Write)

               Command after modifying parameters

©  2014  Digi  International Inc.                                                                                           65
XStream™ OEM RF Module – Product Manual v5.x00

Appendix C: Additional Information

1-Year Warranty

             XStream OEM RF Modules from Digi International Inc. (the ʺProductʺ) are warranted against defects

             in materials and workmanship under normal use, for a period of 1‐year from the date of purchase. In

             the event of a product failure due to materials or workmanship, Digi will repair or replace the

             defective product. For warranty service, return the defective product to Digi, shipping prepaid, for

             prompt repair or replacement.

             The foregoing sets forth the full extent of Digiʹs warranties regarding the Product. Repair or

             replacement at Digiʹs option is the exclusive remedy. THIS WARRANTY IS GIVEN IN LIEU OF ALL

             OTHER WARRANTIES, EXPRESS OR IMPLIED, AND DIGI SPECIFICALLY DISCLAIMS ALL

             WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO

             EVENT SHALL DIGI, ITS SUPPLIERS OR LICENSORS BE LIABLE FOR DAMAGES IN EXCESS OF

             THE PURCHASE PRICE OF THE PRODUCT, FOR ANY LOSS OF USE, LOSS OF TIME,

             INCONVENIENCE, COMMERCIAL LOSS, LOST PROFITS OR SAVINGS, OR OTHER

             INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR

             INABILITY TO USE THE PRODUCT, TO THE FULL EXTENT SUCH MAY BE DISCLAIMED BY

             LAW. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR

             CONSEQUENTIAL DAMAGES. THEREFOR, THE FOREGOING EXCLUSIONS MAY NOT APPLY

             IN ALL CASES. This warranty provides specific legal rights. Other rights which vary from state to

             state may also apply.

Ordering Information

Figure C‐01  Digi OEM RF Module Part Numbers Key

© 2014 Digi International Inc.                                                                                     66
XStream™ OEM RF Module – Product Manual v5.x00

Contact  Digi

         If you need assistance,                contact technical support:

         Documentation:                         www.digi.com/support/

         Technical Support:                     Phone   (866) 765-9885 toll-free U.S. and Canada

                                                        (801) 765-9885 Worldwide

                                                Online  8:00 am – 5:00 pm (U.S. Mountain Time)

                                                        www.digi.com/support/eservice

© 2014 Digi International Inc.                                                                    67
Mouser Electronics

Authorized Distributor

Click to View Pricing, Inventory, Delivery & Lifecycle Information:

Digi International:

X09-001NSI  X24-009NMI  X24-009NSI  X24-009NST  X24-009WNI  X24-019NMI  X24-019NMT  X24-019NSI  X24-

019NST  X24-019WNI   X09-001NMI  X24-009-DK  X24-019-DK  X24-009NMC  X24-009NSC  X24-009WNC  X24-

019NMC  X24-019NSC      X24-019WNC  X24-009NNC

About Us 关于我们 客户服务 联系方式 器件索引 网站地图 最新更新 手机版

站点相关: 大学堂 TI培训 Datasheet 电子工程

器件索引   0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
搜索索引   0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

北京市海淀区知春路23号集成电路设计园量子银座1305 电话:(010)82350740 邮编:100191

电子工程世界版权所有 京B2-20211791 京ICP备10001474号-1 电信业务审批[2006]字第258号函 京公网安备 11010802033920号 Copyright © 2005-2021 EEWORLD.com.cn, Inc. All rights reserved