xx
SourceXpress®
ZZZ
Waveform Creation Application
Programmer Manual
*P077114401*
077-1144-01
xx
SourceXpress®
ZZZ
Waveform Creation Application
Programmer Manual
www.tektronix.com
077-1144-01
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.
®
SourceXpress
is a registered trademark of Tektronix, Inc.
Contacting Tektronix
Tektronix, Inc.
14150 SW Karl Braun D rive
P.O. B o x 5 0 0
Beaverto
USA
For product information, sales, service, and technical suppor t:
n, OR 97077
In North America, call 1-800-833-9200.
Worldwide, visit www.tektronix.com to find contacts in your area.
Table of Contents
Getting Started
Introducti
Documentation............. .................................. ................................ ..................... 1-2
on ........................ ................................ ................................ ............... 1-1
Syntax and Commands
Command Syntax.................................... ................................ ............................. 2-1
Command G
Connectivity group commands ............................................................................. 2-3
Waveform plug-in group commands.......................... .................................. ........... 2-3
Command Descriptions.......................................................................................... 2-5
roups ................................................................................................ 2-3
Status and Events
Status and Events ................................................................................................. 3-1
Error messages and codes ....................................................................................... 3-2
SourceXpress Programmer Manual i
Table of Contents
ii SourceXpress Programmer Manual
Getting Started
Introduction
This programmer manual provides information on how to use commands for
remotely controlling the SourceXpress software.
The SourceXpress programmatic interface works seamlessly with the
AWG70000A series instrument’s programmatic interface. Using a single VISA
or raw socket session, it is possible to communicate with both SourceXpress
and AWG70000A series instruments.
For information on the Remote Control, GPIB Parameters, LAN Parameters,
Connecting to the Instrument using GPIB, and Setting up GPIB Communication,
refer to t
Manual.
he AWG70000A series Arbitrary Waveform Generators Programmer
SourceXpress Programmer Manual 1-1
Documentation
Documentation
In addition to this SourceXpress Programmer Guide, the following documentation
is included with this application:
SourceXpress Help. The help provides in-depth operation and user interface
help.
SourceXpress User Manual (PDF). This is adapted from the SourceXpress
help system.
1-2 SourceXpress Programmer Manual
Syntax and Commands
Command Syntax
For information on the Syntax Overview, Command and Query Structure,
Clearing the Instrument, Command Entry, Parameter Types, SCPI Commands
and Queries,
Programmer Manual.
refer to the AWG70000A Series Arbitrary Waveform Generators
SourceXpress Programmer Manual 2-1
Command Syntax
2-2 SourceXpress Programmer Manual
Command Groups
Connectivity
Wavefo
rm plug-in group commands
group commands
Table 2-1: Connectivity group commands and their descriptions
Command Descriptio
CONNectivi
CONNectivity:CONNect Connects SourceXpress to a remote
CONNecti
CONNect
Table 2-2: Waveform plug-in group commands and their descriptions
Comman
WPLug
WPLugin:PLUGins? Returns all the available waveform creation
vity:DISConnect
ivity:STATus?
d
in:ACTive
ty:ACTive
n
Sets or retu
connected generator's name.
generator using the generator's hostname
or IP addre
Disconnects the named remote generator
from Sour
Returns
generator.
Descri
Sets o
plug-in.
plug-ins.
rns the active generator using the
ss.
ceXpress.
the connection status of the named
ption
r returns the active waveform creation
SourceXpress Programmer Manual 2-3
Command Groups
2-4 SourceXpress Programmer Manual
Command Descriptions
CONNectivity:ACTive
Conditions
Group
Syntax
Arguments
Returns
This command
name. The active generator is the target of instrument operations. Only a single
generator can be active at once.
The set version of this command must use the actual generator name as listed in
the Connected Generators list (in the SourceXpress application).
The generator must be connected before it can become active.
Connectivity
CONNectivity:ACTive {<name>|<IPaddress>}
CONNectivity:ACTive?
<name>::=<string>
<IPaddress>::=<string>
<name>::= the name of the active generator.
<IPaddress>::= the name of the active generator.
sets or returns the active generator using the connected generator's
Examples
CONNECTIVITY:ACTIVE "MyGenerator " makes the generator named
"MyGenerator" the active generator.
CONNECTIVITY:ACTIVE? might return "194.66.82.11", indicating that the
generator named with this IP address is the active generator.
CONNectivity:CONNect (No Q uery Form)
This command connec
hostname or IP address, making the remote generator available for use by
SourceXpress.
Group
Syntax
SourceXpress Programmer Manual 2-5
Connectivity
CONNectivity:CONNect {<hostname>|<IPaddress>}
ts SourceXpress to a remote generator using the generator's
Command Descriptions
Arguments
Examples
<hostname>::=
<IPaddress>::=<string>
CONNECTIVITY:CONNECT "MyGenerator" remotely connects to the instrument
named "MyGenerator".
<string>
CONNectivity:DISConnect (No Query Form)
This command disconnects the named generator from SourceXpress.
Conditions
Group
Syntax
You must use the name of the generator as listed in the Connected Generators list
in SourceXpre ss.
Connectivity
CONNectivity:DISConnect {<name>|<IPaddress>}
Arguments
Examples
<name>::=<string>
<IPaddress>::=<string>
CONNECTIVITY:DISCONNECT "MyGenerat or" disconnects the remote
generator named "MyGenerator".
CONNectivity:STATus? (Query Only)
This command returns the connection status of the named generator.
Conditions
Group
Syntax
You must use the name of the generator as listed in the Connected Generators list
in SourceXpre ss.
Connectivity
CONNectivity:STATus? {<name>|<IPaddress>}
Arguments
2-6 SourceXpress Programmer Manual
<name>::=<string>
<IPaddress>::=<string>
Command Descriptions
Returns
Examples
WPLugin:ACTive
Conditions
Group
Asingle<Boole
0 indicates the named generator is not connected.
1 indicates the named generator is connected.
CONNECTIVITY:STATUS? "MyGenerator" might return 1, indicating it is
connected and available.
This command sets or returns the active waveform creation plug-in.
This is an overlapping command.
Overlapping commands run concurrently with other commands, allowing
additional commands to start before the overlapping command has finished.
Waveform plug-in
an> value, 0 or 1.
Syntax
Arguments
Returns
Examples
WPLugin:ACTive <plugin_name>
<plugin_name>::=<string>
A single string representing the active waveform creation plug-in.
WPLUGIN:ACTIVE "Multitone" sets Multitone plug-in as the active plug-in.
WPLUGIN:ACTIVE? might return "Multitone", indicating the Multitone plug-in is
currently active.
WPLugin:PLUGins? (Query Only)
This command returns all the avail
response returns a comma separated string with all the plug-in names.
Group
Waveform plug-in
able waveform creation plug-ins installed. The
Syntax
SourceXpress Programmer Manual 2-7
WPLugin:PLUGins?
Command Descriptions
Returns
Examples
<string>::= <p
Plugin_name is the waveform module name(s).
WPLUGIN:PLUGINS? might return "Basic Waveform,Multitone" indicating
that the Basic Waveform and Multitone plug-ins are installed.
lugin_name>,<plugin_name> ....
2-8 SourceXpress Programmer Manual
Status and Events
Status and Events
There is no status and event information.
SourceXpress Programmer Manual 3-1
Error messages and codes
Error messages and codes
The following error codes are unique to the SourceXpress application.
Table3-1: Deviceerrors
Error code Error message
2100 Unable to connect.
2101 Unable to connect.
2102 Failed to connect.
2103
2104
2105
2106 Name in use.
2107 Invalid name.
2108
2109
Connection requires instrument firmware version {0} or greater.
Connection requires SourceXpress software version {0} or
greater.
Failed to connect to generator.
Generator not found.
Generator not found in the Connected Generator list.
Set to active failure.
Failed to set a generator to be the active generator.
Connection lost.
Lost connection to the a ctive generator.
Name already in use by another virtual generator.
Unable to find virtual generator with the specified name.
Disconnect failed.
Cannot disconnect from the default virtual generator.
Remove failed.
Cannot remove the default virtual generator.
3-2 SourceXpress Programmer Manual
Index
C
Command Groups, 2-3
CONNectivity:ACTive, 2-5
CONNectivity:CONNect, 2-5
CONNectivity:DISConnect, 2-6
CONNectivity:STATus?, 2-6
E
Error codes, 3-2
W
WPLugin:AC
WPLugin:PLUGins?, 2-7
Tive, 2-7
SourceXpress Programmer Manual Index-1
Loading...