System

SCPI Commands :

SYSTem:BASE:RELiability
SYSTem:DID
SYSTem:KLOCk
SYSTem:PRESet
SYSTem:PRESet:ALL
SYSTem:PRESet:BASE
SYSTem:RESet
SYSTem:RESet:ALL
SYSTem:RESet:BASE
SYSTem:VERSion
class SystemCls[source]

System commands group definition. 98 total commands, 25 Subgroups, 10 group commands

get_did() → str[source]
# SCPI: SYSTem:DID
value: str = driver.system.get_did()

No command help available

return:

device_id: No help available

get_klock() → bool[source]
# SCPI: SYSTem:KLOCk
value: bool = driver.system.get_klock()

Locks or unlocks the local controls of the instrument, including the (soft-) front panel keys.

return:

klock: No help available

get_reliability() → int[source]
# SCPI: SYSTem:BASE:RELiability
value: int = driver.system.get_reliability()

Returns a reliability value indicating errors detected by the base software.

return:

value: decimal For reliability indicator values, see ‘Checking the reliability indicator’

get_version() → float[source]
# SCPI: SYSTem:VERSion
value: float = driver.system.get_version()

Queries the SCPI version number to which the instrument complies.

return:

version: string ‘1999.0’ is the final SCPI version.

preset(appl_name_and_li_number: str = None) → None[source]
# SCPI: SYSTem:PRESet
driver.system.preset(appl_name_and_li_number = 'abc')

A PRESet sets the parameters of the subinstrument to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation. Optionally, the preset/reset can be limited to a specific application instance.

param appl_name_and_li_number:

string Application and instance to be reset/preset. Example: ‘LTE Meas1’ for LTE UE measurements instance 1 Omitting the instance (e.g. ‘LTE Meas’) selects instance 1. The supported strings are listed in the table below.

preset_all() → None[source]
# SCPI: SYSTem:PRESet:ALL
driver.system.preset_all()

A PRESet sets the parameters of all subinstruments and the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

preset_all_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: SYSTem:PRESet:ALL
driver.system.preset_all_with_opc()

A PRESet sets the parameters of all subinstruments and the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

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

param opc_timeout_ms:

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

preset_base() → None[source]
# SCPI: SYSTem:PRESet:BASE
driver.system.preset_base()

A PRESet sets the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

preset_base_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: SYSTem:PRESet:BASE
driver.system.preset_base_with_opc()

A PRESet sets the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

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

param opc_timeout_ms:

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

reset(appl_name_and_li_number: str = None) → None[source]
# SCPI: SYSTem:RESet
driver.system.reset(appl_name_and_li_number = 'abc')

A PRESet sets the parameters of the subinstrument to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation. Optionally, the preset/reset can be limited to a specific application instance.

param appl_name_and_li_number:

string Application and instance to be reset/preset. Example: ‘LTE Meas1’ for LTE UE measurements instance 1 Omitting the instance (e.g. ‘LTE Meas’) selects instance 1. The supported strings are listed in the table below.

reset_all() → None[source]
# SCPI: SYSTem:RESet:ALL
driver.system.reset_all()

A PRESet sets the parameters of all subinstruments and the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

reset_all_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: SYSTem:RESet:ALL
driver.system.reset_all_with_opc()

A PRESet sets the parameters of all subinstruments and the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

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

param opc_timeout_ms:

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

reset_base() → None[source]
# SCPI: SYSTem:RESet:BASE
driver.system.reset_base()

A PRESet sets the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

reset_base_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: SYSTem:RESet:BASE
driver.system.reset_base_with_opc()

A PRESet sets the base settings to default values suitable for local/manual interaction. A RESet sets them to default values suitable for remote operation.

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

param opc_timeout_ms:

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

set_klock(klock: bool) → None[source]
# SCPI: SYSTem:KLOCk
driver.system.set_klock(klock = False)

Locks or unlocks the local controls of the instrument, including the (soft-) front panel keys.

param klock:

ON | OFF | 1 | 0 ON | 1: Local key locked (key lock enabled) OFF | 0: Local keys unlocked

Cloning the Group

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

Subgroups