Throughput

SCPI Commands

STOP:GSM:SIGNaling<Instance>:THRoughput
ABORt:GSM:SIGNaling<Instance>:THRoughput
INITiate:GSM:SIGNaling<Instance>:THRoughput
FETCh:GSM:SIGNaling<Instance>:THRoughput
READ:GSM:SIGNaling<Instance>:THRoughput

class Throughput

Throughput commands group definition. 23 total commands, 2 Sub-groups, 5 group commands

class ResultData

Response structure. Fields:

• Reliability: int: decimal See ‘Reliability Indicator’

• Curr_Dl_Pdu: float: float Current, average, maximum and minimum DL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Avg_Dl_Pdu: float: float Current, average, maximum and minimum DL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Max_Dl_Pdu: float: float Current, average, maximum and minimum DL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Min_Dl_Pdu: float: float Current, average, maximum and minimum DL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Curr_Dl_Sdu: float: float Current, average, maximum and minimum DL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Avg_Dl_Sdu: float: float Current, average, maximum and minimum DL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Max_Dl_Sdu: float: float Current, average, maximum and minimum DL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Min_Dl_Sdu: float: float Current, average, maximum and minimum DL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Blocks_Dl_Pdu: int: decimal Number of transmitted RLC PDUs Range: 0 to 1E+6

• Curr_Ul_Pdu: float: float Current, average, maximum and minimum UL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Avg_Ul_Pdu: float: float Current, average, maximum and minimum UL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Max_Ul_Pdu: float: float Current, average, maximum and minimum UL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Min_Ul_Pdu: float: float Current, average, maximum and minimum UL PDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Curr_Ul_Sdu: float: float Current, average, maximum and minimum UL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Avg_Ul_Sdu: float: float Current, average, maximum and minimum UL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Max_Ul_Sdu: float: float Current, average, maximum and minimum UL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Min_Ul_Sdu: float: float Current, average, maximum and minimum UL SDU results Range: 0 bit/s to 100E+6 bit/s , Unit: bit/s

• Blocks_Ul_Pdu: float: float Range: 0 to 1E+6

abort() → None

# SCPI: ABORt:GSM:SIGNaling<instance>:THRoughput
driver.throughput.abort()


    INTRO_CMD_HELP: Starts, stops, or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
    - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

abort_with_opc() → None

# SCPI: ABORt:GSM:SIGNaling<instance>:THRoughput
driver.throughput.abort_with_opc()


    INTRO_CMD_HELP: Starts, stops, or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
    - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

Same as abort, but waits for the operation to complete before continuing further. Use the RsCmwGsmSig.utilities.opc_timeout_set() to set the timeout value.

fetch() → ResultData

# SCPI: FETCh:GSM:SIGNaling<instance>:THRoughput
value: ResultData = driver.throughput.fetch()

Returns all single value throughput results.

return

structure: for return value, see the help for ResultData structure arguments.

initiate() → None

# SCPI: INITiate:GSM:SIGNaling<instance>:THRoughput
driver.throughput.initiate()


    INTRO_CMD_HELP: Starts, stops, or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
    - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

initiate_with_opc() → None

# SCPI: INITiate:GSM:SIGNaling<instance>:THRoughput
driver.throughput.initiate_with_opc()


    INTRO_CMD_HELP: Starts, stops, or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
    - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

Same as initiate, but waits for the operation to complete before continuing further. Use the RsCmwGsmSig.utilities.opc_timeout_set() to set the timeout value.

read() → ResultData

# SCPI: READ:GSM:SIGNaling<instance>:THRoughput
value: ResultData = driver.throughput.read()

Returns all single value throughput results.

return

structure: for return value, see the help for ResultData structure arguments.

stop() → None

# SCPI: STOP:GSM:SIGNaling<instance>:THRoughput
driver.throughput.stop()


    INTRO_CMD_HELP: Starts, stops, or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
    - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

stop_with_opc() → None

# SCPI: STOP:GSM:SIGNaling<instance>:THRoughput
driver.throughput.stop_with_opc()


    INTRO_CMD_HELP: Starts, stops, or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
    - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

Same as stop, but waits for the operation to complete before continuing further. Use the RsCmwGsmSig.utilities.opc_timeout_set() to set the timeout value.

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.throughput.clone()

Subgroups

• State
  • All
• Trace
  • Downlink
    • Sdu
      • Current
      • Average
    • Pdu
      • Current
      • Average
  • Uplink
    • Sdu
      • Current
      • Average
    • Pdu
      • Current
      • Average