Preset

SCPI Commands :

USERdefined:PRESet:OPEN
USERdefined:PRESet:SAVE
USERdefined:PRESet[:ENABle]
USERdefined:PRESet:NAME

Commands in total: 4

Subgroups: 0

Direct child commands: 4

get_enable() → bool

# USERdefined:PRESet[:ENABle]
value: bool = driver.userDefined.preset.get_enable()

If enabled, the settings from the selected saveset are restored when the Preset key is pressed. If disabled, Preset sets the instrument to the factory defaults. The saveset to be used as preset file is defined with method RsMxo.userDefined.preset.name() .

Returns:

name: OFF | ON

get_name() → str

# USERdefined:PRESet:NAME
value: str = driver.userDefined.preset.get_name()

Sets the path, the filename and the file format of the preset file.

Returns:

name: String with path and filename with extension .set.

open(opc_timeout_ms: int = -1) → None

# USERdefined:PRESet:OPEN
driver.userDefined.preset.open()

Opens and loads the preset file that is defined with method RsMxo.userDefined.preset.name() .

Parameters:

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

save(opc_timeout_ms: int = -1) → None

# USERdefined:PRESet:SAVE
driver.userDefined.preset.save()

Saves the current settings as a preset file. You define the storage location and filename with method RsMxo.userDefined.preset.name() .

Parameters:

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

set_enable(name: bool) → None

# USERdefined:PRESet[:ENABle]
driver.userDefined.preset.set_enable(name = False)

If enabled, the settings from the selected saveset are restored when the Preset key is pressed. If disabled, Preset sets the instrument to the factory defaults. The saveset to be used as preset file is defined with method RsMxo.userDefined.preset.name() .

Parameters:

name – OFF | ON

set_name(name: str) → None

# USERdefined:PRESet:NAME
driver.userDefined.preset.set_name(name = 'abc')

Sets the path, the filename and the file format of the preset file.

Parameters:

name – String with path and filename with extension .set.