Throughput tool

The Throughput tool allows you to measure the transfer ratio between two radio modules in the same network. To perform a throughput measure, you need to have a local radio module added to XCTU and a remote device in the same network as the local one.

To open the Throughput tool, select Throughput from the Tools drop-down menu on the main XCTU toolbar.

Throughput dialog

Use the Throughput dialog to measure the transfer ratio between two radio modules in the same network. For instructions, see Measure the transfer ratio between two radio modules.

Device selection

Use the Device selection section to designate the local device that will perform the throughput and the remote device that receives the data:

Select the local radio device

Field/button Description
Local device list

Populates with devices currently added to XCTU. Select the device you want to use in the throughput session. The list provides the following information about each local device:

  • MAC address
  • Device name
  • Protocol
  • Operating mode

Discovers remote devices for the selected local device.

Select the remote radio device

The remote device selection can be performed in four ways:

Field Description
Discovered device

Displays a list of any remote devices discovered for the selected local device. Only devices whose protocols support node discovery list remote devices.
Specify 64-bit address

Allows a user to manually enter the 64-bit address of the destination device.

 
Specify 16-bit address

Allows a user to manually enter the 16-bit address of the destination device.
Specify IPv6 address Allows a user to manually enter the IPv6 address of the destination device. Only supported by Thread modules.

Note Not all protocols support node discovery. Only devices that support node discovery list remote devices.

Note Not all protocols support IPv6, 64 and 16-bit addressing. Devices that do not support any of these mechanisms display an error at the top of the page.

Throughput session configuration

You can configure the following throughput session options from within the Throughput tool:

Field Description
Throughput type

Determines the type of throughput process to perform. Available options include:

  • Unidirectional: Sends data from the local device to the remote device. Before sending the next packet of data, it waits for the transmission status of the previous one.

  • Unidirectional (UDP): Sends data from the local device to the remote device using UDP protocol. Before sending the next packet of data, it waits for the transmission status of the previous one. Only supported by Thread modules.

  • Unidirectional CoAP: Sends data from the local device to the remote device using CoAP protocol. Before sending the next packet of data, it waits for the CoAP transmission status of the previous one. Only supported by Thread modules.

  • Bidi - Cluster ID 0x12: Sends data from the local device to the remote one and waits for the data receipt from the remote device. The transmission is performed using explicit addressing frames/packets directed to the Cluster ID 0x12 which returns the sent message.

Note Not all protocols and operating modes support Bidi - Cluster ID 0x12 Throughput type. Devices that do not support it display an error at the top of the page.

  • Bidi - Loopback: Same as previous bidirectional mode, this one also waits for the data back from the remote device before sending the next block of data. The data back is performed using the serial port/USB hardware loopback capabilities. Specific user actions are required to use this mechanism. See Special considerations. This method is valid for local modules working in both AT and API operating modes.

  • Bidi - Loopback (UDP): Bidirectional mode. Sends data from the local device to the remote one using UDP protocol and waits for the data receipt from the remote device before sending the next block of data. The data back is performed using the serial port/USB hardware loopback capabilities. Specific user actions are required to use this mechanism. See Special considerations. This method is valid only for Thread modules working either in AT or API operating modes.

  • Bidi - Loopback (CoAP): Same as Bidi - Loopback (UDP) but using CoAP protocol. Specific user actions are required to use this mechanism. See Special considerations. See Special considerations. This method is valid only for Thread modules working either in AT or API operating modes

Note Loopback throughput sessions require the remote device to be in AT (transparent) mode.

Packet payload

Allows you to configure the packet payload that will be sent to the remote device. Opens a new window where you can configure different payload values by operating mode of the local radio module (AT or API):

 

Local module working in API mode:

Local module working in AT mode:

Note In API mode the payload length is limited by the protocol. In AT mode the payload length is unlimited.

  • Payload timeout: This is the time that the Throughput session waits to receive the transmit status packet (when the throughput type is unidirectional) or the data back from the module (when the throughput type is bidirectional). The bigger the payload is the greater this time should be.
Duration

Determines the duration of the Throughput session. Available options include:

 

  • Time (s): Establishes the minimum duration of the session in seconds. The process sends data packets to the remote device until this time is reached.
  • Packets: The duration of the session is established by the number of packets configured in this field. Bear in mind that depending on the packet payload, a packet can take several seconds to be sent.
  • Loop infinitely: The process sends packets infinitely until the throughput session is stopped manually.
Time window Configures the visible time window of the transfer ration measured by the throughput session.

When you have configured all the options, click the Start Throughput button to start measuring the transfer ratio of your radio module.

You can stop the process at any time by pressing the same button, now showing the text Stop Throughput.

 

Data representation

The chart in the tool represents the instant transfer ratio and the average transfer ratio.

Field Description
Transfer ratio chart

Displays the instant transfer ratio with a light blue area and the average transfer ratio as a dark blue line. The instant transfer ratio is calculated every 250ms or every time a packet is sent if sending takes longer than 250ms. You can hide and show chart data by checking or unchecking Transfer ratio and Avg. transfer ratio.

 
Transfer ratio values

Displays the instant and average transfer ratio as packets are sent to the remote module during the session.

 
Session statistics

Displays session statistics such as the number of packets sent to the remote device, the number of transferred bytes, and the duration of the session.

 

Supported products

Throughput is only supported in these protocols:

Special considerations

There are some special considerations to be aware of while working with the Throughput tool.

When the local module is working in AT (transparent) mode, the tool automatically performs configuration steps in the module before starting the throughput session, and after finishing or stopping it. A progress bar shows the level of completion for this process: