Page is loading ...
xx
DSA8300
DigitalSerialAnalyzer
ZZZ
Programmer Manual
*P077057002*
077-0570-02
DSA8300
Digital Serial Analyzer
ZZZ
Programmer Manual
xx
Revision B
www.tektronix.com
077-0570-02
Copyright © Tektronix. All rights reserved. Licensed software products are owned by Tektronix or its subsidiaries
or suppliers, and are protected by national copyright laws and international treaty provisions.
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.
IConnect and BERTScope are registered trademarks of Tektronix, Inc.
TekVISA is a trademark of Tektronix, Inc.
Contacting Tektronix
Tektronix, Inc.
14150 SW Karl Braun Drive
P.O. Box 5 0 0
Beaverton, OR 97077
USA
For product information, sales, service, and technical support:
In North America, call 1-800-833-9200.
Worldwide, visit www.tektronix.com to find contacts in your area.
Table of Contents
Preface .............................................................................................................. iii
Getting Started
Getting Started .................................................................................................... 1-1
Setting Up Remote Communications................................. .. .. ................................. 1-3
Syntax and Commands
Command Syntax................................................................................................. 2-1
Command and Query Structure ............................................................................ 2-1
Clearing the Instrument ..................................................................................... 2-3
Command Entry.............................................................................................. 2-4
Constructed Mnemonics .................................................................................... 2-6
Argument Types.............................................................................................. 2-8
Command Groups .............................................................................................. 2-11
Acquisition Command Group ............................................................................ 2-11
Calibration Command Group............................................................................. 2-12
Compensation Command Group......................................................................... 2-13
Cursor Command Group.................................................................................. 2-15
Display Control Command Group ....................................................................... 2-16
Hard Copy Command Group............................................................................. 2-17
Histogram Command Group ............................................................................. 2-18
Horizontal Command Group ............................................................................. 2-19
Mask Command Group ................................................................................... 2-23
Math Command Group.................................................................................... 2-25
Measurement Command Group.......................................................................... 2-25
Miscellaneous Command Group......................................................................... 2-29
Phase Reference Command Group ...................................................................... 2-30
Save and Recall Command Group ....................................................................... 2-30
Status and Error Command Group....................................................................... 2-31
System Command Group ................................................................................. 2-32
TDR Command Group .................................................................................... 2-34
Trigger Command Group ................................................................................. 2-35
Vertical Command Group................................................................................. 2-40
Waveform Dat
abase Command Group .................................................................. 2-42
Waveform Transfer Command Group ................................................................... 2-44
DSA8300 Programmer Manual i
Table of Contents
Commands Liste
d in Alphabetical Order .................................................................... 2-49
Status and Eve
nts
Status and Events ................................................................................................. 3-1
Registers ...................................................................................................... 3-1
Queues ........................................................................................................ 3-4
Event Handling Sequence................................................................................... 3-5
Synchronization Methods................................................................................... 3-6
Messages.................................................................................................... 3-11
Examples
Programming Examples ......................................................................................... 4-1
Appendices
Appendix A: Character Set..................................................................................... A-1
Append
ix B: Reserved Words.................................................................................. B-1
Appendix C: Factory Default Setup Values................................................................... C-1
Appendix D: GPIB Interface Specifications.................................................................. D-1
ii DSA8300 Programmer Manual
Preface
This programmer manual provides you with the information required to use GPIB
commands for remotely controlling your instrument. This document supports the
following in
struments:
DSA8300 Series, Te kScope application SW version 6.2.X and greater.
DSA8300 Programmer Manual iii
Preface
iv DSA8300 Programmer Manual
Getting Started
Getting Started
This programmer manual provides you with the information required to use
GPIB commands to remotely control your instrument. With this information,
you can write
computer programs that will perform functions such as setting the
front-panel controls, taking measurements, performing statistical calculations, and
exporting data for use in other programs, such as spreadsheets.
Besides the traditional GPIB electronic interface (referred to as the physical GPIB
interface), your instrument has a TekVISA™ GPIB-compatible interface (referred
to as the virtual GPIB interface). This is a software Application Programming
Interface (API) which enables you to communicate with the instrument in a
variety of ways, including via the internet. With the following two exceptions,
these in
terfaces are completely independent:
HEADER. Command headers enabled or disabled on one interface are
corresp
ondingly enabled or disabled on the other interface. Refer to the
command descriptions for m ore d etailed information.
VERBOS
E. Verbosity enabled or disabled on one interface is correspondingly
enabled or disabled on the other interface. Refer to the command description
for more detailed information.
Most examples in this document assume that both
HEADER and VERBOSE are ON.
DSA8300 Programmer Manual 1-1
Getting Started
The programmer
manual is divided into the following major sections:
Getting Started. This section introduces you to the programming information
and p rovides b
asic information about setting up your instrument for remote
control.
Syntax and C
ommands. This section provides an overview of the command
syntax that you use to communicate with the instrument and other general
information about commands, such as how commands and queries are
constructed, how to enter commands, constructed mnemonics, and argument
types.
Command Groups. This section contains all the commands listed by their
functional groups. Each group consists of an overview of the commands in
that group and a table that lists all the commands and queries for that group.
You can c
lick a command in the listing to display a detailed description of
the command.
Comman
ds Listed in Alphabetical Order. This section contains all the
commands in alphabetical order and is where you can find the complete
description o f each c ommand.
Status and Events. This section discusses the status and event reporting
system for the GPIB interfaces. This system informs you of certain significant
events that occur within the instrument. Topics that are discussed include
registers, queues, event handling sequences, synchronization methods, and
messages that the instrument may return, including error messages.
Appendices. This section contains miscellaneous information, such as a
list of reserved w ords, a table of the factory initialization (default) settings,
an
d interface specifications that may be helpful when using commands to
remotely control the instrument.
1-2 DSA8300 Programmer Manual
Getting Started
SettingUpRem
ote Communications
Before setting up the instrument for remote communications using the electronic
(physical) GPIB interface, you should familiarize yourself with the following
GPIB require
ments:
A unique device address must be assigned to each device on the bus. No two
devices can
share the same device address.
No more than 15 devices can be connected to any one line.
One device should be c onnected 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 the device s on the network in a star or linear configuration. Do not
use loop or parallel configurations.
Connecting to the
Instrument
Your instrument has a 24-pin GPIB connector on its rear (side) panel. This
connector has a D-type shell and conforms to IEEE Std 488.1–1987. Attach an
IEEE Std 488.1–1987 GPIB cable to this connector and to y our controller as
shown in the following figure.
If necessary, the GPIB connectors can be stacked as shown in the figure below.
DSA8300 Programmer Manual 1-3
Getting Started
Setting the GPIB Address
By default, the DSA8300 is set to address 1 a nd Talk/Listen (Slave) mode, to
enable remote access and control. Software applications that communicate with
the inst
rument over the GPIB bus should use the specified instrument GPIB
address.
To chan
ge GPIB settings, do the following:
1. Select Utilities > User Preferences.
2. Click the GPIB Configuration Tab.
3. Change the GPIB Address to a unique address.
4. Set the GPIB communication mode:
Off Bus Mode: Removes the instrument from the GPIB bus (the
instrument does not communicate with or monitor the GPIB bus).
Talk/Listen Mode: Enables remote control access from the GPIB port.
This is the default GPIB mode.
Controller Mode: Sets the instrument to be a GPIB controller (Master),
which a llows you to use the DSA8300 to control other devices over the
GPIB port.
NOTE. Switching between Talk/Listen and Controller modes requires the
instrument to reboot. The application will prompt you to reboot the instrument.
5. Click OK.
1-4 DSA8300 Programmer Manual
Syntax and Commands
Command Syntax
You can control the operations and functions of the instrument through the
GPIB interface using commands and queries. The related topics listed below
describe the
syntax of these commands and queries. The topics also describe the
conventions that the instrument uses to process them. See the Command Groups
topic in the table of contents for a listing of the commands by command group, or
use the index to locate a specificcommand.
Backus-Naur Form
Notation
This documentation describes the commands and queries using Backus-Naur
Form (BNF) notation. Refer to the following table for the symbols that are used.
Table 2-1: Symbols for Backus-Naur Form
Symbol Meaning
<>
Defined element
::=
Is defined as
| Exclusive OR
{ } Group; one element is required
[]
Optional; can be omitted
.. .
Previous element(s) may be repeated
( ) Comment
Command and Query Structure
Co
mmands consist of set commands and query commands (usually called
commands and queries). Commands modify instrument settings or tell the
instrument to perform a specific action. Queries cause the instrument to return
data and status information.
Most commands have both a set form and a query form. The query form of the
command differs from the set form by its question mark on the end. For example,
the set command
ACQuire:MODe has a query form ACQuire:MODe?.Notall
commands have both a set and a query form. Some commands have set only and
some have query only.
Messages
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.
DSA8300 Programmer Manual 2-1
Command Syntax
Table 2-2: Comm
and Message Elements
Symbol Meaning
<Header>
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 c olon
(:) characte
r. If the command is concatenated with other commands,
the beginning colon is required. Never use the beginning colon with
command headers beginning with a star (*).
<Mnemonic>
This is a header subfunction. Some command headers have only one
mnemonic. I
f a command header has multiple mnemonics, a colon (:)
character always separates them from each other.
<Argument
>
This is a qu
antity, quality, restriction, or limit associated with the header.
Some commands have no arguments w hile others have multiple
arguments. A <space> separates arguments from the header. A
<comma> se
parates arguments from each other.
<Comma> A single c
omma is used between arguments of multiple-argument
commands. Optionally, there may be white space characters before
and after the comma.
<Space>
A white space character is used between a command header and the
related argument. Optionally, a wh ite space may consist of multiple
white sp
ace characters.
Commands
Comman
ds cause the instrument to perform a specific function or change one of
the settings. Commands have the structure:
[:]<H
eader>[<Space><Argument>[<C omma> <Argument>]...]
A command header consists of one or more mnemonics arranged in a hierarchical
or tr
ee structure. The first mnemonic is the base or root of the tree and each
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.
2-2 DSA8300 Programmer Manual
Command Syntax
Queries
Queries cause t
he instrument to return status or setting information. Queries
have the structure:
[:]<Header>?
[:]<Header>?[<Space><Argumen t> [<Coma><Argument>]...]
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 sp
ecified branch or level. For example, HIStogram:STATistics:STDdev?
returns the standard deviation of the histogram, while HIStogram:STATistics?
returns all the histogram statistics, and HIStogram? returns all the histogram
parameters.
Headers
You can control whether the instrument returns headers as part of the query
response. U se the HEADer c ommand to control this feature. If header is on,
the query response returns command headers, then formats itself as a valid set
command. When header is off, the response includes only the values. This may
make it easier to parse and extract the information from the response. The table
below
shows the difference in responses.
Table 2-3: Comparison of Header Off and Header On Responses
Query Header Off Header On
TIME?
"14:30:00" :TIME"14:30:00"
ACQuire:NUMAVg?
100
:ACQUIRE:NUMAVG 100
Clearing the Instrument
You can clea r the Output Queue and re set the instrument to accept a new
command or query by using the selected Device Clear (DCL) GPIB function.
Refer to your GPIB library documentation for further details about the selected
Device Clear operation.
DSA8300 Programmer Manual 2-3
Command Syntax
Command Entry
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.
Abbreviating
You can abbreviate many instrument commands. Each command in this
documentation shows the abbreviations in capitals. For example, you c an enter
the command ACQuire:NUMAvg simply as ACQ:NUMA or acq:numa.
Abbreviation rules may change over time as new instrument models are
introduced. Thus, for the most robust code, use the full spelling.
If you use the HEADer command to have command headers included as part
of query responses, you can further control whether the returned headers are
abbreviated o r are full-length with the VERBose command.
Conc
atenating
You can concatenate any combination of set commands and queries using a
semicolon (;). The instrument executes c onca tenated commands in the order
received.
2-4 DSA8300 Programmer Manual
/
