No part of this manual may be
reproduced in any form or by any
means (including electronic storage
and retrieval or translation into a
foreign language) without prior
agreement and written consent from
Keysight Technologies, Inc. as
governed by United States and
international copyright laws.
Trademark Acknowledgments
Manual Part Number
E8251-90356
Edition
Edition 3, January 2017
Supersedes: October 2015
Printed in USA/Malaysia
Published by:
Keysight Technologies
1400 Fountaingrove Parkway
Santa Rosa, CA 95403
Warranty
THE MATERIAL CONTAINED IN THIS
DOCUMENT IS PROVIDED “AS IS,”
AND IS SUBJECT TO BEING
CHANGED, WITHOUT NOTICE, IN
FUTURE EDITIONS. FURTHER, TO
THE MAXIMUM EXTENT PERMITTED
BY APPLICABLE LAW, KEYSIGHT
DISCLAIMS ALL WARRANTIES,
EITHER EXPRESS OR IMPLIED WITH
REGARD TO THIS MANUAL AND
ANY INFORMATION CONTAINED
HEREIN, INCLUDING BUT NOT
LIMITED TO THE IMPLIED
WARRANTIES OF
MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE.
KEYSIGHT SHALL NOT BE LIABLE
FOR ERRORS OR FOR INCIDENTAL
OR CONSEQUENTIAL DAMAGES IN
CONNECTION WITH THE
FURNISHING, USE, OR
PERFORMANCE OF THIS
DOCUMENT OR ANY INFORMATION
CONTAINED HEREIN. SHOULD
KEYSIGHT AND THE USER HAVE A
SEPARATE WRITTEN AGREEMENT
WITH WARRANTY TERMS
COVERING THE MATERIAL IN THIS
DOCUMENT THAT CONFLICT WITH
THESE TERMS, THE WARRANTY
TERMS IN THE SEPARATE
AGREEMENT WILL CONTROL.
Technology Licenses
The hardware and/or software
described in this document are
furnished under a license and may be
used or copied only in accordance
with the terms of such license.
U.S. Government Rights
The Software is “commercial
computer software,” as defined
by Federal Acquisition Regulation
(“FAR”) 2.101. Pursuant to FAR
12.212 and 27.405-3 and
Department of Defense FAR
Supplement (“DFARS”) 227.7202,
the U.S. government acquires
commercial computer software
under the same terms by which
the software is customarily
provided to the public.
Accordingly, Keysight provides
the Software to U.S. government
customers under its standard
commercial license, which is
embodied in its End User License
Agreement (EULA), a copy of
which can be found at
http://www.keysight.com/find/sweula
The license set forth in the EULA
represents the exclusive authority
by which the U.S. government
may use, modify, distribute, or
disclose the Software. The EULA
and the license set forth therein,
does not require or permit,
among other things, that
Keysight: (1) Furnish technical
information related to
commercial computer software
or commercial computer
software documentation that is
not customarily provided to the
public; or (2) Relinquish to, or
otherwise provide, the
government rights in excess of
these rights customarily provided
to the public to use, modify,
reproduce, release, perform,
display, or disclose commercial
computer software or
commercial computer software
documentation. No additional
government requirements
beyond those set forth in the
EULA shall apply, except to the
extent that those terms, rights, or
licenses are explicitly required
from all providers of commercial
computer software pursuant to
the FAR and the DFARS and are
set forth specifically in writing
elsewhere in the EULA. Keysight
shall be under no obligation to
update, revise or otherwise
modify the Software. With
respect to any technical data as
defined by FAR 2.101, pursuant
to FAR 12.211 and 27.404.2 and
DFARS 227.7102, the U.S.
government acquires no greater
than Limited Rights as defined in
FAR 27.401 or DFAR 227.7103-5
(c), as applicable in any technical
data.
Safety Notices
A CAUTION notice denotes a hazard. It
calls attention to an operating
procedure, practice, or the like that,
if not correctly performed or adhered
to, could result in damage to the
product or loss of important data. Do
not proceed beyond a CAUTION
notice until the indicated conditions
are fully understood and met.
A WARNING notice denotes a hazard.
It calls attention to an operating
procedure, practice, or the like that,
if not correctly performed or adhered
to, could result in personal injury or
death. Do not proceed beyond a
WARNING notice until the indicated
conditions are fully understood and
met.
Where to Find the Latest Information
Documentation is updated periodically. For the latest information about these products, including instrument software
upgrades, application information, and product information, browse to one of the following URLs, according to the name
of your product:
http://www.keysight.com/find/psg
To receive the latest updates by email, subscribe to Keysight Email Updates at the following URL:
http://www.keysight.com/find/MyKeysight
Information on preventing instrument damage can be found at:
www.keysight.com/find/PreventingInstrumentRepair
Is your product software up-to-date?
Periodically, Keysight releases software updates to fix known defects and incorporate product enhancements. To search
for software updates for your product, go to the Keysight Technical Support website at:
Keysight PSG Signal Generators
E8257D, E8267D, & E8663D
SCPI Command Reference
1Using this Guide
In the following sections, this chapter describes how SCPI information is
organized and presented in this guide. An overview of the SCPI language is
also provided:
— “How the SCPI Information is Organized” on page 2
— “SCPI Basics” on page 3
1
Using this Guide
How the SCPI Information is Organized
How the SCPI Information is Organized
SCPI Listings
The table of contents lists the Standard Commands for Programmable
Instruments (SCPI) without the parameters. The SCPI subsystem name will
generally have the first part of the command in parenthesis that is repeated in
all commands within the subsystem. The title(s) beneath the subsystem name
is the remaining command syntax. The following example demonstrates this
listing:
Communication Subsystem (:SYSTem:COMMunicate)
:PMETer:CHANnel
:SERial:ECHO
The following examples show the complete commands from the above Table of
Contents listing:
:SYSTem:COMMunicate:PMETer:CHANnel
:SYSTem:COMMunicate:SERial:ECHO
Subsystem Groupings by Chapter
A subsystem is a group of commands used to configure and operate a certain
function or feature. Like individual commands, subsystems that share a similar
scope or role can also be categorized and grouped together. This guide uses
chapters to divide subsystems into the following groups:
—System Commands
— Basic Function Commands
— Analog Modulation Commands
— Digital Modulation Commands
Front Panel Operation Cross Reference
The last section in this book provides an index of hardkeys, softkeys, and data
fields used in front panel operation, cross–referenced to their corresponding
SCPI command. Key and data field names are sorted in two ways:
— individual softkey, hardkey, or data field name
— SCPI subsystem name with associated key and data field names nested
underneath
Supported Models and Options per Command
Within each command section, the Supported heading describes the signal
generator configurations supported by the SCPI command. “All” means that all
models and options are supported. When “All with Option xxx” is shown next to
this heading, only the stated option(s) is supported.
This section describes the general use of the SCPI language for the PSG. It is
not intended to teach you everything about the SCPI language; the SCPI
Consortium or IEEE can provide that level of detailed information. For a list of
the specific commands available for the signal generator, refer to the table of
contents.
For additional information, refer to the following publications:
— IEEE Standard 488.1–1987, IEEE Standard Digital Interface for
Programmable Instrumentation. New York, NY, 1998.
— IEEE Standard 488.2–1992, IEEE Standard Codes, Formats, Protocols and
Command Commands for Use with ANSI/IEEE Standard 488.1–1987. New
York, NY, 1998.
The following terms are used throughout the remainder of this section:
Command A command is an instruction in SCPI consisting of
mnemonics (keywords), parameters (arguments), and
punctuation. You combine commands to form
messages that control instruments.
Controller A controller is any device used to control the signal
generator, for example a computer or another
instrument.
Event Command Some commands are events and cannot be queried. An
event has no corresponding setting; it initiates an action
at a particular time.
Program Message A program message is a combination of one or more
properly formatted commands. Program messages are
sent by the controller to the signal generator.
Query A query is a special type of command used to instruct
the signal generator to make response data available to
the controller. A query ends with a question mark.
Generally you can query any command value that you
set.
Response Message A response message is a collection of data in
specific SCPI formats sent from the signal generator to
the controller. Response messages tell the controller
about the internal state of the signal generator.
A typical command is made up of keywords prefixed with colons (:). The
keywords are followed by parameters. The following is an example syntax
statement:
[:SOURce]:POWer[:LEVel] MAXimum|MINimum
In the example above, the [:LEVel] portion of the command immediately
follows the :POWer portion with no separating space. The portion following the
[:LEVel], MINimum|MAXimum, are the parameters (argument for the
command statement). There is a separating space (white space) between the
command and its parameter.
Additional conventions in syntax statements are shown in Table 1-1 and Table
1-2.
Table 1-1 Special Characters in Command Syntax
Characters MeaningExample
|A vertical stroke between keywords or parameters indicates alterative
choices. For parameters, the effect of the command varies depending
on the choice.
[ ]Square brackets indicate that the enclosed keywords or parameters are
optional when composing the command. These implied keywords or
parameters will be executed even if they are omitted.
< >Angle brackets around a word (or words) indicate they are not to be
used literally in the command. They represent the needed item.
{ }Braces indicate that parameters can optionally be used in the
command once, several times, or not at all.
[:SOURce]:AM:
MOD DEEP|NORMal
DEEP or NORMal are the choices.
[:SOURce]:FREQuency[:CW]?
SOURce and CW are optional items.
[:SOURce]:FREQuency:
STARt <val><unit>
In this command, the words <val> and
<unit> should be replaced by the actual
frequency and unit.
:FREQuency:STARt 2.5GHZ
[:SOURce]:LIST:
POWer <val>{,<val>}
a single power listing:
LIST:POWer 5
a series of power listings:
LIST:POWer 5,10,15,20
Table 1-2 Command Syntax
Characters, Keywords, and SyntaxExample
Upper–case lettering indicates the minimum set of characters required to execute
the command.
Lower–case lettering indicates the portion of the command that is optional; it can
either be included with the upper–case portion of the command or omitted. This is
the flexible format principle called forgiving listening. Refer to “Command
Parameters and Responses” on page 7 for more information.
[:SOURce]:FREQuency[:CW]?,
FREQ is the minimum requirement.
:FREQuency
Either :FREQ, :FREQuency, or
:FREQUENCY is correct.
When a colon is placed between two command mnemonics, it moves the current
path down one level in the command tree. Refer to “Command Tree” on
page 6 more information on command paths.
If a command requires more than one parameter, you must separate adjacent
parameters using a comma. Parameters are not part of the command path, so
commas do not affect the path level.
A semicolon separates two commands in the same program message without
changing the current path.
White space characters, such as <tab> and <space>, are generally ignored as
long as they do not occur within or between keywords.
However, you must use white space to separate the command from the parameter,
but this does not affect the current path.
Command Types
Commands can be separated into two groups: common commands and
subsystem commands. Figure 1-1, shows the separation of the two command
groups. Common commands are used to manage macros, status registers,
synchronization, and data storage and are defined by IEEE 488.2. They are easy
to recognize because they all begin with an asterisk. For example *IDN?, *OPC,
and *RST are common commands. Common commands are not part of any
subsystem and the signal generator interprets them in the same way,
regardless of the current path setting.
:TRIGger:OUTPut:POLarity?
TRIGger is the root level keyword
for this command.
[:SOURce]:LIST:
DWELl <val>{,<val>}
:FREQ 2.5GHZ;:POW 10DBM
:FREQ uency or :POWer
:LEVel are
not allowed.
A <space> between :LEVel and
6.2
is mandatory.
:POWer:LEVel 6.2
Subsystem commands are distinguished by the colon (:). The colon is used at
the beginning of a command statement and between keywords, as in
:FREQuency[:CW?]. Each command subsystem is a set of commands that
roughly correspond to a functional block inside the signal generator. For
example, the power subsystem (:POWer) contains commands for power
generation, while the Status subsystem (:STATus) contains commands for
controlling status registers.
Most programming tasks involve subsystem commands. SCPI uses a structure
for subsystem commands similar to the file systems on most computers. In
SCPI, this command structure is called a command tree and is shown in Figure
1-2.
Figure 1-2 Simplified Command Tree
The command closest to the top is the root command, or simply “the root.”
Notice that you must follow a particular path to reach lower level commands.
In the following example, :POWer represents AA, :ALC represents BB,
:SOURce represents GG. The complete command path is
:POWer:ALC:SOURce? (:AA:BB:GG).
Paths Through the Command Tree
To access commands from different paths in the command tree, you must
understand how the signal generator interprets commands. The parser, a part
of the signal generator firmware, decodes each message sent to the signal
generator. The parser breaks up the message into component commands
using a set of rules to determine the command tree path used. The parser
keeps track of the current path (the level in the command tree) and where it
expects to find the next command statement. This is important because the
same keyword may appear in different paths. The particular path is determined
by the keyword(s) in the command statement.
A message terminator, such as a <new line> character, sets the current path
to the root. Many programming languages have output statements that
automatically send message terminators.
The current path is set to the root after the line–power is cycled or when
*RST is sent.
Command Parameters and Responses
SCPI defines different data formats for use in program and response messages.
It does this to accommodate the principle of forgiving listening and precise
talking. For more information on program data types refer to IEEE 488.2.
Forgiving listening means the command and parameter formats are flexible.
For example, with the :FREQuency:REFerence:STATe ON|OFF|1|0
command, the signal generator accepts :FREQuency:REFerence:STATe ON,
:FREQuency:REFerence:STATe 1, :FREQ:REF:STAT ON,
:FREQ:REF:STAT 1 to turn on the frequency reference mode.
Each parameter type has one or more corresponding response data types. A
setting that you program using a numeric parameter returns either real or
integer response data when queried. Response data (data returned to the
controller) is more concise and restricted and is called precise talking.
Precise talking means that the response format for a particular query is always
the same.
For example, if you query the power state (:POWer:ALC:STATe?) when it is
on, the response is always 1, regardless of whether you previously sent
:POWer:ALC:STATe 1 or :POWer:ALC:STATe ON.
Table 1-3 Parameter and Response Types
Parameter TypesResponse Data Types
NumericReal, Integer
Extended NumericReal, Integer
DiscreteDiscrete
BooleanNumeric Boolean
StringString
Numeric Parameters
Numeric parameters are used in both common and subsystem commands.
They accept all commonly used decimal representations of numbers including
optional signs, decimal points, and scientific notation.
If a signal generator setting is programmed with a numeric parameter which
can only assume a finite value, it automatically rounds any entered parameter
which is greater or less than the finite value. For example, if a signal generator
has a programmable output impedance of 50 or 75 ohms, and you specified
76.1 for the output impedance, the value is rounded to 75. The following are
examples of numeric parameters:
100no decimal point required
100.fractional digits optional
−1.23leading signs allowed
4.56E<space>3space allowed after the E in exponential
−7.89E−001use either E or e in exponential
+256leading + allowed
.5digits left of decimal point optional
Extended Numeric Parameters
Most subsystems use extended numeric parameters to specify physical
quantities. Extended numeric parameters accept all numeric parameter values
and other special values as well.
The following are examples of extended numeric parameters:
Extended Numeric ParametersSpecial Parameters
100any simple numeric valueDEFaultresets parameter to its default value
1.2GHZGHZ can be used for exponential (E009)UPincrements the parameter
200MHZMHZ can be used for exponential (E006)DOWNdecrements the parameter
−100mVnegative 100 millivoltsMINimumsets parameter to smallest possible value
10DEG10 degreesMAXimumsets parameter to largest possible value
Discrete Parameters
Discrete parameters use mnemonics to represent each valid setting. They have
a long and a short form, just like command mnemonics. You can mix upper and
lower case letters for discrete parameters.
The following examples of discrete parameters are used with the command
:TRIGger[:SEQuence]:SOURce BUS|IMMediate|EXTernal.
Although discrete parameters look like command keywords, do not confuse the
two. In particular, be sure to use colons and spaces correctly. Use a colon to
separate command mnemonics from each other and a space to separate
parameters from command mnemonics.
The following are examples of discrete parameters in commands:
TRIGger:SOURce BUS
TRIGger:SOURce IMMediate
TRIGger:SOURce EXTernal
Boolean Parameters
Boolean parameters represent a single binary condition that is either true or
false. The two–state boolean parameter has four arguments. The following list
shows the arguments for the two–state boolean parameter:
ONboolean true, upper/lower case allowed
OFFboolean false, upper/lower case allowed
1boolean true
0boolean false
String Parameters
String parameters allow ASCII strings to be sent as parameters. Single or
double quotes are used as delimiters.
The following are examples of string parameters:
'This is valid' "This is also valid" 'SO IS THIS'
Real Response Data
Real response data represent decimal numbers in either fixed decimal or
scientific notation. Most high–level programming languages that support
signal generator input/output (I/O) handle either decimal or scientific notation
transparently.
Integer response data are decimal representations of integer values including
optional signs. Most status register related queries return integer response
data. The following are examples of integer response data:
0signs are optional−100leading − allowed
+100leading + allowed256never any decimal point
Discrete Response Data
Discrete response data are similar to discrete parameters. The main difference
is that discrete response data only returns the short form of a particular
mnemonic, in all upper case letters. The following are examples of discrete
response data:
IMMEXTINTNEG
Numeric Boolean Response Data
Boolean response data returns a binary numeric value of one or zero.
String Response Data
String response data are similar to string parameters. The main difference is
that string response data returns double quotes, rather than single quotes.
Embedded double quotes may be present in string response data. Embedded
quotes appear as two adjacent double quotes with no characters between
them. The following are examples of string response data:
"This is a string"
"one double quote inside brackets: [""]"
"Hello!"
Program Messages
The following commands will be used to demonstrate the creation of program
messages:
This program message is correct and will not cause errors; STARt and STOP are
at the same path level. It is equivalent to sending the following message:
This program message will result in an error. The message makes use of the
default
POWer[:LEVel] node (root command). When using a default node, there is no
change to the current path position. Since there is no command OFFSet at the
root level, an error results.
The following example shows the correct syntax for this program message:
:POWer 10DBM;:POWer:OFFSet 5DB
Example 3
:POWer:OFFSet 5DB;POWer 10DBM
This program message results in a command error. The path is dropped one
level at each colon. The first half of the message drops the command path to
the lower level command OFFSet; POWer does not exist at this level.
The POWer 10DBM command is missing the leading colon and when sent, it
causes confusion because the signal generator cannot find POWer at the
POWer:OFFSet level. By adding the leading colon, the current path is reset to
the root. The following shows the correct program message:
:POWer:OFFSet 5DB;:POWer 10DBM
Example 4
FREQ 500MHZ;POW 4DBM
In this example, the keyword short form is used. The program message is
correct because it utilizes the default nodes of :FREQ[:CW] and
:POW[:LEVel]. Since default nodes do not affect the current path, it is not
necessary to use a leading colon before FREQ or POW.
File Name Variables
File name variables, such as "<file name>", represent three formats, "<file
name>", "<file name@file type>", and "</user/file type/file
name>". The following shows the file name syntax for the three formats, but
uses "FLATCAL" as the file name in place of the variable "<file name>":
Format 1 "FLATCAL"
Format 2 "FLATCAL@USERFLAT"
Format 3 "/USER/USERFLAT/FLATCAL"
Format 2 uses the file type extension (@USERFLAT) as part of the file name
syntax. Format 3 uses the directory path which includes the file name and file
type. Use Formats 2 and 3 when the command does not specify the file type.
This generally occurs in the Memory (:MEMory) or Mass Memory (:MMEMory)
subsystems. The following examples demonstrate a command where Format 1
applies:
Command Syntax with the file name variable:MEMory:STORe:LIST "<file name>"
Command Syntax with the file name:MEMory:STORe:LIST "SWEEP_1"
This command has :LIST in the command syntax. This denotes that
"SWEEP_1" will be saved in the :List file type location as a list type file.
The following examples demonstrate a command where Format 2 applies:
This command cannot distinguish which file type "FLATCAL" belongs to
without the file type extension (@USERFLAT). If this command were executed
without the extension, the command would assume the file type was Binary.
The following examples demonstrate a command where format 3 applies:
— NVWFM: non–volatile ARB waveform storage. Files must be moved to the
WFM1: directory before they can be played by the signal generator’s Dual
ARB player. The directory can also be specified as /USER/WAVEFORM.
— SEQ: sequence files are stored here and are non–volatile. The directory can
also be specified as /USER/SEQ.
MSUS (Mass Storage Unit Specifier) Variable
The variable "<msus>" enables a command to be file type specific when
working with user files. Some commands use it as the only command
parameter, while others can use it in conjunction with a file name when a
command is not file type specific. When used with a file name, it is similar to
Format 2 in the File Name Variables section on page 11. The difference is the
file type specifier (msus) occupies its own variable and is not part of the file
name syntax.
The following examples illustrate the usage of the variable "<msus>" when it is
the only command parameter:
Command Syntax with the msus variable
:MMEMory:CATalog? "<msus>"
Command Syntax with the file system
:MMEMory:CATalog? "LIST:"
The variable "<msus>" is replaced with "LIST:". When the command is
executed, the output displays only the files from the List file system.
The following examples illustrate the usage of the variable "<file name>" with the variable "<msus>":
Command Syntax with the file name and msus variables
:MMEMory:DELete[:NAME] "<file name>",["<msus>"]
Command Syntax with the file name and file system
:MMEMory:DELete:NAME "LIST_1","LIST:"
The command from the above example cannot discern which file system
LIST_1 belongs to without a file system specifier and will not work without it.
When the command is properly executed, LIST_1 is deleted from the List file
system.
The following example shows the same command, but using Format 2 from the
File Name Variables section on page 11:
:MMEMory:DELete:NAME "LIST_1@LIST"
When a file name is a parameter for a command that is not file system specific,
either format
(<file name>","<msus>" or "<file name@file system>") will work.
Refer to Table on page 4 for a listing of special syntax characters.
Quote Usage with SCPI Commands
As a general rule, programming languages require that SCPI commands be
enclosed in double quotes as shown in the following example:
":FM:EXTernal:IMPedance 600"
However, when a string is the parameter for a SCPI command, additional
quotes or other delimiters may be required to identify the string. Your
programming language may use two sets of double quotes, one set of single
quotes, or back slashes with quotes to signify the string parameter. The
following examples illustrate these different formats:
"MEMory:LOAD:LIST ""myfile""" used in BASIC programming
languages
"MEMory:LOAD:LIST \"myfile\"" used in C, C++, Java, and PERL
"MEMory:LOAD:LIST 'myfile'" accepted by most programming
languages
Consult your programming language reference manual to determine the
correct format.
Binary, Decimal, Hexadecimal, and Octal Formats
Command values may be entered using a binary, decimal, hexadecimal, or
octal format. When the binary, hexadecimal, or octal format is used, their
values must be preceded with the proper identifier. The decimal format (default
format) requires no identifier and the signal generator assumes this format
when a numeric value is entered without one. The following list shows the
identifiers for the formats that require them:
— #B identifies the number as a binary numeric value (base–2).
— #H identifies the number as a hexadecimal alphanumeric value (base–16).
— #Q identifies the number as a octal alphanumeric value (base–8).
The following are examples of SCPI command values and identifiers for the
decimal value 45:
#B101101 binary equivalent
#H2D hexadecimal equivalent
#Q55 octal equivalent
The following example sets the RF output power to 10 dBm (or the equivalent
value for the currently selected power unit, such as DBUV or DBUVEMF) using
the hexadecimal value 000A:
Keysight PSG Signal Generators
E8257D, E8267D, & E8663D
SCPI Command Reference
2System Commands
In the following sections, this chapter provides SCPI descriptions for
subsystems dedicated to peripheral signal generator operations common to all
PSG models:
— “Calibration Subsystem (:CALibration)” on page 18
— “Communication Subsystem (:SYSTem:COMMunicate)” on page 24
— “Diagnostic Subsystem (:DIAGnostic[:CPU]:INFOrmation)” on page 31
— “Display Subsystem (:DISPlay)” on page 34
— “IEEE 488.2 Common Commands” on page 39
— “Low–Band Filter Subsystem” on page 44
— “Memory Subsystem (:MEMory)” on page 45
— “Mass Memory Subsystem (:MMEMory)” on page 68
— “Output Subsystem (:OUTPut)” on page 74
— “Route Subsystem (:ROUTe:HARDware:DGENerator)” on page 78
— “Status Subsystem (:STATus)” on page 86
— “System Subsystem (:SYSTem)” on page 102
— “Trigger Subsystem” on page 123
— “Unit Subsystem (:UNIT)” on page 126
17
System Commands
Calibration Subsystem (:CALibration)
Calibration Subsystem (:CALibration)
:DCFM
SupportedAll with Option UNT
:CALibration:DCFM
This command initiates a DCFM or DCΦM calibration depending on the
currently active modulation. This calibration eliminates any dc or modulation
offset of the carrier signal.
Use this calibration for externally applied signals. While the calibration can
also be performed for internally generated signals, dc offset is not a normal
characteristic for them.
If the calibration is performed with a dc signal applied, any deviation
provided by the dc signal will be removed and the new zero reference point
will be at the applied dc level. The calibration will have to be performed
again when the dc signal is removed in order to reset the carrier signal to
the correct zero reference.
:IQ
:IQ:DC
Key Entry DCFM/DCΦM Cal
Supported E8267D
:CALibration:IQ
This command initiates an I/Q calibration for a range of frequencies and is
equivalent to selecting User from the front panel Calibration Type DC User Full softkey in the I/Q Calibration menu. For setting range frequencies, refer to
:IQ:STARt, and :IQ:STOP commands.
Key Entry Execute Cal Calibration Type DC User Full
Supported E8267D
:CALibration:IQ:DC
This command starts and performs a one to two second adjustment that is not
traceable to a standard. However, it will minimize errors associated with signal
generator internal voltage offsets. This adjustment minimizes errors for the
current signal generator setting and at a single frequency. The DC adjustment
is volatile and must be repeated with each signal generator setting change.
This command can be sent while the RF On/Off is set to Off and the adjustment
will still be valid when the RF is enabled.
System Commands
Calibration Subsystem (:CALibration)
The I/Q DC adjustment is dependent upon a number of instrument settings. If
any of the instrument settings change, the adjustment will become invalid. The
dependent instrument settings are:
— I/Q calibration (the I/Q DC calibration will be invalidated if any other I/Q
calibration is execute)
— Temperature (±5 degrees)
The following instrument states will not invalidate the I/Q DC calibration:
—Power level changes
— I/Q Impairments
:IQ:DEFault
:CALibration:IQ:DEFault
This command will restore the original factory calibration data for the internal
I/Q modulator.
:IQ:FULL
:CALibration:IQ:FULL
This command sets and performs a full frequency range (regardless of the start
and stop frequency settings) I/Q calibration and stores the results in the signal
generator’s memory.
Start and stop frequencies default to the full frequency range of the signal
generator.
Key Entry Execute Cal Calibration Type DC User Full
Supported E8267D
Key Entry Revert to Default Cal Settings
Supported E8267D
RangeDepends on the signal generator’s frequency option.
See also: “:FREQuency:CENTer” on page 131.
Key Entry Execute Cal (Calibration Type DC User Full set to Full)
This command sets the stop frequency and automatically sets the calibration
type to User for an I/Q calibration. The setting enabled by this command is not
affected by a signal generator power–on, preset, or *RST command.
Example
:CAL:IQ:STOP 2GHZ
The preceding example sets the signal generator’s stop frequency for an IQ
calibration to 2 GHz.
RangeDepends on the signal generator’s frequency option.
System Commands
Calibration Subsystem (:CALibration)
This command initiates a wideband I/Q calibration for a range of frequencies
and is equivalent to selecting User from the front panel Calibration Type DC User Full softkey. For setting range frequencies, refer to :WBIQ:STARt, and
:WBIQ:STOP commands.
:WBIQ:DC
:CALibration:WBIQ:DC
This command performs a one to two second adjustment that is not traceable
to a standard. However, it will minimize errors associated with offset voltages.
This adjustment minimizes errors for the current signal generator setting and
at a single frequency. The DC adjustment is volatile and must be repeated with
each signal generator setting change. This command can be sent while the RF
On/Off is set to Off and the adjustment will be valid when RF is enabled.
The wideband I/Q DC adjustment is dependent upon a number of instrument
settings. If any of the PSG settings change, the adjustment will become invalid.
The dependent instrument settings are:
System Commands
Calibration Subsystem (:CALibration)
:WBIQ:DEFault
SupportedE8267D with Option 015
:CALibration:WBIQ:DEFault
This command will restore the original factory calibration data for the internal
I/Q modulator.
Key Entry Revert to Default Cal Settings
:WBIQ:FULL
SupportedE8267D with Option 015
:CALibration:WBIQ:FULL
This command sets and performs a full–frequency range (regardless of the
start and stop frequency settings) wideband I/Q calibration and stores the
results in the signal generator’s firmware.
Start and stop frequencies will default to the full frequency range of the signal
generator.
RangeDepends on the signal generator’s frequency option.
This command sets the start frequency and automatically sets the calibration
type to User for a wideband I/Q calibration. The setting enabled by this
command is not affected by a signal generator power–on, preset, or *RST
command.
Example
:CAL:WBIQ:STAR 1GHZ
The preceding example sets the signal generator’s start frequency to 1 GHz for
a wideband IQ calibration.
See also: “:FREQuency:CENTer” on page 131.
Key Entry Execute Cal Calibration Type DC User Full
Supported E8267D with Option 015
RangeDepends on the signal generator’s frequency option.
This command sets the signal generator’s general purpose instrument bus
(GPIB) address.
The variable <number> is a numeric value between 0 and 30. The signal
generator typically uses 19 as the instrument address. The address must be
different from other GPIB devices in your system.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:GTLocal
:SYST:COMM:GPIB:ADDR 19
The preceding example sets the signal generator’s GPIB address to 19.
Range 0–30
Key Entry GPIB Address
Supported All Models
:SYSTem:COMMunicate:GTLocal
This command sets the signal generator to local mode, enabling front panel
operation.
This command selects the signal generator’s internet protocol (IP) address. The
dynamic host communication protocol (DHCP) selection allows the network to
assign an IP address. The manual selection allows the user to enter an IP
address.
Example
:SYST:COMM:LAN:CONF DHCP
The preceding example sets up the signal generator LAN configuration to use a
DHCP IP address.
This command sets the gateway for local area network (LAN) access to the
signal generator from outside the current sub–network.
The "<ipstring>" string variable is the LAN gateway address, formatted as
xxx.xxx.xxx.xxx. Refer to Quote Usage with SCPI Commands for information on
using quotes for different programming languages.
Using an empty string restricts access to the signal generator to local hosts on
the LAN.
Example
:SYST:COMM:LAN:GATE "203.149.781.101"
The preceding example sets the signal generator’s LAN gateway address.
System Commands
Communication Subsystem (:SYSTem:COMMunicate)
The "<string>" variable is the hostname for the signal generator. Refer to Quote
Usage with SCPI Commands for information on using quotes for different
programming languages.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:SYST:COMM:LAN:HOSTname "siginst3"
The preceding example sets “siginst3” as the signal generator’s LAN hostname.
This command sets the signal generator’s local area network (LAN) internet
protocol (IP) address for your IP network connection.
The "<ipstring>" variable is the signal generator’s IP address, formatted as
xxx.xxx.xxx.xxx. Refer to Quote Usage with SCPI Commands for information on
using quotes for different programming languages.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:SYST:COMM:LAN:IP "202.195.207.193"
The preceding example sets the signal generator’s LAN IP address.
This command sets the signal generator’s local area network (LAN) subnet
mask address for your internet protocol (IP) network connection.
The "<ipstring>" variable is the subnet mask for the IP address, formatted as
xxx.xxx.xxx.xxx. Refer to Quote Usage with SCPI Commands for information on
using quotes for different programming languages.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
This command sets the instrument address for a power meter that is controlled
by the signal generator. The power meter is controlled only through a general
purpose instrument bus (GPIB) cable.
The variable <number> is an integer numeric value between 0 and 30. The
power meter address must be different from the GPIB address of the signal
generator and any other GPIB instrument addresses in your system.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:SYST:COMM:PMET:ADDR 14
The preceding example sets the address to 14 for the power meter that is
connected to and controlled by the signal generator.
This command sets the measurement channel on a dual channel power meter
that is controlled by the signal generator. A single–channel power meter uses
channel A and selecting channel B will have no effect.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command. The power meter is controlled only
through a general purpose instrument bus (GPIB) cable.
This command sets the model number of the power meter that is controlled by
the signal generator. The setting enabled by this command is not affected by a
signal generator power–on, preset, or *RST command. The power meter is
controlled only through a general purpose instrument bus (GPIB) cable.
Example
:SYST:COMM:PMET:IDN E4417A
The preceding example sets the model number for the power meter that is
connected to and controlled by the signal generator.
This command sets the period of time that the signal generator will wait for a
valid reading from the power meter. The variable <num> has a resolution of
0.001.
The variable <num> is the time expressed as a number. The variable
<time_suffix> are the units of time, for example mS (milliseconds) or S
(seconds).
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command. The power meter is controlled only
through a general purpose instrument bus (GPIB) cable. If a timeout occurs,
the signal generator reports an error message.
Example
:SYST:COMM:PMET:TIME .1SEC
The preceding example sets the timeout to 100 milliseconds for the power
meter that is connected to and controlled by the signal generator.
This command sets the baud rate for the rear panel RS–232 interface labeled
RS–232. The setting enabled by this command is not affected by a signal
generator power–on, preset, or *RST command.
The variable <number> is an integer value corresponding to baud rates: 300,
2400, 4800, 9600, 19200, 38400, and 57600.
Example
:SYST:COMM:SER:BAUD 9600
The preceding example sets the baud rate for serial communication to 9600.
This command enables or disables the RS–232 echo, and is not affected by a
power–on, preset, or *RST command. Characters sent to the signal generator
are displayed or echoed to the controller display.
Example
:SYST:COMM:SER:ECHO ON
The preceding example enables RS–232 echoing.
Key Entry RS–232 ECHO Off On
:SERial:RESet
SupportedAll Models
:SYSTem:COMMunicate:SERial:RESet
This event command resets the RS–232 buffer and discards unprocessed SCPI
input received at the RS–232 port.
This command sets the RS–232 serial port timeout value. If further input is not
received within the timeout period specified while a SCPI command is
processed, the command aborts and clears the input buffer. The variable <val>
is entered in seconds. The setting is not affected by a signal generator
power–on, preset, or *RST command.
Example
:SYST:COMM:SER:TOUT 2SEC
The preceding example sets the RS–232 timeout for 2 seconds.
System Commands
Diagnostic Subsystem (:DIAGnostic[:CPU]:INFOrmation)
:LICENse:AUXiliary
SupportedAll Models
:DIAGnostic[:CPU]:INFOrmation:LICense:AUXiliary?
This query returns a listing of current external software application license
numbers for an auxiliary instrument.
Key Entry Auxiliary Software Options
:OPTions
SupportedAll Models
:DIAGnostic[:CPU]:INFOrmation:OPTions?
This query returns a list of options installed in the signal generator.
Key Entry Options Info
:OPTions:DETail
:DIAGnostic[:CPU]:INFOrmation:OPTions:DETail?
This query returns the options installed, option revision, and digital signal
processing (DSP) version if applicable.
:OTIMe
:DIAGnostic[:CPU]:INFOrmation:OTIMe?
This query returns the cumulative number of hours that the signal generator
has been on.
:REVision
:DIAGnostic[:CPU]:INFOrmation:REVision?
Supported All Models
Key Entry Options Info
Supported All Models
Key Entry Diagnostic Info
Supported All Models
This query returns the CPU bootstrap read only memory (boot ROM) revision
date. In addition, the query returns the revision, creation date, and creation
time for the firmware.
This command sets the displayed front panel amplitude units.
If the amplitude reference state is set to on, the query returns units expressed
in dB. Setting any other unit will cause a setting conflict error stating that the
amplitude reference state must be set to off. Refer to :REFerence:STATe
command for more information.
Example
:DISP:ANN:AMPL:UNIT DB
The preceding example sets DB as the amplitude units shown on the signal
generator’s front panel display.
This command selects the date format. The choices are month–day–year
(MDY) or day–month–year (DMY) format. The date is shown on the signal
generator’s front panel display.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:DISP:ANN:CLOC:DATA:FORM DMY
The preceding example sets the date format shown on the signal generator’s
front panel display to DMY.
This command enables or disables the digital clock shown at the lower right
side of the front panel display.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:DISP:ANN:CLOC OFF
The preceding example disables the digital clock on the signal generator’s
front panel display.
:BRIGhtness
SupportedAll Models
:DISPlay:BRIGhtness <val>
:DISPlay:BRIGhtness?
This command sets the display brightness (intensity). The brightness can be
set to the minimum level (0.02), maximum level (1), or in between by using
fractional numeric values (0.03–0.99).
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:DISP:BRIG .45
The preceding example sets display intensity to .45.
This command allows the user to capture the current display and store it in the
signal generator’s memory.
The display capture is stored as DISPLAY.BMP in the Binary file system. This file
is overwritten with each subsequent display capture. The file can be
down–loaded in the following manner:
1. Log on to the signal generator using file transfer protocol (FTP).
2. Change to the BIN directory using the FTP cd command.
3. Retrieve the file by using the FTP get command.
:CONTrast
Supported All Models
Supported All Models
:INVerse
:DISPlay:CONTrast <val>
:DISPlay:CONTrast?
This command sets the contrast for the signal generator’s display. The variable
<val> is expressed as a fractional number between 0 and 1. The contrast can
be set to the maximum level (1), minimum level (0), or in between by using
fractional numeric values (0.001–0.999).
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
Example
:DISP:CONT .45
The preceding example sets the display contrast to .45.
Range 0–1
Key Entry Display contrast hardkeys are located below the display.
Supported All Models
:DISPlay:INVerse ON|OFF|1|0
:DISPlay:INVerse?
This command sets the display of the source to inverse video mode. The setting
enabled by this command is not affected by a signal generator power–on,
preset, or *RST command.
The preceding example sets the display video to normal (not inverse).
Key Entry Inverse Video Off On
Supported All Models
:DISPlay:REMote ON|OFF|1|0
:DISPlay:REMote?
This command enables or disables display updating when the signal generator
is remotely controlled.
ON (1) This choice updates the signal generator display so that
you can see the settings change as the commands are
executed, however, this will decrease the signal
generator’s response time.
OFF (0) This choice turns off display updating which will
optimizing the signal generator’s response time.
The setting enabled by this command is not affected by signal generator preset
or *RST command. However, cycling the signal generator power will reset it to
zero.
Example
:DISP:REM 0
The preceding example turns off display updating.
Key Entry Update in Remote Off On
:SWEep
SupportedAll Models
:DISPlay:SWEep ON|OFF|1|0
:DISPlay:SWEep?
This command disables display updating when the signal generator is in sweep
off mode.
Example
:DISP:SWE
The preceding example turns off display updating.
*RST On (1)
Key Entry Utility->Display->Update->Update in Sweep Off On
The Clear Status (CLS) command clears the Status Byte register, the Data
Questionable Event register, the Standard Event Status register, and the
Standard Operation Status register.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
*ESE
SupportedAll Models
*ESE <val>
*ESE?
This command enables bits in the Standard Event Enable register. Bits enabled
and set in this register will set the Standard Event Status Summary bit (bit 5) in
the Status Byte register. When bit 5 (decimal 32) in the Status Byte register is
set, you can read the Standard Event register using the *ESR command and
determine the cause.
The Standard Event Enable register state (bits enabled with this command) is
not affected by signal generator preset or *RST. The register will be cleared
when the signal generator is turned off unless the command *PSC is used
before turning it off.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
Example
*ESE 129
This command enables bit 0 (decimal 1, Operation Complete) and bit 7
(decimal 128, Power On) in the Standard Event Status Enable register.
Range 0–255
Supported All Models
*ESE?
This query returns the decimal sum of the enabled bits in the Standard Event
Enable register.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
This is a destructive read. The data in the register is latched until it is
queried. Once queried, the data is cleared. Refer to the Keysight Signal
Generators Programming Guide for more information.
*ESR?
This query returns the decimal sum of the bits set in the Standard Event
register.
SupportedAll Models
*IDN?
This query requests an identification string from the signal generator. The IDN
string consists of the following information:
The power–on Status Clear (PSC) command controls the automatic power–on
clearing of the Service Request Enable register, the Standard Event Status
Enable register, and the device–specific event enable registers.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
The setting enabled by this command is not affected by a signal generator
power–on, preset, or *RST command.
ON (1) This choice enables the power–on clearing of the listed
registers.
OFF (0) This choice disables the clearing of the listed registers
and they retain their status when a power–on condition
occurs.
*PSC?
*RCL
Example
*PSC ON
This command clears all listed registers at power–on.
SupportedAll Models
*PSC?
The power–on Status Clear (PSC) query returns the flag (1 or 0) setting as
enabled by the *PSC command.
SupportedAll Models
*RCL <reg>,<seq>
The Recall (RCL) command recalls the state from the specified memory register
<reg> in the specified sequence <seq>.
The Reset (RST) command resets most signal generator functions to a
factory–defined state.
Each command description in this reference shows the *RST value if the signal
generator’s setting is affected.
SupportedAll Models
*SAV <reg>,<seq>
The Save (SAV) command saves the state of the signal generator to the
specified memory register <reg> of the specified sequence <seq>. Settings
such as frequency, attenuation, power, and settings that do not survive a
power cycle or an instrument reset can be saved. Data formats, arb setups, list
sweep values, table entries, and so forth are not stored. Only a reference to the
data file name is saved. Refer to the E8257D/67D, E8663D PSG Signal
Generators User’s Guide and Keysight Signal Generators Programming
Guide for more information on saving and recalling instrument states.
*SRE
Range registers: 0–99 Sequences: 0–9
Key Entry Save Reg Save Seq[n] Reg[nn]
Supported All Models
*SRE <val>
The Service Request Enable (SRE) command enables bits in the Service
Request Enable register. Bits enabled and set in this register will set bits in the
Status Byte register.
The variable <val> is the decimal sum of the bits that are enabled. Bit 6 (value
64) is not available in this register and therefore cannot be enabled by this
command. Because bit 6 is not available, entering values from 64 to 127 is
equivalent to entering values from 0 to 63.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
The setting enabled by this command is persistent, in that it is not affected by
cycling the signal generator power, preset or the *RST command.
The Service Request Enable (SRE) query returns the decimal sum of bits
enabled in the Service Request Enable register. Bit 6 (decimal 64) is not
available in this register.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
Range 0 to 63, 128 to 191
Supported All Models
*STB?
This command reads the decimal sum of the bits set in the Status Byte register.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
Range0 to 255
*TRG
*TST?
*WAI
SupportedAll Models
*TRG
The Trigger (TRG) command triggers the device if BUS is the selected trigger
source, otherwise, *TRG is ignored. For more information on triggers; refer to
“:TRIGger[:SEQuence]:SOURce” on page 125.
Supported All Models
*TST?
The Self–Test (TST) query initiates the internal self–test and returns one of the
following results:
0 This shows that all tests passed.
1 This shows that one or more tests failed.
Key Entry Run Complete Self Test
Supported All Models
*WAI
The Wait–to–Continue (WAI) command causes the signal generator to wait
until all pending commands are completed, before executing any other
commands.
This command outputs a list of binary files. The return data will be in the
following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry Binary
:CATalog:BIT
SupportedE8267D with Option 601 or 602
:MEMory:CATalog:BIT?
This command outputs a list of bit files. The return data will be in the following
form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry Bit
:CATalog:DMOD
SupportedE8267D with Option 601 or 602
:MEMory:CATalog:DMOD?
This command outputs a list of arbitrary waveform digital modulation files. The
return data will be in the following form:
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
:CATalog:FIR
:MEMory:CATalog:FIR?
This command outputs a list of finite impulse response (FIR) filter files. The
return data will be in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
Key Entry DMOD
Supported E8267D with Option 601 or 602
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
:CATalog:FSK
:MEMory:CATalog:FSK?
This command outputs a list of frequency shift keying (FSK) files. The return
data will be in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
This command outputs a list of IQ files. The return data will be in the following
form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
:CATalog:LIST
Supported E8267D with Option 601 or 602
Key Entry I/Q
Supported All Models
:MEMory:CATalog:LIST?
This command outputs a list of List Sweep files. The return data will be in the
following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry List
:CATalog:MDMod
SupportedE8267D with Option 601 or 602
:MEMory:CATalog:MDMod?
This command outputs a list of arbitrary waveform multicarrier digital
modulation (MDMod) files. The return data will be in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}.
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
Refer to File Name Variables for information on the file name syntax.
Key Entry MDMOD
:CATalog:MTONe
SupportedE8267D with Option 601 or 602
:MEMory:CATalog:MTONe?
This command outputs a list of arbitrary waveform multitone files. The return
data will be in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry MTONE
:CATalog:SEQ
SupportedE8267D with Option 601 or 602
:MEMory:CATalog:SEQ?
This command outputs a list of arbitrary waveform sequence files. The return
data will be in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry Seq
:CATalog:SHAPe
SupportedE8267D with Option 601 or 602
:MEMory:CATalog:SHAPe?
This command outputs a list of burst shape files. The return data will be in the
following form:
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry Shape
:CATalog:STATe
SupportedAll Models
:MEMory:CATalog:STATe?
This command outputs a list of state files. The return data will be in the
following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
Key Entry State
:CATalog:UFLT
SupportedAll Models
:MEMory:CATalog:UFLT?
This command outputs a list of user–flatness correction files. The return data
will be in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the directory. Each file listing parameter
will be in the following form:
"<file_name,file_type,file_size>"
Refer to File Name Variables for information on the file name syntax.
This command outputs a list of all files in the memory subsystem, but does not
include files stored in the Option 601 or 602 baseband generator memory. The
return data is in the following form:
<mem_used>,<mem_free>{,"<file_listing>"}
The signal generator returns the two memory usage parameters and as many
file listings as there are files in the memory subsystem. Each file listing
parameter is in the following form:
"<file_name,file_type,file_size>"
Refer to Table 2-11 for file types, and to File Name Variables for file name
syntax.
Key Entry All
:COPY[:NAME]
SupportedAll Models
:MEMory:COPY[:NAME] "<src_name>","<dest_name>"
:DATA
This command copies the data from one file into another file. The file can use
the same name if the specified directory is different. For example, if the file
resides in non–volatile waveform memory (NVWFM) it can be copied, using the
same name, to the signal generator’s volatile memory (WFM1).
When copying a waveform or marker file from volatile to non-volatile memory,
the associated marker or waveform file is also copied.
"<src_name>" This variable names a file residing in memory that will
be copied. For information on the file name syntax, refer
to “File Name Variables” on page 11.
"<dest_name>" This variable names the file that is a copy of the
"<src_name>" file.
Example
:MEM:COPY "/USER/IQ/4QAM","/USER/IQ/test_QAM"
The preceding example copies the 4QAM file in the signal generator’s
/USER/IQ directory to a file named test_QAM and saves it in the same
directory.
This command loads waveform data into signal generator memory using the
<data_block> parameter and saves the data to a file designated by the
"<file_name>" variable. The query returns the file contents of the file as a
datablock.
The waveform file must be located in volatile waveform memory (WFM1) before
it can be played by the signal generator’s Dual ARB player. For downloads
directly into volatile waveform memory use the path "WFM1:<file_name>". For
downloads to non–volatile waveform memory, use the path
"NVWFM:<file_name>".
Refer to File Name Variables for information on the file name syntax.
"<file_name>" This variable names the destination file, including the
directory path. Refer to ARB Waveform File Directories
for information on directory paths and the file name
syntax.
<data_block> This parameter represents the data and file length
parameters. The data in the file is represented by the
<data_block> variable.
Refer to the Keysight Signal Generators Programming Guide for more
information on programming the status registers.
ARB waveform files created using the
:DATA command cannot be retrieved
or uploaded. Attempting to do so will cause the signal generator to display
the message: ERROR:221, Access denied. To download ARB data to files
for later retrieval, use the
:DATA:UNPRotected command on page 61.
Example
:MEM:DATA "NVWFM:IQ_Data",#210Qaz37pY9oL
The preceding example downloads 10 bytes of data to a file, IQ_Data., in the
signal generator’s non–volatile memory. The table shown below describes the
command parameters.
Table 2-1
— "NVWFM:IQ_Data"IQ_Data is the data filename. The d irectory path is specified
along with the filename
— #210Qaz37pY9oLData block
#This character indicates the beginning of the data block
This commands appends data to an existing file stored in signal generator
memory.
"<file_name>" This variable names the destination file and directory
<data_block> This parameter represents the data and file length
Refer to the Keysight Signal Generators Programming Guide for more
information on downloading and using files.
path. Refer to File Name Variables for information on
the file name syntax.
parameters. The data in the file is represented by the
<data_block> variable. The file length parameters are
used
by the signal generator for allocating memory.
Example
:MEM:DATA:APPend "NVWFM:IQ_Data",#14Y9oL
The preceding example downloads and appends the data, Y9oL, to an existing
file named IQ_Data stored in the signal generator’s non–volatile memory
(NVWFM).
— "NVWFM:IQ_Data"IQ_Data is the filename to append data to. The directory path
is specified along with the filename.
— #14Y9oLData block
#This character indicates the beginning of the data block
1Number of digits in the byte count
4Byte count
Y9oL4 bytes of data
SupportedE8267D with Option 601 or 602
This command loads bit data into signal generator memory using the
<bit_count> and <data_block> parameters and saves the data to a file
designated by the "<file_name>" variable. The query returns the bit count, file
length information, and the data.
"<file_name>" This variable names the destination file and the
directory path. Refer to File Name Variables for
information on the file name syntax.
<bit_count> This number represents the number of bits in the data
block.
<data_block> This parameter represents the data and file length
parameters. The data in the file is represented by the
<data_block> variable. The file length parameters are
used
by the signal generator for allocating memory.
Refer to the Keysight Signal Generators Programming Guide for more
information on downloading and using files.
Example
:MEM:DATA:BIT "/USER/BIT/Test_Data",16,#12Qz
The preceding example downloads bit data to the file, Test_Data. The table
below describes the command parameters.
This command loads oversample ratio (OSR) and user–defined finite impulse
response (FIR) coefficient data into a file in the signal generator’s non–volatile
memory (NVWFM). The query returns the oversample ratio and coefficient
data.
— "/USER/BIT/Test_Data"Test_Data is the bit data filename. The directory path is
specified along with the filename
—16Number of bits in the data block
— #12QzData block
#This character indicates the beginning of the data block
1Number of digits in the byte count
2Byte count
Qz16 bits of data (ascii representation of bit data)
SupportedE8267D with Option 601 or 602
"<file_name>" This variable is the directory path and file name of the
destination file. Refer to File Name Variables for
information on the file name syntax.
osr The OSR is the number of filter taps per symbol.
coefficient This variable is the FIR coefficient. The maximum
The preceding example downloads a four–level FSK data to a file named 4FSK
that has four states (frequencies): −2kHZ, −1kHZ, 2kHZ, 1kHZ; differential
encoding is toggled ON, and there are two differential states 1 and 0. The table
shown below describes the command parameters.
Table 2-4
— "/USER/FSK/4FSK"4FSK is the FSK data filename. The directory path is specified
This command loads bit data into signal generator memory using the
<bit_count> and <data_block> parameters and saves the data to a file
designated by the "<file_name>" variable. The query returns the bit count, file
length information, and the data.
"<file_name>" This variable names the destination file and the
<bit_count> This number represents the number of bits in the data
<data_block> This parameter represents the data and file length
directory path. Refer to File Name Variables for
information on the file name syntax.
block.
parameters. The data in the file is represented by the
<data_block> variable. The file length parameters are
used by the signal generator for allocating memory.
:DATA:IQ
Refer to the Keysight Signal Generators Programming Guide for more
information on downloading and using files.
"<file_name>" This variable string identifies the name of the I/Q file.
The filename must be enclosed with quotation marks.
Refer to File Name Variables for information on the file
name syntax.
<offsetQ> This variable enables (1) or disables (0) the Q output
delay by 1/2 symbol from the I output.
<num_states> This is the number of symbols.
<i0>...<i(n)> This is the I value of the first and subsequent I symbols.
<q0>...<q(n)> This is the Q value of the first and subsequent Q
symbols.
<diff_state> This variable enables and disables differential encoding.
<num_diff_states> This variable identifies the number of differential
states.
<diff0> This variable identifies the value of the first differential
state.
<diff1,...diff(n)> This variable identifies the value of the second and
subsequent differential states.
Refer to the Keysight Signal Generators Programming Guide for more
information on downloading and using files.
Example
:MEM:DATA:IQ "/USER/IQ/Test_BPSK",1,2,1,0,0,0
The preceding example loads and stores a two–symbol I/Q file named
Test_BPSK that has a Q offset. The table shown below describes the
command parameters.
Table 2-6
— "/USER/IQ/Test_BPSK"Test_Data is the bit data filename. The d irectory path is
This command loads block–formatted data directly into pattern RAM volatile
memory (WFM1). Pattern RAM memory describes how memory (WFM1) is
used and is not a distinct piece of memory. A PRAM file is specified as an array
of bytes. No directory path name is needed.
i0–i(
n):
q0–q(
n):
num_diff_stat
es:
diff0–diff(
n):
−1
to 1
−1
to 1
0–2
56
–128 to
127
"<file_name>" This variable names the destination file. Refer to File
Name Variables for information on the file name syntax.
<data_block> This parameter represents the data and file length
parameters. The data in the file is represented by the
<data_block> variable. The file length parameters are
used
by the signal generator for allocating memory.
Pattern Ram files are binary files downloaded directly into waveform memory
as an array of bytes. Each byte specifies a data bit (LSB 0), a burst bit (BIT 2),
and an Event 1 output bit (BIT 6). Refer to the Keysight Signal Generators Programming Guide for more information on downloading and using files.
This command loads list–formatted data directly into pattern RAM volatile
memory (WFM1). Pattern RAM memory describes how memory (WFM1) is
used and is not a distinct piece of memory. A PRAM file is specified as an array
of bytes.
This command should be preceded by a *WAI (Wait–to–Continue)
command to ensure that all pending operations are completed, before
loading the list.
"<file_name>" This variable names the destination file. Refer to File
Name Variables for information on the file name syntax.
<uint8> This variable is any of the valid 8–bit, unsigned integer
values between 0 and 255.
[,<uint8>,<...>] This variable identifies the value of the second and
subsequent 8–bit unsigned integer variables.
Pattern Ram files are binary files downloaded directly into waveform memory
as an array of bytes. Each byte specifies a data bit (LSB 0), a burst bit (BIT 2),
and an Event 1 output bit (BIT 6). Refer to the Keysight Signal Generators
Programming Guide for more information on downloading and using files.
The preceding example downloads PRAM data, in list format, to a file named
Pram_Data in the signal generator’s volatile memory (WFM1).
Table 2-8
— "Pram_Data"Pram_Data is the data filename. PRAM files are saved to the
—85The first 8–bit integer value
— 21,21,20,20,100Subsequent 8–bit integer values.
:DATA:PRAM?
This query is no longer supported; however, it is still valid for backward
compatibility. Refer to “:DATA:PRAM?” on page 419 for information on this
command.
signal generator’s non–volatile memory (WFM1).
Range0 to 255
:DATA:PRAM:BLOCk
This command has been replaced by “:DATA:PRAM:FILE:BLOCk” on
page 58. This command is no longer supported; however, it is still valid for
backward compatibility. Refer to “:DATA:PRAM:BLOCk” on page 419 for
information.
:DATA:PRAM:LIST
This command has been replaced by “:DATA:PRAM:FILE:LIST” on page 59.
This command is no longer supported; however, it is still valid for
backward compatibility. Refer to “:DATA:PRAM:LIST” on page 419 for
information.
This command allows you to download data and store it in a file on the signal
generator with the ability to retrieve it. This command is intended for
downloading waveform data; however, you can use it to download all types of
data.
If you do not use the
UNPRotected command when downloading a
waveform file, you will not be able to retrieve or upload the file. Attempting
to do so will cause the signal generator to display the message:
ERROR:221, Access denied.
The UNPRotected command does not require the directory path in the
"<file_name>" parameter if the destination directory is BINARY.
Waveform files created with Keysight’s Signal Studio are encrypted. These files
can be used in other signal generators (provided the other signal generator has
the same options and licenses required by the file) only if the SECUREWAVE
directory path is specified in both the download and upload command
parameters. The securewave directory path is SNVWFM: for non–volatile
waveform memory and SWFM1: for volatile waveform memory.
"<file_name>" This variable names the destination file and directory
path. Refer to File Name Variables for information on
the file name syntax.
<data_block> This parameter represents the data and file length
parameters. The data in the file is represented by the
<data_block> variable.
Refer to the Keysight Signal Generators Programming Guide for more
information on downloading and using files.
Example
:MEM:DATA:UNPR "NVWFM:Data_File",#18Qz37pY9o
The preceding example downloads waveform data to a file named Data_File in
the signal generator’s non–volatile memory. The table shown below describes
the command parameters.
Table 2-10
— "NVWFM:Data_File"Data_File is the data filename. The d irectory path is implied
along with the filename.
— #18Qz37pY9oData block
#This character indicates the beginning of the data block
Using this command deletes all user files including binary, list, state, and
flatness correction files, and any saved setups that use the front panel
table editor. However, this does not include files stored in the Option
601 or 602 baseband generator memory. You cannot recover the files after
executing this command.
:MEMory:DELete:ALL
This command clears the file system of all user files.
Key Entry Delete All Files
:DELete:BINary
SupportedAll Models
:MEMory:DELete:BINary
This command deletes all binary files.
Key Entry Delete All Binary Files
:DELete:BIT
SupportedE8267D with Option 601 or 602
:MEMory:DELete:BIT
This command deletes all bit files.
Key Entry Delete All Bit Files
:DELete:DMOD
SupportedE8267D with Option 601 or 602
:MEMory:DELete:DMOD
This command deletes all arbitrary waveform digital modulation (DMOD) files.
Key Entry Delete All ARB DMOD Files
:DELete:FIR
SupportedE8267D with Option 601 or 602
:MEMory:DELete:FIR
This command deletes all finite impulse response (FIR) filter files.
This command lets you to add a descriptive comment to the saved instrument
in the state register, <reg_num>,<seq_num>. Comments can be up to 55
characters long.
Example
:MEM:STAT:COMM 00,1, "ARB file using external reference"
The preceding example writes a descriptive comment to the state file saved in
register 00, sequence 1.
:STORe:LIST
:MEMory:STORe:LIST "<file_name>"
This command stores the current list sweep data to a file.
Refer to File Name Variables for information on the file name syntax.
Supported All Models
Key Entry Add Comment To Seq[n] Reg[nn]
Supported All Models
Example
:MEM:STOR:LIST "Test_Data"
The preceding example writes list sweep data to a file named Test_Data and
stores the file in the signal generator’s non–volatile memory, List directory.
This command outputs a list of the files from the specified file system. The
variable "<msus>" (mass storage unit specifier) represents a file system. The
file systems and types are shown in Tab le 2-11.
Table 2-11
File SystemFile Type
BIN – Binary fileBIN
BITBIT
DMOD – ARB digital modulation fileDMOD
FIR – finite impulse response filter fileFIR
FSK – frequency shift keying modulation fileFSK
I/Q – modulation fileIQ
LIST – sweep list fileLIST
MDMOD – ARB multicarrier digital modulation fileMDM
The signal generator will return the two memory usage parameters and as
many file listings as there are files in the specified file system. Each file listing
will be in the following format:
Refer to MSUS (Mass Storage Unit Specifier) Variable for information on the
use of the "<msus>" variable.
:COPY
Key Entry
Supported All Models
:MMEMory:COPY[:NAME] "<src_name>","<dest_name>"
This command copies the data from one file into another file. The file can use
the same name if the specified directory is different. For example, if the file
resides in non–volatile waveform memory (NVWFM) it can be copied, using the
same name, to the signal generator’s volatile memory (WFM1)
"<src_name>" This variable names a file residing in memory that will
"<dest_name>" This variable names the file that is a copy of the
BitI/QShapeMTONEDMOD
Seq ListBinaryNVMKRNVMFM
FIRStateWFM1MDMODUser
Flatness
FSK
be copied. For information on the file name syntax, see
File Name Variables.
"<src_name>" file.
:DATA
Example
:MMEM:COPY "/USER/IQ/4QAM","/USER/IQ/test_QAM"
The preceding example copies the 4QAM file in the signal generator’s
/USER/IQ directory to a file named test_QAM and saves it in the same
directory.
This command loads waveform data into signal generator memory using the
<data_block> parameter and saves the data to a file designated by the
"<file_name>" variable. The query returns the file contents of the file as a
datablock.
The waveform file must be located in volatile waveform memory (WFM1) before
it can be played by the signal generator’s Dual ARB player. For downloads
directly into volatile waveform memory use the path "WFM1:<file_name>". For
downloads to non–volatile waveform memory, use the path
"NVWFM:<file_name>".
Refer to File Name Variables for information on the file name syntax.
"<file_name>" This variable names the destination file, including the
directory path. Refer to ARB Waveform File Directories
for information on directory paths and the file name
syntax.
<data_block> This parameter represents the data and file length
parameters. The data in the file is represented by the
<data_block> variable. The file length parameters are
used
by the signal generator for allocating memory.
Refer to the Keysight Signal Generators Programming Guide for more
information on downloading and using files.
Files created using the
:DATA command cannot be retrieved or uploaded.
Attempting to do so will cause the signal generator to display the
message: ERROR:221, Access denied. To download data to files for later
retrieval, use the
:DATA:UNPRotected command on page 61.
Example
:MMEM:DATA "NVWFM:IQ_Data",#210Qaz37pY9oL
The preceding example downloads 10 bytes of data to a file, IQ_Data., in the
signal generator’s non–volatile memory. The table shown below describes the
command parameters.
Table 2-13
— "NVWFM:IQ_Data"IQ_Data is the data filename. The d irectory path is specified
along with the filename
— #210Qaz37pY9oLData block
#This character indicates the beginning of the data block
This command clears the memory file system of all non–volatile arbitrary
waveform (NVWFM) files.
Key Entry Delete All NVWFM Files
:DELete:WFM
SupportedE8267D with Option 601 or 602
:MMEMory:DELete:WFM
This command clears the memory file system of all volatile arbitrary waveform
files. For backwards compatible command, refer to “:DELete:WFM1” on
page 420.
Key Entry Delete All WFM Files
:DELete[:NAME]
SupportedAll Models
:MMEMory:DELete[:NAME] "<file_name>",["<msus>"]
This command clears the memory file system of "<file_name>" with the option
of specifying the file system ["<msus>"] separately.
The variable "<msus>" (mass storage unit specifier) represents the file system.
For a list of the file systems refer to Table 2-11. For information on the mass
storage unit specifier, refer to “MSUS (Mass Storage Unit Specifier) Variable”
on page 13.
If the optional variable "<msus>" is omitted, the file name needs to include the
file system extension. Refer to File Name Variables for information on the file
name syntax.
The preceding examples delete the file named Test_Data from the signal
generator’s USER/BIN directory. The first example uses the full file name path
while the second example uses the "<msus>" specifier.
This command deletes header file information for the waveform file
"<file_name>". This command does not require a personality modulation to be
on. The header file contains signal generator settings and marker routings
associated with the waveform file. Refer to File Name Variables for information
on the file name syntax.
Example
:MMEM:HEAD "/USER/WAVEFORM/Test_Data"
The preceding example deletes header file information for the Test_Data
waveform file.
This command inserts a description for the header file named. The header
description is limited to 32 characters.
Refer to File Name Variables for information on the file name syntax.
Example
:MMEM:HEAD:DESC "/USER/WAVEFORM/Test_Data","This is new header
data"
The preceding example inserts a description into the Test_Data header file. In
this example, the file is located in the signal generator’s non–volatile waveform
memory.
:HEADer:ID?
MMEMory:HEADer:ID?
This query returns a unique waveform identification.
Refer to File Name Variables for information on the file name syntax.
This command sets the state for automatic RF Output blanking. Blanking
occurs when the RF output is momentarily turned off as the sweep transitions
from one frequency segment (band) to another, allowing the signal to settle.
Blanking also occurs during the retrace, so the signal can settle before the next
sweep. In CW mode, blanking occurs whenever you change the frequency.
ON (1) This choice activates the automatic blanking function.
The signal generator determines the blanking
occurrences for optimum performance.
OFF (0) This choice turns off the automatic blanking function,
which also sets the blanking state to off.
Example
:OUTP:BLAN:AUTO 0
The preceding example disables RF output blanking.
This command sets the state for RF Output blanking. Blanking occurs when the
RF output is momentarily turned off as the sweep transitions from one
frequency segment (band) to another, allowing the signal to settle. Blanking
also occurs during the retrace, so the signal can settle before the next sweep.
In CW mode, blanking occurs whenever you change the frequency.
ON (1) This choice activates the blanking function. Blanking
OFF (0) This choice turns off the blanking function.
Example
:OUTP:BLAN:ON
occurs on all frequency changes, including segment
transitions and retrace
This command enables or disables the modulation of the RF output with the
currently active modulation type(s). Most modulation types can be
simultaneously enabled except FM with ΦM.
An annunciator on the signal generator always displays to indicate whether
modulation is on or off.
Example
:OUTP:MOD 0
The preceding example disables RF modulation.
*RST 1
Key Entry Mod On/Off
:SETTled?
SupportedAll Models
:OUTPut:SETTled?
This command returns the current state of the source settled line. A “1” return
value indicates the source is settled. A “0” return value indicates the source is
unsettled. This command does not wait for the source to settle before returning
the state. This is different than the *OPC? command which delays the
command response until the operation is complete.
An annunciator always displays on the signal generator to indicate whether the
RF output is on or off.
This command sets the polarity of the source settled line (also referred to as:
“lock and level”). When the active polarity is set to NORMal, the source settled
line will be TTL low level whenever the source is settled. If the active polarity is
set to INVerted, the source will be TTL high level whenever the source is
settled. (This is the default condition.)
An annunciator always displays on the signal generator to indicate whether the
RF output is on or off.
NORMal This choice indicates the source is settled by setting this
INVerted This choice indicates the source is settled by setting this
This command sets the source settled state (also referred to as: “lock and
level”) when a step or list sweep is armed and waiting for an external trigger
input. In the “NORMal” mode, the source settled output indicates “Settled”; in
the “INVerted” mode, the source settled output indicates “Not Settled.” This
command is coupled to the “:SETTled:POLarity” on page 75 command. If the
“:SETTled:POLarity” on page 75 command is “INVerted” and the retrace mode
is “INVerted”, the source settled ouput will be at a TTL low level when the step
or list sweep is armed and waiting for an external trigger input. (This is the
default condition.)
An annunciator always displays on the signal generator to indicate whether the
RF output is on or off.
NORMal This choice indicates the source is settled when waiting
for an external trigger.
INVerted This choice indicates the source is not settled when
waiting for an external trigger. (This is the default
condition.)