Tektronix CSA8000B, CSA8000, TDS8000, TDS8000B, TDS8200 Programmer Manual

8000 Series Digital Sampling Oscilloscopes Programmer Manual

www.tektronix.com

077-0008-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. Speciﬁcations and price change privileges reserved.

TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.

Contacting Te

Tektronix, Inc. 14200 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. Worl dwid e, v

ktronix

isit www.tektronix.com to ﬁnd contacts in your area.

Table of Contents

Preface .............................................................................................................. iii

Getting Started .. ..... . ..... . ..... . ... . . ..... . ..... . ..... . ..... . ..... . ... . . . .... . ..... . ..... . ..... . ..... . ..... . .... 1-1

Setting Up Remote Communications.... . ..... . .... . . .... . ..... . ..... . ... . . ..... . ..... . ... . . . .... . ..... . .. 1-3

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-9

Command Entry............................................................................................ 2-11

Command Groups .............................................................................................. 2-15

Acquisition Command Group .... . ..... . ..... . ..... . ... . . . .... . ..... . ..... . ..... . ..... . ..... . ..... . ... . . . 2-15

Calibration Command Group............................................................................. 2-16

Compensation Command Group ......................................................................... 2-17

Cursor Command Group ......................... .................................. ....................... 2-19

Display Control Command Group .... ................................ .................................. . 2-20

Hard Copy Command Group...................... ................................ ....................... 2-21

Histogram Command Group ............................................................................. 2-22

Horizontal Command Group ...... ................................ ................................ ....... 2-23

Mask Command Group ........................ ................................ ........................... 2-27

Math Command Group................... .................................. ............................... 2-28

Measurement Command Group........... ................................ ............................... 2-29

Miscellaneous Command Group ......................................................................... 2-33

Phase Reference Command Group ...................................................................... 2-33

Save and Recall Command Group ....................................................................... 2-34

Status and Error Command Group........................................ ............................... 2-35

System Command Group ................................................................................. 2-36

TDR Command Group .................................................................................... 2-38

Trigger Command Group ........................ ................................ ......................... 2-39

Vertical Command Group.......................... ................................ ....................... 2-41

Waveform Database Command Group .................................................................. 2-43

Waveform Transfer Command Group................................................................... 2-45

Commands Listed in Alphabetical Order ......... ................................ ........................... 2-51

Status and Events ................................................................................................. 3-1

Registers ............. ................................ .................................. ....................... 3-1

Queues ........................................................................................................ 3-4

Event Handling Sequence................................................................................... 3-5

Synchronization Methods.................. ................................ ................................ . 3-6

Messages.................................................................................................... 3-11

CSA/TDS8000 Series Programmer Manual i

Table of Contents

Programming Ex

Appendix A: Character Set ..................................................................................... A-1

Appendix B: Reserved Words.................................................................................. B-1

Appendix C: Factory Default Setup Values................. ................................ .................. C-1

Appendix D: GPIB Interface Speciﬁcations........ ................................ .......................... D-1

Index

amples .......................... ................................ ............................... 4-1

ii CSA/TDS8000 Series Programmer Manual

Preface

This programmer manual provides you with the information required to use GPIB commands for remotely controlling your instrument. In addition to this Programmer G

uide, the following documentation is included with this instrument.

Documentation

CSA8200 Communications Signal Analyzer and TDS8200 Digital Sampling Oscilloscope Quick Start User Manual. The user manual has information about

installing and operating the instrument.

8000 Series Online Help. This online help system is the main source for user documentation of your instrument. Choose Help Contents and Index from the Help menu o

CSA/TDS8000 Series Instruments Product Documentation CD-ROM.

This CD-R CSA/TDS8000 series instruments including:

Document series instruments

Documen

Documentationtoverifyperformance

Oscilloscope Analysis and Connectivity Made Easy. This book explores some options for getting data from your instrument into any one of several available analys

ftheinstrument.

OM contains pdf ﬁles for various documentation relating to the

ation for the modules available for use with the CSA/TDS8000

tation to service the instrument and modules

is tools.

CSA/TDS8000 Series Programmer Manual iii

Preface

iv CSA/TDS8000 Series Programmer Manual

Getting Started

This programmer guide provides you with the information required to use GPIB commands for remotely controlling your instrument. With this information, you can write com 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 is provided with a TekVIS A 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 exceptio

HEADER. Command headers enabled or disabled on one interface are correspo command descriptions for more detailed information.

puter programs that will perform functions such as setting the

ns, these interfaces are completely independent:

ndingly enabled or disabled on the other interface. Refer to the

VERBOSE enabled or disabled on the other interface. Refer to the command description for more detailed information.

Most examples in this document assume that both

. Verbosity enabled or disabled on one interface is correspondingly

HEADER and VERBOSE are ON.

CSA/TDS8000 Series Programmer Manual 1-1

Getting Started

The programmer

Getting Started. This topic introduces you to the programming information and provides b control.

Syntax and Co 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 topic 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 c a n c l the command.

Commands commands in alphabetical order and is where you can ﬁnd the complete description of each command.

Status and Events. This topic discusses the status and event reporting system for the GPIB interfaces. This system informs you of certain signiﬁcant 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.

guide is divided into the following major topics:

asic information about setting up your instrument for remote

mmands. This topic provides an overview of the command

ick a command in the listing to display a detailed description of

Listed in Alphabetical Order. This topic contains all the

Appendices. This topic contains miscellaneous information, such as a list of reserved words, a table of the factory initialization (default) settings, and

face speciﬁcations that may be helpful when using commands to remotely

inter control the instrument.

1-2 CSA/TDS8000 Series Programmer Manual

Getting Started

SettingUpRem

Connecting to the

Instrument

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

A unique device address must be assigned to each device on the bus. No two devices can s

No more than 15 devices can be connected to any one line.

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 d evices on the network should be powered on while using the network.

Connect the devices on the network in a star or linear conﬁguration. Do not use loop or parallel conﬁgurations.

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 your controller as shown in the following ﬁgure.

ments:

hare the same device address.

If necessary, the GPIB connectors can be stacked as shown in the ﬁgure below.

CSA/TDS8000 Series Programmer Manual 1-3

Getting Started

Setting the GPIB Address

To function correctly, your instrument must have a unique device address. The default settings for the GPIB conﬁguration are:

GPIB Address: 1

GPIB Mode: GPIB Talk/Listen

1-4 CSA/TDS8000 Series Programmer Manual

Getting Started

To change eithe

1. Select User Preferences from the Utilities menu.

2. Select the GPIB Conﬁguration Tab.

r of the GPIB settings, do the following:

3. Change the GPIB Address to a unique address.

4. Click OK.

The instrument is now set up for bidirectional communication with your controller.

Master/Slave Mode

CSA/TDS8000 Series Programmer Manual 1-5

The 8000 series instruments are factory set to be a GPIB device (slave), allowing you to control the instrument via the GPIB port. You can change the instrument to be a GPIB controller (master), allowing you to control other devices via the GPIB port.

GPIB/VISA Controller/Device (Master/Slave) S witch. The 8000 series instruments can be conﬁgured as a GPIB Device (Slave) or Controller (Master). The factory setting is conﬁgured to enable control of the instrument via the GPIB port, referred to as the “Device Mode”.

Getting Started

You can change t port by switching the instrument to be a GPIB Controller referred to as the “Controller Mode”.

To switch the instrument between these two modes, use the GPIB Device-Controller Utility found in the Windows Start menu under Programs > Tektronix TDSCSA8000 > GPIB Device-Controller Utility. Starting this utility displays the TekGpibSwitcher screen which allows you to switch the instrument between the two modes.

NOTE. Switc

he instrument to be used to control other devices via the GPIB

hing the mode causes the instrument to automatically reboot.

1-6 CSA/TDS8000 Series Programmer Manual

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 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 speciﬁccommand.

syntax of these commands and queries. The topics also describe the

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

::=

| Exclusive OR

{ } Group; one element is required

[]

.. .

( ) Comment

Command and Query Structure

Comman commands and queries). Commands modify instrument settings or tell the instrument to perform a speciﬁc action. Queries cause the instrument to return data and status information.

ds consist of set commands and query commands (usually called

Deﬁned element

Is deﬁned as

Optional; can be omitted

Previous element(s) may be repeated

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 m ark on the end. For example, the set command commands have both a set and a query form. Some commands have set only and

ehavequeryonly.

som

Messages

CSA/TDS8000 Series Programmer Manual 2-1

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

ntain ﬁve element types, deﬁned in the following table.

ACQuire:MODe has a query form ACQuire:MODe?.Notall

Command Syntax

Commands

Table 2-2: Comm

Symbol Meaning

<Argument> This is a quan

<Comma> A single com

<Space>

Commands

and Message Elements

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 (:) c haracter 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 mnemonic. If character always separates them from each other.

Some commands have no arguments while others have multiple arguments. A <space> separates arguments from the header. A <comma> sep

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 multiple white spac

. If the command is concatenated with other commands,

a command header has multiple mnemonics, a colon (:)

tity, quality, restriction, or limit associated with the header.

arates arguments from each other.

ma is used between arguments of multiple-argument

e characters.

cause the instrument to perform a speciﬁc function or change one of

the settings. Commands have the structure:

[:]<Hea

der>[<Space><Argument>[<Comma> <Argument>]...]

A command header consists of one or more mnemonics arranged in a hierarchical or tree s

tructure. The ﬁrst 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 CSA/TDS8000 Series Programmer Manual

Command Syntax

Queries

Headers

Queries cause t

he instrument to return status or setting information. Queries

have the structure:

[:]<Header>?

[:]<Header>?[<Space><Argument> [<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 spe

ciﬁed 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.

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 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 sh

ows the difference in responses.

Table 2-3: Comparison of Header Off and Header On Responses

Query Header Off Header On

TIME?

ACQuire:NUMAVg?

"14:30:00" :TIME"14:30:00"

100

:ACQUIRE:NUMAVG 100

Clearing the Instrument

You can clear the Output Queue and reset 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 d etails about the selected Device Clear operation.

CSA/TDS8000 Series 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

Concat

enating

You can abbreviate many instrument commands. Each command in this documentation shows the abbreviations in capitals. For example, you can 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 or are full-length with the VERBose command.

You can concatenate any combination of set commands and queries using a semicolon (;). The instrument executes c oncatenated commands in the order received.

2-4 CSA/TDS8000 Series Programmer Manual

Command Syntax

When concatena

ting commands and queries, you must follow these rules:

1. Separate completely different headers by a semicolon and by the beginning

colon on all commands except the ﬁrst one. For example, the commands

TRIGger:MODe NORMal and ACQuire:NUMAVg 10, can be concatenated

into the following single command:

TRIGger:MODe NORMal;:ACQuire:NUMAVg 10

2. 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, you can concatenate the commands

ACQuire:MODe ENVelope

and ACQuire:NUMAVg 10 into a single command:

ACQuire:MODe ENVelope; NU MAVg 10

The longer version works equally well:

ACQuire:MODe ENVelope;:ACQuire:NUMAVg 10

3. Never precede a star (*) command with a colon:

ACQuire:MODe ENVelope;*OPC

Any commands that follow will be processed as if the star command was not there so the commands,

ACQuire:MODe ENVelope;*OPC;NUMAVg 10 will

set the acquisition mode to envelope and set the number of acquisitions for averaging to 10.

4. When you concatenate queries, the responses to all the queries are

concatenated into a single response message. For example, if the display imageview color is temperature and the display recordview color is spectral, the concatenated query

RECORDVIEW?

will return the following.

DISplay:COLOr:PALETTE:IMAGEVIEW?;

If the header is on:

:DISPLAY:COLOR:PALETTE:IMAGEVIEW TEMPERATURE; :DISPLAY:COLOR:PALETTE:RECORDVIEW SPECTRAL

If the header is off:

TEMPERATURE;SPECTRAL

5. Set commands and queries may be concatenated in the same message. For

example,

ACQuire:MODe SAMple;NUMAVg?;STATE?

is a valid message that sets the acquisition mode to sample. The message then queries the number of acquisitions for averaging and the acquisition state. Concatenated commands and queries are executed in the order received.

Here are some invalid concatenations:

DISPlay:STYle:NORMal;ACQuire:NUMAVg 10 (no colon before ACQuire)

CSA/TDS8000 Series Programmer Manual 2-5

Command Syntax

Terminating

DISPlay:COLor DISPlay:COLor:CURSor1 1:CURSor2 5 instead)

DISPlay:STYl

DISPlay:COLor:CURSor1 1;COLor:CURSor2 5 (levels of the mnemonics

are differen front of

COLor:CURSor2 5)

:CURSor1 1;:CURSor2 5

e:NORMal;:*OPC

(colon before a star (*) command)

t; either remove the second use of

(extra colon before CURSor2; use

COLor or place :DISPlay: in

This documentation uses <EOM> (End of message) to represent a message terminator

Table 2-4: End of Message Terminator

Symbol Meaning

<EOM>

Message terminator

The end-of-message terminator must be the END message (EOI asserted concurrently with the last data byte). The last data byte may be an ASCII linefeed (LF) cha

racter.

This instrument does not support ASCII LF only message termination. The instrum

ent always terminates outgoing messages with LF and EOI.

Constructed Mnemonics

Some he a channel mnemonic can be CH1, CH2, CH3, ... through CH8. You use these mnemonics in the command just as you do any other mnemonic. For example, there is a CH1:POSition command, and there is also a CH2:POSition command. In the command descriptions, this list of choices is abbreviated a s CH<x>.

Cursor Position

Mnemonics

When cursors are displayed, commands may specify which cursor of the pair to use.

Table 2-5: Cursor Mnemonics

Sym

CUR

ader mnemonics specify one of a range of mnemonics. For example,

bol

SOR<x>

ning

Mea

A cursor selector; <x> is either 1 or 2.

2-6 CSA/TDS8000 Series Programmer Manual

Table 2-5: Cursor Mnemonics, (cont.)

Symbol Meaning

POSITION<x>

HPOS<x>

A cursor selector; <x> is either 1 or 2.

Command Syntax

Histogram Statistics

Speciﬁer M

nemonics

Magniﬁed Timebase

Speciﬁer Mnemonics

Mask Speciﬁer Mnemonics

Commands can specify which Sigma value to return for histogram statistics as a mnemonic i

n the header. A Sigma is speciﬁed in this way:

Table 2-6: Histogram Statistics Speciﬁer Mnemonics

Symbol Meaning

SIGMA<x> A histogram statistics speciﬁer; <x> is either 1, 2, or 3.

Commands can specify which of two magniﬁed timebases to set or query as a mnemonic in the header. The magniﬁed timebases are speciﬁed in this way:

Table 2-7: Magniﬁed Timebase Speciﬁer Mnemonics

Symbol Meaning

MAG<x> A magniﬁed speciﬁer; <x> is 1or 2.

Commands can specify w hich mask to set or query as a mnemonic in the header.

asks are speciﬁed in this way:

The m

Table2-8:MaskSpeciﬁer Mnemonics

Symbol Meaning

MASK<x> A mask speciﬁer; <x> is 1 through 8.

asurement Speciﬁer

Mnemonics

Commands can specify which measurement to set or query as a mnemonic in the header. Up to eight automated measurements may be displayed with each displayed waveform. The displayed measurements are speciﬁed in this way:

able 2-9: Measurement Speciﬁer Mnemonics

Symbol Meaning

MEAS<x> A measurement speciﬁer; <x> is 1 through 8.

CSA/TDS8000 Series Programmer Manual 2-7

Command Syntax

Table 2-9: Measurement Speciﬁer Mnemonics, (cont.)

Symbol Meaning

SOURCE<x> A waveform speciﬁer; <x> is either 1 (Source 1 waveform) or 2 (Source

2 waveform).

REFLevel<x>

A waveform speciﬁer for reference level measurements; <x> is either 1 (Source 1 waveform) or 2 (Source 2 waveform).

Channel Mn

emonics

Math Waveform

Mnemonics

Reference Waveform

Mnemonics

Commands specify the channel to use as a mnemonic in the header.

Table 2-10: Channel Mnemonics

Symbol Meaning

CH<x> A channel

Command

s can specify the mathematical waveform to use as a mnemonic in

speciﬁer; <x> is 1 through 8.

the header.

Table 2-11: Math Waveform Mnemonics

Symbol Meaning

Math<x>

A math waveform speciﬁer; <x> is 1 through 8.

Commands can specify the reference waveform to use as a mnemonic in the header.

e 2-12: Reference Waveform Mnemonics

Tabl

Symbol Meaning

REF<

A reference waveform speciﬁer; <x> is 1 through 8.

Waveform Database

Mnemonics

Commands can specify the reference waveform to use as a mnemonic in the header.

Table 2-13: Waveform Database Mnemonics

Rules

ymbol

WFMDB<x>

The following rules apply when entering commands:

eaning

waveform database speciﬁer; <x> is either 1 or2.

2-8 CSA/TDS8000 Series Programmer Manual

Command Syntax

Abbreviating

Argument Types

Numeric

You c a n e n t er c o

mmands in upper or lower case.

You can precede any command with white space characters. White space characters in

clude any combination of the ASCII control characters 00 through

09 and 0B through 20 hexadecimal (0 through 9 and 11 through 32 decimal).

The instrume

nt ignores commands consisting of any combination of white

space characters and line feeds.

You can abbreviate many instrument commands. Each command in this documentat

ion shows the abbreviations in capitals. For example, you can enter

the command ACQuire:NUMAvg simply as ACQ:NUMA or acq:numa.

Abbreviat

ion 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 or are full-length with the VERBose command.

Many instrument commands require numeric arguments. The syntax shows the format that the instrument returns in response to a query. This is also the preferred format when sending the command to the instrument though any of the formats will be accepted. This documentation represents these arguments as follows:

Quoted String

2-14: Numeric Arguments

Table

Symbol Meaning

<NR1>

<NR2> Float

<NR3> Floating point value with an exponent

Signed integer value

ing point value without an exponent

Most numeric arguments will be automatically forced to a valid setting, either by

ding or truncating, when an invalid number is input unless otherwise noted

roun in the command description.

Some commands accept or return data in the form of a quoted string, which is

mply a group of ASCII characters enclosed by a single quote (’) or double quote

si ("). The following is an example of a quoted string:

string"

. This documentation represents these arguments as follows:

"This is a quoted

CSA/TDS8000 Series Programmer Manual 2-9

Command Syntax

Table 2-15: Quo

Symbol Meaning

<QString> Quoted string of ASCII text

ted String Argument

A quoted string can include any character deﬁned in the 7-bit ASCII character set. Follow these rules when you use quoted strings:

1. Use the same type of quote character to open and close the string. For example:

"this is a valid string".

2. You can mix quotation marks within a string as long as you follow the previous rule. For example,

"this is an ’acceptable’ string".

3. You can include a quote character within a string by repeating the quote. For example:

"here is a "" mark".

4. Strings can have upper or lower case characters.

5. If you use a GPIB network, you cannot terminate a quoted string with the

END message before the closing delimiter.

6. 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.

7. The maximum length of a quoted string returned from a query is 1000 characters.

Block

Here are some invalid strings:

"Invalid string argument’ (quotes are not of the same type)

OI>"

"test<E

(termination character is embedded in the string)

Several instrument commands use a block argument form (see the following table).

Table 2-16: Block Argument

Symbol Meaning

<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

A digit character, in the range of 0–9

through 255 decimal)

A block of data bytes deﬁned as: <B lock> ::= {#<NZDig><Dig>[<Dig>...][<DChar>...] |#0[<DChar>...]<terminator>}

<NZDig> speciﬁes the number of <Dig> elements that follow. Taken together, the <NZDig> and <Dig> elements form a decimal integer that speciﬁes how many <DChar> elements follow.

2-10 CSA/TDS8000 Series Programmer Manual

Command Entry

Command Syntax

Concatenat

ing

You can concatenate any combination of set commands and queries using a semicolon (;). The instrument executes concatenated commands in the order received.

CSA/TDS8000 Series Programmer Manual 2 -11

Command Syntax

When concatena

ting commands and queries, you must follow these rules:

Separate completely different headers by a semicolon and by the beginning colon on all commands except the ﬁrst one. For example, the commands,

TRIGger:MODe NORMal and ACQuire:NUMAVg 10, can be concatenated

into the following single command:

TRIGger:MODe NORMal;:ACQuire:NUMAVg 10

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, you can concatenate the commands ACQuire:MODe ENVelope andACQuire:NUMAVg10intoasinglecommand:

ACQuire:MODe ENVElope; NUMAVg 10

The longer version works equally well:

ACQuire:MODe ENVElope;:ACQuire:NUMAVg 10

Never precede a star (*) command with a colon:

ACQuire:MODe ENVElope;*OPC

Any commands that follow will be processed as if the star command was not there. For example, the ACQuire:MODe ENVElope;*OPC;NUMAVg 10 commands will set the acquisition mode to envelope and set the number of acquisitions for averaging to 10.

When you concatenate queries, the responses to all the queries are concatenated into a single response message. For example, if the display background color is white and the display foreground color is black, the concatenated query DISplay:COLor:BACKGround?;FOREGround? will return the following:

Iftheheaderison:

:DISPLAY:COLOR:BACKGROUND 7;

:DISPLAY:COLOR:FOREGROUND 0

If the header is off:

7;0

Set commands and queries may be concatenated in the same message. For example,

ACQuire:MODe SAMple;NUMAVg?;STATE?

Here are some invalid concatenations:

2-12 CSA/TDS8000 Series Programmer Manual

Command Syntax

Terminating

DISPlay:STYle

:NORMal;ACQuire:NUMAVg 10 (no colon before ACQuire)

DISPlay:COLor:CURSor1 1;:CURSor2 5 (extra colon before CURSor2; use DISPlay:COLo

r:CURSor11;CURSor25instead)

DISPlay:STYle:NORMal;:*OPC (colon before a star (*) command)

ISPlay:COLor:CURSor1 1;COLor:CURSor2 5 (levels of the mnemonics are different; either remove the second use of COLor or place :DISPlay: in front of COLo

r:CURSor2 5)

This documentation uses <EOM> (End of message) to represent a message terminator.

Table 2-17

Symbol Meaning

<EOM>

: End of Message Terminator

Message te

rminator

The end-of-message terminator must be the END message (EOI asserted concurrently with the last data byte). The last data byte may be an ASCII linefeed (LF) character. This instrument does not support ASCII LF only message termina

tion. The instrument always terminates outgoing messages with LF and

EOI. It allows white space before the terminator. For example, it allows CR LF.

CSA/TDS8000 Series Programmer Manual 2-13

Command Syntax

2-14 CSA/TDS8000 Series Programmer Manual

Command Groups

The CSA/TDS8000 Series programmable interfaces conform to Tektronix standard codes and formats except where noted. The GPIB interface also conforms to I

Acquisition Command Group

Use the commands in the Acquisition Command Group to set up the modes and functions that control how the instrument acquires the signals you input to the channels and processes them into waveforms.

Using these commands for acquiring waveforms, you can do the following:

Start and stop acquisitions.

Control whether each waveform is simply acquired, averaged, or enveloped over successive acquisitions of that waveform.

Set the controls or conditions that start and stop acquisitions.

Determine the action the system takes upon completing an acquisition, such as saving all waveforms and taking a measu stopped.

EEE Std 488.2-1987 except where noted.

rement when the acquisition is

Get data on acquired waveforms, histograms, and masks.

Get acquisition parameters.

Clear all acquired data.

Table 2-18: Acquisition Commands

Command Description

ACQuire?

ACQuire:CURRentcount:ACQWfms? Returns acquired waveforms count

ACQuire:CURRentcount:HISTHits?

ACQuire:CURRentcount:HISTWfms? Returns histogram waveforms count

ACQuire:CURRentcount:MASKHits<x>?

ACQuire:CURRentcount:MASKSamples?

ACQuire:CURRentcount:MASKTHits?

ACQuire:CURRentcount:MASKWfms? Returns mask waveforms count

ACQuire:DATA:CLEar Clears all acquired data

ACQuire:MODe Sets or returns acquisition mode

ACQuire:NUMAVg Sets or returns number of acquisitions for an

ACQuire:SAVEFile:SAVEScreen Sets or returns the ﬁle to save screen to on

Returns acquisition parameters

Returns histogram hits count

Returns mask hits count

Returns mask samples count

Returns total mask hits count

averaged waveform

acquisition stopped

CSA/TDS8000 Series Programmer Manual 2-15

Command Groups

Table 2-18: Acquisition Commands, (cont.)

Command Description

ACQuire:SAVEFile:SAVEWfm Sets or returns the ﬁle to save waveform

data to on acquisition stopped

ACQuire:STATE Starts, stops, or returns acquisition state

ACQuire:STOPAfter? Returns all stopafter parameters

ACQuire:STOPAfter:ACTion Sets or returns the stopafter action

ACQuire:STOPAfter:BELL Sets or returns whether to sound bell on

acquisition stopped

ACQuire:STOPAfter:CONDition Sets or r eturns the acquisition stopafter

condition

ACQuire:STOPAfter:COUNt Sets or returns the stopafter count value

The stopafter count value is dependent on the condition set by the ACQuire:STOPAfter:CONDiton command

ACQuire:STOPAfter:MODe Sets or returns the stopafter mode

Calibration Command Group

The calibration commands provide information about the current state of the calibration for the mainframe and all resident sampling-module channels. Additional commands allow you to update portions of the “electronic calibration sticker” information, to check the protection status of the calibration information, and to set or query the front-panel DC calibration output.

Command

CALibrate:DATE:CH<x>? Returns date and time of the last sampling

CALibrate:DATE:MAInframe? Returns the date and time of the last

CALibrate:DCCALibrator Sets o returns the value of the DC Calibrator

CALibrate:HOSTinfo:CH<x>? Returns the mainframe model number, serial

CALibrate:LOCK:STATus? Returns the status of the calibration

CALibrate:STATus:CH<x>? Returns calibration status for speciﬁed

CALibrate:STATus:MAInframe? Returns calibration status for mainframe

Description

module channel<x> calibration

mainframe calibration

voltage

number, and mainframe channel<x> in which the sampling module channel was located during the last calibration information update.

information hardware lock switch

sampling module channel<x>

2-16 CSA/TDS8000 Series Programmer Manual

Command Groups

Command

CALibrate:TEMPerature:CH<x>? Returns the difference in ºC between

CALibrate:TEMPerature:MAInframe? Returns the difference in ºC between the

CALibrate:UPDATEinfo:ALL Updates date, time, temp and (for sampling

CALibrate:UPDATEinfo:CH<x> Updates the calibration information in the

CALibrate:UPDATEinfo:MAInframe Updates the calibration information in the

Compensation Command Group

The compensation commands provide information about the current state of the compensation for the mainframe and all resident module channels, means to invoke compensation functions, and management of compensation storage memory locations.

Description

the current sampling module c hannel<x> temperature a at the last calibration information update

current mainframe temperature and the temperature information update

modules) host mainframe information

nonvolatil channel<x>

nonvolatile memory of the mainframe

nd the temperature recorded

recorded at the last calibration

e memory of the sampling module

There are two nonvolatile compensation storage memory blocks in the mainframe and each sampling module channel: Factory and User. In addition, there is a volatile run-time, in-use version of all compensation data, which is the compensation data actually used during the operation of the instrument.

Command

COMPensate:ALL Compensates the mainframe and all resident

COMPensate:CH<x> Compensates the module channel<x> for

COMPensate:DARKLev:CH<x> Compensates the speciﬁed optical

COMPensate:DATE:CH<x>? Returns date and time of the current

COMPensate:DATE:MAInframe? Returns date and time of the current in-use

COMPensate:MAInframe Compensates the mainframe for DC

COMPensate:OPTGAIN:CH<x> Compensates optical user wavelength gain

Description

modules

DC variances

channel<x> by removing residual DC offsets in the entire vertical path

in-use compensation data for the module channel<x>

compensation data for the mainframe

variances

(wavelengths and input power)

CSA/TDS8000 Series Programmer Manual 2-17

Command Groups

Command

COMPensate:RECAll:FACTory:ALL Recalls compensation data for the mainframe

COMPensate:RECAll:FACTory:CH<x> Recalls compensation data from the

COMPensate:RECAll:FACTory:MAInframe Recalls compensation data from the

COMPensate

COMPensat

COMPensa

COMPensate:RESults? Returns brief explanation of the results of the

COMPens

COMPensate:SAVe:USER:ALL Saves volatile run-time compensation

COMPensate:SAVe:USER:CH<x> Saves volatile run-time compensation data

COMPensate:SAVe:USER:MAInframe Saves volatile run-time compensation data

COMPe

COMPensate:STATus:MAInframe? Returns the current compensation status of

:RECAll:USER:ALL

e:RECAll:USER:CH<x>

te:RECAll:USER:MAInframe

ate:RESults:VERBose?

nsate:STATus:CH<x>?

Description

and all resident module channels from their nonvolatile f compensation memory

nonvolatile factory memory of the module channel<x> i memory

nonvolatile factory memory in the mainframe into its ass

Recalls com and all resident module channels from their respective nonvolatile user memories into run-time c

Recalls co nonvolatile user memory of the module channel<x> into its associated run-time memory

Recalls c nonvolatile user memory in the mainframe into its associated run-time mem o ry

last com

Returns with a more detailed explanation than the COMPensate:RESults? query returns

data for modules into their associated nonvolatile user memories

for the user memory

for the mainframe into its nonvolatile user memor

Retur the speciﬁed module channel<x>

the mainframe

actory memories into run-time

nto its associated run-time

ociated run-time memory

pensation data for the mainframe

ompensation memory

mpensation data from the

ompensation data from the

pensation

results of last compensation,

the mainframe and all resident

module channel<x> into its nonvolatile

ns the current compensation status of

2-18 CSA/TDS8000 Series Programmer Manual

+ 376 hidden pages

Tektronix CSA8000B, CSA8000, TDS8000, TDS8000B, TDS8200 Programmer Manual

Specifications and Main Features

Frequently Asked Questions

User Manual