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 . B o x 5 0 0
Beaverto
USA
For product information, sales, service, and technical support:
n, OR 97077
In North America, call 1-800-833-9200.
World w ide, visi t www.tektronix.com to find contacts in your area.
This document contains a comprehensive listing or remote control commands
for the Tektronix BERTScope family of products. It includes commands for the
different pl
for each of those commands.
The remote control features enable operation of instrument processes remotely
via an IEEE-488 communications connection. Remote control is implemented
using a text-oriented command protocol that enable you to set and query system
parameters, and to operate the analyzer in different modes, including live error
analysis and offline playback of previously recorded error data.
The text-oriented commands follow a basic three-part structure, consisting of one
word identifying the major feature being addressed, another word identifying
aspeci
The analyzer receives and operates on each command immediately. Command
execution sets a status variable that may be queried by the user to determine if
the previous command was successful. Alternatively, a mode can be selected in
which these statuses are automatically returned after each command execution.
atforms. Restrictions and separate parameters or ranges are noted
fic operation or parameter within that feature, and optional parameters.
This document describes how to interface with the analyzer using the IEEE-488
connection. The Analyzer is an IEEE-488 bus peripheral only; it is not an
IEEE-488 bus controller and cannot produce SRQ signals. The IEEE-488 Setup
el. In the System View, touch the Tools tab, then the Remote button, then
pan
IEEE Address. Enter the unique address in the GPIB Address field.
r more technical assistance in programming your remote control applications,
Fo
please contact your local Tektronix representative.
BERTScope Remote Control Guidev
Preface
viBERTScope Remote Control Guide
Getting started
Remote contro
loverview
The BERTScope analyzer and any connected BERTScope instruments can
be controlled remotely via either an IEEE-488 or a TCP/IP communications
connection
or a host PC..
The remote
computer via either an IEEE-488 or TCP/IP connection. It then routes the
commands to one or more BERTScope instruments, connected to the BERTScope
analyzer or host PC via USB.
If the local host is a BERTScope, then the BERTScope software gets a chance
to handle the command first. Any commands the BERTScope software doesn’t
understand are sent to the BERTScope instruemnt software, which then controls
the BERTScope instruments.
When a BERTScope instrument is connected to a BERTScope, you can inter-mix
BERTScope and BERTScope instrument commands in the same script, program,
or int
are routed to the remote control software directly. In this case, using the
BERTScope-specific commands will result in an error.
For most applications, a single BERTScope instrument is connected to a
BERTScope or host PC. In this case, the BERTScope instrument is automatically
detected and connected when the remote control software is started, and
automatically disconnected when the remote control software is stopped. There
is no need in this case to use the OPEN or CLOSE commands described later in
is section.
th
. The remote control software runs on either a BERTScope anaylyzer,
control software accepts text-oriented commands from a remote
eractive session. If the host is just an ordinary PC, then the commands
If more than one BERTScope instrument is connected (such as a DPP125C and
ne or more Clock Recovery instruments) to the BERTScope or host computer,
o
the remote control software will not connect automatically. In this case, the
Remote computer must issue a NAMES? query to discover the IDs of the
connected BERTScope instruments, and OPEN the one desired before issuing
control commands. If the Remote computer needs to control multiple BERTScope
instruments, it would OPEN, control, then CLOSE one, then OPEN, control, and
CLOSE another. The device that is OPEN is referred to as the current device
throughout this document.
Remote control is implemented using a text-oriented command protocol described
in the following pages of this document. These commands enable you to set
and query the system parameters of the BERTScope instruments, and to retrieve
measurements made by the instrument.
BERTScope Remote Control Guide1
Getting started
Set up the inst
rument for remote control operation
Remote setup is a ccessed from the BERTScope Analyzer System View.
1. In the System view, under the Tools tab Utilities heading, click the Remote
button to access the configuration panel.
2. Before beginning a remote control session, it is necessary to start the Remote
Client application, RemoteClient.exe, on the host computer.
If the host is a BERTScope, click the Remote button from the System View
To ols page. If the host computer is a normal PC, then just execute the
RemoteClient.exe, file.
3. If you are using GPIB to control the BERTScope, enable the IEEE Address
button.
If the button is not enabled, click the Disconnect button; it might take a few
seconds to enable the IEEE Address button.
4. Click the IEEE Address button and enter the required information into the
NI-488.2 Settings dialog box.
Command description
Remote control communications are exchanged as ASCII strings over a LAN
telnet (TCP port 23) between the host computer and the analyzer. Select a
communications port to be used for access to the instrument's remote control
operations. If the port is set to NONE, then remote control is disabled.
The input values of commands are checked against the same ranges as the user
interface. If an input is received that is outside of this legal range, the input will
be clipped and recorded in the status queue.
It is recommended that you request the status of a command by sending
SYStemERRor? after each command. Besides telling you what has happened
with the command, this will also synchronize command transmission and
handling.
2BERTScope Remote Control Guide
Getting started
Command synta
x
Remote Control Command Lines are defined as ASCII text strings ending with
‘\r’ or ‘\n’.
The commands follow a basic three-part structure, consisting of one word
identifying the feature of the BERTScope instrument being addressed, another
word identi
The feature and operation are separated by a colon, and the operation and
parameter (if any), are separated by a space. The operation can be Double,
Integer, or Boolean numbers; a file path name; a special word; or a data type. For
a Boolean data type, the input can be ON, OFF, 1, or 0. The returned response
will be either 1 for true or 0 for false. A question-mark character (?) is added at
the end o
FEATURE:OPERATION PARAMETER
Commands and parameters are generally case-insensitive, with the notable
exception of those requiring a case-sensitive parameter for the Standard names.
Most commands have both a “long version” and “short version,” indicated by
capitalized versus lowercase letters. For example:
typed
are required; the lowercase letters are optional – commands are not case-sensitive.
The s
for example). You might want to use the long form in scripts or programs, to
increase code clarity.
fying a specific operation within that feature, and optional parameters.
f a command, without a space, to create a query.
GENerator:PATTern? can be
out exactly as shown, or as
hort form is convenient during interactive control (using a telnet session,
GEN:PATT? The capital letters and the colon (:)
Features
When command setup data uses a string as a parameter (a filename or path name,
for instance), enclose the string in double-quotes (“string”).
For every command processed, an error code will be returned. If the command
has a question mark (a query), the setup information is also returned.
The BERTScope remote control commands are divided into feature groups. The
number of features per each group depend on the BERTScope product.
In the first group are commands that handle device discovery and connection. You
can use these commands anytime, even if a current device has not been selected
yet (with the OPEN command). The NAMES, OPEN, and CLOSE commands are
allpartofthisgroup.
A second group consists of commands for controlling and monitoring a particular
BERTScope instruments. The current device must have been specified (using the
OPEN command) before to using any commands in this group.
BERTScope Remote Control Guide3
Getting started
Operations
Read-only properties
Read-write properties
In addition to t
to control the host computer display (VIEW, PTFILE, GUILOCKOUT), the
run state (RSTATE, RDURATION), and the overall program configuration
(SCONFIGURATION, RCONFIGURATION, ISSTATUS, RSSTATUS). These
commands primarily implement the functionality provided by the GUI Console
buttons.
Queryareadablepropertybyappendingaquestionmarktoit(withnospace
between the command and the question mark). For example:
CRS:OPEN?
returns the device name of the currently connected BERTScope CR. In most
cases, the returned values are all capitalized.
Query a read-write property by appending a question mark after it.
Set a read-write property by adding an appropriate parameter. For example:
DPP:OPEN “DPP_1234”
selects the BERTScope DPP with the device name DPP_1234 as the current
device, while
he various feature groups, several miscellaneous features exist
Write-only operation
Parameters
DPP:OPEN?
returns name of the device previously OPENed.
Question marks are illegal for write-only operation, and parameters may or may
not be required, depending upon the particular operation. For example:
requires the complete pathname of the BERTScope DPP configuration file.
A parameter can be a double or integer number, Boolean (0 or 1), an enumerated
data type, or a string.
When a command uses a string as a parameter, the string is enclosed in double
quotes (
double quotes.
“string”). Filenames always require the absolute path, enclosed within
4BERTScope Remote Control Guide
Getting started
Command status
Parameters are
generally case-insensitive, with the notable exception of
case-sensitive Standard names. For example:
CRC:STANDARD “123abc”
and
CRC:DELETESTANDARD “123ABC”
are specifying different user-defined clock recovery standards.
The BERTScope instrument receives and operates on each command immediately.
The input values of commands are checked. If an input is received that is outside
of the legal range, the input will be clipped and recorded in the status queue.
Command execution sets a status variable that can be queried by the user to
determine if the previous command was successful.
Request the status of a command by sending:
SYSTEM:ERROR? or SYST:ERR?
This command retrieves items listed in the error status queue, in the format:
Command
Error messages
< n, “event/string” >
The status queue is first in, first out. It can contain up t o 100 error messages. If the
status queue overflows, the last error/event in the queue is replaced with Error
-350, “Queue overflow”. When all errors/events have been read from the
queue, further error/event queries will return
To clear the status queue all at once, send:
*CLS
error messages and codes
The following error messages might be returned:
"TOO MANY PARAMETERS"
"UNRECOGNIZED COMMA
"WRONG PARAMETER TYPE"
"TOO LITTLE PARAMETERS"
"WRONG PARAMETER FORMAT"
"WRONG PARAMETER NUMBER"
0, “NO ERROR”.
ND"
"WRONG ACTION-ONLY"
BERTScope Remote Control Guide5
Getting started
Error codes
The following error codes might be returned:
0 "NO ERROR"
-350 "Queue Overflow"
-10 File transfer error
-20 System
-30 Command error, see list of error messages
-40 No software option
Communications timeouts
Most commands issued to the BERTSope/BitAlyzer are processed quickly and
return within immediately. However a handful of commands might require
considerable processing and take longer, including the following:
"WRONG QUERY-O
“REQUESTED <QUERY PARAMETER> IS NOT SUPPORTED ON THE
PLATFORM”
rator data signal enabling (BERTScope only) — 7 seconds
Gene
Run state enable (Physical layer tests that perform initial auto-align) —
conds
6se
As a result, programming the communications architecture with a two-second
meout for most command, and a 10-second timeout for the above-listed
ti
commands is one approach. Another approach is to set all communication
timeouts to be 10 seconds. Of course, commands that don’t require this much time
will not be affected by the longer timeout. This ensures that all commands can
complete without triggering communications timeouts.
6BERTScope Remote Control Guide
Command listing
Generator (See page 11, Generator.)
Data Generator (See page 17,
Generator Data Generator.)
Pattern Start (See page 19, GeneratorPattern Start.)
Spread Spectrum Clock (See page 20,
Generator Spread Spectrum Clock.)
Clock Input (See page 22, GeneratorClock Input.)
Clock Output + (See page 24,
Generator Clock Output Positive.)
Clock Output – (See page 27,
Generator Clock Output Negative.)
GSM Configure/Enable (See page 41,
GSM - Stressed Eye Configure/Enable.)
Detector (See page 51, Detector.)
Error D etector (See page 54, DetectorError Detector.)
Start Detect (See page 58, DetectorStart Detect.)
Clock Input (See page 59, DetectorClock Input.)
Data Input (See page 61, Detector DataInput.)
Blank Input (See page 63, DetectorBlank Input.)
Symbol Filtering (See page 67,
Detector Symbol Filtering.)
Stress Combiner (See page 71, Stress Combiner Option.)
Stress Combiner command summary
(See page 72, Stress Combinercommand summary.)
Clock Recovery (See page 79, Clock Recovery Option.)
CR Service (See page 84, CRService :Clock Recovery Service.)
CR Control (See page 85, CRControl :Clock Recovery Control.)
CR Loop Response (See page 94,
Clock Recovery Loop Response.)
Clock Output +/– (See page 30, GeneratorClock Output Pos/Neg.)
Data Output + (See page 31, Generator DataOutput Positive.)
Data Output –(See page 34, Generator DataOutput Negative.)
Data Output +/– (See page 36, GeneratorData Output Pos/Neg.)
Trigger (See page 37, Generator Trigger.)
Error Inject(See page 38, Generator ErrorInject.)
GSM Stress Setup (See page 42, GSM -Stressed Eye Setup.)
Trigger (See page 64, Detector Trigger.)
Results (See page 65, Detector Results.)
Auto Align Results (See page 68, DetectorAuto Align Results.)
Optical Mode (See page 69, Detector OpticalMode.)
Convenience (See page 68, DetectorConvenience.)
Stress Combiner commands (See page 74,
Stress Combiner commands.)
CR Jitter Spectrum (See page 99, ClockRecovery Jitter Spectrum.)
CR Miscellaneous (See page 103, ClockRecovery Miscellaneous.)
CR Sample Program (See page 106, ClockRecovery: Sample Program.)
BERTScope Remote Control Guide7
Command listing
CR SSC Waveform (See page 96,
Clock Recovery SSC Waveform.)
Digital Pre-Emphasis Processor (DPP) (S ee page 113, Digital Pre-Emphasis Processor
(DPP) Option
DPP command s
page 114, DPP command summary.)
Lightwave Test Set LTS option (See page 131, Lightwave Test Set (LTS) option.)
LTS remote control setup (See
page 132, LTS remote control setup.)
RC LTS Remote Control Commands
(See page
Commands.)
Analysis Engine (See page 145, Analysis Engine.)
Basic BER (See page 149, Basic BER.)2D Error Map (See page 160, Error Map.)
Block Errors (See page 150, BlockErrors.)
Burst Length (See page 153, Burst
Lengt
Corr
Correlation.)
Error Free Interval (See page 158,
Error Free Interval.)
Physical Layer Test (See page 175, Physical Layer Test.)
Eye Diagram (See page 176, Eye
Di
BER Contour (See page 215, BER Contour.)
Mainframe (See page 261, Mainframe.)
System (See page 269, System View.)
System Event Log (See page 273, System Event Log.)
Configuration (See page 275, Configuration.)
.)
ummary (See
136, LTS Remote Control
h.)
elation (See page 155,
agram.)
e: CleanEye (See page 187,
Ey
Eye: CleanEye.)
Eye: Single Value Waveform (See
page 207, Eye: Single ValueWaveform.)
Eye: Data Collecting (See
page 206, Eye: Data Collecting.)
Eye: Optical Mode (See page 208,
Eye: Optical Mode.)
Eye: Read Eye Measurement
(See page 212, Eye: Read EyeMeasurement.)
DPP Interfac
control commands.)
RC LTS command summary (See page 135,
LTS command summary.)
FEC Emulation (See page 163, FECEmulation.)
Pattern Sensitivity (See page 169, Pattern
Sensi
p Chart (See page 172, Strip Chart.)
Stri
sk Test (See page 247, Mask Test.)
Ma
Jitter Map (See page 222, Jitter Map.)
Jitter Peak (See page 234, Jitter Peak.)
Jitter Tolerance (See page 242, JitterTolerance.)
Q-Factor (See page 254, Q-Factor.)
e(See page 116, DPP remote
tivity.)
Contour Optical Mode (See page 221,
R Contour: Optical Mode.)
BE
8BERTScope Remote Control Guide
Status Queries (See page 277, Status Queries.)
Common Commands (See page 281, Common Commands .)
Command listing
BERTScope Remote Control Guide9
Command listing
10BERTScope Remote Control Guide
Generator
Complete command list (See page 7, Command listing.)
DELAY:GENR e c a l ?
Retrieve the information that indicates whether Generator delay needs
recalibration. Query only. Note: Since monitoring for these calibrations is
suspended while Physical Layer tests are running, using this command under
those circumstances may not return an accurate result.
< 1 >Needs delay recalibration.Returns:
< 0 >Does not need delay recalibration.
GENerato
r:CREFerence <EXTernal | INTernal>
GENerator:CREFerence?
BERTSco
Params:
Returns:
pe Analyzer only. Set or retrieve the Generator input clock reference.
<EXTernal>
<INTernal>
< EXTERNAL | INTERNAL >
External clock reference
Internal clock reference
GENerator:CSELect <INTernal | EXTernal>
rator:CSELect?
GENe
Set or retrieve the clock used by the Generator.
Params:
Returns:
<INTernal>
<EXTernal>
< INTERNAL | EXTERNAL >
Generator uses the internal clock synthesizer
Generator uses the external clock
BERTScope Remote Control Guide11
Generator
GENerator:CUT
OFFKHZ?
Retrieve the frequency at which the Generator switches to the DDR mode.
Applies to BER
TScope BSA175C. Query only.
GENerator:DDEFs <numeric>
GENerator:
DDEFs?
Set or retrieve the Generator data delay in femto-seconds.
Params:<numeric>
Returns:<numeric>
Set Generator data delay in fs.
GENerator:DDELay <numeric>
GENerator:DDELay?
Set or retrieve the Generator data delay in picoseconds.
Params:<numeric>
Returns:<numeric>
or data delay.
Generat
BitAlyzer: Input out of range will be clipped and recorded
in the status queue.
When th
1,500 MHz], Data Delay is within range [0 to 5,000 ps].
BERTScope Analyzer: Input out of range will be clipped
and rec
When the Analyzer is operating within range [1,100 to
12,500 MHz], Data Delay is within range [0 to 3,000 ps].
e BitAlyzer is operating w ithin range [982 to
orded in the status queue.
GENerator:DINVert <bool>
GENerator:DINVert?
Set or retrieve data inversion state for the Generator.
Params:<bool>
Returns:
Nerator:DRATe?
GE
< 1 >Data inversion is on
<0>
On=1,Off=0
Data inversion is off
Retrieve the Generator data rate. Query only.
Returns:<numeric>
Generator data rate in bits/sec. “0” means “No Clock.”
Set or retrieve the Generator data type. PRBS-11 is available only on BERTScope
Analyzers. The Passthrough type is available only on BSA85C, BSA175C, and
BSA286CL.
Params:
Returns:
mand list (See page 7, Command listing.)
<"filename" >
<PN7 | PN11|
PN15 | PN20 |
PN23 | PN31>
<USTart>User pattern (See GEN:UPLoad command to load a
Generator pseudo-random pattern data type.
PN11 pattern is available only on the BERTScope
Analyzer.
user pattern file)
User pattern cycle
All-zeros pattern
When corresponding option is purchased, Detector
Pass-Through mode outputs whatever the Detector has
just received. Available only on BSA85C, BSA175C,
and BSA286CL.
GENerator:PSELect <A | B>
GENerator:PSELect?
Set or retrieve the selected page of the user pattern loaded to the Generator.
<A>User pattern page AParams:
<B>User pattern page B
Returns:
< PAGEA | PAGEB >
GENerator:PSWitch
Switch the page of the user pattern loaded to the Generator. Action only.
BERTScope Remote Control Guide17
Generator Data Generator
GENerator:UPL
oad <"filename">
Load user pattern from the specified file. Action only.
Params:
<"filename">
Use the absolute path name and enclose the string in
double quotes.
GENerator:UPLPercent?
Retrieve the user pattern loading percentage completion value. Query returns 100
if the loading is complete. Query only.
Returns:< number >
The percentage of user pattern loaded into the
Generator
GENerator:UPLTracking<bool>
GENerato
r:UPLTracking?
Set or retrieve whether the Generator tracks the Detector when loading a user
pattern
. If the tracking is true, the command GEN:UPL <“filename”> loads the
user pattern into both the Generator and Detector.
Params:<bool>
Returns:
<1>
<0>
On=1,Off=0
Generator tracks Detector when loading
Generator does not track D etector when loading
rator:UPWLen?
GENe
Retrieve the word count from the Generator RAM. Query only.
Returns:< number >
The number of words in RAM
Complete command list (See page 7, Command listing.)
Set or retrieve the SSC modulation deviation. Argument range is different for first
generation hardware (Option SSC) and second generation (Option XSSC).
Params:<numeric>
Returns:<numeric>
SSC modulation deviation in ppm.
Option SSC: Range [0 to 10,000] in Down spread or Up
spread mode; [0 to 5,000] in Center spread mode.
Option XSSC: Range is a function of data rate. Refer to
BERTScope Analyzer Technical Specifications.
Set or retrieve whether the SSC/XSSC option is enabled (option must be present
in order to enable; see GEN:SSCMOD:PRES command below).
Params:<bool>
Returns:
<1>
<0>
On=1,Off=0
SSC is enabled
SSC is disabled
20BERTScope Remote Control Guide
Generator Spread Spectrum Clock
GENerator:SSC
MOD:FREQuency <numeric>
GENerator:SSCMOD:FREQuency?
Set or retriev
e the SSC modulation frequency. Argument range is different for
first generation hardware (Option SSC) and second generation (Option XSSC).
Params:<numeric>
Returns:<numeric>
GENerator
:SSCMOD:PRESent <bool>
SSC modulation frequency in Hz.
Option SSC: Range [25,000 to 35,000]
Option XSSC:Range [20,000 to 160,000]. Note that
modulation deviation is uncalibrated for modulation
frequencies >40 kHz.