Rst
SCPI Commands :
USRDefined:RST[:ENABle]
USRDefined:RST:NAME
USRDefined:RST:OPEN
USRDefined:RST:SAVE
- Commands in total: 4Subgroups: 0Direct child commands: 4
- get_enable() bool[source]
# USRDefined:RST[:ENABle] value: bool = driver.usrDefined.rst.get_enable()
If ON, the settings from a previously defined preset file are restored when the Preset key is pressed. The preset file is defined with method
RsRtx.usrDefined.rst.name(). If OFF, Preset sets the instrument to the factory defaults.
- get_name() str[source]
# USRDefined:RST:NAME value: str = driver.usrDefined.rst.get_name()
Sets the path and file name of a user-defined preset file.
- open() None[source]
# USRDefined:RST:OPEN driver.usrDefined.rst.open()
opens and loads a user-defined preset file. Name and path of the preset file are defined with method
RsRtx.usrDefined.rst.name().
- open_and_wait(opc_timeout_ms: int = -1) None[source]
# USRDefined:RST:OPEN driver.usrDefined.rst.open_and_wait()
opens and loads a user-defined preset file. Name and path of the preset file are defined with method
RsRtx.usrDefined.rst.name().Same as open, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
- Parameters:
opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.
- save() None[source]
# USRDefined:RST:SAVE driver.usrDefined.rst.save()
Saves the current instrument settings to a user-defined preset file. Name and path of the preset file are defined with method
RsRtx.usrDefined.rst.name().
- save_and_wait(opc_timeout_ms: int = -1) None[source]
# USRDefined:RST:SAVE driver.usrDefined.rst.save_and_wait()
Saves the current instrument settings to a user-defined preset file. Name and path of the preset file are defined with method
RsRtx.usrDefined.rst.name().Same as save, but waits for the operation to complete before continuing further. Use the RsRtx.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_enable(enab_usr_defined_preset: bool) None[source]
# USRDefined:RST[:ENABle] driver.usrDefined.rst.set_enable(enab_usr_defined_preset = False)
If ON, the settings from a previously defined preset file are restored when the Preset key is pressed. The preset file is defined with method
RsRtx.usrDefined.rst.name(). If OFF, Preset sets the instrument to the factory defaults.- Parameters:
enab_usr_defined_preset – OFF | ON
- set_name(usr_defined_preset_path: str) None[source]
# USRDefined:RST:NAME driver.usrDefined.rst.set_name(usr_defined_preset_path = 'abc')
Sets the path and file name of a user-defined preset file.
- Parameters:
usr_defined_preset_path – String parameter