ListPy

SCPI Commands :

[SOURce<HW>]:LIST:CATalog
[SOURce<HW>]:LIST:DELete
[SOURce<HW>]:LIST:DELete:ALL
[SOURce<HW>]:LIST:FREE
[SOURce<HW>]:LIST:MODE
[SOURce<HW>]:LIST:RESet
[SOURce<HW>]:LIST:RMODe
[SOURce<HW>]:LIST:RUNNing
[SOURce<HW>]:LIST:SELect
Commands in total: 32
Subgroups: 7
Direct child commands: 9
delete(filename: str) → None[source]
# [SOURce<HW>]:LIST:DELete
driver.source.listPy.delete(filename = 'abc')

Deletes the specified list. Refer to ‘Handling files in the default or in a specified directory’ for general information on file handling in the default and in a specific directory.

Parameters:

filename – string Filename or complete file path; file extension is optional.

delete_all() → None[source]
# [SOURce<HW>]:LIST:DELete:ALL
driver.source.listPy.delete_all()

Deletes all lists in the set directory. This command can only be executed, if:

  • No list file is selected.

  • List mode is disabled.

delete_all_with_opc(opc_timeout_ms: int = -1) → None[source]
# [SOURce<HW>]:LIST:DELete:ALL
driver.source.listPy.delete_all_with_opc()

Deletes all lists in the set directory. This command can only be executed, if:

  • No list file is selected.

  • List mode is disabled.

Same as delete_all, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.

Parameters:

opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

get_catalog() → List[str][source]
# [SOURce<HW>]:LIST:CATalog
value: List[str] = driver.source.listPy.get_catalog()

Queries the available list files in the specified directory.

Returns:

catalog: string List of list filenames, separated by commas

get_free() → int[source]
# [SOURce<HW>]:LIST:FREE
value: int = driver.source.listPy.get_free()

Queries the amount of free memory (in bytes) for list mode lists.

Returns:

free: integer Range: 0 to INT_MAX

get_mode() → AutoStepIndex[source]
# [SOURce<HW>]:LIST:MODE
value: enums.AutoStepIndex = driver.source.listPy.get_mode()

Sets the list mode. The instrument processes the list according to the selected mode and trigger source. See LIST:TRIG:SOUR AUTO, SING or EXT for the description of the trigger source settings.

Returns:

mode: AUTO | STEP AUTO Each trigger event triggers a complete list cycle. STEP Each trigger event triggers only one step in the list processing cycle. The list is processed in ascending order. INDex The trigger event triggers the entry of the selected index in the list.

get_rmode() → LmodRunMode[source]
# [SOURce<HW>]:LIST:RMODe
value: enums.LmodRunMode = driver.source.listPy.get_rmode()

Selects the run mode for processing the list.

Returns:

rmode: LEARned | LIVE LEARned Generates the signal by replaying the previously learned and saved data from the temporary memory. LIVE Generates the signal by processing the list directly.

get_running() → bool[source]
# [SOURce<HW>]:LIST:RUNNing
value: bool = driver.source.listPy.get_running()

Queries the current state of the list mode.

Returns:

state: 1 | ON | 0| OFF 1 Signal generation based on the list mode is active.

get_select() → str[source]
# [SOURce<HW>]:LIST:SELect
value: str = driver.source.listPy.get_select()

Selects or creates a data list in list mode. If the list with the selected name does not exist, a new list is created.

Returns:

filename: string Filename or complete file path; file extension can be omitted.

reset() → None[source]
# [SOURce<HW>]:LIST:RESet
driver.source.listPy.reset()

Jumps to the beginning of the list.

reset_with_opc(opc_timeout_ms: int = -1) → None[source]
# [SOURce<HW>]:LIST:RESet
driver.source.listPy.reset_with_opc()

Jumps to the beginning of the list.

Same as reset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.

Parameters:

opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

set_mode(mode: AutoStepIndex) → None[source]
# [SOURce<HW>]:LIST:MODE
driver.source.listPy.set_mode(mode = enums.AutoStepIndex.AUTO)

Sets the list mode. The instrument processes the list according to the selected mode and trigger source. See LIST:TRIG:SOUR AUTO, SING or EXT for the description of the trigger source settings.

Parameters:

mode – AUTO | STEP AUTO Each trigger event triggers a complete list cycle. STEP Each trigger event triggers only one step in the list processing cycle. The list is processed in ascending order. INDex The trigger event triggers the entry of the selected index in the list.

set_rmode(rmode: LmodRunMode) → None[source]
# [SOURce<HW>]:LIST:RMODe
driver.source.listPy.set_rmode(rmode = enums.LmodRunMode.LEARned)

Selects the run mode for processing the list.

Parameters:

rmode – LEARned | LIVE LEARned Generates the signal by replaying the previously learned and saved data from the temporary memory. LIVE Generates the signal by processing the list directly.

set_select(filename: str) → None[source]
# [SOURce<HW>]:LIST:SELect
driver.source.listPy.set_select(filename = 'abc')

Selects or creates a data list in list mode. If the list with the selected name does not exist, a new list is created.

Parameters:

filename – string Filename or complete file path; file extension can be omitted.

Cloning the Group

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

Subgroups