Ping¶

SCPI Commands

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

class Ping[source]

Ping commands group definition. 9 total commands, 3 Sub-groups, 5 group commands

class ResultData[source]

Response structure. Fields:

Reliability: int: See ‘Reliability Indicator’
Req_No: List[int]: Request label, 0 = last request, -1 = previous request, and so on Range: -1000 to 0
Timestamp: List[str]: Timestamp as string in the format ‘hh:mm:ss’
Latency: List[float]: Round-trip time for sent packets (0 s = no reply) Range: 0 s to 10 s, Unit: s

abort() → None[source]

# SCPI: ABORt:DATA:MEASurement<Instance>:PING
driver.data.measurement.ping.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>:PING
driver.data.measurement.ping.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>:PING
value: ResultData = driver.data.measurement.ping.fetch()

Queries the measured ping characteristics. After the reliability indicator, three results are returned for each ping request: <Reliability>, {<ReqNo>, <Timestamp>, <Latency>}request 1, {…}request 2, … The number of ping requests is specified by method RsCmwDau.Configure.Data.Measurement.Ping.pcount.

return

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

initiate() → None[source]

# SCPI: INITiate:DATA:MEASurement<Instance>:PING
driver.data.measurement.ping.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>:PING
driver.data.measurement.ping.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>:PING
value: ResultData = driver.data.measurement.ping.read()

Queries the measured ping characteristics. After the reliability indicator, three results are returned for each ping request: <Reliability>, {<ReqNo>, <Timestamp>, <Latency>}request 1, {…}request 2, … The number of ping requests is specified by method RsCmwDau.Configure.Data.Measurement.Ping.pcount.

return

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

stop() → None[source]

# SCPI: STOP:DATA:MEASurement<Instance>:PING
driver.data.measurement.ping.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>:PING
driver.data.measurement.ping.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.ping.clone()

Subgroups