1. Manuals
  2. Brands
  3. Digi Manuals
  4. Radio Modems
  5. XLR PRO
  6. User manual

Digi XLR PRO User Manual

Hide thumbs Also See for XLR PRO:
Table of Contents

Advertisement

Quick Links

Download this manual
XLR PRO
Radio Frequency (RF) Modem
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XLR PRO and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Digi XLR PRO

Summary of Contents for Digi XLR PRO

  • Page 1 XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 2 Moved source content and made miscellaneous editorial corrections. Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.
  • Page 3 Digi Technical Support: Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and pricing, contact us at 877.912.3444 or visit us at www.digi.com/support.

  • Page 4: Table Of Contents

    Contents XLR PRO Radio Frequency (RF) Modem User Guide Technical specifications General Frequency range Rural range line-of-sight Urban range line-of-sight Receiver sensitivity Receiver selectivity UART interface data rates (software selectable) Networking and security Power requirements Environmental Regulatory approvals Connectors Data rates and sensitivity...
  • Page 5 MAC/PHY layers Ethernet bridging Ethernet packet handling Bridging precautions Enabling bridging 64-bit addresses Unicast Broadcast Serial addressing basics 64-bit addresses Unicast Broadcast Delivery method AT command reference for XLR PRO Special commands XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 6 DL (destination address low) TO (transmit options) NI (node identifier) NT (node discovery timeout) NO (node discovery options) CI (cluster ID) DE (destination endpoint) SE (source endpoint) Addressing discovery & configuration commands DN (discover node) XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 7 MA (IP addressing mode) MY (XLR IP address) MK (subnet mask) GW (default gateway address) NS (DNS address) %M (Ethernet MAC address) Device Cloud commands DO (Device Cloud enable) KP (device description) KC (device contact) XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 8 Using the AP command to set the operation mode API frame format API operation (AP = 1) frame format API operation with escapes (AP = 2) frame format Length field Frame data field Checksum field API serial exchanges XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 9 Device discovery General purpose flash memory Accessing general purpose flash memory Working with flash memory Over-the-air (OTA) firmware upgrades Distributing the new application Verifying the new application Installing the application Keep in mind XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 10 Configuring XLR PRO using the web configuration interface Access the XLR PRO web configuration interface Set general options Set Ethernet network options Set Ethernet RF bridging options Set Device Cloud connectivity options Set XLR radio options Set XLR radio serial options...
  • Page 11 Safety notices and certifications RF exposure statement Class 1, Division 2 (C1D2) certification—USA and Canada FCC (United States) certification Industry Canada (IC) certification Australia certification Mexico IFETEL XLR PRO antennas Omni-directional antennas Yagi antennas XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 12 XLR PRO Radio Frequency (RF) Modem User Guide XLR PRO is a high performance, industrial grade long-range radio solution that offers serial, Ethernet socket, and Ethernet bridging connectivity to ensure reliable wireless data communications over long distances. There are two models:...

  • Page 13: Technical Specifications

    Improved multipath performance Adjustable data rates Flexible configuration and management options allow you to quickly set up and deploy one or more XLR PRO modems, as well as apply firmware updates, get device status information, and more. Technical specifications General...

  • Page 14: Rural Range Line-Of-Sight

    Based on 100-mile range results. Other data rates scale based on sensitivity levels. Results will vary based on noise levels and line of sight quality. Estimated based on 3.6-mile range results. Estimated based on 3.6-mile range results. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 15: Receiver Selectivity

    460.8 kb/s UART Up to 921.6 kb/s Networking and security Item Specification Modulation Chirp Spread Spectrum Supported network topologies Point-to-point/point-to-multipoint Encryption 128-bit AES Power requirements Item Value Supply voltage 9VDC to 26VDC XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 16: Environmental

    -40° C to 70° C Regulatory approvals Regulation Approval Emissions/immunity FCC Part 15B Hazardous locations Class I, Division 2, Groups A, B, C, and D Mexico Safety NOM NYCE Safety Mexico Radio NOM-121 Australia XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 17: Connectors

    Ethernet (2) RJ45 Serial (1) RJ45 Configuration port Mini USB Data rates and sensitivity The following table lists XLR PRO available data rates along with the corresponding receiver sensitivity. RF data rate setting Data Receiver sensitivity (dBm, (ATBR) rate 25°C) 9.4 kb/s...

  • Page 18: Power Supply

    25°C) 3.2 Mb/s Power supply XLR PRO must be powered by a UL-listed power supply rated between 9 and 26V DC. Refer to the following table for the required input current settings. Input voltage Minimum current rating 9 to 15...

  • Page 19: Leds

    XLR PRO does not support Power over Ethernet (PoE) and must be externally powered through the DC power jack. LEDs The following tables describe XLR PRO LED behavior during startup and data transmissions. (For a diagram of the XLR PRO LEDS, see XLR PRO front panel on page...

  • Page 20: Reset Button

    (yellow) Reset button You can use the Reset button to reset the XLR PRO and to restore factory default settings. To reset the XLR PRO: 1. Hold down the Reset button for up to five seconds. The serial data in and serial data out LEDs flash three times to indicate that five seconds have passed.

  • Page 21: Antenna Port

    Reverse Polarity TNC (RPTNC) female. The connector has threads on the outside of a barrel and a male center conductor. For more information XLR PRO Radio Frequency (RF) family of products includes the following publications: Title Part...
  • Page 22 Description number XLR PRO 90002202 Provides complete information on all XLR Radio PRO and XLR PRO INTL Radio Frequency (RF) Frequency Modem features; describes how to configure (RF) XLR PRO modems using XCTU, the Web Modem configuration interface, and Device Cloud;...

  • Page 23: Hardware Setup

    Hardware setup XLR PRO kit contents The following table shows the XLR PRO accessories kit. Item Description XLR PRO modem Power supply XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 24: Xlr Pro Front Panel

    Network cable Mini USB cable RJ45/DB9F adapter Antenna Note: Australian kit only: Power plug adapter kit (UK, EU, XLR PRO front panel The following figure shows XLR PRO front panel connectors and LEDs. XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 25 Description Ethernet port 1 Ethernet port 2 Mini USB port Serial data out LED Serial data in LED Power LED Serial port Link margin indicator LEDs (RSSI) Reset button DC power jack XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 26: Rj45 Serial Port Pinout

    RS-232 RS-485 (4-wire) RS-485 (2-wire) TX/RX+ TX/RX- Unused Unused DRS/DCD Unused Unused Unused Unused Hardware setup Connect the hardware The following figure shows how to connect the XLR PRO cables and antenna. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 27: Mount The Xlr Pro

    The XLR PRO provides mounting holes in the bottom of the unit by which you can mount the unit directly on a wall or attach mounting brackets. There are two mounting brackets for the XLR PRO:...

  • Page 28: Mounting Guidelines

    Follow these general guidelines when mounting the XLR PRO: Use the pre-drilled mounting holes located on the bottom of the XLR PRO unit to attach the XLR PRO to the wall of an enclosure or DIN Rail bracket. Do not alter or move the mounting holes.

  • Page 29: Antenna Placement

    Mount the XLR PRO antenna vertically—that is, pointed directly up or down. If the XLR PRO is mounted within a metal enclosure, use an antenna external to the enclosure connected to the XLR PRO using a a 50 ohm coaxial cable, suitable for 900MHz UHF radio transmission.

  • Page 30: Xlr Pro Operational Design

    Operations XLR PRO operational design The XLR PRO uses a multi-layered firmware base for data flow. The flow of data depends on the hardware and software configuration you choose. The configuration block diagram below shows the host serial interface as the physical starting point and the antenna as the physical endpoint for transferred data.

  • Page 31: Ethernet Rf Bridging

    SH (serial number high) and SL (serial number low) parameters on the opposite XLR PRO (example: BA=0x0013A20012345678). With bridging enabled, the XLR PRO radios on the RF network should be treated as if they were a single Ethernet cable. Consult a qualified network administrator to evaluate the radio deployment if multiple XLR PRO radios will be used on the same LAN or if bridging multiple large networks together.

  • Page 32: Serial Mode Selection

    Serial mode selection Serial mode selection At any given time, only one serial mode can be selected. The XLR PRO selects the serial mode based on cable connections detection and configuration options. XLR PRO detects DTR on the USB virtual COM port.
  • Page 33 Serial mode selection Reset / Power On USB DTR? RS-232 DTR? 4E Set? (default) ES Set? (default) RS-232 IP Socket RS-485 XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 34: Usb Mode

    XLR PRO USB driver (Windows only) on the host PC. (The driver is available at www.digi.com/support/productdetail?pid=5603&type=drivers.) When connected via the mini USB port, the XLR PRO appears as a virtual COM port on the host. XLR PRO detects an active virtual DTR signal to determine if a USB connection is active.

  • Page 35: Ip Socket Mode

    RS-232. IP socket mode IP socket mode provides serial communication for a single TCP or UDP port on the XLR PRO (multiple simultaneous connections are not supported). This would normally happen over the Ethernet connection, but it may also occur over the bridge if Ethernet RF bridging is enabled and another XLR PRO (which also has Ethernet RF bridging enabled) provides the Ethernet connection to an IP host.
  • Page 36 IP host. C0: TCP or UDP port on which the XLR PRO listens. The IP host must send data to this port for the XLR PRO to accept the incoming data. If configuring the XLR PRO using XCTU, the port number is displayed in hexadecimal.

  • Page 37: Serial Communications

    DX and DY parameters are unused. In this case, the XLR PRO takes the role of a TCP or UDP server. But if the XLR PRO has data to send before an IP host sends data to the XLR PRO, then DX and DY determine the destination of that data until the TCP connection times out or until IP socket mode is restarted, whichever comes first.

  • Page 38: Networking Methods

    Networking methods This section explains XLR PRO networking layers and methods, starting from the simplest and moving to the most complex. MAC/PHY layers PHY stands for “physical layer.” The PHY layer manages the hardware that modulates and demodulates the RF bits.

  • Page 39: Ethernet Bridging

    The purpose of Ethernet RF bridging is to act as an Ethernet cable replacement. The MAC/PHY layer of the Ethernet standard handles all Ethernet traffic. As a result, the XLR PRO does not have to have a valid IP address on the network for bridging to work.

  • Page 40: Bridging Precautions

    The XLR PRO does not implement STP. As a precaution, when using bridging, only connect one of the XLR PRO devices to the same Ethernet network to avoid bridging loops. If you create multiple paths and you connect enterprise level switches with STP to the XLR PRO devices, then the connected switch ports are shutdown.

  • Page 41: Broadcast

    To transmit to all radios: For Ethernet RF bridging, set BA (bridge destination MAC) to 0x000000000000FFFF. If more than two XLR PRO devices are participating in a bridge, then you must set BA to 0xFFFF. By default, Ethernet bridging uses broadcasts and no retransmissions occur. If you send packets via TCP, then the TCP protocol provides the retransmissions as needed to provide for reliability.

  • Page 42: Delivery Method

    A P2MP unicast is only delivered directly to the destination radio, which must be in RF range of the sending radio. The XLR PRO uses patented technology that allows the destination radio to receive transmissions directed to it, even when there is a large amount of RF traffic. This works best when broadcast transmissions are kept to a minimum.
  • Page 43 By default, the CE (node messaging option) parameter is set to not route broadcasts. Due to the long-range of the XLR PRO, Digi advises you to evaluate on a per-radio basis which nodes should be configured as repeaters. Limiting the amount of congestion and generated RF traffic provides a more reliable network.

  • Page 44: At Command Reference For Xlr Pro

    Range Not applicable. Default Not applicable. FR (software reset) Resets the module. When issued, the module reponds with OK and performs a reset 100 milliseconds later. Range Not applicable. Default Not applicable. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 45: Re (Restore Defaults)

    If you are using OEM network identifiers, set ID to FFFF to use the factory value. Range A hexadecimal value from 0 through 7FFF. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 46: Br (Rf Data Rate)

    9.38 kb/s 28.14 kb/s 65.66 kb/s 140.7 kb/s 290.8 kb/s 590.9 kb/s 1.191 Mb/s 2.392 Mb/s 3.189 Mb/s Default Default is 4 which indicates a data transmission rate of 290.8 kb per second. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 47: Pl (Power Level)

    Default is A which indicates a maximum of 10 retries for unicasts. MT (broadcast multi-transmit) Sets or displays the number of additional MAC-level broadcast transmissions. All broadcast packets are transmitted MT+1 times to ensure packet reception. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 48: Diagnostics Commands

    EA command. EA is a volatile value—that is, the value does not persist across module resets. Range A hexadecimal value from 0 through FFFF. Default Default is 0. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 49: Er (Received Error Count)

    You can reset the counter to any 16-bit value within the valid range by appending a hexadecimal value to the TR command. TR is a volatile value—that is, the value does not persist across module resets. Range A hexadecimal value from 0 through FFFF. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 50: Ua (Unicasts Attempted)

    %8 (MAC broadcast one-hop timeout) Displays the MAC broadcast one-hop timeout value in milliseconds. Changing MAC parameters can change this value. Range Parameter is read only. Default Default value is hexadecimal 23D. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 51: N? (Network Discovery Timeout)

    Directed Broadcast. Range An integer from 0 through 2: Value Description Standard router node. A standard router repeats broadcasts. Not applicable. Non-router node. Default Default is 2 for non-router node. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 52: Bh (Broadcast Hops)

    An integer from 0 through 8. Default Default is 3. RF addressing commands SH (serial number high) Displays the upper 32 bits of the unique IEEE 64-bit RF extended address assigned to the XLR PRO. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 53: Sl (Serial Number Low)

    Parameter value is read only, and the default is factory set. SL (serial number low) Displays the lower 32 bits of the unique IEEE 64-bit RF extended address assigned to the XLR PRO. Range A hexadecimal value from 0 through FFFFFFFF.

  • Page 54: To (Transmit Options)

    Default is 40 (point-to-point/multipoint, ACK enabled). NI (node identifier) Sets or displays a string identifier for the XLR PRO. The NI string identifier is returned by the (network discover) on page 58 command. The NI string identifier can also be used by the...

  • Page 55: Nt (Node Discovery Timeout)

    API node identification frames. 00000010 Sends ND (network discover) on page 58 (find neighbors) on page 59 response frame when ND (network discover) on page 58 is issued. 00000011 Selects both 01 and 02 options XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 56: Ci (Cluster Id)

    One of the following hexadecimal values: Value Description Transparent data Loopback (that is, the destination node echoes transmitted packets back to the originator) Link test Memory Access (GPM) Default Default is 11 (transparent data). XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 57: De (Destination Endpoint)

    Sets or displays the application layer source endpoint value. The value is used as the source endpoint for all data transmissions. Range One of the following hexadecimal values: Value Description Digi device endpoint Digi data endpoint Default Default is E8 (Digi data endpoint). Addressing discovery & configuration commands XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 58: Dn (Discover Node)

    MY (XLR IP address) on page 71 <CR> (always FFFE) SH (serial number high) on page 52<CR> SL (serial number low) on page 53<CR> NI (node identifier) on page 54<CR> (Variable length) XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 59: Fn (Find Neighbors)

    DEVICE_TYPE<CR> (1 Byte: 0=Coord, 1=Router, 2=End Device) STATUS<CR> (1 Byte: Reserved) PROFILE_ID<CR> (2 Bytes) MANUFACTURER_ID<CR> (2 Bytes) DIGI DEVICE TYPE<CR> (4 Bytes. Optionally included based on NO (node discovery options) on page 55 settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on...

  • Page 60: Security Commands

    DEVICE_TYPE<CR> (1 Byte: 0=Coord, 1=Router, 2=End Device) STATUS<CR> (1 Byte: Reserved) PROFILE_ID<CR> (2 Bytes) MANUFACTURER_ID<CR> (2 Bytes) DIGI DEVICE TYPE<CR> (4 Bytes. Optionally included based on NO (node discovery options) on page 55 settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on...

  • Page 61: Serial Interfacing Commands

    Not applicable. Serial interfacing commands BD (baud rate) Sets or displays the serial baud rate for the XLR PRO. BD affects only the interface data rate for RS- 232 and RS-485/422 data through the serial port. Range An integer from 1 through 9 to select a preset baud rate; or a hexadecimal value from 5B9 through 5B8D80 to specify a specific baud rate.

  • Page 62: Nb (Parity)

    Default is 0 (no parity). SB (stop bits) Sets or displays the number of stop bits for the UART. Range One of the following values: Value Description One (1) stop bit. Two (2) stop bits. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 63: Ro (Packetization Timeout)

    Re-assert CTS when less then FT minus 16 bytes are in the UART receive buffer. Range A hexadecimal value from 11 through 94F. Default Default is 94F. AP (API mode) Sets or displays the API mode for the device. Range One of the following values: XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 64: Ao (Api Options)

    API Explicit RX indicator (0x91) Default Default is 0 (API RX indicator 0x90). D6 (RTS flow control) Sets or displays whether RTS flow control is enabled or disabled for the serial port. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 65: D7 (Cts Flow Control)

    CTS flow control is enabled. Default Default is 0 (CTS flow control is disabled). 4E (serial protocol) Sets or displays the serial protocol used for serial mode operation. Range Value Description RS-232 RS-485/422 XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 66: Rs-485 Duplex)

    120 Ohm termination resistor on the RS-485/422 data lines. This setting has no impact on RS-232 communication. Range Value Description Line termination is disabled. Line termination is enabled. Default Default is 0 (line termination is disabled). Hardware diagnostics commands XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 67: Tp (Temperature)

    Ethernet and IP socket mode commands TP (temperature) Displays the temperature of the XLR PRO in degrees Celsius. The temperature value is displayed in 8- bit two’s compliment format. For example, 1A = 26C, and F6 = -10C. Because the XLR PRO RF module produces heat, this temperature reading is usually above the ambient temperature.

  • Page 68: Ib (Ip Socket Baud Rate)

    Default is 1 (IP socket mode is enabled). IB (IP socket baud rate) Sets or displays the IP socket baud rate for the XLR PRO. This value only affects the interface data rate for serial TCP/UDP data through the Ethernet port.

  • Page 69: Ip (Ip Protocol)

    Sets or displays the destination IP address in IPv4 format for outgoing IP socket mode data. For broadcast, set DX to 255.255.255.255. Range A valid address in IPv4 format from 0.0.0.0 to 255.255.255.255. Default Default is 0.0.0.0. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 70: C0 (Source Port)

    TM (TCP client connection timeout) Sets or displays the timeout in seconds for outgoing TCP socket connections when the XLR PRO is acting as a TCP client. The connection is closed if no activity is detected during this timeout period.

  • Page 71: Ts (Tcp Server Connection Timeout)

    TS (TCP server connection timeout) Sets or displays the timeout in seconds for incoming TCP socket connections when the XLR PRO is acting as a TCP server. The connection is closed if no activity is detected during this timeout period.

  • Page 72: Mk (Subnet Mask)

    Second to last byte of the Ethernet MAC address. Last byte of the Ethernet MAC address. If the Auto-IP address of the XLR PRO conflicts with another address on the network, then the Auto- IP address is incremented by one until the conflict is resolved.

  • Page 73: Ns (Dns Address)

    A valid address in IPv4 format from 0.0.0.0 to 255.255.255.255. Default Not applicable. NS (DNS address) Sets or displays the IPv4 address of the domain name server for the XLR PRO. Range A valid address in IPv4 format from 0.0.0.0 to 255.255.255.255. Default Not applicable.

  • Page 74: Kp (Device Description)

    From 0 through 31 ASCII characters. Default Default is blank. KL (device location) Sets or displays a user-defined physical location for the XLR PRO displayed in Device Cloud and web configuration interfaces. Range From 0 through 31 ASCII characters. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 75: Lx (Latitude)

    Default Default is blank. LX (latitude) Sets or displays a user-defined GPS latitude coordinate for the XLR PRO displayed in Device Cloud and web configuration interfaces. The latitude is a user-defined field—the XLR PRO does not have GPS functionality. Range From 0 through 15 ASCII characters.

  • Page 76: Di (Device Cloud Indicator)

    DHCP is enabled and no DHCP server was found Default Not applicable. Web configuration commands HE (web configuration enable) Sets or displays whether XLR PRO web configuration (HTTP) is enabled. Range Value Description Web configuration is disabled. Web configuration is enabled.

  • Page 77: Hu (Web Configuration User Name)

    Default is password. Ethernet bridging commands BE (Ethernet RF bridging enable) Sets or displays whether Ethernet RF bridging is enabled. Range Value Description Ethernet RF bridging is disabled. Ethernet RF bridging is enabled. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 78: Ba (Bridge Destination Mac)

    CC (command sequence character) Sets or displays the sequence character to use for entering AT command mode. Repeating the CC character three times causes the XLR PRO to enter AT command mode. The following commands are related to CC: GT (guard time) on page 79 to define a guard time—the amount of time before...

  • Page 79: Cn (Exit Command Mode)

    Default Not applicable. CT (command mode timeout) Sets or displays the period of inactivity (no valid commands received) after which the XLR PRO automatically exits AT command mode and returns to idle mode. Range A hexadecimal value from 2 to 1770 multiplied by 100 milliseconds to define the timeout value.

  • Page 80: Vr (Xlr Pro Module Firmware Version)

    Displays the XLR PRO RF module hardware version. Range Not applicable. Default Not applicable. VH (XLR PRO baseboard hardware version) Displays the XLR PRO RF modem baseboard hardware version. Range Not applicable. Default Not applicable. *C (compatibility) Displays the compatibility setting for the XLR PRO.

  • Page 81: Dd (Device Type Identifier)

    Default Not applicable. DD (device type identifier) Displays the Digi device type identifier. This identifier can be used to differentiate Digi products. The XLR PRO RF modem product code upper word is 000E. Range A hexadecimal value from 0 through FFFFFFFF.

  • Page 82: Ck (Configuration Crc)

    After a firmware update, this command may return a different CK value even if the parameters have not been altered. Range A hexadecimal value from 0 through FFFF. Default Not applicable. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 83: Api Operation

    Note Digi may add new frame types to future versions of firmware, so include the ability to filter out unknown API frames into your software interface. See Application API support on page...

  • Page 84: Api Operation (Ap = 1) Frame Format

    Any data received prior to the start delimiter is discarded. If the frame is not received correctly or if the checksum fails, the XLR PRO replies with a radio status frame indicating the nature of the failure. API operation with escapes (AP = 2) frame format...

  • Page 85: Length Field

    The length field is a two-byte value that specifies the number of bytes contained in the frame data field. It does not include the checksum field. Frame data field The frame data field of the serial data frame forms an API-specific structure as follows: XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 86 Frame type: API frame type identifier. Determines the type of API frame and order of the information in the Data. Data: Determined by the API frame type, contains information in the order defined by the API type. XLR PRO can send the following frame types: API frame name Frame ID AT command 0x08 AT command—queue parameter value...

  • Page 87: Checksum Field

    The following image shows the API frame exchange that takes place at the serial interface when sending an AT command request to read or set an XLR PRO parameter. The response can be disabled by setting the frame ID to 0 in the request.

  • Page 88: Remote At Commands

    Applications that support API should make provisions to accommodate new API frames that may be introduced in future releases. For example, a section of code on a host microprocessor that handles received serial API frames (sent out the XLR PRO active serial interface) might look like this: void XLRPRO_HandleRxAPIFrame(_apiFrameUnion*papiFrame){ switch(papiFrame->api_id){...

  • Page 89: At Command-Apply Changes

    AT command—apply changes Frame type: 0x08 Used to query or set XLR PRO parameters on the local device and apply the changes after executing the command. (Changes made to XLR PRO parameters take effect once changes are applied.) Example: The example below shows an API frame that queries the ID (network ID) parameter value of the XLR PRO.

  • Page 90: Tx Request

    115200. TX request Frame type: 0x10 A TX Request API frame causes the XLR PRO to send data as an RF packet to the specified destination: Broadcast transmission: For broadcast transmission to all devices, set the 64-bit destination address to 0x000000000000FFFF.
  • Page 91 If the transmit options is set to 0, then the TO parameter is Options used. Here are valid transmit options: 0x01—Disable ACK 0x02—Disable network address discovery Set all other bits to 0. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 92: Explicit Tx Request

    TX Request, but also requires application layer addressing fields to be specified (endpoints, cluster ID, profile ID). An Explicit TX Request API frame causes the XLR PRO to send data as an RF packet to the specified destination, using the specified source and destination endpoints, cluster ID, and profile ID.
  • Page 93 The Profile ID that the host uses in the transmission. 0x05 Broadcast 0x00 Sets the maximum number of hops a broadcast transmission Radius can traverse. If set to 0, the transmission radius will be set to the network maximum hops value. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 94: Remote At Command Request

    Remote AT command request Frame type: 0x17 Used to query or set XLR PRO parameters on a remote device. For parameter changes on the remote device to take effect, changes must be applied either by setting the apply changes options bit or by sending an AC (apply changes) command to the remote.

  • Page 95: At Command Response

    AT command response Frame type: 0x88 In response to an AT Command message, the XLR PRO will send an AT Command Response message. Some commands will send back multiple frames, for example, the ND (Node Discover) command. Example: The following examples shows a command response. Suppose the BD parameter is changed on the local device with a frame ID of 0x01.

  • Page 96: Modem Status

    Modem status Frame type: (0x8A) Radio status messages are sent from the XLR PRO in response to specific conditions. Example: The following API frame is returned when an API device powers up. Frame fields...

  • Page 97: Transmit Status

    Transmit status Frame type: 0x8B When a TX Request is completed, the XLR PRO sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure. Example: In the following example, a unicast data transmission was sent successfully to a destination device using a frame ID of 0x47.

  • Page 98: Rx Indicator

    RX indicator Frame type: (0x90) When the XLR PRO receives an RF data packet, it is sent out the active serial interface using this message type. Example: In the following example, a device with a 64-bit address of 0x0013A200 40522BAA sends a unicast data transmission to a remote device with payload RxData.

  • Page 99: Explicit Rx Indicator

    Explicit RX indicator Frame type:0x91 When the XLR PRO receives an RF packet it is sent out the active serial interface using this message type (when AO=1). Example: In the following example, a device with a 64-bit address of 0x0013A200 40522BAA sends a broadcast data transmission to a remote device with payload "RxData".

  • Page 100: Remote Command Response

    Remote command response Frame type: 0x97 If an XLR PRO receives a remote command response RF data frame in response to a Remote AT Command Request, the XLR PRO will send a Remote AT Command Response message out the active serial interface.
  • Page 101 0x03 = Invalid Parameter 0x04 = TX Failure The most significant nibble is a bitfield as follows: 0x40 = The RSSI field is invalid and should be ignored 0x80 = Response is a remote command XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 102 API Frame types Frame fields Byte Example Description Command data 19-n 0x40 The value of the required register. 0x52 0x2B 0xAA XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 103: Advanced Application Features

    Advanced application features Remote configuration commands An XLR PRO in API mode has provisions to send configuration commands to remote devices using the Remote Command Request API frame (see API operation on page 83). This API frame can be used to send commands to a remote XLR PRO to read or set command parameters.

  • Page 104: Remote Command Responses

    Device configuration The XLR PRO can be configured locally through serial commands (AT or API), or remotely through remote API commands. API devices can send configuration commands to set or read the configuration settings of any device in the network.

  • Page 105: Device Discovery

    NI (node identifier), and other relevant information. This command is useful for generating a list of all XLR PRO addresses in a network. When a device receives the ND command, it waits a random time before sending its own response.

  • Page 106: General Purpose Flash Memory

    The General Purpose Memory (GPM) is also used to store a firmware upgrade file for over-the-air firmware upgrades of the XLR PRO itself. Accessing general purpose flash memory...
  • Page 107 The format of the response is similar to the request packet: Payload Number Field Description (byte name offset) bytes GPM_ This field will be the same as the request field. CMD_ID GPM_ Status indicating whether the command was successful. STATUS XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 108 GPM_START_INDEX Set to 0. This field is unused for this command. GPM_NUM_BYTES Set to 0. This field is unused for this command. GPM_DATA No data bytes should be specified for this command. XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 109 The ERASE command erases (writes all bits to binary 1) one or all of the GPM flash blocks. The ERASE command can also be used to erase all GPM blocks by setting the GPM_NUM_BYTES field to 0. XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 110 Description GPM_CMD_ID Set to ERASE_RESPONSE (0x81). GPM_STATUS A one (1) in the least-significant bit indicates an error occurred. All other bits are reserved. GPM_BLOCK_ Matches the parameter passed in the request frame. XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 111 ERASE of the entire GPM block specified with the GPM_BLOCK_NUM field prior to doing a WRITE. Field Description name GPM_ Set to WRITE (0x02) or ERASE_THEN_WRITE (0x03). CMD_ID GPM_ At present, there are no defined options for this command. Set this field to 0. OPTIONS XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 112 Set to WRITE_RESPONSE (0x82) or ERASE_THEN_WRITE_RESPONSE (0x83). GPM_OPTIONS A one (1) in the least-significant bit indicates an error occurred. All other bits are reserved. GPM_BLOCK_ Matches the parameter passed in the request frame. XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 113 Field Description name GPM_ Set to READ (0x04). CMD_ID GPM_ At present, there are no defined options for this command. Set this field to 0. OPTIONS XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 114 Description GPM_CMD_ID Set to READ_RESPONSE (0x84). GPM_OPTIONS A one (1) in the least-significant bit indicates an error occurred. All other bits are reserved. GPM_BLOCK_ Matches the parameter passed in the request frame. XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 115 PRO firmware remotely. Remote firmware upgrades are covered in detail in the next section. These commands check if the General Purpose Memory contains a valid over-the-air update file. For the FIRMWARE_VERIFY_AND_INSTALL command, if the GPM contains a valid firmware image, then the XLR PRO resets and begins using the new firmware. Field name Description...
  • Page 116 GPM memory does not contain a valid image. If the image is valid, the XLR PRO will reset and begin using the new firmware.

  • Page 117: Working With Flash Memory

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

  • Page 118: Distributing The New Application

    Example: XLR PRO firmware version 1003 has an .ebin file of 1,048,576 bytes in length. Based on using a recommended packet size of 1024 bytes, sending a packet every 30 seconds minimized network disruption. For this reason, the .ebin should be divided and addressed as follows:...

  • Page 119: Verifying The New Application

    AND_INSTALL command can be issued. Once the target receives the command it will verify the .ebin file loaded in the GPM. If it is found to be valid, the XLR PRO will install the new firmware. This XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 120: Keep In Mind

    Over-the-air (OTA) firmware upgrades installation process can take up to 8 seconds. During the installation the XLR PRO will be unresponsive to both serial and RF communication. To complete the installation, the target XLR PRO will reset. Any AT parameter settings which have not been written to flash using the WR (write) command will be lost.

  • Page 121: Configuring Xlr Pro Using The Web Configuration Interface

    Access the XLR PRO web configuration interface Accessing the XLR PRO web configuration interface requires the IP address of the XLR PRO. If your XLR PRO is configured for DHCP addressing (the default), connect the XLR PRO to the network and wait approximately one minute for DHCP to assign an address.

  • Page 122: Set Ethernet Network Options

    3. Click Apply. Set Ethernet network options Use Ethernet Network options to configure Ethernet options for the XLR PRO. Ethernet Network options are used for Ethernet (socket) mode only. 1. From the XLR PRO Configuration and Management page, select Ethernet Network.

  • Page 123: Set Ethernet Rf Bridging Options

    RF MAC address. A destination address of 00000000:000FFFF is broadcast. 3. Click Apply. Set Device Cloud connectivity options By default, the XLR PRO is enabled for Device Cloud management. To change Device Cloud options: XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 124: Set Xlr Radio Options

    Set XLR radio options 1. From the XLR PRO Configuration and Management page, select Device Cloud Connectivity. The Device Cloud Configuration page appears. 2. Select the following: Enable Device Cloud Connectivity: Select this option to enable Device Cloud connectivity; deselect this option to disable Device Cloud connectivity.

  • Page 125: Set Xlr Radio Serial Options

    RF Data Rate: Select an RF Data Rate from the drop-down list. The default is 4. Network ID: Enter a network ID for the XLR PRO. The default is 7FFF. Security Key: Enter an AES encryption key for RF packets, a 128-bit key.

  • Page 126: Set Xlr Radio Ip Socket (Ethernet) Options

    Set XLR radio IP socket (Ethernet) options To set XLR radio IP socket (Ethernet) configuration options: 1. From the XLR PRO Configuration and Management page, select XLR Radio IP Socket Configuration. The Socket Radio Configuration page appears. 2. Enable or disable IP socket mode: To enable socket mode, select Enable IP Socket Mode.

  • Page 127: Update Firmware

    The default is 60 seconds. 4. Click Apply. Update firmware Use the Firmware Update option on the XLR PRO Device Configuration Home page to update the XLR PRO firmware. To update firmware: 1. Go to the XLR PRO product page: www.digi.com/xlrpro and download the latest XLR PRO firmware.

  • Page 128: Set Web Configuration Options

    5. After selecting a firmware file, click Update Firmware. XLR PRO firmware is updated and the XLR PRO resets. (The amount of time needed to update the XLR PRO depends on the speed of your network.) Approximately 30 seconds after the XLR PRO resets, the XLR PRO is operational.

  • Page 129: Configuring Xlr Pro Using Xctu

    Connect XLR PRO to your PC To connect XLR PRO to your PC: 1. Connect the XLR PRO mini USB port to an available USB port on your PC using the mini USB cable. 2. Power on the XLR PRO.

  • Page 130: Configure Parameters Using Xctu

    Flow Control: Select the default, None. The radio module is programmable: Keep the default, unselected. 4. Click Finish. XCTU connects to the XLR PRO and displays the device in the list of radios. 5. Click the XLR PRO to display current properties and configure parameters in the right-hand pane.

  • Page 131: Assign A Static Ip Address

    XLR PRO assigns an IP address using the following format: 169.254.xxx.yyy where xxx is the decimal value of the 2nd to last byte of the XLR PRO Ethernet MAC address and yyy is the last byte of the XLR PRO Ethernet MAC address. If the assigned address is already in use, the address is incremented until a free address is found.
  • Page 132 Update firmware with XCTU 5. Select the desired firmware, function set, and firmware version. 6. Click Finish and then the Yes. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 133: Configuration Xlr Pro Using Device Cloud

    Device Cloud, refer to the Device Cloud User Guide, available via the Documentation tab in Device Cloud. Before you can manage an XLR PRO with Device Cloud, you must create a Device Cloud account. To create a Device Cloud account: 1.

  • Page 134: Add A Digi Xlr Pro To Device Cloud

    2. Click Device Management > Devices. 3. Click Add Devices. The Add Devices dialog appears. You can use the Discover button to discover an XLR PRO device if the XLR PRO is connected to your local network. 4. Select Mac Address, and enter the MAC address of the XLR PRO you want to add.

  • Page 135: Configure Device Cloud Connectivity Options

    Schedule Device Cloud configuration changes on page 142. Configure Ethernet network options By default, the XLR PRO is configured to use DHCP addressing. To change the IP addressing options: 1. Click Device Management > Devices. 2. Double-click the XLR PRO you need to configure.

  • Page 136: Configure Ethernet Rf Bridging Options

    To obtain an IP address automatically using DHCP, disable Use static address. 5. For static addressing only, enter the following: IP address: Enter an IP address to assign to the XLR PRO in IPv4 format. Subnet Mask: Enter the subnet mask to use for the XLR PRO in IPv4 format.

  • Page 137: Configure Ip Socket Mode Options

    RF MAC address for the destination XLR PRO. 5. Apply the configuration changes: If the XLR PRO is currently connected to Device Cloud, click Save to immediately apply configuration settings. If the XLR PRO is currently not connected to Device Cloud, use the Schedule option to schedule when to apply configuration changes to the device.

  • Page 138: Configure Serial Mode Options

    The default is 60 seconds. IP Socket Mode: Socket mode is enabled or disabled depending on what cables are plugged in to the XLR PRO. To prevent socket mode regardless of cables, select Disabled. 5. Apply the configuration changes: If the XLR PRO is currently connected to Device Cloud, click Save to immediately apply configuration settings.

  • Page 139: Configure System Options

    RS-458 Termination: Enable or disable RS-485 termination. The default is disabled. 5. Apply the configuration changes: If the XLR PRO is currently connected to Device Cloud, click Save to immediately apply configuration settings. If the XLR PRO is currently not connected to Device Cloud, use the Schedule option to schedule when to apply configuration changes to the device.

  • Page 140: Configure Web Configuration Options

    Schedule Device Cloud configuration changes on page 142. Configure web configuration options By default, the XLR PRO HTTP server interface is enabled. To change HTTP server options: 1. Click Device Management > Devices. 2. Double-click the XLR PRO you need to configure.

  • Page 141: Configure Xlr Radio Configuration Options

    To remove a user name and password, blank out the input fields. 5. Apply the configuration changes: If the XLR PRO is currently connected to Device Cloud, click Save to immediately apply configuration settings. If the XLR PRO is currently not connected to Device Cloud, use the Schedule option to schedule when to apply configuration changes to the device.

  • Page 142: Schedule Device Cloud Configuration Changes

    API mode: Select the API mode for the XLR PRO: none (transparent), API, or API with escapes. The default is none (transparent). Network ID: Enter a network ID for the XLR PRO. The default is 7FFF. Only XLR PROs with matching network IDs can communicate with each other.
  • Page 143 3. Enable the Schedule Offline checkbox to create a schedule for a device that is offline. If a device becomes disconnected from Device Cloud for any reason during the execution of this command, Device Cloud retries the command when the device reconnects. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 144: Troubleshooting

    Serial interface issues Symptom Solution No data To enable the XLR PRO serial port, the DTR line on your RS-232 cable must be on serial active and connected. If the DTR line is not present, the XLR PRO uses IP socket port mode instead of the serial port for serial communication.

  • Page 145: General Issues

    Solution All of the If all of the LEDs on the front panel are lit solid, this indicates that the XLR PRO is LEDs are in a bootloader state and will not respond to any user input. This can happen if...

  • Page 146: Safety Notices And Certifications

    Note The USB port on the XLR PRO is not intended for use in Class I, Division 2 environments. XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 147: Fcc (United States) Certification

    This equipment generates, uses, and can radiate radio frequency energy, and if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. However, there is no guarantee XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 148: Industry Canada (Ic) Certification

    (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Modifications (FCC 15.21) Changes or modifications to this equipment not expressly approved by Digi may void the user’s authority to operate this equipment. Industry Canada (IC) certification...

  • Page 149: Australia Certification

    Mexico IFETEL Manufacturer: Digi International Inc. Country: USA Brand: Digi The XLR Pro RF Modem for carries the following Mexican approval marks: Mexico: 1502CE10266 IFT# RCPDIXL15-1494 Note Only the 2.1 dBi dipole antenna (A09-HATM-10) is approved for use with the modem in Mexico.

  • Page 150: Xlr Pro Antennas

    A09-F0 OMNI Fixed A09-F1 OMNI Fixed A09-F2 OMNI Fixed A09-F3 OMNI Fixed A09-F4 OMNI Fixed A09-F5 OMNI Fixed A09-F6 OMNI Fixed A09-F7 OMNI Fixed A09-F8 OMNI Fixed A09-W7 OMNI Fixed XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 151 A09-M7 OMNI RPSMAF Fixed A09-W7SM OMNI RPSMA Fixed A09-F0TM OMNI RPTNC Fixed A09-F1TM OMNI RPTNC Fixed A09-F2TM OMNI RPTNC Fixed A09-F3TM OMNI RPTNC Fixed A09-F4TM OMNI RPTNC Fixed A09-F5TM OMNI RPTNC Fixed XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 152 RPSMA Fixed/Mobile A09- OMNI MMCX Fixed/Mobile HABMM- A09- OMNI MMCX Fixed/Mobile HABMM-6- A09-HBMM- OMNI MMCX Fixed/Mobile A09-HRSM OMNI RPSMA Fixed A09-HASM- OMNI RPSMA Fixed A09-HG OMNI RPSMA Fixed A09-HATM OMNI RPTNC Fixed XLR PRO Radio Frequency (RF) Modem User Guide...

  • Page 153: Yagi Antennas

    OMNI MMCX Fixed/Mobile Max Gain Yagi antennas Part Type Connector Gain Application Minimum cable loss or TX number (dBi) power reduction required in dB A09-Y6 Fixed/Mobile Element Yagi A09-Y7 Fixed/Mobile Element Yagi XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 154 Element Yagi A09-Y10 10.1 Fixed/Mobile Element Yagi A09-Y11 11.1 Fixed/Mobile Element Yagi A09-Y12 12.1 Fixed/Mobile Element Yagi A09-Y13 13.1 Fixed/Mobile Element Yagi A09-Y14 14.1 Fixed/Mobile Element Yagi A09-Y14 14.1 Fixed/Mobile Element Yagi XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 155 A09- RPTNC Fixed/Mobile Y7TM Element Yagi A09- RPTNC Fixed/Mobile Y8TM Element Yagi A09- RPTNC Fixed/Mobile Y9TM Element Yagi A09- RPTNC 10.1 Fixed/Mobile Y10TM Element Yagi A09- RPTNC 11.1 Fixed/Mobile Y11TM Element Yagi XLR PRO Radio Frequency (RF) Modem User Guide...
  • Page 156 Yagi A09- RPTNC 14.1 Fixed/Mobile Y14TM Element Yagi A09- RPTNC 14.1 Fixed/Mobile Y14TM Element Yagi A09- RPTNC 15.1 Fixed/Mobile Y15TM Element Yagi A09- RPTNC 15.1 Fixed/Mobile Y15TM Element Yagi Max Gain 15.1 XLR PRO Radio Frequency (RF) Modem User Guide...

Table of Contents