Tektronix TSG4100A Series Operating and maintenance manual

TSG4100A Series
RF Signal Generators
ZZZ
Programmer Manual
xx
www.tektronix.com
077-1079-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.

Table of Contents
Preface.............................................................................................................. iii
Related Documentation ...................................................................................... iii
Getting started...... .................................. .................................. .......... ................. 1-1
Overview of the manual..................................................................................... 1-1
Connecting the interface .................................................................................... 1-1
Using NI-VISA .............................................................................................. 1-2
Syntax and Commands
Command Syntax................................................................................................. 2-1
Backus-Naur Form Definition . .... .... ..... .... ..... .... .... .... ..... .... ..... .... .... .... .... ..... .... .... 2-1
Syntax......................................................................................................... 2-1
IEEE 488.2 Common Commands.......................................................................... 2-4
Command Groups ................................................................................................ 2-6
Functional Groups ........................................................................................... 2-6
Common Commands............................................................................................. 2-7
Interface Commands ............................................................................................. 2-8
Modulation commands........................................................................................... 2-9
Basic analog modulation configuration.................................................................. 2-10
Basic vector modulation configuration.................................................................. 2-11
Signal Synthesis Commands .................................................................................. 2-13
Basic signal configuration ................................................................................ 2-13
Status Commands............................................................................................... 2-14
Retrieving Response Message................................................................................. 2-15
Command Descriptions........................................................................................ 2-16
Status and Errors
Status and Events................................................................................................. 3-1
Status byte register........................................................................................... 3-1
Standard Event Status Register............................................................................. 3-2
Instrument Status Register.................................................................................. 3-3
Event markers and TDMA.................................................................................. 3-3
................................................................................................................. 3-4
Error messages and codes ....................................................................................... 3-5
Execution errors.............................................................................................. 3-5
Query errors .................................................................................................. 3-6
Device specific errors ....................................................................................... 3-6
File system errors............................................................................................ 3-7
Parsing errors................................................................................................. 3-7
TSG4100A Series Programmer Manual i

Table of Contents
Communication errors....................................................................................... 3-8
Other errors................................................................................................... 3-9
Appendices
Appendix A: Character Charts ................................................................................. A-1
Appendix B: GPIB Interface Specification ................................................................... B-1
Interface Functions ......................................................................................... B-1
Interface Messages ......................................................................................... B-2
ii TSG4100A Series Programmer Manual

Preface
This programmer manual covers the TSG4100A Series RF Signal Generators. It
provides information on operating your generator using LAN, the General Purpose
Interface Bus (GPIB), and RS-232.
This manual is composed of the following sections
Getting Started outlines how to use LAN, the GPIB interface, and RS-232.
Syntax and Commands defines the syntax used in command descriptions,
presents a list of all command subsystems, and presents detailed descriptions
of all programming commands.
Status and Events describes how the status and Events Reporting system
operates and presents a list of all system errors.
Appendices provides additional information including character charts, LAN
specifications, GPIB interface specifications, RS-232 interface specifications,
and factory initialization settings.
Related Documentation
The following documents provide operating information for the TSG4100A
Series instruments. They are available on the Tektronix Web site at
www.tektronix.com/manuals.
TSG4100A Series RF Signal Generator User Manual
This manual contains detailed operating, UI navigation, and other information
to help you operate the instrument.
TSG4100A Series RF Signal Generator Specifications and Performance
Verification Technical Reference
This technical reference contains specifications and performance verification
information.
TSG4100A Series RF Signal Generator Installation and Safety Instructions
This manual provides basic installation information for getting started using
the instrument. It also includes safety, compliance, and environmental
information. It is available in both English and Russian.
TSG4100A Series Programmer Manual iii

Preface
iv TSG4100A Series Programmer Manual

Getting started
To help you get started with programming this instrument, this section includes
the following subsections.
Overview of the manual
Summarizes each major section of this manual.
Connecting the interface
Describes interface options.
Using NI-VISA
Describes how to download the NI-VISA communication protocol.
Overview of the manual
The information contained in each major section of this manual is described below.
Syntax and Commands Syntax and Commands, describes the structure and content of the messages your
program sends to the generator. This section also describes the effect of each
command and provides examples of how you might use it.
The Command Groups subsection provides lists by functional areas. The
commands are listed alphabetically in the Command Descriptions section.
Status and Events The program may request information from the instrument. The instrument
provides information in the form of status and error messages. The Status and
Events section describes how to get status or event information from the program
and details the event and error messages.
Connecting the interface
You can use the LAN connector or the GPIB or RS-232 interfaces to send/receive
remote commands.
When using a GPIB or RS-232 interface, remember the following:
TSG4100A Series Programmer Manual 1-1

Getting started
Assign a unique device address to each device on the bus. No two devices
can share the same device address.
Do not connect more than 15 devices to any one bus.
Connect one device for every 2 m (6 ft) of cable used.
Do not use more than 20 m (65 ft) of cable to connect devices to a bus.
Turn on at least 2/3 of the devices on the network while using the network.
Connect the devices on the network in a star or linear configuration, as shown
in the following figure. Do not use loop or parallel configurations.
Using NI-VISA
NI (National Instruments) VISA (Virtual Instrument Software Architecture)
provides a common standard for software developers so that software from
multiple vendors, such as instrument drivers, can run on the same platform.
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 the VISA specification for controlling GPIB and serial (RS-232)
instrument interfaces locally or remotely through an Ethernet LAN connection.
Installation Use an internet browser to access the National Instruments Web site and download
the current version of NI-VISA to your PC. Unzip the downloaded file in a
temporary directory of your choice and run Setup.exe.
1-2 TSG4100A Series Programmer Manual

Syntax and Commands

Command Syntax
This section contains information on the Standard Commands for Programmable
Instruments (SCPI) and IEEE 488.2 Common Commands you can use to program
your TSG4100A Series generator. The information is organized in the following
subsections:
Backus-NaurFormDefinition
Syntax
IEEE 488.2 Common Commands
Backus-Naur Form Definition
This manual may describe commands and queries using the Backus-Naur Form
(BNF) notation. The following table defines the standard BNF symbols.
Table 2-1: BNF symbols and meanings
Symbol Meaning
<> Defined element
:= Is defined as
| Exclusive OR
{ } Group; one element is required
[] Optional; can be omitted
( ) Comment
NOTE. Parameters (elements) listed without any surrounding characters are
always required.
Commands are terminated by a semicolon, a <CR> (ASCII 13), or a <LF> (ASCII
10). If the communications interface is GPIB, then the terminating character may
optionally be accompanied by an EOI signal. If the EOI accompanies a character
other than a <LF>, a <LF> will be appended to the command to terminate it.
Execution of the command does not begin until a command terminator is received.
Syntax
All commands use ASCII characters, are four characters long, and are
case-insensitive. Standard IEEE-488.2 defined commands begin with the ‘*’
character followed by three letters. Instrument specificcommandsarecomposed
of four letters.
TSG4100A Series Programmer Manual 2-1

Command Syntax
The four letter mnemonic (shown in capital letters) in each command sequence
specifies the command. The rest of the sequence consists of parameters. For
example:
DELW 1
Sets and queries Commands may take either set or query form, depending on whether the ‘?’
character follows the mnemonic. Set only commands are listed without the ‘?’,
query only commands show the ‘?’ after the mnemonic, and query optional
commands are marked with a ‘(?)’.
Set commands specify actions for the instrument to perform. Query commands
return measurement data and information about parameter settings.
NOTE. Donotsend()or{}or[]orspacesaspartofthecommand.
Query responses When a query is sent to the instrument, only the values are returned, as shown
in the following table.
Table 2-2: Query response examples
Query Response
CATL?0,512,1,0,2,128,3,0,4,0,5,0,6,0,7,0,8,0,9,0,10,
173696,11,720,12,128,13,79,14,235,15,
76800, 1044480
CNST? 2
A few queries also initiate an operation action before returning information. For
example, the ERAS? query erases all user waveforms and then returns the free
nonvolatile memory in 16-bit words.
Errors and failures Aside from communication errors, commands may fail due to either syntax or
execution errors. Syntax errors can be detected by looking at bit 5 (CME) of the
event status register (*ESR?). Execution errors can be detected by looking at bit
4(EXE) of the event status register. In both cases, an error code, indicating the
specific cause of the error, is appended to the error queue. The error queue may be
queried with the LERR? command. Descriptions of all error codes can be found
in the section Error Codes. (See page 3-5.)
The command buffer is limited to 768 bytes, with 25 byte buffers allocated to each
of up to 3 parameters per command. If the command buffer overflows, both the
input and output buffers will be flushed and reset. If a parameter buffer overflows,
a command error will be generated and the offending command discarded.
TSG4100A Series Programmer Manual 2-2

Command Syntax
Parameter conventions The command descriptions use parameters, such as i, f, and v. These parameters
represent integers or floating point values expected by the command. The
parameters follow the conventions summarized in the following table.
Table 2-3: Available units and parameter conventions
Parameter Meaning
Arbitrary
block 1
A specified length of arbitrary data.
#512234xxxxx . . . where 5 indicates that the following 5 digits (12234)
specify the length of the data in bytes; xxxxx ... indicates the data
Hexadecimal 2Hexadecimal numbers (0-9, A, B, C, D, E, F).
#HAA, #H1
i, j, k An integer value.
dAfloating point value.
fAfloating point value representing a frequency in Hz.
pAfloating point value representing a phase in degrees.
tAfloating point value representing time in seconds.
vAfloating point value representing voltage in volts.
An identifier of units. Allowed units are:
Type Allowed units
Amplitude ‘dBm’, ‘rms’, ‘Vpp’
Frequency ‘GHz’, ‘MHz’, ‘kHz’, or ‘Hz’
u
Time ‘ns’, ‘us’, ‘ms’, or ‘s’
1Defined in ANSI/IEEE 488.2 as "Definite Length Arbitrary Block Response Data."
2An ANSI/IEEE 488.2-1992-defined parameter type.
3Some commands and queries will accept an octal or hexadecimal value even though the parameter type is
defined as NR1.
You can omit a unit in a command, but you must include the unit when using a SI
prefix. For example, frequency of 15 MHz can be described as follows
15.0E6, 1.5E7Hz, 15000000, 15000000Hz, 15MHz, etc.
("15M" is not allowed.)
Note that you can use either lower or upper case units and prefixes. The following
examples have the same result, respectively.
170mhz, 170mHz, 170MHz, etc.
250mv, 250mV, 250MV, etc.
Numeric conventions Floating point values may be decimal (‘123.45’) or scientific (‘1.2345e2’). Integer
values may be decimal (‘12345’) or hexadecimal (‘0x3039’).
2-3 TSG4100A Series Programmer Manual

Command Syntax
General Rules Here are three general rules for using commands, queries, and parameters:
You can use upper case, lower case, or a mixture of both cases for all
commands, queries, and parameters.
FDEV 10 kHz
is the same as
FDEv 10 kHz
IEEE 488.2 Common Commands
Description ANSI/IEEE Standard 488.2 defines the codes, formats, protocols, and usage of
common commands and queries used on the interface between the controller and
the instruments. The generator complies with this standard.
TSG4100A Series Programmer Manual 2-4

Command Syntax
Command and Query
Structure
The syntax for an IEEE 488.2 common command is an asterisk (*) followed by a
command and, optionally, a space and parameter value. The syntax for an IEEE
488.2 common query is an asterisk (*) followed by a query and a question mark.
All of the common commands and queries are listed in the last part of the Syntax
and Commands section. The following are examples of common commands:
*ESE 16
*CLS
The following are examples of common queries:
*ESR?
*IDN?
2-5 TSG4100A Series Programmer Manual

Command Groups
Command Groups
This section lists the instrument commands in two ways. It first presents them by
functional groups. It then lists them alphabetically. The functional group list starts
below. The alphabetical list provides more detail on each command.
Items followed by question marks are queries; items without question marks are
commands. Some items in this section have a question mark in parentheses () in
the command header section; this indicates that the item can be both a command
and a query.
For the conventions of notation in this manual, refer to Command Syntax and
following pages.
Functional Groups
All commands are divided into groups as shown in the following table.
Table 2-4: Command groups
Command group Function
Common Conforms to the IEEE Std 488.2.
Status Controls the status and event registers.
Signal Synthesis Controls signal parameters.
Modulation Controls the modulation settings and parameters.
Interface Controls interface settings and parameters.
The following section lists the commands by group.
TSG4100A Series Programmer Manual 2-6

Common Commands
Common Commands
The IEEE 488.2 common commands have a "*" prefix.
Table 2-5: Common commands
Header Description
*CAL? Performs an internal self-calibration.
*CLS Clears status.
*ESE(?){i} Sets or queries the bits in the SESE register.
*ESR? Returns the contents of the SESR register.
*IDN? Returns the instrument identification code.
*OPC(?) Synchronizes commands.
*PSC(?){i} Clears power on status.
*RCL iRecalls instrument settings.
*RST Returns the instrument settings to the factory defaults.
*SAV i Saves instrument settings.
*SRE(?){i} Sets or queries the bits in the SRER register.
*STB? Returns the contents of the SBR using the MSS bit.
*TRG Generates a trigger.
*TST? Self test.
*WAI Prevents the generator from executing further commands.
2-7 TSG4100A Series Programmer Manual

Interface Commands
Interface Commands
Use the Interface commands to control instrument interface actions.
Table 2-6: Interface commands
Header Description
EMAC? Query the Ethernet MAC address.
EPHY(?){i} Set (query) the Ethernet link speed.
IFCF(?)i{,j} Set (query) interface configuration parameter.
IFRS i Reset interface.
IPCF? i Query active TCP/IP configuration parameter.
LOCK? Request the instrument lock.
UNLK? Release the instrument lock previously acquired by the LOCK?
command.
XTRMi{,j,k} Set the interface terminator that is appended to each response.
TSG4100A Series Programmer Manual 2-8

Modulation commands
Modulation commands
Use the modulation commands to configure different types of modulation of the
carrier. Basic configuration for analog modulation and vector modulation can be
achieved by following the steps outlined in the related tables. (See Table 2-8.)
(See Table 2-9.)
Table 2-7: Modulation commands
Header Description
ADEP Set (query) the AM modulation depth in percent.
ALPH Set (query) the excess bandwidth factor, α, for Nyquist and
Root-Nyquist filters.
ANDP Set (query) the AM noise modulation depth {to d} in percent.
AWGN Set (query) the current configuration for Additive White Gaussian
Noise (AWGN).
BITS? Query the current bits/symbol for the current constellation.
BTEE Set (query) the current bandwidth, symbol time product, BT, for
Gaussian filters.
CATL? Query the current catalog listing of available user waveforms.
CNST Set (query) the current user constellation.
COUP Set (query) the coupling of the external modulation input.
DELW? Delete the user waveform at the specified location and return
an error code followed by the current free space in nonvolatile
memory in 16-bit words.
ERAS? Erase all user waveforms and return an error code followed by
the current free space in nonvolatile memory in 16-bit words.
FDEV Set (query) the FM deviation.
FLTR Set (query) the current pulse shaping filter.
FNDV Set (query) the FM noise deviation.
MFNC Set (query) the modulation function or AM/FM/ΦM.
MODI Set (query) the modulation index for CPM.
MODL Set (query) the enable state of modulation.
MPRE Configure the instrument according to the given modulation
preset.
NPWR Set (query) the current AWGN power in dB.
OFSI Set (query) the current offset for I in IQ modulation in percent.
OFSQ Set (query) the current offset for Q in IQ modulation in percent.
PDEV Set (query) the ΦM deviation in degrees.
PDTY Set (query) the duty factor for pulse modulation in percent.
PFNC Set (query) the modulation function for pulse modulation.
PNDV Set (query) the ΦM noise deviation in degrees.
2-9 TSG4100A Series Programmer Manual

Modulation commands
Table 2-7: Modulation commands (cont.)
Header Description
PPER Set (query) the pulse modulation period.
PRBS Set (query) the PRBS length for pulse modulation.
PTRN Set (query) the 16-bit data word for pattern waveforms.
PWID Set (query) the pulse modulation width (duty cycle).
QFNC Set (query) the modulation function for IQ modulation.
RATE Set (query) the modulation rate for AM/FM/PM.
RPER Set (query) the PRBS period for pulse modulation.
SAVC? Save the user constellation stored in SRAM to the specified
location in nonvolatile memory and return an error code when
complete.
SAVF? Save the user filter stored in SRAM to the specified location in
nonvolatile memory and return an error code when complete.
SAVW? Save the user waveform stored in SRAM to the specified location
in nonvolatile memory and return an error code when complete.
SCAL Set (query) the digital scale factor for modulation waveforms.
STAG? Query whether or not the current constellation operates in
staggered mode.
STYP Set (query) the modulation subtype.
SYMR Set (query) the symbol rate for digital waveforms.
TDMA? Query the current TDMA configuration word.
TYPE Set (query) the current modulation type.
WAVF Set (query) the current user waveform.
WRTC Write the given user constellation to SRAM.
WRTE Write the given event marker configuration to SRAM.
WRTF Write the given filter to SRAM.
WRTW Write the given user waveform to SRAM.
Basic analog modulation configuration
Basic configuration for analog modulation can be achieved by following the steps
outlined in the following table. The remote interface commands associated with
each setting are shown. Analog modulation is indicated by setting the subtype to
zero (STYP command). Modulation type is selected with the TYPE command.
Although not shown in this table, analog modulation also supports user waveforms
downloaded by the user. This is achieved by setting the modulation function
(MFNC or PFNC) to user waveform and selecting the desired user waveform with
the WAVF command.
TSG4100A Series Programmer Manual 2-10

Modulation commands
Table 2-8: Basic analog modulation configuration
Modulation Configuration Relevant commands
On/Off Enable configuration MODL
External AC/DC input coupling COUP
Select AM modulation TYPE 0, STYP 0
Modulation function MFNC
Modulation rate / Noise bandwidth RATE
AM
Deviation ADEP, ANDP
Select FM modulation TYPE 1, STYP 0
Modulation function MFNC
Modulation rate / Noise bandwidth RATE
FM
Deviation FDEV, FNDV
Select ΦM modulation TYPE 2, STYP 0
Modulation function MFNC
Modulation rate / Noise bandwidth RATE
ΦM
Deviation PDEV, PNDV
Select pulse TYPE 4
Modulation function PFNC
Pulse period PPER
Pulse width PWID or PDTY
PRBS period RPER
Pulse
PRBS length PRBS
Basic vector modulation configuration
Basic configuration for digital vector modulation can be achieved by following
the steps outlined in the following table.
The remote interface commands associated with each setting are shown in this
table. In contrast to analog modulation, digital vector modulation involves
the mapping of digital symbols onto a vector constellation. Thus, instead of
a waveform frequency or period, there is a symbol rate (SYMR command).
The digital symbols are also typically played back through pulse shaping filter
characterized through the FLTR command.
2-11 TSG4100A Series Programmer Manual