Tektronix products are covered by U.S. and foreign patents, issued and pending. Information in this publication
supersedes that in all previously published material. Specifications and price change privileges reserved.
TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.
Supports product software version 6.0 and above.
Contacting Tektronix
Tektronix, Inc.
14150 SW Karl Braun Drive
P.O. B o x 5 0 0
Beaverto
USA
For product information, sales, service, and technical support:
n, OR 97077
In North America, call 1-800-833-9200.
Worldwide, visit www.tek.com to find contacts in your area.
This programmer guide provides you with the information required to remotely
control your instrument.
In addition to this manual, other resources available about your instrument include
the following documents.
Documentat
ion
Review the following table to locate more information about this product.
You c a n do w n load P D F files of the documents from
www.tek.com/manual/downloads.
To read aboutUse these documents
Installation and SafetyRead the Installation and Safety manual for proper instrument
installation and general safety information.
This document is provided with the instrument and is also
available for download from the Tektronix web site.
Operation and User
Interface Help
Programmer
commands
Specifications
and Performance
Verification procedures
Access the user help from the Help menu for information on
controls and screen elements.
The user help information is also available as a PDF file available
from the Tektronix web site.
The Programmer document provides the proper syntax of remote
commands.
This document is available for download from the Tektronix w eb
site.
This Technical Reference document provides the specifications
and the performance verification procedures.
This document is available for download from the Tektronix w eb
site.
AWG5200 Series Programmer Manualiii
Preface
ivAWG5200 Series Programmer Manual
Getting Started
Introduction
This programmer guide provides you with the information required to use
Programmable Interface (PI) commands for remotely controlling your instrument
over a LAN electronic interface. With this information, you can write computer
programs that perform functions such as setting the front-panel controls, selecting
clock sourc
In addition to the LAN electronic interface, your AWG is provided with a TekV I S A
GPIB-comp
The programmer guide is divided into the following major sections:
Getting Started: p rovides basic information about setting up your AWG for
remote control.
Syntax and Commands: provides an overview of the command syntax used
to communicate with the instrument and other general information about
command
commands, constructed mnemonics, and argument types.
e, setting sampling rate, and exporting data for use in other programs.
atible interface, (referred to as the virtual GPIB interface).
s, such as how commands and queries are constructed, how to enter
Comman
Command groups: contains all the commands listed in functional groups.
Each g
table that lists all the commands and queries for that group.
us and Events: discusses the status and event reporting system for the
Stat
LAN interface. This system informs you of certain significant events that
occur within the instrument.
Appendices: contains miscellaneous information, such as LAN interface
specifications that may be helpful when using remote commands.
d syntax:
roup consists of an overview of the commands in that group and a
AWG5200 Series Programmer Manual1-1
Remote control
Remote control
You can remotely control communications between your instrument and a PC via
Ethernet or GPIB cables. Refer to the following sections describing the setups and
connections
required.
Ethernet control
If you are using Ethernet, start by connecting an appropriate Ethernet cable to the
Ethernet port (RJ-45 connector) on the rear panel of the instrument. This connects
the instrument to a 10BASE-T/100BASE-TX/1000BASE-T local area network.
The AWG accepts two types of Ethernet LAN connections:
VXI-11 Server: VXI-11 protocol is used through TekVISA. TekVISA is
preinstalled on the instrument, but to use this protocol, TekVISA must also be
installed on the remote controller (PC).
Raw Socket: Raw Socket is used through TekVISA. To use this protocol,
TekVISA must also be installed on the remote controller (PC).
IP address. By default, the AWGs are specified to automatically acquire an IP
address by DHCP. Refer to Windows documentation regarding network-related
parameters.
GPIB control
1-2AWG5200 Series Programmer Manual
The AWG has a USB 2.0 high-speed (HS) Device port to control the instrument
through USBTMC or GPIB with a TEK-USB-488 Adapter. The USBTMC
protocol allows USB devices to communicate using IEEE488 style messages.
This lets you run your GPIB software applications on USB hardware.
To use GPIB (General Purpose Interface Bus), start by connecting an appropriate
SB cable to the USB 2.0 high-speed (HS) device port on the rear panel of the
U
AWG. Connect the other end to the TEK-USB-488 Adapter host port. Then
connect a GPIB cable from the TEK-USB-488 Adapter to your PC.
Before setting up the instrument for remote communication using the electronic
(physical) GPIB interface, you should familiarize yourself with the following
GPIB requirements:
Remote control
A unique device
devices can share the same device address.
No more than 15
One device should be connected for every 6 feet (2 meters) of cable used.
No more than 65 feet (20 meters) of cable should be used to connect devices
to a bus.
At least two-thirds of the devices on the network should be powered on while
using the network.
Connect t he devices on the network in a star or linear configuration. Do not
use loop or parallel configurations.
The default setting for the GPIB configuration is GPIB Address 1. If you need to
change the GPIB address, do the following:
1. Display the Utilities screen and select System.
2. Set the GPIB address.
3. If the TEK-USB-488 adapter is connected to the instrument, disconnect and
reconnect the adapter to ensure the new address is acquired.
address must be assigned to each device on the bus. No two
devices can be connected to any one line.
AWG5200 Series Programmer Manual1-3
Remote control
1-4AWG5200 Series Programmer Manual
Syntax and Commands
Command syntax
Syntax overvi
ew
Control the operations and functions of the AWG through the LAN interface
using commands and queries. The related topics listed below describe the syntax
of these com
AWG uses to process them. See the Command Groups topic for a listing of the
commands by command group or use the index to locate a specific command.
Refer to the following table for the symbols that are used.
Table 2-1: Syntax symbols and their meanings
SymbolMeaning
<>
::=
|Exclusive OR
{ }Group; one element is required
[]
...
( )Comment
mands and queries. The topics also describe the conventions that the
Defined element
Is defined as
Optional; can be omitted
Previous elements can be repeated
mand and query structure
Com
Overview
Messages
Commands consist of set commands and query commands (usually called
commands and queries). Commands modify instrument settings or tell the
strument to perform a specific action. Queries cause the instrument to return
in
data and status information.
ost commands have both a set form and a query form. The query form
M
of the command differs from the set form by its question m ark o n the end.
For example, the set command
AWGControl:RSTate?. Not all commands have both a set and a query form.
Some commands have only set and some have only query.
A command message is a command or query name followed by any information
the instrument needs to execute the command or query. Command messages may
contain five element types, defined in the following table.
AWGControl:RSTate has a query form
AWG5200 Series Programmer Manual2-1
Command syntax
Commands
Table 2-2: Mess
SymbolMeaning
<Header>
<Mnemonic>
<Argument
<Comma>A single c
<Space>
Comman
age symbols and their meanings
This is the basic command name. If the header ends with a
question mark, the command is a query. The header may begin
with a colon (
other commands, the beginning colon is required. Never use the
beginning colon with command headers beginning with a star (*).
This is a header subfunction. Some command headers have only
one mnemoni
colon (:) character always separates them from each other.
>
This is a qu
header. Some commands have no arguments while others have
multiple arguments. A <space> separates arguments from the
header. A <
commands. Optionally, there may be white space characters
before and after the comma.
A white space character is used between a command header and
the related argument. Optionally, a white space may consist of
multipl
:) character. If the command is concatenated with
c. If a command header has multiple mnemonics, a
antity, quality, restriction, or limit associated with the
comma> separates arguments from each other.
omma is used between arguments of multiple-argument
e white space characters.
ds cause the instrument to perform a specific function or change one of
the settings. Commands have the structure:
Queries
Clearing the instrument
eader>[<Space><Argument>[<Comma><Argument>]...]
[:]<H
A command header consists of one or more mnemonics arranged in a hierarchical
ee structure. The first mnemonic is the base or root of the tree and each
or tr
subsequent mnemonic is a level or branch off 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 status or setting information. Queries
have the structure:
Use the Device Clear (DCL) or Selected Device Clear (SDC) functions to clear
the Output Queue and reset the instrument to accept a new command or query.
2-2AWG5200 Series Programmer Manual
Command entry
Command syntax
Rules
Abbreviating
Concatenating
The following rules apply when entering commands:
You can 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 consisting of any combination of white
space characters and line feeds.
You c an abbreviate many instrument commands. Each command in this
documentation shows the abbreviations in capitals. For example, enter the
command
TRIGger:LEVel simply as TRIG:LEV.
Use a semicolon (;) to concatenate any combination of s et commands and queries.
The instrument executes concatenated commands in the order received. When
concatenating commands and queries, follow these rules:
1. Separate completely different headers by a semicolon and by the beginning
colon on all commands except the first one. For example, the commands
TRIGger:IMPedance 50 and SOURce:RMODe TRIGgered, can be
catenated into the following single command:
con
TRIGger:IMPedance 50;:RMODe TRIGgered
2. If concatenated commands have headers that differ by only the last mnemonic,
you can abbreviate the second command and eliminate the beginning
lon. For example, you can concatenate the commands
co
EXTernal
RIGger:SOURce EXTernal; SLOPe NEGative
T
and TRIGger:SLOPe NEGative into a single command:
TRIGger:SOURCE
The longer version works equally well:
TRIGger:SOURCE EXTernal;:TRIGger:SLOPe NEGative
3. Never precede a star (*) command with a semicolon (;) or colon (:).
AWG5200 Series Programmer Manual2-3
Command syntax
Terminating
4. When you concat
enate queries, the responses to all the queries are
concatenated into a single response message. For example, if the
high level of marker one of channel one is 1.0 V and the low level is
0.0 V, the concatenated quer y
SOURce1:MARKer1:VOLTage:LOW? will return the following:
SOURce1:MARKer1:VOLTage:HIGH?;
1.0;0.0
5. Set commands and queries may be concatenated in the same message. For
example,
TRIGger:SOURce EXTernal; SLOPe? is a valid message that
sets the trigger source to External. The message then queries the external
trigger slope. Concatenated commands and queries are executed in the order
received.
This documentation uses <EOM> (end of message) to represent a message
terminator.
Table 2-3: Message terminator and meaning
SymbolMeaning
<EOM>
Message terminator
For messages sent to the instrument, the end-of-message terminator must be the
END message (EOI asserted concurrently with the last data byte). The instrument
always terminates messages with LF and EOI. It allows white space before the
terminator. For example, it allows CR LF.
Parameter types
Parameters are indicated by angle brackets, such as <file_name>. T here are
several different types of parameters, as listed in the following table. The
parameter type is listed after the parameter. Some parameter types are defined
specifically for the instrument command set and some are definedbySCPI.
Table 2-4: Parameter types, their descriptions, and examples
Parameter typeDescriptionExample
Arbitrary block
BooleanBoolean numbers or values
Discrete
NaNNot a Number9.91
A block of data bytes#512234xxxxx... where 5
indicates that the following
5 digits (12234) specify the
length of the data in bytes;
xxxxx... indicates actual data
or #0xxxxx...<LF><&EOI>
ON or ≠ 0
OFF or 0
Alistofspecific values
MINimum, MAXimum
37
2-4AWG5200 Series Programmer Manual
Command syntax
Table 2-4: Parameter types, their descriptions, and examples (cont.)
Parameter typeDescriptionExample
NR1 numericIntegers0, 1, 15, –1
NR2 numericDecimal numbers1.2, 3.141,–6.5
NR3 numericFloating point numbers3.1415E+9
NRf numeric
String
Flexible decimal numbers
that may be type NR1, NR2,
or NR3
Alphanumeric characters
(must be within quotation
marks)
See NR1, NR2, and NR3
examples in this table
"Testing 1, 2, 3"
About MIN, MAX
Block
You can also use MINimum and MAXimum keywords in the commands with
the "Numeric" parameter. Set the minimum value or the maximum value using
these keywords and query these values.
Several instrument commands use a block argument form (see the following table).
Table 2-5: Block symbols and their meanings
SymbolMeaning
<NZDig>
<Dig>
<DChar>A character with the hexadecimal equivalent of 00 through FF (0
<Block>
A nonzero digit character in the range of 1–9
<Dig> A digit character, in the range of 0–9
ough 255 decimal) that represents actual data
thr
lock of data bytes defined as:
Ab
<Block> ::={#<NZDig><Dig>[<Dig>...][<DChar>...]
|#0[<DChar>...]<terminator>}
AWG5200 Series Programmer Manual2-5
Command syntax
Arbitrary block
Quoted string
An arbitrary bl
ock argument is defined as:
#<NZDig><Dig>[<Dig>...][<DChar>...]
or
#0[<DChar>...]<terminator>
<NZDig> specifies the number of <Dig> elements that follow. Taken together,
the <NZDig> and <Dig> elements form a decimal integer that specifies how
many <DChar> elements follow.
#0 means that the <Block> is a n indefinite length block. The <terminator> ends
the block.
NOTE. The AWGs do not support the indefinite format (a block starts with #0).
Some commands accept or return data in the form of a quoted string, which is
simply a group of ASCII characters enclosed by a single quote (') or double quote
r example: "this is a quoted string". This documentation represents these
("). Fo
argumentsasfollows:
Table 2-6: String symbol and meaning
SymbolMeaning
<QString >Quoted string of ASCII text
A quoted string can include any character defined in the 7-bit ASCII character
. Follow these rules when you use quoted strings:
set
1. Use the same type of quote character to open and close the string. For
ample: "this is a valid string".
ex
2. You can mix quotation marks within a string as long as you follow the
revious rule. For example, "this is an 'acceptable' string".
p
3. You can include a quote character within a string simply by repeating the
uote.
q
For example: "here is a "" mark".
4. Strings can have upper or lower case characters.
5. 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.
6. The maximum length of a quoted string returned from a query is 1000
characters.
2-6AWG5200 Series Programmer Manual
Command syntax
Units and SI prefix
Here are some in
valid strings:
"Invalid string argument' (quotes are not of the same type)
"test<EOI>" (termination character is embedded in the string)
If the decimal numeric argument refers to voltage, frequency, impedance, or time,
express it using SI units instead of using the scaled explicit point input value
format <NR3>. (SI prefixes are standardized for use in the International System
of Units by the International Bureau of Weights and Measures.) For example, use
the input format 200 mV or 1.0 MHz instead of 200.0E-3 or 1.0E+6, respectively,
to specify voltage or fre quency.
Omit the unit when you describe commands, but include the SI unit prefix. Enter
both uppercase and lowercase characters. The following list shows examples of
units you c an use with the commands.
V for voltage (V).
HZ for frequency (Hz).
OHM for impedance (ohm).
S for time (s).
DBM for power ratio.
PCT for %.
VPP for Peak-to-Peak Voltage (V p-p).
UIPP for Peak-to-Peak, Unit is UI (UI p-p).
UIRMS for RMS, Unit is UI (UIrms).
SPP for Peak-to-Peak, Unit is second (s p-p).
SRMS for RMS, Unit is second (srms).
V/NS for SLEW’s unit (V/ns).
The SI prefixes, which must be included, are shown in the following table. You
can enter both uppercase and lowercase characters.
Table 2-7: SI prefixes and their indexes
SI prefix
EX10
PE10
T10
G
MA10
K10
1
Corresponding power
18
15
12
9
10
6
3
AWG5200 Series Programmer Manual2-7
Command syntax
Table 2-7: SI prefixes and their indexes (cont.)
SI prefix
M10
U
N10
P10
F10
A10
1
2
1
2
Note that the prefixm/Mindicates10–3when the decimal numeric argument denotes voltage or time, but
indicates 10
Note that the prefix u/U is used instead of "μ".
6
when it denotes frequency.
Corresponding power
–3
–6
10
–9
–12
–15
–18
Since M (m) can be interpreted as 1E-3 or 1E6 depending on the units, use mV
for V, and MHz for Hz.
The SI prefixes need units.
correct: 10MHz, 10E+6Hz
incorrect: 10M
SCPI commands and queries
The AWG uses a command language based on the SCPI standard. The SCPI
(Standard Commands for Programmable Instruments) standard was created by
a consortium to provide guidelines for remote programming of instruments.
These guidelines provide a consistent programming environment for instrument
control and data transfer. This environment uses defined programming messages,
instrument responses and data formats that operate across all SCPI instruments,
regardless of manufacturer.
The SCPI language is based on a hierarchical or tree structure that represents a
subsystem (see following figure). The top level of the tree is the root node; it is
followed by one or more lower-level nodes.
, 10E+6
You can create commands and queries from these s ubsyste m hierarchy trees.
Commands specify actions for the instrument to perform. Queries return
measurement data and information about parameter settings.
2-8AWG5200 Series Programmer Manual
Command syntax
Sequential, b
Sequential commands
locking, and overlapping commands
Programming commands (and queries) fall into three command type categories:
Sequential
Blocking
Overlapping
Thetypeof
could cause unexpected results if not handled correctly. See the following
explanations and examples.
Most of th
means a command will not start until the previous command has finished.
Followi
command is important to consider when programming since they
e programming commands are sequential type commands. This simply
ng is an example of a series of sequential commands.
Blocking commands
In normal operation, these commands could all be sent at once and they would be
queued up and execute d sequentially.
The AWG5200 series instruments have several commands that are blocking. A
blocking command does not allow any further commands to be executed until it is
finished performing its task, such a s a command that changes a hardware setting.
Blocking commands perform similar to sequential commands, but they tend to
take a longer amount of time to complete. Because of the time for a blocking
command to complete, if a number of blocking commands are run in a sequence
ollowed by a query, the query could time out because the previous blocking
f
commandshavenotfinished.
locking commands are noted in their command descriptions.
B
AWG5200 Series Programmer Manual2-9
Command syntax
Overlapping commands
Overlapping co
additional commands to start before the overlapping command has finished. The
illustration below shows how a series of overlapping commands might start and
end.
In some instances, you may want to make an overlapping command perform
similarly to a sequential command. This is simply done by placing a *WAI
command after the overlapping command as illustrated below.
mmands run concurrently with other commands, allowing
You always want to ensure the overlapping command has completed. This is
done by using the *OPC? command. When an overlapping command starts, the
operation complete status event is cleared. When the overlapping command
completes, the operation complete status event is set. The *OPC? command
requirementistoreturna1whentheoperation complete status event is set. In the
illustration below, the OPC? command blocks any further commands from being
executed until the operation complete status event is set.
NOTE. Always ensure overlapping commands have completed by placing an
*OPC? command after the overlapping command.
2-10AWG5200 Series Programmer Manual
Command syntax
The AWG5200 ser
command per *OPC?. If two or more overlapping commands are sent and
followedbyan*OPC?,thenthefirst overlapped command to finish will set the
operation complete status event and *OPC? will return 1. This early return may
produce undesirable results. The following illustration shows this behavior.
NOTE. The *OPC? query only supports one overlapping command, not the two or
more over
Overlapping commands are noted in their command descriptions.
lapping commands as defined in the IEEE Std 488.2 standard.
ies instruments are limited to one outstanding overlapping
AWG5200 Series Programmer Manual2-11
Command syntax
2-12AWG5200 Series Programmer Manual
Command groups
This section contains tables that divide the commands into common groups. A
brief description of the command is provided. Use the link provided to jump
directly to t
and examples.
Commands noted for backwards compatibility should not be used for new
programming applications.
Auxiliary out commands
Use the Auxiliary out commands to setup and control the Auxiliary outputs on
the rear panel.
Table 2-8: Auxiliary output group commands and their descriptions
CommandDescription
AUXoutput[n]:SOURceSets or returns the signal source for the specified Auxiliary Output
AUXoutput[n]:SOURce:CMAPpingSets or returns the Auxiliary O utput channel mapping.
he command description, providing: a detailed description, syntax,
connector.
Basic waveform editor commands
Use the Basic waveform editor commands to setup and create waveforms using
the Basic waveform editor plug-in.
Table 2-9: Basic waveform editor group commands and their descriptions
CommandDescription
BWAVeform:AMPLitudeSets or returns the peak-to-peak Amplitude value for the waveform created
by the Basic Waveform editor plug-in.
BWAVeform:AUTOSets or returns the Basic Waveform editor plug-in Auto Ca
determining which value is automatically calculated.
BWAVeform:COMPileInitiates the Basic Waveform editor plug-in compile process.
BWAVeform:COMPile:CASSignSets or returns the state (enabled or disabled) of the Basic Waveform
editor to compile the waveform and immediately assign it to a specified
channel (enabled) or just compile the waveform (disa
BWAVeform:COMPile:CHANnelSets or returns playout the channel intended for the c
the Basic Waveform editor plug-in. T he selected channel is also used to
set the amplitude and offset range.
BWAVeform:COMPile:NAMESets or returns the name of the Basic Waveform editor plug-in compiled
waveform.
BWAVeform:COMPile:PLAYSets or returns the state (enabled or disabled) of
to either immediately play the waveform after compile or just compile.
the Basic Waveform editor
lculate setting,
bled).
ompiled waveform of
AWG5200 Series Programmer Manual2-13
Command groups
Table 2-9: Basic waveform editor group commands and their descriptions (cont.)
CommandDescription
BWAVeform:CYCLeSets or returns the Cycle value (number of times the waveform repeats) for
the waveform created by the Basic Waveform editor plug-in.
BWAVeform:FDRangeSets or returns the state (enabled or disabled) of the Basic Waveform
editor plug-in to use or not use the full DAC range during compile. Using
the full DAC range when compiling waveforms results in waveforms with
the best resolution.
BWAVeform:FREQuencySets or returns the Frequency for the waveform created by the Basic
Waveform editor plug-in.
BWAVeform:FUNCtionSets or returns the Basic Waveform editor plug-in waveform type.
BWAVeform:HIGHSets or returns the High voltage value for the waveform created by the
Basic Waveform editor plug-in.
BWAVeform:LENGthSets or returns the Length for the waveform created by the Basic Waveform
editor plug-in.
BWAVeform:LOWSets or returns the Low voltage value for the waveform created by the
Basic Waveform editor plug-in.
BWAVeform:OFFSetSets or returns the Offset voltage value for the waveform created by the
Basic Waveform editor plug-in.
BWAVeform:RESetResets the Basic Waveform editor plug-in to its default values.
BWAVeform:SRATeSets or returns the Sample Rate for the waveform created by the Basic
Waveform editor plug-in.
Calibration group commands
Use the calibration commands to calibrate the arbitrary waveform generator and
obtain calibration data.
Table 2-10: Calibration group commands and their descriptions
CommandDescription
CALibration:ABORtStops the self calibration process and restores the previous calibration
constants.
CALibration[:ALL]Performs a full calibration of the AWG. The query form performs a full
calibration and returns a status of the operation.
CALibration:CATalog?Returns the list of subsystems, areas, or procedures.
CALibration:LOG?Returns a string of continuous concatenated calibration results.
CALibration:LOG:CLEarClears the results log.
CALibration:LOG:FAILuresonlySets and returns the flag that controls the amount of result information
saved into the log.
CALibration:RESToreRestores the calibration constants from the factory non-volatile memory
and copied to user storage.
2-14AWG5200 Series Programmer Manual
Loading...
+ 391 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.