Instrument

SCPI Commands :

INSTrument:ADD
INSTrument:CAPabilities
INSTrument:CLEar
INSTrument:COMMent
INSTrument:CONNect
INSTrument:COUNt
INSTrument:DELete
INSTrument:FIRMware
INSTrument:LIST
INSTrument:NAME
INSTrument:ONLine
INSTrument:PMOD
INSTrument:PSEC
INSTrument:RESource
INSTrument:SELect
INSTrument:SUPPorted
INSTrument:TYPE
INSTrument:VIRTual

class InstrumentCls

Instrument commands group definition. 19 total commands, 1 Subgroups, 18 group commands

clear() → None

# SCPI: INSTrument:CLEar
driver.instrument.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: INSTrument:CLEar
driver.instrument.clear_with_opc()

Deletes all items from the list or the table.

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

param opc_timeout_ms:

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

delete(delete: float) → None

# SCPI: INSTrument:DELete
driver.instrument.delete(delete = 1.0)

Deletes the particular item.

param delete:

float

get_capabilities() → str

# SCPI: INSTrument:CAPabilities
value: str = driver.instrument.get_capabilities()

Queries the generator capabilities regarding supported scenario types and processing of waveforms and multi-segment files.

return:

capabilities: string

get_comment() → str

# SCPI: INSTrument:COMMent
value: str = driver.instrument.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_count() → float

# SCPI: INSTrument:COUNt
value: float = driver.instrument.get_count()

Queries the number of existing items.

return:

count: integer

get_firmware() → str

# SCPI: INSTrument:FIRMware
value: str = driver.instrument.get_firmware()

Queries the firmware version of the selected instrument.

return:

firmware: string

get_list_py() → List[str]

# SCPI: INSTrument:LIST
value: List[str] = driver.instrument.get_list_py()

Queries the names of the signal generators that are connected to the R&S Pulse Sequencer in the current setup. See method RsPulseSeq.Setup.listPy.

return:

list_py: ‘Instr#1’,’Instr#2’,…

get_name() → str

# SCPI: INSTrument:NAME
value: str = driver.instrument.get_name()

Queries the name of the selected instrument.

return:

name: string

get_online() → float

# SCPI: INSTrument:ONLine
value: float = driver.instrument.get_online()

Queries the connection status of a physical signal generator.

return:

online: float 0 Offline 1 Online

get_pmod() → PmodSource

# SCPI: INSTrument:PMOD
value: enums.PmodSource = driver.instrument.get_pmod()

Select the marker source if pulse modulator is used, see method RsPulseSeq.Setup.Pmod.enable.

return:

pmod: OFF| INTernal| EXTernal OFF Disables the function for the selected instrument. INTernal No additional cabling or configuration of marker signals is required. EXTernal Requires that: 1) the instruments are cabled according to the wiring diagram 2) high the clock rate is selected 3) pulse marker M2 is set to pulse width 4) sequence marker M2 is enabled 5) the generation of the dedicated marker signal is enabled

get_psec() → Psec

# SCPI: INSTrument:PSEC
value: enums.Psec = driver.instrument.get_psec()

Sets the Primary/Secondary order in synchronized setups.

return:

psec: NONE| PRIMary| SEC1| SEC2| SEC3| SEC4| SEC5| SEC6| SEC7| SEC8| SEC9| SEC10| SEC11| SEC12| SEC13| SEC14| SEC15| SEC16 NONE Unsynchronized instrument. PRIMary The primary instrument. SEC1 Denotes the secondary instruments.

get_resource() → str

# SCPI: INSTrument:RESource
value: str = driver.instrument.get_resource()

Queries the resource string of the instrument selected with the command method RsPulseSeq.Instrument.select.

return:

resource: string

get_select() → float

# SCPI: INSTrument:SELect
value: float = driver.instrument.get_select()

Selects the element to which the subsequent commands apply.

return:

select: string Available element as queried with the corresponding …:LIST command. For example, method RsPulseSeq.Assignment.Generator.Path.Antenna.listPy

get_supported() → float

# SCPI: INSTrument:SUPPorted
value: float = driver.instrument.get_supported()

Queries the supported status.

return:

supported: 0| 1 1 Supported 0 Not supported

get_type_py() → GeneratorType

# SCPI: INSTrument:TYPE
value: enums.GeneratorType = driver.instrument.get_type_py()

Sets the instrument type.

return:

type_py: SMBB| SW| SGT| SMBV| SMJ| SMW| SMU| SMM

get_virtual() → bool

# SCPI: INSTrument:VIRTual
value: bool = driver.instrument.get_virtual()

Queries the state of the virtual instrument.

return:

virtual: ON| OFF| 1| 0

set_add(add: str) → None

# SCPI: INSTrument:ADD
driver.instrument.set_add(add = 'abc')

Adds an instrument with the specified IP address, computer name, or the VISA resource string.

param add:

string ‘IP_Address’ or ‘Computer_Name’ or ‘GPIB_Address’

set_capabilities(capabilities: str) → None

# SCPI: INSTrument:CAPabilities
driver.instrument.set_capabilities(capabilities = 'abc')

Queries the generator capabilities regarding supported scenario types and processing of waveforms and multi-segment files.

param capabilities:

string

set_comment(comment: str) → None

# SCPI: INSTrument:COMMent
driver.instrument.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_connect(connect: str) → None

# SCPI: INSTrument:CONNect
driver.instrument.set_connect(connect = 'abc')

Connects to the instrument defined by method RsPulseSeq.Instrument.select

param connect:

string

set_name(name: str) → None

# SCPI: INSTrument:NAME
driver.instrument.set_name(name = 'abc')

Queries the name of the selected instrument.

param name:

string

set_online(online: float) → None

# SCPI: INSTrument:ONLine
driver.instrument.set_online(online = 1.0)

Queries the connection status of a physical signal generator.

param online:

float 0 Offline 1 Online

set_pmod(pmod: PmodSource) → None

# SCPI: INSTrument:PMOD
driver.instrument.set_pmod(pmod = enums.PmodSource.EXTernal)

Select the marker source if pulse modulator is used, see method RsPulseSeq.Setup.Pmod.enable.

param pmod:

OFF| INTernal| EXTernal OFF Disables the function for the selected instrument. INTernal No additional cabling or configuration of marker signals is required. EXTernal Requires that: 1) the instruments are cabled according to the wiring diagram 2) high the clock rate is selected 3) pulse marker M2 is set to pulse width 4) sequence marker M2 is enabled 5) the generation of the dedicated marker signal is enabled

set_psec(psec: Psec) → None

# SCPI: INSTrument:PSEC
driver.instrument.set_psec(psec = enums.Psec.NONE)

Sets the Primary/Secondary order in synchronized setups.

param psec:

NONE| PRIMary| SEC1| SEC2| SEC3| SEC4| SEC5| SEC6| SEC7| SEC8| SEC9| SEC10| SEC11| SEC12| SEC13| SEC14| SEC15| SEC16 NONE Unsynchronized instrument. PRIMary The primary instrument. SEC1 Denotes the secondary instruments.

set_select(select: float) → None

# SCPI: INSTrument:SELect
driver.instrument.set_select(select = 1.0)

Selects the element to which the subsequent commands apply.

param select:

string Available element as queried with the corresponding …:LIST command. For example, method RsPulseSeq.Assignment.Generator.Path.Antenna.listPy

set_type_py(type_py: GeneratorType) → None

# SCPI: INSTrument:TYPE
driver.instrument.set_type_py(type_py = enums.GeneratorType.SGT)

Sets the instrument type.

param type_py:

SMBB| SW| SGT| SMBV| SMJ| SMW| SMU| SMM

Cloning the Group

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

Subgroups

• Adb