Power

SCPI Command:

CONFigure:GPRF:MEASurement<Instance>:POWer:TOUT
CONFigure:GPRF:MEASurement<Instance>:POWer:SLENgth
CONFigure:GPRF:MEASurement<Instance>:POWer:MLENgth
CONFigure:GPRF:MEASurement<Instance>:POWer:REPetition
CONFigure:GPRF:MEASurement<Instance>:POWer:RCOupling
CONFigure:GPRF:MEASurement<Instance>:POWer:SCOunt
class PowerCls[source]

Power commands group definition. 9 total commands, 1 Subgroups, 6 group commands

get_mlength() float[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:MLENgth
value: float = driver.configure.gprfMeasurement.power.get_mlength()

Sets the time interval used to calculate one set of ‘Current’ power result (RMS value, minimum and maximum) . The maximum allowed value is limited by the step length, see method RsCma.Configure.GprfMeasurement.Power.slength.

return:

meas_length: Range: 10E-6 s to StepLength, Unit: s

get_rcoupling() bool[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:RCOupling
value: bool = driver.configure.gprfMeasurement.power.get_rcoupling()

Couples the repetition mode (single shot or continuous) of all measurements.

return:

repetition_coupl: OFF | ON

get_repetition() Repeat[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:REPetition
value: enums.Repeat = driver.configure.gprfMeasurement.power.get_repetition()

Selects whether the measurement is repeated continuously or not.

return:

repetition: SINGleshot | CONTinuous SINGleshot Single-shot measurement, stopped after one measurement cycle CONTinuous Continuous measurement, running until explicitly terminated

get_scount() int[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:SCOunt
value: int = driver.configure.gprfMeasurement.power.get_scount()

Specifies the number of measurement intervals per measurement cycle. One measurement interval delivers one ‘Current’ power result.

return:

statistic_count: Range: 1 to 100E+3

get_slength() float[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:SLENgth
value: float = driver.configure.gprfMeasurement.power.get_slength()

Sets the time between the beginning of two consecutive measurement intervals.

return:

step_length: Range: 50E-6 s to 1 s, Unit: s

get_timeout() float[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:TOUT
value: float = driver.configure.gprfMeasurement.power.get_timeout()

Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated via the graphical user interface. The timer is reset after the first measurement cycle. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped and the reliability indicator is set to 1. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.

return:

tcd_timeout: Unit: s

set_mlength(meas_length: float) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:MLENgth
driver.configure.gprfMeasurement.power.set_mlength(meas_length = 1.0)

Sets the time interval used to calculate one set of ‘Current’ power result (RMS value, minimum and maximum) . The maximum allowed value is limited by the step length, see method RsCma.Configure.GprfMeasurement.Power.slength.

param meas_length:

Range: 10E-6 s to StepLength, Unit: s

set_rcoupling(repetition_coupl: bool) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:RCOupling
driver.configure.gprfMeasurement.power.set_rcoupling(repetition_coupl = False)

Couples the repetition mode (single shot or continuous) of all measurements.

param repetition_coupl:

OFF | ON

set_repetition(repetition: Repeat) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:REPetition
driver.configure.gprfMeasurement.power.set_repetition(repetition = enums.Repeat.CONTinuous)

Selects whether the measurement is repeated continuously or not.

param repetition:

SINGleshot | CONTinuous SINGleshot Single-shot measurement, stopped after one measurement cycle CONTinuous Continuous measurement, running until explicitly terminated

set_scount(statistic_count: int) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:SCOunt
driver.configure.gprfMeasurement.power.set_scount(statistic_count = 1)

Specifies the number of measurement intervals per measurement cycle. One measurement interval delivers one ‘Current’ power result.

param statistic_count:

Range: 1 to 100E+3

set_slength(step_length: float) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:SLENgth
driver.configure.gprfMeasurement.power.set_slength(step_length = 1.0)

Sets the time between the beginning of two consecutive measurement intervals.

param step_length:

Range: 50E-6 s to 1 s, Unit: s

set_timeout(tcd_timeout: float) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:TOUT
driver.configure.gprfMeasurement.power.set_timeout(tcd_timeout = 1.0)

Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated via the graphical user interface. The timer is reset after the first measurement cycle. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped and the reliability indicator is set to 1. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.

param tcd_timeout:

Unit: s

Cloning the Group

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

Subgroups