Agilent Technologies OTDRs Programming Guide

Notices
Copyright 1998-2000 Agilent
Technologies Deutschland GmbH. All
rights reserved.
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
Agilent Technologies, Inc. as
governed by United States and
international copyright laws.

continually increasing customer

satisfaction through improved process
control.

Bellcore Certification of
Excellence
Agilent Technologies is officially
designated Bellcore Certification
Eligible, and is awarded Bellcores
Certification of Excellence for its
OTDR Data Format.

Warranty
The material contained in this
document is subject to change without
notice. Agilent Technologies makes
no warranty of any kind with regard to
this material, including, but not
limited to, the implied warranties of
merchantability and fitness for a
particular purpose. Agilent
Technologies shall not be liable for
errors contained herein or for
incidental or consequential damages in
connection with the furnishing,
performance, or use of this material.

Edition/Print Date
All Editions and Updates of this
manual and their creation dates are
listed below.
E4310-91016 Third Edition E0401
First Edition E0298
Second Edition E1098, E0599, E0500
Third Edition E0401

Assistance
Product maintenance agreements and
other customer assistance agreements
are available for Agilent Technologies
products.
For any assistance, contact your
nearest Agilent Technologies Sales
and Service Office (see Service and
Support on page 6).

ISO 9001 Certification

Produced to ISO 9001 international
quality system standard as part of
Agilent Technologies objective of

Agilent Technologies GmbH

Herrenberger Str. 130
71034 Bblingen
Germany

About This Manual

This manual contains information about SCPI commands which can be
used to program all HP/Agilent Optical Time Domain Reflectometers.
Instruments affected are:
HP/Agilent E4310A (8147A) OTDR (Mainframe OTDR)
Agilent E6000 Mini-OTDR (Mini-OTDR)
Agilent E6020A Mini-Fiber Break Locator (Mini-FBL)
Agilent E605* and E606* Rack OTDRs (Rack OTDR).
Most SCPI commands can be used with all OTDRs, but a few are only
applicable to particular instruments, or have slightly different names. For
example, commands which may also be used with different Mini-OTDR
submodules have an extra number in their name, indicating which
submodule is affected.
Each command definition contains text showing which instrument is
affected. A command which affects All can be used with all the
instruments listed above.

The Structure of this Manual

This manual is divided into 4 parts:
Chapter 1 gives a general introduction to SCPI programming with
OTDRs.
Chapter 2 lists the OTDR-specific SCPI commands.
Chapters 3 to 5 give fuller explanations and examples of the OTDRspecific commands.
Chapter 6 gives some example programs showing how the SCPI
commands can be used with OTDRs.

In addition, there is an appendix containing information about the HP VEE

driver.

Conventions used in this manual

All commands and typed text is written in Courier font, for example
INIT[:IMM][:ALL].
SCPI commands are written in mixed case: text that you MUST print is
written in capitals; text which is helpful but nor necessary is written in
lower case.
So, the command INITiate[:IMMediate][:ALL] can be
entered either as init[:imm][:all], or as
initiate[:immediate][:all]. It does not matter whether you
enter text using capitals or lower-case letters.
SCPI commands often contain extra arguments in square brackets.
These arguments may be helpful, but they need not be entered.
So, the command INITiate[:IMMediate][:ALL] can be
entered as init or initiate.
A SCPI command which can be either a command or a query is
appended with the text /?.
So, SYSTem:SET/? refers to both the command SYSTem:SET and
the query SYSTem:SET?.

Related Publications
You can find more information about the instruments covered by this
manual in the following manuals:
HP 8147A Optical Time Domain Reflectometer Users Guide (Agilent
Product Number E4310-91011).
Agilent E6000C Mini-OTDR Users Guide (Agilent Product Number
E6000-91031)

 Agilent E6020A Mini-Fiber Break Locator Users Guide (Agilent

Product Number E6020-91011)
Agilent E6053A, E6058A and E6060A Rack OTDR Users Guide
(Agilent Product Number E6050-91011).
NOT E

Please note that these User Guides no longer contain programming

information, and must now be used in conjunction with this manual.
If you are not familiar with the GPIB, then refer to the following books:
HP publication 5952-0156, Tutorial Description of HP-IB.
ANSI/IEEE-488.1-1978, IEEE Standard Digital Interface for
Programmable Instrumentation, and ANSI/IEEE-488.2-1987, IEEE
Standard Codes, Formats, and Common Commands, published by the
Institute of Electrical and Electronic Engineers.
In addition, the commands not from the IEEE 488.2 standard are defined
according to the Standard Commands for Programmable Instruments
(SCPI).
For an introduction to SCPI and SCPI programming techniques, refer to
the following documents:
Hewlett-Packard Press (Addison-Wesley Publishing Company, Inc.): A
Beginners Guide to SCPI by Barry Eppler.
The SCPI Consortium: Standard Commands for Programmable
Instruments, published periodically by various publishers. To obtain a
copy of this manual, contact your Agilent TEchnologies representative.

Service and Support

Any adjustment, maintenance, or repair of this product must be performed
by qualified personnel. Contact your customer engineer through your local
Agilent Technologies Service Center. You can find a list of local service
representatives on the Web at:
http://www.agilent-tech.com/services/English/index.html
If you do not have access to the Internet, one of these centers can direct
you to your nearest representative:
United States

Test and Measurement Call Center

(800) 452-4844 (Toll free in US)

Canada

(905) 206-4725

Europe

(31 20) 547 9900

Japan

Measurement Assistance Center

(81) 426 56 7832
(81) 426 56 7840 (FAX)

Latin America

(305) 267 4245

(305) 267 4288 (FAX)

Australia/New
Zealand

1 800 629 485 (Australia)

Asia-Pacific

(852) 2599 7777

(852) 2506 9285 (FAX)

0800 738 378 (New Zealand)

Front Matter

1 Introduction to Programming
1.1 Command Messages ...............................................17
Units .................................................................................... 17
Trace Array ......................................................................... 18
Data ..................................................................................... 18
Message Exchange ............................................................. 18
The Input Queue ................................................................. 19
The Output Queue .............................................................. 19
The Error Queue ................................................................. 19

1.2 Common Commands ..............................................20

Common Command Summary ........................................... 21
Common Status Information .............................................. 22

1.3 HP/Agilent OTDR Status Model ...........................23

Annotations ......................................................................... 25
Standard Event Status Register ........................................... 25
Operation/Questionable Status ........................................... 26
Operation Status ................................................................. 26
Questionable Status ............................................................ 26
Status Command Summary ................................................ 27
Mini-OTDR and Rack OTDR Bit Table ............................ 28
Mainframe OTDR Bit Table ............................................... 28
Other Commands ................................................................ 29

2 Specific Commands
2.1 Specific Command Summary ................................33

Front Matter

3 Instrument Setup and Status

3.1 IEEE-Common Commands ...................................45
3.2 Status Reporting The STATus Subsystem ........56
3.3 Interface/Instrument Behaviour Settings The SYSTem Subsystem .............................................................61

4 Operations on Traces and Measurements

4.1 Root Layer Commands ..........................................79
4.2 Playing With Data The PROGram and CALCulate
Subsystems .....................................................................83
4.3 Measurement Functions The SENSe Subsystem 89
4.4 Signal Generation The SOURce Subsystem ......100
4.5 Trace Data Access The TRACe Subsystem .......110

5 Mass Storage, Display, and Print Functions

5.1 Display Operations The DISPlay Subsystem ....123
5.2 Print Operations The HCOPy Subsystem .........130
5.3 File Operations The MMEMory Subsystem .....137

6 Programming Examples
8

Front Matter
6.1 How to Connect your OTDR to a PC ....................147
How to set the Instrument Configuration ........................... 148

6.2 How to Connect with a Terminal Program ..........150

6.3 Using a Program to Connect to the OTDR ...........151
6.4 How to Send Commands and Queries ..................152
Commands .......................................................................... 153
Queries ................................................................................ 153
Blocks transfer .................................................................... 153

6.5 Common Tasks ........................................................154

How to Initialize the Instrument ......................................... 154
How to Set Up an OTDR Measurement ............................. 155
How to Run a Measurement ............................................... 155
How to Scan a Trace ........................................................... 156
How to Process a Trace ...................................................... 156
How to Upload a Bellcore File from the current trace ....... 156

6.6 Advanced Topics .....................................................157

How to Download a Bellcore File ...................................... 157
How to Use the Power Meter and Source Mode ................ 158
How to Store Traces on Other Devices .............................. 158

6.7 SCPI data transfer between PC and OTDR .........159

A The VEE Driver

A.1 What is HP VEE ? ..................................................165
Using the RS232 port ......................................................... 165

A.2 How to Install HP VEE ..........................................166

A.3 Features of the HP OTDR VEE Driver ...............169
9

Front Matter
A.4 Directory Structure ................................................170
A.5 Opening an Instrument Session ............................170
A.6 Closing an Instrument Session ..............................171
A.7 VISA Data Types and Selected Constant Definitions
172
A.8 Error Handling .......................................................172
A.9 Introduction to Programming ..............................173
Selecting Functions .............................................................173
Example Programs ..............................................................174
LabView ..............................................................................174
LabWindows .......................................................................175

A.10 VISA-specific information ...................................175

Instrument Addresses ..........................................................175
Callbacks .............................................................................176

A.11 Using the HP OTDR VEE Driver in Application Development Environments .............................................176
Microsoft Visual C++ 4.0 (or higher) and Borland C++ 4.5 (or
higher) .................................................................................176
Microsoft Visual Basic 4.0 (or higher) ...............................176
HP VEE 3.2 (or higher) .......................................................177
LabWindows CVI/ (R) 4.0 (or higher) ................................177

A.12 Online information ...............................................178

10

Front Matter
Figure 1-1 Common Status Registers .........................................................................
Figure 6-1 Instrument configuration - example ..........................................................
Figure 6-2 Connection check - example .....................................................................
Figure 6-3 Query - example........................................................................................
Figure 6-4 Blocks transfer - example .........................................................................
Figure 6-5 Uploading a Bellcore file - example .........................................................
Figure A-1 VXIplug&play window ...........................................................................
Figure A-2 HP VEE - Install options..........................................................................

11

22
149
152
153
154
157
167
168

Front Matter

12

Front Matter
Table 1-1 Common Command Summary ...................................................................
Table 2-1 Specific Command Summary.....................................................................
Table 6-1 Cable configuration for connection to a PC ...............................................
Table 6-2 Transmission parameters ............................................................................

13

21
34
147
150

Front Matter

14

Introduction to
Programming

Introduction to
Programming

This chapter introduces some background information that may

help you when programming OTDRs. You can find general
information about SCPI commands here, and lists and descriptions
of some useful IEEE standard common commands.

16

Introduction to Programming

1.1 Command Messages

A command message is a message from the controller to the
OTDR. The following are a few points about command messages:
Either upper-case or lower-case characters can be used.
The parts in upper-case characters in the command descriptions
must be given. The parts in lower-case characters can also be
given, but they are optional.
The parts in brackets [ ] in the command description can be
given, but they are optional.
In the syntax descriptions the characters between angled
brackets (<...>) show the kind of data that you require. You do
not type these brackets in the actual command. <wsp> stands
for a white space character.
A command message is ended by a line feed character (LF) or
<CR><LF>.
Several commands can be sent in a single message. Each
command must be separated from the next one by a semicolon
;.

Units
Where units are given with a command, usually only the base units
are specified. The full sets of units are given in the table below.
Unit
meters
miles
feet
decibel
second

Default
M
MI
FT
DB
S

Allowed Mnemonics
NM, UM, MM, M, KM
MIles
FT, KFT
MDB, DB
NS, US, MS, S

The default unit of length is usually mm.

17

Introduction to Programming

Trace Array
The Mini-OTDR and Rack OTDR can load up to two traces into
their memory. The Mainframe OTDR can load up to four traces.
These traces form a trace array. One of the entries in this array is
always the current entry. Most operations work on this entry.

Data
With the commands you give parameters to the OTDR and receive
response values from the OTDR. Unless explicitly noticed these
data are given in ASCII format (in fact, only the trace data are given
in binary format). The following types of data are used:
Boolean data may only have the values 0 or 1.
Data of type short may have values between -32768 and 32767.
When the OTDR returns a short value, it always explicitly gives
the sign.
Float variables may be given in decimal or exponential writing
(0.123 or 123E-3).
A string is contained between a " at the start and at the end or a
' at the start and at the end. When the OTDR returns a string, it
is always included in " " and terminated by <END>.
When a register value is given or returned (for example *ESE),
the decimal values for the single bits are added. For example, a
value of nine means that bit 0 and bit 3 are set.
Larger blocks of data are given as Binary Blocks, preceded by
#HLenNumbytes, terminated by <END>; HLen represents the
length of the Numbytes block. For example:
#16TRACES<END>.

Message Exchange
The OTDR exchanges messages using an input and an output
queue. Error messages are kept in a separate error queue.

18

Introduction to Programming

The Input Queue

The input queue is a FIFO queue (first-in first-out). Incoming bytes
are stored in the input queue as follows:
Receiving a byte:
Clears the output queue.
Clears Bit 7 (MSB).
No modification is made inside strings or binary blocks.
Outside strings and binary blocks, the following modifications
are made:
Lower-case characters are converted to upper-case.
Two or more blanks are truncated to one.
The parser is started if the LF character is received or if the input
queue is full.
Clearing the Input Queue
Switching the power off causes commands that are in the input
queue, but have not been executed to be lost.

The Output Queue

The output queue contains responses to query messages. The
OTDR transmits any data from the output queue immediately.
On the Mainframe OTDR, each response message ends with a
carriage return (CR, 0D16) and a LF (0A16), with EOI=TRUE. If no
query is received, or if the query has an error, the output queue
remains empty.

The Error Queue

The error queue is 30 errors long. It is a FIFO queue (first-in firstout). That is, the first error read is the first error to have occurred.
If more than 29 errors are put into the queue, the message '-350,
"Queue overflow" ' is placed as the last message in the queue. The
queue continues to work, but now with only the first 29 positions.

19

Introduction to Programming

The oldest error message in the queue is discarded each time a new
error message added.

1.2 Common Commands

The IEEE 488.2 standard has a list of reserved commands, called
common commands. Some of these commands must be
implemented by any instrument using the standard, others are
optional. The OTDR implements all the necessary commands, and
some optional ones. This section describes the implemented
commands.

20

Introduction to Programming

Common Command Summary

Table 1-1gives a summary of the common commands.

Table 1-1

Common Command Summary

Command
Parameter
*CLS
*ESE
*ESE?
*ESR?
*FTY
*IDN?
*LRN?
*OPC?
*OPT?
*RCL
*RST
*SAV
*STB?
*TST?
*WAI

NO T E

<location>
<location>

Function
Clear Status Command
Standard Event Status Enable Command
Standard Event Status Enable Query
Standard Event Status Register Query
Reset defaults and reboot
(not possible on Mainframe OTDR)
Identification Query
Read instrument settings
Operation Complete Query
Options Query
Recall Instrument Setting
Reset Command
Save Instrument Setting
Read Status Byte Query
Self Test Query
Wait Command

These commands are described in more detail in IEEE-Common

Commands on page 45

21

Introduction to Programming

Common Status Information

There are four registers for the status information. Two of these are
status-registers and two are enable-registers. These registers
conform to the IEEE Standard 488.2-1987. You can find further
descriptions of these registers under *ESE, *ESR?, *SRE, and
*STB?. The following figure shows how the registers are
organized.

Figure 1-1

Common Status Registers

* The questionable and operation status command trees are
described in Status Reporting The STATus Subsystem on
page 56.
AT T E NT I O N Unused bits in any of the registers return 0 when
you read them.
For information about the status model, see Status Reporting
The STATus Subsystem on page 56

22

Introduction to Programming

1.3 HP/Agilent OTDR Status Model

The following figure describes the relevant bit patterns and their
relationship of the SCPI status/error model

23

Introduction to Programming

Status
Byte

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Operat.*Master ESR MAV Quest.*unused*unused Laser
Status Summ Summ.
Status
Active

Standard Event
Status Enable

&

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Power *User Cmd
On Request Error

Enable

+&

Exec DevDep Query *Req Operat.

Error Error Error Control Compl.

Operation
Status
0, *unused

0, *unused

1, *unused

1, *unused

2, *unused

2, *unused

3, *unused

3, power warn

4, meas running

4, *unused

5, *unused

5, *unused

6, *unused

6, *unused

7, *unused

7, *unused

8, scan running

8, *unused

9, printing

9, *unused

10, *unused

10, *unused

11, *unused

11, *unused

12, *unused

12, *unused

13, *unused

13, *unused

14, *unused

14, cmd. warn.

15, *unused

15, *unused

EVENt <- CONDition

24

Questionable
Status

Standard Event
Status Register

Enable

&+

CONDition -> EVENt

Introduction to Programming

Bits marked with * are not used and therefore always set to 0. The
few used bits in the operation are marked with arrows, as are the
questionable status registers.

Annotations
Status Byte:
Bit 0 is set any time the laser is on (measurement running)
Bits 1 and Bit 2 are unused (0)
Bit 3 is built from the questionable status event register and its
enable mask.
Bit 4 (MAV) is generally 0.
Bit 5 is built from the SESR and its SESE.
Bit 6 is always 0 because the SRE mask is always 0 (no service
request).
Bit 7 is built from the operation status and its enable mask.

Standard Event Status Register

Bit 0 is set if an operation complete event has been received
since the last call to *ESR?.
Bit 1 is always 0 (no service request).
Bit 2 is set if a query error has been detected.
Bit 3 is set if a device dependent error has been detected.
Bit 4 is set if an execution error has been detected.
Bit 5 is set if a command error has been detected.
Bit 6 is always 0 (no service request).
Bit 7 is set for the first call of *ESR after Power On.

25

Introduction to Programming

Operation/Questionable Status
The Operation/Questionable Status consists of a condition and
an event register.
A "rising" bit in the condition register is copied to the event
register.
A "falling" bit in the condition register has no effect on the event
register.
Reading the condition register is non-destructive.
Reading the event register is destructive.
A summary of the event register and its enable mask is set in the
status byte.

Operation Status
Bit 4 is set if a measurement is running, and reset when the
measurement is stopped.
Bit 8 is set if the scan trace is running, and reset when the scan
trace is stopped.
Bit 9 is set if a printout has been started, and reset when the
printout is finished or cancelled.
All other bits are unused, and therefore set to 0.

Questionable Status
Bit 3 is set if a weak power supply has been detected (DC supply,
battery low).
Bit 14 is set if a questionable command has been received (for
example, starting the scan trace or printout with no valid trace
data).
All other bits are unused, and therefore set to 0.

26

Introduction to Programming

Status Command Summary

*STB?
*ESE
*ESE?
*ESR?
*OPC?

returns status byte, value 0 .. +255

sets the standard event status enable register, parameter 0 .. +255
returns SESE, value 0 .. +255
returns the standard event status register, value 0 .. +255
returns 1 if all operations (scan trace printout, measurement) are
completed. Otherwise it returns 0.
*CLS clears the status byte and SESR, and removes any entries from the error
queue.
*RST clears the error queue, loads the default setting, and restarts
communication.
NOTE: *RST does NOT touch the STB or SESR. A running
measurement is stopped.
*TST? initiates an instrument selftest and returns the results as a 32 bit LONG.
If a measurement is running, the status of the latest selftest is returned
and an error is set. +0 means "passed". The bits of the 32 bit long
integer have the following meaning:

27

Introduction to Programming

Mini-OTDR and Rack OTDR Bit Table

<-------- Overall State - "0" means passed, "1" means ST failed or not tested -------->
Bit 31 Bit 30 Bit 29 Bit 28 Bit 27 Bit 26 Bit 25 Bit 24 Bit 23 Bit 22 Bit 21 Bit 20 Bit 19
STError

Mainframe
State

Video
State

Batt
State

RTC
State

SMC
State

Check
Sum
State

Power
6V
State

Flash
State

Floppy
State

DAP
State

Sub- Module
Module State
State

Bits 15 .. 8

Bits 7 .. 0

Submodule Error

Module Error

Bits 18 .. 16

Unused

<----------------- Error code -----------------> <----------------- Error code ----------------->

Mainframe OTDR Bit Table

Bit 31

Bits 30 .. 26
unused

Selftest
ERROR

MSW:

Bit 23 Bit 22 Bit 21 Bit 20 Bit 19 Bit 18 Bit 17 Bit 16

FATAL ST nonST-Error fatal
Error

LSW:

28

Bit 25 Bit 24
Module IBI-test
Init
failed
failed

analog
summ

digital
summ

MOD
Temp.

LAS
Temp.

APD-L
Temp.

APD-H
Temp.

Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10

Bit 9

Bit 8

APDHV

RCVOFFS

OFFS
HILIN

OFFS
Higain

OFFS
Logain

RMS
HILIN

RMS
Higain

RMS
Logain

Bit 7

Bit 6

Bit 5

Bit 4

Bit 3

Bit 2

Bit 1

Bit 0

not used

DAPALU

DSPCode

CALData

LOGTable

SHOTRAM

DAPRAM

DSPRAM

Introduction to Programming

Other Commands
*RCL

recalls a pre-defined setting.

This is the same as *RCL on page 21, except that it is read from a
harddisk.
*SAV stores the current setting.
This is the same as *SAV on page 21, except that it is stored on a
harddisk.
*OPT? returns a string containing the installed options:
<FLOPPY opt>, <COLOR opt>.
For example, *OPT? FLOPPY, 0
An uninstalled option returns 0.
*WAI causes the remote control part of the instrument to wait for at least 2
seconds before continuing to parse commands. This gives the
instrument a chance to accomplish pending tasks.
The instrument returns to receiving commands after 2 seconds, or the
completion of a printout or scan trace or a limited measurement time
(averaging time > 0).
NOTE: During a running measurement *WAI does NOT wait for the
scan trace to finish as it runs continuously.
*IDN? is an identification string, like *LRN? on page 21.
*FTY resets the defaults and reboot
(not possible on Mainframe OTDR)

29

Introduction to Programming

30

Specific Commands

Specific Commands

This chapter gives information about the HP/Agilent OTDR remote

commands. It lists all the remote commands relating to OTDRs,
with a single-line description.
Each of these summaries contains a page reference for more
detailed information about the particular command later in this
manual.

32

Specific Commands

2.1 Specific Command Summary

The commands are ordered in a command tree. Every command
belongs to a node in this tree.
The root nodes are also called the subsystems. A subsystem
contains all commands belonging to a specific topic. In a subsystem
there may be further subnodes.
All the nodes have to be given with a command. For example in the
command hcop:item:all
HCOPy is the subsystem containing all commands for
controlling the print out,
ITEM is the subnode that provides selecting what should be
printed,
ALL is the command selecting everything for the print out.
NO T E

If a command and a query are both available, the command ends /?.
So, disp:brig/? means that disp:brig and disp:brig? are
both available.
Table 2-1 gives an overview of the command tree. You see the
nodes, the subnodes, and the included commands.

33

Specific Commands

Command

Description

ABORt[1/2]

Stops a running measurement.

Page
79

CALCulate:MATH:EXPRession
:NAME?

Allows calculating loss and attenuation values.

87

:REFLex?

Calculates Reflectance.

87

:SPLice?

Calculates Splice Loss.

88

:TYPE/?

Sets/queries whether Reflection Height or Reflectance is

used.

88

:BRIGhtness/?

Changes or queries the current LCD brightness.

123

:CONTrast/?

Changes or queries the current LCD contrast.

123

:ENABle/?

Enables, disables, or checks the internal LCD.

124

DISPLay

DISPLay[:WINDow]:GRAPhics
:COLor/?

Changes or queries the trace color.

125

:LTYPe/?

Changes or queries the trace linestyle.

125

DISPLay[:WINDow]:TEXT
:DATA/?

Sets or requests a comment.

126

Changes or queries the zooming mode (full trace or zoom)

127

DISPLay[:WINDow]:X
:SCALe/?

DISPLay[:WINDow]:X[:SCALe]
:PDIVision/?

Changes or queries the scaling of the X-axis.

128

DISPLay[:WINDow]:Y[:SCALe]
:PDIVision/?

Changes or queries the scaling of the Y-axis.

129

Reads current power meter value (triggers a measurement).

79

FETCh[:SCALar]
:POWer[:DC]?

Table 2-1

Specific Command Summary

34

Specific Commands

Command

Description

Page

HCOPy
:ABORt

Cancels the current print job.

130

:DESTination/?

Changes or queries the active printer.

130

[:IMMediate]

Immediately starts printing everything selected.

131

Start printing everything.

132

HCOPy:ITEM
:ALL[:IMMediate]

HCOPy:ITEM[:WINDow]
[:IMMediate]

Immediately starts printing the parameter window.

132

:STATe/?

Enables or queries printing the parameter window.

132

HCOPy:ITEM[:WINDow]:TEXT
[:IMMediate]

Immediately starts printing the event table.

133

:STATe/?

Enables or queries printing the event table.

133

HCOPy:ITEM[:WINDow]:TRACe
[:IMMediate]

Immediately starts printing the trace.

134

:STATe/?

Enables or queries printing the trace.

133

HCOPy:ITEM[:WINDow]:TRACe:GRATicule
:STATe/?

Enables or queries printing the trace window grid.

135

Selects or queries the size of the paper.

136

HCOPy:PAGE
:SIZE/?

INITiate[1][:IMMediate]
[:ALL]

INITiate2
:CONTinuous/?

KEYBoard
Table 2-1

Starts a measurement.

80

Starts a power meter measurement.

80

Starts or Queries a single/continuous power meter

measurement.

80

Allows the use of a terminal as an external keyboard

81

Specific Command Summary (continued)

35

Specific Commands

Command

Description

Page

MMEMory
:CATalog?

Returns contents of current directory.

137

:CDIRectory/?

Changes or queries the current directory.

138

:DELete

Deletes a file.

138

:FREE

Reclaims free space.

139

:FREE?

Returns the amount of free space and the amount used

139

:INITialize

Formats the specified storage device

139

:MDIRectory

Creates a directory on the current storage device.

140

:MSIS/?

Changes or queries the current storage device.

141

:NAME/?

Changes or queries the name of the current trace.

141

Copies a file to a new name/device

138

:FILE?

Returns a Bellcore binary file.

140

:STATe

Loads a settings file.

140

:TRACe

Loads a trace file.

140

Downloads a Bellcore binary file

142

:STATe

Saves a settings file.

142

:TRACe

Saves a trace file.

142

:TRACe:REVision/?

Sets or requests the Bellcore file revision used.

142

:CHECk:LIMit/?

Sets or queries the Pass/Fail Test limits

83

:EXECute

Executes a special task.

85

MMEMory:COPY
:FILE

MMEMory:LOAD

MMEMory:SAVE
:FILE

MMEMory:STORe

PROGram:EXPLicit

Table 2-1

Specific Command Summary (continued)

36

Specific Commands

Command

Description

Page

:NUMBer/?

Sets or requests the threshold in mdB

85

:STATe/?

Controls a running task.

86

Reads current power meter value (no measurement

triggered).

82

Sets or queries the current averaging time.

89

READ[:SCALar]
:POWer[:DC]?

SENSe:AVERage
:COUNt/?

SENSe:AVERage:COUNt
Sets or queries the number of averages for measurements

90

[:FUNCtion]/?

Sets or queries the current measurement mode.

91

[:FUNCtion:]AUTO/?

Enables or checks the auto mode.

92

:NUMBer/?

SENSe:DETector

[:FUNCtion:]OPTimize/? Sets or queries the optimization mode.

92

:MODE/?

93

Sets or returns the current Mini-OTDR mode

SENSe:DETector:SAMPle
Returns the current sample distance.

94

:REFRindex/?

Sets or returns the current refractive index.

94

:SCATtercoeff/?

Sets or returns the current scatter coefficient.

95

:TYPE?

Returns the current fiber type.

95

:FREQuency?

Queries the detected power meter input frequency

96

:REFerence/?

Sets or Queries the power meter reference value.

96

:UNIT/?

Sets or Queries the power meter power units.

98

:WAVelength/?

Sets or Queries the power meter wavelength.

98

:DISTance?

SENSe:FIBer

SENSe:POWer

Table 2-1

Specific Command Summary (continued)

37

Specific Commands

Command

Description

Page

SENSe:POWer:REFerence
:DISPlay

Takes current power meter value as reference value.

97

:STATe/?

Sets or Queries type of power meter display (relative or

absolute).

97

Sets or returns the horizontal offset

101

[SOURce:]
HOFFset/?

WAVelength[1/2][:CW]/? Sets or returns the current wavelength.

108

[SOURce:]AM[:INTERNAL]
:FREQuency[1/2]/?

Sets or returns frequency of chosen source.

100

[SOURce:]MARKer1/2/3
:POINt/?

Sets or returns the position of the marker.

102

[:STATe]/?

Activates, disables, or checks the marker.

103

:STATe[1/2]

Switches the laser of the chosen source on or off.

104

:STATE[1/2]?

Queries the state of the chosen source.

104

:WIDTh/?

Sets or returns the pulsewidth.

104

:WIDTh:LLIMit?

Returns the lower limit of the measurement hardware.

105

:WIDTh:ULIMit?

Returns the upper limit of the measurement hardware.

105

:LUNit/?

Sets or returns the current length unit.

106

:SPAN/?

Sets or returns the current measurement span.

106

:STARt/?

Sets or returns the current measurement start.

107

SOURce:POWer

[SOURce:]PULSe

[SOURce:]RANGe

[SOURce:]WAVelength[1/2][:CW]
AVAilable?

Table 2-1

Returns the available wavelength(s)

Specific Command Summary (continued)

38

109

Specific Commands

Command

Description

Page

STATus
Presets all registers and queues.

58

[:EVENt]?

Returns the event register.

56

:CONDition?

Returns the condition register.

56

:ENABle/?

Sets or queries the enable mask for the event register.

56

:ACDC?

Queries how the battery is powered.

57

:CAPacity?

Returns the power capacity of the battery.

57

:CURRent?

Returns the current of the battery in mA.

58

:REMain?

Returns the operating time in minutes.

58

[:EVENt]?

Returns the event register.

59

:CONDition?

Returns the condition register.

59

:ENABle/?

Sets or queries the enable mask for the event register.

59

:BRIDge

Passes communication from serial port 1 to serial port 2

61

:DATE/?

Sets or returns the OTDRs internal date.

69

:ERRor?

Returns the contents of the OTDRs error queue.

70

:HELP?

Returns a Help page on a specified topic

70

:KEY/?

Simulates or Returns a key stroke on the OTDRs front panel. 71

:PRESet

Loads a predefined instrument setting.

73

:SET/?

Sets or returns the current setting

73

:TIME/?

Sets or returns the OTDRs internal time.

74

:UPTime?

Returns the time (in seconds) run on the OTDR

74

:PRESet

STATus:OPERation

STATus:POWer

STATus:QUEStionable

SYSTem

Table 2-1

Specific Command Summary (continued)

39

Specific Commands

Command

Description

:VERSion?

Returns the OTDRs SCPI version

Page
75

SYSTem:COMMunicate
:GPIB[:SELF]:ADDRess/?Sets or returns the OTDRs GPIB address.

61

SYSTem:COMMunicate:SERial
:FEED/?

Sends a command or query to serial port 2

64

[:RECeive]:PORT?

Returns the port used (RS232 or RS485) by the Rack OTDR

68

[:RECeive]:SBITS/?

Sets or queries the number of stop bits.

68

SYSTem:COMMunicate:SERial[1|2][:RECeive]
:BAUD/?

Sets or queries the baud rate.

62

:BITS/?

Sets or queries the number of data bits.

63

:PACE/?

Sets or queries the pace for the communication.

65

:PARity[:TYPE]/?

Sends or returns the parity

66

:PARity:CHECk/?

Activates the parity.

67

:CATalog?

Returns positions and names of currently loaded traces.

110

:DATA?

Reads a complete trace data array.

111

:DELete

Closes the current trace.

117

:DELete:ALL

Closes all loaded traces.

117

:FEED:CONTrol/?

Sets or queries the current trace.

117

:FREE?

Returns the number of unused trace array values.

118

:POINts

Sets the number of samples for the current trace.

118

:POINts?

Returns the number of data points of the current trace.

119

:FCRetloss?

Returns the Front Connector return loss

112

:LINE?

Reads samples

114

TRACe

TRACe:DATA

Table 2-1

Specific Command Summary (continued)

40

Specific Commands

Command

Description

Page

:TABLe?

Returns an event table.

115

:TABLe:LOCK/?

Sets or queries whether or not event table is locked.

115

:TORL?

Returns the total optical return loss

116

:VALue?

Returns a measured value at a sample point.

116

:TABLe?

Returns a Pass/Fail Test table.

111

:STATe?

Queries the Pass/Fail Test Table state.

112

TRACe:DATA:CHECk

TRACe:DATA:LANDmark
:ADD

Adds a landmark

112

:DELete

Deletes a landmark

113

Sets/queries whether traffic detection is on or off

82

TRAFficdet/?
Table 2-1

Specific Command Summary (continued)

41

Specific Commands

42

Instrument Setup and

Status

Instrument Setup and

Status
This chapter gives descriptions of commands that you can use when
setting up your OTDR. The commands are split into the following
separate subsystems:
IEEE Specific commands: which were introduced in Common
Commands on page 20
:STATUS: commands which relate to the status model.
:SYSTEM: commands which control the serial interface and
internal data.
Other commands are described in Chapter 4 Operations on Traces
and Measurements, and Chapter 5 Mass Storage, Display, and
Print Functions.

44

Instrument Setup and Status

3.1 IEEE-Common Commands

Common Commands on page 20 gave a brief introduction to the
IEEE-common commands which can be used with OTDRs. This
section gives fuller descriptions of each of these commands.
command:
syntax:
description:

parameters:
response:
example:
affects:

*CLS
*CLS
The CLear Status command *CLS clears all the event registers summarized
in the Status Byte register.
Except for the output queue, all queues summarized in the Status Byte
register are emptied. The error queue is emptied.
Neither the Standard Event Status Enable register, nor the Service Request
Enable register are affected by this command.
After the *CLS command the instrument is left in the idle state. The
command does not alter the instrument setting.
none
none
*CLS

All instruments

45

Instrument Setup and Status

command:
syntax:
description:

parameters:

response:
example:
affects:
command:
syntax:
description:

parameters:
response:
example:
affects:

*ESE
*ESE<wsp><value>
The standard Event Status Enable command (*ESE) sets bits in the
Standard Event Status Enable register.
A 1 in a bit in the enable register enables the corresponding bit in the
Standard Event Status register.
The register is cleared at power-on. The *RST and *CLS commands do not
affect the register.
The bit value for the register (a short or a float):
Bit
Mnemonic
Decimal Value
7 (MSB)
Power On
128
6
User Request
64
5
Command Error
32
4
Execution Error
16
3
Device Dependent Error
8
2
Query Error
4
1
Request Control
2
0 (LSB)
Operation Complete
1
none
*ESE 21
All instruments
*ESE?
*ESE?
The standard Event Status Enable query *ESE? returns the contents of the
Standard Event Status Enable register (see *ESE for information on this
register).
none
The bit value for the register (a short value).
*ESE? 21<END>

All instruments

46

Instrument Setup and Status

command:
syntax:
description:
parameters
response

example:
affects:

command:
syntax:
description:
parameters:
response:
example:
affects:

*ESR?
*ESR?
The standard Event Status Register query *ESR? returns the contents of the
Standard Event Status register. The register is cleared after being read.
none
The bit value for the register (a short or a float):
Bit
Mnemonic
Decimal Value
7 (MSB) Power On
128
6
User Request
64
5
Command Error
32
4

Execution Error

16

Device Dependent Error

Query Error

4
2
1

1
Request Control
0 (LSB) Operation Complete
*ESR? 21<END>

All instruments
*FTY
*FTY
The FacTorY defaults command *FTY resets your OTDR to the factory
defaults and reboots the OTDR.
none
none
*FTY
Mini-OTDR, Mini-FBL and Rack OTDR

47

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:

example:

NOTE

*IDN?
*IDN?
The IDeNtification query *IDN? gets the instrument identification over the
interface.
none
The identification terminated by <END>:
HP E6000 Mini-Optical Time Domain Reflectometer Mainframe:
nnnnnnnnnn, Module: mmmmmmmmmm SW_Rev i.j
manufacturer
HP:
instrument model number (for example E6000)
mmmm:
serial number
ssssssss
firmware revision level
rrrrrrrrrr
Software Revision number, for example 1.1 or 1.0
SW_Rev i.j
*IDN? HP E6000 Mini Optical Time Domain
Reflectometer Mainframe 0123456789, Module:
ABCDE54321 SW_Rev 6.0<END>
The response from *IDN? for Mini FBLs, Rack OTDRs and
Mainframe OTDRs is respectively:

Agilent E6020A Fiber Break Locator Instrument...

HP E60xxA Rack Optical Time Domain Reflectometer...

and
HP 8147 Optical Time Domain Reflectometer...

affects:

All instruments

48

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

command:
syntax:
description:

*LRN?
*LRN?
The LeaRN query *LRN? reads the complete instrument setting in a binary
block. The binary block can be directly stored as a setting file.
none
Binary block.
*LRN? binblock

All instruments
*OPC?
*OPC?
The OPeration Complete query *OPC? parses all program message units in
the input queue.
If a print, measurement or scan trace is active, *OPC? returns 0. Otherwise,
*OPC? returns 1.
The following actions cancel the *OPC? query (and put the instrument into
Operation Complete, Command Idle State):

parameters:
response:
example:
affects:

Power-on
the Device Clear Active State is asserted on the interface.
*CLS
*RST
none
0<END> print, measurement, Scan Trace active, or
1<END>
*OPC? 1<END>

All instruments

49

Instrument Setup and Status

command:
syntax:
description:

parameters:
response:

*OPT?
*OPT?
The OPTions query *OPT? gets a list of the installed options over the
interface. All three options are always listed, in the same order, separated
by commas. If an option is not installed in the instrument, 0 is sent in its
position in the list.
none
Mini-OTDR / Mini-FBL response:
module-type|0, FLOPPY|0, COLOR|0, EXTFLASH|0,
submodule-type : submodule serial no|0
Rack OTDR response:
module-type|0, FLOPPY|0, COLOR|0, EXTFLASH|0,
submodule-type : submodule serial no|0 RS232|RS485
Mainframe OTDR response:
module-type|0, DC|0, PRINTER|0, COLOR|0, HPIB|0, LAN|0

NOTE

The second and third arguments for the Rack OTDR (FLOPPY
and COLOR) are included for the sake of consistency.
The Rack OTDR has no floppy option, and is always configured as
a color unit.

NOTE

In this release of the Mini-OTDR and Rack OTDR, the fourth

argument (EXTFLASH) will always be 0.

example:

affects:

Mini-OTDR / Mini-FBL example:

*OPT? E6003A, FLOPPY, 0, 0, E6006A :
DE13A00108<END>
Rack OTDR example:
*OPT? E6053A, 0, 0, 0, 0 RS485<END>
Mainframe OTDR example:
*OPT? E4316A, DC, 0, 0, HPIB, LAN<END>

All instruments

50

Instrument Setup and Status

command:
syntax:
description:

parameters:
response:
related commands
example:
affects:

*RCL
*RCL<wsp><location>
The instrument setting is changed to one saved on the internal storage
device. Saved settings are in the form n.SET, so *RCL 2 recalls setting
SET2.SET.
a short value (between 0 and 5) giving the number of the setting to be
saved.
none
*SAV
*RCL 3

Mini-OTDR, Rack OTDR, and Mainframe OTDR

51

Instrument Setup and Status

command:
syntax:
description:

*RST
*RST
The ReSeT command *RST sets the instrument to reset setting (standard
setting) stored in internal storage.
Pending *OPC? actions are cancelled.
The instrument is placed in the idle state awaiting a command. The *RST
command clears the error queue.
The following are not changed:
Output queue
Service Request Enable register (SRE)
Standard Event Status Enable register (ESE)

The following parameters are reset

parameters:
response:
example:
affects:

Start: 0 km (Auto)
Stop: 2 km (Auto) (Mini and Rack); 40 km (Auto) (Mainframe OTDR)
Pulsewidth: 1 s (Auto)
First Wavelength: 1310 nm
Refractive Index, Scatter Coefficient: nominal for 1310 nm
Measurement Mode: Averaging
Averaging Time: 3 min (Mini and Rack); unlimited (Mainframe OTDR)
Optimize Mode: Standard
Data Points: 16000
Front Connector Threshold: -30 dB
Reflective Threshold: 0
Non-Reflective Threshold: 0
End Threshold: 5 dB (Mini and Rack); 3 dB (Mainframe OTDR)
none
none
*RST

All instruments

52

Instrument Setup and Status

command:
syntax:
description:

parameters:
related commands:
response:
example:
affects:

*SAV
*SAV<wsp><location>
With the SAVe command *SAV the instrument setting is stored on the
internal storage device. The instrument can store 4 settings, in locations 1 to
4. The scope of the saved setting is identical to the standard setting (see
*RST).
Settings are in the form n.SET, so *SAV 2 saves the current setting as
SET2.SET.
a short value (between 0 and 5) giving the number of the setting to be
saved.
*RCL
none
*SAV 3

Mini-OTDR, Rack OTDR, and Mainframe OTDR

53

Instrument Setup and Status

command:
syntax:
description:

parameters:
response:

example:
affects:

command:
syntax:
description:

parameters:
response:
example:
affects:

*STB?
*STB?
The STatus Byte query *STB? returns the contents of the Status Byte
register.
The Master Summary Status (MSS) bit is true when any enabled bit of the
STB register is set (excluding Bit 6). The Status Byte register including, the
master summary bit, MSS, is not directly altered because of an *STB?
query.
none
The bit value for the register (a short value):
Bit
Mnemonic
Decimal Value
7 (MSB)
Operation Status
128
6
Master Summary Status
64
5
Event Status Bit
32
4
Message Available
16
3
Questionable Status
8
2
Not used
0
1
Not used
0
0 (LSB)
Laser Active Bit
1
*STB? 1<END>

All instruments
*TST?
*TST?
The self-TeST query *TST? makes the instrument perform a self-test and
place the results of the test in the output queue.
No further commands are allowed while the test is running. After the selftest the instrument is returned to the setting that was active at the time the
self-test query was processed.
none
The sum of the results for the individual tests (a 32-bit signed integer
value):
*TST? 0<END>

All instruments

54

Instrument Setup and Status

command:
syntax:
description:

parameters:
response:
example:
affects:

*WAI
*WAI
The WAIt command *WAI prevents the instrument from executing any
further commands until the current command has finished executing. All
pending operations are completed during the wait period.
none
none
*WAI

All instruments

55

Instrument Setup and Status

3.2 Status Reporting The STATus Subsystem

The Status subsystem allows you to return and set details from the
Status Model. For more details, see HP/Agilent OTDR Status
Model on page 23

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:OPERation[:EVENt]?
STATus:OPERation[:EVENt]?
Queries the operation event register
none
The bit value for the operation event register as a short value
(0 .. +32767)
stat:oper? +0<END>
All instruments
STATus:OPERation:CONDition?
STATus:OPERation:CONDition?
Queries the operation condition register
none
The bit value for the operation condition register as a short value
(0 .. +32767)
stat:oper:cond? +16<END>
All instruments
STATus:OPERation:ENABle
STATus:OPERation:ENABle<wsp><value>
Sets the operation enable mask for the event register
The bit value for the operation enable mask as a short value
(0 .. +32767)
none
stat:oper:enab 128

All instruments
56

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:OPERation:ENABle?
STATus:OPERation[:ENABle]?
Returns the operation enable mask for the event register
none
The bit value for the operation enable mask as a short value
(0 .. +32767)
stat:oper:enab? +128<END>
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:POWer:ACDC?
STATus:POWer:ACDC?
Queries how the battery is powered.
none
AC, DC or CHARging
stat:pow:acdc? AC<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:POWer:CAPacity?
STATus:POWer:CAPacity?
Returns the power capacity of the battery.
none
percentage capacity of the battery
stat:pow:cap? 75%<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

57

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
NOTE

STATus:POWer:CURRent?
STATus:POWer:CURRent?
Returns the current of the battery in mA.
none
Battery current
If the battery is discharging, the returned value will be negative.
If the battery is charging, the returned value will be positive.
stat:pow:curr? 200MA<END>

example:
affects:

Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:POWer:REMain?
STATus:POWer:REMain?
Returns the operating time in minutes
none
Remaining time
stat:pow:rem? 180MIN<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:PRESet
STATus:PRESet
Resets both enable masks to 0.
none
none
stat:pres

All instruments

58

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:QUEStionable[:EVENt]?
STATus:QUEStionable[:EVENt]?
Queries the questionable event register
none
The bit value for the questionable event register as a short value
(0 .. +32767)
stat:ques? +0<END>
All instruments
STATus:QUEStionable:CONDition?
STATus:QUEStionable:CONDition?
Queries the condition register
none
The bit value for the questionable condition register as a short value
(0 .. +32767)
stat:ques:cond? +8<END>
All instruments
STATus:QUEStionable:ENABle
STATus:QUEStionable:ENABle<wsp><value>
Sets the questionable enable mask for the event register
The bit value for the questionable enable mask as a short value
(0 .. +32767)
none
stat:ques:enab 128

All instruments

59

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

STATus:QUEStionable:ENABle?
STATus:QUEStionable[:ENABle]?
Returns the questionable enable mask for the event register
none
The bit value for the questionable enable mask as a short value
(0 .. +32767)
stat:ques:enab? +128<END>
All instruments

60

Instrument Setup and Status

3.3 Interface/Instrument Behaviour Settings

The SYSTem Subsystem
The SYSTem subsystem lets you control the instruments serial
interface. You can also control some internal data (like date, time
zone, and so on)

command:
syntax:
description:

parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:BRIDge
SYSTem:BRIDge
Allows you to send and receive data from the instrument connected
to Serial1 to the instrument connected to Serial 2.
Data characters are passed between Serial 1 and Serial 2 until the
command #SCPI is detected.
none
none
syst:brid

Rack OTDR only

SYSTem:COMMunicate:GPIB[:SELF]:ADDRess
SYSTem:COMMunicate:GPIB[:SELF]:ADDRess<wsp><value>
Sets the OTDRs GPIB address.
Valid values for the address are 1 .. 32 (a short value).
none
syst:comm:gpib:addr 15

Mainframe OTDR only

61

Instrument Setup and Status

.
command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:COMMunicate:GPIB[:SELF]:ADDRess?

Mainframe OTDR only

command:
syntax:
description:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:BAUD
SYSTem:COMMunicate:SERial[:RECeive]:BAUD<wsp><value>
Sets the baud rate for the OTDR serial interface

SYSTem:COMMunicate:GPIB[:SELF]:ADDRess?
Queries the OTDRs current GPIB address.
none
Possible values for the address are 1 .. 32 (a short value).
syst:comm:gpib:addr? +15<END>

NOTE

You can choose Serial 1 or 2 for the Rack OTDR only.

If you are using a Rack OTDR, and you do not specify a serial port
number, the baud rate for Serial 1 is set.

NOTE

All changes take effect immediately. After this command, you

must reconfigure your RS232 to continue communication.

parameters:
response:
example:
affects:

Valid baud rates are 1200, 2400, 9600, 19200,38400, 57600, 115200.
none
syst:comm:ser:baud 9600

All instruments

62

Instrument Setup and Status

command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:BAUD?
SYSTem:COMMunicate:SERial[1|2][:RECeive]:BAUD?
Returns the current baud rate for the OTDR serial interface
You can choose Serial 1 or 2 for the Rack OTDR only.
If you are using a Rack OTDR, and you do not specify a serial port
number, the baud rate for Serial 1 is returned.

none
Possible baud rates are 1200, 2400, 9600, 19200, 38400, 57600,
115200
syst:comm:ser:baud? +9600<END>
All instruments
SYSTem:COMMunicate:SERial[:RECeive]:BITS
SYSTem:COMMunicate:SERial[:RECeive]:BITS<wsp><value>
Sets the number of data bits for the OTDRs serial interface.
All changes take effect immediately. After this command, you
must reconfigure your RS232 to continue communication.
Valid numbers are 5 .. 8
none
syst:comm:ser:bits 6

Mainframe OTDR only

SYSTem:COMMunicate:SERial[:RECeive]:BITS?
SYSTem:COMMunicate:SERial[:RECeive]:BITS?
Returns the number of data bits for the OTDRs serial interface.
none
Possible numbers are 5 .. 8
syst:comm:ser:bits +6<END>

Mainframe OTDR only

63

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:COMMunicate:SERial:FEED
SYSTem:COMMunicate:SERial:FEED<wsp><command>
Send a command to the instrument connected to Serial 2
The command given as a text string in "".
none

command:
syntax:
description:
parameters:
response:
example:

SYSTem:COMMunicate:SERial:FEED?
SYSTem:COMMunicate:SERial:FEED?<wsp><query>
Send a query to the instrument connected to Serial 2
The query given as a text string in "".
none
syst:comm:ser:feed? "*idn?" HP E6000 Mini-

syst:comm:ser:feed "init"

Rack OTDR and Mainframe OTDR

Optical Time Domain Reflectometer Mainframe

0123456789, Module: ABCDE54321 SW_Rev 6.0<END>

affects:

Rack OTDR only

64

Instrument Setup and Status

command:
syntax:
description:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE<wsp>
<pace>
Sets the pace for the OTDR serial interface

NOTE

You can choose Serial 1 or 2 for the Rack OTDR only.

If you are using a Rack OTDR, and you do not specify a serial port
number, the pace for Serial 1 is set.
You cannot use this command with a Rack OTDR Option 006
(RS485), as this does not have hardware handshaking.

NOTE

parameters:

All changes take effect immediately. After this command, you

must reconfigure your RS232 to continue communication.

Valid values are NONE, HARDware, XONXoff.

NOTE

response:
example:
affects:

XONX is only available with the Mainframe OTDR.

However, for binary disk transfers HARD is recommended, and
XONX is forbidden

none
syst:comm:ser:pace hard

All instruments

65

Instrument Setup and Status

command:
syntax:
description:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE?
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE?
Returns the pace for the OTDR serial interface

NOTE

parameters:
response:

You can choose Serial 1 or 2 for the Rack OTDR only.

If you are using a Rack OTDR, and you do not specify a serial port
number, the pace for Serial 1 is requested.

none
Possible values are NONE, HARDware, and XONXoff.

NOTE

example:
affects:
command:
syntax:
description:

XONX is only available with the Mainframe OTDR.

syst:comm:ser:pace? HARD<END>

All instruments
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity
[:TYPE]
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity[:TYPE]<wsp>
<parity>
Sets the type of parity checking for the OTDRs serial interface.

NOTE

You can choose Serial 1 or 2 for the Rack OTDR only.

If you are using a Rack OTDR, and you do not specify a serial port
number, the parity type for Serial 1 is set.

NOTE

All changes take effect immediately. After this command, you

must reconfigure your RS232 to continue communication.

parameters:
response:
example:
affects:

Valid values are NONE, ODD, EVEN.

none
syst:comm:ser:par odd

All instruments

66

Instrument Setup and Status

command:
syntax:
description:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity
[:TYPE]?
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity[:TYPE]?
Returns the type of parity checking for the OTDRs serial interface.

NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:

You can choose Serial 1 or 2 for the Rack OTDR only.

If you are using a Rack OTDR, and you do not specify a serial port
number, the parity type for Serial 1 is requested.

none
Possible values are NONE, ODD, EVEN.
syst:comm:ser:par? ODD<END>

All instruments
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity:
CHECk
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity:CHECk<wsp>
<boolean>
Determines whether parity checking is enabled for the OTDRs serial
interface.
You can choose Serial 1 or 2 for the Rack OTDR only.
If you are using a Rack OTDR, and you do not specify a serial port
number, the parity for Serial 1 is checked.
Possible values are 0 and 1
none
syst:comm:ser:par:chec 1

All instruments

67

Instrument Setup and Status

command:
syntax:
description:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity
:CHECk?
SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity:CHECk?
Queries whether parity checking is enabled for the OTDRs serial interface.

NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:

You can choose Serial 1 or 2 for the Rack OTDR only.

If you are using a Rack OTDR, and you do not specify a serial port
number, the parity checking state for Serial 1 is requested.

none
Possible values are

0: checking disabled
1: checking enabled
syst:comm:ser:par:chec? 1<END>

All instruments
SYSTem:COMMunicate:SERial:PORT?
SYSTem:COMMunicate:SERial:PORT?
Inquires the type of second serial port that is configured (Rack
OTDR only).
none
RS232 or RS485
syst:comm:ser:port? RS485<END>
Rack OTDR only
SYSTem:COMMunicate:SERial[:RECeive]:SBITS
SYSTem:COMMunicate:SERial[:RECeive]:SBITS<wsp><bits>
Sets the number of stop bits for the OTDRs serial interface.
All changes take effect immediately. After this command, you
must reconfigure your RS232 to continue communication.
Valid numbers are ONE, ONEHalf, TWO
none
syst:comm:ser:sbit two

Mainframe OTDR only

68

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:COMMunicate:SERial[:RECeive]:SBITS?
SYSTem:COMMunicate:SERial[:RECeive]:SBITS?
Returns the number of stop bits for the OTDRs serial interface.
none
Possible values are ONE, ONEHalf, TWO
syst:comm:ser:sbit? TWO<END>

Mainframe OTDR only

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:DATE
SYSTem:DATE<wsp><day>,<month>,<year>
Sets the OTDRs internal date.
The date in the format day, month,year (short values)
none

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:DATE?
SYSTem:DATE?
Returns the OTDRs internal date.
none
The date in the format day, month,year (short values)
syst:date? +20,+7,+1995<END>
All instruments

syst:date 20,7,1995

All instruments

69

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:

response:
example:

affects:

SYSTem:ERRor?
SYSTem:ERRor?
Returns the contents of the OTDRs error queue. Removes the
returned entry from the queue.
none
The number of the latest error, and its meaning.
syst:err? -113,"Undefined header"<END>
All instruments
SYSTem:HELP?
SYSTem:HELP?<wsp><keyword>
Returns a help page corresponding to the specified keyword.
keyword given as a string in "". For example, "SYSTem",
"SOURce", "DISPlay", "IEEEcommon".
"" returns a list of valid keywords.
A Binary block containing the help page.
syst:help? "syst" #3316[help_page]<END>
All instruments

70

Instrument Setup and Status

command:
syntax:
description:
parameters:

SYSTem:KEY
SYSTem:KEY<wsp><code>
Simulates keystrokes on the OTDRs frontpanel.
Valid key codes are as follows:
Mini-OTDR / Mini-FBL Rack OTDR
Mainframe OTDR

0:Select key.
1:Run/Stop key.
2:Up key
3:Down key
4:Left key
5:Right key
6:Help key

response:
example:
affects:

none
syst:key? 1<END>

All instruments

71

0: Enter/Return
1: <f2>
2: Up arrow
3: Down arrow
4: Left arrow
5: Right arrow
6: <f1>

0: Enter (RPG-click)
1: Softkey 1 (topmost)
2: Softkey 2
3: Softkey 3
4: Softkey 4
5: Softkey 5
6: Softkey 6
7: Help
8: Zoom Horizontal Out
9: Zoom Vertical In
10: Zoom Vertical Out
11: Zoom Horizontal In
12: Next marker
13: Print
14: Full Trace
15: Save
16: Trace/Event
17: Around Marker
18: Auto
19: Run/Stop
20: Decrease Brightness
21: Increase Brightness

Instrument Setup and Status

command:
syntax:
description:

SYSTem:KEY?
SYSTem:KEY?
Returns either the last keystroke entered on the OTDR frontpanel
(not possible on Mainframe OTDR), or the last keystroke emulated
by the SYSTem:KEY remote command (all instruments).

parameters:
response:

none
Valid key codes are as follows:
Mini-OTDR / Mini-FBL Rack OTDR

0:Select key.
1:Run/Stop key.
2:Up key
3:Down key
4:Left key
5:Right key
6:Help key

example:
affects:

0: Enter/Return
1: <f2>
2: Up arrow
3: Down arrow
4: Left arrow
5: Right arrow
6: <f1>

syst:key? 1<END>

All instruments

72

Mainframe OTDR

0: Enter (RPG-click)
1: Softkey 1 (topmost)
2: Softkey 2
3: Softkey 3
4: Softkey 4
5: Softkey 5
6: Softkey 6
7: Help
8: Zoom Horizontal Out
9: Zoom Vertical In
10: Zoom Vertical Out
11: Zoom Horizontal In
12: Next marker
13: Print
14: Full Trace
15: Save
16: Trace/Event
17: Around Marker
18: Auto
19: Run/Stop
20: Decrease Brightness
21: Increase Brightness

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:PRESet
SYSTem:PRESet
Loads a predefined instrument setting that is also loaded on power
on.
none
none
syst:pres
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:SET
SYSTem:SET<wsp><setting>
Sets the specified instrument setting from a binary block.
binary block
none
syst:set binblock
Mini-OTDR, Rack OTDR, and Mainframe OTDR

command:
syntax:
description:

SYSTem:SET?
SYSTem:SET?
Reads the complete instrument setting in a binary block. The binary
block can be directly stored as a setting file.
none
binary block
syst:set? binblock
All instruments

parameters:
response:
example:
affects:

73

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:TIME
SYSTem:TIME<wsp><hour>,<minute>,<second>
Sets the OTDRs internal time.
The time in the format hour,minute,second. Hours are counted 0...23
(short values).
none
syst:time 20,15,30
All instruments
SYSTem:TIME?
SYSTem:TIME?
Returns the OTDRs internal time.
none
The time in the format hour,minute,second. Hours are counted 0...23
(short values).
syst:time? +20,+15,+30<END>
All instruments
SYSTem:UPTime?
SYSTem:UPTime?
Returns the time (in seconds) since you switched on your OTDR.
none
The time in seconds (int32 value).
syst:upt? 240<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

74

Instrument Setup and Status

command:
syntax:
description:
parameters:
response:
example:
affects:

SYSTem:VERSion?
SYSTem:VERSion?
Returns the SCPI revision to which the OTDR complies.
none
The revision year and number.
syst:vers? 1995.0<END>
All instruments

75

Instrument Setup and Status

76

Operations on Traces and

Measurements

Operations on Traces
and Measurements
This chapter gives descriptions of commands that you can use when
taking traces and measurements from your OTDR. The commands
are split into the following separate subsystems:
Root level commands: general commands.
:PROGRAM/:CALCULATE: commands which execute tasks
or calculate values.
:SENSE: commands which control measurement parameters.
:SOURCE: commands which control the optical source and
markers.
:TRACE: commands which relate to the traces in the OTDRs
memory.
Other commands are described in Chapter 3 Instrument Setup and
Status, and Chapter 5 Mass Storage, Display, and Print
Functions.

78

Operations on Traces and Measurements

4.1 Root Layer Commands

command:
syntax:
description:

ABORt[1/2]
ABORt[1/2]
Stops a running measurement: abor or abor1: on the OTDR
abor2: on the Visual Fault Finder

NOTE

You cannot use a Visual Fault Finder with a Mainframe OTDR.

This means that abor2 is not available.

parameters:
response:
example:
affects:

none
none

command:
syntax:
description:

FETCh[:SCAlar]:POWer[:DC]?
FETCh[:SCALar]:POWer[:DC]?
Reads the current power meter value.

NOTE

parameters:
response:
NOTE

example:
affects:

abor

All instruments

If the power meter is not running, a measurement is triggered.

none
The reference as a float value in dBm, W or dB.
If the reference state is absolute, units are dBm or W.
If the reference state is relative, units are dB.
fetc:pow? +4DBM<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

79

Operations on Traces and Measurements

command:
syntax:
description:

INITiate[1|2][:IMMediate][:ALL]
INITiate[1|2][:IMMediate][:ALL]
Starts a measurement: init or init1: internal source
init2: power meter

NOTE

You cannot use a Visual Fault Finder with a Mainframe OTDR.

This means that init2 is not available.

parameters:
response:
example:
affects:

none
none

command:
syntax:
description:
parameters:

INITiate2[:IMMediate]:CONTinuous

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

init

All instruments

INITiate2[:IMMediate]:CONTinuous<wsp><boolean>
Starts a power meter measurement.

A boolean value:

0 single measurement made

1 continuous measurement made

none
init2:cont 1

Mini-OTDR, Mini-FBL, and Rack OTDR

INITiate2[:IMMediate]:CONTinuous?
INITiate2[:IMMediate]:CONTinuous?
Queries whether power meter measurement is continuous

none
A boolean value:

0 single measurement
1 continuous measurement

init2:cont? 1<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

80

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
NOTE

KEYBoard
KEYBoard
Allows the use of a terminal as an external keyboard

none
none
keyb
keyb allows you to add text from a terminal (for example, when
specifying the name of a file to be saved). To use this facility, you should
do the following:

Attach your OTDR to a terminal. In this context, a terminal is any

PC or palmtop running a terminal program. The terminal should
have its own keyboard.
You can attach the terminal using an RS232 cable. For details of
attaching an RS232 cable to an OTDR, see the appropriate Guide.

Enter keyb from your terminal keyboard.

Enter text as required from your terminal keyboard. All text is

treated literally until you enter <CTRL>Z (ASCII character 26)
(see below).

To finish entering text, enter <CTRL>Z from your terminal

keyboard.

For example, after [File]<Save As..>New Name, you see a keyboard on

the OTDR screen. Instead of using this keyboard you can enter the
following text from your terminal:
keyb
T1.SOR
^Z

This is the equivalent of entering T1.SOR from the screen keyboard.

affects:

Mini-OTDR, Mini-FBL, and Rack OTDR

81

Operations on Traces and Measurements

command:
syntax:
description:
NOTE

parameters:
response:
NOTE

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

READ[:SCAlar]:POWer[:DC]?
READ[:SCALar]:POWer[:DC]?
Reads the current power meter value.
The power meter must be running for this command to be
effective

none
The reference as a float value in dBm, W or dB.
If the reference state is absolute, units are dBm or W.
If the reference state is relative, units are dB.
read:pow? +4DBM<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

TRAFficdet
TRAFficdet<wsp><onoff>
Turn traffic detection on or off
ON: turn traffic detection on
OFF: turn traffic detection off.
none
traf on

Mini-OTDR and Rack OTDR

TRAFficdet?
TRAFficdet?
Queries whether traffic detection is on or off
none
ON: traffic detection is on
OFF: traffic detection is off.
traf? ON<END>
Mini-OTDR and Rack OTDR

82

Operations on Traces and Measurements

4.2 Playing With Data The PROGram and

CALCulate Subsystems
The PROGram and CALCulate subsystems allow you to execute
special tasks and calculating several loss and attenuation values

command:
syntax:
description:
parameters:

PROGram:EXPLicit:CHECk:LIMit
PROGram:EXPLicit:CHECk:LIMit<wsp><param><wsp><value>
Set the Pass/Fail test limits for the specified parameter.
Valid values are as follows.
Units

Units

Limit

REFLective
mdB
10000 .. 65000
NONReflective
mdB
0 .. 5000
ATTenuation
mdB/km
0 .. 5000
CONNector loss
mdB
0 .. 5000
LOSS
mdB
0 .. 50000
LENGTh
mm
0 .. 500000000
TOLerance
mm
0 .. 50000000
NEW events
0=off, non-zero=on
SORT results
0=severity, 1=distance 0 or 1
The units specified above are implied, so you may only enter a
positive integer within the specified limits.
NOTE

response:
example:
affects:

For more information about the Pass/Fail test limits, please

consult the E6000C Mini-OTDR Users Guide (English Agilent
Product number E6000-91031).

none
prog:expl:chec:lim refl 30000

Mini-OTDR and Rack OTDR

83

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

response:
NOTE

example:
affects:

PROGram:EXPLicit:CHECk:LIMit?
PROGram:EXPLicit:CHECk:LIMit?<wsp><param>
Query the Pass/Fail test limits for the specified parameter.
Valid units are: REFLective
NONReflective
ATTenuation
CONNector loss
LOSS
LENGTh
TOLerance
NEW events
SORT results
The units and limits as the same as for
PROGram:EXPLicit:CHECk:LIMit on page 83.
For more information about the Pass/Fail test limits, please
consult the E6000C Mini-OTDR Users Guide (English Agilent
Product number E6000-91031).
prog:expl:chec:lim? refl -30000<END>

Mini-OTDR and Rack OTDR

84

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

PROGram:EXPLicit:EXECute
PROGram:EXPLicit:EXECute<wsp><task>
Allows executing special tasks on the OTDR.
A string specifying the task.
Currently only "scan" is valid on all instruments.
On the Mini-OTDR and Rack OTDR, you can also enter "check" to
start the Pass/Fail test.
Valid units are: SCAN: run a scan trace (not Mini-FBL)
CHECK: run a Pass/Fail Test (not Mini-FBL)
ORL?: inquire Optical Return Loss (not Mini-FBL)
TORL?: inquire Total ORL of a Link

NOTE

response:
example:
affects:
command:
syntax:
description:
parameters:

Because this command does not accept character data, you must
put quotation marks around the parameter scan or check.

none
prog:expl:exec "scan"

Mini-OTDR, Mini-FBL, and Rack OTDR

PROGram:EXPLicit:NUMBer
PROGram:EXPLicit:NUMBer<wsp><type>,<value>
Sets the threshold.
REFLective, NONReflective, or END
threshold value (int32) in mdB
On the Mini-FBL, only END is valid.

response:
example:
affects:

none
prog:expl:numb refl, 60000

All instruments

85

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

PROGram:EXPLicit:NUMBer?
PROGram:EXPLicit:NUMBer?<wsp><type>
Requests the threshold value.
REFLective, NONReflective, or END
On the Mini-FBL, only END is possible.

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

threshold value (int32) in mdB

prog:expl:numb? refl 60000<END>
All instruments
PROGram:EXPLicit:STATe
PROGram:EXPLicit:STATe<wsp>"scan",<boolean>
Allows terminating the currently running task
A boolean value: 0 terminate the task
1 no action
none
prog:expl:stat "scan",0

Mini-OTDR, Rack OTDR, and Mainframe OTDR

PROGram:EXPLicit:STATe?
PROGram:EXPLicit:STATe?<wsp>"scan"
Queries whether a task is still running.
none
A boolean value: 0 task is not running
1 task is still running
prog:expl:stat? "scan" 1<END>
All instruments

86

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:
NOTE

example:
affects:

CALCulate:MATH:EXPRession:NAME?
CALCulate:MATH:EXPRession:NAME?<wsp><expr>
Allows calculating several loss and attenuation values. All
calculations use the stretch between markers A and B.
Valid values are:
LOSS
LSAattenuation
ATTenuation.
ORL: Optical Return Loss
The loss is returned in dB. The attenuations are returned in mdB/km.
calc:math:expr:name? att 291MDB/KM<END>
All instruments
CALCulate:MATH:EXPRession:REFLex?
CALCulate:MATH:EXPRessionREFLex?<wsp><pos1>,<pos2>,
<pos3>
Calculate the Reflectance of an event
The active marker must be at the position of the Event.

3 aux marker positions with length unit.

Valid length units are: MM, CM, M, KM, MI, FT, KFT.
reflectance or reflection height in dB
The type of measurement given (reflectance or reflection height)
depends on how you have configured your instrument.
You specify a new configuration with calc:math:expr:type.
calc:math:expr:refl? 9.5km,9800m,1001000cm
-55.5000DB (Marker at 10km).

All instruments

87

Operations on Traces and Measurements

command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:

parameters:
response:
example:
affects:
command:
syntax:
description:

parameters:
response:
example:
affects:

CALCulate:MATH:EXPRession:SPLice?
CALCulate:MATH:EXPRession:SPLice?<wsp><pos1>,<pos2>,
<pos3>,<pos4>
Calculate the splice loss of an event.
The active marker must be at the position of the splice.

4 aux marker positions with length unit.

Valid length units are: MM, CM, M, KM, MI, FT, KFT.
splice loss in mdB
calc:math:expr:spl? 9.5km,9800m,10500m,10.8km
100MDB (Marker at 10km).

All instruments
CALCulate:MATH:EXPRession:TYPE
CALCulate:MATH:EXPRession:TYPE<wsp><type>
Sets the reflection parameter used for the return value of
calc:math:expr:refl? and the event table (for example,
trac:data:tabl).
Valid values are: REFLectance and HEIGht.
none
calc:math:expr:type refl

Mini-OTDR and Rack OTDR

CALCulate:MATH:EXPRession:TYPE?
CALCulate:MATH:EXPRession:TYPE?
Queries the reflection parameter used for the return value of
calc:math:expr:refl? and the event table (for example,
trac:data:tabl).
none
REFL or HEIG
calc:math:expr:type REFL<END>
Mini-OTDR and Rack OTDR
88

Operations on Traces and Measurements

4.3 Measurement Functions The SENSe

Subsystem
The SENSe subsystem lets you control measurement parameters
like the averaging time, the detectors bandwidth, and fiber
parameters.

command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
NOTE

example:
affects:

SENSe:AVERage:COUNt
SENSe:AVERage:COUNt<wsp><value>
Sets the averaging time.
Averaging time in seconds (a short value).
A value of 0 means that the measurement runs until it is stopped by
the user.
none
sens:aver:coun 180

Mini-OTDR, Rack OTDR, and Mainframe OTDR

SENSe:AVERage:COUNt?
SENSe:AVERage:COUNt?<wsp><boolean>
Queries the averaging time.
A boolean value:

0 returns averaging time

1 returns time elapsed since start of measurement.

Averaging time in seconds (a short value).

If your instrument is configured to measure Number of Averages,
rather than Averaging Time, you receive a response of 0.
Use sens:aver:coun to configure your instrument for
Averaging Time (Mini-OTDR only).
sens:aver:coun? 0 +180<END>

All instruments

89

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

SENSe:AVERage:COUNt:NUMBer
SENSe:AVERage:COUNt:NUMBer<wsp><value>
Sets the number of averages to measure.
Number of averages as a power of 2 (a short value).
For example, if you enter 14, 214 averages are taken.
A value of 0 means that the measurement runs until it is stopped by
the user.

NOTE

response:
example:
affects:
command:
syntax:
description:
parameters:
response:

You may only enter 0 or an integer between 14 and 22.

none
sens:aver:coun:numb 14

Mini-OTDR and Rack OTDR

SENSe:AVERage:COUNt:NUMBer?
SENSe:AVERage:COUNt?<wsp><boolean>
Queries the number of averages measured.
A boolean value:

0 returns averaging time

1 returns time elapsed since start of measurement.
Number of averages as a power of 2 (a short value).

For example, if you see 14, the instrument is configured to take 214
averages.
NOTE

example:
affects:

If your instrument is configured to measure Averaging Time,

rather than Number of Averages, you receive a response of 0.
Use sens:aver:coun:numb to configure your instrument for
Number of Averages.
sens:aver:coun? 0 14<END>

Mini-OTDR and Rack OTDR

90

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
parameters:
response:

example:
affects:

SENSe:DETector[:FUNCtion]
SENSe:DETector[:FUNCtion]<wsp><mode>
Sets the current measurement mode.
Valid modes are:

AVERage
REAL time (not Mini-FBL)
CONTinue (not Mini-FBL)
CW
RETLoss (Mainframe OTDR only)
M2kHz (not Mainframe OTDR)

none
sens:det aver

All instruments
SENSe:DETector[:FUNCtion]?
SENSe:DETector[:FUNCtion]?
Returns the current measurement mode.
none
Possible responses are: AVERage
REAL time (not Mini-FBL)
CONTinue (not Mini-FBL)
CW
RETLoss (Mainframe OTDR only)
M2kHz (not Mainframe OTDR)
sens:det? AVER<END>

All instruments

91

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:

response:
example:
affects:

SENSe:DETector[:FUNCtion:]AUTO
SENSe:DETector[:FUNCtion]:AUTO<wsp><boolean>
Enables or disables the automatic measurement mode.
A boolean value: 0 disable auto mode
1 enable auto mode
none
sens:det:auto 1
Mini-OTDR, Rack OTDR, and Mainframe OTDR
SENSe:DETector[:FUNCtion:]AUTO?
SENSe:DETector[:FUNCtion]:AUTO?
Queries whether the automatic measurement mode is enabled.
none
A boolean value: 0 auto mode disabled
1 auto mode enabled
sens:det:auto? 1<END>
All instruments
SENSe:DETector[:FUNCtion:]OPTimize
SENSe:DETector[:FUNCtion]:OPTimize<wsp><mode>
Sets the optimization mode
Valid modes are: NONE standard optimization
RESolution optimize for resolution
DYNamic optimize for dynamic
LINearity - optimize for linearity (Mainframe
OTDR only)
none
sens:det:opt res
Mini-OTDR, Rack OTDR, and Mainframe OTDR

92

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:

example:
affects:
command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:DETector[:FUNCtion:]OPTimize?
SENSe:DETector[:FUNCtion]:OPTimize?
Returns the current optimization mode.
none
Possible modes are NONE standard optimization
RESolution optimize for resolution
DYNamic optimize for dynamic
LINearity - optimize for linearity (Mainframe
OTDR only)
sens:det:opt? RES<END>
All instruments
SENSe:DETector:MODE
SENSe:DETector:MODE<wsp><mode>
Selects the mode of the OTDR screen
Valid modes are: OTDR OTDR mode
BREAK Fiber Break Locator
SOURce Source mode
none
sens:det:mode otdr

Mini-OTDR and Rack OTDR

SENSe:DETEctor:MODE?
SENSe:DETector:MODE?
Returns the current mode of the OTDR
none
Possible modes are OTDR, BREAK, SOUR
sens:det:mode OTDR<END>
Mini-OTDR, Mainframe OTDR, and Rack OTDR

93

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:DETector:SAMPle:DISTance?
SENSe:DETector:SAMPle:DISTance?
Queries the current sample distance.
none
The sample distance in mm.
sens:samp:dist? +4600<END>
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:FIBer:REFRindex
SENSe:FIBer:REFRindex<wsp><value>
Sets the fibers refractive index.
The refractive index (a float value).
none

command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:FIBer:REFRindex?
SENSe:FIBer:REFRindex?
Returns the current refractive index.
none
The refractive index (a float value).
sens:fib:refr? +1.4580000<END>
All instruments

sens:fib:refr 1.458

All instruments

94

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

Mini-OTDR, Rack OTDR, and Mainframe OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:FIBer:SCATtercoeff?
SENSe:FIBer:SCATtercoeff?
Returns the current scatter coefficient.
none
The scatter coefficient in dB (a float value).
sens:fib:scat? +51.500DB<END>
All instruments

command:
syntax:
description:
parameters:
response:

SENSe:FIBer:TYPE?
SENSe:FIBer:TYPE?
Queries the fiber type of the measurement module.
none

example:
affects:

SENSe:FIBer:SCATtercoeff
SENSe:FIBer:SCATtercoeff<wsp><value>[dB|mdB]
Sets the fibers scatter coefficient.
The scatter coefficient in mdB (default) or dB (a float value).
none
sens:fib:scat 51500mdb

Possible values are:

MONomode
MULTimode
sens:fib:type? MULT<END>

All instruments

95

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
NOTE

example:
affects:

SENSe:POWer:FREQuency?
SENSe:POWer:FREQuency?
Queries the detected power meter input frequency.
none
Valid responses are: CW, LI, and the current frequency in Hz or KHz
sens:pow:freq? 270HZ<END>
Mini-OTDR, Mini-FBL, and Rack OTDR
SENSe:POWer:REFerence
SENSe:POWer:REFerence<wsp><value>
[pW|nW|uW|mW|Watt|dBm]
Sets the power meter reference value
The reference as a float value. You may append a unit type.
Valid units are: pW, nW, uW, mW, Watt, and dBm.
If no unit type is specified, dBm is implied.
none
sens:pow:ref 4dBm

Mini-OTDR, Mini-FBL, and Rack OTDR

SENSe:POWer:REFerence?
SENSe:POWer:REFerence?
Queries the power meter reference value and units
none
The reference as a float value in dBm, W or dB.
If the reference state is relative, units are dBm or W.
If the reference state is absolute, units are dB
sens:pow:ref? +4DBM<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

96

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:POWer:REFerence:DISPlay
SENSe:POWer:REFerence:DISPlay
Takes the current power meter value as the reference value
none
none
sens:pow:ref:disp

Mini-OTDR, Mini-FBL, and Rack OTDR

SENSe:POWer:REFerence:STATe
SENSe:POWer:REFerence:STATe<wsp><boolean>
Sets the power meter display to relative or absolute
A boolean value: 0 relative
1 - absolute
none
sens:pow:ref:stat 1

Mini-OTDR, Mini-FBL, and Rack OTDR

SENSe:POWer:REFerence:STATe?
SENSe:POWer:REFerence:STATe?
Inquires whether the current power meter display is relative or
absolute
none
A boolean value: 0 relative
1 - absolute
sens:pow:ref:stat? 1<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

97

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

response:
example:
affects:

SENSe:POWer:UNIT
SENSe:POWer:UNIT<wsp><boolean>
Sets the power meter power unit
A boolean value: 0 dBm
1 - Watt
or DBM or W
none
sens:pow:unit 1

Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

SENSe:POWer:UNIT?
SENSe:POWer:UNIT?
Inquires the current power meter power unit
none
DBM or W
sens:pow:unit? W<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

SENSE:POWer:WAVelength
SENSE:POWer:WAVelength<wsp><value>[NM | UM | MM | M]

Sets the current power meter wavelength.

The wavelength as a float value in nm/um/mm/m.
none
sens:pow:wav 1550E-3um

Mini-OTDR, Mini-FBL, and Rack OTDR

98

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example
affects:

SENSE:POWer:WAVelength?
SENSE:POWer:WAVelength?

Inquires the current power meter wavelength.

none
The wavelength as a float value in nm.
sens:pow:wav? +1550NM<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

99

Operations on Traces and Measurements

4.4 Signal Generation The SOURce Subsystem

The SOURce subsystem allows controlling the OTDRs optical
source. It also controls positions and appearance of the markers

command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]AM[:INTernal]:FREQuency[1]
[SOURce:]AM[:INTernal]:FREQency[1]<wsp><freq>
Sets the modulation frequency of the internal source
Valid units are: CW, F270HZ, F1KHZ, F2KHZ, and CODE
none
Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]AM[:INTernal]:FREQuency[1]?
[SOURce:]AM[:INTernal]:FREQency[1]?
Queries the current modulation frequency of the internal source
none
Valid units are: CW, F270HZ, F1KHZ, F2KHZ, and CODE
am:freq? F270HZ<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]AM[:INTernal]:FREQuency2
[SOURce:]AM[:INTernal]:FREQency2<wsp><freq>
Sets the modulation frequency of the Visual Fault Finder
Valid units are: CW and F1HZ
none

am:freq f270hz

am:freq2 f1hz

Mini-OTDR, Mini-FBL, and Rack OTDR

100

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]AM[:INTernal]:FREQuency2?
[SOURce:]AM[:INTernal]:FREQency2?
Queries the current modulation frequency of the Visual Fault Finder
none
Valid units are: CW and F1HZ
am:freq2? F1HZ<END>
Mini-OTDR, Mini-FBL, and Rack OTDR

.
command:
syntax:
description:
parameters:

[SOURce:]HOFFset
[SOURce:]HOFFset<wsp><value>[MM | CM | M | KM | MI | FT |
KFT]
Sets the horizontal offset.
The offset as a float value. You may append a length unit.
Valid length units are: MM, CM, M, KM, MI, FT, KFT.

NOTE

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

A value of 0 clears the horizontal offset.

none
hoff 5km

Mini-OTDR, Rack OTDR, and Mainframe OTDR

[SOURce:]HOFFset?
[SOURce:]HOFFset?
Returns the current horizontal offset.
none
The offset as a float value in the current length unit.
hoff? +5.0000000KM<END>
Mini-OTDR, Rack OTDR, and Mainframe OTDR

101

Operations on Traces and Measurements

command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:

[SOURce:]MARKer1|2|3:POINt
[SOURce:]MARKer1|2|3:POINt<wsp><position>[length unit]
Sets the position of the selected marker (MARK1 = marker A,
MARK2 = marker B, MARK3 = marker C).
The Mini-OTDR and Rack OTDR have no Marker C.
MARK3 is therefore only valid for the Mainframe OTDR.

Position in length unit.

none
mark2:poin 1000m

Mini-OTDR, Rack OTDR, and Mainframe OTDR

[SOURce:]MARKer1|2|3:POINt?
[SOURce:]MARKer1|2| 3:POINt?
Returns the position of the selected marker (MARK1 = marker A,
MARK2 = marker B, MARK3 = marker C).
The Mini-OTDR and Rack OTDR have no Marker C.
MARK3 is therefore only valid for the Mainframe OTDR.

none
Position in length unit.
mark2:poin? +1KM <END>
Mini-OTDR, Rack OTDR, and Mainframe OTDR

102

Operations on Traces and Measurements

command:
syntax:
description:

[SOURce:]MARKer1|2|3 [:STATe]
[SOURce:]MARKer1|2|3[:STATe]<wsp><boolean>
Activates or disables the selected marker (MARK1 = marker A,
MARK2 = marker B, MARK3 = marker C).

NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:

The Mini-OTDR and Rack OTDR have no Marker C.

MARK3 is therefore only valid for the Mainframe OTDR.

A boolean value:

0 disables marker
1 enables marker

none
mark2 1

Mini-OTDR, Rack OTDR, and Mainframe OTDR

[SOURce:]MARKer1|2|3[:STATe]?
[SOURce:]MARKer1|2|3[:STATe]?
Queries the state of the selected marker (MARK1 = marker A,
MARK2 = marker B, MARK3 = marker C).
The Mini-OTDR and Rack OTDR have no Marker C.
MARK3 is therefore only valid for the Mainframe OTDR.

none
A boolean value:

0 marker disabled
1 marker enabled

mark2? 1<END>
Mini-OTDR, Rack OTDR, and Mainframe OTDR

103

Operations on Traces and Measurements

command:
syntax:
description:

parameters:
response:
example:
affects:
command:
syntax:
description:

parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]POWer:STATe[1|2]
[SOURce:]POWer:STATe[1|2]
Switches the laser of the chosen source on or off:
stat or stat1: internal source (default)
stat2: Visual Light Source
A boolean value: 0 Laser Off
1 - Laser On
none
pow:stat 1

Mini-OTDR, Mini-FBL, and Rack OTDR

[SOURce:]POWer:STATe[1|2]?
[SOURce:]POWer:STATe[1|2]?
Queries the laser state of the chosen source:
stat or stat1: internal source (default)
stat2: Visual Light Source
none
A boolean value: 0 Laser Off
1 - Laser On
pow:stat 1<END>
Mini-OTDR, Mini-FBL, and Rack OTDR
[SOURce:]PULSe:WIDTh
[SOURce:]PULSe:WIDTh<wsp><value>[NS|US|MS|S]
Sets the measurement pulsewidth.
The pulsewidth in ns/us (a float value).
none
puls:widt 3000E-9s
Mini-OTDR, Rack OTDR, and Mainframe OTDR

104

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]PULSe:WIDTh?
[SOURce:]PULSe:WIDTh?
Returns the measurement pulsewidth.
none
The pulsewidth in ns/us (a short value).
puls:widt? 3US<END>
All instruments

command:
syntax:
description:

[SOURce:]PULSe:WIDTh:LLIMit?
[SOURce:]PULSe:WIDTh:LLIMit?
Returns the lower limit for the pulsewidth determined by the
measurement hardware.
none
The pulsewidth in ns/us (a short value).
puls:widt:llim? +10NS<END>
All instruments

parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]PULSe:WIDTh:ULIMit?
[SOURce:]PULSe:WIDTh:ULIMit?
Returns the upper limit for the pulsewidth determined by the
measurement hardware.
none
The pulsewidth in ns/us (a short value).
puls:widt:ulim? +10US<END>
All instruments

105

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
parameters:
response:

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]RANGe:LUNit
[SOURce:]RANGe:LUNit<wsp><unit>
Sets the length unit.
Valid units are:
M meters
FT feet
MI miles
none
rang:lun m

All instruments
[SOURce:]RANGe:LUNit?
[SOURce:]RANGe:LUNit?
Queries the current length unit.
none
Valid units are:
M meters
FT feet
MI miles
rang:lun? M<END>
All instruments
[SOURce:]RANGe:SPAN
[SOURce:]RANGe:SPAN<wsp><value>[MM | CM | M | KM | MI |
FT | KFT]
Sets the measurement span.
The span as a float value. You may append a length unit.
Valid length units are: MM, CM, M, KM, MI, FT, KFT.
none
rang:span 50mi

Mini-OTDR, Rack OTDR, and Mainframe OTDR

106

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

[SOURce:]RANGe:SPAN?
[SOURce:]RANGe:SPAN?
Returns the current measurement span.
none
The span as a float value in the current length unit.
rang:span? +80.4670000KM<END>
All instruments
[SOURce:]RANGe:STARt
[SOURce:]RANGe:STARt<wsp><value>[MM | CM | M | KM | MI |
FT | KFT]
Sets the starting point for the measurement.
The start as a float value. You may append a length unit.
Valid length units are: MM, CM, M, KM, MI, FT, KFT.
none
rang:star 10km

Mini-OTDR, Rack OTDR, and Mainframe OTDR

[SOURce:]RANGe:STARt?
[SOURce:]RANGe:STARt?
Returns the current starting point for the measurement.
none
The start as a float value in the current length unit.
rang:star? 10.0000000KM<END>
All instruments

107

Operations on Traces and Measurements

command:
syntax:
description:

[SOURce:]WAVelength[1|2][:CW]
[SOURce:]WAVelength[1|2][:CW]<wsp><value>[NM | UM | MM | M]

Sets the wavelength for the specified source:

wav or wav1: internal source (default)
wav2: Visual Light source

NOTE

wav2 is only included for the sake of consistency. You will never
want to set the Visual Light Source wavelength

NOTE

You cannot use a submodule with an Mainframe OTDR.

This means that wav2 is unavailable.

parameters:
response:
example:
affects:

The wavelength as a float value in nm/um/mm/m.

none

command:
syntax:
description:

[SOURce:]WAVelength[1|2][:CW]?
[SOURce:]WAVelength[1:2][:CW]?
Inquires the wavelength for the specified source:
WAVelength or WAVelength1: internal source (default)
WAVelength2: Visual Light source

NOTE

parameters:
response:
example:
affects:

wav 1550E-3um

All instruments

You cannot use a submodule with an Mainframe OTDR.

This means that wav2 is unavailable.

none
The wavelength as a float value in nm.
wav? +1550NM<END>
All instruments

108

Operations on Traces and Measurements

command:
syntax:
description:

[SOURce:]WAVelength[1|2][:CW]:AVAilable?
[SOURce:]WAVelength[1|2][:CW]:AVAilable?

Returns the wavelengths for the specified source:

wav or wav1: internal source (default)
wav2: Visual Light source

NOTE

parameters:
response:
example:
affects:

You cannot use a submodule with an Mainframe OTDR.

This means that wav2:ava? is unavailable.

The wavelengths as float values separated by commas.

none
wav:ava? 1310,1550<END>
All instruments

109

Operations on Traces and Measurements

4.5 Trace Data Access The TRACe Subsystem

The TRACe subsystem lets you control the traces loaded into the
OTDRs memory.

command:
syntax:
description:

parameters:
response:
example:
affects:

TRACe:CATalog?
TRACe:CATalog?
Returns the names of the currently loaded traces and their positions
in the trace array.
There is a maximum of two loaded traces for the Mini-OTDR and
Rack OTDR, and four loaded traces for the Mainframe OTDR.
none
A string terminated by <END>.
trac:cat? "1:TRACE1.SOR 2:TRACE2.SOR"<END>
All instruments

110

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
NOTE

TRACe:DATA?
TRACe:DATA?
Reads a complete trace data array for the current trace.
none
The data is a Binary Block containing the trace data.
TRAC:DATA? returns blocks of unsigned short (16-bit) data in
Intel little endian byte ordering (low byte first).

Some processor architectures (such as HP PA-Risc or Motorola)

use big endian byte order (high byte first).
If your processor uses big endian byte order, you must swap the
low and high byte for each 16 bit value.
If you are not sure about the byte ordering technique used by your
processor, please consult your processor documentation.

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

trac:data? #48192[..8192 bytes of data..]<END>

All instruments
TRACe:DATA:CHECk:TABLe?
TRACe:DATA:CHECk:TABLe?
Returns the Pass/Fail test Checker Table.
none.
Block containing the Pass/Fail test table. The header is the same as a
binary, but the data is in ASCII format.
trac:data:chec:tabl? block<END>
Mini-OTDR and Rack OTDR

111

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:

response:
example:
affects:

TRACe:DATA:CHECk:STATe?
TRACe:DATA:CHECk:STATe?
Returns the current Pass/Fail test state.
none
Possible values
INVALID
are:
PASSED
FAILED
trac:data:chec:stat? PASSED<END>
Mini-OTDR and Rack OTDR
TRACe:DATA:FCRetloss?
TRACe:DATA:FCRetloss?
Returns the Front connector Return Loss
none
Return loss in dB.
trac:data:fcr? -35723MDB<END>
All instruments
TRACe:DATA:LANDmark:ADD
TRACe:DATA:LANDmark:ADD<wsp><value>[MM | CM | M |
KM | MI | FT | KFT],<comm>
Adds a landmark.
<value> The landmark position as a float value. You may append
a length unit. Valid length units are: MM, CM, M, KM,
MI, FT, KFT.
<comm> Landmark name, given as a string in " " (max. 40
characters)
none
trac:data:land:add 2km,"Landmark A"

Mini-OTDR, Rack OTDR, and Mainframe OTDR

112

Operations on Traces and Measurements

command:
syntax:
description:
parameters:

response:
example:
affects:

TRACe:DATA:LANDmark:DELete
TRACe:DATA:LANDmark:DELete<wsp><value>[MM | CM | M |
KM | MI | FT | KFT]
Deletes a landmark.
The landmark position as a float value. You may append a length
unit.
Valid length units are: MM, CM, M, KM, MI, FT, KFT.
none
trac:data:land:del 2km

Mini-OTDR, Rack OTDR, and Mainframe OTDR

113

Operations on Traces and Measurements

command:
syntax:
description:

parameters:

NOTE

TRACe:DATA:LINE?
TRACe:DATA:LINE?<wsp><start>,<range>,<width>,<minmax>
Starting at sample start, examines the next width samples, and
notes their minimum/maximum value. (minmax determines whether
it is MIN or MAX).
Repeats this for range samples, and stores the resulting line in a
binary block.
start (int32) - starting point from which samples are taken.
range (int32) - number of separate samples analyzed,
width (int32) - number of points in each sample.
For an illustration of the interpretation of the parameters, see the
diagram below:

start + (range*width) must be less than the number of data

points
range must be greater than or equal to 4
width must be greater than 0
minmax -

response:

MIN: minimum value is taken

MAX: maximum value is taken

binary block

114

Operations on Traces and Measurements

NOTE

TRAC:DATA:LINE? returns blocks of unsigned short (16-bit)

data in Intel little endian byte ordering (low byte first).

Some processor architectures (such as HP PA-Risc or Motorola)

use bug endian byte order (high byte first).
If your processor uses big endian byte order, you must swap the
low and high byte for each 16 bit value.
If you are not sure about the byte ordering technique used by your
processor, please consult your processor documentation.

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

trac:data:line? 2,5,2,MAX block

All instruments
TRACe:DATA:TABLe?
TRACe:DATA:TABLe?
Returns an event table.
none.
Block containing the event table. The header is the same as a binary,
but the data is in ASCII format.
trac:data:tabl? block
All instruments
TRACe:DATA:TABLe:LOCK
TRACe:DATA:TABLe:LOCK<wsp><boolean>
Locks/Unlocks the event table
A boolean value: 0: table unlocked
1: table locked
none
trac:data:tabl:lock 0

Mini-OTDR, Rack OTDR, and Mainframe OTDR

115

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

TRACe:DATA:TABLe:LOCK?
TRACe:DATA:TABLe:LOCK?
Returns whether the event table is locked.
none.
A boolean value: 0: table unlocked
1: table locked
trac:data:tabl:lock? 0<END>
Mini-OTDR, Rack OTDR, and Mainframe OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

TRACe:DATA:TORL?
TRACe:DATA:TORL?
Returns the Total Optical Return Loss
none
Return loss in dB.
trac:data:torl? +35.7DB<END>
All instruments

command:
syntax:
description:

TRACe:DATA:VALue?
TRACe:DATA:VALue?<wsp><sample point>
Returns the measured value at the specified sample point.

NOTE

parameters:
response:
example:
affects:

The maximum value of <sample point> is determined by

trac:poin?

The sample point.

The measured value in mdB.
trac:data:val? 1999 +31800<END>
All instruments

116

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

TRACe:DELete
TRACe:DELete
Closes the current trace.
none
none

command:
syntax:
description:
parameters:
response:
example:
affects:

TRACe:DELete:ALL
TRACe:DELete:ALL
Closes all loaded traces.
none
none

command:
syntax:
description:

TRACe:FEED:CONTrol
TRACe:FEED:CONTrol<wsp><trace>

trac:del

All instruments

trac:del:all

All instruments

Specifies the current trace.

NOTE

parameters:

response:
example:
affects:

The current trace receives all measurement data and therefore

will be overwritten with every new measurement

Valid values are:

FIRSt
SECond
THIRd (Mainframe OTDR only)
FOURth (Mainframe OTDR only)

none
trac:feed:cont sec

Mini-OTDR, Rack OTDR, and Mainframe OTDR

117

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:

example:
affects:

TRACe:FEED:CONTrol?
TRACe:FEED:CONTrol?
Returns the current trace.
none
Possible values
FIRSt
are:
SECond
THIRd (Mainframe OTDR only)
FOURth (Mainframe OTDR only)
trac:feed:cont? SEC<END>
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

TRACe:FREE?
TRACe:FREE?
Returns the number of unused trace array fields.
none
A short value: 0...2.(0...4 for the Mainframe OTDR)
trac:free? +2<END>
All instruments

command:
syntax:
description:
parameters:

TRACe:POINts
TRACe:POINts
Sets the maximum number of samples for the current trace.
The number of data points (a short value).
Valid arguments are 4000, 8000, and 16000.
none

response:
example:
affects:

trac:poin 8000

Mini-OTDR and Rack OTDR

118

Operations on Traces and Measurements

command:
syntax:
description:
parameters:
response:
example:
affects:

TRACe:POINts?
TRACe:POINts?
Returns the number of trace data points for the current trace.
none
The number of data points (a short value).
trac:poin? +8192<END>
All instruments

119

Operations on Traces and Measurements

120

Mass Storage, Display, and

Print Functions

Mass Storage, Display,

and Print Functions
This chapter gives descriptions of commands that you can use when
storing and printing traces from your OTDR. The commands are
split into the following separate subsystems:
:DISPLAY: commands which relate to what you see on the
OTDR display.
:HCOPY: commands which relate to printing operations.
:MMEMORY: commands which relate to the OTDR memory.
Other commands are described in Chapter 3 Instrument Setup and
Status, and Chapter 4 Operations on Traces and Measurements.

122

Mass Storage, Display, and Print Functions

5.1 Display Operations The DISPlay Subsystem

The DISPlay subsystem lets you control what you see on the
OTDRs display.

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

DISPlay:BRIGhtness
DISPlay:BRIGhtness<wsp><value>
Controls the brightness for the display.
0 .. 100 (0 ..64 on the Mainframe OTDR)

none
disp:brig 32

All instruments
DISPlay:BRIGhtness?
DISPlay:BRIGhtness?
Requests the brightness for the display.
none
0 .. 100 (0 ..64 on the Mainframe OTDR)
disp:brig? 32<END>

All instruments
DISPlay:CONTrast
DISPlay:CONTrast<wsp><value>
Controls the contrast for the display.
0 .. 100

none
disp:cont 50

Mini-OTDR and Mini-FBL

123

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

DISPlay:CONTrast?
DISPlay:CONTrast?
Requests the contrast for the display.
none

0 .. 100
disp:cont? 50<END>

Mini-OTDR and Mini-FBL

DISPlay:ENABle
DISPlay:ENABle<wsp><boolean>
Enables or disables the LCD.
A boolean value: 0 switch off the LCD
1 switch on the LCD
none
disp:enab 1

All instruments
DISPlay:ENABle?
DISPlay:ENABle?
Queries the state of the LCD.
none
A boolean value: 0 the LCD is turned off
1 the LCD is turned on
disp:enab? 1<END>
All instruments

124

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

DISPlay[:WINDow]:GRAPhics:COLor
DISPlay[:WINDow]:GRAPhics:COLor<wsp><color>
Changes the color of the current trace.
The new trace color (a short value):
BLACk, RED, BLUE, GREen, GREY, WHITe
none
disp:grap:col blac

Mainframe OTDR only

DISPlay[:WINDow]:GRAPhics:COLor?
DISPlay[:WINDow]:GRAPhics:COLor?
Queries the color of the current trace.
none
The current trace color (a short value):
BLAC, RED, BLUE, GRE, GREY, WHIT
DISPlay[:WINDow]:GRAPhics:COLor?

Mainframe OTDR only

DISPlay[:WINDow]:GRAPhics:LTYPe
DISPlay[:WINDow]:GRAPhics:LTYPe<wsp><boolean>
Changes the linestyle of the current trace.
A boolean value: 0 new linestyle is dotted
1 new linestyle is solid
none
disp:grap:ltyp 0

Mini-OTDR, Rack OTDR, and Mainframe OTDR

125

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

DISPlay[:WINDow]:GRAPhics:LTYPe?
DISPlay[:WINDow]:GRAPhics:LTYPe?
Queries the linestyle of the current trace.
none
A boolean value: 0 current linestyle is dotted
1 current linestyle is solid
disp:grap:ltyp? 0<END>
All instruments
DISPlay[:WINDow]:TEXT:DATA
DISPlay[:WINDow]:TEXT:DATA<wsp><c-no>,<comm>
Sets a comment in the trace.
<c-no> 0 .. 4 - comment number
<comm> Comment, given as a string in " " (max. 40 characters)
none
disp:text:data 0,"This is a Comment"

All instruments
DISPlay[:WINDow]:TEXT:DATA?
DISPlay[:WINDow]:TEXT:DATA? <wsp><c-no>
Requests an individual comment
0 .. 4 - comment number
Comment, given as a string, terminated by <END>
disp:text:data? 0 "This is a Comment"<END>
All instruments

126

Mass Storage, Display, and Print Functions

command:
syntax:
description:
NOTE

DISPlay[:WINDow]:X:SCALe
DISPlay[:WINDow]:X:SCALe:<wsp><type>
Controls whether the display is in full trace mode or zoomed.
You must send this command before you perform any zooming
operations.
The DISP ... :PDIV/? commands described below only work
in AROund mode.

parameters:
response:
example:
affects:

FULLtrace or AROund.
none
Mini-OTDR, Rack OTDR, and Mainframe OTDR

command:
syntax:
description:
parameters:
response:
example:
affects:

DISPlay[:WINDow]:X:SCALe?
DISPlay[:WINDow]:X:SCALe?
Queries whether the display is in full trace mode or zoomed.
none
FULLtrace or AROund
disp:x:scal? FULL<END>
All instruments

disp:x:scal full

127

Mass Storage, Display, and Print Functions

command:
syntax:
description:
NOTE

parameters:

response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:

example:
affects:

DISPlay[:WINDow]:X[:SCALe]:PDIVision
DISPlay[:WINDow]:X[:SCALe]:PDIVision<wsp><value>
Determines the scaling of the X-axis.
This command only works in AROund mode (see
DISP:X:SCAL).

Valid values for the scaling: 0...15 (a short value):

0 full trace ...
15 1 m/DIV
none
disp:x:pdiv 3

Mini-OTDR, Rack OTDR, and Mainframe OTDR

DISPlay[:WINDow]:X[:SCALe]:PDIVision?
DISPlay[:WINDow]:X[:SCALe]:PDIVision?
Queries the current scaling of the X-axis.
This command only works in AROund mode (see
DISP:X:SCAL).

none
Possible values for the scaling: 0...15 (a short value):
0 full trace ....
15 1 m/DIV
disp:x:pdiv? +3<END>
All instruments

128

Mass Storage, Display, and Print Functions

command:
syntax:
description:
NOTE

parameters:

response:
example:
affects:
command:
syntax:
description:
NOTE

parameters:
response:

example:
affects:

DISPlay[:WINDow]:Y[:SCALe]:PDIVision
DISPlay[:WINDow]:Y[:SCALe]:PDIVision<wsp><value>
Determines the scaling of the Y-axis.
This command only works in AROund mode (see
DISP:X:SCAL).

Valid values for the scaling: 1...7 (a short value):

1 > 5 dB/DIV ....
7 > 0.1 dB/DIV
none
disp:y:pdiv 3

Mini-OTDR, Rack OTDR, and Mainframe OTDR

DISPlay[:WINDow]:Y[:SCALe]:PDIVision?
DISPlay[:WINDow]:Y[:SCALe]:PDIVision?
Queries the current scaling of the Y-axis.
This command only works in AROund mode (see
DISP:X:SCAL).

none
Possible values for the scaling: 1...7(a short value):
1 > 5 dB/DIV ....
7 > 0.1 dB/DIV
disp:y:pdiv? +3<END>
All instruments

129

Mass Storage, Display, and Print Functions

5.2 Print Operations The HCOPy Subsystem

The HCOPy subsystem lets you select the print layout and control
the printing.

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ABORt
HCOPy:ABORt
Cancels the current print job.
none
none

command:
syntax:
description:
parameters:

HCOPy:DESTination
HCOPy:DESTination<wsp><printer>
changes the current printing device.

hcop:abor

All instruments

The printers name as a string.

Valid names for the Mini-OTDR and Rack OTDR are:
PCL100DPI: Standard HP-PCL printer (for example, HP LaserJet or

HP DeskJet) @ 100 dots per inch

PCL150DPI: Standard HP-PCL printer (for example, HP LaserJet or
HP DeskJet) @ 150 dots per inch
EPSONPIN: Epson 8-Pin printer
SEIKODPU: Seiko DPU-411/414
Valid name for the Mainframe OTDR are:
the name of a specific printer, for example HP-LASERJET
INTernal: internal printer
EXTernal: external printer

response:
example:
affects:

none
hcop:dest "PCL100DPI"

All instruments

130

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:

HCOPy:DESTination?
HCOPy:DESTination?
Queries the current printing device.
none
The printers name as a string terminated by <END>.
Valid names for the Mini-OTDR and Rack OTDR are:
PCL100DPI: Standard HP-PCL printer (for example, HP LaserJet or
HP DeskJet) @ 100 dots per inch
PCL150DPI: Standard HP-PCL printer (for example, HP LaserJet or
HP DeskJet) @ 150 dots per inch
EPSONPIN: Epson Pin printer
SEIKODPU: Seiko DPU-411/414
NONE: no printer configured

Valid names for the Mainframe OTDR are:

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

the name of a specific printer, for example HP-LASERJET

INTernal: internal printer
EXTernal: external printer
hcop:dest? "PCL100DPI"<END>

All instruments
HCOPy[:IMMediate]
HCOPy[:IMMediate]
Immediately starts printing everything that has been selected before.
none
none
hcop

All instruments

131

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM:ALL[:IMMediate]
HCOPy:ITEM:ALL[:IMMediate]
Immediately starts printing everything.
none
none

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM[:WINDow][:IMMediate]
HCOPy:ITEM[:WINDow][:IMMediate]
Immediately starts printing the parameter window.
none
none

command:
syntax:
description:
parameters:

HCOPy:ITEM[:WINDow]:STATe
HCOPy:ITEM[:WINDow]:STATe<wsp><boolean>
Enables or disables printing the parameter window.
A boolean value: 0 disable
1 enable
none

response:
example:
affects:

hcop:item:all

All instruments

hcop:item

All instruments

hcop:item:stat 1

All instruments

132

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM[:WINDow]:STATe?
HCOPy:ITEM[:WINDow]:STATe?
Queries printing the parameter window.
none
A boolean value: 0 parameter window will not be printed
1 parameter window will be printed
hcop:item:stat? 1<END>
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM[:WINDow]:TEXT[:IMMediate]
HCOPy:ITEM[:WINDow]:TEXT[:IMMediate]
Immediately starts printing the event table.
none
none

command:
syntax:
description:
parameters:

HCOPy:ITEM[:WINDow]:TEXT:STATe
HCOPy:ITEM[:WINDow]:TEXT:STATe<wsp><boolean>
Enables or disables printing the event table.
A boolean value: 0 disable
1 enable
none

response:
example:
affects:

hcop:item:text

All instruments

hcop:item:text:stat 1

All instruments

133

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM[:WINDow]:TEXT:STATe?
HCOPy:ITEM[:WINDow]:TEXT:STATe?
Queries whether the event table will be printed.
none
A boolean value: 0 event table will not be printed
1 event table will be printed
hcop:item:text:stat? 1<END>
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM[:WINDow]:TRACe[:IMMediate]
HCOPy:ITEM[:WINDow]:TRACe[:IMMediate]
Immediately starts printing the trace.
none
none

command:
syntax:
description:
parameters:

HCOPy:ITEM[:WINDow]:TRACe:STATe
HCOPy:ITEM[:WINDow]:TRACe:STATe<wsp><boolean>
Enables or disables printing the trace window.
A boolean value: 0 disable
1 enable
none

response:
example:
affects:

hcop:item:trac

All instruments

hcop:item:trac:stat 1

All instruments

134

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:ITEM[:WINDow]:TRACe:STATe?
HCOPy:ITEM[:WINDow]:TRACe:STATe?
Queries whether the trace window will be printed.
none
A boolean value: 0 trace window will not be printed
1 trace window will be printed
hcop:item:trac:stat? 1<END>
All instruments
HCOPy:ITEM[:WINDow]:TRACe:GRATicule:STATe
HCOPy:ITEM[:WINDow]:TRACe:GRATicule:STATe<wsp>
<boolean>
Enables or disables printing the trace window grid.
A boolean value: 0 disable
1 enable
none
hcop:item:trac:grat:stat 1
All instruments
HCOPy:ITEM[:WINDow]:TRACe:GRATicule:STATe?
HCOPy:ITEM[:WINDow]:TRACe:GRATicule:STATe?
Queries printing the trace window grid.
none
A boolean value: 0 trace window grid will not be printed
1 trace window grid will be printed
hcop:item:trac:grat:stat? 1<END>
All instruments

135

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

HCOPy:PAGE:SIZE
HCOPy:PAGE:SIZE<wsp><size>
Controls the paper size of the printout.
Valid parameters are LETTer, A or A4.
Please note that LETTer and A are the same page size.
none
hcop:page:size A4

All instruments
HCOPy:PAGE:SIZE?
HCOPy:PAGE:SIZE?
Queries the current paper size of the printout.
none
A value containing A or A4, terminated by <END>
hcop:page:size? A4<END>
All instruments

136

Mass Storage, Display, and Print Functions

5.3 File Operations The MMEMory Subsystem

The MMEMory subsystem gives you access to the OTDRs
memory and to the storage devices.

command:
syntax:
description:
parameters:
response:

example:

MMEMory:CATalog?
MMEMory:CATalog?
Returns the contents of the current directory.
none
A binary Block containing the contents of the directory as ASCII
text, separated by CR/LF. The first digit states the number of digits
following. The digits following give the total number of characters
in the list of filenames.
mmem:cat? #229.
..
DEMO1.SOR
DEMO2.SOR

<END>
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

All instruments
MMEMory:CDIRectory
MMEMory:CDIRectory<wsp><directory>
Changes the current directory.
The directory given as a string in " ".
none
mmem:cdir "TRACES"

All instruments

137

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:CDIRectory?
MMEMory:CDIRectory?
Queries the current directory.
none
The directory given as a string terminated by <END>.
mmem:cdir? "TRACES"<END>
All instruments

command:
syntax:
description:
parameters:

MMEMory:COPY:FILE
MMEMory:COPY:FILE?<wsp><file>,<newfile>,<device>
Copies the specified Bellcore binary file from the current device.
The file name given as a string in " ".
The name of the new file given as a string in " ".
Device where new file is located: FLASh - internal memory
FLOPpy diskette
PCMCia - memory card
none
mmem:copy:file "t0721_01.sor","\abc\test.sor",flop
Mini-OTDR, Mini-FBL, and Rack OTDR

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:DELete
MMEMory:DELete<wsp><file>
Deletes the specified file from the current directory.
The file name given as a string in " ".
none
mmem:del "t0721_01.sor"

All instruments

138

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:

response:
example:
affects:

MMEMory:FREE
MMEMory:FREE
Performs garbage collection on internal memory to reclaim free
space.
none
none
mmem:free

Mini-OTDR, Mini-FBL, and Rack OTDR

MMEMory:FREE?
MMEMory:FREE?
returns the free and used disk space.
none
<free-space> - the amount of free space
<used-space> - the amount of used space
mmem:free? 125384, 1354789
All instruments
MMEMory:INITialize
MMEMory:INITialize<wsp><device>
Formats the specified storage device.
Valid devices are: FLASh - internal memory
FLOPpy diskette
PCMCia - memory card
none
mmem:init flop

Mini-OTDR, Mini-FBL, and Rack OTDR

139

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:LOAD:STATe, :LOAD:TRACe
for example: MMEM:LOAD:STATe<wsp><file>
Loads a settings file or a trace file.
The file name given as a string in " ".
none
mmem:load:trac "t0721_01.sor"

MMEM:LOAD:TRACE - All instruments

MMEM:LOAD:STAT does not affect the Mini-FBL.

command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:LOAD:FILE?
MMEMory:LOAD:FILE?<wsp><file>
Uploads the specified Bellcore binary file from the OTDR.
The file name given as a string in " ".
binblock (Bellcore binary)
mmem:load:file? "t0721_01.sor" binblock
All instruments

command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:MDIRectory
MMEMory:MDIRectory<wsp><directory>
Creates a directory on the current storage device.
The directory given as a string in " ".
none
mmem:mdir "TRACES"

All instruments

140

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:

response:
example:
affects:
command:
syntax:
description:
parameters:
response:

example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:MSIS
MMEMory:MSIS<wsp><device>
Changes the current storage device.
Valid devices are: FLASh - internal memory (not Mainframe OTDR)
FLOPpy diskette
HARDdisk (Mainframe OTDR only)
PCMCia - memory card (not Mainframe OTDR)
none
mmem:msis flop

All instruments
MMEMory:MSIS?
MMEMory:MSIS?
Queries the current storage device.
none
Possible devices are: FLAS - internal memory (not Mainframe
OTDR)
FLOP diskette
HARD (Mainframe OTDR only)
PCMC - memory card (not Mainframe OTDR)
mmem:msis? FLOP<END>
All instruments
MMEMory:NAME
MMEMory:NAME<wsp><name>
Changes the name of the current trace.
The name given as a string.
none
mmem:name "t0711_01.sor"

All instruments

141

Mass Storage, Display, and Print Functions

command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:NAME?
MMEMory:NAME?
Queries the name of the current trace.
none
The name given as a string.
mmem:name? "T0711_01.SOR"<END>
All instruments

command:
syntax:
description:
parameters:

MMEMory:SAVE:FILE
MMEMory:SAVE:FILE<wsp><file>,<binblock>
Downloads the specified file to the OTDR.
The file name given as a string in " ".
binblock (Bellcore binary)
none
mmem:save:file "t0721_01.sor",binblock
All instruments

response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:STORe:STATe, :STORe:TRACe
for example: MMEMory:STORe:STATe<wsp><file>
Saves a setting or a trace under the specified name.
The file name given as a string in " ".
none
mmem:stor:trac "t0721_01.sor"

All instruments

142

Mass Storage, Display, and Print Functions

command:
syntax:
description:
NOTE

parameters:
response:
example:
affects:
command:
syntax:
description:
parameters:
response:
example:
affects:

MMEMory:STORe:TRACe:REVision
MMEMory:STORe:TRACe:REVision<wsp><value>
Sets the Bellcore revision number used to store Bellcore files.
Bellcore revision 1.1 conforms to standards, but you may need to
use Bellcore revision 1.0 for backward compatibility.

Valid values: (a short value): 10: Bellcore revision 1.0

11: Bellcore revision 1.1
none
mmem:stor:trac:rev 11

All instruments
MMEMory:STORe:TRACe:REVision?
MMEMory:STORe:TRACe:REVision?
Queries the Bellcore revision number according to which Bellcore
files are stored on your OTDR.
none
Possible values: (a short value): 10: Bellcore revision 1.0
11: Bellcore revision 1.1
mmem:stor:trac:rev? +11<END>
All instruments

143

Mass Storage, Display, and Print Functions

144

Programming Examples

Programming Examples

This section contains some example programs that you can use to
run an OTDR.
This programming examples do not cover the full command set for
the instrument. They are intended only as an introduction to the
method of programming the instrument.
We recommend that you send commands via a program, examples
of which are contained in this chapter. However, for testing
processes you can enter individual commands (for example,
*idn?) from your terminal program (see How to Send
Commands and Queries on page 152).

146

Programming Examples

6.1 How to Connect your OTDR to a PC

This section explains the processes needed to connect your OTDR
to a PC, and set up a serial interface,
This section contains extracts from a demo program. You can see
the program in full in SCPI data transfer between PC and OTDR
on page 159.
1

NO T E

Connect the OTDR serial port to the serial interface of the PC.
Use an Agilent 5180-2477 RS232 cable or an equivalent.

For more information about attaching cables, consult the appropriate

Users Guide:
Mini-OTDR Users Guide (E6000-91031), Mini-FBL Users Guide
(E6020-91011), OTDR Users Guide (E4310-91011), or Rack OTDR
Users Guide (E6050-91011).
2

Table 6-1

If you have no available cable, you can configure your own,

according to the specifications listed in Table 6-1.

Cable configuration for connection to a PC

Mini-OTDR signal
DCD
RxD
TxD
DTR
GND
DSR
RTS
CTS
RI

Pin

[
147

PC-Host signal (9 pin standard) Pin

1 RTS
2 TxD
3 RxD
4 DSR, CTS
5 GND
6 DTR
7 DCD
8 DTR
9 RI

7
3
2
6, 8 (connected)
5
4
1
4
9

Programming Examples

How to set the Instrument Configuration

3

If the instrument is not also configured at your PCs serial

interface, set the following configuration:

baud rate of 19200

hardware handshaking
8 data bits
no parity
1 stop bit
NO T E

This is the default configuration, so you should only need to send these
commands if the instrument configuration has been altered.

148

Programming Examples

HANDLE InitSerial( int baudrate )

{
static HANDLE hSer = CreateFile(
INTERFACE,
// use COM1 / Serial A
GENERIC_READ | GENERIC_WRITE,
// open for read & write access
0, NULL,
OPEN_EXISTING,
// well, hopefully ... :-)
0, NULL );
if(!hSer)
{
return NULL;
}
// configure the interface ...
DCB dcb;
COMMTIMEOUTS commtimeout;
GetCommTimeouts(hSer, &commtimeout);
commtimeout.ReadIntervalTimeout = 3000;
commtimeout.ReadTotalTimeoutMultiplier = 200;
commtimeout.WriteTotalTimeoutMultiplier = 200;
commtimeout.WriteTotalTimeoutConstant = 3000;
GetCommState(hSer, &dcb);
dcb.DCBlength = sizeof(dcb);
dcb.BaudRate = baudrate;
dcb.ByteSize = 8;
dcb.Parity = 0;
dcb.StopBits = 1;
dcb.fBinary = 1;
dcb.fParity = 0 ;
dcb.fOutX = 0;
dcb.fInX = 0;
dcb.fDtrControl = DTR_CONTROL_DISABLE;
dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;

// RTS flow control

SetCommState(hSer, &dcb);
SetCommTimeouts(hSer, &commtimeout);
ClearCommBreak(hSer);
PurgeComm(hSer,
PURGE_TXABORT|PURGE_RXABORT|PURGE_TXCLEAR|PURGE_RXCLEAR);
return hSer;
}

Figure 6-1

Instrument configuration - example

149

Programming Examples

6.2 How to Connect with a Terminal Program

1

Start a terminal program on the PC, for example terminal.exe

(Win 3.11 or Windows NT), or hypertrm.exe (Windows 95 or
Hyperterminal).

Set the transmission parameters in the terminal program as listed

in Table 6-2:

Table 6-2
Speed:
Code, databits:
Communication:
Parity:
Startbits:
Stopbits:
Flow control:

Transmission parameters
19200 bps (Baud)
8 bit
Full duplex
no parity
1 (not configurable)
1
RTS-CTS (Hardware)

Send a test command in terminal mode to the OTDR:

type *IDN?

You should see a response, telling you the identity of your

OTDR.
For example, a Mini-OTDR should respond:
HP E6000 Mini Optical Time Domain
Reflectometer.....
If you see this message, or its equivalent, the basic connection
works.

Close the terminal program on the PC.

Closing the terminal program is important, as it avoids later
conflicts with the PC and the interface control.

150

Programming Examples

6.3 Using a Program to Connect to the OTDR

1

Send a new line ("\n")

Send *idn? to check the identity of the OTDR

Check the response to the *idn? query.

The response should be HP ...<END> and give details of the
type of OTDR, and the modules used.
The following responses are possible (depending on you OTDR
type):
HP E6000 Mini Optical Time Domain
Reflectometer...
Agilent E6020A Fiber Break Locator
Instrument...
HP E60xxA Rack Optical Time Domain
Reflectometer...
HP 8147 Optical Time Domain
Reflectometer...

If you do not receive an appropriate response, repeat steps 1 to 3

151

Programming Examples

until you receive the correct response or you give up.

// write query
sprintf (txtbuffer, "\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
sprintf(txtbuffer,"*IDN?\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
// read response
ReadFile(hSerial, txtbuffer, MAXNUMBYTES, &cnt, 0);
if(cnt == 0 || strlen(txtbuffer) == 0)
{
printf("SCPI query failed, exiting!\n");
CloseHandle(hSerial);
return;
}
// print result (in txtbuffer)
printf("Connected to: %s\n", txtbuffer);

Figure 6-2

Connection check - example

5

If the response is still incorrect, make the following checks:

How to check the connection

6

Send a break
This resets the instruments and RS232 to the values given in
step 3.

Close the device and reopen it.

Repeat steps 1 to 4.

6.4 How to Send Commands and Queries

There are two types of SCPI commands: queries which end with a
question mark (?), and commands which do not. Only queries
expect a response.
Commands and queries are discussed below.

152

Programming Examples

NO T E

For more information about SCPI, please consult Chapter 1

Introduction to Programming.
The SCPI commands specific to OTDRs are listed in Chapter 2
Specific Commands, and explained in subsequent chapters.

Commands
Commands must be followed by a newline ("\n").
For example, the abort command abor should be formatted as:
sprintf(txtbuffer,"ABOR\n");

There is no response.
You can check that a command has been sent correctly by sending
the query SYST:ERR?, which returns the contents of the
OTDRs error queue.

Queries
A query produces a response from the instrument.
If the response is short, you can read the line. Otherwise, you
should read the response one character at a time until you find an
<END> (see Figure 6-3).
sprintf(txtbuffer,"*IDN?\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
// read response
ReadFile(hSerial, txtbuffer, MAXNUMBYTES, &cnt, 0);

Figure 6-3

Query - example

Blocks transfer
Larger blocks of data are given as Binary Blocks, preceded by
#HLenNumbytes, terminated by <END>; HLen represents the
length of the Numbytes block. For example: #16TRACES<END>.

153

Programming Examples

For more examples, see Figure 6-4 and How to Upload a Bellcore
File from the current trace on page 156
// read the trace data ...
sprintf(txtbuffer,"TRACE:DATA?\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
// now comes the data: e.g. #48000.... which means:
//
| 4 digits following to tell the number
//
of bytes
//
|||| 8000 bytes following, containing
//
4000 trace pts
cnt=0;
while(!cnt) ReadFile(hSerial, header, 1, &cnt, 0); // read "#"
ReadFile(hSerial, header, 1, &cnt, 0); // read number of digits
header[1]=0;
numbytes = atoi(header);
ReadFile(hSerial, header, numbytes, &cnt, 0); // read digits
header[cnt] = 0;
numbytes = atoi(header);
printf("Reading %d points of trace data ...\n", numbytes/2);
// 1 point = 16 bit unsigned short
ReadFile(hSerial, tracebuf, numbytes, &cnt, 0); // read trace data
ReadFile(hSerial, header, 15, &cnt, 0);
// read rest:
<END>\n

Figure 6-4

Blocks transfer - example

6.5 Common Tasks

This section gives some programming examples for common
OTDR tasks. The examples do not cover all SCPI commands, but
are just a general example.
For a full program containing some of these, and other, commands,
see SCPI data transfer between PC and OTDR on page 159.

How to Initialize the Instrument

1

154

Connect to the instrument,

See How to Connect your OTDR to a PC on page 147.

Programming Examples

Clear the error queue.

Send the command *CLS.

Check the instrument id

Send the query *IDN?

For example, sending: *idn? may return:

HP E6000 Mini Optical Time Domain
Reflectometer
Mainframe: 3502G00056 , Module: 3525G00056
SW-Rev.: 5.3<END>

How to Set Up an OTDR Measurement

4

Set up the measurement parameters.

For example, send the following commands:
source:puls:width 3us
source:range:start 0km
source:range:span 60km
source:wav 1310nm
sens:det:func:opt dyn
sens:aver:coun 180
sens:fib:refr 1.462
This sets a pulsewidth of 3 us, a start and span of 0 km - 60 km,
a wavelength of 1310nm, dynamic optimize modem an
averaging time of 3 minutes, and a refractive index of 1.462

Select the OTDR screen (this is only possible with the MiniOTDR and Rack OTDR):
Send the command SENS:DET:MODE OTDR.

How to Run a Measurement

6

Start the measurement

Send the command init.

You can stop the measurement with the abor command, or wait
until the Averaging Time is complete,
7

Check whether the measurement is still running

155

Programming Examples

*opc? returns 0 if the measurement is still running, and 1 if

the measurement is finished.

The measurement has now stopped, and you can check the results

How to Scan a Trace

8

Send the command prog:expl:exec "scan"

When the scan is complete, *opc? returns 1 (see note 7,
above).

How to Process a Trace

9

Print the Trace

Send the command hcop:item:all

10 Save the Trace

Send the command mmem:stor:trac "newtrace.sor"

How to Upload a Bellcore File from the current trace

11 Upload the file from the OTDR
Send the query MMEM:LOAD:FILE? ""
12 Read in the first character
This character should be a hash (#).
13 Read in the next character
This character should be an integer, m, giving the number of
digits you should now read.
14 Read in the next m characters
This series of characters should form an integer, n, giving the
number of data bytes that follow.
15 Read in the next n data bytes, and store them.
16 Read until the final <END>.

156

Programming Examples

17 Check that there have been no errors.

// now comes the data: e.g. #48000.... which means:
//
| 4 digits following to tell the number
//
of bytes
//
|||| 8000 bytes following, containing
//
4000 trace pts
cnt=0;
while(!cnt) ReadFile(hSerial, header, 1, &cnt, 0); // read "#"
ReadFile(hSerial, header, 1, &cnt, 0); // read number of digits
header[1]=0;
numbytes = atoi(header);
ReadFile(hSerial, header, numbytes, &cnt, 0); // read digits
header[cnt] = 0;
numbytes = atoi(header);
printf("Reading %d points of trace data ...\n", numbytes/2);
// 1 point = 16 bit unsigned short
ReadFile(hSerial, tracebuf, numbytes, &cnt, 0); // read trace data
ReadFile(hSerial, header, 15, &cnt, 0);
// read rest:
<END>\n
// write the data to the console ...
for(unsigned int i=0; i<numbytes/2; i++)
{
printf("idx: %d, value: %d\n", i, tracebuf[i]);
}

Figure 6-5

Uploading a Bellcore file - example

6.6 Advanced Topics

This section gives some further examples of SCPI commands that
you may wish to use when programming your OTDR.

How to Download a Bellcore File

1

Download a specified file to the OTDR

Send the command
mmem:save:file "newtrace.sor"#Asss....
Where #Assss... is a binary block containing the Bellcore
file.

157

Programming Examples

How to Use the Power Meter and Source Mode

These examples show you how to user the Power Meter options on
the Mini-OTDR and Rack OTDR. They are not valid for the 8147A
Mainframe OTDR.
1

Select source mode

Send the command SENS:DET:MODE SOUR.

Reset the reference power

Send the command SENS:POW:REF 0.

Set the power meter display to absolute power level readout

Send the command SENS:POW:REF:STAT 0.

Select Watts (W) as the readout unit.

Send the command SENS:POW:UNIT W

Start a measurement on the power meter.

Send the command INIT2:CONT 0.

Read the detected wavelength and power.

Send the queries SENS:POW:WAV? and READ:POW?
These return, for example, 1310NM<END> and
1.07898NW<END>.

These queries respectively return the current power meter

wavelength (in nm), and the current power reading (in dBm, W, or
dB).

How to Store Traces on Other Devices

1

Select a new storage device.

For example, send the command MMEM:MSIS FLOP to
change to the floppy disk drive.

Check that the device has been changed correctly.

Send the query MMEM:MSIS?

You should receive a string corresponding to the device that you

have just set, in this case FLOP.
3
158

Check that there is enough free disk space.

Programming Examples

Send the query MMEM:FREE?.

You receive a response giving 2 values. The first value gives the
amount of free space.
4

NOT E

Reclaim extra disk space, if required (this is not possible with the
Mainframe OTDR).
Send the command MMEM:FREE.

MMEM:FREE replaces internal disk space only (not, for example, for the
Flash Disk or Floppy disk).

6.7 SCPI data transfer between PC and OTDR

This C program transfers data between the Mini-OTDR and a PC.
Before you run this program connect the PC and the OTDR with an
RS232 cable (see the Mini-OTDR Users Guide)
The program sets the measurement parameters, starts the
measurement, stops the measurement 15 seconds later, and
transfers the trace data to the PC.
NOT E

TRAC:DATA? and TRAC:DATA:LINE? returns blocks of unsigned

short (16-bit) data in Intel little endian byte ordering (low byte first).

Some processor architectures (such as HP PA-Risc or Motorola) use big

endian byte order (high byte first).
If your processor uses big endian byte order, you must swap the low and
high byte for each 16 bit value.
If you are not sure about the byte ordering technique used by your
processor, please consult your processor documentation.
/* ------------------------------------------------------------------------------------

159

Programming Examples

* Module:
demoapp.cpp
*
* Description:
application to demonstrate a SCPI data transfer between PC<->OTDR
*
* Copyright:
12/02/1996 Hewlett-Packard GmbH
*
* NOTE:
This application is not supported by HP/Agilent!
*
*
HP/Agilent cannot be held responsible
*
*
for any problems/damages caused by this program!
*
*
*
* Compile:
Compile this program as a 32Bit Console Application under Win95/NT. *
*
We recommend a struct member byte alignment of 2 bytes.
*
* -----------------------------------------------------------------------------------*/
#include <windows.h>
#include <stdio.h>
#include <string.h>
#define INTERFACE "COM1"
#define MAXNUMBYTES 255
#define TRLEN 16512
HANDLE InitSerial( int baudrate )
{
static HANDLE hSer = CreateFile(
INTERFACE,
// use COM1 / Serial A
GENERIC_READ | GENERIC_WRITE, // open for read & write access
0, NULL,
OPEN_EXISTING,
// well, hopefully ... :-)
0, NULL );
if(!hSer)
{
return NULL;
}
// configure the interface ...
DCB dcb;
COMMTIMEOUTS commtimeout;
GetCommTimeouts(hSer, &commtimeout);
commtimeout.ReadIntervalTimeout = 3000;
commtimeout.ReadTotalTimeoutMultiplier = 200;
commtimeout.WriteTotalTimeoutMultiplier = 200;
commtimeout.WriteTotalTimeoutConstant = 3000;
GetCommState(hSer, &dcb);
dcb.DCBlength = sizeof(dcb);
dcb.BaudRate = baudrate;
dcb.ByteSize = 8;
dcb.Parity = 0;
dcb.StopBits = 1;
dcb.fBinary = 1;
dcb.fParity = 0 ;
dcb.fOutX = 0;
dcb.fInX = 0;
dcb.fDtrControl = DTR_CONTROL_DISABLE;
dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
// RTS flow control
SetCommState(hSer, &dcb);
SetCommTimeouts(hSer, &commtimeout);
ClearCommBreak(hSer);
PurgeComm(hSer, PURGE_TXABORT|PURGE_RXABORT|PURGE_TXCLEAR|PURGE_RXCLEAR);

160

Programming Examples

return hSer;
}
void main(int argc, char** argv)
{
int baudrate=19200;
HANDLE hSerial=NULL;
char txtbuffer[MAXNUMBYTES+1];
char header[16];
unsigned short tracebuf[TRLEN];
unsigned long cnt;
unsigned long numbytes;

//
//
//
//
//
//
//

default value for baudrate

windows handle for interface
ascii buffer for commands/ascii queries
buffer to read the binary header into
binary buffer for trac:data? query
number of bytes actually written/read
number of bytes to write/read

// if argc>1, take argv[1] as the current baudrate

if(argc>1)
{
baudrate = atoi(argv[1]);
if(baudrate < 1200 || baudrate > 115200) baudrate = 19200;
}
// initialize the interface ...
printf("Setting baudrate to %d!\n", baudrate);
hSerial = InitSerial(baudrate);
if(!hSerial)
{
printf("Failed to open %s, exiting!\n", INTERFACE);
return;
}
// now start communicating ...
sprintf(txtbuffer,"*CLS\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
sprintf(txtbuffer,"*IDN?\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
ReadFile(hSerial, txtbuffer, MAXNUMBYTES, &cnt, 0);
if(cnt == 0 || strlen(txtbuffer) == 0)
{
printf("SCPI query failed, exiting!\n");
CloseHandle(hSerial);
return;
}
printf("Connected to: %s\n", txtbuffer);
// setting measurement parameters ...
sprintf(txtbuffer,"SOURCE:RANGE:START 0\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
sprintf(txtbuffer,"SOURCE:RANGE:SPAN 10km\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
sprintf(txtbuffer,"SOURCE:PULSE:WIDTH 100ns\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
sprintf(txtbuffer,"SOURCE:WAVELENGTH 1310nm\n");
numbytes = strlen(txtbuffer);

161

// measurement start

// measurement span

// pulsewidth

// wavelength

Programming Examples

WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);

// start the measurement ...
printf("Starting measurement ...\n");
sprintf(txtbuffer,"INIT\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
Sleep(15000); // give it 10s to run + 5s for init ...
// stop the measurement ...
printf("Stopping measurement ...\n");
sprintf(txtbuffer,"ABORT\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
Sleep(1000); // wait a little for things to settle ...
// read the trace data ...
sprintf(txtbuffer,"TRACE:DATA?\n");
numbytes = strlen(txtbuffer);
WriteFile(hSerial, txtbuffer, numbytes, &cnt, 0);
// now comes the data: e.g. #48000.... which means:
//
| 4 digits following to tell the number of bytes
//
|||| 8000 bytes following, containing 4000 trace pts
cnt=0;
while(!cnt) ReadFile(hSerial, header, 1, &cnt, 0); // read "#"
ReadFile(hSerial, header, 1, &cnt, 0); // read number of digits
header[1]=0;
numbytes = atoi(header);
ReadFile(hSerial, header, numbytes, &cnt, 0); // read digits
header[cnt] = 0;
numbytes = atoi(header);
printf("Reading %d points of trace data ...\n", numbytes/2);
ReadFile(hSerial, tracebuf, numbytes, &cnt, 0); // read trace data
ReadFile(hSerial, header, 15, &cnt, 0);
// read rest: <END>\n
// write the data to the console ...
for(unsigned int i=0; i<numbytes/2; i++)
{
printf("idx: %d, value: %d\n", i, tracebuf[i]);
}
// close the interface
CloseHandle(hSerial);
return;
}

162

The VEE Driver

The VEE Driver

This appendix gives you extra information about using HP/Agilent

OTDRs with the HP VEE VXI-plug&play driver.
You will find the driver on the update CD under vxipnp/.

164

The VEE Driver

A.1 What is HP VEE ?

Hewlett-Packard Visual Engineering Environment (HP VEE) is a
visual programming language optimized for instrument control
applications. To develop programs in HP VEE, you connect
graphical objects instead of writing lines of code. These programs
resemble easy-to-understand block diagrams with lines.
HP VEE allows you to leverage your investment in textual
languages by integrating with languages such as C, C++, Visual
Basic, FORTRAN, Pascal, and HP BASIC.
HP VEE controls GPIB, VXI, Serial, GPIO, PC Plug-in, and LAN
instruments directly over the interfaces or by using instrument
drivers.
HP VEE supports VXIplug&play drivers in the WIN, WIN95,
WINNT, and HP-UX frameworks. In addition, versions 3.2 and
above of HP VEE support the graphical Function Panel interface,
providing a function tree of the hierarchy of the driver.
NO T E

This appendix assumes that you are using Windows 95. If you are using
Windows NT, please replace every reference to win95 with winnt.
Windows 95 and Windows NT are registered trademarks of Microsoft
corporation.
HP VEE automatically calls the initialize and close functions to
perform automatic error checking.

Using the RS232 port

HP VEE supports interfacing with an instrument from the RS232
port. Before you can do this, you must do the following:
1

Select INSTRUMENT MANAGER from the IO menu.

Double-click on the Add button to bring up the Device

165

The VEE Driver

Configuration screen.
3

Enter the following information:

Name: choose any name to describe the instrument.
Interface: HP-IB (even if you want to use the serial port).
Address: key in any number (it does not matter which
number you enter as you will only be using one of the serial
ports).
Gateway: This host.

NO T E

Press Advanced I/O Config, and select the hpotdr

plug&play Driver from a drop down list.

If you do not see this driver in the list, it has not been installed properly.
5

If you are planning to use the COMx port in the machine, specify
the address of the instrument as ASRLx.

Select whether Reset and Instrument Name Check

should be performed whenever VEE opens the instrument for
interaction.

Return to the Instrument Manager screen, and select OK to save

the configuration.

A.2 How to Install HP VEE

The HP VEE VxIplug&play driver comes as a self-extracting
archive with an installation wizard. The installation wizard extracts
all the files to preset destinations, asking you appropriate questions
as it does so.
You install HP VEE by running the executable OTDR.EXE. When
you run OTDR.EXE, you see a message telling you that the HP
OTDR Instrument Driver will be installed.
166

The VEE Driver

Figure A-1

VXIplug&play window
2

NO T E

Press Yes to continue.

You see a VXIplug&play window, and a message telling you
that you are not an administrator (Figure A-1)

Ignore this message, and press Yes to continue.

If HP VEE is already installed on your system, you see a message asking

you if you want to uninstall the old version.
Press Yes, if required, then wait until you see a message telling you that
the uninstall has been successful. Then press OK to continue.
You see a Welcome message, advising you to close the
programs that you have running.
3

Close these programs and press Next> to continue.

167

The VEE Driver

NO T E

If you do not have VISA installed, you see a message advising you to
install VISA.
Press Cancel to temporarily exit this installation procedure; install
VISA on your PC, then run OTDR.EXE again.
You see a window showing you what you can install (Figure A2).
4

Figure A-2

Select any or all of Read Me, Help and Uninstall, then

press Next> to continue.

HP VEE - Install options

You see a window asking you in which folder you want to
install the files.
5

Select the default, VXIPNP, or choose a folder that you want.

Press Next> to continue.
You see a message saying that setup is complete, giving you an
option to view the Readme file.

Press Finish to complete installation, viewing the Readme file

168

The VEE Driver

if you wish.

A.3 Features of the HP OTDR VEE Driver

The HP OTDR VEE driver conforms to all aspects of the
VXIplug&play driver standard which apply to conventional rack
and stack instruments.
The following features are available:
The VEE driver conforms with the VXIplug&play standard.
There is one exception as the OTDR driver does not have a soft
front panel or a knowledge-based file.
The VEE driver is built on top of VISA, and uses the services
provided.
VISA supports GPIB and VXI protocols. The driver can be
used with any GPIB card for which the manufacturer has
provided a VISA DLL.
The VEE driver includes a Function Panel (.FP) file.
The .FP file allows the driver to be used with visual
programming environments such as HP-VEE, LabWindows,
and LabVIEW.
The VEE driver includes a comprehensive on-line help file
which complements the instrument manual.
The help file contains application programming examples, a
cross-reference between instrument commands and driver
functions, and detailed documentation of each function with
examples.
The VEE driver includes a source, so that the driver can be
modified if desired.
The source conforms to VXIplug&play standards. You should
only modify the driver if you are familiar with these standards.

169

The VEE Driver

The VEE driver includes a Visual Basic (.BAS) file which

contains the function calls in Visual Basic syntax, and allows the
driver functions to be called from Visual Basic.
You should only use Visual Basic with this driver if you are
familiar with C/C++ function declarations. You must take
particular care when working with C/C++ pointers.

A.4 Directory Structure

The setup program which installs the HP OTDR instrument driver
creates the VXIPNP directory if it does not already exist.
Windows 95 files are in VXIPNP\WIN95; Windows NT files are
in VXIPNP\WINNT.

A.5 Opening an Instrument Session

To control an instrument from a program, you must open a
communication path between the computer/controller and the
instrument. This path is known as an instrument session, and is
opened with the function
ViStatus hpotdr_init( ViRsrc InstrDesc,
ViBoolean id_query, ViBoolean reset,
ViPSession instrumentHandle );

Instruments are assigned a handle when the instrument session is

opened. The handle, which is a pointer to the instrument, is the first
parameter passed in all subsequent calls to driver functions.
The parameters of the function hpotdr_init include:
ViRsrc InstrDesc: the address of the instrument

170

The VEE Driver

ViBoolean id_query: a Boolean flag which indicates if insystem verification should be performed.
Passing VI_TRUE (1) will perform an in-system verification;
passing VI_FALSE (0) will not.
If you set id_query to false, you can use the generic functions
of the instrument driver with other instruments.
ViBoolean reset: a Boolean flag which indicates if the
instrument should be reset when it is opened.
Passing VI_TRUE (1) will perform a reset when the session is
opened; passing VI_FALSE (0) will not perform a reset,
ViPSession instrumentHandle: a pointer to an
instrument session.
InstrumentHandle is the handle which addresses the
instrument, and is the first parameter passed in all driver
functions.
Successful completion of this function returns VI_SUCCESS

A.6 Closing an Instrument Session

Sessions (instrumentHandle) opened with the hpotdr_init()
function are closed with the function:
hpotdr_close( ViSession instrumentHandle);

When no further communication with an instrument is required, the

session must be explicitly closed (hpotdr_close() function).
VISA does not remove sessions unless they are explicitly closed.
Closing the instrument session frees all data structures and system
resources allocated to that session.

171

The VEE Driver

A.7 VISA Data Types and Selected Constant

Definitions
The driver functions use VISA data types. VISA data types are
identified by the Vi prefix in the data type name (for example,
ViInt16, ViUInt16, ViChar).
The file visatype.h contains a complete listing of the VISA
data types, function call casts and some of the common constants.
NO T E

You can find a partial list of the type definitions and constant
definitions for the visatype.h in the HP OTDR Instrument Driver
Online Help.

A.8 Error Handling

Events and errors within a instrument control program can be
detected by polling (querying) the instrument. Polling is used in
application development environments (ADEs) that do not support
asynchronous activities where callbacks can be used.
Programs can set up and use polling as shown below.
1

Declare a variable to contain the function completion code.

ViStatus errStatus;
Every driver function returns the completion code ViStatus.
If the function executes with no I/O errors, driver errors, or
instrument errors, ViStatus is 0 (VI_SUCCESS).
If an error occurs, ViStatus is a negative error code.
Warnings are positive error codes, and indicate the operation
succeeded but special conditions exist.

Enable automatic instrument error checking following each

172

The VEE Driver

function call.
hpotdr_errorQueryDetect
(instrumentHandle, VI_TRUE);
When enabled, the driver queries the instrument for an error
condition before returning from the function.
If an error occurred, errStatus (Step 1) will contain a code
indicating that an error was detected
(hpotdr_INSTR_ERROR_DETECTED).
3

Check for an error (or event) after each function.

errStatus = hpotdr_cmd(instrumentHandle,
"MEAS:FREQ");
check(instrumentHandle, errStatus);
After the function executes, errStatus contains the
completion code.
The completion code and instrument ID are passed to an error
checking routine. In the above statement, the routine is called
'check'.

Create a routine to respond to the error or event.

A.9 Introduction to Programming

Selecting Functions
The functions in each category are identified below.
Application Functions
These functions do application level tasks. They are designed to
allow quick and easy access to common instrument measurement
sequences.
Application functions are instrument-specific, and can be used for
common instrument measurement tasks.

173

The VEE Driver

Subsystem Functions
These functions combine multiple SCPI commands into a single,
functional operation. They are designed to allow quick and easy
access to common instrument command sequences.
Subsystem functions are instrument-specific, and cab be used for
functional tasks.
Passthrough Functions
Passthrough functions pass SCPI commands directly to the
instrument. These functions are used when there is not a driver
function available to set or perform a particular operation.
Utility Functions
Utility functions perform a variety of standard tasks.

Example Programs
See the Online Help and Chapter 6 Programming Examples.

LabView
The 32-bit HP/Agilent OTDR driver can be used with LabVIEW
4.0 and above. LabVIEW 4.0 is a 32-bit version of LabVIEW
which runs on Windows 95 and Windows NT.
To access the functions of the HP/Agilent OTDR instrument driver
from within LabVIEW 4.0, select FILE from the main menu, then
select the CONVERT CVI FP FILE submenu item.
In the file selection dialog box which appears, select hpotdr.fp
and click on the OK button.
LabVIEW will create a series of VI's, one per driver function. It
will create a file called hpotdr.llb which contains these VI's.
This library of VI's can then be accessed like any other VI library in
LabVIEW.

174

The VEE Driver

NO T E

You must use the 32-bit version of the HP/Agilent OTDR driver with
LabVIEW 4.0.

NO T E

LabView is a trademark of National Instruments Corporation

LabWindows
The 32-bit HP/Agilent OTDR driver can be used with LabWindows
4.0 and above. LabWindows 4.0 is a 32-bit version of LabWindows
which runs on Windows 95 and Windows NT.
To access the functions of the HP/Agilent OTDR driver from within
LabWindows, select INSTRUMENT from the main menu, and then
select the LOAD... submenu item.
In the file selection dialog box which appears, select hpotdr.fp
and click on the OK button. LabWindows loads the function panel
and instrument driver.
The driver now appears as a selection on the Instrument menu, and
can be treated like any LabWindows driver.
NO T E

LabWindows is a trademark of National Instruments Corporation

A.10 VISA-specific information

The following information is useful if you are using the driver with
a version of VISA.

Instrument Addresses
When you are using HP VXIplug&play instrument drivers, you
should enter the instrument addresses using only upper case letters.
This is to ensure maximum portability.

175

The VEE Driver

For example, use GPIB0::22 rather than gpib0::22.

Callbacks
Callbacks are not supported by this driver.

A.11 Using the HP OTDR VEE Driver in

Application Development Environments
The sections contains suggestions as to how you can use
hpotdr_32.dll within various application development
environments.

Microsoft Visual C++ 4.0 (or higher) and Borland

C++ 4.5 (or higher)
Please refer to your Microsoft Visual C++ or Borland C++ manuals
for information on linking and calling DLLS.
The driver uses Pascal calling conventions.
You should rebuild the driver DLL in a different directory to the
directory in which the driver was installed. This helps you to
differentiate the changes.

Microsoft Visual Basic 4.0 (or higher)

Please refer to your Microsoft Visual Basic manual for information
on calling DLLs.
The BASIC include file is hpotdr.bas. You can find this file in
the directory ~vxipnp\win95\include, where ~ is the
directory in the VXIPNP variable.
By default, ~ is equivalent to C:\. This means that the file is in
C:\vxipnp\win95\include.

176

The VEE Driver

You may also need to include the file visa.bas. visa.bas is

provided with your VISA DLL.

HP VEE 3.2 (or higher)

Your copy of HP VEE for Windows contains a document titled
Using VXIplug&play drivers with HP VEE for Windows. This
document contains the detailed information you need for HP VEE
applications.

LabWindows CVI/ (R) 4.0 (or higher)

The HP OTDR VEE driver is supplied as both a source code file,
and as a Dynamic Link Library (.DLL) file.
There are several advantages to using the .DLL form of the driver,
including those listed below:
transportability across different computer platforms,
a higher level of support for the compiled driver from HewlettPackard,
a faster load time for your project.
LabWindows/CVI (R) will attempt by default to load the source
version of the instrument driver. To load the DLL, you must include
the file HPOTDR.FP in your project. HPOTDR.FP can be found in
the directory vxipnp\win95\hpotdr.
Do not include HPOTDR.C in your project.
You must provide an include file for HPOTDR.H. You do this by
ensuring that the directory ~vxipnp\win95\include is added
to the include paths (CVI Project Option menu).
~ is the directory in the VXIPNP variable. By default, ~ is
equivalent to C:\. This means that the file is in
C:\vxipnp\win95\include.

177

The VEE Driver

A.12 Online information

The latest copy of this driver and other HP VXIplug&play drivers
can be obtained from the World Wide Web at:
http://www.agilent.com/find/inst_drivers

If you do not have web access, please contact your Agilent supplier,
or use the version of OTDR.EXE on your installation CD.

178

Index
A

Close

all traces ............117

trace .................117

Abort

measurement .......79
printing .............130

Add landmark .........112

Around marker ........127
Attenuation .............87
Automatic
measurement
mode ..............92
Average
number of averages

90

Average mode .........91

Averaging time ........89

Color .....................125
Command messages .17
Command syntax .....17
Commands .............153
Comment ...............126
Common commands .20
Common status registers 22
Condition register ....56, 59
Continue mode ........91
Continuous measurement 80
Contrast .................123,

124

Copy

file

Battery

current ..............58
power ...............57
power capacity ....57

..................138

Current ..................58
Current trace ...........117,

118

CW mode

Baud rate ................62

Bellcore file

download ...........157
upload ..............156

Bellcore revision number

143

Binary block

153

...........18,

Blocks transfer ........153

Brightness ..............123

Data bits .................63

Data points .............118,

119

Data transfer ...........159

Data types ..............18
Date ......................69
Defaults .................47
Delete
all traces ............117
file ..................138
landmark ...........113
trace .................117

Cable configuration ..147

CALCulate subsystem 83
Clear
event registers

Device

...................158
..............141
..............139

change
format

.....45

179

................141

change ..............137
contents ............137
create ...............140
query ................138

Display

brightness ..........123
contrast .............123,

124
................124
Display Operations ...123
DISPlay Subsystem ..123
Dotted line ..............125,
126
Download file .........142,
157
Dynamic optimization 92,
93
LCD

...............91
D

query

Directory

Empty traces ...........118

End Threshold .........85, 86
Error queue .............19, 70
Event register
clear .................45
operation ...........56
operation enable ...56, 57
questionable .......59
questionable enable 59,

60

Event Status Enable ..46

Event Status Register 47
Event Table ............115
lock
print

.................115
.................133,
134

Front Matter
F
Factory default
Fiber
type

I
........47

.................95
.93

Fiber Break Locator

File

copy .................138
delete ...............138
download ...........142
upload ..............140

File operations .........137

Flash disk ...............141

..............139
Floppy ...................141
format ..............139

Identification ...........48
IEEE-Common Commands

45

Initialize .................154
Input frequency .......96
Input queue .............19
Installed options ......50
Instrument Behaviour Settings ...............61
Instrument Configuration

148

format

example

Interface
behaviour settings

Front connector Return Loss

112

GPIB address
Grid
print

Keyboard
Keystroke

.................135

Hard disk ...............141

HCOPy subsystem ...130
Help page ...............70
Horizontal offset ......101

...............81

return last keystroke 72

simulate keystroke 71

..........61, 62

.61

................127
G

.................114
92,

93

Linestyle

................125,

Load file
Lock

................140

126

event table

L
Landmark

add ..................112
delete ...............113

Laser

state .................104
switch on ...........104

LCD
180

......................124

.........115

Loss ......................87
LSA Attenuation ......87

............149

load .................73
read .................73
save .................53
set ...................73

device

Full trace

store

Linearity optimization

Instrument setting

Format

...............139
Free space ..............139
reclaim .............139
Frequency ..............96

Learn .....................49
Length unit .............106
Line

M2kHz mode
Marker

..........91

activate .............103
disable ..............103
position .............102
state .................103

..........155
.................80
.................79
Measurement Functions 89
Measurement mode ..91
automatic ...........92
Message exchange ...18
MMEMory subsystem 137
Measurement
start
stop

Modulation frequency

internal source .....100

visual fault finder .100,

101

Module
fiber type

...........95
......95

Multimode fiber

Index
N

................141
..............139
Power ....................57
capacity ............57
current ..............58
Power Meter ...........158
format

Non-Reflective Threshold

85, ................86
Notices ..................2
Number of averages .90

59

start measurement

.80

Power meter

absolute display ...97

continuous measurement

Operating time ........58

Operation Complete .49
Operation condition register

80

current value .......79,

input frequency ....96
reference value ....96,
relative display ....97
units .................96,
wavelength .........98,

56

Operation enable ......56, 57

Operation event register 56
Optimization mode ...92, 93
Options ..................50
OTDR

............154
OTDR mode ...........93
OTDR screen ..........93
Output queue ..........19

Print

P
Pace ......................65, 66
Paper size ...............136
Parameter window

.................132,
133
Parity checking ........67, 68
Parity type ..............66, 67
Pass/Fail test ...........85
limits ................83, 84
state .................112
table .................111
print

147

82
97
98
99

......................156

abort ................130
device ...............130,

initialize

connect with OTDR

Queries ..................153
Questionable enable .59, 60
Questionable event register

continuous measurement

80

PC

PCMCIA

131
.........133,
134
grid ..................135
paper size ..........136
parameter window 132,
133
print all .............132
print all selected ...131
trace .................134,
135
Print operations .......130
Printer ...................130,
131
PROGram subsystem 83
Pulsewidth ..............104,
105
lower limit .........105
upper limit .........105
event table

181

Realtime mode ........91

Recall saved settings 51
Reclaim free space ...139
Reflectance .............87, 88
Reflection Height .....88
Reflection parameter 88
Reflective Threshold 85, 86
Refractive index ......94
Reset .....................52
Reset default ...........47
Resolution optimization 92,

93

Return Loss

front connector ....112

total .................116

Return Loss mode ....91

Root layer commands 79
RS232 ...................68,

147
...................68

RS485

S
Sample distance .......94
Save ......................53,

156

setting ..............142
trace .................142

Front Matter
Saved settings
Scale

measurement ......80
power meter measurement

.........51

..............128
..............129
Scan Trace ..............85,
156
Scatter coefficient ....95
SCPI revision ..........75
Self-test .................54
SENSe subsystem ....89
x-scale
y-scale

Serial 2

80

Status Byte .............54

Status Command Summary

27

Status Information ....22

Status Registers .......22
Status Reporting ......56
STATus subsystem ..56
Stop

baud rate ...........62

data bits ............63
pace .................65,
parity checking ....67,
parity type ..........66,
stop bits ............68,

Setting
save

.................142
.................140

SYSTem subsystem

Signal generation .....100

Single-mode fiber ....95
Solid line ................125,

126

Source Mode

158

119

empty traces .......118

linestyle ............125,

...........93,

156

Trace array .............18

Trace Data Access ...75,

110

TRACe subsystem ...110

Traffic detection ......82
Transfer
blocks

Terminal program
Terminate

....150

Specific Command Summary

Threshold ...............85,
Time .....................74

enter

................81

since power on

....74

Total Optical Return Loss

182

...............153
U

........86

Test .......................54
Text

33, ................34
Splice loss ..............88
Start ......................107
laser .................104

135, ...156

current task

126

load file .............140

loaded ..............110
name ................142
print .................134,
rename ..............141
save .................142,

..61

SOURce subsystem ..100

Span ......................106,

107

69

CALCulate .........83
DISPlay ............123
HCOPy .............130
MMEMory .........137
PROGram ..........83
SENSe ..............89
SOURce ............100
STATus ............56
SYSTem ...........61
TRACe .............110

66
68
67
69

Settings file
load

118

Stop bits .................68,

Subsystem

Serial interface

close ................117
close all .............117
color ................125
comment ...........126
current trace .......117,
data array ...........111
data points .........118,

laser .................104
measurement ......79

configuration ......68
send command ....64
send query .........64
send/receive data ..61

116
Trace

.....................17,
106
Upload file .............140,
156
Uptime ..................74
Units

86

Index
V
Visual Fault Finder
modulation frequency

100, ...101
W

Wait ......................55
Wavelength ............108

available ............109
power meter .......98, 99

X
x-scale

...................128
Y

y-scale

...................129
Z

Zoom
around marker

.....127

183