Iperf¶

SCPI Commands

INITiate:DATA:MEASurement<MeasInstance>:IPERf
STOP:DATA:MEASurement<MeasInstance>:IPERf
ABORt:DATA:MEASurement<MeasInstance>:IPERf
READ:DATA:MEASurement<MeasInstance>:IPERf
FETCh:DATA:MEASurement<MeasInstance>:IPERf

class Iperf[source]

Iperf commands group definition. 13 total commands, 5 Sub-groups, 5 group commands

class ResultData[source]

Response structure. Fields:

Reliability: int: No parameter help available
Up_Bandwidth: float: No parameter help available
Down_Bandwidth: float: No parameter help available

abort() → None[source]

# SCPI: ABORt:DATA:MEASurement<Instance>:IPERf
driver.data.measurement.iperf.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[source]

# SCPI: ABORt:DATA:MEASurement<Instance>:IPERf
driver.data.measurement.iperf.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 RsCmwDau.utilities.opc_timeout_set() to set the timeout value.

fetch() → ResultData[source]

# SCPI: FETCh:DATA:MEASurement<Instance>:IPERf
value: ResultData = driver.data.measurement.iperf.fetch()

No command help available

return

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

initiate() → None[source]

# SCPI: INITiate:DATA:MEASurement<Instance>:IPERf
driver.data.measurement.iperf.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[source]

# SCPI: INITiate:DATA:MEASurement<Instance>:IPERf
driver.data.measurement.iperf.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 RsCmwDau.utilities.opc_timeout_set() to set the timeout value.

read() → ResultData[source]

# SCPI: READ:DATA:MEASurement<Instance>:IPERf
value: ResultData = driver.data.measurement.iperf.read()

No command help available

return

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

stop() → None[source]

# SCPI: STOP:DATA:MEASurement<Instance>:IPERf
driver.data.measurement.iperf.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[source]

# SCPI: STOP:DATA:MEASurement<Instance>:IPERf
driver.data.measurement.iperf.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 RsCmwDau.utilities.opc_timeout_set() to set the timeout value.

Cloning the Group

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

Subgroups