Digi XLR PRO User Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. XLR PRO
  6. User manual

Digi XLR PRO User Manual

Radio frequency (rf) module
Hide thumbs Also See for XLR PRO:
Table of Contents

Advertisement

Quick Links

Download this manual
XLR PRO™
Radio Frequency (RF) Module
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

Related Manuals for Digi XLR PRO

Summary of Contents for Digi XLR PRO

  • Page 1 XLR PRO™ Radio Frequency (RF) Module User Guide...
  • Page 2 Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.

  • Page 3: Table Of Contents

    Networking and security specifications Power requirements Environmental Regulatory conformity summary Connectors Getting started with the XLR PRO RF Module Development Board for the XLR PRO RF Module Edge connector XLR PRO Modular Development Board LEDs USB communication enable and loopback switches...
  • Page 4 GD (Good Packets Received) TR (Transmission Failure Count) UA (Unicasts Attempted) %H (MAC Unicast One Hop Time) %8 (MAC Broadcast One Hop Time) N? (Network Discovery Timeout) Network commands CE (Node Messaging Options) XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 5 P5 (DIO15/SPI_MISO) P6 (SPI_MOSI Configuration) P7 (DIO17/SPI_SSEL ) P8 (DIO18/SPI_CLK) P9 (DIO19/SPI_ATTN) PD (Pull Up/Down Direction) PR (Pull-up/Down Resistor Enable) M0 (PWM0 Duty Cycle) M1 (PWM1 Duty Cycle) LT (Associate LED Blink Time) XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 6 Length field Frame data Checksum field API serial exchanges AT command frames Transmit and receive RF data Remote AT commands Code to support future API frames API frames AT Command frame - 0x08 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 7 Distribute the new application Verify the new application Install the application Keep in mind Configure the XLR PRO RF Module using XCTU Download and install XCTU Connect XLR PRO to your PC Launch XCTU and add the XLR PRO Configure parameters using XCTU...
  • Page 8 ISED (Innovation, Science and Economic Development Canada) certification RF exposure IC labeling requirements Transmitters with detachable antennas Australia (RCM) [pending] Power requirements Antennas Omni-directional antennas Yagi antennas XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 9: About The Xlr Pro Rf Module

    Adjustable data rates The XLR PRO RF Module flexible configuration and management options allow you to quickly set up and deploy one or more XLR PRO RF Modules, as well as apply firmware updates, get device status information, and more.

  • Page 10: Antenna Port

    The following figures show the XLR PRO RF Module mechanical drawings. All dimensions are in inches. Pinouts The following table shows the pin assignments for the XLR PRO RF Module. In the table, low-asserted signals have a horizontal line above signal name.
  • Page 11 DIO3/AD3 Both — — do not connect DIO4 Both — — do not connect DIO5/ASSOC Both DIO19/SPI_ATTN Both (input) DIO8/DTR/SLP_RQ Both DIO17/SPI_SSEL Both DIO9/ON/SLEEP Output DIO16/SPI_MOSI Both VREF Both unused DIO15/SPI_MISO Both XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 12: Heat Dissipation

    Heat dissipation We recommend that you use a heat sink with the XLR PRO RF Module. The XLR PRO RF Module produces heat and when it transmits, it generates more heat. The device has over-temperature protection and automatically shuts down if it gets too hot. It is best to avoid this temperature and not exceed 90 °C so that the application can control transmissions, and is not stopped due to overheating.

  • Page 13: Use A Heat Sink

    About the XLR PRO RF Module Heat dissipation Use a heat sink Use a heat sink to prevent the XLR PRO RF Module from overheating. The following mechanical drawing shows the heat sink that we use on the XLR Module Development Board: <insert picture>...

  • Page 14: Operation Without A Heat Sink

    Operation without a heat sink Although we do not recommend it, you can operate the XLR PRO RF Module without a heat sink. This can only be done with an ambient temperature lower than 40 °C, and with the transmitter being used no more than five seconds in a ten second period.

  • Page 15: Technical Specifications

    The following tables provide the device's technical specifications. General specifications Electrical specifications RF characteristics Rural range line-of-sight Receiver sensitivity Receiver selectivity Interface data rate (software selectable) Networking and security specifications Power requirements Environmental Regulatory conformity summary Connectors XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 16: General Specifications

    11 g (.39 oz) RoHS Compliant Electrical specifications The following table provides the electrical specifications for the XLR PRO RF Module. In this table, low-asserted signals have a horizontal line above signal name. Electrical specifications Minimum Typical Maximum Units Status VDD_5V Operation below 4.5 V may reduce...

  • Page 17: Rf Characteristics

    70 dB (below 908 MHz, above 922 MHz) Receiver selectivity at 141 kb/s 40 dB (908 MHz to 922 MHz) RF data rate Maximum transmit power +30 dBm (1 W) (software selectable) XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 18: Rural Range Line-Of-Sight

    1.2 Mb/s -103 2.4 Mb/s -100 3.2 Mb/s 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. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 19: Receiver Selectivity

    The following table describes the networking and security specifications for the devices. Item Specification Supported network topologies Point-to-point/point-to-multipoint Encryption 128-bit AES Power requirements The following table describes the power requirements for the XLR PRO RF Module. Item Value 3.8 to 5.5 VDC (see Electrical specifications) Supply voltage Receive current...

  • Page 20: Connectors

    Technical specifications Connectors Regulation Approval FCC ID: MCQ-XLRP United States Canada IC: 1846A-XLRP Australia RCM (pending) Connectors Connector Description Antenna MMCX XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 21 Getting started with the XLR PRO RF Module This section provides information on the Development Board for the XLR PRO RF Module and getting started instructions if you have an XLR PRO RF Module Development Kit. Development Board for the XLR PRO RF Module...

  • Page 22: Getting Started With The Xlr Pro Rf Module

    Getting started with the XLR PRO RF Module Development Board for the XLR PRO RF Module Development Board for the XLR PRO RF Module The following figure shows the Development Board for the XLR PRO RF Module with an onboard XLR PRO RF Module. Edge connector The XLR PRO RF Module is connected to the development board by an edge connector.

  • Page 23: Xlr Pro Modular Development Board Leds

    Getting started with the XLR PRO RF Module Development Board for the XLR PRO RF Module CAUTION! The thermal gasket for the XLR PRO RF Module is subject to wear and tear. We recommend that you limit the number of insertions of the XLR PRO RF Module.
  • Page 24 5V line indicator An illuminated red LED indicates that the 5 V line on the XLR PRO Module is powered. This light being illuminated does not ensure the voltage on VDD_5V line is correct, it only indicates that a voltage is present.

  • Page 25: Usb Communication Enable And Loopback Switches

    UART_LOOPBACK is enabled when pushed to the right). When enabled, they allow communication from the USB port to reach the XLR PRO module. The loopback switch loops back data sent from the USB port back out of the USB port.

  • Page 26: Commissioning And Reset Buttons

    Getting started with the XLR PRO RF Module Development Board for the XLR PRO RF Module Commissioning and Reset buttons Use the Commissioning and Reset buttons to toggle the RESET and DIO0/AD0/CommBtn lines to the XLR PRO module. XLR PRO Shutdown control switch Use the large three-state switch located near the top right corner of the board to control shutdown of the XLR PRO.

  • Page 27: Xlr Pro Direct Voltage Supply Input

    High High If the switch is high, the XLR PRO module is enabled. If the switch is low, the XLR PRO module is put into shutdown. The middle position could mean the XLR PRO module is enabled or in shutdown, depending on how a line is pulled on the USB bridging chip on the development board.

  • Page 28: 40-Pin Development Header

    All power supplied on the terminal blocks is used to power the XLR PRO module only. Components on the XLR PRO Modular Development Board are not powered through the terminal blocks. Current measurements can be taken if powering through the terminal.

  • Page 29: Set Up A Development Kit For A Range Test

    3. Connect the development boards to the USB port on a computer using the mini-USB cables. Separate the development boards by at least 2 m (6 ft). 4. Use the MMCX to SMA cable provided to connect the XLR PRO to the SMA connector (P7) on the development boards .

  • Page 30: Perform A Range Test

    Getting started with the XLR PRO RF Module Perform a range test When you connect the development board to a PC for the first time, the PC automatically installs drivers, which may take a few minutes to complete. 1. Add the two devices to XCTU.
  • Page 31 Getting started with the XLR PRO RF Module Perform a range test 6. Range test data is represented in the chart. By default, 100 packets are sent for the test. XCTU displays the instant local and remote RSSI in two separate controls, as well as the number of packets sent and received.
  • Page 32 Operations Operational design UART SPI signals Slave mode characteristics Full duplex operation Configuration considerations SPI and API mode SPI parameters Serial port selection XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 33: Operations

    Operational design Operational design The XLR PRO RF Module 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 34: Serial Communications

    Serial buffers Serial receive buffer When serial data enters the XLR PRO, the data is stored in the serial receive buffer until it can be processed. Under certain conditions, the XLR PRO may not be able to process data in the serial receive buffer immediately.

  • Page 35: Slave Mode Characteristics

    Full duplex operation When using SPI on the XLR PRO RF Module the device uses API operation (AP = 1) without escaped characters to packetize data. SPI is a full duplex protocol, even when data is only available in one direction.

  • Page 36: Configuration Considerations

    Clock polarity (CPOL): first (leading) edge rises All XLR PRO RF Modules use SPI mode 0 and MSB first. Mode 0 means that data is sampled on the leading edge and that the leading edge rises. MSB first means that bit 7 is the first bit of a byte sent over the interface.

  • Page 37: Serial Receive Buffer

    RF data packet. Whenever the device receives data faster than it can process and transmit the data out the serial port, there is a potential of dropping data. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 38: Networking Methods

    Networking methods MAC/PHY layers Addressing basics Delivery methods Transmission timeouts XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 39: Mac/Phy Layers

    The following table shows the AT commands related to the MAC/PHY layers. command Description The ID (network identifier) command sets the network identifier. For XLR PRO radios to communicate, you must configure them with the same network identifier. The PL (power level) command sets the transmit (TX) power level. You can reduce the power level from the maximum to reduce current power consumption or to test at short distances.

  • Page 40: Make A Broadcast Transmission

    The XLR PRO RF Module uses patented technology that allows the destination device to receive unicast transmissions directed to it, even when there is a large amount of traffic. This works best if you keep broadcast transmissions to a minimum.

  • Page 41: Transmission Timeouts

    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 42: At Commands

    MAC/PHY commands Diagnostic commands Network commands Addressing commands Addressing discovery and configuration commands Security commands Serial interfacing commands I/O settings commands I/O sampling commands I/O line passing commands Command mode options Firmware commands XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 43: Special Commands

    When you issue a WR command add a 100 millisecond delay or wait for an OK response before issuing any subsequent AT commands. Note Once you issue a WR command, do not send any additional characters to the device until after you receive the OK response. Parameter range XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 44: Mac/Phy Commands

    Range An integer from 0 through 8: Value Description 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 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 45: Power Level)

    Set or read the number of additional MAC-level broadcast transmissions. All broadcast packets are transmitted MT+1 times to ensure they are received. Parameter range 0x0 - 0x8 Default Diagnostic commands The following commands are diagnostic commands. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 46: Db (Received Signal Strength)

    You can reset the counter to any 16-bit value within the valid range by appending a hexadecimal value to the GD command. GD is a volatile value—that is, the value does not persist across device resets. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 47: Tr (Transmission Failure Count)

    Parameter range [read-only] Default 0x267 %8 (MAC Broadcast One Hop Time) The MAC broadcast one hop time timeout in milliseconds. If you change MAC parameters, it can change this value. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 48: N? (Network Discovery Timeout)

    0. If BH is set to a value greater than the value for NH (Network Hops), then the NH value is used. Parameter range An integer from 0 through 4. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 49: Nh (Network Hops)

    Default Addressing commands The following AT commands are addressing commands. SH (Serial Number High) Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XLR PRO in the factory. Parameter range 0 - 0xFFFFFFFF [read-only]...

  • Page 50: Dh (Destination Address High)

    Point-to-point/mulitpoint, ACK disabled 0x80 Repeater/Directed broadcast, ACK enabled 0x81 Repeater/Directed broadcast, ACK disabled When you set BR to 0 the TO option has the DigiMesh and Repeater mode disabled automatically. Default 0x40 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 51: Ni (Node Identifier)

    AT commands Addressing commands NI (Node Identifier) Sets or displays a string identifier for the XLR PRO. The NI string identifier is returned by the (Network Discover) command. The NI string identifier can also be used by the DN (Discover Node) command to set the destination address—DL (Destination Address Low)

  • Page 52: Ci (Cluster Id)

    Default 0x11 DE (Destination Endpoint) Sets or displays the application layer destination ID value. The value is used as the destination endpoint for all data transmissions. The default value (0xE8) is the Digi data endpoint. Parameter range Value Description 0xE6...

  • Page 53: Addressing Discovery And Configuration Commands

    Sets or displays the application layer source endpoint value used for data transmissions. This command only affects outgoing transmissions in transparent mode (AP=0). 0xE8 is the Digi data endpoint used for outgoing data transmissions. 0xE6 is the Digi device object endpoint used for configuration and commands. Parameter range Value...

  • Page 54: Fn (Find Neighbors)

    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 settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on settings.) <CR> After the number of milliseconds set by the...

  • Page 55: Security Commands

    The following AT commands are serial interfacing commands. BD (Baud Rate) Sets or displays the serial baud rate for the XLR PRO. To set a non-standard baud rate, enter a value above 0x5B9. BD adjusts the value to the closest supported baud rate.

  • Page 56: Sb (Stop Bits)

    Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet. Parameter range 0 - 0xFF (x character times) Default FT (Flow Control Threshold) Set or display the flow control threshold. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 57: Ap (Api Mode)

    Sets or displays the API data frame output format for received frames. Applies to both UART and SPI interfaces. Parameter range 0, 1 Value Description API RX indicator (0x90) API Explicit RX indicator (0x91) Default XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 58: I/O Settings Commands

    Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (pin 20). Parameter range 0, 2 - 5 Parameter Description Disabled Commissioning button Digital input Digital output, low Digital output, high PTI_EN Default XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 59: D2 (Dio2/Ad2)

    0, 2 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default D4 (DIO4) Sets or displays the DIO4 configuration (pin 26). Parameter range 0, 3 - 5 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 60: D5 (Dio5/Associated_Indicator)

    Parameter Description Disabled Associate LED indicator Digital input Digital output, default low Digital output, default high Default D6 (DIO6/RTS) Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 61: D7 (Dio7/Cts)

    Default D8 (DIO8/DTR/SLP_RQ) Sets or displays the DIO8/DTR/SLP_RQ configuration (pin 30). The XLR PRO RF Module does not support sleep. The SLEEP_REQUEST option is provided for compatibility purposes and does not affect the device. Parameter range 0, 1, 3 - 5...

  • Page 62: D9 (Dio9/On_Sleep)

    ON/SLEEP output Digital input Digital output, low Digital output, high Default DIO10/PWM0/RSSI Sets or displays the PWM0/RSSI/DIO10 configuration (pin 36). Parameter range 0 - 5 Parameter Description Disabled RSSI PWM0 output PWM0 output XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 63: P1 (Dio11/Pwm1 Configuration)

    Digital output, high Default P2 (DIO12 Configuration) Sets or displays the DIO12 configuration (pin 40). Parameter range 0, 3 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 64: P3 (Dio13/Dout)

    0 - 1 Parameter Description Disabled UART DIN/CONFIG enabled Default P5 (DIO15/SPI_MISO) Sets or displays the DIO15/SPI_MISO configuration (pin 35). Parameter range 0, 1 0, 1, 4, 5 Parameter Description Disabled SPI_MISO XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 65: P6 (Spi_Mosi Configuration)

    Parameter Description Disabled SPI_MOSI Digital output, low Digital output, high Default P7 (DIO17/SPI_SSEL ) Sets or displays the DIO17/SPI_SSEL configuration (pin 31). Parameter range 0, 1, 4, 5 Parameter Description Disabled SPI_SSEL XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 66: P8 (Dio18/Spi_Clk)

    Digital output, high Default P9 (DIO19/SPI_ATTN) Sets or displays the DIO19/SPI_ATTN configuration (pin 29). The options include SPI nAttention, and PTI Trace data line for packet capture. Parameter range 0, 1, 4 - 6 XLR PRO Radio Frequency (RF) Module User Guide...

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

    PD (Pull Up/Down Direction) The resistor pull direction bit field (1 = pull-up, 0 = pull-down) for corresponding I/O lines that are set by the PR command. Parameter range 0x0 - 0xFFFFF XLR PRO Radio Frequency (RF) Module User Guide...

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

    I/O line Module pin DIO4/AD4 DIO3/AD3 DIO2/AD2 DIO1/AD1 DIO0/AD0 DIO6/RTS DIO8/DTR/SLEEP_REQUEST DIO14/DIN/CONFIG DIO5/ASSOCIATE DIO9/On/SLEEP DIO12 DIO10/RSSI/PWM0 DIO11/PWM1 DIO7/CTS DIO13/DOUT DIO15/SPI_MISO DIO16/SPI_MOSI DIO17/SPI_SSEL DIO18/SPI_SCLK DIO19/SPI_ATTN Parameter range 0 - 0xFFFFF (bit field) Default 0xFFFFF XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 69: M0 (Pwm0 Duty Cycle)

    (DIO5/Associate pin), this value determines the on and off blink times for the LED. The XLR PRO RF Module does not use network authentication or synchronized sleep support, so the Associate LED steadily blinks regardless of the current network status.

  • Page 70: I/O Sampling Commands

    DIO0 through DIO12 can be sampled using a Change Detect. Set unused bits to 0. I/O line Module pin DIO0 DIO1 DIO2 DIO3 DIO4 DIO5 DIO6 DIO7 DIO8 DIO9 DIO10 DIO11 DIO12 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 71: Ir (Sample Rate)

    Default TP (Temperature) Displays the temperature of the XLR PRO RF Module in degrees Celsius. The temperature value is displayed in 8-bit two’s compliment format. For example, 0x1A = 26 °C, and 0xF6 = -10 °C. Because the XLR PRO RF Module produces heat, this temperature reading is usually above the ambient temperature.

  • Page 72: I/O Line Passing Commands

    Specifies how long pin D0 holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 73: T1 (D1 Timeout)

    T5 (D5 Timeout) Specifies how long pin D5 holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 74: T6 (D6 Timeout)

    0 - 0x1770 (x 100 ms) Default Q0 (P0 Timeout) Specifies how long pin P0 holds a given value before it reverts to configured value. If set to 0, there is no timeout. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 75: Q1 (P1 Timeout)

    Specifies how long pin P4 holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 76: Pwm Output Timeout)

    Sets or displays the ASCII sequence character to use for entering Command mode. Repeating the CC character three times causes the XLR PRO to enter Command mode. The device responds with OK\r when Command mode is successfully entered. The following commands are related to CC: GT (Guard Times) to define a guard time—the amount of time before and after entering a...

  • Page 77: Gt (Guard Times)

    Display the hardware version number of the device. Parameter range Default DD (Device Type Identifier) Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. If you change DD, RE (Restore Defaults) will not restore defaults. The only way to get DD back to default values is to explicitly set it to defaults.

  • Page 78: Np (Maximum Packet Payload Bytes)

    Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. This command allows you to detect an unexpected configuration change on a device. After a firmware update this command may return a different value. Parameter range 0 - 0xFFFF Default XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 79: Operate In Api Mode

    Operate in API mode API mode overview Use the AP command to set the operation mode API frame format API serial exchanges Code to support future API frames API frames XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 80: Api Mode Overview

    API mode overview API mode overview By default, the XLR PRO RF Module acts as a serial line replacement (Transparent operation), it queues all UART data that it receive through the DI pin for RF transmission. When the device receives an RF packet, it sends the data out the DO pin with no additional information.

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

    1 byte Any data received prior to the start delimiter is silently 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.

  • Page 82: Length Field

    To test data integrity, a checksum is calculated and verified on non-escaped data. To calculate: Not including frame delimiters and length, add all bytes keeping only the lowest 8 bits of the result and subtract the result from 0xFF. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 83: Api Serial Exchanges

    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. To disable the response, set the frame ID to 0 in the request.

  • Page 84: Api Frames

    Command name: two ASCII characters that identify the AT command. command Parameter If present, indicates the requested parameter value to set the given register. value If no characters are present, it queries the register. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 85 Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x04 Frame type 0x08 Frame ID 0x52 AT command 0x4E (N) 0x48 (H) Parameter value (NH2 = two network hops) 0x02 Checksum 0x0D XLR PRO Radio Frequency (RF) Module User Guide...

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

    Command name: two ASCII characters that identify the AT command. Parameter value 7-n If present, indicates the requested parameter value to set the given register. If no characters are present, queries the register. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 87: Transmit Request Frame - 0X10

    Up to NP bytes per packet. Sent to the destination device. 17-n Example The example shows how to send a transmission to a device if you disable escaping (AP = 1), with destination address 0x0013A200 400A0127, and payload “TxData0A”. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 88 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x7D 0x33 The device calculates the checksum (on all non-escaped bytes) as [0xFF - (sum of all bytes from API frame type through data payload)]. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 89: Explicit Addressing Command Frame - 0X11

    Broadcast If set to 0, the transmission radius set to the network maximum hops value. radius Transmission options Up to NP bytes per packet. Sent to the destination device. Data payload 23-n XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 90 Destination endpoint: 0xE8 Cluster ID: 0x11 Profile ID: 0xC105 Payload: TxData Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x1A Frame type 0x11 Frame ID 0x01 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 91 0xFF 0xFE Source endpoint 0xE8 Destination endpoint 0xE8 Cluster ID 0x00 0x11 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Data payload 0x54 0x78 0x44 0x61 0x74 0x61 Checksum 0xDD XLR PRO Radio Frequency (RF) Module User Guide...

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

    In this example, the 64-bit address of the remote device is 0x0013A200 40401122. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x10 0x17 Frame type Frame ID 0x01 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 93 MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF 0xFE Remote command options 0x02 (apply changes) AT command 0x42 (B) 0x48 (H) Command parameter 0x01 Checksum 0xF5 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 94: At Command Response Frame - 0X88

    Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x05 Frame type 0x88 Frame ID 0x01 AT command 0x42 (B) 0x44 (D) Command status 0x00 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 95 Operate in API mode API frames Frame data fields Offset Example Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 96: Modem Status Frame - 0X8A

    When a device powers up, it returns the following API frame. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 LSB 2 0x02 Frame type 0x8A Status 0x00 Checksum 0x75 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 97: Transmit Status Frame - 0X8B

    The outgoing Transmit Request that this response frame uses Frame ID of 0x47. Frame Fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x07 Frame type 0x8B Frame ID 0x47 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 98 Operate in API mode API frames Frame Fields Offset Example Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 99: Receive Packet Frame - 0X90

    RxData. If AO=0 on the receiving device, it sends the following frame out its serial interface. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x12 0x90 Frame type XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 100 Example MSB 4 0x00 64-bit source address 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Receive options 0x01 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x11 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 101: Explicit Rx Indicator Frame - 0X91

    With source and destination endpoints of 0xE0 Cluster ID = 0x2211 Profile ID = 0xC105 If AO = 1 on the receiving device, it sends the following frame out its serial interface. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 102 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Source endpoint 0xE0 Destination endpoint 0xE0 Cluster ID 0x22 0x11 Profile ID 0xC1 0x05 Receive options 0x02 Received data 0x52 0x78 0x44 0x61 0x74 0x61 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 103: Remote Command Response Frame - 0X97

    SL command, and if the frame ID = 0x55, the response would look like the following example. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x13 Frame type 0x97 Frame ID 0x55 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 104 64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12 0xAA Reserved 0xFF 0xFE AT commands 0x53 0x4C Command status 0x00 Command data 0x40 0x52 0x2B 0xAA Checksum 0xF4 XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 105 Advanced application features Monitor I/O lines I/O line passing Work with networked devices General Purpose Flash Memory Over-the-air (OTA) firmware updates XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 106: Monitor I/O Lines

    AD0 / DIO0 / Commissioning Pushbutton Use the PR command to enable internal pull up/down resistors for each digital input. Use the PD command to determine the direction of the internal pull up/down resistor. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 107 If you issue the IS command using a a local or remote AT Command API frame, then the device returns an AT Command Response (0x88) frame with the I/O data included in the command data portion of the packet. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 108: Periodic I/O Sampling

    IR samples, the bottom graph shows a combination of IR samples and IC (Change Detect). In the top graph, the humps indicate that the sample was not taken at that exact moment and needed to wait for the next IR sample period. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 109: I/O Line Passing

    For example: DI5 (pin 28) can only update DO5 (pin 28). For Analog Line Passing, the XLR PRO RF Module has two PWM output pins that simulate the voltage measured by the ADC lines AD0 and AD1. For example, when configured as an ADC, AD0 (pin 18) updates PWM0 (pin 36);...

  • Page 110: Work With Networked Devices

    You can use the PD command to change the direction of the internal pull- up/down resistors. The XLR PRO RF Module uses an internal reference voltage of 2.5 V for ADC lines, but you can use the AV command to set it to 1.25 VDC.

  • Page 111: Network Commissioning And Diagnostics

    API frame out its UART. The remote command response indicates: 1. The status of the command, which is either success or the reason for failure. 2. In the case of a command query, it includes the register value. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 112: Test Links In A Network - Loopback Cluster

    To request that device B perform a link test against device A: 1. Use device A in API mode (AP = 1) to send an Explicit Addressing Command (0x11) frame to device B. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 113 B (SH/SL=0x0013A 200 4052ABCD) by transmitting 1000 40-byte packets: Send the following API packet to the serial interface of device A. In the following example packet, whitespace marks fields, bold text is the payload portion of the packet: XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 114 For more information on the node identifier string, see NI (Node Identifier). ND is useful for generating a list of all device addresses in a network. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 115: General Purpose Flash Memory

    0x88. General Purpose Flash Memory XLR PRO RF Modules provide 119 512-byte blocks of flash memory that an application can read and write to. This memory provides a non-volatile data storage area that an application uses for many purposes. Some common uses of this data storage include:...
  • Page 116 * Specify multi-byte parameters with big-endian byte ordering. PLATFORM_INFO_REQUEST (0x00) A PLATFORM_INFO_REQUEST frame can be sent to query details of the GPM structure. Field name Command-specific description GPM_CMD_ID Should be set to PLATFORM_INFO_REQUEST (0x00). XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 117 ERASE command to erase all blocks of the GPM by setting the GPM_NUM_BYTES field to 0. Field name Command-specific description GPM_CMD_ID Should be set to ERASE (0x01). GPM_OPTIONS There are currently no options defined for the ERASE command. Set this field to 0. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 118 GPM block, make sure all the bytes have first been erased. The ERASE_THEN_WRITE command performs an ERASE of the entire GPM block specified with the GPM_BLOCK_NUM field prior to doing a WRITE. XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 119 7E 002B 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 C0 02 00 0016 0000 000F 0102030405060708090A0B0C0D0E0F C5 Assuming all transmissions were successful and that flash block 22 was previously erased, the following API packets would be output the source node's serial interface: XLR PRO Radio Frequency (RF) Module User Guide...
  • Page 120 0x0013a200407402ac a READ packet should be formatted as follows (spaces added to delineate fields): 7E 001C 11 01 0013A200407402AC FFFE E6 E6 0023 C105 00 C0 04 00 0016 0000 000F 3B XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 121: Work With Flash Memory

    This field is unused for this command. Set to 0. GPM_DATA This field is unused for this command Work with flash memory When working with the General Purpose Memory, observe the following limitations: XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 122: Over-The-Air (Ota) Firmware Updates

    GPM WRITE frame is flexible and can be catered to the user 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.

  • Page 123: Verify 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 installation process can take up to 8 seconds. During the installation the XLR PRO will be unresponsive to both serial and RF communication.

  • Page 124: Configure The Xlr Pro Rf Module Using Xctu

    Configure the XLR PRO RF Module using XCTU Download and install XCTU Connect XLR PRO to your PC Launch XCTU and add the XLR PRO Configure parameters using XCTU Update firmware with XCTU XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 125: Download And Install Xctu

    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 126: Update Firmware With Xctu

    To update firmware using XCTU: 1. Launch XCTU. 2. Click Add devices or Discover devices to add the XLR PRO to the list of radios. Select the COM port to which the XLR PRO serial interface is connected. Select the baud rate (9600 8-N-1 by default).
  • Page 127 Safety notices and certifications Before installing and powering on the XLR PRO, read all instructions and keep these instructions in a safe place for future reference. Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment.

  • Page 128: Safety Notices And Certifications

    Canada. FCC (United States) certification The XLR PRO 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 operate under Digi International FCC Certification, RF modules/integrators must comply with the following regulations: 1.

  • Page 129: Fcc Limited Modular Approval

    Final antenna installation and operating configurations of this transmitter including antenna gain and cable loss must not exceed the EIRP of the configuration used for calculating MPE. Grantee (Digi) must coordinate with OEM integrators to ensure the end-users and installers of products operating with the module are provided with operating instructions to satisfy RF exposure requirements.

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

    énumérés ci?dessous et ayant un gain admissible maximal et l'impédance requise pour chaque type d'antenne. Les types d'antenne non inclus dans cette liste, ou dont le gain est supérieur au gain maximal indiqué, sont strictement interdits pour l'exploitation de l'émetteur. XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 131: Australia (Rcm) [Pending]

    The maximum EIRP for the FCC (United States) and IC (Canada) is 36 dBm. The XLR PRO modules comply with the requirements to be used in end products in Australia. All products with EMC and radio communications must have registered RCM marks. Registration to use the compliance mark will only be accepted from Australian manufacturers or importers, or their agents.

  • Page 132: Omni-Directional Antennas

    Antennas Omni-directional antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Minimum cable loss or TX power reduction Gain required in dB Part number Type...
  • Page 133 OMNI RPTNC Fixed/mobile 0 A09-H OMNI RPSMA Fixed A09-HBMMP61 OMNI MMCX Fixed/mobile 0 A09-QBMMP61 OMNI MMCX Fixed/mobile 0 A09-QSM-3 OMNI RPSMA Fixed/mobile 0 A09-QSM-3H OMNI RPSMA Fixed/mobile 0 A09-QBMM-P61 OMNI MMCX Fixed/mobile 0 XLR PRO Radio Frequency (RF) Module User Guide...

  • Page 134: Yagi Antennas

    RPTNC 13.1 Fixed/Mobile 7.1 A09-Y14TM 10-Element Yagi RPTNC 14.1 Fixed/Mobile 8.1 A09-Y14TM 12-Element Yagi RPTNC 14.1 Fixed/Mobile 8.1 A09-Y15TM 13-Element Yagi RPTNC 15.1 Fixed/Mobile 9.1 A09-Y15TM 15-Element Yagi RPTNC 15.1 Fixed/Mobile 9.1 Max gain 15.1 XLR PRO Radio Frequency (RF) Module User Guide...

Table of Contents