mso4kb_commands ¶

The MSO4KB commands module.

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

MSO4KBCommandConstants ¶

The MSO4KB command argument constants.

This provides access to all the string constants which can be used as arguments for MSO4KB commands.

MSO4KBCommands ¶

The MSO4KB commands.

This provides access to all the commands for the MSO4KB device. See the documentation of each property for more usage information.

Properties

.acquire: The ACQuire command.
.actonevent: The ACTONEVent command tree.
.afg: The AFG command tree.
.alias: The ALIas command tree.
.allev: The ALLEv command.
.application: The APPLication command tree.
.autoset: The AUTOSet command.
.auxin: The AUXin command.
.auxout: The AUXOut command tree.
.bus: The BUS command.
.busy: The BUSY command.
.cal: The *CAL command.
.calibrate: The CALibrate command tree.
.ch: The CH<x> command.
.clearmenu: The CLEARMenu command.
.cls: The *CLS command.
.configuration: The CONFIGuration command tree.
.cursor: The CURSor command.
.curve: The CURVe command.
.d: The D<x> command.
.data: The DATa command.
.date: The DATE command.
.ddt: The *DDT command.
.dese: The DESE command.
.deskew: The DESkew command.
.diag: The DIAg command tree.
.display: The DISplay command.
.dvm: The DVM command.
.email: The EMAIL command tree.
.errlog: The ERRlog command.
.ese: The *ESE command.
.esr: The *ESR command.
.ethernet: The ETHERnet command tree.
.event: The EVENT command.
.evmsg: The EVMsg command.
.evqty: The EVQty command.
.factory: The FACtory command.
.filesystem: The FILESystem command.
.fpanel: The FPAnel command tree.
.gpibusb: The GPIBUsb command tree.
.hardcopy: The HARDCopy command.
.header: The HEADer command.
.histogram: The HIStogram command.
.horizontal: The HORizontal command.
.id: The ID command.
.idn: The *IDN command.
.language: The LANGuage command.
.lock: The LOCk command.
.lrn: The *LRN command.
.mark: The MARK command.
.marker: The MARKER command tree.
.mask: The MASK command tree.
.math1: The MATH1 command.
.mathvar: The MATHVAR command.
.measurement: The MEASUrement command.
.message: The MESSage command.
.newpass: The NEWpass command.
.opc: The *OPC command.
.opt: The *OPT command.
.password: The PASSWord command.
.pause: The PAUSe command.
.pictbridge: The PICTBridge command tree.
.power: The POWer command tree.
.psc: The *PSC command.
.pud: The *PUD command.
.rcl: The *RCL command.
.reboot: The REBOOT command.
.recall: The RECAll command tree.
.ref: The REF<x> command.
.rem: The REM command.
.rf: The RF command tree.
.rosc: The ROSc command tree.
.rst: The *RST command.
.sav: The *SAV command.
.save: The SAVe command tree.
.search: The SEARCH command.
.select: The SELect command.
.set: The SET command.
.setup: The SETUP<x> command tree.
.socketserver: The SOCKETServer command tree.
.sre: The *SRE command.
.stb: The *STB command.
.teksecure: The TEKSecure command.
.time: The TIMe command.
.totaluptime: The TOTaluptime command.
.trg: The *TRG command.
.trigger: The TRIGger command.
.tst: The *TST command.
.unlock: The UNLock command.
.usbdevice: The USBDevice command tree.
.usbtmc: The USBTMC command.
.verbose: The VERBose command.
.vidpic: The VIDPic command tree.
.wai: The *WAI command.
.wavfrm: The WAVFrm command.
.wfminpre: The WFMInpre command.
.wfmoutpre: The WFMOutpre command.
.zoom: The ZOOm command.

acquire `property` ¶

acquire: Acquire

Return the ACQuire command.

Description

Queries the current acquisition state.

Usage

Using the .query() method will send the ACQuire? query.
Using the .verify(value) method will send the ACQuire? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- ACQuire?

Sub-properties

.fastacq: The ACQuire:FASTAcq command.
.magnivu: The ACQuire:MAGnivu command.
.maxsamplerate: The ACQuire:MAXSamplerate command.
.mode: The ACQuire:MODe command.
.numacq: The ACQuire:NUMACq command.
.numavg: The ACQuire:NUMAVg command.
.numenv: The ACQuire:NUMEnv command.
.state: The ACQuire:STATE command.
.stopafter: The ACQuire:STOPAfter command.

actonevent `property` ¶

actonevent: Actonevent

Return the ACTONEVent command tree.

Usage

Using the .query() method will send the ACTONEVent? query.
Using the .verify(value) method will send the ACTONEVent? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.action: The ACTONEVent:ACTION command tree.
.eventtype: The ACTONEVent:EVENTTYPe command.
.numacqs: The ACTONEVent:NUMACQs command.
.repeatcount: The ACTONEVent:REPEATCount command.

afg `property` ¶

afg: Afg

Return the AFG command tree.

Usage

Using the .query() method will send the AFG? query.
Using the .verify(value) method will send the AFG? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.amplitude: The AFG:AMPLitude command.
.arbitrary: The AFG:ARBitrary command tree.
.frequency: The AFG:FREQuency command.
.function: The AFG:FUNCtion command.
.highlevel: The AFG:HIGHLevel command.
.levelpreset: The AFG:LEVELPreset command.
.lowlevel: The AFG:LOWLevel command.
.noiseadd: The AFG:NOISEAdd command tree.
.offset: The AFG:OFFSet command.
.output: The AFG:OUTPut command tree.
.period: The AFG:PERIod command.
.phase: The AFG:PHASe command.
.pulse: The AFG:PULse command tree.
.ramp: The AFG:RAMP command tree.
.square: The AFG:SQUare command tree.

alias `property` ¶

alias: Alias

Return the ALIas command tree.

Usage

Using the .query() method will send the ALIas? query.
Using the .verify(value) method will send the ALIas? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.catalog: The ALIas:CATalog command.
.define: The ALIas:DEFine command.
.delete: The ALIas:DELEte command tree.
.state: The ALIas:STATE command.

allev `property` ¶

allev: Allev

Return the ALLEv command.

Description

This query-only command prompts the instrument to return all events and their messages (delimited by commas), and removes the returned events from the Event Queue. Use the *ESR? query to enable the events to be returned. This command is similar to repeatedly sending *EVMsg? queries to the instrument.

Usage

Using the .query() method will send the ALLEv? query.
Using the .verify(value) method will send the ALLEv? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- ALLEv?

application `property` ¶

application: Application

Return the APPLication command tree.

Usage

Using the .query() method will send the APPLication? query.
Using the .verify(value) method will send the APPLication? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.license: The APPLication:LICENSE command tree.
.type: The APPLication:TYPe command.

autoset `property` ¶

autoset: Autoset

Return the AUTOSet command.

Description

Sets the vertical, horizontal, and trigger controls of the oscilloscope to automatically acquire and display the selected waveform.

Usage

Using the .write(value) method will send the AUTOSet value command.

SCPI Syntax

- AUTOSet {EXECute|UNDo}

Info

EXECute autosets the displayed waveform.
UNDo restores the oscilloscope settings to those present prior to the autoset execution.

Sub-properties

.enable: The AUTOSet:ENAble command.

auxin `property` ¶

auxin: Auxin

Return the AUXin command.

Description

Returns all Aux Input connector parameters.

Usage

Using the .query() method will send the AUXin? query.
Using the .verify(value) method will send the AUXin? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- AUXin?

Sub-properties

.probe: The AUXin:PRObe command.

auxout `property` ¶

auxout: Auxout

Return the AUXOut command tree.

Usage

Using the .query() method will send the AUXOut? query.
Using the .verify(value) method will send the AUXOut? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.source: The AUXOut:SOUrce command.

bus `property` ¶

bus: Bus

Return the BUS command.

Description

Returns the parameters for each serial (if installed) and parallel bus.

Usage

Using the .query() method will send the BUS? query.
Using the .verify(value) method will send the BUS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- BUS?

Sub-properties

.b: The BUS:B<x> command tree.
.lowerthreshold: The BUS:LOWerthreshold command tree.
.threshold: The BUS:THReshold command tree.
.upperthreshold: The BUS:UPPerthreshold command tree.

busy `property` ¶

busy: Busy

Return the BUSY command.

Description

This query-only command returns the status of the instrument. This command allows you to synchronize the operation of the instrument with your application program.

Usage

Using the .query() method will send the BUSY? query.
Using the .verify(value) method will send the BUSY? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- BUSY?

cal `property` ¶

cal: Cal

Return the *CAL command.

Description

This query-only command starts signal path calibration (SPC) and returns the status upon completion.

Usage

Using the .query() method will send the *CAL? query.
Using the .verify(value) method will send the *CAL? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *CAL?

calibrate `property` ¶

calibrate: Calibrate

Return the CALibrate command tree.

Usage

Using the .query() method will send the CALibrate? query.
Using the .verify(value) method will send the CALibrate? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.factory: The CALibrate:FACtory command tree.
.internal: The CALibrate:INTERNal command.
.powerupstatus: The CALibrate:POWerupstatus command.
.results: The CALibrate:RESults command.
.rf: The CALibrate:RF command.
.temperature: The CALibrate:TEMPerature command.

ch `property` ¶

ch: dict[int, Channel]

Return the CH<x> command.

Description

This query-only command returns the vertical parameters for the specified channel. The channel is specified by x.

Usage

Using the .query() method will send the CH<x>? query.
Using the .verify(value) method will send the CH<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>?

Sub-properties

.ampsviavolts: The CH<x>:AMPSVIAVOLTs command tree.
.bandwidth: The CH<x>:BANdwidth command.
.coupling: The CH<x>:COUPling command.
.deskew: The CH<x>:DESKew command.
.impedance: The CH<x>:IMPedance command.
.invert: The CH<x>:INVert command.
.label: The CH<x>:LABel command.
.offset: The CH<x>:OFFSet command.
.position: The CH<x>:POSition command.
.probe: The CH<x>:PRObe command.
.scale: The CH<x>:SCAle command.
.termination: The CH<x>:TERmination command.
.volts: The CH<x>:VOLts command.
.yunits: The CH<x>:YUNits command.

clearmenu `property` ¶

clearmenu: Clearmenu

Return the CLEARMenu command.

Description

Clears the current menu from the display. This command is equivalent to pressing the front panel Menu off.

Usage

Using the .write() method will send the CLEARMenu command.

SCPI Syntax

- CLEARMenu

cls `property` ¶

cls: Cls

Return the *CLS command.

Description

This command (no query form) clears the following: Event Queue Standard Event Status Register Status Byte Register (except the MAV bit) If the *CLS command immediately follows an , the Output Queue and MAV bit (Status Byte Register bit 4) are also cleared. MAV indicates that information is in the output queue. The device clear (DCL) control message will clear the output queue and thus MAV. *CLS does not clear the output queue or MAV. *CLS can suppress a Service Request that is to be generated by an *OPC. This will happen if a single sequence acquisition operation is still being processed when the *CLS command is executed.

Usage

Using the .write() method will send the *CLS command.

SCPI Syntax

- *CLS

configuration `property` ¶

configuration: Configuration

Return the CONFIGuration command tree.

Usage

Using the .query() method will send the CONFIGuration? query.
Using the .verify(value) method will send the CONFIGuration? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.advmath: The CONFIGuration:ADVMATH command.
.afg: The CONFIGuration:AFG command.
.analog: The CONFIGuration:ANALOg command tree.
.applications: The CONFIGuration:APPLications command tree.
.arb: The CONFIGuration:ARB command.
.auxin: The CONFIGuration:AUXIN command.
.buswaveforms: The CONFIGuration:BUSWAVEFORMS command tree.
.digital: The CONFIGuration:DIGITAl command tree.
.dvm: The CONFIGuration:DVM command.
.extvideo: The CONFIGuration:EXTVIDEO command.
.histogram: The CONFIGuration:HISTOGRAM command.
.networkdrives: The CONFIGuration:NETWORKDRIVES command.
.nummeas: The CONFIGuration:NUMMEAS command.
.refs: The CONFIGuration:REFS command tree.
.rf: The CONFIGuration:RF command tree.
.rosc: The CONFIGuration:ROSC command.

cursor `property` ¶

cursor: Cursor

Return the CURSor command.

Description

Returns all of the current cursor settings.

Usage

Using the .query() method will send the CURSor? query.
Using the .verify(value) method will send the CURSor? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor?

Sub-properties

.ddt: The CURSor:DDT command.
.function: The CURSor:FUNCtion command.
.hbars: The CURSor:HBArs command.
.mode: The CURSor:MODe command.
.source: The CURSor:SOUrce command.
.vbars: The CURSor:VBArs command.
.xy: The CURSor:XY command tree.

curve `property` ¶

curve: Curve

Return the CURVe command.

Description

The CURVe command transfers the waveform data points the oscilloscope’s internal reference memory location (REF1-4), which is specified by the to DATa:DESTination command. The CURVe? query transfers data the oscilloscope; the source waveform is specified by the from DATa:SOUrce command. The first and last data points are specified by the DATa:STARt and DATa:STOP commands. Associated with each waveform transferred using the CURVe command or query is a waveform preamble that provides the data format, scale and associated information needed to interpret the waveform data points. The preamble information for waveforms sent the oscilloscope is specified using the to WFMInpre commands. The preamble information for waveforms transferred the oscilloscope is specified or queried using the from WFMOutpre commands. If the waveform is not displayed, the query form generates an error. The CURVe command and CURVe? query transfer waveform data in ASCII or binary format. ASCII data is sent as a comma-separated list of decimal values. Binary data is sent with the IEEE488.2 binary block header immediately followed by the binary data. The IEEE488.2 binary block header is defined as follows: #N where: N is a single decimal or hexadecimal digit indicating the number of digits to follow. are the decimal digits representing the number of bytes in the data that immediately follows this binary block header. The Waveform Transfer command group text contains more comprehensive information.

Usage

Using the .query() method will send the CURVe? query.
Using the .verify(value) method will send the CURVe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURVe value command.

SCPI Syntax

- CURVe {<Block>|<asc curve>}
- CURVe?

Info

<Block> is the waveform data in binary format. The waveform is formatted as follows.
<asc curve> is the waveform data in ASCII format. The format for ASCII data is [,..], where each represents a data point. For RF frequency domain waveforms, the data is transmitted as 4-byte floating point values (NR2 or NR3).

d `property` ¶

d: dict[int, DigitalBit]

Return the D<x> command.

Description

This command specifies parameters for digital channel , where x is the channel number.

Usage

Using the .write() method will send the D<x> command.

SCPI Syntax

- D<x>

Sub-properties

.label: The D<x>:LABel command.
.position: The D<x>:POSition command.
.threshold: The D<x>:THReshold command.

data `property` ¶

data: Data

Return the DATa command.

Description

This command sets or queries the format and location of the waveform data that is transferred with the CURVE command.

Usage

Using the .query() method will send the DATa? query.
Using the .verify(value) method will send the DATa? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa value command.

SCPI Syntax

- DATa {INIT|SNAp}
- DATa?

Info

INIT initializes the waveform data parameters to their factory defaults except for DATa:STOP, which isset to the current acquisition record length.
SNAp Sets DATa:STARt and DATa:STOP to match the current waveform cursor positions of WAVEVIEW1 CURSOR1 if these waveform cursors are currently on. If these waveform cursors are not on when the DATa SNAp command is sent, it is silently ignored and DATa:STARt and :STOP remain unchanged.

Sub-properties

.destination: The DATa:DESTination command.
.encdg: The DATa:ENCdg command.
.source: The DATa:SOUrce command.
.start: The DATa:STARt command.
.stop: The DATa:STOP command.
.width: The DATa:WIDth command.

date `property` ¶

date: Date

Return the DATE command.

Description

This command specifies the date the oscilloscope displays.

Usage

Using the .query() method will send the DATE? query.
Using the .verify(value) method will send the DATE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATE value command.

SCPI Syntax

- DATE <QString>
- DATE?

Info

<QString> is a date in the form ‘yyyy-mm-dd’ where yyyy refers to a four-digit year number, mm refers to a two-digit month number from 01 to 12, and dd refers to a two-digit day number in the month.

ddt `property` ¶

ddt: Ddt

Return the *DDT command.

Description

This command allows you to specify a command or a list of commands that are executed when the instrument receives a TRG command. Define Device Trigger ( *DDT ) is a special alias that the *TRG command uses.

Usage

Using the .query() method will send the *DDT? query.
Using the .verify(value) method will send the *DDT? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the *DDT value command.

SCPI Syntax

- *DDT {<Block>|<QString>}
- *DDT?

Info

<Block> is a complete sequence of program messages. The messages can contain only valid commands that must be separated by semicolons and must follow all rules for concatenating commands. The sequence must be less than or equal to 80 characters. The format of this argument is always returned as a query.
<QString> is a complete sequence of program messages. The messages can contain only valid commands that must be separated by semicolons and must follow all rules for concatenating commands. The sequence must be less than or equal to 80 characters.

dese `property` ¶

dese: Dese

Return the DESE command.

Description

This command sets and queries the bits in the Device Event Status Enable Register (DESER). The DESER is the mask that determines whether events are reported to the Standard Event Status Register (SESR), and entered into the Event Queue. For a more detailed discussion of the use of these registers, see Registers.

Usage

Using the .query() method will send the DESE? query.
Using the .verify(value) method will send the DESE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DESE value command.

SCPI Syntax

- DESE <NR1>
- DESE?

Info

<NR1> The binary bits of the DESER are set according to this value, which ranges from 1 through 255. For example, DESE 209 sets the DESER to the binary value 11010001 (that is, the most significant bit in the register is set to 1, the next most significant bit to 1, the next bit to 0, etc.).

deskew `property` ¶

deskew: Deskew

Return the DESkew command.

Description

Causes the deskew values for all channels to be set to the recommended values. Equivalent to pressing the ‘Set all deskews to recommended values’ button in the application UI.

Usage

Using the .write(value) method will send the DESkew value command.

SCPI Syntax

- DESkew {SETALLtorec}

Info

<SETALLtorec> sets the deskew for all channels to the recommended values.

Sub-properties

.display: The DESkew:DISPlay command.

diag `property` ¶

diag: Diag

Return the DIAg command tree.

Usage

Using the .query() method will send the DIAg? query.
Using the .verify(value) method will send the DIAg? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.individual: The DIAg:INDIvidual command tree.
.loop: The DIAg:LOOP command tree.
.result: The DIAg:RESUlt command tree.
.select: The DIAg:SELect command.
.state: The DIAg:STATE command.

display `property` ¶

display: Display

Return the DISplay command.

Description

This query-only command returns the current Display settings.

Usage

Using the .query() method will send the DISplay? query.
Using the .verify(value) method will send the DISplay? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DISplay?

Sub-properties

.clock: The DISplay:CLOCk command.
.configure: The DISplay:CONFIGure command tree.
.digital: The DISplay:DIGital command tree.
.graticule: The DISplay:GRAticule command.
.intensity: The DISplay:INTENSITy command.
.persistence: The DISplay:PERSistence command.
.style: The DISplay:STYle command tree.
.trigfrequency: The DISplay:TRIGFrequency command.
.xy: The DISplay:XY command.

dvm `property` ¶

dvm: Dvm

Return the DVM command.

Description

Resets the Digital Voltmeter measurements and history.

Usage

Using the .write(value) method will send the DVM value command.

SCPI Syntax

- DVM {RESET}

Sub-properties

.autorange: The DVM:AUTORange command.
.displaystyle: The DVM:DISPLAYSTYle command.
.measurement: The DVM:MEASUrement command tree.
.mode: The DVM:MODe command.
.source: The DVM:SOUrce command.

email `property` ¶

email: Email

Return the EMAIL command tree.

Usage

Using the .query() method will send the EMAIL? query.
Using the .verify(value) method will send the EMAIL? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.setup: The EMAIL:SETUp command tree.

errlog `property` ¶

errlog: Errlog

Return the ERRlog command.

Description

Clears the oscilloscope error log.

Usage

Using the .write(value) method will send the ERRlog value command.

SCPI Syntax

- ERRlog {CLEar}

Info

CLear

Sub-properties

.first: The ERRlog:FIRst command.
.next: The ERRlog:NEXt command.
.numentries: The ERRlog:NUMENTries command.

ese `property` ¶

ese: Ese

Return the *ESE command.

Description

This command sets and queries the bits in the Event Status Enable Register (ESER). The ESER prevents events from being reported to the Status Byte Register (STB). For a more detailed discussion of the use of these registers, see Registers.

Usage

Using the .query() method will send the *ESE? query.
Using the .verify(value) method will send the *ESE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the *ESE value command.

SCPI Syntax

- *ESE <NR1>
- *ESE?

Info

<NR1> specifies the binary bits of the ESER according to this value, which ranges from 0 through 255.

esr `property` ¶

esr: Esr

Return the *ESR command.

Description

This query-only command returns the contents of the Standard Event Status Register (SESR). *ESR? also clears the SESR (since reading the SESR clears it). For a more detailed discussion of the use of these registers, see Registers.

Usage

Using the .query() method will send the *ESR? query.
Using the .verify(value) method will send the *ESR? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *ESR?

ethernet `property` ¶

ethernet: Ethernet

Return the ETHERnet command tree.

Usage

Using the .query() method will send the ETHERnet? query.
Using the .verify(value) method will send the ETHERnet? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.dhcpbootp: The ETHERnet:DHCPbootp command.
.dns: The ETHERnet:DNS command tree.
.domainname: The ETHERnet:DOMAINname command.
.enet: The ETHERnet:ENET command tree.
.gateway: The ETHERnet:GATEWay command tree.
.httpport: The ETHERnet:HTTPPort command.
.ipaddress: The ETHERnet:IPADDress command.
.lxi: The ETHERnet:LXI command tree.
.name: The ETHERnet:NAME command.
.networkconfig: The ETHERnet:NETWORKCONFig command.
.password: The ETHERnet:PASSWord command.
.ping: The ETHERnet:PING command.
.subnetmask: The ETHERnet:SUBNETMask command.

event `property` ¶

event: Event

Return the EVENT command.

Description

This query-only command returns an event code from the Event Queue that provides information about the results of the last ESR read. EVENT? also removes the returned value from the Event Queue.

Usage

Using the .query() method will send the EVENT? query.
Using the .verify(value) method will send the EVENT? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- EVENT?

evmsg `property` ¶

evmsg: Evmsg

Return the EVMsg command.

Description

This query-only command removes a single event code from the Event Queue that is associated with the results of the last ESR read and returns the event code with an explanatory message. For more information, see Event Handling.

Usage

Using the .query() method will send the EVMsg? query.
Using the .verify(value) method will send the EVMsg? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- EVMsg?

evqty `property` ¶

evqty: Evqty

Return the EVQty command.

Description

This query-only command returns the number of events that are enabled in the queue. This is useful when using the ALLEV query, since it lets you know exactly how many events will be returned.

Usage

Using the .query() method will send the EVQty? query.
Using the .verify(value) method will send the EVQty? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- EVQty?

factory `property` ¶

factory: Factory

Return the FACtory command.

Description

This command (no query form) resets the instrument to its factory default settings. This command is equivalent to pressing the DEFAULT SETUP button located on the instrument front panel or selecting Default Setup from the File menu. This command Performs the following in addition to what is done for the *RST command: Clears any pending OPC operations. Resets the following IEEE488.2 registers: *ESE 0 (Event Status Enable Register) *SRE 0 (Service Request Enable Register) DESE 255 (Device Event Status Enable Register) *PSC 1 (Power-on Status Clear Flag) Deletes all defined aliases. Enables command headers (:HEADer 1).

Usage

Using the .write() method will send the FACtory command.

SCPI Syntax

- FACtory

filesystem `property` ¶

filesystem: Filesystem

Return the FILESystem command.

Description

This query-only command returns the directory listing of the current working directory. This query is the same as the FILESystem:DIR? query.

Usage

Using the .query() method will send the FILESystem? query.
Using the .verify(value) method will send the FILESystem? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- FILESystem?

Sub-properties

.copy: The FILESystem:COPy command.
.cwd: The FILESystem:CWD command.
.delete: The FILESystem:DELEte command.
.dir: The FILESystem:DIR command.
.format: The FILESystem:FORMat command.
.freespace: The FILESystem:FREESpace command.
.ldir: The FILESystem:LDIR command.
.mkdir: The FILESystem:MKDir command.
.mount: The FILESystem:MOUNT command tree.
.readfile: The FILESystem:READFile command.
.rename: The FILESystem:REName command.
.rmdir: The FILESystem:RMDir command.
.unmount: The FILESystem:UNMOUNT command tree.
.writefile: The FILESystem:WRITEFile command.

fpanel `property` ¶

fpanel: Fpanel

Return the FPAnel command tree.

Usage

Using the .query() method will send the FPAnel? query.
Using the .verify(value) method will send the FPAnel? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.hold: The FPAnel:HOLD command.
.press: The FPAnel:PRESS command.
.turn: The FPAnel:TURN command.

gpibusb `property` ¶

gpibusb: Gpibusb

Return the GPIBUsb command tree.

Usage

Using the .query() method will send the GPIBUsb? query.
Using the .verify(value) method will send the GPIBUsb? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.address: The GPIBUsb:ADDress command.
.id: The GPIBUsb:ID command.

hardcopy `property` ¶

hardcopy: Hardcopy

Return the HARDCopy command.

Description

Sends a hard copy of the screen display to the currently active printer using the current palette and layout settings.

Usage

Using the .write(value) method will send the HARDCopy value command.

SCPI Syntax

- HARDCopy {STARt}

Info

STARt sends a block of data representing the current screen image to the requested port. The data sent is in the image format specified by the SAVE:IMAGE:FILEFORMAT command and the compression level is controlled by the selected format (BMP and TIFF are uncompressed whereas PNG is compressed). The HARDCOPY:INKSAVER determines whether the data sent is in InkSaver mode.

Sub-properties

.activeprinter: The HARDCopy:ACTIVeprinter command.
.inksaver: The HARDCopy:INKSaver command.
.layout: The HARDCopy:LAYout command.
.preview: The HARDCopy:PREVIEW command.
.printer: The HARDCopy:PRINTer command tree.

header `property` ¶

header: Header

Return the HEADer command.

Description

This command sets or queries the Response Header Enable State that causes the instrument to either include or omit headers on query responses. Whether the long or short form of header keywords and enumerations are returned is dependent upon the state of :VERBose.

Usage

Using the .query() method will send the HEADer? query.
Using the .verify(value) method will send the HEADer? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HEADer value command.

SCPI Syntax

- HEADer {ON|OFF|<NR1>}
- HEADer?

Info

<NR1> = 0 sets the Response Header Enable State to false; any other value sets this state to true.
OFF sets the Response Header Enable State to false. This causes the instrument to omit headers on query responses, so that only the argument is returned.
ON sets the Response Header Enable State to true. This causes the instrument to include headers on applicable query responses. You can then use the query response as a command.

histogram `property` ¶

histogram: Histogram

Return the HIStogram command.

Description

This query-only query returns all histogram parameters; it queries the state of all histogram parameters that the user can set. This command is equivalent to selecting Waveform Histograms from the Measure menu.

Usage

Using the .query() method will send the HIStogram? query.
Using the .verify(value) method will send the HIStogram? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram?

Sub-properties

.box: The HIStogram:BOX command.
.boxpcnt: The HIStogram:BOXPcnt command.
.count: The HIStogram:COUNt command.
.data: The HIStogram:DATa command.
.display: The HIStogram:DISplay command.
.end: The HIStogram:END command.
.mode: The HIStogram:MODe command.
.source: The HIStogram:SOUrce command.
.start: The HIStogram:STARt command.

horizontal `property` ¶

horizontal: Horizontal

Return the HORizontal command.

Description

Queries the current horizontal settings.

Usage

Using the .query() method will send the HORizontal? query.
Using the .verify(value) method will send the HORizontal? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HORizontal?

Sub-properties

.delay: The HORizontal:DELay command tree.
.digital: The HORizontal:DIGital command tree.
.position: The HORizontal:POSition command.
.previewstate: The HORizontal:PREViewstate command.
.recordlength: The HORizontal:RECOrdlength command.
.samplerate: The HORizontal:SAMPLERate command.
.scale: The HORizontal:SCAle command.

id `property` ¶

id: Id

Return the ID command.

Description

This query-only command returns identifying information about the instrument and related firmware similar to that returned by the *IDN? IEEE488.2 common query but does not include the instrument serial number.

Usage

Using the .query() method will send the ID? query.
Using the .verify(value) method will send the ID? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- ID?

idn `property` ¶

idn: Idn

Return the *IDN command.

Description

This query-only command returns the instrument identification code.

Usage

Using the .query() method will send the *IDN? query.
Using the .verify(value) method will send the *IDN? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *IDN?

language `property` ¶

language: Language

Return the LANGuage command.

Description

This command specifies the user interface display language. This command only affects the oscilloscope displayed language. Remote commands and their responses are always in English.

Usage

Using the .query() method will send the LANGuage? query.
Using the .verify(value) method will send the LANGuage? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the LANGuage value command.

SCPI Syntax

- LANGuage {ENGLish|FRENch|GERMan|ITALian|SPANish|PORTUguese|JAPAnese|KOREan|RUSSian|SIMPlifiedchinese|TRADitionalchinese}
- LANGuage?

lock `property` ¶

lock: Lock

Return the LOCk command.

Description

This command enables or disables the touch screen and all front panel buttons and knobs. There is no front panel equivalent. When the front panel is locked, the front panel commands will not work and will not generate error events. You can work around a locked front panel, by using the appropriate programmatic interface commands, instead of the front-panel commands. For example, to set the trigger level to 50%, you could use TRIGger:A SETLevel. To force a trigger, you could use TRIGger FORCe.

Usage

Using the .query() method will send the LOCk? query.
Using the .verify(value) method will send the LOCk? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the LOCk value command.

SCPI Syntax

- LOCk {ALL|NONe}
- LOCk?

Info

ALL disables all front panel controls and the touch screen.
NONe enables all front panel controls and the touch screen. The UNLock ALL command only unlocks the front panel controls.
NONe command has no effect. For more information, see the ANSI/IEEE Std 488.1-1987 Standard Digital Interface for Programmable Instrumentation, section 2.8.3 on RL State Descriptions.

lrn `property` ¶

lrn: Lrn

Return the *LRN command.

Description

This query-only command returns the commands that list the instrument settings, allowing you to record or ‘learn’ the current instrument settings. You can use these commands to return the instrument to the state it was in when you made the *LRN? query. This command is identical to the SET command.

Usage

Using the .query() method will send the *LRN? query.
Using the .verify(value) method will send the *LRN? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *LRN?

mark `property` ¶

mark: Mark

Return the MARK command.

Description

Moves to the next or previous reference mark on the waveform. Returns the current mark position.

Usage

Using the .query() method will send the MARK? query.
Using the .verify(value) method will send the MARK? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the MARK value command.

SCPI Syntax

- MARK {NEXT|PREVious}
- MARK?

Info

NEXT moves to the next reference mark on the right.
PREVious moves to the next reference mark on the left.

Sub-properties

.create: The MARK:CREATE command.
.delete: The MARK:DELEte command.
.free: The MARK:FREE command.
.saveall: The MARK:SAVEALL command.
.selected: The MARK:SELected command tree.
.total: The MARK:TOTal command.
.userlist: The MARK:USERLIST command.

marker `property` ¶

marker: Marker

Return the MARKER command tree.

Usage

Using the .query() method will send the MARKER? query.
Using the .verify(value) method will send the MARKER? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.m: The MARKER:M<x> command tree.
.manual: The MARKER:MANual command.
.peak: The MARKER:PEAK command tree.
.reference: The MARKER:REFERence command.
.type: The MARKER:TYPe command.

mask `property` ¶

mask: Mask

Return the MASK command tree.

Usage

Using the .query() method will send the MASK? query.
Using the .verify(value) method will send the MASK? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.copy: The MASK:COPy command tree.
.count: The MASK:COUNt command.
.custom: The MASK:CUSTom command.
.display: The MASK:DISplay command.
.lock: The MASK:LOCk command.
.margin: The MASK:MARgin command tree.
.source: The MASK:SOUrce command.
.standard: The MASK:STANdard command.
.stoponviolation: The MASK:STOPOnviolation command.
.template: The MASK:TEMPLate command tree.
.test: The MASK:TESt command tree.
.user: The MASK:USER command tree.

math1 `property` ¶

math1: Math1

Return the MATH1 command.

Description

Returns the definition of the math waveform. The returned data depends on the setting of the MATH1:TYPE command.

Usage

Using the .query() method will send the MATH1? query.
Using the .verify(value) method will send the MATH1? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- MATH1?

Sub-properties

.autoscale: The MATH1:AUTOSCale command.
.define: The MATH1:DEFine command.
.horizontal: The MATH1:HORizontal command tree.
.label: The MATH1:LABel command.
.spectral: The MATH1:SPECTral command tree.
.type: The MATH1:TYPe command.
.vertical: The MATH1:VERTical command tree.

mathvar `property` ¶

mathvar: Mathvar

Return the MATHVAR command.

Description

Queries both numerical values you can use within math expressions.

Usage

Using the .query() method will send the MATHVAR? query.
Using the .verify(value) method will send the MATHVAR? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- MATHVAR?

Sub-properties

.var: The MATHVAR:VAR<x> command.

measurement `property` ¶

measurement: Measurement

Return the MEASUrement command.

Description

This query-only command returns all measurement parameters.

Usage

Using the .query() method will send the MEASUrement? query.
Using the .verify(value) method will send the MEASUrement? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- MEASUrement?

Sub-properties

.clearsnapshot: The MEASUrement:CLEARSNapshot command.
.gating: The MEASUrement:GATing command.
.immed: The MEASUrement:IMMed command.
.indicators: The MEASUrement:INDICators command.
.meas: The MEASUrement:MEAS<x> command.
.method: The MEASUrement:METHod command.
.reflevel: The MEASUrement:REFLevel command.
.snapshot: The MEASUrement:SNAPShot command.
.statistics: The MEASUrement:STATIstics command.

message `property` ¶

message: Message

Return the MESSage command.

Description

This command sets or queries message box (screen annotation) parameters.

Usage

Using the .query() method will send the MESSage? query.
Using the .verify(value) method will send the MESSage? query and raise an AssertionError if the returned value does not match value.
Using the .write() method will send the MESSage command.

SCPI Syntax

- MESSage
- MESSage?

Sub-properties

.box: The MESSage:BOX command.
.clear: The MESSage:CLEAR command.
.show: The MESSage:SHOW command.
.state: The MESSage:STATE command.

newpass `property` ¶

newpass: Newpass

Return the NEWpass command.

Description

This command (no query form) changes the password that enables access to password protected data. The PASSWord command must be successfully executed before using this command or an execution error will be generated.

Usage

Using the .write(value) method will send the NEWpass value command.

SCPI Syntax

- NEWpass <QString>

Info

<QString> is the new password, which can contain up to 10 characters.

opc `property` ¶

opc: Opc

Return the *OPC command.

Description

This command generates the operation complete message in the Standard Event Status Register (SESR) when all pending commands that generate an OPC message are complete. The *OPC? query places the ASCII character ‘1’ into the output queue when all such OPC commands are complete. The *OPC? response is not available to read until all pending operations finish. For a complete discussion of the use of these registers and the output queue, see Registers and Queues. The *OPC command allows you to synchronize the operation of the instrument with your application program. For more information, see Synchronization Methods. Refer to the Oscilloscope operations that can generate OPC table for a list of commands that generate an OPC message.

Usage

Using the .query() method will send the *OPC? query.
Using the .verify(value) method will send the *OPC? query and raise an AssertionError if the returned value does not match value.
Using the .write() method will send the *OPC command.

SCPI Syntax

- *OPC
- *OPC?

opt `property` ¶

opt: Opt

Return the *OPT command.

Description

This query-only command returns a comma separated list of installed options as an arbitrary ASCII string (no quotes) of the form: <optionCode>:<optionDescription>,<optionCode>:<optionDescription>… The last section of each entry (the text following the last hyphen) indicates the license type. If no options are found, NONE is returned.

Usage

Using the .query() method will send the *OPT? query.
Using the .verify(value) method will send the *OPT? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *OPT?

password `property` ¶

password: Password

Return the PASSWord command.

Description

This command (no query form) enables the *PUD and NEWpass set commands. Sending PASSWord without any arguments disables these same commands. Once the password is successfully entered, the *PUD and NEWpass commands are enabled until the instrument is powered off, or until the FACtory command, the PASSWord command with no arguments, or the *RST command is issued. To change the password, you must first enter the valid password with the PASSWord command and then change to your new password with the NEWpass command. Remember that the password is case sensitive.

Usage

Using the .write(value) method will send the PASSWord value command.

SCPI Syntax

- PASSWord <QString>

Info

<QString> is the password, which can contain up to 10 characters. The factory default password is ‘XYZZY’ and is always valid.

pause `property` ¶

pause: Pause

Return the PAUSe command.

Description

This command causes the interface to pause the specified number of seconds before processing any other commands.

Usage

Using the .write(value) method will send the PAUSe value command.

SCPI Syntax

- PAUSe <NR3>

Info

<NR3> is the specified number of seconds the interface is to pause before processing any other commands. The pause time is specified as a floating point value in seconds and must be > 0.0 and ≥1800.0.

pictbridge `property` ¶

pictbridge: Pictbridge

Return the PICTBridge command tree.

Usage

Using the .query() method will send the PICTBridge? query.
Using the .verify(value) method will send the PICTBridge? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.dateprint: The PICTBridge:DATEPrint command.
.default: The PICTBridge:DEFault command.
.idprint: The PICTBridge:IDPrint command.
.imagesize: The PICTBridge:IMAGESize command.
.papersize: The PICTBridge:PAPERSize command.
.papertype: The PICTBridge:PAPERType command.
.printqual: The PICTBridge:PRINTQual command.

power `property` ¶

power: Power

Return the POWer command tree.

Usage

Using the .query() method will send the POWer? query.
Using the .verify(value) method will send the POWer? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.currentsource: The POWer:CURRENTSOurce command.
.display: The POWer:DISplay command.
.gatesource: The POWer:GATESOurce command.
.gating: The POWer:GATing command.
.harmonics: The POWer:HARMonics command tree.
.indicators: The POWer:INDICators command.
.modulation: The POWer:MODulation command tree.
.quality: The POWer:QUALity command tree.
.reflevel: The POWer:REFLevel command tree.
.ripple: The POWer:RIPPle command.
.soa: The POWer:SOA command tree.
.statistics: The POWer:STATIstics command.
.swloss: The POWer:SWLoss command tree.
.type: The POWer:TYPe command.
.voltagesource: The POWer:VOLTAGESOurce command.

psc `property` ¶

psc: Psc

Return the *PSC command.

Description

This command sets and queries the power-on status flag that controls the automatic power-on handling of the DESER, SRER, and ESER registers. When *PSC is true, the DESER register is set to 255 and the SRER and ESER registers are set to 0 at power-on. When *PSC is false, the current values in the DESER, SRER, and ESER registers are preserved in nonvolatile memory when power is shut off and are restored at power-on.

Usage

Using the .query() method will send the *PSC? query.
Using the .verify(value) method will send the *PSC? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the *PSC value command.

SCPI Syntax

- *PSC {ON|OFF|<NR1>}
- *PSC?

Info

<NR1> = 0 sets the power-on status clear flag to false, disables the power-on clear and allows the instrument to possibly assert SRQ after power-on; any other value sets the power-on status clear flag to true, enabling the power-on status clear and prevents any SRQ assertion after power on.
OFF sets the power-on status clear flag to false, disables the power-on clear and allows the instrument to possibly assert SRQ after power-on.
ON sets the power-on status clear flag to true, enabling the power-on status clear and prevents any SRQ assertion after power on.

pud `property` ¶

pud: Pud

Return the *PUD command.

Description

This command sets or queries a string of Protected User Data. This data is protected by the PASSWord command. You can modify it only by first entering the correct password. This password is not necessary to query the data.

Usage

Using the .query() method will send the *PUD? query.
Using the .verify(value) method will send the *PUD? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the *PUD value command.

SCPI Syntax

- *PUD {<Block>|<QString>}
- *PUD?

Info

<Block> is a block containing up to 100 characters.
<QString> is a string containing up to 100 characters.

rcl `property` ¶

rcl: Rcl

Return the *RCL command.

Description

This command restores the state of the oscilloscope from a copy of the settings stored in memory (The settings are stored using the *SAV command).

Usage

Using the .write(value) method will send the *RCL value command.

SCPI Syntax

- *RCL <NR1>

Info

<NR1> is a value in the range from 1 to 10, which specifies a saved setup storage location.

reboot `property` ¶

reboot: Reboot

Return the REBOOT command.

Description

Reboots the system after a short delay, emulating the front panel power button push. The system will power back on after a 5 second delay.

Usage

Using the .write() method will send the REBOOT command.

SCPI Syntax

- REBOOT

recall `property` ¶

recall: Recall

Return the RECAll command tree.

Usage

Using the .query() method will send the RECAll? query.
Using the .verify(value) method will send the RECAll? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.mask: The RECAll:MASK command.
.setup: The RECAll:SETUp command.
.waveform: The RECAll:WAVEform command.

ref `property` ¶

ref: dict[int, RefItem]

Return the REF<x> command.

Description

This query returns data for the reference waveform specified by .

Usage

Using the .query() method will send the REF<x>? query.
Using the .verify(value) method will send the REF<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- REF<x>?

Sub-properties

.date: The REF<x>:DATE command.
.horizontal: The REF<x>:HORizontal command tree.
.label: The REF<x>:LABel command.
.time: The REF<x>:TIMe command.
.vertical: The REF<x>:VERTical command tree.

rem `property` ¶

rem: Rem

Return the REM command.

Description

This command (no query form) embeds a comment within programs as a means of internally documenting the programs. This is how to embed comments in a .set file. The instrument ignores these embedded comment lines.

Usage

Using the .write(value) method will send the REM value command.

SCPI Syntax

- REM <QString>

Info

<QString> is a string that can contain a maximum of 80 characters.

rf `property` ¶

rf: Rf

Return the RF command tree.

Usage

Using the .query() method will send the RF? query.
Using the .verify(value) method will send the RF? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.clipping: The RF:CLIPPing command.
.detectionmethod: The RF:DETECTionmethod command tree.
.frequency: The RF:FREQuency command.
.label: The RF:LABel command.
.measure: The RF:MEASUre command tree.
.position: The RF:POSition command.
.probe: The RF:PRObe command tree.
.rbw: The RF:RBW command.
.reflevel: The RF:REFLevel command.
.rf_amplitude: The RF:RF_AMPlitude command tree.
.rf_average: The RF:RF_AVErage command tree.
.rf_phase: The RF:RF_PHASe command tree.
.rf_v_time: The RF:RF_V_TIMe command tree.
.scale: The RF:SCAle command.
.span: The RF:SPAN command.
.spanrbwratio: The RF:SPANRbwratio command.
.spectrummode: The RF:SPECTRUMMode command.
.spectrumtrace: The RF:SPECTRUMTrace command.
.spectrogram: The RF:SPECTRogram command.
.squelch: The RF:SQUELCH command tree.
.start: The RF:STARt command.
.stop: The RF:STOP command.
.units: The RF:UNIts command.
.window: The RF:WINdow command.

rosc `property` ¶

rosc: Rosc

Return the ROSc command tree.

Usage

Using the .query() method will send the ROSc? query.
Using the .verify(value) method will send the ROSc? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.source: The ROSc:SOUrce command.
.state: The ROSc:STATE command.

rst `property` ¶

rst: Rst

Return the *RST command.

Description

This command (no query form) resets the instrument to the factory default settings. This command does the following: Recalls the default instrument setup. Clears the current *DDT command. Disables aliases (:ALIAS:STATE 0). Disables the user password (for the *PUD command). The *RST command does not change the following: The current working directory ( :FILESystem:CWD command). The state of command headers ( :HEADer command). The state of keyword and enumeration verbosity ( :VERBose command). The Power-on Status Clear Flag ( *PSC command). The Event Status Enable Register ( *ESE command). The Service Request Enable Register ( *SRE command). The Device Event Status Enable Register ( DESE command). The user password for protected user data ( :PASSWord command). The content of protected user data ( *PUD command). The enabled state of the socket server ( :SOCKETServer:ENAble command). The socket server port number ( :SOCKETServer:PORT command). The socket server protocol ( :SOCKETServer:PROTOCol command). The USBTMC port configuration ( :USBDevice:CONFigure command). The destination reference waveform or file path for the :CURVe command ( :DATa:DESTination command). The source waveform for the :CURVe? or :WAVFrm? queries ( :DATa:SOUrce command). The waveform data encoding for the :CURVe command or query or the :WAVFrm? query ( :DATa:ENCdg command). The starting point for :CURVe? queries ( :DATa:STARt command). The ending point for :CURVe? queries ( :DATa:STOP command). All settings associated the :WFMInpre commands. All user settable settings associated with the WFMOutpre commands. *RST only resets the programmable interface settings, it does not change the user interface settings.

Usage

Using the .write() method will send the *RST command.

SCPI Syntax

- *RST

sav `property` ¶

sav: Sav

Return the *SAV command.

Description

Stores the state of the oscilloscope to a specified memory location. You can use the *RCL command to restore the oscilloscope to this saved state at a later time.

Usage

Using the .write(value) method will send the *SAV value command.

SCPI Syntax

- *SAV <NR1>

Info

<NR1> specifies a location in which to save the state of the oscilloscope. Location values range from 1 through 10. Using an out-of-range location value causes an execution error. Any settings that have been stored previously at this location will be overwritten.

save `property` ¶

save: Save

Return the SAVe command tree.

Usage

Using the .query() method will send the SAVe? query.
Using the .verify(value) method will send the SAVe? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.assign: The SAVe:ASSIgn command tree.
.eventtable: The SAVe:EVENTtable command tree.
.image: The SAVe:IMAGe command.
.mask: The SAVe:MASK command.
.setup: The SAVe:SETUp command.
.waveform: The SAVe:WAVEform command.

search `property` ¶

search: Search

Return the SEARCH command.

Description

Returns all search-related settings.

Usage

Using the .query() method will send the SEARCH? query.
Using the .verify(value) method will send the SEARCH? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- SEARCH?

Sub-properties

.search: The SEARCH:SEARCH<x> command tree.

select `property` ¶

select: Select

Return the SELect command.

Description

Queries which waveforms are displayed.

Usage

Using the .query() method will send the SELect? query.
Using the .verify(value) method will send the SELect? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- SELect?

Sub-properties

.ch: The SELect:CH<x> command.
.control: The SELect:CONTROl command.
.d: The SELect:D<x> command.
.dall: The SELect:DAll command.
.ref: The SELect:REF<x> command.
.rf_amplitude: The SELect:RF_AMPlitude command.
.rf_average: The SELect:RF_AVErage command.
.rf_frequency: The SELect:RF_FREQuency command.
.rf_maxhold: The SELect:RF_MAXHold command.
.rf_minhold: The SELect:RF_MINHold command.
.rf_normal: The SELect:RF_NORMal command.
.rf_phase: The SELect:RF_PHASe command.
.bus: The SELect:BUS<x> command.
.b: The SELect:B<x> command.
.math: The SELect:MATH command.
.math1: The SELect:MATH1 command.

set_ `property` ¶

set_: Set

Return the SET command.

Description

This query-only command returns the commands that list the instrument settings, except for configuration information for the calibration values. You can use these commands to return the instrument to the state it was in when you made the SET? query. The SET? query always returns command headers, regardless of the setting of the HEADER command. This is because the returned commands are intended to be sent back to the instrument as a command string. The VERBOSE command can still be used to specify whether the returned headers should be abbreviated or full-length. This command is identical to the LRN command.

Usage

Using the .query() method will send the SET? query.
Using the .verify(value) method will send the SET? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- SET?

setup `property` ¶

setup: dict[int, SetupItem]

Return the SETUP<x> command tree.

Usage

Using the .query() method will send the SETUP<x>? query.
Using the .verify(value) method will send the SETUP<x>? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.date: The SETUP<x>:DATE command.
.label: The SETUP<x>:LABEL command.
.time: The SETUP<x>:TIME command.

socketserver `property` ¶

socketserver: Socketserver

Return the SOCKETServer command tree.

Usage

Using the .query() method will send the SOCKETServer? query.
Using the .verify(value) method will send the SOCKETServer? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.enable: The SOCKETServer:ENAble command.
.port: The SOCKETServer:PORT command.
.protocol: The SOCKETServer:PROTOCol command.

sre `property` ¶

sre: Sre

Return the *SRE command.

Description

The *SRE (Service Request Enable) command sets and queries the bits in the Service Request Enable Register. For more information, refer to Registers.

Usage

Using the .query() method will send the *SRE? query.
Using the .verify(value) method will send the *SRE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the *SRE value command.

SCPI Syntax

- *SRE <NR1>
- *SRE?

Info

<NR1> is a value in the range from 0 through 255. The binary bits of the SRER are set according to this value. Using an out-of-range value causes an execution error. The power-on default for SRER is 0 if *PSC is 1. If *PSC is 0, the SRER maintains the previous power cycle value through the current power cycle.

stb `property` ¶

stb: Stb

Return the *STB command.

Description

The *STB? (Read Status Byte) query returns the contents of the Status Byte Register (SBR) using the Master Summary Status (MSS) bit. For more information, refer to Registers.

Usage

Using the .query() method will send the *STB? query.
Using the .verify(value) method will send the *STB? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *STB?

teksecure `property` ¶

teksecure: Teksecure

Return the TEKSecure command.

Description

This command initializes, for the current user, both waveform and setup memories, overwriting any previously stored data. Equivalent to invoking Teksecure from the Utility menu. This is a time-consuming operation (3 to 5 minutes) and the instrument is inoperable until the TekSecure operation is complete.

Usage

Using the .write() method will send the TEKSecure command.

SCPI Syntax

- TEKSecure

time `property` ¶

time: Time

Return the TIMe command.

Description

This command sets the time in the form hh:mm:ss where hh refers to a two-digit hour number, mm refers to a two-digit minute number from 01 to 60, and ss refers to a two-digit second number from 01 to 60.

Usage

Using the .query() method will send the TIMe? query.
Using the .verify(value) method will send the TIMe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the TIMe value command.

SCPI Syntax

- TIMe <QString>
- TIMe?

Info

<QString> is a quoted string representing the desired time.

totaluptime `property` ¶

totaluptime: Totaluptime

Return the TOTaluptime command.

Description

Total number of hours the instrument has been turned on since the NV memory was last programmed, usually during the initial manufacturing process.

Usage

Using the .query() method will send the TOTaluptime? query.
Using the .verify(value) method will send the TOTaluptime? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- TOTaluptime?

trg `property` ¶

trg: Trg

Return the *TRG command.

Description

Performs a group execute trigger on commands defined by *DDT.

Usage

Using the .write() method will send the *TRG command.

SCPI Syntax

- *TRG

trigger `property` ¶

trigger: Trigger

Return the TRIGger command.

Description

This command forces a trigger event to occur. The query returns the current trigger parameters for the instrument.

Usage

Using the .query() method will send the TRIGger? query.
Using the .verify(value) method will send the TRIGger? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the TRIGger value command.

SCPI Syntax

- TRIGger FORCe
- TRIGger?

Info

FORCe creates a trigger event. If TRIGger:STATE is set to READy, the acquisition will complete. Otherwise, this command will be ignored. This is equivalent to pressing the Force button on the front panel.

Sub-properties

.a: The TRIGger:A command.
.b: The TRIGger:B command.
.external: The TRIGger:EXTernal command.
.frequency: The TRIGger:FREQuency command.
.state: The TRIGger:STATE command.

tst `property` ¶

tst: Tst

Return the *TST command.

Description

Tests (self-test) the interface and returns a 0.

Usage

Using the .query() method will send the *TST? query.
Using the .verify(value) method will send the *TST? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- *TST?

unlock `property` ¶

unlock: Unlock

Return the UNLock command.

Description

This command (no query form) unlocks the front panel controls only. To unlock the front panel controls and the touch screen use the LOCk NONe command. The command TOUCHSCReen:STATE ON enables the touch screen only.

Usage

Using the .write(value) method will send the UNLock value command.

SCPI Syntax

- UNLock ALL

Info

ALL specifies that all front panel buttons and knobs are unlocked.

usbdevice `property` ¶

usbdevice: Usbdevice

Return the USBDevice command tree.

Usage

Using the .query() method will send the USBDevice? query.
Using the .verify(value) method will send the USBDevice? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.configure: The USBDevice:CONFigure command.

usbtmc `property` ¶

usbtmc: Usbtmc

Return the USBTMC command.

Description

Returns the USBTMC information used by the USB hosts to determine the instrument interfaces.

Usage

Using the .query() method will send the USBTMC? query.
Using the .verify(value) method will send the USBTMC? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- USBTMC?

Sub-properties

.productid: The USBTMC:PRODUCTID command tree.
.serialnumber: The USBTMC:SERIALnumber command.
.vendorid: The USBTMC:VENDORID command tree.

verbose `property` ¶

verbose: Verbose

Return the VERBose command.

Description

This command sets or queries the Verbose state that controls the length of keywords on query responses. Keywords can be both headers and arguments.

Usage

Using the .write(value) method will send the VERBose value command.

SCPI Syntax

- VERBose {ON|OFF|<NR1>}

Info

<NR1> = 0 disables Verbose, any other value enables Verbose.
OFF sets the Verbose state to false, which returns minimum-length keywords for applicable setting queries.
ON sets the Verbose state to true, which returns full-length keywords for applicable setting queries.

vidpic `property` ¶

vidpic: Vidpic

Return the VIDPic command tree.

Usage

Using the .query() method will send the VIDPic? query.
Using the .verify(value) method will send the VIDPic? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.autocontrast: The VIDPic:AUTOContrast command.
.brightness: The VIDPic:BRIGHTNess command.
.contrast: The VIDPic:CONTRast command.
.display: The VIDPic:DISplay command.
.frametype: The VIDPic:FRAMETYPe command.
.location: The VIDPic:LOCation command tree.
.source: The VIDPic:SOUrce command.
.standard: The VIDPic:STANdard command.

wai `property` ¶

wai: Wai

Return the *WAI command.

Description

The *WAI (Wait) command (no query form) prevents the instrument from executing further commands or queries until all pending commands that generate an OPC message are complete. This command allows you to synchronize the operation of the instrument with your application program. For more information, refer to Synchronization Methods.

Usage

Using the .write() method will send the *WAI command.

SCPI Syntax

- *WAI

wavfrm `property` ¶

wavfrm: Wavfrm

Return the WAVFrm command.

Description

This query-only command provides the Tektronix standard waveform query which returns the waveform preamble followed by the waveform data for the source specified by :DATa:SOUrce using the :DATa settings for encoding, width, and so forth.

Usage

Using the .query() method will send the WAVFrm? query.
Using the .verify(value) method will send the WAVFrm? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- WAVFrm?

wfminpre `property` ¶

wfminpre: Wfminpre

Return the WFMInpre command.

Description

Returns the waveform formatting and scaling specifications to be applied to the next incoming CURVe command data.

Usage

Using the .query() method will send the WFMInpre? query.
Using the .verify(value) method will send the WFMInpre? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- WFMInpre?

Sub-properties

.bit_nr: The WFMInpre:BIT_Nr command.
.bn_fmt: The WFMInpre:BN_Fmt command.
.byt_nr: The WFMInpre:BYT_Nr command.
.byt_or: The WFMInpre:BYT_Or command.
.centerfrequency: The WFMInpre:CENTERFREQuency command.
.domain: The WFMInpre:DOMain command.
.encdg: The WFMInpre:ENCdg command.
.nr_pt: The WFMInpre:NR_Pt command.
.pt_fmt: The WFMInpre:PT_Fmt command.
.pt_off: The WFMInpre:PT_Off command.
.reflevel: The WFMInpre:REFLevel command.
.span: The WFMInpre:SPAN command.
.wfmtype: The WFMInpre:WFMTYPe command.
.xincr: The WFMInpre:XINcr command.
.xunit: The WFMInpre:XUNit command.
.xzero: The WFMInpre:XZEro command.
.ymult: The WFMInpre:YMUlt command.
.yoff: The WFMInpre:YOFf command.
.yunit: The WFMInpre:YUNit command.
.yzero: The WFMInpre:YZEro command.

wfmoutpre `property` ¶

wfmoutpre: Wfmoutpre

Return the WFMOutpre command.

Description

This query-only command queries the waveform formatting data for the waveform specified by the DATA:SOURCE command. The preamble components are considered to be of two types; formatting and interpretation. The formatting components are: ENCdg, BN_Fmt, BYT_Or, BYT_Nr, BIT_Nr. The interpretation components are derived from the DATa:SOUrce specified waveform.

Usage

Using the .query() method will send the WFMOutpre? query.
Using the .verify(value) method will send the WFMOutpre? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- WFMOutpre?

Sub-properties

.bit_nr: The WFMOutpre:BIT_Nr command.
.bn_fmt: The WFMOutpre:BN_Fmt command.
.byt_nr: The WFMOutpre:BYT_Nr command.
.byt_or: The WFMOutpre:BYT_Or command.
.centerfrequency: The WFMOutpre:CENTERFREQuency command.
.domain: The WFMOutpre:DOMain command.
.encdg: The WFMOutpre:ENCdg command.
.nr_pt: The WFMOutpre:NR_Pt command.
.pt_fmt: The WFMOutpre:PT_Fmt command.
.pt_order: The WFMOutpre:PT_ORder command.
.pt_off: The WFMOutpre:PT_Off command.
.reflevel: The WFMOutpre:REFLEvel command.
.span: The WFMOutpre:SPAN command.
.wfid: The WFMOutpre:WFId command.
.wfmtype: The WFMOutpre:WFMTYPe command.
.xincr: The WFMOutpre:XINcr command.
.xunit: The WFMOutpre:XUNit command.
.xzero: The WFMOutpre:XZEro command.
.ymult: The WFMOutpre:YMUlt command.
.yoff: The WFMOutpre:YOFf command.
.yunit: The WFMOutpre:YUNit command.
.yzero: The WFMOutpre:YZEro command.

zoom `property` ¶

zoom: Zoom

Return the ZOOm command.

Description

Returns the current vertical and horizontal positioning and scaling of the display.

Usage

Using the .query() method will send the ZOOm? query.
Using the .verify(value) method will send the ZOOm? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- ZOOm?

Sub-properties

.zoom1: The ZOOm:ZOOM1 command.
.mode: The ZOOm:MODe command.
.state: The ZOOm:STATE command.

MSO4KBMixin ¶

A mixin that provides access to the MSO4KB commands and constants.

Properties

.command_argument_constants: The MSO4KB command argument constants.
.commands: The MSO4KB commands.

command_argument_constants `cached` `property` ¶

command_argument_constants: MSO4KBCommandConstants

Return the MSO4KB command argument constants.

This provides access to all the string constants which can be used as arguments for MSO4KB commands.

commands `cached` `property` ¶

commands: MSO4KBCommands

Return the MSO4KB commands.

This provides access to all the commands for the MSO4KB device. See the documentation of each sub-property for more usage information.

Sub-properties

.acquire: The ACQuire command.
.actonevent: The ACTONEVent command tree.
.afg: The AFG command tree.
.alias: The ALIas command tree.
.allev: The ALLEv command.
.application: The APPLication command tree.
.autoset: The AUTOSet command.
.auxin: The AUXin command.
.auxout: The AUXOut command tree.
.bus: The BUS command.
.busy: The BUSY command.
.cal: The *CAL command.
.calibrate: The CALibrate command tree.
.ch: The CH<x> command.
.clearmenu: The CLEARMenu command.
.cls: The *CLS command.
.configuration: The CONFIGuration command tree.
.cursor: The CURSor command.
.curve: The CURVe command.
.d: The D<x> command.
.data: The DATa command.
.date: The DATE command.
.ddt: The *DDT command.
.dese: The DESE command.
.deskew: The DESkew command.
.diag: The DIAg command tree.
.display: The DISplay command.
.dvm: The DVM command.
.email: The EMAIL command tree.
.errlog: The ERRlog command.
.ese: The *ESE command.
.esr: The *ESR command.
.ethernet: The ETHERnet command tree.
.event: The EVENT command.
.evmsg: The EVMsg command.
.evqty: The EVQty command.
.factory: The FACtory command.
.filesystem: The FILESystem command.
.fpanel: The FPAnel command tree.
.gpibusb: The GPIBUsb command tree.
.hardcopy: The HARDCopy command.
.header: The HEADer command.
.histogram: The HIStogram command.
.horizontal: The HORizontal command.
.id: The ID command.
.idn: The *IDN command.
.language: The LANGuage command.
.lock: The LOCk command.
.lrn: The *LRN command.
.mark: The MARK command.
.marker: The MARKER command tree.
.mask: The MASK command tree.
.math1: The MATH1 command.
.mathvar: The MATHVAR command.
.measurement: The MEASUrement command.
.message: The MESSage command.
.newpass: The NEWpass command.
.opc: The *OPC command.
.opt: The *OPT command.
.password: The PASSWord command.
.pause: The PAUSe command.
.pictbridge: The PICTBridge command tree.
.power: The POWer command tree.
.psc: The *PSC command.
.pud: The *PUD command.
.rcl: The *RCL command.
.reboot: The REBOOT command.
.recall: The RECAll command tree.
.ref: The REF<x> command.
.rem: The REM command.
.rf: The RF command tree.
.rosc: The ROSc command tree.
.rst: The *RST command.
.sav: The *SAV command.
.save: The SAVe command tree.
.search: The SEARCH command.
.select: The SELect command.
.set: The SET command.
.setup: The SETUP<x> command tree.
.socketserver: The SOCKETServer command tree.
.sre: The *SRE command.
.stb: The *STB command.
.teksecure: The TEKSecure command.
.time: The TIMe command.
.totaluptime: The TOTaluptime command.
.trg: The *TRG command.
.trigger: The TRIGger command.
.tst: The *TST command.
.unlock: The UNLock command.
.usbdevice: The USBDevice command tree.
.usbtmc: The USBTMC command.
.verbose: The VERBose command.
.vidpic: The VIDPic command tree.
.wai: The *WAI command.
.wavfrm: The WAVFrm command.
.wfminpre: The WFMInpre command.
.wfmoutpre: The WFMOutpre command.
.zoom: The ZOOm command.

mso4kb_commands ¶

MSO4KBCommandConstants ¶

MSO4KBCommands ¶

acquire property ¶

actonevent property ¶

afg property ¶

alias property ¶

allev property ¶

application property ¶

autoset property ¶

auxin property ¶

auxout property ¶

bus property ¶

busy property ¶

cal property ¶

calibrate property ¶

ch property ¶

clearmenu property ¶

cls property ¶

configuration property ¶

cursor property ¶

curve property ¶

d property ¶

data property ¶

date property ¶

ddt property ¶

dese property ¶

deskew property ¶

diag property ¶

display property ¶

dvm property ¶

email property ¶

errlog property ¶

ese property ¶

esr property ¶

ethernet property ¶

event property ¶

evmsg property ¶

evqty property ¶

factory property ¶

filesystem property ¶

fpanel property ¶

gpibusb property ¶

hardcopy property ¶

header property ¶

histogram property ¶

horizontal property ¶

id property ¶

idn property ¶

language property ¶

lock property ¶

lrn property ¶

mark property ¶

marker property ¶

mask property ¶

math1 property ¶

mathvar property ¶

measurement property ¶

message property ¶

newpass property ¶

opc property ¶

opt property ¶

password property ¶

pause property ¶

pictbridge property ¶

power property ¶

psc property ¶

pud property ¶

rcl property ¶

reboot property ¶

recall property ¶

ref property ¶

rem property ¶

rf property ¶

rosc property ¶

rst property ¶

sav property ¶

save property ¶

search property ¶

select property ¶

acquire `property` ¶

actonevent `property` ¶

afg `property` ¶

alias `property` ¶

allev `property` ¶

application `property` ¶

autoset `property` ¶

auxin `property` ¶

auxout `property` ¶

bus `property` ¶

busy `property` ¶

cal `property` ¶

calibrate `property` ¶

ch `property` ¶

clearmenu `property` ¶

cls `property` ¶

configuration `property` ¶

cursor `property` ¶

curve `property` ¶

d `property` ¶

data `property` ¶

date `property` ¶

ddt `property` ¶

dese `property` ¶

deskew `property` ¶

diag `property` ¶

display `property` ¶

dvm `property` ¶

email `property` ¶

errlog `property` ¶

ese `property` ¶

esr `property` ¶

ethernet `property` ¶

event `property` ¶

evmsg `property` ¶

evqty `property` ¶

factory `property` ¶

filesystem `property` ¶

fpanel `property` ¶

gpibusb `property` ¶

hardcopy `property` ¶

header `property` ¶

histogram `property` ¶

horizontal `property` ¶

id `property` ¶

idn `property` ¶

language `property` ¶

lock `property` ¶

lrn `property` ¶

mark `property` ¶

marker `property` ¶

mask `property` ¶

math1 `property` ¶

mathvar `property` ¶

measurement `property` ¶

message `property` ¶

newpass `property` ¶

opc `property` ¶

opt `property` ¶

password `property` ¶

pause `property` ¶

pictbridge `property` ¶

power `property` ¶

psc `property` ¶

pud `property` ¶

rcl `property` ¶

reboot `property` ¶

recall `property` ¶

ref `property` ¶

rem `property` ¶

rf `property` ¶

rosc `property` ¶

rst `property` ¶

sav `property` ¶

save `property` ¶

search `property` ¶

select `property` ¶

set_ `property` ¶

setup `property` ¶

socketserver `property` ¶