mso2_commands
¶
The MSO2 commands module.
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
MSO2CommandConstants
¶
The MSO2 command argument constants.
This provides access to all the string constants which can be used as arguments for MSO2 commands.
MSO2Commands
¶
The MSO2 commands.
This provides access to all the commands for the MSO2 device. See the documentation of each property for more usage information.
Properties
.acquire: TheACQuirecommand..actonevent: TheACTONEVentcommand tree..afg: TheAFGcommand tree..alias: TheALIascommand..allev: TheALLEvcommand..autosavepitimeout: TheAUTOSAVEPITIMEOUTcommand..autosaveuitimeout: TheAUTOSAVEUITIMEOUTcommand..autoset: TheAUTOSetcommand..auxout: TheAUXoutcommand tree..battery: TheBATTerycommand tree..bus: TheBUScommand tree..bustable: TheBUSTABlecommand tree..busy: TheBUSYcommand..cal: The*CALcommand..calibrate: TheCALibratecommand..callouts: TheCALLOUTScommand tree..ch: TheCH<x>command..clear: TheCLEARcommand..cls: The*CLScommand..configuration: TheCONFIGurationcommand tree..connected: TheCONNectedcommand tree..curve: TheCURVecommand..curvestream: TheCURVEStreamcommand..customtable: TheCUSTOMTABlecommand tree..data: TheDATacommand..date: TheDATEcommand..dch: TheDCH<x>command tree..ddt: The*DDTcommand..dese: TheDESEcommand..diag: TheDIAgcommand tree..display: TheDISplaycommand..ese: The*ESEcommand..esr: The*ESRcommand..ethernet: TheETHERnetcommand tree..event: TheEVENTcommand..evmsg: TheEVMsgcommand..evqty: TheEVQtycommand..factory: TheFACtorycommand..filesystem: TheFILESystemcommand..fpanel: TheFPAnelcommand tree..header: TheHEADercommand..horizontal: TheHORizontalcommand..id: TheIDcommand..idn: The*IDNcommand..lic: TheLICcommand tree..license: TheLICensecommand..lock: TheLOCkcommand..lrn: The*LRNcommand..mainwindow: TheMAINWindowcommand tree..mask: TheMASKcommand tree..math: TheMATHcommand tree..meastable: TheMEASTABlecommand tree..measurement: TheMEASUrementcommand..newpass: TheNEWpasscommand..opc: The*OPCcommand..opt: The*OPTcommand..password: ThePASSWordcommand..pause: ThePAUSecommand..pg: ThePGcommand tree..plot: ThePLOTcommand tree..power: ThePOWercommand tree..psc: The*PSCcommand..pud: The*PUDcommand..recall: TheRECAllcommand tree..ref: TheREFcommand tree..rem: TheREMcommand..rosc: TheROSccommand tree..rst: The*RSTcommand..save: TheSAVecommand tree..saveon: TheSAVEONcommand tree..saveonevent: TheSAVEONEVentcommand tree..search: TheSEARCHcommand tree..select: TheSELectcommand tree..set: TheSETcommand..socketserver: TheSOCKETServercommand tree..sre: The*SREcommand..stb: The*STBcommand..teksecure: TheTEKSecurecommand..time: TheTIMecommand..totaluptime: TheTOTaluptimecommand..touchscreen: TheTOUCHSCReencommand tree..trg: The*TRGcommand..trigger: TheTRIGgercommand..tst: The*TSTcommand..undo: TheUNDOcommand..unlock: TheUNLockcommand..usbdevice: TheUSBDevicecommand tree..verbose: TheVERBosecommand..vertical: TheVERTicalcommand tree..vxi: TheVXIcommand tree..wai: The*WAIcommand..wavfrm: TheWAVFrmcommand..wfmoutpre: TheWFMOutprecommand.
acquire
property
¶
acquire: Acquire
Return the ACQuire command.
Description
- Queries the current acquisition state.
Usage
- Using the
.query()method will send theACQuire?query. - Using the
.verify(value)method will send theACQuire?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- ACQuire?
Sub-properties
.fastacq: TheACQuire:FASTAcqcommand tree..maxsamplerate: TheACQuire:MAXSampleratecommand..mode: TheACQuire:MODecommand..numacq: TheACQuire:NUMACqcommand..numavg: TheACQuire:NUMAVgcommand..sequence: TheACQuire:SEQuencecommand tree..state: TheACQuire:STATEcommand..stopafter: TheACQuire:STOPAftercommand.
actonevent
property
¶
actonevent: Actonevent
Return the ACTONEVent command tree.
Usage
- Using the
.query()method will send theACTONEVent?query. - Using the
.verify(value)method will send theACTONEVent?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.enable: TheACTONEVent:ENablecommand..limitcount: TheACTONEVent:LIMITCountcommand..limit: TheACTONEVent:LIMitcommand..maskfail: TheACTONEVent:MASKFailcommand tree..maskhit: TheACTONEVent:MASKHitcommand tree..maskpass: TheACTONEVent:MASKPasscommand tree..measurement: TheACTONEVent:MEASUrementcommand tree..search: TheACTONEVent:SEARCHcommand tree..trigger: TheACTONEVent:TRIGgercommand tree.
afg
property
¶
afg: Afg
Return the AFG command tree.
Usage
- Using the
.query()method will send theAFG?query. - Using the
.verify(value)method will send theAFG?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.amplitude: TheAFG:AMPLitudecommand..arbitrary: TheAFG:ARBitrarycommand tree..burst: TheAFG:BURStcommand tree..frequency: TheAFG:FREQuencycommand..function: TheAFG:FUNCtioncommand..highlevel: TheAFG:HIGHLevelcommand..lowlevel: TheAFG:LOWLevelcommand..noiseadd: TheAFG:NOISEAddcommand tree..offset: TheAFG:OFFSetcommand..output: TheAFG:OUTPutcommand tree..period: TheAFG:PERIodcommand..pulse: TheAFG:PULsecommand tree..ramp: TheAFG:RAMPcommand tree..square: TheAFG:SQUarecommand tree.
alias
property
¶
alias: Alias
Return the ALIas command.
Description
- This command sets or queries the state of alias functionality, and it is identical to
the
ALIAS:STATEcommand.
Usage
- Using the
.query()method will send theALIas?query. - Using the
.verify(value)method will send theALIas?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theALIas valuecommand.
SCPI Syntax
- ALIas {ON|OFF|<NR1>}
- ALIas?
Info
OFFturns Alias expansion off.ONturns Alias expansion on. When a defined alias is received, the specified command sequence is substituted for the alias and executed.<NR1>= 0 disables Alias mode; any other value enables Alias mode.
Sub-properties
.catalog: TheALIas:CATalogcommand..define: TheALIas:DEFinecommand..delete: TheALIas:DELEtecommand..state: TheALIas:STATEcommand.
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 theALLEv?query. - Using the
.verify(value)method will send theALLEv?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- ALLEv?
autosavepitimeout
property
¶
autosavepitimeout: Autosavepitimeout
Return the AUTOSAVEPITIMEOUT command.
Description
- This command sets or queries the idle time from the programmable interface before auto-save occurs.
Usage
- Using the
.query()method will send theAUTOSAVEPITIMEOUT?query. - Using the
.verify(value)method will send theAUTOSAVEPITIMEOUT?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theAUTOSAVEPITIMEOUT valuecommand.
SCPI Syntax
- AUTOSAVEPITIMEOUT <NR1>
- AUTOSAVEPITIMEOUT?
Info
<NR1>sets the timeout time.
autosaveuitimeout
property
¶
autosaveuitimeout: Autosaveuitimeout
Return the AUTOSAVEUITIMEOUT command.
Description
- This command sets or queries the idle time from the user interface before auto-save occurs.
Usage
- Using the
.query()method will send theAUTOSAVEUITIMEOUT?query. - Using the
.verify(value)method will send theAUTOSAVEUITIMEOUT?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theAUTOSAVEUITIMEOUT valuecommand.
SCPI Syntax
- AUTOSAVEUITIMEOUT <NR1>
- AUTOSAVEUITIMEOUT?
Info
<NR1>
autoset
property
¶
autoset: Autoset
Return the AUTOSet command.
Description
- This command (no query format) sets the vertical, horizontal, and trigger controls of the instrument to automatically acquire and display the selected waveform.
Usage
- Using the
.write(value)method will send theAUTOSet valuecommand.
SCPI Syntax
- AUTOSet EXECute
Info
EXECuteautosets the displayed waveform; this is equivalent to pressing the front panel Autoset button.
Sub-properties
.acquisition: TheAUTOSet:ACQuisitioncommand tree..enable: TheAUTOSet:ENAblecommand..horizontal: TheAUTOSet:HORizontalcommand tree..trigger: TheAUTOSet:TRIGgercommand tree..vertical: TheAUTOSet:VERTicalcommand tree.
auxout
property
¶
auxout: Auxout
Return the AUXout command tree.
Usage
- Using the
.query()method will send theAUXout?query. - Using the
.verify(value)method will send theAUXout?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.edge: TheAUXout:EDGEcommand..source: TheAUXout:SOUrcecommand.
battery
property
¶
battery: Battery
Return the BATTery command tree.
Usage
- Using the
.query()method will send theBATTery?query. - Using the
.verify(value)method will send theBATTery?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.acpower: TheBATTery:ACPOWercommand..slot: TheBATTery:SLOT<1,2>command tree.
bus
property
¶
bus: Bus
Return the BUS command tree.
Usage
- Using the
.query()method will send theBUS?query. - Using the
.verify(value)method will send theBUS?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheBUS:ADDNewcommand..b: TheBUS:B<x>command tree..delete: TheBUS:DELetecommand..list: TheBUS:LISTcommand.
bustable
property
¶
bustable: Bustable
Return the BUSTABle command tree.
Usage
- Using the
.query()method will send theBUSTABle?query. - Using the
.verify(value)method will send theBUSTABle?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheBUSTABle:ADDNewcommand..delete: TheBUSTABle:DELetecommand..list: TheBUSTABle:LISTcommand.
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 theBUSY?query. - Using the
.verify(value)method will send theBUSY?query and raise an AssertionError if the returned value does not matchvalue.
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 matchvalue.
SCPI Syntax
- *CAL?
calibrate
property
¶
calibrate: Calibrate
Return the CALibrate command.
Description
- This query returns the status of signal path calibration.
Usage
- Using the
.query()method will send theCALibrate?query. - Using the
.verify(value)method will send theCALibrate?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- CALibrate?
Sub-properties
.internal: TheCALibrate:INTERNalcommand..pwrupstatus: TheCALibrate:PWRUpstatuscommand.
callouts
property
¶
callouts: Callouts
Return the CALLOUTS command tree.
Usage
- Using the
.query()method will send theCALLOUTS?query. - Using the
.verify(value)method will send theCALLOUTS?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheCALLOUTS:ADDNewcommand..callout: TheCALLOUTS:CALLOUT<x>command tree..delete: TheCALLOUTS:DELetecommand.
ch
property
¶
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 theCH<x>?query. - Using the
.verify(value)method will send theCH<x>?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- CH<x>?
Sub-properties
.bandwidth: TheCH<x>:BANdwidthcommand..clipping: TheCH<x>:CLIPpingcommand..coupling: TheCH<x>:COUPlingcommand..deskew: TheCH<x>:DESKewcommand..ditherrange: TheCH<x>:DITHERrangecommand..invert: TheCH<x>:INVertcommand..label: TheCH<x>:LABelcommand tree..offset: TheCH<x>:OFFSetcommand..position: TheCH<x>:POSitioncommand..probefunc: TheCH<x>:PROBEFunccommand tree..scaleratio: TheCH<x>:SCALERATiocommand..scale: TheCH<x>:SCAlecommand..termination: TheCH<x>:TERminationcommand..vterm: TheCH<x>:VTERmcommand tree.
clear
property
¶
clear: Clear
Return the CLEAR command.
Description
- This command clears acquisitions, measurements, and waveforms.
Usage
- Using the
.write()method will send theCLEARcommand.
SCPI Syntax
- CLEAR
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
*CLScommand 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. *CLSdoes not clear the output queue or MAV.*CLScan 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*CLScommand is executed.
Usage
- Using the
.write()method will send the*CLScommand.
SCPI Syntax
- *CLS
configuration
property
¶
configuration: Configuration
Return the CONFIGuration command tree.
Usage
- Using the
.query()method will send theCONFIGuration?query. - Using the
.verify(value)method will send theCONFIGuration?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.analog: TheCONFIGuration:ANALOgcommand tree.
connected
property
¶
connected: Connected
Return the CONNected command tree.
Usage
- Using the
.query()method will send theCONNected?query. - Using the
.verify(value)method will send theCONNected?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.requested: TheCONNected:REQUestedcommand tree..status: TheCONNected:STATuscommand..usage: TheCONNected:USAGecommand tree.
curve
property
¶
curve: Curve
Return the CURVe command.
Description
- This command transfers waveform data from the instrument. Each waveform that is
transferred has an associated waveform preamble that contains information such as data
format and scale. The
CURVe?query transfers data from the instrument. The data source is specified by theDATA:SOURCEcommand. The first and last data points are specified by theDATA:STARTandDATA:STOPcommands. For MATH sources, only 8-byte double precision floating point data is returned in:CURVe?queries.
Usage
- Using the
.query()method will send theCURVe?query. - Using the
.verify(value)method will send theCURVe?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- CURVe?
curvestream
property
¶
curvestream: Curvestream
Return the CURVEStream command.
Description
- This query-only command continuously transfers waveform data from the instrument as it
is acquired. This command puts the instrument into a streaming data mode, allowing the
controller to receive waveform records as fast as they are acquired. Use the
DATA:SOURCEcommand to specify the waveform sources. The command supports all the same data formatting options as the CURVE command. Control of the instrument through the user interface or other external clients is not allowed while in streaming data mode. The GPIB controller must take the instrument out of this streaming data mode to terminate the query and allow other input sources to resume communication with the instrument. The following options are available to transition out of streaming data mode: Send a device clear over the bus Send another command or query to the instrument Turning the waveform screen display mode off (:DISplay:WAVEform OFF) may increase waveform throughput during streaming mode. Using a data encoding of SRIbinary (DATa:ENCdg SRIbinary) may also increase the waveform throughput since that is the raw native data format of the oscilloscope. While in streaming data mode, two extreme conditions can occur. If the waveform records are being acquired slowly (high resolution), configure the controller for a long time-out threshold, as the data is not sent out until each complete record is acquired. If the waveform records are being acquired rapidly (low resolution), and the controller is not reading the data off the bus fast enough, the trigger rate is slowed to allow each waveform to be sent sequentially.
Usage
- Using the
.query()method will send theCURVEStream?query. - Using the
.verify(value)method will send theCURVEStream?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- CURVEStream?
customtable
property
¶
customtable: Customtable
Return the CUSTOMTABle command tree.
Usage
- Using the
.query()method will send theCUSTOMTABle?query. - Using the
.verify(value)method will send theCUSTOMTABle?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheCUSTOMTABle:ADDNewcommand..delete: TheCUSTOMTABle:DELetecommand..list: TheCUSTOMTABle:LISTcommand.
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 theDATa?query. - Using the
.verify(value)method will send theDATa?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATa valuecommand.
SCPI Syntax
- DATa {INIT|SNAp}
- DATa?
Info
INITinitializes the waveform data parameters to their factory defaults except forDATa:STOP, which isset to the current acquisition record length.SNApSetsDATa:STARtandDATa:STOPto match the current waveform cursor positions of WAVEVIEW1 CURSOR1 if these waveform cursors are currently on. If these waveform cursors are not on when theDATa SNApcommand is sent, it is silently ignored andDATa:STARtand:STOPremain unchanged.
Sub-properties
.encdg: TheDATa:ENCdgcommand..mode: TheDATa:MODecommand..resample: TheDATa:RESamplecommand..source: TheDATa:SOUrcecommand..start: TheDATa:STARtcommand..stop: TheDATa:STOPcommand..width: TheDATa:WIDthcommand.
date
property
¶
date: Date
Return the DATE command.
Description
- This command queries the date that the instrument displays.
Usage
- Using the
.query()method will send theDATE?query. - Using the
.verify(value)method will send theDATE?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DATE?
dch
property
¶
Return the DCH<x> command tree.
Usage
- Using the
.query()method will send theDCH<x>?query. - Using the
.verify(value)method will send theDCH<x>?query and raise an AssertionError if the returned value does not matchvalue.
Info
DCH<x>specifies the digital channel. The supported value is 1.
Sub-properties
.d: TheDCH<x>_D<x>command tree.
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*TRGcommand 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 matchvalue. - Using the
.write(value)method will send the*DDT valuecommand.
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 theDESE?query. - Using the
.verify(value)method will send theDESE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDESE valuecommand.
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 209sets 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.).
diag
property
¶
diag: Diag
Return the DIAg command tree.
Usage
- Using the
.query()method will send theDIAg?query. - Using the
.verify(value)method will send theDIAg?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.loop: TheDIAg:LOOPcommand tree..mode: TheDIAg:MODecommand..result: TheDIAg:RESUltcommand..select: TheDIAg:SELectcommand..state: TheDIAg:STATEcommand.
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 theDISplay?query. - Using the
.verify(value)method will send theDISplay?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DISplay?
Sub-properties
.colors: TheDISplay:COLorscommand..global: TheDISplay:GLObalcommand tree..intensity: TheDISplay:INTENSITycommand..mathfftview1: TheDISplay:MATHFFTView1command tree..persistence: TheDISplay:PERSistencecommand..plotview1: TheDISplay:PLOTView1command tree..reffftview: TheDISplay:REFFFTView<x>command tree..select: TheDISplay:SELectcommand tree..varpersist: TheDISplay:VARpersistcommand..waveview: TheDISplay:WAVEViewcommand tree..waveview1: TheDISplay:WAVEView1command tree..waveform: TheDISplay:WAVEformcommand..ch: TheDISplay:CH<x>command tree..math: TheDISplay:Math<x>command tree..ref: TheDISplay:REF<x>command tree.
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 matchvalue. - Using the
.write(value)method will send the*ESE valuecommand.
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 matchvalue.
SCPI Syntax
- *ESR?
ethernet
property
¶
ethernet: Ethernet
Return the ETHERnet command tree.
Usage
- Using the
.query()method will send theETHERnet?query. - Using the
.verify(value)method will send theETHERnet?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.dhcpbootp: TheETHERnet:DHCPbootpcommand..dns: TheETHERnet:DNScommand tree..domainname: TheETHERnet:DOMAINnamecommand..enet: TheETHERnet:ENETcommand tree..gateway: TheETHERnet:GATEWaycommand tree..ipaddress: TheETHERnet:IPADDresscommand..lxi: TheETHERnet:LXIcommand tree..name: TheETHERnet:NAMEcommand..networkconfig: TheETHERnet:NETWORKCONFigcommand..ping: TheETHERnet:PINGcommand..subnetmask: TheETHERnet:SUBNETMaskcommand.
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 theEVENT?query. - Using the
.verify(value)method will send theEVENT?query and raise an AssertionError if the returned value does not matchvalue.
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 theEVMsg?query. - Using the
.verify(value)method will send theEVMsg?query and raise an AssertionError if the returned value does not matchvalue.
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 theEVQty?query. - Using the
.verify(value)method will send theEVQty?query and raise an AssertionError if the returned value does not matchvalue.
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
*RSTcommand: 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 theFACtorycommand.
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 theFILESystem?query. - Using the
.verify(value)method will send theFILESystem?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- FILESystem?
Sub-properties
.copy: TheFILESystem:COPycommand..cwd: TheFILESystem:CWDcommand..delete: TheFILESystem:DELEtecommand..dir: TheFILESystem:DIRcommand..homedir: TheFILESystem:HOMEDircommand..ldir: TheFILESystem:LDIRcommand..mkdir: TheFILESystem:MKDircommand..mount: TheFILESystem:MOUNTcommand tree..readfile: TheFILESystem:READFilecommand..rename: TheFILESystem:RENamecommand..rmdir: TheFILESystem:RMDircommand..tekdrive: TheFILESystem:TEKDrivecommand tree..unmount: TheFILESystem:UNMOUNTcommand tree..writefile: TheFILESystem:WRITEFilecommand.
fpanel
property
¶
fpanel: Fpanel
Return the FPAnel command tree.
Usage
- Using the
.query()method will send theFPAnel?query. - Using the
.verify(value)method will send theFPAnel?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.press: TheFPAnel:PRESScommand..turn: TheFPAnel:TURNcommand.
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 theHEADer?query. - Using the
.verify(value)method will send theHEADer?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theHEADer valuecommand.
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.OFFsets the Response Header Enable State to false. This causes the instrument to omit headers on query responses, so that only the argument is returned.ONsets 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.
horizontal
property
¶
horizontal: Horizontal
Return the HORizontal command.
Description
- Queries the current horizontal settings.
Usage
- Using the
.query()method will send theHORizontal?query. - Using the
.verify(value)method will send theHORizontal?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- HORizontal?
Sub-properties
.acqduration: TheHORizontal:ACQDURATIONcommand..delay: TheHORizontal:DELaycommand tree..divisions: TheHORizontal:DIVisionscommand..main: TheHORizontal:MAIncommand tree..mode: TheHORizontal:MODEcommand..position: TheHORizontal:POSitioncommand..previewstate: TheHORizontal:PREViewstatecommand..recordlength: TheHORizontal:RECOrdlengthcommand..samplerate: TheHORizontal:SAMPLERatecommand..scale: TheHORizontal:SCAlecommand.
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 theID?query. - Using the
.verify(value)method will send theID?query and raise an AssertionError if the returned value does not matchvalue.
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 matchvalue.
SCPI Syntax
- *IDN?
lic
property
¶
lic: Lic
Return the LIC command tree.
Usage
- Using the
.query()method will send theLIC?query. - Using the
.verify(value)method will send theLIC?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.uninstall: TheLIC:UNINSTALLcommand.
license
property
¶
license: License
Return the LICense command.
Description
- This query-only command returns all license parameters.
Usage
- Using the
.query()method will send theLICense?query. - Using the
.verify(value)method will send theLICense?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- LICense?
Sub-properties
.appid: TheLICense:APPIDcommand..count: TheLICense:COUNtcommand..error: TheLICense:ERRorcommand..gmt: TheLICense:GMTcommand..hid: TheLICense:HIDcommand..install: TheLICense:INSTallcommand..item: TheLICense:ITEMcommand..list: TheLICense:LISTcommand..validate: TheLICense:VALidatecommand.
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 theLOCk?query. - Using the
.verify(value)method will send theLOCk?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theLOCk valuecommand.
SCPI Syntax
- LOCk {ALL|NONe}
- LOCk?
Info
ALLdisables all front panel controls and the touch screen.NONeenables all front panel controls and the touch screen. The UNLock ALL command only unlocks the front panel controls.NONecommand 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 matchvalue.
SCPI Syntax
- *LRN?
mainwindow
property
¶
mainwindow: Mainwindow
Return the MAINWindow command tree.
Usage
- Using the
.query()method will send theMAINWindow?query. - Using the
.verify(value)method will send theMAINWindow?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.badge: TheMAINWindow:BADGecommand tree..fontsize: TheMAINWindow:FONTSizecommand..rrbdisplaystate: TheMAINWindow:RRBDisplaystatecommand.
mask
property
¶
mask: Mask
Return the MASK command tree.
Usage
- Using the
.query()method will send theMASK?query. - Using the
.verify(value)method will send theMASK?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.delete: TheMASK:DELetecommand..mask: TheMASK:MASK<x>command tree..test: TheMASK:TEStcommand tree.
math
property
¶
math: Math
Return the MATH command tree.
Usage
- Using the
.query()method will send theMATH?query. - Using the
.verify(value)method will send theMATH?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheMATH:ADDNewcommand..delete: TheMATH:DELetecommand..list: TheMATH:LISTcommand..math: TheMATH:MATH<x>command tree.
meastable
property
¶
meastable: Meastable
Return the MEASTABle command tree.
Usage
- Using the
.query()method will send theMEASTABle?query. - Using the
.verify(value)method will send theMEASTABle?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheMEASTABle:ADDNewcommand..delete: TheMEASTABle:DELETEcommand.
measurement
property
¶
measurement: Measurement
Return the MEASUrement command.
Description
- This query-only command returns all measurement parameters.
Usage
- Using the
.query()method will send theMEASUrement?query. - Using the
.verify(value)method will send theMEASUrement?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MEASUrement?
Sub-properties
.addmeas: TheMEASUrement:ADDMEAScommand..addnew: TheMEASUrement:ADDNewcommand..annotate: TheMEASUrement:ANNOTatecommand..ch: TheMEASUrement:CH<x>command tree..deleteall: TheMEASUrement:DELETEALLcommand..delete: TheMEASUrement:DELetecommand..edge: TheMEASUrement:EDGE<x>command..gating: TheMEASUrement:GATingcommand..interp: TheMEASUrement:INTERpcommand..list: TheMEASUrement:LISTcommand..math: TheMEASUrement:MATH<x>command tree..meas: TheMEASUrement:MEAS<x>command tree..ref: TheMEASUrement:REF<x>command tree..reflevels: TheMEASUrement:REFLevelscommand tree..statistics: TheMEASUrement:STATIsticscommand tree.
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 theNEWpass valuecommand.
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*OPCcommand 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 matchvalue. - Using the
.write()method will send the*OPCcommand.
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 matchvalue.
SCPI Syntax
- *OPT?
password
property
¶
password: Password
Return the PASSWord command.
Description
- This command (no query form) enables the
*PUDand NEWpass set commands. SendingPASSWordwithout any arguments disables these same commands. Once the password is successfully entered, the*PUDand NEWpass commands are enabled until the instrument is powered off, or until the FACtory command, thePASSWordcommand with no arguments, or the*RSTcommand is issued. To change the password, you must first enter the valid password with thePASSWordcommand 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 thePASSWord valuecommand.
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 thePAUSe valuecommand.
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.
pg
property
¶
pg: Pg
Return the PG command tree.
Usage
- Using the
.query()method will send thePG?query. - Using the
.verify(value)method will send thePG?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.amplitude: ThePG:AMPlitudecommand..bit: ThePG:BITcommand tree..bitrate: ThePG:BITRatecommand..burst: ThePG:BURStcommand tree..file: ThePG:FILEcommand tree..output: ThePG:OUTPutcommand tree..patterndefinition: ThePG:PATTERNdefinitioncommand.
plot
property
¶
plot: Plot
Return the PLOT command tree.
Usage
- Using the
.query()method will send thePLOT?query. - Using the
.verify(value)method will send thePLOT?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: ThePLOT:ADDNewcommand..delete: ThePLOT:DELetecommand..list: ThePLOT:LISTcommand..plot: ThePLOT:PLOT<x>command tree.
power
property
¶
power: Power
Return the POWer command tree.
Usage
- Using the
.query()method will send thePOWer?query. - Using the
.verify(value)method will send thePOWer?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: ThePOWer:ADDNewcommand..delete: ThePOWer:DELetecommand..power: ThePOWer:POWer<x>command tree.
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
*PSCis true, the DESER register is set to 255 and the SRER and ESER registers are set to 0 at power-on. When*PSCis 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 matchvalue. - Using the
.write(value)method will send the*PSC valuecommand.
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.OFFsets the power-on status clear flag to false, disables the power-on clear and allows the instrument to possibly assert SRQ after power-on.ONsets 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 matchvalue. - Using the
.write(value)method will send the*PUD valuecommand.
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.
recall
property
¶
recall: Recall
Return the RECAll command tree.
Usage
- Using the
.query()method will send theRECAll?query. - Using the
.verify(value)method will send theRECAll?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.mask: TheRECAll:MASKcommand..session: TheRECAll:SESsioncommand..setup: TheRECAll:SETUpcommand..waveform: TheRECAll:WAVEformcommand.
ref
property
¶
ref: Ref
Return the REF command tree.
Usage
- Using the
.query()method will send theREF?query. - Using the
.verify(value)method will send theREF?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheREF:ADDNewcommand..delete: TheREF:DELetecommand..list: TheREF:LISTcommand..ref: TheREF:REF<x>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 theREM valuecommand.
SCPI Syntax
- REM <QString>
Info
<QString>is a string that can contain a maximum of 80 characters.
rosc
property
¶
rosc: Rosc
Return the ROSc command tree.
Usage
- Using the
.query()method will send theROSc?query. - Using the
.verify(value)method will send theROSc?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.source: TheROSc:SOUrcecommand..state: TheROSc:STATEcommand.
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
*DDTcommand. Disables aliases (:ALIAS:STATE 0). Disables the user password (for the*PUDcommand). The*RSTcommand does not change the following: The current working directory (:FILESystem:CWDcommand). The state of command headers (:HEADercommand). The state of keyword and enumeration verbosity (:VERBosecommand). The Power-on Status Clear Flag (*PSCcommand). The Event Status Enable Register (*ESEcommand). The Service Request Enable Register (*SREcommand). The Device Event Status Enable Register ( DESE command). The user password for protected user data (:PASSWordcommand). The content of protected user data (*PUDcommand). The enabled state of the socket server (:SOCKETServer:ENAblecommand). The socket server port number (:SOCKETServer:PORTcommand). The socket server protocol (:SOCKETServer:PROTOColcommand). The USBTMC port configuration (:USBDevice:CONFigurecommand). The destination reference waveform or file path for the:CURVecommand (:DATa:DESTinationcommand). The source waveform for the:CURVe?or:WAVFrm?queries (:DATa:SOUrcecommand). The waveform data encoding for the:CURVecommand or query or the:WAVFrm?query (:DATa:ENCdgcommand). The starting point for:CURVe?queries (:DATa:STARtcommand). The ending point for:CURVe?queries (:DATa:STOPcommand). All settings associated the:WFMInprecommands. All user settable settings associated with the WFMOutpre commands.*RSTonly resets the programmable interface settings, it does not change the user interface settings.
Usage
- Using the
.write()method will send the*RSTcommand.
SCPI Syntax
- *RST
save
property
¶
save: Save
Return the SAVe command tree.
Usage
- Using the
.query()method will send theSAVe?query. - Using the
.verify(value)method will send theSAVe?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.eventtable: TheSAVe:EVENTtablecommand tree..image: TheSAVe:IMAGecommand..plotdata: TheSAVe:PLOTDatacommand..report: TheSAVe:REPOrtcommand..session: TheSAVe:SESsioncommand..setup: TheSAVe:SETUpcommand..waveform: TheSAVe:WAVEformcommand.
saveon
property
¶
saveon: Saveon
Return the SAVEON command tree.
Usage
- Using the
.query()method will send theSAVEON?query. - Using the
.verify(value)method will send theSAVEON?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.file: TheSAVEON:FILEcommand tree..image: TheSAVEON:IMAGecommand..trigger: TheSAVEON:TRIGgercommand..waveform: TheSAVEON:WAVEformcommand.
saveonevent
property
¶
saveonevent: Saveonevent
Return the SAVEONEVent command tree.
Usage
- Using the
.query()method will send theSAVEONEVent?query. - Using the
.verify(value)method will send theSAVEONEVent?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.filedest: TheSAVEONEVent:FILEDestcommand..filename: TheSAVEONEVent:FILENamecommand..image: TheSAVEONEVent:IMAGecommand tree..waveform: TheSAVEONEVent:WAVEformcommand tree.
search
property
¶
search: Search
Return the SEARCH command tree.
Usage
- Using the
.query()method will send theSEARCH?query. - Using the
.verify(value)method will send theSEARCH?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.addnew: TheSEARCH:ADDNewcommand..deleteall: TheSEARCH:DELETEALLcommand..delete: TheSEARCH:DELetecommand..list: TheSEARCH:LISTcommand..search: TheSEARCH:SEARCH<x>command tree..selected: TheSEARCH:SELectedcommand.
select
property
¶
select: Select
Return the SELect command tree.
Usage
- Using the
.query()method will send theSELect?query. - Using the
.verify(value)method will send theSELect?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.ch: TheSELect:CH<x>command..dch: TheSELect:DCH<x>command tree.
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. TheSET?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 theSET?query. - Using the
.verify(value)method will send theSET?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SET?
socketserver
property
¶
socketserver: Socketserver
Return the SOCKETServer command tree.
Usage
- Using the
.query()method will send theSOCKETServer?query. - Using the
.verify(value)method will send theSOCKETServer?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.enable: TheSOCKETServer:ENAblecommand..port: TheSOCKETServer:PORTcommand..protocol: TheSOCKETServer:PROTOColcommand.
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 matchvalue. - Using the
.write(value)method will send the*SRE valuecommand.
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*PSCis 1. If*PSCis 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 matchvalue.
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 theTEKSecurecommand.
SCPI Syntax
- TEKSecure
time
property
¶
time: Time
Return the TIMe command.
Description
- This command sets the time in the form
hh:mm:sswhere 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 theTIMe?query. - Using the
.verify(value)method will send theTIMe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theTIMe valuecommand.
SCPI Syntax
- TIMe <QString>
- TIMe?
Info
<QString>is a quoted string representing the desired time.
Sub-properties
.zone: TheTIMe:ZONecommand.
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 theTOTaluptime?query. - Using the
.verify(value)method will send theTOTaluptime?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- TOTaluptime?
touchscreen
property
¶
touchscreen: Touchscreen
Return the TOUCHSCReen command tree.
Usage
- Using the
.query()method will send theTOUCHSCReen?query. - Using the
.verify(value)method will send theTOUCHSCReen?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.state: TheTOUCHSCReen:STATecommand.
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*TRGcommand.
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 theTRIGger?query. - Using the
.verify(value)method will send theTRIGger?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theTRIGger valuecommand.
SCPI Syntax
- TRIGger FORCe
- TRIGger?
Info
FORCecreates a trigger event. IfTRIGger:STATEis 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: TheTRIGger:Acommand..auxlevel: TheTRIGger:AUXLevelcommand..hysteresis: TheTRIGger:HYSTeresiscommand tree..state: TheTRIGger:STATEcommand.
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 matchvalue.
SCPI Syntax
- *TST?
undo
property
¶
undo: Undo
Return the UNDO command.
Description
- Reverts the instrument settings to a state before the previous command or user interface action.
Usage
- Using the
.write()method will send theUNDOcommand.
SCPI Syntax
- UNDO
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 ONenables the touch screen only.
Usage
- Using the
.write(value)method will send theUNLock valuecommand.
SCPI Syntax
- UNLock ALL
Info
ALLspecifies 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 theUSBDevice?query. - Using the
.verify(value)method will send theUSBDevice?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.configure: TheUSBDevice:CONFigurecommand.
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 theVERBose valuecommand.
SCPI Syntax
- VERBose {ON|OFF|<NR1>}
Info
<NR1>= 0 disables Verbose, any other value enables Verbose.OFFsets the Verbose state to false, which returns minimum-length keywords for applicable setting queries.ONsets the Verbose state to true, which returns full-length keywords for applicable setting queries.
vertical
property
¶
vertical: Vertical
Return the VERTical command tree.
Usage
- Using the
.query()method will send theVERTical?query. - Using the
.verify(value)method will send theVERTical?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.deskew: TheVERTical:DESKewcommand tree.
vxi
property
¶
vxi: Vxi
Return the VXI command tree.
Usage
- Using the
.query()method will send theVXI?query. - Using the
.verify(value)method will send theVXI?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.enable: TheVXI:ENAblecommand..port: TheVXI:PORTcommand tree.
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*WAIcommand.
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:SOUrceusing the:DATasettings for encoding, width, and so forth.
Usage
- Using the
.query()method will send theWAVFrm?query. - Using the
.verify(value)method will send theWAVFrm?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- WAVFrm?
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:SOURCEcommand. 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 theDATa:SOUrcespecified waveform.
Usage
- Using the
.query()method will send theWFMOutpre?query. - Using the
.verify(value)method will send theWFMOutpre?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- WFMOutpre?
Sub-properties
.asc_fmt: TheWFMOutpre:ASC_Fmtcommand..bit_nr: TheWFMOutpre:BIT_Nrcommand..bn_fmt: TheWFMOutpre:BN_Fmtcommand..byt_nr: TheWFMOutpre:BYT_Nrcommand..byt_or: TheWFMOutpre:BYT_Orcommand..centerfrequency: TheWFMOutpre:CENTERFREQuencycommand..domain: TheWFMOutpre:DOMaincommand..encdg: TheWFMOutpre:ENCdgcommand..nr_pt: TheWFMOutpre:NR_Ptcommand..pt_fmt: TheWFMOutpre:PT_Fmtcommand..pt_order: TheWFMOutpre:PT_ORdercommand..pt_off: TheWFMOutpre:PT_Offcommand..resample: TheWFMOutpre:RESamplecommand..span: TheWFMOutpre:SPANcommand..wfid: TheWFMOutpre:WFIdcommand..wfmtype: TheWFMOutpre:WFMTYPecommand..xincr: TheWFMOutpre:XINcrcommand..xunit: TheWFMOutpre:XUNitcommand..xzero: TheWFMOutpre:XZErocommand..ymult: TheWFMOutpre:YMUltcommand..yoff: TheWFMOutpre:YOFfcommand..yunit: TheWFMOutpre:YUNitcommand..yzero: TheWFMOutpre:YZErocommand.
MSO2Mixin
¶
A mixin that provides access to the MSO2 commands and constants.
Properties
.command_argument_constants: The MSO2 command argument constants..commands: The MSO2 commands.
command_argument_constants
cached
property
¶
command_argument_constants: MSO2CommandConstants
Return the MSO2 command argument constants.
This provides access to all the string constants which can be used as arguments for MSO2 commands.
commands
cached
property
¶
commands: MSO2Commands
Return the MSO2 commands.
This provides access to all the commands for the MSO2 device. See the documentation of each sub-property for more usage information.
Sub-properties
.acquire: TheACQuirecommand..actonevent: TheACTONEVentcommand tree..afg: TheAFGcommand tree..alias: TheALIascommand..allev: TheALLEvcommand..autosavepitimeout: TheAUTOSAVEPITIMEOUTcommand..autosaveuitimeout: TheAUTOSAVEUITIMEOUTcommand..autoset: TheAUTOSetcommand..auxout: TheAUXoutcommand tree..battery: TheBATTerycommand tree..bus: TheBUScommand tree..bustable: TheBUSTABlecommand tree..busy: TheBUSYcommand..cal: The*CALcommand..calibrate: TheCALibratecommand..callouts: TheCALLOUTScommand tree..ch: TheCH<x>command..clear: TheCLEARcommand..cls: The*CLScommand..configuration: TheCONFIGurationcommand tree..connected: TheCONNectedcommand tree..curve: TheCURVecommand..curvestream: TheCURVEStreamcommand..customtable: TheCUSTOMTABlecommand tree..data: TheDATacommand..date: TheDATEcommand..dch: TheDCH<x>command tree..ddt: The*DDTcommand..dese: TheDESEcommand..diag: TheDIAgcommand tree..display: TheDISplaycommand..ese: The*ESEcommand..esr: The*ESRcommand..ethernet: TheETHERnetcommand tree..event: TheEVENTcommand..evmsg: TheEVMsgcommand..evqty: TheEVQtycommand..factory: TheFACtorycommand..filesystem: TheFILESystemcommand..fpanel: TheFPAnelcommand tree..header: TheHEADercommand..horizontal: TheHORizontalcommand..id: TheIDcommand..idn: The*IDNcommand..lic: TheLICcommand tree..license: TheLICensecommand..lock: TheLOCkcommand..lrn: The*LRNcommand..mainwindow: TheMAINWindowcommand tree..mask: TheMASKcommand tree..math: TheMATHcommand tree..meastable: TheMEASTABlecommand tree..measurement: TheMEASUrementcommand..newpass: TheNEWpasscommand..opc: The*OPCcommand..opt: The*OPTcommand..password: ThePASSWordcommand..pause: ThePAUSecommand..pg: ThePGcommand tree..plot: ThePLOTcommand tree..power: ThePOWercommand tree..psc: The*PSCcommand..pud: The*PUDcommand..recall: TheRECAllcommand tree..ref: TheREFcommand tree..rem: TheREMcommand..rosc: TheROSccommand tree..rst: The*RSTcommand..save: TheSAVecommand tree..saveon: TheSAVEONcommand tree..saveonevent: TheSAVEONEVentcommand tree..search: TheSEARCHcommand tree..select: TheSELectcommand tree..set: TheSETcommand..socketserver: TheSOCKETServercommand tree..sre: The*SREcommand..stb: The*STBcommand..teksecure: TheTEKSecurecommand..time: TheTIMecommand..totaluptime: TheTOTaluptimecommand..touchscreen: TheTOUCHSCReencommand tree..trg: The*TRGcommand..trigger: TheTRIGgercommand..tst: The*TSTcommand..undo: TheUNDOcommand..unlock: TheUNLockcommand..usbdevice: TheUSBDevicecommand tree..verbose: TheVERBosecommand..vertical: TheVERTicalcommand tree..vxi: TheVXIcommand tree..wai: The*WAIcommand..wavfrm: TheWAVFrmcommand..wfmoutpre: TheWFMOutprecommand.