mso5k_commands
¶
The MSO5K commands module.
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
MSO5KCommandConstants
¶
The MSO5K command argument constants.
This provides access to all the string constants which can be used as arguments for MSO5K commands.
MSO5KCommands
¶
The MSO5K commands.
This provides access to all the commands for the MSO5K device. See the documentation of each property for more usage information.
Properties
.acquire: TheACQuirecommand tree..alias: TheALIascommand..allev: TheALLEvcommand..allocate: TheALLOcatecommand tree..application: TheAPPLicationcommand tree..autoset: TheAUTOSetcommand..auxin: TheAUXIncommand tree..auxout: TheAUXoutcommand..bell: TheBELlcommand..bus: TheBUScommand tree..busy: TheBUSYcommand..cal: The*CALcommand..calibrate: TheCALibratecommand..ch: TheCH<x>command..clear: TheCLEARcommand..cls: The*CLScommand..cmdbatch: TheCMDBatchcommand..counter: TheCOUntercommand tree..cq: TheCQ<x>command tree..cursor: TheCURSorcommand..curve: TheCURVecommand..curvenext: TheCURVENextcommand..curvestream: TheCURVEStreamcommand..custom: TheCUSTOMcommand tree..d: TheD<x>command tree..data: TheDATacommand..date: TheDATEcommand..ddt: The*DDTcommand..delete: TheDELEtecommand tree..dese: TheDESEcommand..diag: TheDIAgcommand tree..display: TheDISplaycommand..email: TheEMailcommand..errordetector: TheERRORDetectorcommand tree..ese: The*ESEcommand..esr: The*ESRcommand..event: TheEVENTcommand..evmsg: TheEVMsgcommand..evqty: TheEVQtycommand..export: TheEXPortcommand..factory: TheFACtorycommand..fastacq: TheFASTAcqcommand..filesystem: TheFILESystemcommand..gpibusb: TheGPIBUsbcommand tree..hardcopy: TheHARDCopycommand..hdr: TheHDRcommand..header: TheHEADercommand..histogram: TheHIStogramcommand..horizontal: TheHORizontalcommand..id: TheIDcommand..idn: The*IDNcommand..limit: TheLIMitcommand..linktraining: TheLINKTRainingcommand tree..lock: TheLOCkcommand..lrn: The*LRNcommand..mark: TheMARKcommand..mask: TheMASKcommand..math: TheMATH<x>command..matharbflt: TheMATHArbflt<x>command tree..mathvar: TheMATHVARcommand..mch: TheMCH<x>command tree..measurement: TheMEASUrementcommand..multiscope: TheMULTiscopecommand tree..newpass: TheNEWpasscommand..opc: The*OPCcommand..opcextended: TheOPCEXtendedcommand..opt: The*OPTcommand..password: ThePASSWordcommand..pcenable: ThePCENablecommand..psc: The*PSCcommand..pud: The*PUDcommand..rcl: The*RCLcommand..recall: TheRECAllcommand tree..ref: TheREF<x>command tree..rem: TheREMcommand..rosc: TheROSccommand tree..rst: The*RSTcommand..sav: The*SAVcommand..save: TheSAVecommand tree..saveon: TheSAVEONcommand..sds: The*SDScommand..search: TheSEARCHcommand tree..select: TheSELectcommand..set: TheSETcommand..setup: TheSETUpcommand tree..sre: The*SREcommand..stb: The*STBcommand..system: TheSYSTemcommand tree..teklink: TheTEKLinkcommand tree..teksecure: TheTEKSecurecommand..test: TheTESTcommand..time: TheTIMEcommand..trg: The*TRGcommand..trig: TheTRIGcommand tree..trigger: TheTRIGgercommand..tst: The*TSTcommand..unlock: TheUNLockcommand..usbtmc: TheUSBTMCcommand tree..verbose: TheVERBosecommand..visual: TheVISualcommand..wai: The*WAIcommand..wavfrm: TheWAVFrmcommand..wavfrmstream: TheWAVFRMStreamcommand..wfminpre: TheWFMInprecommand..wfmoutpre: TheWFMOutprecommand..wfmpre: TheWFMPrecommand tree..zoom: TheZOOmcommand.
acquire
property
¶
acquire: Acquire
Return the ACQuire command tree.
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.
Sub-properties
.enhancedenob: TheACQuire:ENHANCEDEnobcommand..interpeightbit: TheACQuire:INTERPEightbitcommand..magnivu: TheACQuire:MAGnivucommand..mode: TheACQuire:MODecommand..numacq: TheACQuire:NUMACqcommand..numavg: TheACQuire:NUMAVgcommand..numenv: TheACQuire:NUMEnvcommand..numframesacquired: TheACQuire:NUMFRAMESACQuiredcommand..numsamples: TheACQuire:NUMSAMplescommand..samplingmode: TheACQuire:SAMPlingmodecommand..state: TheACQuire:STATEcommand..stopafter: TheACQuire:STOPAftercommand..syncsamples: TheACQuire:SYNcsamplescommand.
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?
allocate
property
¶
allocate: Allocate
Return the ALLOcate command tree.
Usage
- Using the
.query()method will send theALLOcate?query. - Using the
.verify(value)method will send theALLOcate?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.waveform: TheALLOcate:WAVEformcommand tree.
application
property
¶
application: Application
Return the APPLication command tree.
Usage
- Using the
.query()method will send theAPPLication?query. - Using the
.verify(value)method will send theAPPLication?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.activate: TheAPPLication:ACTivatecommand..scopeapp: TheAPPLication:SCOPEAPPcommand tree.
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. (To autoset a video waveform, the video trigger must be set to video standard, not custom. Video arguments require video hardware.) This is equivalent to pressing the front panel AUTOSET button. For a detailed description of autoset functionality, see Autoset in the index of the online help for your instrument.
Usage
- Using the
.write(value)method will send theAUTOSet valuecommand.
SCPI Syntax
- AUTOSet {EXECute|UNDo|VFields|VIDeo|VLines}
Info
EXECuteruns the autoset routine; this is equivalent to pressing the front panel AUTOSET button. If the display is set to a PAL, MV, or IRE graticule, this argument forces the graticule display to full mode (frame, grid, and cross hair).UNDoreturns the instrument to the setting prior to executing an autoset.VFieldsautosets the displayed waveform.VIDeoautosets the displayed waveform.VLinesautosets the displayed waveform.
Sub-properties
.overlay: TheAUTOSet:OVErlaycommand..percent: TheAUTOSet:PERcentcommand.
auxin
property
¶
auxin: Auxin
Return the AUXIn command tree.
Usage
- Using the
.query()method will send theAUXIn?query. - Using the
.verify(value)method will send theAUXIn?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.bandwidth: TheAUXIn:BANdwidthcommand..coupling: TheAUXIn:COUPlingcommand..offset: TheAUXIn:OFFSetcommand..probefunc: TheAUXIn:PROBEFunccommand tree..probe: TheAUXIn:PRObecommand tree..vterm: TheAUXIn:VTERmcommand tree.
auxout
property
¶
auxout: Auxout
Return the AUXout command.
Description
- This query-only command returns the auxiliary output setup and is equivalent to selecting External Signals. From the Utilities menu, and then viewing the current settings for the AUX OUT Configuration.
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.
SCPI Syntax
- AUXout?
Sub-properties
.edge: TheAUXout:EDGEcommand..source: TheAUXout:SOUrcecommand.
bell
property
¶
bell: Bell
Return the BELl command.
Description
- This command was previously used to beep an audio indicator and is provided for backward compatibility.
Usage
- Using the
.write()method will send theBELlcommand.
SCPI Syntax
- BELl
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
.b1: TheBUS:B1<x>command tree..b: TheBUS:B<x>command tree..ch: TheBUS:CH<x>command tree..math: TheBUS:MATH<x>command tree..ref: TheBUS:REF<x>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 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
.calprobe: TheCALibrate:CALProbecommand tree..internal: TheCALibrate:INTERNalcommand..probestate: TheCALibrate:PRObestatecommand tree..results: TheCALibrate:RESultscommand.
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
.atiactive: TheCH<x>:ATIACTivecommand..available: TheCH<x>:AVAILablecommand..bandwidth: TheCH<x>:BANdwidthcommand..coupling: TheCH<x>:COUPlingcommand..deskew: TheCH<x>:DESKewcommand..fastacqcapable: TheCH<x>:FASTAcqcapablecommand..fastframecapable: TheCH<x>:FASTFRamecapablecommand..icapture: TheCH<x>:ICAPturecommand tree..invert: TheCH<x>:INVertcommand..label: TheCH<x>:LABelcommand tree..offset: TheCH<x>:OFFSetcommand..opti: TheCH<x>:OPTIcommand tree..optical: TheCH<x>:OPTIcalcommand tree..position: TheCH<x>:POSitioncommand..probecontrol: TheCH<x>:PROBECOntrolcommand..probecal: TheCH<x>:PROBECalcommand..probefunc: TheCH<x>:PROBEFunccommand tree..probe: TheCH<x>:PRObecommand..scale: TheCH<x>:SCAlecommand..termination: TheCH<x>:TERminationcommand..threshold: TheCH<x>:THRESHoldcommand..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(value)method will send theCLEAR valuecommand.
SCPI Syntax
- CLEAR {ALL}
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
cmdbatch
property
¶
cmdbatch: Cmdbatch
Return the CMDBatch command.
Description
- This command sets or queries the state of command batching. By batching commands, database transactions can be optimized, increasing command throughput. Also, batching allows for ALL commands in an individual batch to be order independent and accomplish the same result as if the commands were coupled. The Batch state is persistent and will be saved across power cycles, but will not be saved and recalled as part of a setup. In a setup scenario, the factory initial value is enabled.
Usage
- Using the
.query()method will send theCMDBatch?query. - Using the
.verify(value)method will send theCMDBatch?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theCMDBatch valuecommand.
SCPI Syntax
- CMDBatch {<NR1>OFF|ON}
- CMDBatch?
Info
<NR1>= 0 turns command batching off; any other value turns command batching on.OFFturns command batching off.ONturns command batching on.
counter
property
¶
counter: Counter
Return the COUnter command tree.
Usage
- Using the
.query()method will send theCOUnter?query. - Using the
.verify(value)method will send theCOUnter?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.results: TheCOUnter:RESULTscommand.
cq
property
¶
Return the CQ<x> command tree.
Usage
- Using the
.query()method will send theCQ<x>?query. - Using the
.verify(value)method will send theCQ<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.threshold: TheCQ<x>:THRESHoldcommand.
cursor
property
¶
cursor: Cursor
Return the CURSor command.
Description
- Returns all of the current cursor settings.
Usage
- Using the
.query()method will send theCURSor?query. - Using the
.verify(value)method will send theCURSor?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- CURSor?
Sub-properties
.function: TheCURSor:FUNCtioncommand..hbars: TheCURSor:HBArscommand..linestyle: TheCURSor:LINESTylecommand..mode: TheCURSor:MODecommand..screen: TheCURSor:SCREENcommand tree..source1: TheCURSor:SOUrce1command..state: TheCURSor:STATEcommand..vbars: TheCURSor:VBArscommand..waveform: TheCURSor:WAVEformcommand..xy: TheCURSor:XYcommand.
curve
property
¶
curve: Curve
Return the CURVe command.
Description
- The
CURVecommand transfers the waveform data points the oscilloscope’s internal reference memory location (REF1-4), which is specified by the toDATa:DESTinationcommand. TheCURVe?query transfers data the oscilloscope; the source waveform is specified by the fromDATa:SOUrcecommand. The first and last data points are specified by theDATa:STARtandDATa:STOPcommands. Associated with each waveform transferred using theCURVecommand 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. TheCURVecommand andCURVe?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: #Nwhere: 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 theCURVe?query. - Using the
.verify(value)method will send theCURVe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theCURVe valuecommand.
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).
curvenext
property
¶
curvenext: Curvenext
Return the CURVENext command.
Description
- This query-only command returns unique waveform data from the instrument. This query
performs just like CURVE?, except multiple uses guarantee that the waveform returned
is always a new acquisition since the previous CURVENEXT. Note that if the instrument
is acquiring waveform records at a slow rate (high resolution mode), you must
configure the controller for long timeout thresholds. Data will not be transferred
until a new waveform is acquired since the previous
:CURVENext?response.
Usage
- Using the
.query()method will send theCURVENext?query. - Using the
.verify(value)method will send theCURVENext?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- CURVENext?
curvestream
property
¶
curvestream: Curvestream
Return the CURVEStream command.
Description
- This query continuously transfers waveform data from the instrument as it is acquired.
This command puts the instrument into a talk-only mode, allowing the controller to
receive waveform records as fast as (and as soon as) they are acquired. Use the
DATA:SOURCEcommand to specify the waveform sources. The command does the same thing as the CURVE command. Control of the instrument through the user interface or other external client is not possible while in streaming mode. The GPIB controller must take the instrument out of this continuous talking 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 curve mode: send a device clear over the bus or send another query to the instrument (a MEPE Query Interrupted error will occur, but the instrument will be placed back into its normal talk/listen mode). Turning the waveform screen display mode off (:DISPLAY:WAVEFORM OFF) will increase waveform throughput during streaming mode. While in streaming mode, two extreme conditions can occur. If the waveform records are being acquired slowly (high resolution), configure the controller for long time-out thresholds, 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. - Using the
.write(value)method will send theCURVEStream valuecommand.
SCPI Syntax
- CURVEStream {<Block>|<asc curve>}
- CURVEStream?
custom
property
¶
custom: Custom
Return the CUSTOM command tree.
Usage
- Using the
.query()method will send theCUSTOM?query. - Using the
.verify(value)method will send theCUSTOM?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.gate: TheCUSTOM:GATE<x>command tree..select: TheCUSTOM:SELECTcommand tree.
d
property
¶
d: dict[int, DigitalBit]
Return the D<x> command tree.
Usage
- Using the
.query()method will send theD<x>?query. - Using the
.verify(value)method will send theD<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.label: TheD<x>:LABELcommand..position: TheD<x>:POSitioncommand..probe: TheD<x>:PROBEcommand tree..threshold: TheD<x>:THRESHoldcommand.
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
.destination: TheDATa:DESTinationcommand..encdg: TheDATa:ENCdgcommand..framestart: TheDATa:FRAMESTARtcommand..framestop: TheDATa:FRAMESTOPcommand..source: TheDATa:SOUrcecommand..start: TheDATa:STARtcommand..stop: TheDATa:STOPcommand..syncsources: TheDATa:SYNCSOUrcescommand.
date
property
¶
date: Date
Return the DATE command.
Description
- This command specifies the date the oscilloscope 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. - Using the
.write(value)method will send theDATE valuecommand.
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*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.
delete
property
¶
delete: Delete
Return the DELEte command tree.
Usage
- Using the
.query()method will send theDELEte?query. - Using the
.verify(value)method will send theDELEte?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.setup: TheDELEte:SETUpcommand..waveform: TheDELEte:WAVEformcommand.
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
.control: TheDIAg:CONTROLcommand tree..execute: TheDIAg:EXECUTEcommand..failures: TheDIAg:FAILUREScommand tree..item: TheDIAg:ITEMcommand..level: TheDIAg:LEVELcommand..loops: TheDIAg:LOOPScommand..name: TheDIAg:NAMecommand..numitems: TheDIAg:NUMITEMScommand..results: TheDIAg:RESultscommand..select: TheDIAg:SELectcommand tree..state: TheDIAg:STATEcommand..stop: TheDIAg:STOPcommand.
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
.clock: TheDISplay:CLOCkcommand..color: TheDISplay:COLOrcommand..data: TheDISplay:DATacommand..deskew: TheDISplay:DESKewcommand..digital: TheDISplay:DIGitalcommand tree..dpojetplot: TheDISplay:DPOJETPlotcommand..filter: TheDISplay:FILTercommand..format: TheDISplay:FORMatcommand..graticule: TheDISplay:GRAticulecommand..intensity: TheDISplay:INTENSITycommand..persistence: TheDISplay:PERSistencecommand..screentext: TheDISplay:SCREENTExtcommand..showremote: TheDISplay:SHOWREmotecommand..style: TheDISplay:STYlecommand..trigbar: TheDISplay:TRIGBarcommand..trigt: TheDISplay:TRIGTcommand..varpersist: TheDISplay:VARpersistcommand..waveform: TheDISplay:WAVEformcommand.
email
property
¶
email: Email
Return the EMail command.
Description
- This command (no query form) sends a test e-mail message or sets the current e-mail sent count to zero.
Usage
- Using the
.write(value)method will send theEMail valuecommand.
SCPI Syntax
- EMail {TESt|RESET}
Info
TEStargument sends a test e-mail message.RESETargument sets the e-mail sent count to zero.
Sub-properties
.attempts: TheEMail:ATTemptscommand..authlogin: TheEMail:AUTHLogincommand..authpassword: TheEMail:AUTHPasswordcommand..count: TheEMail:COUNtcommand..from: TheEMail:FROmcommand..hostwanted: TheEMail:HOSTwantedcommand..image: TheEMail:IMAGecommand..limit: TheEMail:LIMitcommand..mask: TheEMail:MASKcommand..maxsize: TheEMail:MAXSizecommand..measurement: TheEMail:MEASUrementcommand..numemails: TheEMail:NUMEMailscommand..smtpport: TheEMail:SMTPPortcommand..smtpserver: TheEMail:SMTPServercommand..status: TheEMail:STATUScommand..timeout: TheEMail:TIMEOutcommand..to: TheEMail:TOcommand..trigger: TheEMail:TRIGgercommand..waveform: TheEMail:WAVEformcommand.
errordetector
property
¶
errordetector: Errordetector
Return the ERRORDetector command tree.
Usage
- Using the
.query()method will send theERRORDetector?query. - Using the
.verify(value)method will send theERRORDetector?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.alert: TheERRORDetector:ALERTcommand..aligncharacter: TheERRORDetector:ALIGNCHARactercommand..alignprimitive: TheERRORDetector:ALIGNPRIMitivecommand..bit: TheERRORDetector:BITcommand tree..bitrate: TheERRORDetector:BITRatecommand..channel: TheERRORDetector:CHANnelcommand..duration: TheERRORDetector:DURATIONcommand tree..errorlimit: TheERRORDetector:ERRORLIMITcommand..file: TheERRORDetector:FILEcommand tree..fontsize: TheERRORDetector:FONTSIzecommand..frame: TheERRORDetector:FRAmecommand..maxaligns: TheERRORDetector:MAXALIGNScommand..patternname: TheERRORDetector:PATTERNNAMEcommand..preset: TheERRORDetector:PREsetcommand..saveimage: TheERRORDetector:SAVEIMAGEcommand..savewfm: TheERRORDetector:SAVEWFMcommand..scrambled: TheERRORDetector:SCRAMBLEDcommand..sendemail: TheERRORDetector:SENDEMAILcommand..signaltype: TheERRORDetector:SIGnaltypecommand..ssc: TheERRORDetector:SSCcommand..standard: TheERRORDetector:STANdardcommand..state: TheERRORDetector:STATEcommand..status: TheERRORDetector:STATuscommand..stopwhen: TheERRORDetector:STOPWHENcommand..symbol: TheERRORDetector:SYMBOLcommand..timeformat: TheERRORDetector:TIMEformatcommand..type: TheERRORDetector:TYPecommand.
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?
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?
export
property
¶
export: Export
Return the EXPort command.
Description
- This command sends a copy of the waveform to the file path specified by
EXPORT:FILENAME. TheEXPortquery returns image format and file information.
Usage
- Using the
.query()method will send theEXPort?query. - Using the
.verify(value)method will send theEXPort?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theEXPort valuecommand.
SCPI Syntax
- EXPort STARt
- EXPort?
Info
STARtinitiates the export.
Sub-properties
.filename: TheEXPort:FILENamecommand..format: TheEXPort:FORMatcommand..palette: TheEXPort:PALEttecommand..readouts: TheEXPort:READOutscommand..view: TheEXPort:VIEWcommand.
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
fastacq
property
¶
fastacq: Fastacq
Return the FASTAcq command.
Description
- This query-only command returns the state of Fast Acquisitions. This command is equivalent to pressing the FASTACQ button on the front panel.
Usage
- Using the
.query()method will send theFASTAcq?query. - Using the
.verify(value)method will send theFASTAcq?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- FASTAcq?
Sub-properties
.hiacqrate: TheFASTAcq:HIACQRATEcommand..state: TheFASTAcq:STATEcommand.
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..mkdir: TheFILESystem:MKDircommand..print: TheFILESystem:PRIntcommand..readfile: TheFILESystem:READFilecommand..rename: TheFILESystem:RENamecommand..rmdir: TheFILESystem:RMDircommand..writefile: TheFILESystem:WRITEFilecommand.
gpibusb
property
¶
gpibusb: Gpibusb
Return the GPIBUsb command tree.
Usage
- Using the
.query()method will send theGPIBUsb?query. - Using the
.verify(value)method will send theGPIBUsb?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.address: TheGPIBUsb:ADDresscommand..hwversion: TheGPIBUsb:HWVersioncommand..id: TheGPIBUsb:IDcommand.
hardcopy
property
¶
hardcopy: Hardcopy
Return the HARDCopy command.
Description
- This command sends a copy of the screen display to the port specified by
HARDCopy:PORT. This command is equivalent to pressing the PRINT button on the front panel. When printing to a file, the file format can be BMP, JPG, PNG, PCX or TIFF. The format of the saved screen capture is set by theEXPORT:FORMATcommand. The file format setting is persistent, and will not be affected by a default setup or*RSTcommand sent to the instrument. TheHARDCopyquery returns the port and file path.
Usage
- Using the
.query()method will send theHARDCopy?query. - Using the
.verify(value)method will send theHARDCopy?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theHARDCopy valuecommand.
SCPI Syntax
- HARDCopy STARt
- HARDCopy?
Info
STARtinitiates a screen copy to a file or the default system printer, as specified by the:HARDCopy:PORTselection. The default system printer is set within the Windows operating system. If you need information about how to set the default system printer, refer to Microsoft Windows online help.
Sub-properties
.filename: TheHARDCopy:FILENamecommand..layout: TheHARDCopy:LAYoutcommand..palette: TheHARDCopy:PALEttecommand..port: TheHARDCopy:PORTcommand..readouts: TheHARDCopy:READOutscommand..view: TheHARDCopy:VIEWcommand.
hdr
property
¶
hdr: Hdr
Return the HDR command.
Description
- This command is identical to the HEADer query and is included for backward compatibility purposes.
Usage
- Using the
.query()method will send theHDR?query. - Using the
.verify(value)method will send theHDR?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theHDR valuecommand.
SCPI Syntax
- HDR {ON|OFF|<NR1>}
- HDR?
Info
<NR1>= 0 sets the Response Header Enable State to false; any other value sets this state to true, which causes the instrument to send headers on query responses.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.
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.
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 theHIStogram?query. - Using the
.verify(value)method will send theHIStogram?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- HIStogram?
Sub-properties
.box: TheHIStogram:BOXcommand..boxpcnt: TheHIStogram:BOXPcntcommand..count: TheHIStogram:COUNtcommand..data: TheHIStogram:DATacommand..display: TheHIStogram:DISplaycommand..function: TheHIStogram:FUNCtioncommand..mode: TheHIStogram:MODecommand..size: TheHIStogram:SIZecommand..source: TheHIStogram:SOUrcecommand..state: TheHIStogram:STATEcommand.
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..acqlength: TheHORizontal:ACQLENGTHcommand..digital: TheHORizontal:DIGitalcommand tree..divisions: TheHORizontal:DIVisionscommand..fastframe: TheHORizontal:FASTframecommand..main: TheHORizontal:MAIncommand..mode: TheHORizontal:MODEcommand..position: TheHORizontal:POSitioncommand..roll: TheHORizontal:ROLLcommand..timestamp: TheHORizontal:TIMEStampcommand tree.
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?
limit
property
¶
limit: Limit
Return the LIMit command.
Description
- This query-only command returns all settings for the Limit commands.
Usage
- Using the
.query()method will send theLIMit?query. - Using the
.verify(value)method will send theLIMit?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- LIMit?
Sub-properties
.beep: TheLIMit:BEEPcommand..compare: TheLIMit:COMparecommand..email: TheLIMit:EMailcommand..hardcopy: TheLIMit:HARDCopycommand..highlighthits: TheLIMit:HIGHLIGHTHitscommand..lock: TheLIMit:LOCkcommand..log: TheLIMit:LOGcommand..savewfm: TheLIMit:SAVEWFMcommand..srq: TheLIMit:SRQcommand..state: TheLIMit:STATEcommand..status: TheLIMit:STATuscommand..stoponviolation: TheLIMit:STOPOnviolationcommand..template: TheLIMit:TEMPlatecommand tree.
linktraining
property
¶
linktraining: Linktraining
Return the LINKTRaining command tree.
Usage
- Using the
.query()method will send theLINKTRaining?query. - Using the
.verify(value)method will send theLINKTRaining?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.acqtime: TheLINKTRaining:ACQTimecommand..armscope: TheLINKTRaining:ARMscopecommand..decode: TheLINKTRaining:DECOdecommand..equalizationch: TheLINKTRaining:EQUalizationCH<x>command..lane: TheLINKTRaining:LANEcommand..mark: TheLINKTRaining:MARKcommand..setup: TheLINKTRaining:SETUPcommand.
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?
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 theMARK?query. - Using the
.verify(value)method will send theMARK?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARK valuecommand.
SCPI Syntax
- MARK {NEXT|PREVious}
- MARK?
Info
NEXTmoves to the next reference mark on the right.PREViousmoves to the next reference mark on the left.
Sub-properties
.create: TheMARK:CREATEcommand..delete: TheMARK:DELEtecommand..free: TheMARK:FREEcommand..selected: TheMARK:SELECTEDcommand tree..total: TheMARK:TOTalcommand.
mask
property
¶
mask: Mask
Return the MASK command.
Description
- This query-only command returns the states of all settable mask parameters.
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.
SCPI Syntax
- MASK?
Sub-properties
.autoadjust: TheMASK:AUTOAdjustcommand..autoset: TheMASK:AUTOSetcommand tree..copy: TheMASK:COPycommand tree..count: TheMASK:COUNtcommand..display: TheMASK:DISplaycommand..filter: TheMASK:FILTercommand..highlighthits: TheMASK:HIGHLIGHTHitscommand..invert: TheMASK:INVertcommand..lock: TheMASK:LOCkcommand..margin: TheMASK:MARgincommand tree..maskpre: TheMASK:MASKPREcommand tree..polarity: TheMASK:POLaritycommand..seg: TheMASK:SEG<m>command..source: TheMASK:SOUrcecommand..standard: TheMASK:STANdardcommand..stoponviolation: TheMASK:STOPOnviolationcommand..test: TheMASK:TEStcommand tree..user: TheMASK:USERcommand tree.
math
property
¶
Return the MATH<x> command.
Description
- This query-only command returns the definition for the math waveform specified by
, which ranges from 1 through 4.
Usage
- Using the
.query()method will send theMATH<x>?query. - Using the
.verify(value)method will send theMATH<x>?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MATH<x>?
Sub-properties
.define: TheMATH<x>:DEFinecommand..filter: TheMATH<x>:FILTercommand tree..label: TheMATH<x>:LABelcommand tree..numavg: TheMATH<x>:NUMAVgcommand..spectral: TheMATH<x>:SPECTralcommand..threshold: TheMATH<x>:THRESHoldcommand..unitstring: TheMATH<x>:UNITStringcommand..vertical: TheMATH<x>:VERTicalcommand tree.
matharbflt
property
¶
matharbflt: dict[int, MatharbfltItem]
Return the MATHArbflt<x> command tree.
Usage
- Using the
.query()method will send theMATHArbflt<x>?query. - Using the
.verify(value)method will send theMATHArbflt<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.filepath: TheMATHArbflt<x>:FILepathcommand..readfile: TheMATHArbflt<x>:READFilecommand.
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 theMATHVAR?query. - Using the
.verify(value)method will send theMATHVAR?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MATHVAR?
Sub-properties
.var: TheMATHVAR:VAR<x>command.
mch
property
¶
Return the MCH<x> command tree.
Usage
- Using the
.query()method will send theMCH<x>?query. - Using the
.verify(value)method will send theMCH<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.minamplitude: TheMCH<x>:MINAMPLitudecommand..maxamplitude: TheMCH<x>:MAXAMPLitudecommand.
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
.annotation: TheMEASUrement:ANNOTationcommand tree..dpojetstatistics: TheMEASUrement:DPOJETSTATisticscommand..gating: TheMEASUrement:GATingcommand..immed: TheMEASUrement:IMMedcommand..meas: TheMEASUrement:MEAS<x>command..method: TheMEASUrement:METHodcommand..noise: TheMEASUrement:NOISecommand..reflevel: TheMEASUrement:REFLevelcommand..source1: TheMEASUrement:SOUrce1command tree..statistics: TheMEASUrement:STATIsticscommand tree.
multiscope
property
¶
multiscope: Multiscope
Return the MULTiscope command tree.
Usage
- Using the
.query()method will send theMULTiscope?query. - Using the
.verify(value)method will send theMULTiscope?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.config: TheMULTiscope:CONFigcommand..exit: TheMULTiscope:EXITcommand..restart: TheMULTiscope:RESTARTcommand..status: TheMULTiscope:STATUScommand.
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?
opcextended
property
¶
opcextended: Opcextended
Return the OPCEXtended command.
Description
- This command sets or queries the behavior of OPC commands and queries. When enabled,
operations referenced in the
*OPCcommand description notify when their overlapped functionality has completed. When disabled, the operations notify as they have in the past (only once updated in the instrument state database). Command synchronization Operation PI sequence Single sequence with ttOff:ACQUIRE:STOPAFTER SEQUENCE:ACQUIRE:STATE 1;*OPC?;:WFMOUTPRE:XZERO?Single sequence with Measurement Annotation:ACQUIRE:STOPAFTER SEQUENCE;:MEASUREMENT:MEAS1:STATE 1;TYPE PK2PK:ACQUIRE:STATE 1;*OPC?;:MEASUREMENT:ANNOTATION:X1?Single sequence with Cursors:ACQUIRE:STOPAFTER SEQUENCE;:CURSOR:FUNCTION WAVEFORM;SOURCE CH1;STATE 1:ACQUIRE:STATE 1;*OPC?Single sequence with Math:ACQUIRE:STOPAFTER SEQUENCE;:MATH1:DEFINE‘Ch1*Ch2’;:SELECT:MATH1 1:ACQUIRE:STATE 1;*OPC?Default setup followed by Save Waveform*RST;*OPC?:SAVE:WAVEFORMCH1,REF1;*WAI:SELECT:REF1 1Math On during Acq Run mode:HORIZONTAL:MODE MANUAL;RECORDLENGTH 2500000:MATH1:DEFINE‘CH1*CH1’;:SELECT:MATH1 1:DATA:ENCDG ASCII;SOURCE REF1;START 1;STOP 10:SELECT:MATH1 0{Wait a couple sec..longer in release mode?}:SELECT:MATH1 1;*WAI;:CURVE?Save Math to Ref:HORIZONTAL:MODE MANUAL;RECORDLENGTH 2500000:MATH1:DEFINE‘CH1*CH1’;:SELECT:MATH1 1;*WAI;:SAVE:WAVEFORMMATH1,REF1;:SELECT:REF1 1:DATA:ENCDG ASCII;SOURCE REF1;START 1;STOP 10 CURVE? Trigger state:ACQUIRE:STOPAFTER SEQUENCE:ACQUIRE:STATE 1;*OPC?;:TRIGGER:STATE?Single sequence with Measurement:ACQUIRE:STOPAFTER SEQUENCE;:MEASUREMENT:MEAS1:STATE 1;TYPE AMPLITUDE:ACQUIRE:STATE 1;*OPC?;:MEASUREMENT:MEAS1:VALUE?Single sequence with Measurement on Math:ACQUIRE:STOPAFTER SEQUENCE;:HORIZONTAL:MODE MANUAL;RECORDLENGTH 2500000:MATH1:DEFINE‘CH1*CH1’;:SELECT:MATH1 1:MEASUREMENT:MEAS1:STATE 1;TYPE AMPLITUDE;SOURCE MATH1:ACQUIRE:STATE 1;*OPC?;:MEASUREMENT:MEAS1:VALUE?Acq Count*RST;*WAI;:ACQUIRE:NUMACQ?Acq state after single sequence:ACQUIRE:STOPAFTER SEQUENCE;STATE 1;*WAI;:ACQUIRE:STATE?
Usage
- Using the
.query()method will send theOPCEXtended?query. - Using the
.verify(value)method will send theOPCEXtended?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theOPCEXtended valuecommand.
SCPI Syntax
- OPCEXtended {ON|OFF|<NR1>}
- OPCEXtended?
Info
ONturns on extended OPC behavior.OFFturns off extended OPC behavior.<NR1>= 0 turns off extended OPC behavior; any other value turns on extended OPC behavior.
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.
pcenable
property
¶
pcenable: Pcenable
Return the PCENable command.
Description
- Sets or queries the enable state of the User Preference Probe compensation.
Usage
- Using the
.query()method will send thePCENable?query. - Using the
.verify(value)method will send thePCENable?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send thePCENable valuecommand.
SCPI Syntax
- PCENable OFF | ON
- PCENable?
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.
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
*SAVcommand).
Usage
- Using the
.write(value)method will send the*RCL valuecommand.
SCPI Syntax
- *RCL <NR1>
Info
<NR1>is a value in the range from 1 to 10, which specifies a saved setup storage location.
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..setup: TheRECAll:SETUpcommand..waveform: TheRECAll:WAVEformcommand.
ref
property
¶
Return the REF<x> command tree.
Usage
- Using the
.query()method will send theREF<x>?query. - Using the
.verify(value)method will send theREF<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.horizontal: TheREF<x>:HORizontalcommand tree..label: TheREF<x>:LABelcommand..threshold: TheREF<x>:THRESHoldcommand..vertical: TheREF<x>:VERTicalcommand 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
.out: TheROSc:OUTcommand tree..source: TheROSc:SOUrcecommand..state: TheROSc:STATEcommand..tracking: TheROSc:TRACkingcommand.
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
sav
property
¶
sav: Sav
Return the *SAV command.
Description
- Stores the state of the oscilloscope to a specified memory location. You can use the
*RCLcommand to restore the oscilloscope to this saved state at a later time.
Usage
- Using the
.write(value)method will send the*SAV valuecommand.
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 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..marks: TheSAVe:MARKScommand..mask: TheSAVe:MASKcommand..setup: TheSAVe:SETUpcommand..waveform: TheSAVe:WAVEformcommand.
saveon
property
¶
saveon: Saveon
Return the SAVEON command.
Description
- Sets the auto-increment file count to 0. Once the number of saved files has reached
the limit that you set (using the
SAVEON:NUMeventscommand), no files will be saved until you reset the count.
Usage
- Using the
.write(value)method will send theSAVEON valuecommand.
SCPI Syntax
- SAVEON {RESET}
Info
RESETsets the file count to 0.
Sub-properties
.count: TheSAVEON:COUNtcommand..file: TheSAVEON:FILEcommand tree..image: TheSAVEON:IMAGecommand..limit: TheSAVEON:LIMitcommand..mask: TheSAVEON:MASKcommand..measurement: TheSAVEON:MEASUrementcommand..numevents: TheSAVEON:NUMEventscommand..setup: TheSAVEON:SETUPcommand..trigger: TheSAVEON:TRIGgercommand..waveform: TheSAVEON:WAVEformcommand.
sds
property
¶
sds: Sds
Return the *SDS command.
Description
- This command (no query form) changes the specified setup to reference the factory setup instead of the specific user setup slot. The content of the setup slot is unchanged, but the data will no longer be accessible to you. This command is equivalent to selecting Delete from the File menu, and then choosing the specified setup.
Usage
- Using the
.write(value)method will send the*SDS valuecommand.
SCPI Syntax
- *SDS <NR1>
Info
<NR1>specifies a user setup location to delete. Setup storage location values range from 1 through 10; using an out-of-range value causes an error.
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
.markallevents: TheSEARCH:MARKALLeventscommand..search: TheSEARCH:SEARCH<x>command..stop: TheSEARCH:STOPcommand.
select
property
¶
select: Select
Return the SELect command.
Description
- Queries which waveforms are displayed.
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.
SCPI Syntax
- SELect?
Sub-properties
.b: TheSELect:B<x>command..ch: TheSELect:CH<x>command..control: TheSELect:CONTROlcommand..d: TheSELect:D<x>command..dall: TheSELect:DALLcommand..digtraces: TheSELect:DIGTracescommand tree..math: TheSELect:MATH<x>command..ref: TheSELect:REF<x>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. 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?
setup
property
¶
setup: Setup
Return the SETUp command tree.
Usage
- Using the
.query()method will send theSETUp?query. - Using the
.verify(value)method will send theSETUp?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.name: TheSETUp:NAMecommand.
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?
system
property
¶
system: System
Return the SYSTem command tree.
Usage
- Using the
.query()method will send theSYSTem?query. - Using the
.verify(value)method will send theSYSTem?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.setup: TheSYSTem:SETupcommand.
teklink
property
¶
teklink: Teklink
Return the TEKLink command tree.
Usage
- Using the
.query()method will send theTEKLink?query. - Using the
.verify(value)method will send theTEKLink?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.connection: TheTEKLink:CONNectioncommand..refclk: TheTEKLink:REFClkcommand.
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
test
property
¶
test: Test
Return the TEST command.
Description
- This command provides the ability to select and execute an item at any level of the test hierarchy (Test, Area or Subsystem). The query returns the last command sent. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu, choosing a test and then pressing Run.
Usage
- Using the
.query()method will send theTEST?query. - Using the
.verify(value)method will send theTEST?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theTEST valuecommand.
SCPI Syntax
- TEST <QString>
- TEST?
Info
<QString>sets the test ID, which ranges from 0 through 3 characters. If no test ID is specified, all available diagnostics are executed.
Sub-properties
.results: TheTEST:RESultscommand..stop: TheTEST:STOPcommand.
time
property
¶
time: Time
Return the TIME command.
Description
- This command sets or queries the time that the instrument displays. This command is equivalent to selecting Set Time & Date from the Utilities menu and then setting the fields in the Time group box.
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 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.
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
trig
property
¶
trig: Trig
Return the TRIG command tree.
Usage
- Using the
.query()method will send theTRIG?query. - Using the
.verify(value)method will send theTRIG?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.a: TheTRIG:Acommand tree.
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..b: TheTRIGger:Bcommand..enhanced: TheTRIGger:ENHancedcommand..equation: TheTRIGger:EQUation<x>command..lvlsrcpreference: TheTRIGger:LVLSrcpreferencecommand..main: TheTRIGger:MAIncommand tree..multiscope: TheTRIGger:MULTiscopecommand..qualification: TheTRIGger:QUALificationcommand tree..sensitivity: TheTRIGger:SENSITivitycommand..showequation: TheTRIGger:SHOWEQuationcommand..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?
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.
usbtmc
property
¶
usbtmc: Usbtmc
Return the USBTMC command tree.
Usage
- Using the
.query()method will send theUSBTMC?query. - Using the
.verify(value)method will send theUSBTMC?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.productid: TheUSBTMC:PRODUCTIDcommand tree..serialnumber: TheUSBTMC:SERIALnumbercommand..vendorid: TheUSBTMC:VENDORIDcommand 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 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.
visual
property
¶
visual: Visual
Return the VISual command.
Description
- This query-only command returns the settings for each visual trigger area.
Usage
- Using the
.query()method will send theVISual?query. - Using the
.verify(value)method will send theVISual?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- VISual?
Sub-properties
.area: TheVISual:AREA<x>command..areacolor: TheVISual:AREACOLOrcommand..aspectratio: TheVISual:ASPECTratiocommand..deletearea: TheVISual:DELETEAREAcommand..enable: TheVISual:ENAblecommand..file: TheVISual:FILEcommand 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?
wavfrmstream
property
¶
wavfrmstream: Wavfrmstream
Return the WAVFRMStream command.
Description
- This query only command returns WFMQUTPRE? and CURVESTREAM? data for the waveforms specified by the DATASOURCE command. This command is similar to sending both WFMOUTPRE? and CURVESTREAM?, with the additional provision that each CURVESTREAM response to WAVFRMS? has a WFMOUTPRE response prepended to it. This helps guarantee a continuous synchronized preamble and curve.
Usage
- Using the
.query()method will send theWAVFRMStream?query. - Using the
.verify(value)method will send theWAVFRMStream?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- WAVFRMStream?
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 theWFMInpre?query. - Using the
.verify(value)method will send theWFMInpre?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- WFMInpre?
Sub-properties
.bit_nr: TheWFMInpre:BIT_Nrcommand..bn_fmt: TheWFMInpre:BN_Fmtcommand..byt_nr: TheWFMInpre:BYT_Nrcommand..byt_or: TheWFMInpre:BYT_Orcommand..encdg: TheWFMInpre:ENCdgcommand..nr_fr: TheWFMInpre:NR_FRcommand..nr_pt: TheWFMInpre:NR_Ptcommand..pt_fmt: TheWFMInpre:PT_Fmtcommand..pt_off: TheWFMInpre:PT_Offcommand..wfid: TheWFMInpre:WFIdcommand..xincr: TheWFMInpre:XINcrcommand..xunit: TheWFMInpre:XUNitcommand..xzero: TheWFMInpre:XZErocommand..ymult: TheWFMInpre:YMUltcommand..yoff: TheWFMInpre:YOFfcommand..yunit: TheWFMInpre:YUNitcommand..yzero: TheWFMInpre:YZErocommand.
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
.bit_nr: TheWFMOutpre:BIT_Nrcommand..bn_fmt: TheWFMOutpre:BN_Fmtcommand..byt_nr: TheWFMOutpre:BYT_Nrcommand..byt_or: TheWFMOutpre:BYT_Orcommand..encdg: TheWFMOutpre:ENCdgcommand..nr_fr: TheWFMOutpre:NR_FRcommand..nr_pt: TheWFMOutpre:NR_Ptcommand..pt_fmt: TheWFMOutpre:PT_Fmtcommand..pt_order: TheWFMOutpre:PT_ORdercommand..pt_off: TheWFMOutpre:PT_Offcommand..wfid: TheWFMOutpre:WFIdcommand..xincr: TheWFMOutpre:XINcrcommand..xunit: TheWFMOutpre:XUNitcommand..xzero: TheWFMOutpre:XZErocommand..ymult: TheWFMOutpre:YMUltcommand..yoff: TheWFMOutpre:YOFfcommand..yunit: TheWFMOutpre:YUNitcommand..yzero: TheWFMOutpre:YZErocommand.
wfmpre
property
¶
wfmpre: Wfmpre
Return the WFMPre command tree.
Usage
- Using the
.query()method will send theWFMPre?query. - Using the
.verify(value)method will send theWFMPre?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.nr_fr: TheWFMPre:NR_FRcommand.
zoom
property
¶
zoom: Zoom
Return the ZOOm command.
Description
- This command resets the zoom transforms to default values for all traces or live
traces. The
ZOOmquery returns the current vertical and horizontal positioning and scaling of the display.
Usage
- Using the
.query()method will send theZOOm?query. - Using the
.verify(value)method will send theZOOm?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theZOOm valuecommand.
SCPI Syntax
- ZOOm {RESET|RESETLive}
- ZOOm?
Info
RESETresets the zoom transforms to default values for all traces.RESETLiveresets the zoom transforms to default values for live traces.
Sub-properties
.graticule: TheZOOm:GRAticulecommand tree..horizontal: TheZOOm:HORizontalcommand tree..math: TheZOOm:MATH<x>command tree..mode: TheZOOm:MODecommand..ref: TheZOOm:REF<x>command tree..scroll: TheZOOm:SCROLLcommand tree..state: TheZOOm:STATEcommand..vertical: TheZOOm:VERTicalcommand tree..zoom1: TheZOOm:ZOOM1command.
MSO5KMixin
¶
A mixin that provides access to the MSO5K commands and constants.
Properties
.command_argument_constants: The MSO5K command argument constants..commands: The MSO5K commands.
command_argument_constants
cached
property
¶
command_argument_constants: MSO5KCommandConstants
Return the MSO5K command argument constants.
This provides access to all the string constants which can be used as arguments for MSO5K commands.
commands
cached
property
¶
commands: MSO5KCommands
Return the MSO5K commands.
This provides access to all the commands for the MSO5K device. See the documentation of each sub-property for more usage information.
Sub-properties
.acquire: TheACQuirecommand tree..alias: TheALIascommand..allev: TheALLEvcommand..allocate: TheALLOcatecommand tree..application: TheAPPLicationcommand tree..autoset: TheAUTOSetcommand..auxin: TheAUXIncommand tree..auxout: TheAUXoutcommand..bell: TheBELlcommand..bus: TheBUScommand tree..busy: TheBUSYcommand..cal: The*CALcommand..calibrate: TheCALibratecommand..ch: TheCH<x>command..clear: TheCLEARcommand..cls: The*CLScommand..cmdbatch: TheCMDBatchcommand..counter: TheCOUntercommand tree..cq: TheCQ<x>command tree..cursor: TheCURSorcommand..curve: TheCURVecommand..curvenext: TheCURVENextcommand..curvestream: TheCURVEStreamcommand..custom: TheCUSTOMcommand tree..d: TheD<x>command tree..data: TheDATacommand..date: TheDATEcommand..ddt: The*DDTcommand..delete: TheDELEtecommand tree..dese: TheDESEcommand..diag: TheDIAgcommand tree..display: TheDISplaycommand..email: TheEMailcommand..errordetector: TheERRORDetectorcommand tree..ese: The*ESEcommand..esr: The*ESRcommand..event: TheEVENTcommand..evmsg: TheEVMsgcommand..evqty: TheEVQtycommand..export: TheEXPortcommand..factory: TheFACtorycommand..fastacq: TheFASTAcqcommand..filesystem: TheFILESystemcommand..gpibusb: TheGPIBUsbcommand tree..hardcopy: TheHARDCopycommand..hdr: TheHDRcommand..header: TheHEADercommand..histogram: TheHIStogramcommand..horizontal: TheHORizontalcommand..id: TheIDcommand..idn: The*IDNcommand..limit: TheLIMitcommand..linktraining: TheLINKTRainingcommand tree..lock: TheLOCkcommand..lrn: The*LRNcommand..mark: TheMARKcommand..mask: TheMASKcommand..math: TheMATH<x>command..matharbflt: TheMATHArbflt<x>command tree..mathvar: TheMATHVARcommand..mch: TheMCH<x>command tree..measurement: TheMEASUrementcommand..multiscope: TheMULTiscopecommand tree..newpass: TheNEWpasscommand..opc: The*OPCcommand..opcextended: TheOPCEXtendedcommand..opt: The*OPTcommand..password: ThePASSWordcommand..pcenable: ThePCENablecommand..psc: The*PSCcommand..pud: The*PUDcommand..rcl: The*RCLcommand..recall: TheRECAllcommand tree..ref: TheREF<x>command tree..rem: TheREMcommand..rosc: TheROSccommand tree..rst: The*RSTcommand..sav: The*SAVcommand..save: TheSAVecommand tree..saveon: TheSAVEONcommand..sds: The*SDScommand..search: TheSEARCHcommand tree..select: TheSELectcommand..set: TheSETcommand..setup: TheSETUpcommand tree..sre: The*SREcommand..stb: The*STBcommand..system: TheSYSTemcommand tree..teklink: TheTEKLinkcommand tree..teksecure: TheTEKSecurecommand..test: TheTESTcommand..time: TheTIMEcommand..trg: The*TRGcommand..trig: TheTRIGcommand tree..trigger: TheTRIGgercommand..tst: The*TSTcommand..unlock: TheUNLockcommand..usbtmc: TheUSBTMCcommand tree..verbose: TheVERBosecommand..visual: TheVISualcommand..wai: The*WAIcommand..wavfrm: TheWAVFrmcommand..wavfrmstream: TheWAVFRMStreamcommand..wfminpre: TheWFMInprecommand..wfmoutpre: TheWFMOutprecommand..wfmpre: TheWFMPrecommand tree..zoom: TheZOOmcommand.