ExtPwrSensor

SCPI Commands :

INITiate:GPRF:MEASurement<Instance>:EPSensor
STOP:GPRF:MEASurement<Instance>:EPSensor
ABORt:GPRF:MEASurement<Instance>:EPSensor
FETCh:GPRF:MEASurement<Instance>:EPSensor:IDN
FETCh:GPRF:MEASurement<Instance>:EPSensor
READ:GPRF:MEASurement<Instance>:EPSensor
class ExtPwrSensorCls[source]

ExtPwrSensor commands group definition. 8 total commands, 1 Subgroups, 6 group commands

class ResultData[source]

Response structure. Fields:

  • Reliability: int: decimal See ‘Reliability indicator’

  • Current_Power: float: float Unit: dBm

  • Average_Power: float: float Unit: dBm

  • Minimum_Power: float: float Unit: dBm

  • Maximum_Power: float: float Unit: dBm

  • Elapsed_Stat: int: decimal Elapsed measurement cycles

abort(opc_timeout_ms: int = -1) → None[source]
# SCPI: ABORt:GPRF:MEASurement<Instance>:EPSensor
driver.extPwrSensor.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[source]
# SCPI: FETCh:GPRF:MEASurement<Instance>:EPSensor
value: ResultData = driver.extPwrSensor.fetch()

Returns all results of the EPS measurement.

return:

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

get_idn() → str[source]
# SCPI: FETCh:GPRF:MEASurement<Instance>:EPSensor:IDN
value: str = driver.extPwrSensor.get_idn()

Returns the identification string of the connected external sensor.

return:

idn: string

initiate(opc_timeout_ms: int = -1) → None[source]
# SCPI: INITiate:GPRF:MEASurement<Instance>:EPSensor
driver.extPwrSensor.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[source]
# SCPI: READ:GPRF:MEASurement<Instance>:EPSensor
value: ResultData = driver.extPwrSensor.read()

Returns all results of the EPS measurement.

return:

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

stop(opc_timeout_ms: int = -1) → None[source]
# SCPI: STOP:GPRF:MEASurement<Instance>:EPSensor
driver.extPwrSensor.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.

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.extPwrSensor.clone()

Subgroups