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.
Worldwide, visit www.tek.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 one or more Clock
ecovery instruments) to the BERTScope or host computer, the remote control
R
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 d ocument.
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 accessed from the 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:
CRS:OPEN “CRS_1234”
selects the BERTScope Clock Recovery unit with the device name CRS_1234 as
the current device, while
he various feature groups, several miscellaneous features exist
Write-only operation
Parameters
CRS: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 CR 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 are processed quickly and return within
immediately. However a handful o f 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 9, Generator.)
Data Generator (See page 15,
Generator Data Generator .)
Pattern Start (See page 17, GeneratorPattern Start.)
Spread Spectrum Clock (See page 17,
Generator Spread Spectrum Clock.)
Clock Input (See page 19, GeneratorClock Input.)
Clock Output + (See page 21,
Generator Clock Output Positive.)
Clock Output – (See page 24,
Generator Clock Output Negative.)
Clock Output +/– (See page 27, GeneratorClock Output Pos/Neg.)
GSM Configure/Enable (See page 39,
GSM - Stressed Eye Configure/Enable.)
Detector (See page 49, Detector.)
Error D etector (See page 52, DetectorError Detector.)
Start Detect (See page 56, DetectorStart Detect.)
Clock Input (See page 56, DetectorClock Input.)
Data Input (See page 57, Detector DataInput.)
Blank Input (See page 59, DetectorBlank Input.)
Symbol Filtering (See page 63,
Detector Symbol Filtering.)
Clock Recovery (See page 67, Clock Recovery Option.)
CR Service (See page 72, CRService :Clock Recovery Service.)
CR Control (See page 73, CRControl :Clock Recovery Control.)
CR Loop Response (See page 82,
Clock Recovery Loop Response.)
CR SSC Waveform (See page 84,
Clock Recovery SSC Waveform.)
Data Output + (See page 29, Generator DataOutput Positive.)
Data Output – (See page 32, Generator DataOutput Negative.)
Data Output +/– (See page 34, GeneratorData Output Pos/Neg.)
(See page 35, Generator Reference ClockMultiplier.)
Trigger (See page 37, Generator Trigger.)
Error Inject(See page 38, Generator ErrorInject.)
GSM Stress Setup (See page 40, GSM -Stressed Eye Setup.)
Trigger (See page 60, Detector Trigger.)
Results (See page 61, Detector Results.)
Auto Align Results (See page 64, DetectorAuto Align Results.)
Optical Mode (See page 65, Detector OpticalMode.)
Convenience (See page 64, DetectorConvenience.)
CR Jitter Spectrum (See page 87, ClockRecovery Jitter Spectrum.)
CR Miscellaneous (See page 91, ClockRecovery Miscellaneous.)
CR Sample Program (See page 94, ClockRecovery: Sample Program.)
BERTScope Remote Control Guide7
Command listing
Transmitter Equalization (See page 101, Transmitter Equalization (TXEQ) Option.)
TXEQ command summary (See
page 102, TXEQ command summary.)
Analysis Engine (See page 109, Analysis Engine.)
Basic BER (See page 113, Basic BER.)2D Error Map (See page 124, Error Map.)
Block Errors (See page 114, BlockErrors.)
Burst Leng
Length.)
Correlation (See page 119, Correlation.)Strip Chart (See page 136, Strip Chart.)
Error Free Interval (See page 122,
Error Free Interval.)
Physical Layer Test (See page 137, Physical Layer Test.)
Eye Diagram (See page 138, Eye
Diagra
ER Contour (See page 177, BER Contour.)
B
Mainframe (See page 223, Mainframe.)
System (See page 231, System View.)
System Event Log (See page 235, System Event Log.)
Configuration (See page 237, Configuration.)
Status Queries (See page 239, Status Queries.)
Common Commands (See page 243, Common Commands.)
th (See page 117, Burst
m.)
leanEye (See page 149,
Eye: C
Eye: CleanEye.)
Eye: Single Value Waveform (See
page 169, Eye: Single Value
form.)
Wave
: Data Collecting (See
Eye
page 168, Eye: Data Collecting.)
Eye: Optical Mode (See page 170,
Eye: Optical Mode.)
Eye: Read Eye Measurement
(See page 174, Eye: Read Eye
asurement.)
Me
TXEQ remote control commands (See
page 103, TXEQ remote control commands.)
FEC Emulation (See page 127, FEC
Emulation
Pattern Se
Sensitivity.)
Mask T
Jitter Map (See page 184, Jitter Map.)
Jit
Jitter Tolerance (See page 205, JitterTolerance.)
Q-Factor (See page 216, Q-Factor.)
.)
nsitivity (See page 133, Pattern
Contour Optical M ode (See page 183,
BER Con
ter Peak (See page 197, Jitter Peak.)
tour: O ptical Mode.)
est (See page 210, Mask Test.)
8BERTScope Remote Control Guide
Generator
Complete command listing (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 recalibrationReturns:
< 0 >Does not need delay recalibration
GENerato
r:CREFerence <EXTernal | INTernal>
GENerator:CREFerence?
Set or re
Params:
Returns:
trieve 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 Guide9
Generator
GENerator:CUT
OFFKHZ?
Retrieve the frequency at which the Generator switches to the DDR mode. 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>
Return
s:
<numer
ic>
or data delay.
Generat
Input out of range will be clipped and recorded in the
status queue.
When th
12,500 MHz], Data Delay is within range [0 to 3,000 ps].
e analyzer is operating within range [1,100 to
GENerator:DINVert <bool>
GENerator:DINVert?
Set or retrieve data inversion state for the Generator.
Params:<bool>
Returns:
< 1 >Data inversion is on
<0>
On=1,Off=0
Data inversion is off
GENerator:DRATe?
Retrieve the Generator data rate. Query only.
Returns:<numeric>
Generator data rate in bits/sec. “0” means “No Clock.”
Set or retrieve Phase Modulation Deviation in UI. Range is from 0 to the value
dependent on PM.
Frequency:
250 kHz to ≤4MHz
2.5 kHz to < 250 KHz
10 Hz to <2.5 kHz
In the above formulas:
n = 0.5 for bit rates ≥11.2 Gbps
n = 1 for 6 Gbps ≤ bit rates < 11.2 Gbps
n = 2 for 3 Gbps ≤ bit rates < 6 Gbps
n = 4 for 1.5 Gbps ≤ bit rates < 3 Gbps
n = 8 for 750 Mbps ≤ bit rates < 1.5 Gbps
n = 16 for 375 Mbps ≤ bit rates < 750 Mbps
n = 32 for 187.5 Mbps ≤ bit rates < 375 Mbps
n = 64 for 100 Mbps ≤ bit rates < 187.5 Mbps
Decreasing 30 dB/decade to 12/n UI at 1 MHz and 1.5/n
at 4 MHz
Decreasing 20 dB/decade to 96/n UI at 250 kHz
Fixed 9600/n UI
Params:<numeric>Range: 0 to the upper limit as dependent on the PM Frequency
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>
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.
On=1,Off=0
SSC is enabled
SSC is disabled
BERTScope Remote Control Guide17
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.