Power

SCPI Commands :

CONFigure:GPRF:MEASurement<Instance>:POWer:MODE
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:SCOunt
CONFigure:GPRF:MEASurement<Instance>:POWer:PDEFset
class PowerCls[source]

Power commands group definition. 48 total commands, 5 Subgroups, 7 group commands

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

Sets the length of the evaluation interval used to measure a single set of current power results. The measurement length cannot be greater than the step length.

return:

meas_length: numeric Unit: s

get_mode() CcdfMode[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:MODE
value: enums.CcdfMode = driver.configure.power.get_mode()

Selects the measurement mode for measurements without list mode. Select the mode before starting the power measurement.

return:

ccdf_mode: No help available

get_pdef_set() str[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:PDEFset
value: str = driver.configure.power.get_pdef_set()

This command is related to the global parameter set. A setting command loads a predefined set of parameters into the global parameter set. A query returns the name of the predefined set assigned to the global parameter set. To get a list of predefined-set strings, use method RsCmwGprfMeas.Configure.Power.ParameterSetList.Catalog.pdefSet.

return:

predefined_set: string

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

Specifies the repetition mode of the measurement. The repetition mode specifies whether the measurement is stopped after a single shot or repeated continuously. Use CONFigure:..:MEAS<i>:…:SCOunt to determine the number of measurement intervals per single shot.

return:

repetition: SINGleshot | CONTinuous SINGleshot: single-shot measurement CONTinuous: continuous measurement

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

Specifies the statistic count of the measurement. The statistic count is equal to the number of measurement intervals per single shot.

return:

statistic_count: numeric Number of measurement intervals Range: 1 to 100E+3

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

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

return:

step_length: numeric Unit: s

get_timeout() float[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:TOUT
value: float = driver.configure.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 manually. When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. 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: numeric Unit: s

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

Sets the length of the evaluation interval used to measure a single set of current power results. The measurement length cannot be greater than the step length.

param meas_length:

numeric Unit: s

set_mode(ccdf_mode: CcdfMode) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:MODE
driver.configure.power.set_mode(ccdf_mode = enums.CcdfMode.POWer)

Selects the measurement mode for measurements without list mode. Select the mode before starting the power measurement.

param ccdf_mode:

POWer | STATistic POWer: ‘Power’ mode STATistic: ‘Statistic’ mode

set_pdef_set(predefined_set: str) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:PDEFset
driver.configure.power.set_pdef_set(predefined_set = 'abc')

This command is related to the global parameter set. A setting command loads a predefined set of parameters into the global parameter set. A query returns the name of the predefined set assigned to the global parameter set. To get a list of predefined-set strings, use method RsCmwGprfMeas.Configure.Power.ParameterSetList.Catalog.pdefSet.

param predefined_set:

string

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

Specifies the repetition mode of the measurement. The repetition mode specifies whether the measurement is stopped after a single shot or repeated continuously. Use CONFigure:..:MEAS<i>:…:SCOunt to determine the number of measurement intervals per single shot.

param repetition:

SINGleshot | CONTinuous SINGleshot: single-shot measurement CONTinuous: continuous measurement

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

Specifies the statistic count of the measurement. The statistic count is equal to the number of measurement intervals per single shot.

param statistic_count:

numeric Number of measurement intervals Range: 1 to 100E+3

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

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

param step_length:

numeric Unit: s

set_timeout(tcd_timeout: float) None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:TOUT
driver.configure.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 manually. When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. 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:

numeric Unit: s

Cloning the Group

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

Subgroups