ListPy

SCPI Commands :

SOURce:GPRF:GENerator<Instance>:LIST:AINDex
SOURce:GPRF:GENerator<Instance>:LIST:FILL
SOURce:GPRF:GENerator<Instance>:LIST:GOTO
SOURce:GPRF:GENerator<Instance>:LIST:REPetition
SOURce:GPRF:GENerator<Instance>:LIST:STARt
SOURce:GPRF:GENerator<Instance>:LIST:STOP
SOURce:GPRF:GENerator<Instance>:LIST:COUNt
SOURce:GPRF:GENerator<Instance>:LIST

class ListPyCls[source]

ListPy commands group definition. 32 total commands, 13 Subgroups, 8 group commands

class FillStruct[source]

Structure for setting input parameters. Contains optional set arguments. Fields:

Start_Index: float: numeric The start index of the list segment to be ‘filled’. Range: 0 to 1999
Range_Py: float: numeric The range (length) of the list segment to be ‘filled’. Range: 1 to 2000
Index_Repetition: int: integer The constant ‘Index Repetition’ within this list segment. Range: 1 to 10000
Start_Frequency: float: numeric The frequency of list item StartIndex. For the supported frequency range, see ‘Frequency ranges’. Unit: Hz
Freq_Increment: float: numeric The frequency increment within this list segment. Range: -282.45 MHz to 1.20005 GHz , Unit: Hz
Start_Power: float: numeric The RMS level of list item StartIndex. Range: Depends on the instrument model, the connector and other settings; please notice the ranges quoted in the data sheet , Unit: dBm
Power_Increment: float: numeric The power increment within this list segment. Range: -29.5 dBm to 3 dBm , Unit: dBm
Start_Dwell_Time: float: Optional setting parameter. numeric The constant dwell time within this list segment. Range: 2.0E-4 s to 20 s , Unit: s
Reenable: bool: Optional setting parameter. OFF | ON The constant ‘Reenable’ property within this list segment.
Modulation: bool: Optional setting parameter. OFF | ON The constant ‘Modulation ON|OFF’ property within this list segment.
Start_Gain: float: Optional setting parameter. numeric The digital gain of list item StartIndex. Range: -30 dB to 0 dB , Unit: dB
Gain_Increment: float: Optional setting parameter. numeric The digital gain increment within this list segment. Range: -7.5 dB to 0 dB , Unit: dB

get_aindex() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:AINDex
value: int = driver.source.listPy.get_aindex()

Returns the currently active list index.

return:

active_index: decimal Range: 0 to 19

get_count() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:COUNt
value: int = driver.source.listPy.get_count()

Queries the number of frequency/level steps of the RF generator in list mode.

return:

list_count: decimal Number of frequency/level steps in list mode Range: 1 to 2000

get_goto() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:GOTO
value: int = driver.source.listPy.get_goto()

Defines the start index for the second and all following generator cycles in continuous mode (method RsCmwGprfGen.Source. ListPy.repetition) . The index must be in the selected list section (method RsCmwGprfGen.Source.ListPy.Sstop.set) .

return:

goto_index: numeric Range: 1 to 2000

get_repetition() → RepeatMode[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:REPetition
value: enums.RepeatMode = driver.source.listPy.get_repetition()

Defines how often the RF generator runs through the list.

return:

repetition: CONTinuous | SINGle CONTinuous: The generator cycles through the list. SINGle: The generator runs through the list for a single time. The sequence is triggered via method RsCmwGprfGen.Source.ListPy.Esingle.set.

get_start() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:STARt
value: int = driver.source.listPy.get_start()

Defines the number of the first measured frequency/level step in the list. The start index must not be larger than the stop index (see method RsCmwGprfGen.Source.ListPy.stop) .

return:

start_index: numeric Range: 0 to 1999

get_stop() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:STOP
value: int = driver.source.listPy.get_stop()

Defines the number of the last measured frequency/level step in the list. The stop index must not be smaller than the start index (see method RsCmwGprfGen.Source.ListPy.start) .

return:

stop_index: numeric Range: 0 to 1999

get_value() → bool[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST
value: bool = driver.source.listPy.get_value()

Enables or disables the list mode of the RF generator.

return:

enable_list_mode: ON | OFF ON: List mode enabled OFF: List mode disabled (constant-frequency generator)

set_fill(value: FillStruct) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:FILL
structure = driver.source.listPy.FillStruct()
structure.Start_Index: float = 1.0
structure.Range_Py: float = 1.0
structure.Index_Repetition: int = 1
structure.Start_Frequency: float = 1.0
structure.Freq_Increment: float = 1.0
structure.Start_Power: float = 1.0
structure.Power_Increment: float = 1.0
structure.Start_Dwell_Time: float = 1.0
structure.Reenable: bool = False
structure.Modulation: bool = False
structure.Start_Gain: float = 1.0
structure.Gain_Increment: float = 1.0
driver.source.listPy.set_fill(value = structure)

Convenience command to simplify the configuration of the frequency/level list. Within a list segment determined by its start index and range (length) , the frequency, power and (optionally) the digital gain are incremented by configurable step sizes. The other list item settings are fixed.

param value:

see the help for FillStruct structure arguments.

set_goto(goto_index: int) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:GOTO
driver.source.listPy.set_goto(goto_index = 1)

Defines the start index for the second and all following generator cycles in continuous mode (method RsCmwGprfGen.Source. ListPy.repetition) . The index must be in the selected list section (method RsCmwGprfGen.Source.ListPy.Sstop.set) .

param goto_index:

numeric Range: 1 to 2000

set_repetition(repetition: RepeatMode) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:REPetition
driver.source.listPy.set_repetition(repetition = enums.RepeatMode.CONTinuous)

Defines how often the RF generator runs through the list.

param repetition:

CONTinuous | SINGle CONTinuous: The generator cycles through the list. SINGle: The generator runs through the list for a single time. The sequence is triggered via method RsCmwGprfGen.Source.ListPy.Esingle.set.

set_start(start_index: int) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:STARt
driver.source.listPy.set_start(start_index = 1)

Defines the number of the first measured frequency/level step in the list. The start index must not be larger than the stop index (see method RsCmwGprfGen.Source.ListPy.stop) .

param start_index:

numeric Range: 0 to 1999

set_stop(stop_index: int) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST:STOP
driver.source.listPy.set_stop(stop_index = 1)

Defines the number of the last measured frequency/level step in the list. The stop index must not be smaller than the start index (see method RsCmwGprfGen.Source.ListPy.start) .

param stop_index:

numeric Range: 0 to 1999

set_value(enable_list_mode: bool) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:LIST
driver.source.listPy.set_value(enable_list_mode = False)

Enables or disables the list mode of the RF generator.

param enable_list_mode:

ON | OFF ON: List mode enabled OFF: List mode disabled (constant-frequency generator)

Cloning the Group

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

Subgroups