This view allows you to perform a range test, which demonstrates the real-world RF range and link quality between two XBee devices in the same network.

Since communication between XBee RF devices takes place over the air, the quality of the wireless signal can be affected by many factors: absorption, reflection of waves, line-of-sight issues, antenna style and location, etc.

During a range test:

  • XBee Studio sends data packets from the local XBee module to a remote device and waits for the echo response.

  • The tool counts the number of packets sent and received by the local device and measures the signal strength on both sides as RSSI (Received Signal Strength Indicator) values.

  • Each packet sent from the local XBee should be returned as an echo to the same local XBee.

When deploying an actual network, perform multiple range tests to analyze varying conditions in your application.

1. Configure the test

  1. Open the Range test configuration dialog:

    • When you open the range test view without a remote device selected, the configuration dialog opens automatically.

    • You can also open it manually using the toolbar button Configure range test Configure range test button.

  2. Select a remote device from the network:

    1. If no devices are listed, click Discover remote devices to start a network discovery. Wait for the remote devices to be discovered and added to the list.

    2. Select the desired device to perform the test with.

  3. Optionally, configure the following test options:

    Setting Description

    Range test type

    Defines the type of range test to perform.

    Available options include:

    • Software loopback (Cluster ID 0x12): Uses explicit addressing frames/packets directed to the Cluster ID 0x12 at the data endpoint (0xE8), which returns the received data to the sender.

      Not all protocols and operating modes support the Cluster ID 0x12 range test. XBee Studio displays an error message for unsupported devices.

    • Hardware loopback (jumper): Uses the serial port or USB hardware loopback capability. Before starting this test, configure the remote device in transparent mode and close the loopback jumper.

      Works only with remote devices in AT operating mode.

    Packet payload

    Sets the data payload to send during the range test.

    Opens a window for ASCII or HEX input.

    Rx timeout (ms)

    Specifies the maximum time (in milliseconds) to wait for a response from the remote device before marking the packet as lost.

    Tx interval (ms)

    Specifies the minimum time (in milliseconds) between packet transmissions to the remote device.

    Test duration

    Defines the test duration by time (seconds), number of packets, or indefinitely.

    Skip RSSI measurements

    Skips RSSI measurements when enabled.

    This option is available only when the local device is operating in AT (transparent) mode.

2. Run the test

Once a remote device is selected, click Start in the configuration dialog or click the Start range test Start range test button button in the toolbar.

XBee Studio displays the range test results in multiple formats:

Range test dashboard

  • RSSI chart: Displays the RSSI values for the local and remote devices during the test session. The line graph also includes the total packet success rate.

    Toggle chart data visibility by selecting or clearing Local RSSI, Remote RSSI, or Success rate in the legend.

    You adjust the visible time window of the chart to 1 minute (1M), 1 hour (1H), or the full duration (Max), as well as pan, zoom, and hover over points to view exact values.

  • Local RSSI: Displays the instantaneous RSSI value (in dBm) for the last packet received by the local device.

  • Remote RSSI: Displays the instantaneous RSSI value (in dBm) for the last packet received by the remote device.

    When the local device operates in AT (transparent) mode, XBee Studio cannot read the remote device RSSI value.

  • Packet summary: Displays the total number of packets sent and received, transmission errors, and packets lost.

    It also displays the percentage of success sending and receiving packets during the range test session.

You can stop the test at any time by clicking the Stop range test Stop range test button button in the toolbar.

Special considerations

There are some special considerations to be aware of while working with the range test tool:

  • When the local device operates in AT (transparent) mode:

    • The tool automatically applies the necessary configuration before starting and after finishing the test.

      A progress bar indicates this process.

    • The remote device’s RSSI value cannot be read.

  • The hardware loopback test type only works with remote devices in AT (transparent) mode.

  • For hardware loopback tests, connect the loopback jumper or adapter on the remote device before starting, and disconnect it after finishing.

    A dialog box notifies you when this action is required.

3. Export the test results

When the range test finishes, you can export the results in CSV format by clicking the Export range test session Export range test session button in the toolbar.