AFG1022
Arbitrary Function Generator
Programmer Manual
*P077105700*
077-1057-00
AFG1022
Arbitrary Function Generator
Programmer Manual
www.tektronix.com
077-1057-00
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.
Contacting Tektronix
Tektronix, Inc.
14150 SW Karl Braun Drive
P.O. Box 500
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.
Warranty
Tektronix warrants that the product will be free from defects in materials and workmanship for a period of three (3)
years from the date of original purchase from an authorized Tektronix distributor. If the product proves defective
during this warranty period, Tektronix, at its option, either will repair the defective product without charge for parts
and labor, or will provide a replacement in exchange for the defective product. Parts, modules and replacement
products used by Tektronix for warranty work may be new or
parts, modules and products become the property of Tektronix.
In order to obtain service under this warranty, Customer must notify Tektronix of the defect before the expiration
of the warranty period and make suitable arrangements for the performance of service. Customer shall be
responsible for packaging and shipping the defective product to the service center designated by Tektronix,
shipping charges prepaid, and with a copy of customer proof of purchase. Tektronix shall pay for the return of the
product to Customer if the shipment is to a location within the country in which the Tektronix service center is
located. Customer shall be responsible for paying all shipping charges, duties, taxes, and any other charges for
products returned to any other locations.
This warranty shall not apply to any defect, failure or damage caused by improper use or improper or inadequate
maintenance and care. Tektronix shall not be obligated to furnish service under this warranty a) to repair damage
resulting from attempts by personnel other than Tektronix representatives to install, repair or service the product;
b) to repair damage resulting from improper use or connection to
or malfunction caused by the use of non-Tektronix supplies; or d) to service a product that has been modified or
integrated with other products when the effect of such modification or integration increases the time or difficulty of
servicing the product.
reconditioned to like new performance. All replaced
incompatible equipment; c) to repair any damage
THIS WARRANTY IS GIVEN BY TEKTRONIX WITH RESPECT TO THE PRODUCT IN LIEU OF ANY
OTHER WARRANTIES, EXPRESS OR IMPLIED. TEKTRONIX AND ITS VENDORS DISCLAIM ANY
IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
TEKTRONIX' RESPONSIBILITY TO REPAIR OR REPLACE DEFECTIVE PRODUCTS IS THE SOLE AND
EXCLUSIVE REMEDY PROVIDED TO THE CUSTOMER FOR BREACH OF THIS WARRANTY.
TEKTRONIX AND ITS VENDORS WILL NOT BE LIABLE FOR ANY INDIRECT, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES IRRESPECTIVE OF WHETHER TEKTRONIX OR THE VENDOR HAS
ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.
[W2 – 15AUG04]
AFG1022 Arbitrary Function Generator Programmer Manual
i
Table of contents
Getting Started ....................................................................................................................................... 1
Introduction ...................................................................................................................................... 1
Connecting the Interface ............................................................................................................ 1
Using TekVISA ......................................................................................................................... 1
Where to find more information ................................................................................................ 2
Syntax and Commands ........................................................................................................................... 3
Command Syntax ............................................................................................................................. 3
Backus-Naur Form Definition ................................................................................................... 3
Command and Query Structure ................................................................................................. 3
SCPI Commands and Queries .................................................................................................... 5
IEEE 488.2 Common Commands .............................................................................................. 9
Command Groups ......................................................................................................................... 10
Command Descriptions................................................................................................................. 13
*CLS (No Query Form) ........................................................................................................... 13
*IDN? (Query Only) ................................................................................................................ 13
MMEMory:CATalog? (Query Only) ....................................................................................... 14
MMEMory:CDIRectory ........................................................................................................... 15
MMEMory:DELete (No Query Form) ...................................................................................... 16
*OPT? (Query Only) ............................................................................................................... 16
OUTPut[1|2][:STATe] .............................................................................................................. 17
*RST (No Query Form) ............................................................................................................ 17
[SOURce1]:AM:STATe ........................................................................................................... 18
[SOURce1]:BURSt:MODE ..................................................................................................... 18
[SOURce1]:BURSt:NCYCles ................................................................................................. 19
[SOURce1]:BURSt:STATe ...................................................................................................... 19
[SOURce1]:FM:STATe
[SOURce[1|2]]:FREQuency:CONCurrent[:STATe] ............................................................... 20
[SOURce[1|2]]:FREQuency[:CW|:FIXed] .............................................................................. 21
[SOURce1]:FREQuency:MODE ............................................................................................. 22
[SOURce1]:FSKey:STATe ...................................................................................................... 23
[SOURce[1|2]]:FUNCtion:EFILe ............................................................................................ 23
[SOURce[1|2]]:FUNCtion[:SHAPe] ....................................................................................... 24
[SOURce[1|2]]:PHASe[:ADJust] ............................................................................................ 25
[SOURce1]:PM:STATe
[SOURce[1|2]]:VOLTage[:LEVel][:IMMediate]:OFFSet ........................................................ 26
[SOURce[1|2]]:VOLTage[:LEVel][:IMMediate][:AMPLitude] .............................................. 27
SYSTem:ERRor[:NEXT]? (Query Only) ................................................................................. 28
TRACe|DATA:CATalog? (Query Only) .................................................................................. 29
.............................................................................................................. 20
............................................................................................................. 26
Table of Contents
ii
AFG1022 Arbitrary Function Generator Programmer Manual
TRACe|DATA:COPY (No Query Form) .................................................................................29
TRACe|DATA[:DATA] ............................................................................................................30
TRACe|DATA[:DATA]:VALue ................................................................................................30
TRACe|DATA:POINts .............................................................................................................31
*WAI (No Query Form) ...........................................................................................................32
Command Errors...................................................................................................................................33
Index .....................................................................................................................................................34
AFG1022 Arbitrary Function Generator Programmer Manual
1
AC line
connector
USB
(
type
B
)
connector
Getting Started
Introduction
This programmer g uide provides inform ation to use commands for remotely
controlling your instru ment. With this in formation, write computer programs that will
perform functions such as setting the front-panel controls, selecting clock source,
setting sampling rate , and exporting data for use in other programs.
Connecting the Interface
The AFG1022 has a USB (type B) connector on the rear panel, as shown in the
following figure. This connector conforms to USB-TMC. Attach a USB cable to
this connector.
Figure 1: USB (type B) connector
Using TekVISA
TekVISA is Tektronix implementation of VISA (Virtual Instrument Software
Architecture), an industry-standard communication protocol. VISA provides
a common standard for software developers so that software from multiple
vendors, such as instrument drivers, can run on the same platform. TekVISA is
industry-compliant software, available with selected Tektronix instruments.
You can use this software to write (or draw) interoperable instrument drivers in
a variety of Application Development Environments (ADEs). It implements a
subset of Version 2.2 of the VISA specification for controlling USB
instrument interface locally.
2
AFG1022 Arbitrary Function Generator Programmer Manual
Getting Started
Item
Purpose
Location
Important
safety and
compliance
instructions
Compliance and
safety instructions
Built-in
Help
UI Help and
Operation
Quick Start
User
Unpacking, Installation,
T
and
Programmer
Manu
Menu Structures,
User
Interface,
and
Information
Technical
Reference
Specifications
and
performance
ver
Installation
Use an internet browser to access the Tektronix Web site (www.tektronix.com)
and download the current TekVISA to your PC. Unzip the downloaded file in
temporary directory of your choice and run Setup.exe.
a
NOTE: The details on TekVISA concepts and operations are explained in the
TekVISA Programmer Manual that can be also found on the Tektronix Web site.
Where to find more informati on
The following table lists related documentation available for your instrument.
The documentation is available on the Product Documentation CD and on the
Tektronix Web site (www.tektronix.com/manuals).
Manual
al
utorials, Operation,
Overviews
Programming
ification
procedures
AFG1022 Arbitrary Function Generator Programmer Manual
3
Syntax and Commands
Command Syntax
You can control the operations and functions of the instrument through the
USB 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 Command Groups
(See page 10.) for a listing of the commands by command group, or use the
index to locate a specific command.
Backus-Naur Form Definition
This manual describes commands and queries using the Backus-Naur Form
(BNF) notation. The following table defines the standard BNF symbols.
Table 1: BNF symbols and meanings
Symbol
< >
:=
|
{ } Group; one element is required
[ ] Optional; can be omitted
. . .
( ) Comment
Meaning
Defined element
Is defined as
Exclusive OR
Previous element(s) may be repeated
Command and Query Structure
Overview
Messages
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
For example, the set command
MMEMory:CDIRectory?. Not all commands have both a set and a query form;
some commands are set only and some are query only.
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 element types.
the set form except that it ends with a question mark.
MMEMory:CDIRectory has a query form
4
AFG1022 Arbitrary Function Generator Programmer Manual
Command Syntax
Table 2: Command message elements
Symbol
<Header>
Meaning
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 comman
d is concatenated with other commands the beginning
is required. The beginning colon can never be used with command
<Mnemonic>
headers beginning with a star (*).
A header subfunction. Some command headers have only one mnemonic.
If a command
from each other by a colon (:) character.
header has multiple mnemonics, they are always separated
<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.
colon
Commands
Commands cause the instrument to perform a specific function or change one of
its settings. Commands have the structure:
[:]<Header>[<Space><Argument>[<Comma><Argument>]...]
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 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
Query Responses
Queries cause the instrument to return information about its status or settings.
Queries have the structure:
[:]<Header>?
[:]<Header>?[<Space><Argument>[<Comma><Argument>]...]
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.
When a query is sent to the instrument, only the values are returned. When the
returned value is a mnemonic, it is noted in abbreviated format.
AFG1022 Arbitrary Function Generator Programmer Manual
5
Command Syntax
Command Entry
Follow these general rules when entering commands:
Enter commands in upper or lower case.
Precede any command with white space characters. White space
include any combination of the ASCII control characters 00 through
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.
SCPI Commands and Queries
The instrument 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. The top level of
the tree is the root
You can create commands and queries from these subsystem hierarchy trees.
Commands specify actions for the instrument to perform. Queries return
measurement data and information about parameter settings.
Creating Commands
SCPI commands are created by stringing together the nodes of a subsystem
hierarchy and separating each node by a colon.
node; it is followed by one or more lower-level nodes.
characters
09 and
To create a SCPI command, start with the root node and move down the tree
structure adding nodes until you reach the
some queries have parameters; you must
you specify a parameter value that is out
default value. The command descriptions,
parameters.
Creating Queries
Query Responses
Parameter Types
To create a query, start at the root node of a tree structure, move down to the end of
a branch, and add a question mark.
The query causes the instrument to return information about its status or settings.
When a query is sent to the instrument, only the values are returned. When the
returned value is a mnemonic, it is noted in abbreviated format.
Every parameter in the command and query descriptions is of a specified type.
(See Table 3.) The parameters are enclosed in brackets, such as <value>.
end of a branch. Most commands and
include a value for these parameters. If
of range, the parameter will be set to a
list the valid values for all
6
AFG1022 Arbitrary Function Generator Programmer Manual
Command Syntax
Parameter type
Description
Example
arbitrary block
1
A specified length of
arbitrary
#512234xxxxx . . . where
5
5
length
xxxxx
#0xxxxx...<LF><&EOI>
boolean
Boolean numbers or values
ON or ≠ 0
OFF or 0
discrete
A list of specific values
MIN, MAX
binary
Binary numbers
#B0110
octal
Octal numbers
#Q57, #Q3
hexadecimal
2
Hexadecimal numbers
(0-9, A, B, C, D, E, F)
#H AA, #H1
NR1 2 numeric
Integers
0, 1, 15, -1
NR2
2 3
numeric
Decimal numbers
1.2, 3.141516, -6.5
NR3 2 numeric
Floating point numbers
3.1415E-9, -16.1E5
NRf 2 numeric
Flexible decimal number that
may be type NR1, NR2 or NR3
See NR1, NR2, and NR3
examples
string
4
Alphanumeric characters (must
be within quotation marks)
"Testing 1, 2, 3"
The parameter type is listed after the parameter and is enclosed in parentheses,
for example, (boolean). Some parameter types are defined specifically for the
instrument command set and some are defined by SCPI.
Table 3: Parameter types used in syntax descriptions
data
indicates that the following
digits (12234) specify the
of the data in bytes;
... indicates the data
or
1
Defined in ANSI/IEEE 488.2 as "Definite Length Arbitrary Block Response Data."
2
An ANSI/IEEE 488.2-1992-defined parameter type.
3
Some commands and queries will accept an octal or hexadecimal value even though the parameter type is
defined as NR1.
4
Defined in ANSI/IEEE 488.2 as "String Response Data."
Special Characters
The Line Feed (LF) character or the New Line (NL) character (ASCII 10), and all
characters in the range of ASCII 127-255 are defined as special characters. These
characters are used in arbitrary block arguments only; using these characters in
other parts of any command yields unpredictable results.
Loading...