Throughput

SCPI Commands :

STOP:LTE:SIGNaling<instance>:THRoughput
ABORt:LTE:SIGNaling<instance>:THRoughput
INITiate:LTE:SIGNaling<instance>:THRoughput
FETCh:LTE:SIGNaling<instance>:THRoughput
READ:LTE:SIGNaling<instance>:THRoughput

class ThroughputCls

Throughput commands group definition. 15 total commands, 2 Subgroups, 5 group commands

class ResultData

Response structure. Fields:

• Reliability: int: decimal See ‘Reliability indicator’

• Curr_Dl_Pdu: float: float Current downlink throughput Unit: bit/s

• Avg_Dl_Pdu: float: float Average downlink throughput Unit: bit/s

• Max_Dl_Pdu: float: float Maximum downlink throughput Unit: bit/s

• Min_Dl_Pdu: float: float Minimum downlink throughput Unit: bit/s

• Bytes_Dl_Pdu: int: decimal Number of bytes transmitted in the downlink

• Curr_Ul_Pdu: float: float Current uplink throughput Unit: bit/s

• Avg_Ul_Pdu: float: float Average uplink throughput Unit: bit/s

• Max_Ul_Pdu: float: float Maximum uplink throughput Unit: bit/s

• Min_Ul_Pdu: float: float Minimum uplink throughput Unit: bit/s

• Bytes_Ul_Pdu: float: float Number of bytes received in the uplink

abort(opc_timeout_ms: int = -1) → None

# SCPI: ABORt:LTE: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.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

fetch() → ResultData

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

Returns the contents of the RLC throughput result table.

return:

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

initiate(opc_timeout_ms: int = -1) → None

# SCPI: INITiate:LTE: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.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

read() → ResultData

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

Returns the contents of the RLC throughput result table.

return:

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

stop() → None

# SCPI: STOP:LTE: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(opc_timeout_ms: int = -1) → None

# SCPI: STOP:LTE: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 RsCmwLteSig.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

Cloning the Group

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

Subgroups

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