This programmer manual provides information on how to remotely operate your
instrument. You can use communication ports and protocols, such as for the
General Purpose Interface Bus (GPIB) or Universal Serial Bus (USB) standards,
to remotely control and operate your instrument.
This document supports the following products:
■
TBS2000 Series Digital Storage Oscilloscopes, any version
Each series of instruments has a different set of documentation.
TBS2000 Series Manuals
Service Manuals (English
Only)
Conventions
LanguageTBS2000 user manual part number
English077-1147-XX
For information on how to service your instrument, refer to the appropriate
manual from the following optional accessories:
■
TBS2000 Series Digital Storage Oscilloscopes Service Manual (077-1150XX)
Refer to Command Syntax for information about command conventions.
Command Syntax on page 3
This manual uses the following conventions:
■
Command descriptions list specific instruments series (and modules) when
commands are valid for only those products
Getting Started
This manual contains information on how to remotely control and operate your
instrument through communications protocol and commands.
Refer to the instrument user manual for information on how to configure and test
your instrument remote connectivity (USB or Ethernet).
Download the latest version of the programmer manual from www.tek.com/
downloads for up-to-date command syntax information.
TBS2000 Series Programmer 1
Getting Started
2 TBS2000 Series Programmer
Command Syntax
You can control the instrument through the Ethernet or USB interface using a
large group of commands and queries.
This section describes the syntax these commands and queries use and the
conventions the instrument uses to process them. The commands and queries
themselves are listed in the Command Descriptions section.
Command Syntax
Table 1: Instrument communication protocol
You transmit commands to the instrument using the enhanced American Standard
Code for Information Interchange (ASCII) character encoding. Appendix A
contains a chart of the ASCII character set.
The Backus Naur Form (BNF) notation is used in this manual to describe
commands and queries.
Model or optionGPIBRS-232 USB
TBS2000Yes
1
NoYes
Table 2: BNF notation
SymbolMeaning
< >Defined element
::=Is defined as
|Exclusive OR
{ }Group; one element is required
[ ]Optional; can be omitted
. . .Previous element(s) may be repeated
( )Comment
1
Function available with a TEK-USB-488 adapter.
TBS2000 Series Programmer 3
Command Syntax
Command and Query Structure
Commands consist of set commands and query commands (usually simply called
commands and queries). Commands change instrument settings or perform a
specific action. Queries cause the instrument to return data and information about
its status.
Most commands have both a set form and a query form. The query form of the
command is the same as the set form except that it ends with a question mark.
For example, the set command ACQuire:MODe has a query form
ACQuire:MODe. Not all commands have both a set and a query form; some
commands are set only and some are query only.
A few commands do both a set and query action. For example, the *CAL?
command runs a self-calibration program on the instrument, then returns the
result of the calibration.
A command message is a command or query name, followed by any information
the instrument needs to execute the command or query. Command messages
consist of five different element types.
Table 3: Command message elements
SymbolMeaning
<Header>The basic command name. If the header ends
with a question mark, the command is a query.
The header may begin with a colon (:) character;
if the command is concatenated with other
commands the beginning colon is required. The
beginning colon can never be used with
command headers beginning with a star (*).
<Mnemonic>A header subfunction. Some command headers
have only one mnemonic. If a command header
has multiple mnemonics, they are always
separated from each other by a colon (:)
character.
<Argument>A quantity, quality, restriction, or limit associated
with the header. Not all commands have an
argument, while other commands have multiple
arguments. Arguments are separated from the
header by a <Space>. Arguments are separated
from each other by a <Comma>.
<Comma>A single comma between arguments of multiple-
argument commands. It may optionally have
white space characters before and after the
comma.
<Space>A white space character between command
header and argument. It may optionally consist
of multiple white space characters.
The following figure shows the five command message elements.
4 TBS2000 Series Programmer
Command Syntax
Figure 1: Command message elements
Commands
Queries
Commands cause the instrument to perform a specific function or change one of
its settings. Commands have the structure:
A command header is made up of one or more mnemonics arranged in a
hierarchical or tree structure. The first mnemonic is the base or root of the tree
and each subsequent mnemonic is a level or branch off of the previous one.
Commands at a higher level in the tree may affect those at a lower level. The
leading colon (:) always returns you to the base of the command tree.
Queries cause the instrument to return information about its status or settings.
Queries have the structure:
You can specify a query command at any level within the command tree unless
otherwise noted. These branch queries return information about all the
mnemonics below the specified branch or level.
For example, MEASUrement:MEAS<x>:UNIts? returns the measurement units,
while MEASUrement:MEAS<x>:TYPe? returns the measurement type selected
for the measurement, and MEASUrement:MEAS<x>? returns all the
measurement parameters for the specified measurement.
TBS2000 Series Programmer 5
Command Syntax
Headers in Query
Responses
Clearing the Output Queue
You can control whether the instrument returns headers as part of the query
response. Use the HEADer command to control this feature. If header is on, the
instrument returns command headers as part of the query and formats the query
response as a valid set command. When header is off, the instrument sends back
only the values in the response. This format can make it easier to parse and
extract the information from the response.
Table 4: Comparison of Header Off and Header On responses
QueryHeader Off responseHeader On response
ACQuire:NUMAVg64 ACQUIRE:NUMAVG 64
CHx1:COUPlingDCCH1:COUPLING DC
To clear the output queue and reset the instrument to accept a new command or
query, send a Device Clear (DCL) from a GPIB host.
From an RS-232 host, send a break signal. The RS-232 interface responds by
returning the ASCII string "DCL."
From a USB host, send an INITIATE_CLEAR followed by a
CHECK_CLEAR_STATUS. The USB interface responds to
CHECK_CLEAR_STATUS with STATUS_SUCCESS when it is finished
clearing the output queue.
Command Entry
Follow these general rules when entering commands:
■
Enter commands in upper or lower case.
■
You can precede any command with white space characters. White space
characters include any combination of the ASCII control characters
00 through 09 and 0B through 20 hexadecimal (0 through 9 and 11 through
32 decimal).
■
The instrument ignores commands that consists of just a combination of
white space characters and line feeds.
6 TBS2000 Series Programmer
Command Syntax
Abbreviating Commands
Concatenating Commands
You can abbreviate many instrument commands. These abbreviations are shown
in capital letters in the command listing in the Command Groups section and
Command Descriptions section. For example, the command ACQuire:NUMAvg
can be entered simply as ACQ:NUMA or acq:numa.
If you use the HEADer command to have command headers included as part of
query responses, you can also control whether the returned headers are
abbreviated or are full-length using the VERBose command.
You can concatenate any combination of set commands and queries using a
semicolon (;). The instrument executes concatenated commands in the order
received. When concatenating commands and queries you must follow these
rules:
■
Completely different headers must be separated by both a semicolon and by
the beginning colon on all commands but the first. For example, the
commands TRIGger:MODe NORMal and ACQuire:NUMAVg 16 can be
concatenated into a single command:
TRIGger:MODe NORMal;:ACQuire:NUMAVg 16
■
If concatenated commands have headers that differ by only the last
mnemonic, you can abbreviate the second command and eliminate the
beginning colon. For example, the commands ACQuire:MODe AVErage and
ACQuire:NUMAVg 16 could be concatenated into a single command:
ACQuire:MODe AVErage; NUMAVg 16
The longer version works equally well:
ACQuire:MODe AVErage;:ACQuire:NUMAVg 16
■
Never precede a star (*) command with a colon or semicolon:
ACQuire:MODe AVErage;*TRG
The instrument processes commands that follow the star command as if the
star command was not there, so:
ACQuire:MODe AVErage;*TRG;NUMAVg 16
sets the acquisition mode to average and sets acquisition averaging to 16. The
*TRG command is ignored.
■
When you concatenate queries, the responses to all queries are combined into
a single response message. For example, if channel 1 coupling is set to DC
and the bandwidth is set to 20 MHz, the concatenated query:
CH1:COUPling;BANdwidth
returns CH1:COUPLING DC;:CH1:BANDWIDTH ON if header is on, or
DC;ON if header is off.
■
You can concatenate set commands and queries in the same message. For
example:
ACQuire:MODe AVErage;NUMAVg;STATE
TBS2000 Series Programmer 7
Command Syntax
is a valid message that sets the acquisition mode to average, queries the
number of acquisitions for averaging, and then queries the acquisition state.
The instrument executes concatenated commands and queries in the order it
receives them.
■
Any query that returns arbitrary data, such as ID, must be the last query when
part of a concatenated command. If the query is not last, the instrument
generates event message 440.
Here are some INVALID concatenation examples:
■
CH1:COUPling DC;ACQuire:NUMAVg 16 (missing colon before ACQuire)
■
CH1:COUPling DC;:BANDwidth ON (invalid colon before BANDwidth)
■
CH1:COUPling DC;:*TRG (invalid colon before a star (*) command)
■
HORizontal:MAIn:POSition 0;MAIn:SCAle 1E-13 (levels of mnemonics are
different; either remove the second occurrence of MAIn:, or put HORizontal:
in front of MAIN:SCAle)
Message Terminators
This manual uses the term <EOM> (End of message) to represent a message
terminator.
GPIB End of Message (EOM) Terminators. GPIB EOM terminators can be the
END message (EOI asserted concurrently with the last data byte), the ASCII
code for line feed (LF) sent as the last data byte, or both. The instrument always
terminates messages with LF and EOI. White space is allowed before the
terminator; for example, CR LF is acceptable.
USB End of Message (EOM) Terminators. The EOM bit must be set in the USB
header of the last transfer of a command message
See the USB Test and Measurement Class Specification (USBTMC) section
3.2.1 for details. The instrument terminates messages by setting the EOM bit in
the USB header of the last transfer of a message to the host (USBTMC
Specification section 3.3.1), and by terminating messages with a LF. White
space is allowed before the terminator; for example, CR LF is acceptable.
8 TBS2000 Series Programmer
Command Syntax
Constructed Mnemonics
Some header mnemonics specify one of a range of mnemonics. For example, a
channel mnemonic could be CH2. You can use these mnemonics in the command
just as you do any other mnemonic. For example, there is a CH1:VOLts
command and there is also a CH2:VOLts command. In the command
descriptions, this list of choices is abbreviated CH<x>.
Channel mnemonics
Reference Waveform
Mnemonics
Waveform Mnemonics
Commands specify the channel to use as a mnemonic in the header.
SymbolMeaning
CH<x>2-channel models: A channel specifier; <x> is
1 or 2.
4-channel models: A channel specifier; <x> is 1,
2, 3, or 4.
Commands can specify the reference waveform to use as a mnemonic in the
header.
SymbolMeaning
REF<x>2-channel models: A reference waveform
specifier; <x> is A or B.
4-channel models: A reference waveform
specifier; <x> is A, B, C, or D.
In some commands you can specify a waveform without regard to its type:
channel waveform, math waveform, or reference waveform. The "y" is the same
as "x" in Reference Waveform Mnemonics.
SymbolMeaning
<wfm>Can be CH<x>, MATH, or REF<y>
TBS2000 Series Programmer 9
Command Syntax
Cursor Position Mnemonic
Measurement Specifier
Mnemonics
Argument Types
When the instrument displays cursors, commands may specify which cursor of
the pair to use.
SymbolMeaning
POSITION<x>A cursor selector;<x> is 1 or 2.
Commands can specify which measurement to set or query as a mnemonic in the
header. The instrument can display up to six automated measurements.
SymbolMeaning
MEAS<x>A measurement specifier; <x> is 1-6.
A command argument can be in one of several forms. The individual descriptions
of each command tell which argument types to use with that command.
Numeric Arguments
Many instrument commands require numeric arguments.
Table 5: Types of numeric arguments
SymbolMeaning
<NR1>Signed integer value
<NR2>Floating point value without an exponent
<NR3>Floating point value with an exponent
The syntax shown is the data format that the instrument returns in response to a
query. This format is also the preferred format when sending a command to the
instrument.
When you enter an incorrect numeric argument, the instrument automatically
forces the numeric argument to a correct value.
Table 6: Instrument handling of incorrect numeric arguments
Argument valueInstrument response
Numeric argument is less than lowest correct
value for that command
Numeric argument is greater than the highest
correct value for that command
Numeric value is between two correct valuesRounds the entered value to the nearest correct
Sets the specified command to the lowest
correct value and executes the command
Sets the specified command to the highest
correct value and executes the command
value and executes the command
10 TBS2000 Series Programmer
Command Syntax
Quoted String Arguments
Some commands accept or return data in the form of a quoted string, which is
simply a group of ASCII characters enclosed by single quotes (') or double quotes
("). For example:
"this is a quoted string"
SymbolMeaning
<QString>Quoted string of ASCII text
Follow these rules when you use quoted strings:
1. A quoted string can include any character defined in the 7-bit ASCII
character set. ASCII Code Chart on page 297.
2. Use the same type of quote character to open and close the string:
"this is a valid string"
3. You can mix quotation marks within a string if you follow the previous rule:
"this is an 'acceptable' string"
4. You can include a quote character within a string simply by repeating the
quote. For example,
"here is a "" mark"
Block Arguments
5. Strings can have upper or lower case characters.
6. If you use a GPIB network, you cannot terminate a quoted string with the
END message before the closing delimiter.
7. A carriage return or line feed embedded in a quoted string does not terminate
the string, but is treated as just another character in the string.
8. The maximum length of a quoted string returned from a query is
1000 characters.
Here are some examples of invalid strings:
"Invalid string argument' (quotes are not of the same type)
"test<EOI>" (termination character is embedded in the string)
Several instrument commands use a block argument form.
TBS2000 Series Programmer 11
Command Syntax
Table 7: Parts of a block argument
SymbolMeaning
<NZDig>A nonzero digit character, in the range
1-9 Specifies the number of <Dig> elements that
follow
The following figure shows an example of a block argument.
Figure 2: Block argument example
<NZDig> specifies the number of <Dig> elements that follow. Taken together,
the <Dig> elements form a decimal integer that specifies how many <DChar>
elements follow.
#0 means that the <Block> is an indefinite length block. The <terminator> ends
the block. You should not use indefinite length blocks with RS-232, because
there is no way to include a <terminator> character as a <DChar> character.
The first occurrence of a <terminator> character signals the end of the block and
any subsequent <DChar> characters will be interpreted as a syntax error. With
the GPIB, the EOI line signals the last byte. With the USB, the EOM bit signals
the last byte.
12 TBS2000 Series Programmer
Command groups
This section lists the commands organized by functional group. The following
sections lists all commands alphabetically.
The instrument GPIB and USB interfaces conform to Tektronix standard codes
and formats except where noted. The GPIB interface also conforms to IEEE Std
488.2–1987 except where noted. The USB interface also conforms to USB Test
and Measurement Class, Subclass USB488 Specification, except where noted.
Alias command group
Use the Alias commands to define new commands as a sequence of standard
commands. You may find this useful when repeatedly using the same commands
to perform certain tasks like setting up measurements.
Aliases are similar to macros but do not include the capability to substitute
parameters into alias bodies. The alias mechanism obeys the following rules:
■
The alias name must consist of a valid IEEE488.2 message unit, which may
not appear in a message preceded by a colon, comma, or a command or query
program header.
■
The alias name may not appear in a message followed by a colon, comma, or
question mark.
■
An alias name must be distinct from any keyword or keyword short form.
■
An alias name cannot be redefined without first being deleted using one of
the alias deletion functions.
■
Alias names do not appear in response messages.
Table 8: Alias commands
CommandCommand
ALIas on page 43Sets or returns the alias state.
ALIas:CATalog? on page 44Returns a list of the currently defined alias.
ALIas:DEFine on page 45Assigns a sequence of program messages.
ALIas:DELEte on page 46Removes a specified alias.
ALIas:DELEte:ALL on page 46Deletes all existing aliases.
ALIas:DELEte[:NAMe] on page 47Removes a specified alias.
ALIas[:STATE] on page 47Sets or returns the alias state.
TBS2000 Series Programmer 13
Command groups
Acquisition command group
Acquisition commands affect the acquisition of waveforms. These commands
control mode, averaging, and single-waveform acquisition.
Table 9: Acquisition commands
CommandCommand
ACQuire? on page 37Returns current acquisition settings.
ACQuire:MAXSamplerate? on page 38Returns the maximum real-time sample rate.
ACQuire:MODe on page 38Sets or queries the instrument acquisition mode.
ACQuire:NUMACq? on page 40Indicates the number of acquisitions that have
taken place since starting instrument acquisition.
ACQuire:NUMAVg on page 41Sets the number of instrument waveform
acquisitions that make up an averaged
waveform.
ACQuire:STATE on page 41Starts or stops instrument acquisitions.
ACQuire:STOPAfter on page 42Tells the instrument when to stop taking
acquisitions.
Calibration and Diagnostic command group
Calibration and Diagnostic commands let you initiate the instrument selfcalibration routines and examine the results of diagnostic tests.
Table 10: Calibration and Diagnostic commands
CommandDescription
*CAL? on page 53Performs an internal self-calibration and returns
CALibrate:FACtory on page 54Starts the instrument internal factory calibration
CALibrate:FACtory:STATus? on page 55Returns the factory calibration status value
CALibrate:INTERNAL on page 56Performs an internal self-calibration but does not
CALibrate:INTERNal:STARt on page 56Starts the internal signal path calibration.
CALibrate:INTERNal:STATus? on page 57Returns the current status of the internal signal
CALibrate:RESults? on page 58Returns the status of all calibration subsystems
CALibrate:RESults:FACtory? on page 58Returns the status of internal and factory
CALibrate:RESults:SPC? on page 59Returns the results of the last SPC operation
its status.
operation.
saved in nonvolatile memory.
return any status.
path calibration.
without performing an SPC operation.
calibration
14 TBS2000 Series Programmer
CommandDescription
CALibrate:FACtory:STEPSTIMulus? on
page 55
DIAg:LOOP:OPTion on page 97Sets the self-test loop option
DIAg:LOOP:OPTion:NTIMes on page 98Sets the self-test loop option to run N times
DIAg:LOOP:STOP on page 98Stops the self-test at the end of the current loop
DIAg:RESUlt:FLAg? on page 99Returns the Pass/Fail status from the last
DIAg:RESUlt:LOG? on page 99Returns the internal results log from the last
DIAg:SELect on page 100Sets the type of diagnostics grouping.
DIAg:SELect:<function> on page 101Runs self-tests on the specified system
DIAg:STATE on page 101Starts or stops the instrument self-test.
DIAg:FAN on page 97Read out the currently set PWM fan value
DIAg:TEMPVAL on page 102Read out the currently FPGA chip and ambient
Return the current factory step’s input stimulus.
diagnostic test sequence execution (those run
automatically at power on, or those requested
through the Service Menu).
diagnostic test sequence execution (those run
automatically at power on, or those requested
through the Service Menu).
subsystem.
temperature
Command groups
Cursor command group
Cursor commands provide control over the instrument cursor display and
readout.
Use the commands in the cursor command subsystem to control the cursor
display and readout. You can use these commands to control the setups for cursor
1 and cursor 2, such as cursor position. You can also use the commands to select
one of the following cursor functions:
Off. Turns off the display of all cursors.
Waveform Cursors. Consists of two cursors. Waveform cursors enable you to
conveniently measure waveform amplitude and time.
Screen Cursors. Consists of two pairs of independent horizontal and vertical
cursors.
You can use these cursors to indicate an arbitrary position within the waveform
display area.
TBS2000 Series Programmer 15
Command groups
Table 11: Cursor commands
CommandDescription
CURSor? on page 76Returns current cursor settings.
CURSor:FUNCtion on page 77Selects and displays the instrument cursor type.
CURSor:HBArs? on page 78Returns the settings for the instrument horizontal
bar cursors.
CURSor:HBArs:DELTa? on page 78Returns the difference (in vertical units) between
the two horizontal bar cursors in the instrument
display.
CURSor:HBArs:POSITION<x> on page 79Positions a horizontal bar cursor.
CURSor:HBArs:UNIts on page 80Returns the vertical scale units for the selected
cursor source waveform.
CURSor:HBArs:USE on page 81Sets the horizontal bar cursor measurement
scale.
CURSor:MODe on page 82Sets or returns whether cursors move in unison
or separately.
CURSor:VBArs? on page 83Returns the current vertical bar cursor horizontal
position and units settings.
CURSor:VBArs:ALTERNATE<x>? on page 83Returns the alternate readout for the waveform
(Vbar) cursors.
CURSor:VBArs:DELTa? on page 84Returns the time or frequency difference
between the two vertical bar cursors.
CURSor:VBArs:HPOS<x>? on page 84Returns the horizontal value of the specified
vertical bar ticks for cursor <x>
CURSor:VBArs:POSITION<x> on page 85Sets or returns the vbar cursor<x> horizontal
position
CURSor:VBArs:UNIts on page 86Sets or queries the units for the vertical bar
cursors.
CURSor:VBArs:VDELTa? on page 87Returns the vertical (amplitude) difference
between the two vertical bar cursors.
CURSor:VBArs:VDELTa? on page 87Returns the difference between the cursors X
radius and the cursor Y radius.
16 TBS2000 Series Programmer
Command groups
Ethernet command group
These commands provide control of the Ethernet feature.
Table 12: Ethernet commands
CommandDescription
ETHERnet:DHCPbootp on page 108IP configuration method selection? DHCP or
static ip?
ETHERnet:DNS:IPADDress on page 109DNS IP address set or query.
ETHERnet:DOMAINname on page 109Domain name set or query.
ETHERnet:ENET:ADDress? on page 110Mac query only.
ETHERnet:GATEWay:IPADDress on page 110 Gateway ip set or query.
ETHERnet:HTTPPort on page 111Http port set or query.
ETHERnet:IPADDress on page 112Ip address set or query.
ETHERnet:NAME on page 112Name set or query.
ETHERnet:PASSWord on page 113Password set or query.
ETHERnet:PING on page 113Do ping operation.
ETHERnet:PING:STATUS? on page 114Return ping status: success, no response and
others.
ETHERnet:SUBNETMask on page 114Netmask set or query.
FFT command group
These commands provide control over the instrument FFT feature.
Table 13: FFT commands
CommandDescription
FFT? on page 120Returns all FFT parameters.
FFT:HORizontal:POSition on page 121Sets or queries the FFT horizontal display
position.
FFT:HORizontal:SCAle on page 121Sets or queries the FFT zoom factor.
FFT:SOURce on page 122Sets or queries the FFT source.
FFT:SRCWFM on page 122Sets or queries the FFT source waveform
display state.
FFT:VERtical:POSition on page 123Sets or queries the FFT vertical display position.
FFT:VERtical:SCAle on page 123Sets or queries the FFT vertical zoom factor.
FFT:VERTical:UNIts on page 124Sets or returns the FFT vertical measurement
units label.
FFT:VType on page 124Sets or queries the FFT waveform vertical units.
FFT:WINdow on page 125Sets or queries the FFT window state.
SELect:FFT on page 214Sets or queries the FFT display state.
TBS2000 Series Programmer 17
Command groups
File system command group
File system commands perform file management tasks.
Table 14: File system commands
CommandDescription
FILESystem? on page 125Returns the directory listing of the current
working directory and the number of bytes of
free space available.
FILESystem:CWD on page 126Sets or queries returns the current working
directory (CWD) for FILESystem commands.
FILESystem:DELEte on page 127Deletes the specified file name.
FILESystem:DIR? on page 128Returns a list of strings.
FILESystem:FORMat on page 128Formats a mass storage device.
FILESystem:FREESpace? on page 129Returns the number of bytes of free space on
the current drive.
FILESystem:MKDir on page 130Creates a folder at the specified location.
FILESystem:READFile on page 131Writes the contents of the specified file to the
specified interface
FILESystem:REName on page 131Assigns a new name to a file or folder.
FILESystem:RMDir on page 132Deletes a folder at the specified location.
FILESystem:WRITEFile on page 133Writes the specified block data to the instrument
current working directory
FILESystem:MOUNT:AVAILable on page 134List of available drive letters that can be used for
mounting network drives
FILESystem:MOUNT:DRIve on page 134Mount the network drive specified by the quoted
string argument
FILESystem:MOUNT:LIST on page 135Returns a comma-separated list of the mounted
network drives
FILESystem:MOUNT:UNMOUNT on page 136Attempts to un-mount the network drive
18 TBS2000 Series Programmer
Command groups
File System Conventions
Use the following conventions when specifying file paths and file names:
■
File and folder names have a maximum of 11 characters; eight characters,
followed by a period, followed by up to three characters. This format is
referred to as 8.3 naming.
■
Wild card characters (*, %, ) are not valid characters in file or path names.
■
Lists the Windows-generated short file and folder names for long file or
folder names created on PC Windows operating systems.
Help everywhere command group
Help everywhere commands provide helpful user information.
Table 15: Help everywhere commands
CommandDescription
HELPevery:ACQuire on page 142Enables or disables the display of help
HELPevery:ALL on page 143Enables or disables the display of help
HELPevery:FFT on page 144Enables or disables the display of help
HELPevery:CURsor on page 143Enables or disables the display of help
HELPevery:MATH on page 144Enables or disables the display of help
HELPevery:MEASUrement on page 145Enables or disables the display of help
HELPevery:REFerence on page 146Enables or disables the display of help
HELPevery:TRIGger on page 146Enables or disables the display of help
HELPevery:UTIlity on page 147Enables or disables the display of help
HELPevery:VERtical on page 148Enables or disables the display of help
everywhere information for the acquire module.
everywhere.
everywhere information for the fft module.
everywhere information for the cursor module.
everywhere information for the math module.
everywhere information for the measurement
module.
everywhere information for the reference
module.
everywhere information for the trigger module.
everywhere information for the utility module.
everywhere information for the vertical module.
TBS2000 Series Programmer 19
Command groups
Horizontal command group
Horizontal commands control the time bases of the instrument. You can set the
position and time per division of both the main and window time bases. You can
substitute SECdiv for SCAle in all appropriate horizontal commands. This
provides program compatibility with previous Tektronix digitizing instruments.
Table 16: Horizontal commands
CommandDescription
HORizontal? on page 148Returns all settings for the horizontal
commands.
HORizontal[:MAIn]:SCAle on page 155Sets or queries the time base horizontal scale.
HORizontal[:MAIn]:SECdiv on page 156Specifies the horizontal time/div.
HORizontal:TRIGger:POSition on page 159Same as :HORizontal:POSition.
HORizontal:TRIGger:POSition on page 159Set or queries the trigger position.
HORizontal[:MAIn][:DELay]:POSition on
page 151
HORizontal[:MAIn]:DELay:MODe on page 152The boolean argument type sets delay mode to
HORizontal[:MAIn]:DELay:STATe on page 153 Same as HORizontal:DELay:MODe.
HORizontal[:MAIn]:DELay:TIMe on page 154Specifies the delay time in time units.
HORizontal:DELay:SCAle on page 150Same as HORizontal:SCAle.
HORizontal:DELay:SECdiv on page 150Same as HORizontal:SCAle.
HORizontal:RESOlution on page 158Same as HORizontal:RECOrdlength.
HORizontal:RECOrdlength on page 157Sets or queries the horizontal record length.
HORizontal:RECOrdlength:Auto on page 158Sets or queries the record length mode.
HORizontal:ACQLENGTH on page 149Queries the record length.
HORizontal:PREViewstate on page 157Returns a boolean to indicate whether the
HORizontal[:MAIn]:SAMPLERate on page 154Returns the sample rate
HORizontal:MAIn:UNIts[:STRing] on page 156Queries the horizontal units.
HORizontal:DIVisions on page 151Queries the number of horizontal divisions.
HORizontal:ROLL on page 159Query the state of roll mode.
Sets or returns the horizontal position, as
percent of record, that is used when
HORizontal:DELay:MODe is set to OFF.
on or off.
acquisition system is in the preview state
20 TBS2000 Series Programmer
Math command group
Command groups
Math commands provide math function definition.
Table 17: Math commands
CommandDescription
MATH? on page 165Returns the definition for the math waveform.
MATH:DEFINE on page 166Performs the specified mathematical operation
on the input signal or signals.
MATH:HORizontal:POSition on page 167Sets or returns the horizontal position of the
math waveform.
MATH:HORizontal:SCALe on page 167Sets or returns the horizontal scale of the math
waveform.
MATH:HORizontal:UNIts on page 168Sets or returns the math horizontal
measurement units label.
MATH:VERtical:POSition on page 169Sets or returns the math waveform display
position.
MATH:VERtical:SCAle on page 169Sets or returns the math waveform display scale
in units per division.
MATH:VERTical:UNIts on page 170Sets or returns the math vertical measurement
units label.
Measurement command group
Measurement commands control the automated measurement system. The
instrument can display up to six automated measurements. In the commands,
these measurement readouts are named MEAS<x>, where <x> can be 1, 2, 3, 4,
5, or 6.
The best method for taking measurements over the computer interface is to use
the MEASUREMENT:IMMED commands and queries. The immediate
measurement has no front-panel equivalent, and the instrument never displays
immediate measurements.
Because they are computed only when they are requested, immediate
measurements slow the waveform update rate less than displayed measurements.
Use the VALue? query to obtain measurement results of either displayed or
immediate measurements.
Several measurement commands set and query measurement parameters. You
can assign some parameters, such as waveform sources, differently for each
measurement readout.
TBS2000 Series Programmer 21
Command groups
Table 18: Measurement commands
CommandDescription
MEASUrement? on page 171Returns the current MEASUrement settings.
MEASUrement:CLEARSNapshot on page 172Clears the existing snapshop results and
removes the snapshot window.
MEASUrement:GATing on page 172Sets or returns the measurement gating.
MEASUrement:IMMed? on page 173Returns all immediate measurement setup
parameters.
MEASUrement:IMMed:DELay? on page 174Returns information about the immediate delay
measurement.
MEASUrement:IMMed:DELay:EDGE<x> on
page 174
MEASUrement:IMMed:SOUrce1 on page 175Sets or queries the source for single-source
MEASUrement:IMMed:SOUrce2 on page 176Sets or queries the secondary source for dual-
MEASUrement:IMMed:TYPe on page 177Sets or queries the immediate measurement
MEASUrement:IMMed:UNIts? on page 180Returns the units for the immediate instrument
MEASUrement:IMMed:VALue? on page 180Executes the immediate instrument
MEASUrement:MEAS<x>? on page 181Returns all measurement parameters for the
MEASUrement:MEAS<x>:DELay? on page 182 Returns the delay measurement parameters for
MEASUrement:MEAS<x>:DELay:EDGE<x> on
page 182
MEASUrement:MEAS<x>:SOUrce1 on
page 183
MEASUrement:MEAS<x>:SOUrce2 on
page 184
MEASUrement:MEAS<x>:STATE on page 185 Sets or returns whether the specified
MEASUrement:MEAS<x>:TYPe on page 186Sets or queries the on-screen periodic
MEASUrement:MEAS<x>:UNIts? on page 189Returns the units for the instrument
MEASUrement:MEAS<x>:VALue? on page 190 Returns the value that was calculated for the
Sets or returns the slope of the edge used for
immediate delay from and to waveform
measurements
immediate measurements.
source immediate measurements.
type.
measurement.
measurement specified by the
MEASUrement:IMMed:TYPe command.
displayed instrument periodic measurement
specified by <x>.
the specified measurement.
Sets or returns the slope of the edge to use for
delay “from” and “to” waveform measurements.
Sets or queries the source for an automated
measurement.
Sets or returns the channel to which
measurements are sent.
measurement slot is computed and displayed.
instrument measurement type for the
measurement specified by <x>.
measurement specified by
MEASUrement:MEAS<x>:TYPe.
instrument on-screen periodic measurement
specified by <x>.
22 TBS2000 Series Programmer
Command groups
CommandDescription
MEASUrement:SNAPSHOT on page 191Sets the measurement snapshot feature.
MEASUrement:SOURCESNAPShot on
page 191
MEASUrement:IMMed:SOUrce<x> on
page 177
MEASUrement:MEAS<x>:SOUrce<x> on
page 185
Sets or returns the snapshot source.
Sets or returns the source for the current single
channel measurement.
Sets or returns the source for the specified
measurement.
Miscellaneous command group
Miscellaneous commands are a group of commands that do not fit into any other
category.
Several commands and queries are common to all 488.2-1987 devices on the
GPIB or USB bus. These commands and queries are defined by IEEE Std.
488.2-1987 and Tektronix Standard Codes and Formats 1989 and begin with an
asterisk (*) character.
Table 19: Miscellaneous commands
CommandDescription
AUTOSet on page 49Causes the instrument to adjust its vertical,
horizontal, and trigger controls to display a
stable waveform.
AUTOSet:ENABLE on page 49Allows educators to disable or enable the
Autorange and Autoset functions.
CLEARMenu on page 75Clears the current menu from the display
DATE on page 95Sets or queries the instrument date value.
DISplay:GRAticule on page 102Sets or queries the Graticule state.
DISplay:INTENSITy:BACKLight on page 103Sets or queries the display Backlight.
FPAnel:PRESS on page 136Simulates the action of pressing a specified
front-panel button.
FPAnel:TURN on page 138Simulates the action of turning a specified front-
panel control knob.
FWUpdate:Update on page 139Update firmware from u-disk.
HDR on page 141This command is identical to the HEADer query
and is included for compatibility with other
Tektronix instruments.
HEADer on page 141Sets and queries the Response Header Enable
State that causes the instrument to either
include or omit headers on query responses.
ID? on page 161Returns identifying information about the
instrument and its firmware in Tektronix Codes
and Formats notation.
TBS2000 Series Programmer 23
Command groups
CommandDescription
*IDN? on page 162Returns the instrument identification code in
IEEE 488.
LANGuage on page 163Sets or queries the languages that the
instrument uses to display information on the
screen.
LOCk on page 164Enables and disables all front-panel buttons and
knobs.
*LRN? on page 164This is identical to the query.
*RST on page 204(Reset) Returns the instrument to a known set of
instrument settings, but does not purge any
stored settings.
SET? on page 217Returns most instrument settings.
TEKSecure on page 221Equivalent to invoking Teksecure from the
Utility->Config->TekSecure Erase Memory
menu.
TIMe on page 221Sets or queries the instrument time value.
UNLock on page 243Unlocks the front panel.
VERBose on page 245Sets and queries the Verbose state that controls
the length of keywords on query responses.
Save and Recall command group
Save and Recall commands allow you to store and retrieve internal waveforms
and settings. When you "save a setting," you save most of the settings of the
instrument. When you then "recall a setting," the instrument restores itself to the
state it was in when you saved that setting.
To display a saved waveform, use the SELect:<wfm> command.
Table 20: Save and Recall commands
CommandDescription
FACtory on page 119Resets the instrument to factory default settings.
*RCL on page 197Restores the instrument to factory default
RECAll:SETUp on page 198Restores the factory-default instrument settings,
RECAll:WAVEForm on page 199Recalls a stored waveform from the USB flash
*SAV on page 205Saves the state of the instrument into a specified
settings stored in internal nonvolatile memory.
user-saved settings from internal nonvolatile
memory, or user-saved settings from a file on a
USB flash drive.
drive into a reference location.
nonvolatile memory location.
24 TBS2000 Series Programmer
Command groups
CommandDescription
SAVe:ASSIgn:TYPe on page 206Sets or queries the assignment of the data to be
saved.
SAVe:IMAge on page 206Saves the screen image to a file on the USB
flash drive.
SAVe:IMAge:FILEFormat on page 207Sets the screen image file format used by the
SAVe:IMAGE command and by the SAVE >
Action > Save Image and SAVE > Action > Save
All front-panel operations.
SAVe:IMAGe:LAYout on page 208Sets or queries the layout to use for saved
screen images.
SAVe:SETUp on page 209Saves the current state of the instrument into the
specified nonvolatile memory location, or to a file
on the USB flash drive.
SAVe:WAVEform on page 210Stores a waveform in one of the nonvolatile
reference memory locations, or to a file on the
USB flash drive.
SAVe:WAVEform:FILEFormat on page 211Sets or returns the format for saved waveforms.
SETUP<x>:DATE? on page 218Returns the date when the specified instrument
setup was saved.
SETUP<x>:TIME? (Query Only) on page 218Returns the time when the specified instrument
setup was saved
Status and Error command group
Status and error commands let you determine the status of the instrument and
control events.
Several commands and queries are common to all devices on the GPIB or USB
bus. These commands and queries are defined by IEEE Std. 488.2-1987 and Tek
Standard Codes and Formats 1989, and begin with an asterisk (*) character.
Table 21: Status and Error commands
CommandDescription
ALLEv? on page 48Causes the instrument to return all events and
BUSY? on page 51Returns the status of the instrument.
*CLS on page 75Clears the Event Queue, Standard Event Status
DESE on page 96Sets and queries the bits in the Device Event
*ESE on page 106Sets and queries the bits in the Event Status
their messages, and removes the returned
events from the Event Queue.
Register, and Status Byte Register (except the
MAV bit)..
Status Enable Register (DESER).
Enable Register (ESER).
TBS2000 Series Programmer 25
Command groups
CommandDescription
*ESR? on page 107Returns the contents of the Standard Event
Status Register (SESR).
EVENT? on page 115Returns from the Event Queue an event code
that provides information about the results of the
last *ESR? read.
EVMsg? on page 116Removes from the Event Queue a single event
code associated with the results of the last
*ESR? read, and returns the event code with an
explanatory message.
EVQty? on page 117Return number of events in the event queue.
*OPC on page 193Generates the operation complete message in
the Standard Event Status Register (SESR)
when all pending commands that generate an
OPC message are complete.
*PSC on page 195Sets and queries the power-on status flag that
controls the automatic power-on handling of the
DESER, SRER, and ESER registers.
*RST on page 204Resets the instrument to factory default settings.
*SRE on page 219(Service Request Enable) sets and queries the
bits in the Service Request Enable Register
(SRER).
*STB? on page 220(Read Status Byte) query returns the contents of
the Status Byte Register (SBR) using the Master
Summary Status (MSS) bit.
*WAI on page 247Prevents the instrument from executing further
commands or queries until all pending
commands that generate an OPC message are
complete.
26 TBS2000 Series Programmer
Command groups
Trigger command group
Trigger commands control all aspects of instrument triggering.
The three types of triggers are edge, pulse width, and video. Edge triggering is
the default type. Edge triggering lets you acquire a waveform when the signal
passes through a voltage level of your choosing. Pulse width triggering lets you
trigger on normal or aberrant pulses. Video triggering adds the capability of
triggering on video fields and lines.
Table 22: Trigger commands
CommandDescription
TRIGger on page 222Forces a trigger event to occur.
TRIGger:A on page 223Sets the instrument trigger level to 50% of the
minimum and maximum values of the signal.
TRIGger:A:EDGE? on page 224Returns the trigger coupling, source, and slope
settings for the edge trigger.
TRIGger:A:EDGE:COUPling on page 224Sets or queries the type of coupling for the edge
trigger.
TRIGger:A:EDGE:SLOpe on page 225Selects a rising or falling slope for the edge
trigger.
TRIGger:A:EDGE:SOUrce on page 226Sets or queries the source for the edge trigger.
TRIGger:A:HOLDOff? on page 227Returns the A trigger holdoff settings.
TRIGger:A:HOLDOff:TIMe on page 227Sets or queries the instrument trigger holdoff
time.
TRIGger:A:LEVel on page 228Sets or returns the trigger level for the A trigger.
TRIGger:A:LEVel:CH<x> on page 229Sets or returns the trigger level for the specified
channel. Each channel can have an
independent level.
TRIGger:A:LOWerthreshold:CH<x> on
page 229
TRIGger:A:MODe on page 230Sets or queries the trigger mode for the Edge
TRIGger:A:PULse? on page 231Returns the current Pulse Trigger settings.
TRIGger:A:PULSE:Width? on page 233Returns the pulse trigger width settings.
TRIGger:A:PULse:WIDth:POLarity on page 233 Sets or queries the polarity for the pulse trigger.
TRIGger:A:PULSEWidth:SOUrce on page 234Sets or queries the source for the pulse trigger.
TRIGger:A:PULse:WIDth:WHEN on page 234Sets or queries the trigger conditions for the
TRIGger:A:PULse:WIDth:WIDth on page 235Sets or queries the width for the pulse trigger.
TRIGger:A:RUNT? on page 236Returns the current A runt trigger parameters.
TRIGger:A:RUNT:POLarity on page 237Sets or returns the polarity for the runt trigger.
TRIGger:A:RUNT:SOUrce on page 238Sets or returns the source for the A runt trigger.
TRIGger:A:RUNT:WHEn on page 238Sets or returns the type of pulse width the trigger
Sets or returns the lower threshold for the
channel selected.
(all models) and Pulse width trigger types.
pulse trigger.
checks for when it detects a runt.
TBS2000 Series Programmer 27
Command groups
CommandDescription
TRIGger:A:RUNT:WIDth on page 239Sets or returns the width for a runt trigger.
TRIGger:A:TYPe on page 240Sets or queries the type of instrument trigger.
TRIGger:A:UPPerthreshold:CH<x> on
page 241
TRIGger:FREQuency? on page 242Returns the edge or pulse width trigger
TRIGger:STATE? on page 242Returns the current state of the triggering
Sets the upper threshold for channel <x>, where
x is the channel number. Each channel can have
an independent level. Used only for runt trigger
type.
frequency.
system.
Vertical command group
Vertical commands control the attributes of the channels. The SELect:<wfm>
command also displays a specified waveform or removes it from the display.
Table 23: Vertical commands
CommandDescription
CH<x>? on page 60Returns vertical parameters for the specified
channel.
CH<x>:BANdwidth on page 60Sets or queries the bandwidth setting of the
specified instrument channel.
CH<x>:COUPling on page 61Sets or queries the input coupling setting of the
specified instrument channel.
CH<x>:DESKew on page 62Sets or queries the deskew time for the specified
channel
CH<x>:INVert on page 63Sets or returns the invert function for the
specified channel.
CH<x>:OFFSet on page 63Sets or queries the channel offset.
CH<x>:POSition on page 64Sets or queries the vertical position of the
specified instrument channel.
CH<x>:PRObe on page 65?Returns the gain, resistance, units, and ID of the
probe that is attached to the specified channel.
CH<x>:PRObe:AUTOZero on page 66Sets the TekVPI probe attached to the specified
channel input to autozero.
CH<x>:PRObe:DEGAUss on page 66Starts a degauss/autozero cycle on a TekVPI
current probe attached to the specified channel
input.
CH<x>:PRObe:DEGAUss:STATE? on
page 67
CH<x>:PRObe:FORCEDRange on page 68Sets or queries the range on a TekVPI probe
Returns the state of the probe degauss.
attached to the specified channel.
28 TBS2000 Series Programmer
Command groups
CommandDescription
CH<x>:PRObe:GAIN on page 69Sets or queries the gain factor of the probe that
is attached to the specified channel.
CH<x>:PRObe:ID? on page 70Returns the type and serial number of the probe
that is attached to the specified channel.
CH<x>:PRObe:ID:SERnumber? on page 70Returns the serial number of the probe that is
attached to the specified channel.
CH<x>:PRObe:ID:TYPE? on page 71Returns the type of probe that is attached to the
specified channel.
CH<x>:PRObe:SIGnal on page 71Sets or queries the input bypass setting of the
TekVPI probe attached to the specified channel.
CH<x>:PRObe:UNIts? on page 72Returns the units of measure of the probe that is
attached to the specified channel.
CH<x>:SCAle on page 72Sets or queries the vertical scale of the specified
instrument channel.
CH<x>:VOLts on page 73Sets or queries the vertical sensitivity of the
specified channel.
CH<x>:YUNit on page 74Sets or queries the units of the specified
channel.
REF<x>? on page 200Returns reference waveform data for the
specified channel.
REF<x>:DATE? on page 200Returns the date that the reference waveform
was stored.
REF<x>:TIMe? on page 201Returns the time that the reference waveform
was stored.
REF<x>:HORizontal:DELay:TIMe? on page 201 Returns the horizontal position of the specified
reference waveform in percent of the waveform
that is displayed to the right of the center vertical
graticule.
REF<x>:HORizontal:SCAle? on page 202Returns the horizontal scale for the reference
waveform.
REF<x>:HORizontal:SCAle? on page 202Returns the vertical position for channel <x>,
where x is the reference channel number.
REF<x>:VERTical:POSition? on page 203Returns the vertical position of the specified
reference waveform.
REF<x>:VERTical:SCAle? on page 203Returns the reference waveform vertical scale in
vertical units/div.
SELect:CH<x> on page 212Turns the display of the channel <x> waveform
on or off.
SELect:CONTROl on page 213Sets or returns the waveform that is selected as
the implied recipient of channel-related
commands
SELect:FFT on page 214Turns on or off the FFT waveform or queries
whether the FFT waveform is on or off.
TBS2000 Series Programmer 29
Command groups
CommandDescription
SELect:MATH on page 215Turns on or off the math waveform or queries
whether the math waveform is on or off.
SELect:REF<x> on page 216Turns on or off the specified reference waveform
or queries whether the specified reference
waveform is on or off.
Waveform command group
Waveform commands let you transfer waveform data points to and from the
instrument. Waveform data points are a collection of values that define a
waveform. One data value usually represents one data point in the waveform
record. When working with peak-detect waveforms, each data value is either the
min or max of a min/max pair. Before you can transfer waveform data, you must
specify the data format and waveform locations.
Refer to the text following this table for more information about waveform
commands.
Table 24: Waveform commands
CommandDescription
CURVe on page 87Transfers instrument waveform data to and from
the instrument in binary or ASCII format.
DATa on page 89Sets or queries the format and location of the
waveform data that is transferred with the
CURVe command.
DATa:DESTination on page 90Sets or queries the reference memory location
for storing instrument waveform data that is
transferred into the instrument by the CURVe
command.
DATa:SOUrce on page 91Sets or queries which waveform will be
transferred from the instrument by the CURVe,
WFMPre, or WAVFrm? queries.
DATa:STARt on page 92Sets or queries the starting data point for
waveform data transfers.
DATa:STOP on page 93Sets or queries the last data point in the
waveform that will be transferred when
executing the CURVe? command.
DATa:WIDth on page 94Sets the number of bytes per waveform data
point to be transferred when executing the
CURVe command.
WAVFrm? on page 248Returns WFMPre? and CURVe? data for the
waveform specified by the DATa:SOUrce
command.
WFMInpre:BIT_Nr on page 249Sets or queries the number of bits per waveform
point for the waveform to be transferred.
30 TBS2000 Series Programmer
Command groups
CommandDescription
WFMInpre:BYT_Nr on page 250Sets or queries the data width for the waveform
to be transferred.
WFMInpre:ENCdg on page 250Sets or queries the type of encoding for
waveform data transferred with the CURVe
command.
WFMInpre:NR_Pt? on page 251Returns the number of points that are in the
transmitted waveform record, as specified by
DATa:SOUrce.
WFMInpre:XINcr on page 252The set form of this command specifies the
interval (seconds per point for nonFFT, Hertz
per point for FFT) between samples of the
reference waveform specified by the
DATa:DESTination command.
WFMInpre:XUNit on page 252Sets the horizontal units ("s" for seconds and
"Hz" for Hertz) for the reference waveform
specified by the DATa:DESTination command.
WFMInpre:XZEro on page 253The set form of this command specifies the
position, in XUNits, of the first sample of the
reference waveform specified by the
DATa:DESTination command, relative to the
trigger.
WFMInpre:YMUlt on page 254Sets or queries the vertical scale factor of the
incoming waveform, expressed in YUNits per
waveform data point level.
WFMInpre:YOFf on page 255Sets or queries the vertical position of the
incoming waveform in digitizing levels.
WFMInpre:YUNit on page 255Sets the vertical units for the reference
waveform specified by DATa:DESTination.
WFMInpre:YZEro on page 256Sets or returns the vertical offset of the incoming
waveform in units specified by WFMInpre:YUNit.
WFMOutpre? on page 257Returns waveform transmission and formatting
settings for the waveform specified by the
DATa:SOUrce command.
WFMOutpre:BIT_Nr on page 258Sets and queries the number of bits per
waveform point that outgoing waveforms
contain, as specified by the DATa:SOUrce
command.
WFMOutpre:BYT_Nr on page 259Sets or queries the data width for the outgoing
waveform specified by the DATa:SOUrce
command.
WFMOutpre:ENCdg on page 260Sets and queries the type of encoding for
outgoing waveforms.
WFMOutpre:NR_Pt? on page 261Returns the number of points for the
DATa:SOUrce waveform that will be transmitted
in response to a CURVe? query.
TBS2000 Series Programmer 31
Command groups
CommandDescription
WFMOutpre:RECOrdlength? on page 261Returns the record length for the source
waveform as specified by the DATa:SOUrce
command.
WFMOutpre:WFId? on page 262Returns a descriptive string from the waveform
specified in the DATa:SOUrce command, if that
waveform is active or displayed.
WFMOutpre:XINcr? on page 263Returns the horizontal point spacing in units of
WFMOutpre:XUNit for the waveform specified
by the DATa:SOUrce command.
WFMOutpre:XUNit? on page 263Returns the horizontal units for the waveform
specified by the DATa:SOUrce command.
WFMOutpre:XUNit? on page 263Returns the time coordinate of the first point in
the outgoing waveform.
WFMOutpre:YMUlt? on page 265Returns the vertical scale factor per digitizing
level in units specified by WFMOutpre:YUNit for
the waveform specified by the DATa:SOUrce
command.
WFMOutpre:YOFf? on page 265Returns the vertical position in digitizing levels
for the waveform specified by the DATa:SOUrce
command.
WFMOutpre:YUNit? on page 266Returns the vertical units for the waveform
specified by the DATa:SOUrce command.
WFMOutpre:YZEro? on page 267Returns the vertical offset in units specified by
WFMOutpre:YUNit? for the waveform specified
by the DATa:SOUrce command.
Waveform data formats
Internally, the instrument uses one 8-bit data byte to represent each waveform
data point, regardless of the acquisition mode.
The DATa:WIDth command lets you specify the number of bytes per data point
when transferring data to and from an instrument. This provides compatibility
with other digitizing instruments.
When DATa:WIDth is set to two:
■
If sending data, the instrument multiplies each point by 256; the most
significant byte then has meaningful data and the least significant byte is 0.
■
If receiving data, the instrument truncates the data (divides by 256) and saves
the most significant byte.
NOTE. The instrument uses these methods to handle waveforms transmitted in
ASCII or binary format.
The instrument can transfer waveform data in either ASCII or binary format.
Use the DATa:ENCdg command to specify one of the following formats:
■
ASCII data is represented by signed integer values. The range of values
depends on the byte width specified. One-byte-wide data ranges from -128 to
127. Two-byte-wide data ranges from -32768 to 32767.
32 TBS2000 Series Programmer
Command groups
Each data value requires two to seven characters. This includes one character
for the minus sign if the value is negative, one to five ASCII characters for
the waveform value, and a comma to separate data points.
An example of an ASCII waveform data string follows:
Binary data can be represented by signed integer or positive integer values.
The range of the values depends on the byte width specified.
Table 25: Binary data ranges
Byte widthSigned integer rangePositive integer range
1 -128 to 127 0 to 255
2 -32,768 to 32,767 0 to 65,535
The defined binary formats also specify the order in which the bytes are
transferred giving a total of four binary formats: RIBinary, RPBinary, SRIbinary,
and SRPbinary.
Waveform data record
RIBinary is signed integer where the most significant byte is transferred first, and
RPBinary is positive integer where the most significant byte is transferred first.
SRIbinary and SRPbinary correspond to RIBinary and RPBinary respectively but
use a swapped byte order where the least significant byte is transferred first. The
byte order is ignored when DATa:WIDth is set to 1.
You can transfer multiple points for each waveform record. You can transfer a
part of the waveform or you can transfer the entire record. The DATa:STARt and
DATa:STOP commands let you specify the first and last data points of the
waveform record.
When transferring data into the instrument you must specify the location of the
first data point within the waveform record. For example, when DATa:STARt is
set to 1, data points will be stored starting with the first point in the record, and
when DATa:STARt is set to 500, data will be stored starting at the 500th point in
the record. The instrument ignores DATa:STOP when reading in data as the
instrument will stop reading data when there is no more data to read or when it
has reached 2500 data points.
You must specify the first and last data points in the waveform record when
transferring data from the instrument to an external device. Setting DATa:STARt
to 1 and DATa:STOP to 2500 always sends the entire waveform, regardless of
the acquisition mode.
TBS2000 Series Programmer 33
Command groups
Waveform data locations
and memory allocation
Waveform preamble
Scaling waveform data
The DATa:SOUrce command specifies the location of the data when transferring
waveforms from the instrument. You can transfer one waveform at a time.
You can transfer only one waveform into the instrument at a time. Each
waveform is stored in one of two stored waveform locations for 2-channel
models or one of four stored waveform locations for 4-channel models. You
specify the stored waveform location with the DATa:DESTination command.
NOTE. The instrument stores waveforms that are ≤2500 data points long. The
instrument truncates waveforms longer than 2500 data points.
Each waveform that is transferred has an associated waveform preamble that
contains information such as the horizontal scale, vertical scale, and other
settings in place when the waveform was created. Refer to the WFMPre?
commands for more information about the waveform preamble.
Once you transfer the waveform data to the controller, you can convert the data
points into voltage values for analysis using information from the waveform
preamble.
Transferring waveform
data
Data transfer times depend on data format, data width, and the speed of the
controller. Programming Examples on page 295
From the instrument. To transfer waveforms from the instrument to an external
controller, follow these steps:
1. Use the DATa:SOUrce command to select the waveform source.
2. Use the DATa:ENCdg command to specify the waveform data format.
3. Use the DATa:WIDth command to specify the number of bytes per data
point.
4. Use the DATa:STARt and DATa:STOP commands to specify the part of the
waveform that you want to transfer.
5. Use the WFMPre? command to transfer waveform preamble information.
6. Use the CURVe command to transfer waveform data.
To the instrument. To transfer waveform data to an instrument waveform storage
location, follow these steps:
1. Use the DATa:DESTination command to specify the stored waveform
location.
2. Use the DATa:ENCdg command to specify the waveform data format.
3. Use the DATa:WIDth command to specify the number of bytes per data
point.
4. Use the DATa:STARt command to specify the first data point in the
waveform record.
5. Use the WFMPre? command to transfer waveform preamble information.
6. Use the CURVe command to transfer waveform data.
34 TBS2000 Series Programmer
Command groups
Zoom command group
These commands support the zoom feature.
Table 26: Zoom commands
CommandDescription
ZOOM? on page 269Returns the current horizontal positioning and
scaling of the display.
ZOOM:ZOOM1:STATE on page 274Sets or queries the zoom on/off state.
ZOOm:ZOOM1? on page 270Returns the current horizontal positioning and
scaling of the display
ZOOM:ZOOM1:FACtor on page 271Sets or queries the zoom factor of a particular
zoom box.
ZOOM:ZOOM1:HORizontal:POSition on
page 271
ZOOM:ZOOM1:HORizontal:SCAle on page 272 Sets or queries the horizontal zoom scale of the
ZOOm:ZOOM1:POSition on page 273Sets or returns the horizontal zoom position for
ZOOm:ZOOM1:SCAle on page 273Sets or returns the horizontal zoom scale of the
ZOOM:ZOOM1:STATE on page 274Specifies or returns a trace as zoomed, on or
Sets or queries the horizontal position of a
particular zoom box.
specified waveform in the specified zoom.
the specified waveform in the specified zoom
specified waveform in the specified zoom
off.
TBS2000 Series Programmer 35
Command groups
36 TBS2000 Series Programmer
A commands
ACQuire?
This section lists commands and queries that begin with the letter A.
Returns the current acquisition settings. Query only.
Group
Syntax
Related Commands
Returns
Examples
Acquisition
ACQuire?
ACQuire:MODe on page 38, ACQuire:NUMACq? on page 40, ACQuire:
NUMAVg on page 41, ACQuire:NUMAVg on page 41
Returns current acquisition settings: Stop after, Acquisition state, Mode, Number
of averages.
ACQuire? might return the following string for the current acquisition:
ACQUIRE:STOPAFTER RUNSTOP;STATE 1;MODE SAMPLE;NUMAVG 16
TBS2000 Series Programmer 37
A commands
ACQuire:MAXSamplerate?
Returns the maximum real-time sample rate, which varies from model to model.
Query only.
Examples
ACQuire:MODe
Group
Syntax
Acquisition
ACQuire:MAXSamplerate?
ACQUIRE:MAXSAMPLERATE? might return 2.0000E+9 indicating the
maximum real-time sample rate is 2.0 GS/s.
Sets or queries the acquisition mode of the instrument for all live waveforms.
Waveforms are the displayed data point values taken from acquisition intervals.
Each acquisition interval represents a time duration set by the horizontal scale
(time per division).
The instrument sampling system always samples at the maximum rate, so the
acquisition interval may include more than one sample. The acquisition mode,
which you set using this ACQuire:MODe command, determines how the final
value of the acquisition interval is generated from the many data samples.
Group
Syntax
38 TBS2000 Series Programmer
Acquisition
ACQuire:MODe {SAMple|PEAKdetect|AVErage}
ACQuire:MODe?
A commands
Related commands
Arguments
Examples
ACQuire:NUMAVg on page 41, CURVe on page 87
SAMple specifies that the displayed data point value is the first sampled value
that was taken during the acquisition interval. The waveform data has 8 bits of
precision in all acquisition modes. You can request 16 bit data with a CURVe?
query, but the lower-order 8 bits of data will be zero. SAMple is the default
mode.
PEAKdetect specifies the display of the high-low range of the samples taken
from a single waveform acquisition. The instrument displays the high-low range
as a vertical column that extends from the highest to the lowest value sampled
during the acquisition interval. PEAKdetect mode can reveal the presence of
aliasing or narrow spikes.
AVErage specifies averaging mode, in which the resulting waveform shows an
average of SAMple data points from several separate waveform acquisitions. The
instrument processes the number of waveforms you specify into the acquired
waveform, creating a running exponential average of the input signal. The
number of waveform acquisitions that go into making up the average waveform
is set or queried using the ACQuire:NUMAVg command.
ACQuire:MODe AVErage sets average acquisition mode so that the resulting
waveform is the average of the specified number of waveform acquisitions.
ACQuire:MODe? might return ACQUIRE:MODE AVERAGE indicating that
the displayed waveform is the average of the specified number of waveform
acquisitions.
TBS2000 Series Programmer 39
A commands
ACQuire:NUMACq?
Indicates the number of acquisitions that have taken place since starting
instrument acquisition. The acquisition number will continue to increase while
acquisitions are running until there is a reset.
Starting and stopping acquisitions do not cause this number to reset. For example,
if acquisitions are running, the acquisition count will increase (assuming the
instrument is triggering). If you stop the acquisitions, the acquisition number will
freeze at a given number (For example: 5000). If you start acquisitions again, it
will continue from 5000. The number will reset to 0 only if you change the
horizontal scale while acquisitions are running.
Group
Syntax
Related commands
Returns
Examples
Acquisition
ACQuire:NUMACq?
ACQuire:STATE on page 41
<NR1>
ACQuire:NUMACq? might return ACQUIRE:NUMACQ 350 indicating that
350 acquisitions have occurred.
40 TBS2000 Series Programmer
A commands
ACQuire:NUMAVg
Sets or queries the number of waveform acquisitions that make up an averaged
waveform. Use the ACQuire:MODe command to enable Average mode. Sending
this command is equivalent to turning a multipurpose knob to enter the number of
waveform acquisitions to average.
Arguments
Examples
ACQuire:STATE
Group
Syntax
Acquisition
ACQuire:NUMAVg <NR1>
ACQuire:NUMAVg?
<NR1> is the number of waveform acquisitions to average. The range of values
is from 2 to 512 in powers of two.
ACQuire:NUMAVg 16 specifies that 16 waveform averages are performed
before exponential averaging starts.
ACQuire:NUMAVg? might return ACQUIRE:NUMAVG 64 indicating that
there are 64 acquisitions specified for averaging.
Starts or stops acquisitions.
When State is set to ON or RUN, a new acquisition is started. If the last
acquisition was a single acquisition sequence, a new single sequence acquisition
is started. If the last acquisition was continuous, a new continuous acquisition is
started.
If RUN is issued in the middle of completing a single sequence acquisition (for
example, averaging or enveloping), the acquisition sequence is restarted, and any
accumulated data is discarded. Also, the instrument resets the number of
acquisitions. If the RUN argument is issued while in continuous mode,
acquisition continues.
TBS2000 Series Programmer 41
A commands
Group
Syntax
Related Commands
Arguments
Examples
Acquisition
ACQuire:STATE {OFF|ON|RUN|STOP|<NR1>}
ACQuire:STATE?
*OPC on page 193, ACQuire:STOPAfter on page 42
OFF|STOP|<NR1> = 0 stops acquisitions; any other value starts acquisitions..
ON|RUN|<NR1> ≠ 0 starts acquisition and display of waveforms.
ACQuire:STATE RUN starts acquisition of waveform data and resets the number
of acquisitions count (NUMACq) to zero.
ACQuire:STATE? might return: ACQUIRE:STATE 0 indicating that the
acquisition is stopped.
ACQuire:STOPAfter
Group
Syntax
Sets or returns whether the instrument continually acquires acquisitions or
acquires a single sequence.
Acquisition
ACQuire:STOPAfter {RUNSTop|SEQuence}
ACQuire:STOPAfter?
42 TBS2000 Series Programmer
A commands
ALIas
Related commands
Arguments
Examples
ACQuire:STATE on page 41
RUNSTop specifies that the instrument will continually acquire data, if
ACQuire:STATE is turned on.
SEQuence specifies that the next acquisition will be a single-sequence
acquisition.
ACQuire:STOPAfter RUNSTOP sets the instrument to continually acquire data.
ACQuire:STOPAfter? might return: ACQUIRE:STOPAFTER SEQUENCE
indicating that the next acquisition the instrument makes will be of the singlesequence type.
Sets or queries the state of alias functionality.
Use Alias commands to define new commands as a sequence of standard
commands. You may find this useful when repeatedly using the same commands
to perform certain tasks like setting up measurements. Aliases are similar to
macros but do not include the capability to substitute parameters into alias
bodies.
Group
Syntax
To use Alias commands, first define the alias, then turn on the alias state.
Alias
ALIas {OFF|ON|<NR1>}
ALIas?
TBS2000 Series Programmer 43
A commands
Related commands
Arguments
ALIas:CATalog?
ALIas:DEFine on page 45, ALIas[:STATE] on page 47
OFF turns alias expansion off. If a defined alias is sent when ALIas is off, a
command error (110) will be generated.
ON turns 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.
Examples
ALIAS ON turns the alias feature on. When a defined alias is received, the
specified command sequence is substituted for the alias and executed.
ALIAS? might return :ALIAS 1 indicating that the alias feature is on.
Returns a list of the currently defined alias labels, separated by commas. If no
aliases are defined, the query returns the string "". Query only.
Group
Syntax
Alias
ALIas:CATalog?
Examples
ALIAS:CATALOG? might return the string :ALIAS:CATALOG
"SETUP1","TESTMENU1","DEFAULT" showing that there are three aliases
named SETUP1, TESTMENU1, and DEFAULT.
44 TBS2000 Series Programmer
A commands
ALIas:DEFine
Assigns a sequence of program messages to an alias label. These messages are
then substituted for the alias whenever it is received as a command or query,
provided that ALIas:STATE has been turned on. The query form of this
command returns the definitions of a selected alias.
NOTE. Attempting to give two aliases the same name causes an error. To give a
new alias the name of an existing alias, the existing alias must first be deleted.
Group
Syntax
Related commands
Arguments
Alias
ALIas:DEFine <QString><,>{<QString>|<Block>}
ALIas:DEFine? <QString>
ALIas[:STATE] on page 47
The first <QString> is the alias label. This label cannot be a command name.
Labels must start with a letter and can contain only letters, numbers, and
underscores; other characters are not allowed. The label must be less than or
equal to 12 characters. The second<QString> or <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 256 characters.
Examples
ALIAS:DEFINE "ST1",":RECALL:SETUP 5;:AUTOSET
EXECUTE;:SELECT:CH1 ON" defines an alias named "ST1" that sets up the
instrument.
ALIAS:DEFINE? "ST1" returns :ALIAS:DEFINE
"ST1",#246 :RECALL:SETUP 5;:AUTOSET EXECUTE;:SELECT:CH1 ON.
TBS2000 Series Programmer 45
A commands
ALIas:DELEte
Removes a specified alias and is identical to ALIas:DELEte:NAMe. An error
message is generated if the named alias does not exist. (No query form.
Group
Syntax
Related commands
Arguments
ALIas:DELEte:ALL
Alias
ALIas:DELEte <QString>
*ESR? on page 107, ALIas:DELEte:ALL on page 46
<QString> is the name of the alias to be removed. Using ALIas:DELEte without
specifying an alias causes an execution error. <QString> must be a previously
defined value.
Examples
ALIAS:DELETE "SETUP1" deletes the alias named SETUP1.
Deletes all existing aliases. No query form.
Group
Syntax
Related commands
Alias
ALIas:DELEte:ALL
ALIas:DELEte on page 46, ALIas:DELEte[:NAMe] on page 47
Examples
ALIAS:DELETE:ALL deletes all existing aliases.
46 TBS2000 Series Programmer
A commands
ALIas:DELEte[:NAMe]
Removes a specified alias. This command is identical to ALIas:DELEte. No
query form.
Arguments
ALIas[:STATE]
Group
Syntax
Group
Alias
ALIas:DELEte[:NAMe] <QString>
<QString> is the name of the alias to remove. Using ALIas:DELEte[:NAMe]
without specifying an alias causes an execution error. <QString> must be an
existing alias.
Examples
ALIAS:DELETE:NAME “STARTUP” deletes the alias named STARTUP.
Turns aliases on or off. This command is identical to the ALIas command.
Alias
Syntax
Arguments
ALIas[:STATE] {<NR1>|OFF|ON}
ALIas[:STATE]?
OFF or <NR1> = 0 turns alias expansion off. If a defined alias is sent when
ALIas:STATE is OFF, a command error (102) is generated.
ON or <NR1> ≠ 0 turns alias expansion on. When a defined alias is received, the
specified command sequence is substituted for the alias and executed.
Examples
ALIAS:STATE OFF turns the command alias feature off.
ALIAS[:STATE]? returns 0 when the alias feature is off.
TBS2000 Series Programmer 47
A commands
ALLEv?
Causes the instrument to return all events and their messages, and removes the
returned events from the Event Queue. The messages are separated by commas.
Use the *ESR? query to enable the events to be returned. Refer to the Status and
Events section for a complete description of how to use these registers. This
command is similar to repeatedly sending *EVMsg? queries to the instrument.
Query only.
Group
Syntax
Related Commands
Returns
Status and Error
ALLEv?
*CLS on page 75, DESE on page 96, *ESE on page 106, *ESR? on
page 107, EVENT? on page 115, EVMsg? on page 116, EVQty? on page 117,
*SRE on page 219, *STB? on page 220
The event code and message in the following format:
<Command> is the command that caused the error and may be returned when a
command error is detected by the instrument. As much of the command is
returned as possible without exceeding the 60 character limit of the <Message>
and <Command> strings combined. The command string is right-justified.
Examples
48 TBS2000 Series Programmer
ALLEv? might return the following string: ALLEV 2225,"MEASUREMENT
ERROR, NO WAVEFORM TO MEASURE; ",420,"QUERY
UNTERMINATED; "
AUTOSet
A commands
Causes the instrument to adjust its vertical, horizontal, and trigger controls to
display a stable waveform. This command is equivalent to pushing the frontpanel AUTOSET button. For a detailed description of the Autoset function, refer
to the user manual for your instrument. Command only, no query form.
Group
Syntax
Arguments
AUTOSet:ENABLE
Group
Syntax
Miscellaneous
AUTOSet {EXECute | UNDo}
EXECute runs Autoset on the selected waveform.
UNDo restores the oscilloscope settings to those prior to running Autoset.
Allows educators to disable or enable the Autorange and Autoset functions. The
function can be manually set from the Utility menu. To access the menu, refer to
the your product user manual.
Miscellaneous
AUTOSet:ENABLE {ON | OFF}
AUTOSet:ENABLE?
Related commands
Arguments
TBS2000 Series Programmer 49
AUTOSet on page 49
ON enables the autoset feature.
OFF disables the autoset feature.
Examples
AUTOSET:ENABLE OFF disables autoset.
AUTOSET:ENABLE? might return AUTOSET:ENABLE 1 indicating that
autoset is enabled.
A commands
50 TBS2000 Series Programmer
B commands
BUSY?
This section lists commands and queries that begin with the letter B.
Returns the status of the instrument. This command allows you to synchronize
the operation of the instrument with your application program. Query only.
Certain instrument operations can affect the BUSY? response. Table 30:
Instrument operations that can generate OPC on page 282
Group
Syntax
Related Commands
Returns
Examples
Status and Error
BUSY?
*OPC on page 193, *WAI on page 247
<NR1> = 0 means the instrument is not busy processing a command whose
execution time is extensive.
<NR1> = 1 means the instrument is busy processing a command whose
execution time is extensive. Table 30: Instrument operations that can generate
OPC on page 282
BUSY? might return :BUSY 1 indicating that the instrument is now busy. See
Using the BUSY Query on page 284 for an example of how to use this query.
TBS2000 Series Programmer 51
B commands
52 TBS2000 Series Programmer
C commands
*CAL?
This section lists commands and queries that begin with the letter C.
Performs an internal self-calibration and returns its status. This is equivalent to
selecting the Do Self Cal option in the Utility menu. Although *CAL? is a query
command, it does perform an action. Query only.
NOTE. The self-calibration can take several minutes to complete. During this
time, the instrument does not execute any commands.
Disconnect all signals from the instrument before performing an internal selfcalibration.
Group
Syntax
Related Commands
Returns
Examples
Calibration and Diagnostic
*CAL?
CALibrate:INTERNAL on page 56
0 indicates that the self-calibration completed without any errors detected.
Any value other than zero indicates that the self-calibration did not complete
successfully or completed with errors.
*CAL? performs a self-calibration and might return 0 to indicate that it
completed successfully.
TBS2000 Series Programmer 53
C commands
CALibrate:FACtory
Starts the instrument internal factory calibration operation. The calibration
operation consists of a sequence of steps. You send the CALibrate:CONTINUE
command to advance to the next calibration step. The calibration program
automatically sets up the instrument for each calibration step. Use the
CALibrate:ABOrt command to abort the factory calibration. Command only, no
query form.
NOTE. You should only use this command in a qualified service environment. For
more information about the factory calibration sequence, refer to the service
manual for your instrument.
You can only send synchronization commands or queries (such as *OPC, OPC,
*WAI, BUSY) while doing a factory calibration.
This command starts a signal path compensation. Command only, no query form.
NOTE. The self-calibration can take several minutes to complete. During this
time, the instrument does not execute any commands.
Disconnect all signals from the instrument before performing an internal selfcalibration.
Group
Syntax
Examples
Calibration and Diagnostic
CALibrate:INTERNAL
CALibrate:INTERNAL starts a signal path compensation cycle.
CALibrate:INTERNal:STARt
Starts the internal signal path calibration (SPC) of the instrument. You can use
the CALibrate:INTERNal:STATus? query to return the current status of the
internal signal path calibration of the instrument. No query form.
Group
Syntax
Calibration and Diagnostic
CALibrate:INTERNal:STARt
Related commands
56 TBS2000 Series Programmer
CALibrate:RESults:SPC? on page 59
Examples
CALIBRATE:INTERNAL:START initiates the internal signal path
compensation of the instrument.
C commands
CALibrate:INTERNal:STATus?
Returns the current status of the instrument internal signal path compensation for
the last SPC operation. Query only.
Group
Syntax
Related commands
Returns
Calibration and Diagnostic
CALibrate:INTERNal:STATus?
*CAL? on page 53
INIT indicates the instrument has not had internal signal path calibration run.
PASS indicates the signal path calibration completed successfully.
FAIL indicates the signal path calibration did not complete successfully.
RUNNING indicates the signal path calibration is currently running.
Examples
CALibrate:INTERNal:STATus? might
return :CALIBRATE:INTERNAL:STATUS INIT indicating that the current
status of the internal signal path compensation is that it has not been run.
TBS2000 Series Programmer 57
C commands
CALibrate:RESults?
Returns the status of internal and factory calibrations, without performing any
calibration operations. Query only.
The results returned do not include the calibration status of attached probes. The
CALibrate:RESults? query is intended to support GO/NoGO testing of the
instrument calibration readiness: all returned results should indicate PASS status
if the instrument is fit for duty. It is quite common, however, to use uncalibrated
probes (particularly when the instrument inputs are connected into a test system
with coaxial cables).
Group
Syntax
Related commands
Calibration and Diagnostic
CALibrate:RESults?
*CAL? on page 53
Examples
CALibrate:RESults? might return :CALibrate:RESults INIT indicating the
instrument has not be calibrated.
CALibrate:RESults:FACtory?
Returns the status of internal and factory calibration, without performing any
calibration operations. Query only.
Group
Calibration and Diagnostic
58 TBS2000 Series Programmer
C commands
Syntax
CALibrate:RESults:FACtory?
Examples
CALibrate:RESults:FACtory? might return CALibrate:RESults:FACtory INIT
indicating the instrument has not be calibrated.
CALibrate:RESults:SPC?
Returns the status of the SPC operation. This query does not initiate a SPC.
Query only.
Group
Syntax
Related commands
Calibration and Diagnostic
CALibrate:RESults:SPC?
*CAL? on page 53
Returns
INIT indicates that SPC has never successfully completed.
PASS indicates that the last SPC operation passed.
FAIL indicates that the last SPC operation failed.
RUNNING indicates that the SPC operation is running.
Examples
CALibrate:RESults:SPC? might return :CALibrate:RESults:SPC INIT indicating
SPC has not be run successfully.
TBS2000 Series Programmer 59
C commands
CH<x>?
Returns the vertical parameters for the specified channel. The value of <x> can
vary from 1 through 4 depending on instrument model. Query only.
Because CH<x>:SCAle and CH<x>:VOLts are identical, only CH<x>:SCAle is
returned.
Group
Syntax
Related Commands
Returns
Examples
CH<x>:BANdwidth
Vertical
CH<x>?
SELect:REF<x> on page 216
instrument vertical settings for the specified channel.
Sets or queries the selectable low-pass bandwidth limit filter setting of the
specified instrument channel. The value of <x> can vary from 1 through
4 depending on instrument model.
This command is equivalent to setting the BW Limit option in the Vertical menu.
Group
60 TBS2000 Series Programmer
Vertical
C commands
Syntax
Arguments
Examples
CH<x>:COUPling
CH<x>:BANdwidth {TWEnty|FULl|<NR3>}
CH<x>:BANdwidth?
TWEnty sets the upper bandwidth limit of channel <x> to 20 MHz.
FULl disables any optional bandwidth limiting. The specified channel operates at
its maximum attainable bandwidth.
<NR3> is a double-precision ASCII string. The instrument rounds this value to
an available bandwidth using geometric rounding, and then uses this value to set
the upper bandwidth limit.
NOTE. Other values may be possible depending on the attached probes.
CH1:BANDWIDTH TWENTY sets the bandwidth of channel 1 to 20 MHz.
CH1:BANDWIDTH? might return FULl. This indicates there is no bandwidth
limiting on channel 1.
Group
Syntax
Sets or queries the input attenuator coupling setting of the specified instrument
channel. The value of <x> can vary from 1 through 4 depending on the
instrument model.
This command is equivalent to setting the Coupling option in the Vertical menu.
Vertical
CH<x>:COUPling {AC|DC|GND}
CH<x>:COUPling?
TBS2000 Series Programmer 61
C commands
Arguments
Examples
CH<x>:DESKew
AC sets the specified instrument channel to AC coupling.
DC sets the specified instrument channel to DC coupling.
GND sets the specified instrument channel to ground. Only a flat ground-level
waveform is displayed.
CH1:COUPLING AC establishes AC coupling on channel 1.
CH2:COUPLING? might return :CH2:COUPling DC indicating that channel 2 is
set to DC coupling.
Sets or queries the deskew time for channel <x>, where x is the channel number.
You can adjust the deskew time to add an independent, channel-based delay time
to the delay (set by the horizontal position control and common to all channels)
from the common trigger point to first sample taken for each channel. This lets
you compensate individual channels for different delays introduced by their
individual input hook ups.
Group
Syntax
Arguments
Vertical
CH<x>:DESKew <NR3>
CH<x>:DESKew?
<NR3> is the deskew time for channel <x>, ranging from -100 ns to +100 ns
with a resolution of 1 ns.
Examples
CH4:DESKew 5.0E-9 sets the deskew time for channel 4 to 5 ns.
CH2:DESKew? might return :CH2:DESKEW 2.0000E-09 indicating that the
deskew time for channel 2 is set to 2 ns.
62 TBS2000 Series Programmer
CH<x>:INVert
C commands
Sets or queries the inversion state of the specified instrument channel. The value
of <x> can vary from 1 through 4 depending on the instrument model.
This command is equivalent to setting the Invert option in the Vertical channel
menus.
Arguments
Examples
CH<x>:OFFSet
Group
Syntax
Vertical
CH<x>:INVert {ON|OFF}
CH<x>:INVert?
ON inverts the specified instrument channel.
OFF sets the specified instrument channel to noninverted.
CH1:INVERT ON inverts the signal on channel 1.
CH2:INVERT? might return :CH2:INVERT 0, indicating that channel 2 is not
inverted.
Sets or queries the vertical offset for channel <x>, where x is the channel number.
This command offsets the vertical acquisition window (moves the level at the
vertical center of the acquisition window) for the specified channel. Visualize
offset as scrolling the acquisition window towards the top of a large signal for
increased offset values, and scrolling towards the bottom for decreased offset
values. The resolution of the vertical window sets the offset increment for this
control.
Offset adjusts only the vertical center of the acquisition window for channel
waveforms to help determine what data is acquired. The instrument always
displays the input signal minus the offset value.
The channel offset range depends on the vertical scale factor. The valid ranges
for the instrument are (when the probe and external attenuation factor is X1):
For V/Div settings from 2 mV/div to 200 mV/div, the offset range is +/- 0.8 V
For V/Div settings from 202 mV/div to 5 V/div, the offset range is +/- 20 V
TBS2000 Series Programmer 63
C commands
Related commands
Arguments
CH<x>:POSition
Group
Syntax
Vertical
CH<x>:OFFSet <NR3>
CH<x>:OFFSet?
CH<x>:POSition on page 64
<NR3> is the offset value for the specified channel <x>.
Examples
CH3:OFFSet 2.0E-3 sets the offset for channel 3 to 2 mV.
CH4:OFFSet? might return :CH4:OFFSET 1.0000E-03 indicating that the offset
for channel 4 is set to 1 mV.
Sets or queries the vertical position of the specified instrument channel. The
value of <x> can vary from 1 through 4 depending on the instrument model.
Group
The position voltage value is applied to the signal before digitization. Increasing
the position value of a waveform causes the waveform to move up. Decreasing
the position value causes the waveform to move down. The position value
determines the vertical graticule coordinate at which input signal values, minus
the present offset setting for that channel, are displayed. For example, if the
position for Channel 3 is set to 2.0 and the offset is set to 3.0, then input signals
equal to 3.0 units are displayed 2.0 divisions above the center of the screen (at
1 V/div).
Vertical
64 TBS2000 Series Programmer
C commands
Related commands
Arguments
Examples
CH<x>:PRObe
Syntax
CH<x>:POSition <NR3>
CH<x>:POSition?
CH<x>:OFFSet on page 63REF<x>:VERTical:POSition? on page 203MATH:
VERtical:POSition on page 169
<NR3> is the position in divisions from the center graticule for the specified
channel. The range is 5 to -5 divisions.
CH2:POSITION 1.3E0 positions the channel 2 input signal 1.3 divisions above
the center of the display.
CH1:POSITION? might return :CH1:POSITION -1.3000 indicating that the
vertical position of Channel 1 is 1.3 divisions below the center graticule.
Returns all information concerning the probe attached to channel <x>, where x is
the channel number. The value of <x> can vary from 1 through 4 depending on
the instrument model.
Group
Syntax
Examples
Vertical
CH<x>:PRObe?
CH1:PROBE? might return CH1:PROBE 10.
TBS2000 Series Programmer 65
C commands
CH<x>:PRObe:AUTOZero
Sets the TekVPI probe attached to channel <x> to zero, where x is the channel
number. No Query Form.
Group
Syntax
Arguments
Vertical
CH<x>:PRObe:AUTOZero EXECute
Execute auto zeros the probe.
Examples
CH1:PRObe:AUTOZero EXECute sets the probe attached to channel 1 to zero.
CH<x>:PRObe:DEGAUss
Starts a degauss auto-zero cycle on a TekVPI current probe attached to the input
channel specified by <x>, where x is the channel number. No Query Form.
Group
Vertical
Syntax
Arguments
CH<x>:PRObe:DEGAUss EXECute
EXECute initiates the degauss operation.
Examples
CH1:PRObe:DEGAUss EXECute starts a degauss cycle on the probe attached to
channel 1.
66 TBS2000 Series Programmer
C commands
CH<x>:PRObe:DEGAUss:STATE?
Returns the state of the probe degauss for the channel specified by <x>, where is
x is the channel number. Query Only.
NOTE. This command will return PASSED for probes that do not support degauss
operations.
Group
Syntax
Returns
Vertical
CH<x>:PRObe:DEGAUss:STATE?
NEEDED indicates the probe should be degaussed before taking measurements.
RECOMMENDED indicates the measurement accuracy might be improved by
degaussing the probe.
PASSED indicates the probe is degaussed.
FAILED indicates the degauss operation failed.
RUNNING indicates the probe degauss operation is currently in progress.
Examples
CH1:PRObe:DEGAUss:STATE? might return :CH1:PRObe:DEGAUss:STATE
FAILED indicating the degauss operation failed.
TBS2000 Series Programmer 67
C commands
CH<x>:PRObe:FORCEDRange
Sets or returns the range of a TekVPI probe attached to the channel specified by
<x>, where x is the channel number.
NOTE. This command returns 0.0 for probes that do not forced range.
Group
Syntax
Arguments
Returns
Vertical
CH<x>:PRObe:FORCEDRange <NR3>
CH<x>:PRObe:FORCEDRange?
<NR3> specifies the range, which is probe specific.
This command returns 0.0 for probes that do no support forced range.
Examples
CH1:PRObe:FORCEDRange 0.3 set the range of the probe on channel 1 to 0.3.
0.0 indicating that the probe attached to channel 1 does not support forced range.
68 TBS2000 Series Programmer
C commands
CH<x>:PRObe:GAIN
Sets or queries the gain factor for the probe attached to the channel specified by
<x>, where x is the channel number. The gain of a probe is the output divided by
the input transfer ratio. For example, a common 10x probe has a gain of 0.1.
Group
Syntax
Related commands
Arguments
Vertical
CH<x>:PRObe:GAIN <NR3>
CH<x>:PRObe:GAIN?
CH<x>:SCAle on page 72
<NR3> is the probe gain. Allowed values depend on the specific probe.
Examples
CH1:PRObe:GAIN 0.1 sets the channel 1 probe gain to 0.1.
CH2:PROBE:GAIN? might return :CH2:PROBE:GAIN 0.1000E+00 indicating
that the attached 10x probe delivers 1 V to the channel 2 BNC for every 10 V
applied to the probe input.
TBS2000 Series Programmer 69
C commands
CH<x>:PRObe:ID?
Returns the type and serial number of the probe attached to channel <x>, where x
is the channel number. Query only.
Group
Vertical
Syntax
Examples
CH2:PROBE:ID? might return :CH2:PROBE:ID:TYPE "10X";SERNUMBER
"N/A" indicating that a passive 10x probe of unknown serial number is attached
to channel 2.
CH<x>:PRObe:ID:SERnumber?
Returns the serial number of the probe attached to channel <x>, where x is the
channel number. Query Only.
NOTE. For Level 0 and 1 probes, the serial number will be "".
Group
Vertical
Syntax
70 TBS2000 Series Programmer
CH<x>:PRObe:ID:SERnumber?
Examples
CH1:PROBE:ID:SERNUMBER? might return :CH1:PROBE:ID:SERNUMBER
"B010289" indicating that the serial number of the probe attached to channel 1 is
B010289.
C commands
CH<x>:PRObe:ID:TYPE?
Returns the type of probe attached to the channel specified by <x>, where x is the
channel number. Level 2 (or higher) probes supply their exact product
nomenclature; for Level 0 or 1 probes, a generic “No Probe Detected message is
returned. Query Only.
Group
Syntax
CH<x>:PRObe:SIGnal
Group
Syntax
Vertical
CH<x>:PRObe:ID:TYPE?
Examples
CH1:PROBE:ID:TYPE? might return :CH1:PROBE:ID:TYPE "P6203"
indicating that a P6203-type probe is attached to channel 1.
Sets or queries the input bypass setting of a TekVPI probe attached to channel
<x>, where x is the channel number. The probe must support input bypass, for
example TCP0001. This command is ignored if sent to an unsupported probe.
Vertical
CH<x>:PRObe:SIGnal {BYPass|PASS}
CH<x>:PRObe:SIGnal?
Arguments
TBS2000 Series Programmer 71
BYPass sets the probe to Bypass mode.
PASS sets the probe to Pass mode.
Examples
CH1:PRObe:SIGnal PASS set the probe attached to channel 1 to Pass mode.
CH1:PRObe:SIGnal? might return :CH1:PRObe:SIGnal PASS indicating that the
probe attached to channel 1 is in Pass mode
C commands
CH<x>:PRObe:UNIts?
Returns a string describing the units of measure for the probe attached to channel
<x>, where x is the channel number. Query Only.
CH<x>:SCAle
Group
Syntax
Vertical
CH<x>:PRObe:UNIts?
Examples
CH4:PROBE:UNITS? might return :CH4:PROBE:UNITS "V" indicating that the
units of measure for the probe attached to channel 4 are volts.
Sets or queries the vertical scale of the specified instrument channel. The value of
<x> can vary from 1 through 4 depending on the instrument model.
Each waveform has a vertical scale parameter. For a signal with constant
amplitude, increasing the Scale causes the waveform to be displayed smaller.
Decreasing the scale causes the waveform to be displayed larger.
Scale affects all waveforms, but affects channel waveforms differently from other
waveforms:
For channel waveforms, this setting controls the vertical size of the acquisition
window as well as the display scale. The range and resolution of scale values
depends on the probe attached and any other external factors you have specified.
For reference and math waveforms, this setting controls the display only,
graphically scaling these waveforms and having no affect on the acquisition
hardware.
This command is equivalent to adjusting the front-panel VOLTS/DIV knob.
72 TBS2000 Series Programmer
C commands
Group
Syntax
Related Commands
Arguments
Examples
Vertical
CH<x>:SCAle <NR3>
CH<x>:SCAle?
CH<x>:OFFSet on page 63, CH<x>:POSition on page 64,
REF<x>:VERTical:SCAle? on page 203, MATH:VERtical:SCAle on page 169
<NR3> is the scale, in units-per-division. The value entered here is truncated to
three significant digits.
CH1:SCALE 100E-3 sets the channel 1 gain to 100 mV/div.
CH2:SCALE? might return :CH2:SCALE 1.0000, indicating that the current V/
div setting of channel 2 is 1 V/div.
CH<x>:VOLts
Group
Syntax
Sets or queries the vertical sensitivity of the specified channel. The value of <x>
can vary from 1 through 4 depending on the instrument model.
This command is identical to the CH<x>:SCAle command and is included for
compatibility purposes. Only CH<x>:SCAle is returned in response to a CH<x>?
query.
Vertical
CH<x>:VOLts <NR3>
CH<x>:VOLts?
TBS2000 Series Programmer 73
C commands
Arguments
CH<x>:YUNit
Group
<NR3> is the vertical sensitivity, in volts.
Examples
CH1:VOLts 1.0 sets channel 1 to 1 Volt per division.
CH1:VOLts? Might return CH1:VOLts 1.0 indication that the ch1 volts per
division is 1 Volt per division.
Sets or queries the units of the specified channel. The value of <x> can vary from
1 through 4 depending on instrument model number.
String arguments are case insensitive and any unsupported units will generate an
error. Supported units are:
<QString> is a string of text surrounded by quotes, specifying the supported
units. This command is case insensitive.
CH2:YUNit "V" sets the units for channel 2 to Volts.
CH2:YUNIT might return CH2:YUNIT "V", indicating that the channel 2 units
are volts.
74 TBS2000 Series Programmer
C commands
CLEARMenu
Clears the current menu from the display. This command is equivalent to
pressing the front panel Menu off. No query form.
*CLS
Group
Syntax
Miscellaneous
CLEARMenu
Examples
CLEARMenu clears the current menu from the display.
Command only, no query form. The *CLS command clears the following
instrument status data structures:
■
The Event Queue
■
The Standard Event Status Register (SESR)
■
The Status Byte Register (except the MAV bit)
If the *CLS command immediately follows an <EOI>, the Output Queue and
MAV bit (Status Byte Register bit 4) are also cleared. MAV indicates
information is in the output queue. The device clear (DCL) GPIB control
message and the USBTMC INITIATE_CLEAR control message will clear the
output queue and also MAV.
*CLS does not clear the output queue or MAV. *CLS can suppress a service
request that is to be generated by an *OPC command. This will happen if a hard
copy output or single sequence acquisition operation is still being processed
when the *CLS command is executed. See Registers on page 275
Group
TBS2000 Series Programmer 75
Status and Error
C commands
Related Commands
CURSor?
Syntax
Examples
Group
Syntax
*CLS
DESE on page 96, *ESE on page 106, *ESR? on page 107, EVENT? on
page 115, EVMsg? on page 116, *SRE on page 219, *STB? on page 220
*CLS clears the instrument status data structures.
Returns current cursor settings. Query only.
Cursor
CURSor?
Returns
Examples
instrument cursor settings.
CURSor? might return the following string as the current cursor
settings: :CURSOR:FUNCTION SCREEN;HBARS:POSITION1
0.0000;POSITION2 0.0000;UNITS BASE;:CURSOR:MODE
INDEPENDENT;VBARS:POSITION1 -19.0006E-6;POSITION2
-18.9994E-6;UNITS SECONDS.
76 TBS2000 Series Programmer
C commands
CURSor:FUNCtion
Sets or queries the instrument cursor type. Cursors are attached to the selected
waveform in Waveform mode and are attached to the display area in Screen
mode..
Group
Syntax
Arguments
Cursor
CURSor:FUNCtion{OFF|SCREEN|WAVEform|VBArs|HBArs}
CURSor:FUNCtion?
OFF removes the cursors from the display but does not change the cursor type.
SCREEN specifies both horizontal and vertical bar cursors, which measure the
selected waveform in horizontal and vertical units. Use these cursors to measure
anywhere in the waveform display area.
WAVEform specifies paired cursors in YT display format for measuring
waveform amplitude and time. In XY and XYZ format, these cursors indicate the
amplitude positions of an XY pair (Ch1 vs Ch2 voltage, where Ch1 is the X axis
and Ch2 is the Y axis) relative to the trigger.
VBArs specifies the vertical bar cursor to measure the selected waveform in
vertical units.
HBArs specifies the horizontal bar cursor to measure the selected waveform in
horizontal units.
Examples
CURSOR:FUNCTION WAVEFORM selects the paired cursors for measuring
waveform amplitude and time.
CURSOR:FUNCTION? might return :CURSor:FUNCtion SCREEN indicating
that the screen cursors are currently selected.
TBS2000 Series Programmer 77
C commands
CURSor:HBArs?
Returns the settings for the instrument horizontal bar cursors. Query only.
Group
Syntax
Returns
Examples
CURSor:HBArs:DELTa?
Group
Cursor
CURSor:HBArs?
Current horizontal bar cursor settings.
CURSor:HBArs? might return the horizontal bar setting as return the horizontal
bar setting as :CURSOR:HBARS:POSITION1
320.0000E-03;POSITION2-320.0000E-03;UNITS BASE.
Returns the difference (in vertical units) between the two horizontal bar cursors
in the instrument display. Query only.
Cursor
Syntax
Related commands
Returns
CURSor:HBArs:DELTa?
CURSor:HBArs:UNIts on page 80
<NR3> is the difference between the horizontal bar cursors.
78 TBS2000 Series Programmer
C commands
Examples
CURSOR:HBARS:DELTA? might return :CURSOR:HBARS:DELTA 5.0800E
+00 indicating that the difference between the two cursors is 5.08.
CURSor:HBArs:POSITION<x>
Sets or returns the horizontal bar cursor position relative to ground, which is
expressed in vertical units (usually volts). The cursor is specified by x, which can
be 1 or 2.
Group
Syntax
Related commands
Cursor
CURSor:HBArs:POSITION<x> <NR3>
CURSor:HBArs:POSITION<x>?
CURSor:FUNCtion on page 77
Arguments
Examples
<NR3> specifies the horizontal bar cursor position, relative to ground (in volts
when the units are volts and amps when the units are amps), relative to the center
of the screen (in divs when units are divisions), or relative to 1 V RMS (in
decibels when the source is an FFT math waveform), for the waveform specified
by the CURSor:SELect:SOUrce command.
The cursor position is limited to the graticule whenever an attempt is made to
move it outside the graticule.
NOTE. The source determines the measurement units.
CURSOR:HBARS:POSITION1 25.0E-3 positions Cursor 1 of the horizontal
cursors at 25 mV.
-64.0000E-03 indicating that Cursor 2 of the horizontal bar cursors is at -64 mV.
TBS2000 Series Programmer 79
C commands
CURSor:HBArs:UNIts
Sets or queries the vertical scale units for the selected cursor source waveform.
Group
Syntax
Arguments
Returns
Cursor
CURSor:HBArs:UNIts {BASe|PERcent}
CURSor:HBArs:UNIts?
BASe selects the vertical units for the selected waveform.
PERcent selects ratio cursors.
VOLTS indicates volts from ground as the unit of measure.
DIVS indicates divisions as the unit of measure, with center of screen as
0 divisions and bottom of screen as -4 divisions.
DECIBELS indicates decibels as the unit of measure, relative to a 1 V
wave. (FFT only)
UNKNOWN indicates that Trigger View is active. This also generates event
message 221. (Settings conflict)
AMPS indicates amperes as the unit of measure.
rms
sine
VOLTSSQUARED indicates volts squared (V*V) as the unit of measure.
AMPSSQUARED indicates amperes squared (A*A) as the unit of measure.
VOLTSAMPS indicates voltage times current (V*A) as the unit of measure.
NOTE. Unknown units are represented by "" in the instrument readouts.
80 TBS2000 Series Programmer
C commands
Examples
CURSor:HBArs:USE
Group
Syntax
Related commands
Arguments
CURSor:HBArs:UNIts? might return :CURSOR:HBARS:UNITS BASE
indicating that the units for the horizontal bar cursors are base.
Sets the horizontal bar cursor measurement scale. This command is only
applicable when ratio cursors are on. No query form.
Cursor
CURSor:HBArs:USE {CURrent|HALFgrat|FIVEdivs}
CURSor:HBArs:UNIts on page 80
CURrent sets the H Bar measurement scale so that 0% is the current position of
the lowest H Bar cursor and 100% is the current position of the highest H Bar
cursor.
HALFgrat resets the H bar measurement scale to half the number of divisions
(five for some models and four for others) so that 25% is the current position of
the lowest H Bar cursor and 75% is the current position of the highest H Bar.
FIVEdivs sets H Bar measurement scale so that five screen major divisions is
100%, where 0% is –2.5 divisions and 100% is +2.5 divisions from the center
horizontal graticule.
Examples
CURSOR:HBARS:USE FIVEDIVS sets the H Bar measurement scale so that
5 screen major divisions equals 100%.
TBS2000 Series Programmer 81
C commands
CURSor:MODe
Sets or returns whether the two cursors move linked together in unison or
separately. This applies to the Waveform cursors display mode.
Conditions
Group
Syntax
Arguments
This command is only applicable when waveform cursors are displayed.
Cursor
CURSor:MODe {TRACk|INDependent}
CURSor:MODe?
TRACk ties the navigational functionality of the two cursors together. For cursor
1 adjustments, this ties the movement of the two cursors together; however,
cursor 2 continues to move independently of cursor 1.
INDependent allows independent adjustment of the two cursors.
Examples
CURSOR:MODE TRACK specifies that the cursor positions move in unison.
CURSOR:MODE? might return :CURSOR:MODE TRACK indicating that the
two cursors move in unison.
82 TBS2000 Series Programmer
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.