Agilent E4310A Programming Guide

Page 1

Agilent Technologies OTDRs Programming Guide

Page 2

Notices

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.

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

continually increasing customer satisfaction through improved process control.

Bellcore Certification of Excellence

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

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 Böblingen Germany

Page 3

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 OTDR-

specific commands.

• Chapter 6 gives some example programs showing how the SCPI

commands can be used with OTDRs.

Page 4

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

entered either 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

entered as

• 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

INITiate[:IMMediate][:ALL] can be

init[:imm][:all], or as

INITiate[:IMMediate][:ALL] can be

init or initiate.

/?.

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 User’s Guide (Agilent

Product Number E4310-91011).

• Agilent E6000C Mini-OTDR User’s Guide (Agilent Product Number

E6000-91031)

Page 5

• Agilent E6020A Mini-Fiber Break Locator User’s Guide (Agilent

Product Number E6020-91011)

• Agilent E6053A, E6058A and E6060A Rack OTDR User’s Guide

(Agilent Product Number E6050-91011).

NOTE 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.

Page 6

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

Asia-Pacific (852) 2599 7777

1 800 629 485 (Australia)

0800 738 378 (New Zealand)

(852) 2506 9285 (FAX)

Page 7

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

Page 8

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 SYS-

Tem 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

Page 9

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

Page 10

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 De-

velopment 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

Page 11

Front Matter

Figure 1-1 Common Status Registers......................................................................... 22

Figure 6-1 Instrument configuration - example .......................................................... 149

Figure 6-2 Connection check - example ..................................................................... 152

Figure 6-3 Query - example........................................................................................ 153

Figure 6-4 Blocks transfer - example ......................................................................... 154

Figure 6-5 Uploading a Bellcore file - example ......................................................... 157

Figure A-1 VXIplug&play window ........................................................................... 167

Figure A-2 HP VEE - Install options.......................................................................... 168

Page 12

Front Matter

Page 13

Front Matter

Table 1-1 Common Command Summary................................................................... 21

Table 2-1 Specific Command Summary..................................................................... 34

Table 6-1 Cable configuration for connection to a PC ............................................... 147

Table 6-2 Transmission parameters............................................................................ 150

Page 14

Front Matter

Page 15

1 Introduction to

Programming

Page 16

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.

Page 17

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 Default Allowed Mnemonics

meters M NM, UM, MM, M, KM

miles MI MIles

feet FT FT, KFT

decibel DB MDB, DB

second S NS, US, MS, S

The default unit of length is usually mm.

Page 18

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.

Page 19

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, 0D query is received, or if the query has an error, the output queue remains empty.

) and a LF (0A16), with EOI=TRUE. If no

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.

Page 20

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.

Page 21

Introduction to Programming

Common Command Summary

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

Table 1-1 Common Command Summary

Command Parameter Function

*CLS Clear Status Command

*ESE Standard Event Status Enable Command

*ESE? Standard Event Status Enable Query

*ESR? Standard Event Status Register Query

*FTY Reset defaults and reboot

(not possible on Mainframe OTDR)

*IDN? Identification Query

*LRN? Read instrument settings

*OPC? Operation Complete Query

*OPT? Options Query

*RCL <location> Recall Instrument Setting

*RST Reset Command

*SAV <location> Save Instrument Setting

*STB? Read Status Byte Query

*TST? Self Test Query

*WAI Wait Command

NO T E These commands are described in more detail in “IEEE-Common

Commands” on page 45

Page 22

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.

ATTENTION 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

Page 23

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

Page 24

Introduction to Programming

Bit 7

Bit 6

Status Byte

Operat

Status

Standard Event Status Enable

Bit 7

Power

*Master

Summ

Bit 6

*User

Request

Bit 5 ESR

Summ.

Bit 5

Error

Cmd

Bit 4

MAV

Bit 4

Exec

Error

DevDep

Bit 3

Quest. Status

Bit 3

Error

Bit 2

*unused

Bit 2

Query

Error

Bit 1

*unused

Bit 1

*Req

Control

Bit 0

Laser

Active

Bit 0

Operat. Compl.

Standard Event Status Reg is ter

Enable

Status Statu s

0, *unused

1, *unused

2, *unused

3, *unused

4, meas running

5, *unused

6, *unused

7, *unused

8, scan running

9, printing

10, *unused

11, *unused

12, *unused

13, *unused

14, *unused

15, *unused

0, *unused

1, *unused

2, *unused

3, power warn

4, *unused

5, *unused

6, *unused

7, *unused

8, *unused

9, *unused

10, *unused

11, *unused

12, *unused

13, *unused

14, cmd. warn.

15, *unused

EVENt <- CONDition CONDition -> EVENt

Operation Questionable

Enable

Page 25

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

• 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?.

*ESR after Power On.

Page 26

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.

Page 27

Introduction to Programming

Status Command Summary

*STB? returns status byte, value 0 .. +255

*ESE sets the standard event status enable register, parameter 0 .. +255

*ESE? returns SESE, value 0 .. +255

*ESR? returns the standard event status register, value 0 .. +255

*OPC? 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:

Page 28

Bit 31

ST-

Error

Bit 30

Mainframe

State

Introduction to Programming

Mini-OTDR and Rack OTDR Bit Table

<-------- Overall State - "0" means passed, "1" means ST failed or not tested -------->

Bit 29

Bit 28

Bit 27

Bit 26

Bit 25

Bit 24

Bit 23

Bit 22

Bit 21

Bit 20

Video

State

Batt

RTC

State

Bits 15 .. 8

SMC State

Check

Sum

State

Power

State

Flash

State

Floppy

State

DAP State

Sub-

Module

State

Bits 7 .. 0

Bit 19

State

Bits 18 .. 16

Unused

Submodule Error

Module Error

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

Mainframe OTDR Bit Table

MSW:

LSW:

Bit 31

Selftest

ERROR

Bit 23

FATAL

ST-Error

Bit 15

APD-

Bit 7

not used

Bit 22

ST non-

fatal

Error

Bit 14

RCVOFFS

Bit 6

DAP-

ALU

Bit 21

analog

summ

Bit 13

OFFS

HILIN

Bit 5

DSPCode

Bits 30 .. 26

unused

Bit 20

digital summ

Bit 12

OFFS

Higain

Bit 4

CAL-

Data

Bit 19

MOD

Tem p.

Bit 11

OFFS

Logain

Bit 3

LOG-

Table

Bit 18

LAS

Tem p.

Bit 10

RMS

HILIN

Bit 2

SHOT-

RAM

Bit 25

Module

Init

failed

Bit 17

APD-L

Tem p.

Bit 9

RMS

Higain

Bit 1

DAPRAM

Bit 24

IBI-test

failed

Bit 16

APD-H

Tem p.

Bit 8

RMS

Logain

Bit 0

DSPRAM

Page 29

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)

Page 30

Introduction to Programming

Page 31

2 Specific Commands

Page 32

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.

Page 33

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

•

NO T E If a command and a query are both available, the command ends /?.

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.

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.

Page 34

Specific Commands

Command Description Page

ABORt[1/2]

Stops a running measurement.

CALCulate:MATH:EXPRession

:NAME? Allows calculating loss and attenuation values.

:REFLex? Calculates Reflectance.

:SPLice? Calculates Splice Loss.

:TYPE/? Sets/queries whether Reflection Height or Reflectance is

used.

DISPLay

:BRIGhtness/? Changes or queries the current LCD brightness.

:CONTrast/? Changes or queries the current LCD contrast.

:ENABle/? Enables, disables, or checks the internal LCD.

DISPLay[:WINDow]:GRAPhics

:COLor/? Changes or queries the trace color.

:LTYPe/? Changes or queries the trace linestyle.

123

124

125

DISPLay[:WINDow]:TEXT

:DATA/? Sets or requests a comment.

DISPLay[:WINDow]:X

:SCALe/? Changes or queries the zooming mode (full trace or zoom)

DISPLay[:WINDow]:X[:SCALe]

:PDIVision/? Changes or queries the scaling of the X-axis.

DISPLay[:WINDow]:Y[:SCALe]

:PDIVision/? Changes or queries the scaling of the Y-axis.

FETCh[:SCALar]

:POWer[:DC]? Reads current power meter value (triggers a measurement).

Table 2-1 Specific Command Summary

126

127

128

129

Page 35

Specific Commands

Command Description Page

HCOPy

:ABORt Cancels the current print job.

:DESTination/? Changes or queries the active printer.

[:IMMediate] Immediately starts printing everything selected.

HCOPy:ITEM

:ALL[:IMMediate] Start printing everything.

HCOPy:ITEM[:WINDow]

[:IMMediate] Immediately starts printing the parameter window.

:STATe/? Enables or queries printing the parameter window.

HCOPy:ITEM[:WINDow]:TEXT

[:IMMediate] Immediately starts printing the event table.

:STATe/? Enables or queries printing the event table.

HCOPy:ITEM[:WINDow]:TRACe

[:IMMediate] Immediately starts printing the trace.

:STATe/? Enables or queries printing the trace.

HCOPy:ITEM[:WINDow]:TRACe:GRATicule

:STATe/? Enables or queries printing the trace window grid.

130

131

132

133

134

133

135

HCOPy:PAGE

:SIZE/? Selects or queries the size of the paper.

INITiate[1][:IMMediate]

[:ALL] Starts a measurement.

INITiate2

:CONTinuous/? Starts or Queries a single/continuous power meter

KEYBoard

Table 2-1 Specific Command Summary (continued)

Starts a power meter measurement.

measurement.

Allows the use of a terminal as an external keyboard

136

Page 36

Specific Commands

Command Description Page

MMEMory

:CATalog? Returns contents of current directory.

:CDIRectory/? Changes or queries the current directory.

:DELete Deletes a file.

:FREE Reclaims free space.

:FREE? Returns the amount of free space and the amount used

:INITialize Formats the specified storage device

:MDIRectory Creates a directory on the current storage device.

:MSIS/? Changes or queries the current storage device.

:NAME/? Changes or queries the name of the current trace.

MMEMory:COPY

:FILE Copies a file to a new name/device

MMEMory:LOAD

:FILE? Returns a Bellcore binary file.

:STATe Loads a settings file.

:TRACe Loads a trace file.

137

138

139

140

141

138

140

MMEMory:SAVE

:FILE Downloads a Bellcore binary file

MMEMory:STORe

:STATe Saves a settings file.

:TRACe Saves a trace file.

:TRACe:REVision/? Sets or requests the Bellcore file revision used.

PROGram:EXPLicit

:CHECk:LIMit/? Sets or queries the Pass/Fail Test limits

:EXECute Executes a special task.

Table 2-1 Specific Command Summary (continued)

142

Page 37

Specific Commands

Command Description Page

:NUMBer/? Sets or requests the threshold in mdB

:STATe/? Controls a running task.

READ[:SCALar]

:POWer[:DC]? Reads current power meter value (no measurement

triggered).

SENSe:AVERage

:COUNt/? Sets or queries the current averaging time.

SENSe:AVERage:COUNt

:NUMBer/? Sets or queries the number of averages for measurements

SENSe:DETector

[:FUNCtion]/? Sets or queries the current measurement mode.

[:FUNCtion:]AUTO/? Enables or checks the auto mode.

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

:MODE/? Sets or returns the current Mini-OTDR mode

SENSe:DETector:SAMPle

:DISTance? Returns the current sample distance.

SENSe:FIBer

:REFRindex/? Sets or returns the current refractive index.

:SCATtercoeff/? Sets or returns the current scatter coefficient.

:TYPE? Returns the current fiber type.

SENSe:POWer

:FREQuency? Queries the detected power meter input frequency

:REFerence/? Sets or Queries the power meter reference value.

:UNIT/? Sets or Queries the power meter power units.

:WAVelength/? Sets or Queries the power meter wavelength.

Table 2-1 Specific Command Summary (continued)

Page 38

Specific Commands

Command Description Page

SENSe:POWer:REFerence

:DISPlay Takes current power meter value as reference value.

:STATe/? Sets or Queries type of power meter display (relative or

absolute).

[SOURce:]

HOFFset/? Sets or returns the horizontal offset

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

[SOURce:]AM[:INTERNAL]

:FREQuency[1/2]/? Sets or returns frequency of chosen source.

[SOURce:]MARKer1/2/3

:POINt/? Sets or returns the position of the marker.

[:STATe]/? Activates, disables, or checks the marker.

SOURce:POWer

:STATe[1/2] Switches the laser of the chosen source on or off.

:STATE[1/2]? Queries the state of the chosen source.

[SOURce:]PULSe

:WIDTh/? Sets or returns the pulsewidth.

:WIDTh:LLIMit? Returns the lower limit of the measurement hardware.

:WIDTh:ULIMit? Returns the upper limit of the measurement hardware.

101

108

100

102

103

104

105

[SOURce:]RANGe

:LUNit/? Sets or returns the current length unit.

:SPAN/? Sets or returns the current measurement span.

:STARt/? Sets or returns the current measurement start.

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

AVAilable? Returns the available wavelength(s)

Table 2-1 Specific Command Summary (continued)

106

107

109

Page 39

Specific Commands

Command Description Page

STATus

:PRESet Presets all registers and queues.

STATus:OPERation

[:EVENt]? Returns the event register.

:CONDition? Returns the condition register.

:ENABle/? Sets or queries the enable mask for the event register.

STATus:POWer

:ACDC? Queries how the battery is powered.

:CAPacity? Returns the power capacity of the battery.

:CURRent? Returns the current of the battery in mA.

:REMain? Returns the operating time in minutes.

STATus:QUEStionable

[:EVENt]? Returns the event register.

:CONDition? Returns the condition register.

:ENABle/? Sets or queries the enable mask for the event register.

SYSTem

:BRIDge Passes communication from serial port 1 to serial port 2

:DATE/? Sets or returns the OTDR’s internal date.

:ERRor? Returns the contents of the OTDR’s error queue.

:HELP? Returns a Help page on a specified topic

:KEY/? Simulates or Returns a key stroke on the OTDR’s front panel.

:PRESet Loads a predefined instrument setting.

:SET/? Sets or returns the current setting

:TIME/? Sets or returns the OTDR’s internal time.

:UPTime? Returns the time (in seconds) run on the OTDR

Table 2-1 Specific Command Summary (continued)

Page 40

Specific Commands

Command Description Page

:VERSion? Returns the OTDR’s SCPI version

SYSTem:COMMunicate

:GPIB[:SELF]:ADDRess/?Sets or returns the OTDR’s GPIB address.

SYSTem:COMMunicate:SERial

:FEED/? Sends a command or query to serial port 2

[:RECeive]:PORT? Returns the port used (RS232 or RS485) by the Rack OTDR

[:RECeive]:SBITS/? Sets or queries the number of stop bits.

SYSTem:COMMunicate:SERial[1|2][:RECeive]

:BAUD/? Sets or queries the baud rate.

:BITS/? Sets or queries the number of data bits.

:PACE/? Sets or queries the pace for the communication.

:PARity[:TYPE]/? Sends or returns the parity

:PARity:CHECk/? Activates the parity.

TRACe

:CATalog? Returns positions and names of currently loaded traces.

:DATA? Reads a complete trace data array.

:DELete Closes the current trace.

:DELete:ALL Closes all loaded traces.

:FEED:CONTrol/? Sets or queries the current trace.

:FREE? Returns the number of unused trace array values.

:POINts Sets the number of samples for the current trace.

:POINts? Returns the number of data points of the current trace.

110

111

117

118

119

TRACe:DATA

:FCRetloss? Returns the Front Connector return loss

:LINE? Reads samples

Table 2-1 Specific Command Summary (continued)

112

114

Page 41

Specific Commands

Command Description Page

:TABLe? Returns an event table.

:TABLe:LOCK/? Sets or queries whether or not event table is locked.

:TORL? Returns the total optical return loss

:VALue? Returns a measured value at a sample point.

TRACe:DATA:CHECk

:TABLe? Returns a Pass/Fail Test table.

:STATe? Queries the Pass/Fail Test Table state.

TRACe:DATA:LANDmark

:ADD Adds a landmark

:DELete Deletes a landmark

TRAFficdet/?

Table 2-1 Specific Command Summary (continued)

Sets/queries whether traffic detection is on or off

115

116

111

112

113

Page 42

Specific Commands

Page 43

3 Instrument Setup and

Status

Page 44

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”.

Page 45

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: *CLS

syntax: *CLS

description: 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.

parameters: none

response: none

example: *

affects:

CLS

All instruments

Page 46

Instrument Setup and Status

command: *ESE

syntax: *ESE<wsp><value>

description: 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.

parameters: The bit value for the register (a short or a float):

Bit Mnemonic Decimal Value

7 (MSB) Power On 128 6User Request 64 5 Command Error 32 4 Execution Error 16 3 Device Dependent Error 8 2 Query Error 4 1Request Control 2 0 (LSB) Operation Complete 1

response: none

example:

affects: All instruments

command: *ESE?

syntax: *ESE?

description: The standard Event Status Enable query *ESE? returns the contents of the

parameters: none

response: The bit value for the register (a short value).

example:

affects:

*ESE 21

Standard Event Status Enable register (see *ESE for information on this register).

*ESE? → 21<END>

All instruments

Page 47

Instrument Setup and Status

command: *ESR?

syntax: *ESR?

description: The standard Event Status Register query *ESR? returns the contents of the

Standard Event Status register. The register is cleared after being read.

parameters none

response The bit value for the register (a short or a float):

Bit Mnemonic Decimal Value

7 (MSB) Power On 128

6User Request 64

example:

affects:

5 Command Error

4 Execution Error

3 Device Dependent Error

2 Query Error

1Request Control 2

0 (LSB) Operation Complete 1

*ESR? → 21<END>

All instruments

command: *FTY

syntax: *FTY

description: The FacTorY defaults command *FTY resets your OTDR to the factory

defaults and reboots the OTDR.

parameters: none

response: none

example:

affects: Mini-OTDR, Mini-FBL and Rack OTDR

*FTY

Page 48

Instrument Setup and Status

command: *IDN?

syntax: *IDN?

description: The IDeNtification query *IDN? gets the instrument identification over the

interface.

parameters: none

response: The identification terminated by <END>:

HP E6000 Mini-Optical Time Domain Reflectometer Mainframe: nnnnnnnnnn, Module: mmmmmmmmmm SW_Rev i.j

HP:

mmmm: ssssssss rrrrrrrrrr

SW_Rev i.j

example:

NO T E The response from *IDN? for Mini FBLs, Rack OTDRs and

*IDN? → HP E6000 Mini Optical Time Domain Reflectometer Mainframe 0123456789, Module: ABCDE54321 SW_Rev 6.0<END>

Mainframe OTDRs is respectively:

manufacturer instrument model number (for example E6000) serial number firmware revision level Software Revision number, for example 1.1 or 1.0

Agilent E6020A Fiber Break Locator Instrument...

HP E60xxA Rack Optical Time Domain Reflectometer...

and

HP 8147 Optical Time Domain Reflectometer...

affects:

All instruments

Page 49

Instrument Setup and Status

command: *LRN?

syntax: *LRN?

description: The LeaRN query *LRN? reads the complete instrument setting in a binary

block. The binary block can be directly stored as a setting file.

parameters: none

response: Binary block.

example:

affects:

command: *OPC?

syntax:

description: The OPeration Complete query *OPC? parses all program message units in

*LRN? → binblock

All instruments

*OPC?

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):

• Power-on

• the Device Clear Active State is asserted on the interface.

• *CLS

• *RST

parameters: none

response: 0<END> print, measurement, Scan Trace active, or

1<END>

example:

affects:

*OPC? → 1<END>

All instruments

Page 50

Instrument Setup and Status

command: *OPT?

syntax: *OPT?

description: 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.

parameters: none

response: Mini-OTDR / Mini-FBL response:

Rack OTDR response:

Mainframe OTDR response:

module-type|0, DC|0, PRINTER|0, COLOR|0, HPIB|0, LAN|0

NO T E 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.

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

argument (EXTFLASH) will always be 0.

example: 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>

affects:

All instruments

Page 51

Instrument Setup and Status

command: *RCL

syntax: *RCL<wsp><location>

description: The instrument setting is changed to one saved on the internal storage

device. Saved settings are in the form n.SET, so

SET2.SET.

parameters: a short value (between 0 and 5) giving the number of the setting to be

saved.

response: none

related commands *SAV

example:

affects:

*RCL 3

Mini-OTDR, Rack OTDR, and Mainframe OTDR

*RCL 2 recalls setting

Page 52

Instrument Setup and Status

command: *RST

syntax: *RST

description: 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

•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)

parameters: none

response: none

example:

affects:

*RST

All instruments

Page 53

Instrument Setup and Status

command: *SAV

syntax: *SAV<wsp><location>

description: 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

SET2.SET.

parameters: a short value (between 0 and 5) giving the number of the setting to be

saved.

related commands:

response: none

example:

affects:

*RCL

*SAV 3

Mini-OTDR, Rack OTDR, and Mainframe OTDR

*SAV 2 saves the current setting as

Page 54

Instrument Setup and Status

command: *STB?

syntax: *STB?

description: 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.

parameters: none

response: 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

example:

affects:

*STB? → 1<END>

All instruments

command: *TST?

syntax: *TST?

description: 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.

parameters: none

response: The sum of the results for the individual tests (a 32-bit signed integer

value):

example:

affects:

*TST? → 0<END>

All instruments

Page 55

Instrument Setup and Status

command: *WAI

syntax: *WAI

description: 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.

parameters: none

response: none

example:

affects:

*WAI

All instruments

Page 56

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: STATus:OPERation[:EVENt]?

syntax: STATus:OPERation[:EVENt]? description: Queries the operation event register parameters: none

response: The bit value for the operation event register as a

(0 .. +32767)

example:

affects: All instruments

command: STATus:OPERation:CONDition?

syntax: STATus:OPERation:CONDition? description: Queries the operation condition register parameters: none

response: The bit value for the operation condition register as a

example:

affects: All instruments

stat:oper? → +0<END>

(0 .. +32767)

stat:oper:cond? → +16<END>

short value

command: STATus:OPERation:ENABle

syntax: STATus:OPERation:ENABle<wsp><value> description: Sets the operation enable mask for the event register parameters: The bit value for the operation enable mask as a

short value

(0 .. +32767)

response: none

example:

stat:oper:enab 128

affects: All instruments

Page 57

Instrument Setup and Status

command: STATus:OPERation:ENABle?

syntax: STATus:OPERation[:ENABle]?

description: Returns the operation enable mask for the event register

parameters: none

response: The bit value for the operation enable mask as a

short value

(0 .. +32767)

example:

stat:oper:enab? → +128<END>

affects: All instruments

command: STATus:POWer:ACDC?

syntax: STATus:POWer:ACDC?

description: Queries how the battery is powered.

parameters: none

response: AC, DC or CHARging

example:

stat:pow:acdc? → AC<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: STATus:POWer:CAPacity?

syntax: STATus:POWer:CAPacity?

description: Returns the power capacity of the battery.

parameters: none

response: percentage capacity of the battery

example:

stat:pow:cap? → 75%<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 58

Instrument Setup and Status

command: STATus:POWer:CURRent?

syntax: STATus:POWer:CURRent? description: Returns the current of the battery in mA. parameters: none

response: Battery current

NO T E If the battery is discharging, the returned value will be negative.

If the battery is charging, the returned value will be positive.

example: stat:pow:curr? → 200MA<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: STATus:POWer:REMain?

syntax: STATus:POWer:REMain? description: Returns the operating time in minutes parameters: none

response: Remaining time

example:

stat:pow:rem? → 180MIN<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: STATus:PRESet

syntax: STATus:PRESet description: Resets both enable masks to 0. parameters: none

response: none

example:

stat:pres

affects: All instruments

Page 59

Instrument Setup and Status

command: STATus:QUEStionable[:EVENt]?

syntax: STATus:QUEStionable[:EVENt]?

description: Queries the questionable event register

parameters: none

response: The bit value for the questionable event register as a

(0 .. +32767)

example:

stat:ques? → +0<END>

affects: All instruments

command: STATus:QUEStionable:CONDition?

syntax: STATus:QUEStionable:CONDition?

description: Queries the condition register

parameters: none

response: The bit value for the questionable condition register as a

(0 .. +32767)

example:

stat:ques:cond? → +8<END>

affects: All instruments

short value

command: STATus:QUEStionable:ENABle

syntax: STATus:QUEStionable:ENABle<wsp><value>

description: Sets the questionable enable mask for the event register

parameters: The bit value for the questionable enable mask as a

short value

(0 .. +32767)

response: none

example:

stat:ques:enab 128

affects: All instruments

Page 60

Instrument Setup and Status

command: STATus:QUEStionable:ENABle?

syntax: STATus:QUEStionable[:ENABle]? description: Returns the questionable enable mask for the event register parameters: none

response: The bit value for the questionable enable mask as a

short value

(0 .. +32767)

example:

stat:ques:enab? → +128<END>

affects: All instruments

Page 61

Instrument Setup and Status

3.3 Interface/Instrument Behaviour Settings – The SYSTem Subsystem

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

command: SYSTem:BRIDge

syntax: SYSTem:BRIDge

description: 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

parameters: none

response: none

example:

syst:brid

affects: Rack OTDR only

#SCPI is detected.

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

syntax:

description:

parameters:

response:

example:

SYSTem:COMMunicate:GPIB[:SELF]:ADDRess<wsp><value>

Sets the OTDR’s GPIB address.

Valid values for the address are 1 .. 32 (a short value).

none

syst:comm:gpib:addr 15

affects: Mainframe OTDR only

Page 62

Instrument Setup and Status

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

syntax: description: parameters:

response:

example:

affects: Mainframe OTDR only

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:BAUD

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

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

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

Queries the OTDR’s current GPIB address.

none

Possible values for the address are 1 .. 32 (a short value).

syst:comm:gpib:addr? → +15<END>

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

NO T E All changes take effect immediately. After this command, you

must reconfigure your RS232 to continue communication.

parameters: Valid baud rates are 1200, 2400, 9600, 19200,38400, 57600, 115200.

response: none

example:

syst:comm:ser:baud 9600

affects: All instruments

Page 63

Instrument Setup and Status

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

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

description: Returns the current baud rate for the OTDR serial interface

NO T E 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.

parameters: none

response: Possible baud rates are 1200, 2400, 9600, 19200, 38400, 57600,

115200

example:

syst:comm:ser:baud? → +9600<END>

affects: All instruments

command: SYSTem:COMMunicate:SERial[:RECeive]:BITS

syntax:

description:

SYSTem:COMMunicate:SERial[:RECeive]:BITS<wsp><value>

Sets the number of data bits for the OTDR’s serial interface.

NO T E All changes take effect immediately. After this command, you

must reconfigure your RS232 to continue communication.

parameters:

response:

example:

Valid numbers are 5 .. 8

none

syst:comm:ser:bits 6

affects: Mainframe OTDR only

command: SYSTem:COMMunicate:SERial[:RECeive]:BITS?

syntax:

description:

parameters:

response:

example:

SYSTem:COMMunicate:SERial[:RECeive]:BITS?

Returns the number of data bits for the OTDR’s serial interface.

none

Possible numbers are 5 .. 8

syst:comm:ser:bits → +6<END>

affects: Mainframe OTDR only

Page 64

Instrument Setup and Status

command: SYSTem:COMMunicate:SERial:FEED

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

response: none

example:

affects: Rack OTDR and Mainframe OTDR

command: SYSTem:COMMunicate:SERial:FEED?

syntax: SYSTem:COMMunicate:SERial:FEED?<wsp><query> description: Send a query to the instrument connected to Serial 2 parameters: The query given as a text string in "".

response: none

example:

affects: Rack OTDR only

syst:comm:ser:feed "init"

syst:comm:ser:feed? "*idn?" → HP E6000 MiniOptical Time Domain Reflectometer Mainframe 0123456789, Module: ABCDE54321 SW_Rev 6.0<END>

Page 65

Instrument Setup and Status

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE

syntax: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE<wsp>

<pace>

description: Sets the pace for the OTDR serial interface

NO T E 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.

NO T E All changes take effect immediately. After this command, you

must reconfigure your RS232 to continue communication.

parameters: Valid values are NONE, HARDware, XONXoff.

NO T E XONX is only available with the Mainframe OTDR.

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

response: none

example:

syst:comm:ser:pace hard

affects: All instruments

Page 66

Instrument Setup and Status

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PACE?

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

NO T E 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.

parameters: none

response: Possible values are NONE, HARDware, and XONXoff.

NO T E XONX is only available with the Mainframe OTDR.

example:

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

affects: All instruments

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity

[:TYPE]

syntax:

description:

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

NO T E All changes take effect immediately. After this command, you

parameters:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity[:TYPE]<wsp> <parity>

Sets the type of parity checking for the OTDR’s serial interface.

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

must reconfigure your RS232 to continue communication.

Valid values are NONE, ODD, EVEN.

response: none

example:

syst:comm:ser:par odd

affects: All instruments

Page 67

Instrument Setup and Status

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity

[:TYPE]?

syntax:

description:

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

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity[:TYPE]?

Returns the type of parity checking for the OTDR’s serial interface.

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

parameters: none

response:

example:

Possible values are NONE, ODD, EVEN.

syst:comm:ser:par? → ODD<END>

affects: All instruments

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity:

CHECk

syntax:

description:

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity:CHECk<wsp> <boolean> Determines whether parity checking is enabled for the OTDR’s serial interface.

NO T E 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.

parameters:

response:

example:

Possible values are 0 and 1

none

syst:comm:ser:par:chec 1

affects: All instruments

Page 68

Instrument Setup and Status

command: SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity

:CHECk?

syntax: description:

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

SYSTem:COMMunicate:SERial[1|2][:RECeive]:PARity:CHECk?

Queries whether parity checking is enabled for the OTDR’s serial interface.

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.

parameters: none

response:

example:

Possible values are 0: checking disabled

1: checking enabled

syst:comm:ser:par:chec? → 1<END>

affects: All instruments

command: SYSTem:COMMunicate:SERial:PORT?

syntax: SYSTem:COMMunicate:SERial:PORT? description: Inquires the type of second serial port that is configured (Rack

OTDR only).

parameters: none

response: RS232 or RS485

example:

syst:comm:ser:port? → RS485<END>

affects: Rack OTDR only

command: SYSTem:COMMunicate:SERial[:RECeive]:SBITS

syntax: description:

NO T E All changes take effect immediately. After this command, you

parameters:

response:

example:

SYSTem:COMMunicate:SERial[:RECeive]:SBITS<wsp><bits>

Sets the number of stop bits for the OTDR’s serial interface.

must reconfigure your RS232 to continue communication.

Valid numbers are ONE, ONEHalf, TWO

none

syst:comm:ser:sbit two

affects: Mainframe OTDR only

Page 69

Instrument Setup and Status

command: SYSTem:COMMunicate:SERial[:RECeive]:SBITS?

syntax:

description:

parameters:

response:

example:

SYSTem:COMMunicate:SERial[:RECeive]:SBITS?

Returns the number of stop bits for the OTDR’s serial interface.

none

Possible values are ONE, ONEHalf, TWO

syst:comm:ser:sbit? → TWO<END>

affects: Mainframe OTDR only

command: SYSTem:DATE

syntax: SYSTem:DATE<wsp><day>,<month>,<year>

description: Sets the OTDR’s internal date.

parameters: The date in the format day, month,year (short values)

response: none

example:

syst:date 20,7,1995

affects: All instruments

command: SYSTem:DATE?

syntax: SYSTem:DATE?

description: Returns the OTDR’s internal date.

parameters: none

response: The date in the format day, month,year (short values)

example:

syst:date? → +20,+7,+1995<END>

affects: All instruments

Page 70

Instrument Setup and Status

command: SYSTem:ERRor?

syntax: SYSTem:ERRor? description: Returns the contents of the OTDR’s error queue. Removes the

returned entry from the queue.

parameters: none

response: The number of the latest error, and its meaning.

example:

syst:err? → -113,"Undefined header"<END>

affects: All instruments

command:

syntax:

description:

parameters:

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.

response:

example:

A Binary block containing the help page.

syst:help? "syst" → #3316[help_page]<END>

affects: All instruments

Page 71

Instrument Setup and Status

command:

syntax:

description:

parameters:

SYSTem:KEY

SYSTem:KEY<wsp><code>

Simulates keystrokes on the OTDR’s frontpanel.

Valid key codes are as follows:

Mini-OTDR / Mini-FBL

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

response:

example:

none

syst:key? 1<END>

affects: All instruments

Rack OTDR

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

6: <f1>

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

Page 72

Instrument Setup and Status

command: SYSTem:KEY?

syntax: SYSTem:KEY? description: Returns either the last keystroke entered on the OTDR frontpanel

(not possible on Mainframe OTDR), or the last keystroke emulated

parameters:

response:

by the

none

Valid key codes are as follows:

Mini-OTDR / Mini-FBL

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

SYSTem:KEY remote command (all instruments).

Rack OTDR

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

6: <f1>

Mainframe OTDR

example:

syst:key? → 1<END>

affects: All instruments

Page 73

Instrument Setup and Status

command: SYSTem:PRESet

syntax: SYSTem:PRESet

description: Loads a predefined instrument setting that is also loaded on power

on.

parameters: none

response: none

example: syst:pres

affects: All instruments

command: SYSTem:SET

syntax: SYSTem:SET<wsp><setting>

description: Sets the specified instrument setting from a binary block.

parameters: binary block

response: none

example:

syst:set binblock

affects: Mini-OTDR, Rack OTDR, and Mainframe OTDR

command: SYSTem:SET?

syntax: SYSTem:SET?

description: Reads the complete instrument setting in a binary block. The binary

block can be directly stored as a setting file.

parameters: none

response: binary block

example:

syst:set? → binblock

affects: All instruments

Page 74

Instrument Setup and Status

command: SYSTem:TIME

syntax: SYSTem:TIME<wsp><hour>,<minute>,<second> description: Sets the OTDR’s internal time. parameters: The time in the format hour,minute,second. Hours are counted 0...23

(short values).

response: none

example: s

yst:time 20,15,30

affects: All instruments

command: SYSTem:TIME?

syntax: SYSTem:TIME? description: Returns the OTDR’s internal time. parameters: none

response: The time in the format hour,minute,second. Hours are counted 0...23

(short values).

example:

syst:time? → +20,+15,+30<END>

affects: All instruments

command: SYSTem:UPTime?

syntax: SYSTem:UPTime? description: Returns the time (in seconds) since you switched on your OTDR. parameters: none

response: The time in seconds (int32 value).

example:

syst:upt? → 240<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 75

Instrument Setup and Status

command: SYSTem:VERSion?

syntax: SYSTem:VERSion?

description: Returns the SCPI revision to which the OTDR complies.

parameters: none

response: The revision year and number.

example:

syst:vers? → 1995.0<END>

affects: All instruments

Page 76

Instrument Setup and Status

Page 77

4 Operations on Traces and

Measurements

Page 78

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 OTDR’s memory.

Other commands are described in Chapter 3 “Instrument Setup and Status”, and Chapter 5 “Mass Storage, Display, and Print Functions”.

Page 79

Operations on Traces and Measurements

4.1 Root Layer Commands

command: ABORt[1/2]

syntax: ABORt[1/2]

description: Stops a running measurement:

NO T E You cannot use a Visual Fault Finder with a Mainframe OTDR.

This means that abor2 is not available.

parameters: none

response: none

example:

abor

affects: All instruments

command: FETCh[:SCAlar]:POWer[:DC]?

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

description: Reads the current power meter value.

abor or abor1: on the OTDR abor2: on the Visual Fault Finder

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

parameters: none

response: The reference as a float value in dBm, W or dB.

NO T E If the reference state is absolute, units are dBm or W.

If the reference state is relative, units are dB.

example: fetc:pow? → +4DBM<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 80

Operations on Traces and Measurements

command: INITiate[1|2][:IMMediate][:ALL]

syntax:

INITiate[1|2][:IMMediate][:ALL]

description: Starts a measurement: init or init1: internal source

init2: power meter

NO T E You cannot use a Visual Fault Finder with a Mainframe OTDR.

This means that init2 is not available.

parameters: none

response: none

example:

init

affects: All instruments

command: INITiate2[:IMMediate]:CONTinuous

syntax:

description:

INITiate2[:IMMediate]:CONTinuous<wsp><boolean>

Starts a power meter measurement.

parameters: A boolean value: 0 – single measurement made

1 – continuous measurement made

response: none

example:

init2:cont 1

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: INITiate2[:IMMediate]:CONTinuous?

syntax:

description:

INITiate2[:IMMediate]:CONTinuous?

Queries whether power meter measurement is continuous

parameters: none

response: A boolean value: 0 – single measurement

1 – continuous measurement

example:

init2:cont? → 1<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 81

Operations on Traces and Measurements

command: KEYBoard

syntax: KEYBoard

description:

Allows the use of a terminal as an external keyboard

parameters: none

response: none

example:

NOTE keyb allows you to add text from a terminal (for example, when

keyb

specifying the name of a file to be saved). To use this facility, you should do the following:

1 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.

2 Enter

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

4 To finish entering text, enter

For example, after [File]<Save As..>

the OTDR screen. Instead of using this keyboard you can enter the following text from your terminal:

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

keyb from your terminal keyboard.

treated literally until you enter (see below).

keyboard.

keyb T1.SOR

<CTRL>Z (ASCII character 26)

<CTRL>Z from your terminal

New Name, you see a keyboard on

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 82

Operations on Traces and Measurements

command: READ[:SCAlar]:POWer[:DC]?

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

description: Reads the current power meter value.

NO T E The power meter must be running for this command to be

effective

parameters: none

response: The reference as a float value in dBm, W or dB.

NO T E If the reference state is absolute, units are dBm or W.

If the reference state is relative, units are dB.

example: read:pow? → +4DBM<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: TRAFficdet

syntax: TRAFficdet<wsp><onoff> description: Turn traffic detection on or off parameters: ON: turn traffic detection on

OFF: turn traffic detection off.

response: none

example:

traf on

affects: Mini-OTDR and Rack OTDR

command: TRAFficdet?

syntax: TRAFficdet? description: Queries whether traffic detection is on or off parameters: none

response: ON: traffic detection is on

OFF: traffic detection is off.

example:

traf? → ON<END>

affects: Mini-OTDR and Rack OTDR

Page 83

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: PROGram:EXPLicit:CHECk:LIMit

syntax: PROGram:EXPLicit:CHECk:LIMit<wsp><param><wsp><value>

description: Set the Pass/Fail test limits for the specified parameter.

parameters: Valid values are as follows.

Units

REFLective NONReflective ATTenuation CONNector loss LOSS LENGTh TOLerance NEW events SORT results The units specified above are implied, so you may only enter a positive integer within the specified limits.

Units

mdB mdB mdB/km mdB mdB mm mm 0=off, non-zero=on 0=severity, 1=distance

Limit

10000 .. 65000 0 .. 5000 0 .. 5000 0 .. 5000 0 .. 50000 0 .. 500000000 0 .. 50000000

0 or 1

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

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

response: none

example:

prog:expl:chec:lim refl 30000

affects: Mini-OTDR and Rack OTDR

Page 84

Operations on Traces and Measurements

command: PROGram:EXPLicit:CHECk:LIMit?

syntax: PROGram:EXPLicit:CHECk:LIMit?<wsp><param> description: Query the Pass/Fail test limits for the specified parameter. parameters: Valid units are: REFLective

NONReflective ATTenuation CONNector loss LOSS LENGTh TOLerance NEW events SORT results

response: The units and limits as the same as for

PROGram:EXPLicit:CHECk:LIMit on page 83.

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

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

example: prog:expl:chec:lim? refl→ -30000<END>

affects: Mini-OTDR and Rack OTDR

Page 85

Operations on Traces and Measurements

command: PROGram:EXPLicit:EXECute

syntax: PROGram:EXPLicit:EXECute<wsp><task>

description: Allows executing special tasks on the OTDR.

parameters: A string specifying the task.

Currently only On the Mini-OTDR and Rack OTDR, you can also enter

"scan" is valid on all instruments.

"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

NO T E Because this command does not accept character data, you must

put quotation marks around the parameter scan or check.

response: none

example:

prog:expl:exec "scan"

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: PROGram:EXPLicit:NUMBer

syntax: PROGram:EXPLicit:NUMBer<wsp><type>,<value>

description: Sets the threshold.

parameters:

REFLective, NONReflective, or END threshold value (int32) in mdB

On the Mini-FBL, only END is valid.

response: none

example:

prog:expl:numb refl, 60000

affects: All instruments

Page 86

Operations on Traces and Measurements

command: PROGram:EXPLicit:NUMBer?

syntax: PROGram:EXPLicit:NUMBer?<wsp><type> description: Requests the threshold value. parameters: REFLective, NONReflective, or END

On the Mini-FBL, only END is possible.

response: threshold value (int32) in mdB

example:

prog:expl:numb? refl → 60000<END>

affects: All instruments

command: PROGram:EXPLicit:STATe

syntax: PROGram:EXPLicit:STATe<wsp>"scan",<boolean> description: Allows terminating the currently running task parameters: A boolean value: 0 – terminate the task

1 – no action

response: none

example:

prog:expl:stat "scan",0

affects: Mini-OTDR, Rack OTDR, and Mainframe OTDR

command: PROGram:EXPLicit:STATe?

syntax: PROGram:EXPLicit:STATe?<wsp>"scan" description: Queries whether a task is still running. parameters: none

response: A boolean value: 0 – task is not running

1 – task is still running

example:

prog:expl:stat? "scan" → 1<END>

affects: All instruments

Page 87

Operations on Traces and Measurements

command: CALCulate:MATH:EXPRession:NAME?

syntax: CALCulate:MATH:EXPRession:NAME?<wsp><expr>

description: Allows calculating several loss and attenuation values. All

calculations use the stretch between markers A and B.

parameters: Valid values are: LOSS

LSAattenuation ATTenuation. ORL: Optical Return Loss

response: The loss is returned in dB. The attenuations are returned in mdB/km.

example:

calc:math:expr:name? att → 291MDB/KM<END>

affects: All instruments

command: CALCulate:MATH:EXPRession:REFLex?

syntax: CALCulate:MATH:EXPRessionREFLex?<wsp><pos1>,<pos2>,

<pos3>

description:

Calculate the Reflectance of an event

NO T E The active marker must be at the position of the Event.

parameters: 3 aux marker positions with length unit.

Valid length units are: MM, CM, M, KM, MI, FT, KFT.

response: reflectance or reflection height in dB

NO T E 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.

example:

calc:math:expr:refl? 9.5km,9800m,1001000cm →

-55.5000DB (Marker at 10km).

affects: All instruments

Page 88

Operations on Traces and Measurements

command: CALCulate:MATH:EXPRession:SPLice?

syntax: CALCulate:MATH:EXPRession:SPLice?<wsp><pos1>,<pos2>,

description:

NO T E The active marker must be at the position of the splice.

Calculate the splice loss of an event.

parameters: 4 aux marker positions with length unit.

Valid length units are: MM, CM, M, KM, MI, FT, KFT.

response: splice loss in mdB

example:

calc:math:expr:spl? 9.5km,9800m,10500m,10.8km →

100MDB (Marker at 10km)

affects: All instruments

command: CALCulate:MATH:EXPRession:TYPE

syntax: CALCulate:MATH:EXPRession:TYPE<wsp><type> description: Sets the reflection parameter used for the return value of

calc:math:expr:refl? and the event table (for example, trac:data:tabl).

parameters: Valid values are: REFLectance and HEIGht.

response: none

example:

calc:math:expr:type refl

affects: Mini-OTDR and Rack OTDR

command: CALCulate:MATH:EXPRession:TYPE?

syntax: CALCulate:MATH:EXPRession:TYPE? description: Queries the reflection parameter used for the return value of

calc:math:expr:refl? and the event table (for example, trac:data:tabl).

parameters: none

response: REFL or HEIG

example:

calc:math:expr:type → REFL<END>

affects: Mini-OTDR and Rack OTDR

Page 89

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 detector’s bandwidth, and fiber parameters.

command: SENSe:AVERage:COUNt

syntax: SENSe:AVERage:COUNt<wsp><value>

description: Sets the averaging time.

parameters: Averaging time in seconds (a short value).

A value of 0 means that the measurement runs until it is stopped by the user.

response: none

example:

affects: Mini-OTDR, Rack OTDR, and Mainframe OTDR

sens:aver:coun 180

command: SENSe:AVERage:COUNt?

syntax: SENSe:AVERage:COUNt?<wsp><boolean>

description: Queries the averaging time.

parameters:

A boolean value: 0 – returns averaging time

1 – returns time elapsed since start of measurement.

response: Averaging time in seconds (a short value).

NO T E 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).

example: sens:aver:coun? 0 → +180<END>

affects: All instruments

Page 90

Operations on Traces and Measurements

command: SENSe:AVERage:COUNt:NUMBer

syntax: SENSe:AVERage:COUNt:NUMBer<wsp><value> description: Sets the number of averages to measure. parameters: Number of averages as a power of 2 (a

For example, if you enter 14, 2

short value).

averages are taken. A value of 0 means that the measurement runs until it is stopped by the user.

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

response: none

example:

sens:aver:coun:numb 14

affects: Mini-OTDR and Rack OTDR

command: SENSe:AVERage:COUNt:NUMBer?

syntax: SENSe:AVERage:COUNt?<wsp><boolean> description: Queries the number of averages measured. parameters:

A boolean value: 0 – returns averaging time

1 – returns time elapsed since start of measurement.

response: Number of averages as a power of 2 (a short value).

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

NO T E 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.

example: sens:aver:coun? 0 → 14<END>

affects: Mini-OTDR and Rack OTDR

Page 91

Operations on Traces and Measurements

command: SENSe:DETector[:FUNCtion]

syntax: SENSe:DETector[:FUNCtion]<wsp><mode>

description: Sets the current measurement mode.

parameters:

Valid modes are: AVERage

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

response: none

example:

sens:det aver

affects: All instruments

command: SENSe:DETector[:FUNCtion]?

syntax: SENSe:DETector[:FUNCtion]?

description: Returns the current measurement mode.

parameters: none

response: Possible responses are:

AV E R a g e REAL time (not Mini-FBL) CONTinue (not Mini-FBL) CW RETLoss (Mainframe OTDR only) M2kHz (not Mainframe OTDR)

example: sens:det? → AVER<END>

affects: All instruments

Page 92

Operations on Traces and Measurements

command: SENSe:DETector[:FUNCtion:]AUTO

syntax: SENSe:DETector[:FUNCtion]:AUTO<wsp><boolean> description: Enables or disables the automatic measurement mode. parameters: A boolean value: 0 – disable auto mode

1 – enable auto mode

response: none

example: sens:det:auto 1

affects: Mini-OTDR, Rack OTDR, and Mainframe OTDR

command: SENSe:DETector[:FUNCtion:]AUTO?

syntax: SENSe:DETector[:FUNCtion]:AUTO? description: Queries whether the automatic measurement mode is enabled. parameters: none

response: A boolean value: 0 – auto mode disabled

1 – auto mode enabled

example:

sens:det:auto? → 1<END>

affects: All instruments

command: SENSe:DETector[:FUNCtion:]OPTimize

syntax: SENSe:DETector[:FUNCtion]:OPTimize<wsp><mode> description: Sets the optimization mode parameters: Valid modes are: NONE – standard optimization

RESolution – optimize for resolution DYNamic – optimize for dynamic LINearity - optimize for linearity (Mainframe OTDR only)

response: none

example: sens:det:opt res

affects: Mini-OTDR, Rack OTDR, and Mainframe OTDR

Page 93

Operations on Traces and Measurements

command: SENSe:DETector[:FUNCtion:]OPTimize?

syntax: SENSe:DETector[:FUNCtion]:OPTimize?

description: Returns the current optimization mode.

parameters: none

response: Possible modes are NONE – standard optimization

RESolution – optimize for resolution DYNamic – optimize for dynamic LINearity - optimize for linearity (Mainframe OTDR only)

example: sens:det:opt?

→ RES<END>

affects: All instruments

command: SENSe:DETector:MODE

syntax: SENSe:DETector:MODE<wsp><mode>

description: Selects the mode of the OTDR screen

parameters: Valid modes are: OTDR – OTDR mode

BREAK – Fiber Break Locator SOURce – Source mode

response: none

example:

sens:det:mode otdr

affects: Mini-OTDR and Rack OTDR

command: SENSe:DETEctor:MODE?

syntax: SENSe:DETector:MODE?

description: Returns the current mode of the OTDR

parameters: none

response: Possible modes are OTDR, BREAK, SOUR

example:

sens:det:mode → OTDR<END>

affects: Mini-OTDR, Mainframe OTDR, and Rack OTDR

Page 94

Operations on Traces and Measurements

command: SENSe:DETector:SAMPle:DISTance?

syntax: SENSe:DETector:SAMPle:DISTance? description: Queries the current sample distance. parameters: none

response: The sample distance in mm.

example:

sens:samp:dist? → +4600<END>

affects: All instruments

command: SENSe:FIBer:REFRindex

syntax: SENSe:FIBer:REFRindex<wsp><value> description: Sets the fiber’s refractive index. parameters: The refractive index (a float value).

response: none

example:

sens:fib:refr 1.458

affects: All instruments

command: SENSe:FIBer:REFRindex?

syntax: SENSe:FIBer:REFRindex? description: Returns the current refractive index. parameters: none

response: The refractive index (a float value).

example:

sens:fib:refr? → +1.4580000<END>

affects: All instruments

Page 95

Operations on Traces and Measurements

command: SENSe:FIBer:SCATtercoeff

syntax: SENSe:FIBer:SCATtercoeff<wsp><value>[dB|mdB]

description: Sets the fiber’s scatter coefficient.

parameters: The scatter coefficient in mdB (default) or dB (a float value).

response: none

example:

sens:fib:scat 51500mdb

affects: Mini-OTDR, Rack OTDR, and Mainframe OTDR

command: SENSe:FIBer:SCATtercoeff?

syntax: SENSe:FIBer:SCATtercoeff?

description: Returns the current scatter coefficient.

parameters: none

response: The scatter coefficient in dB (a float value).

example:

sens:fib:scat? → +51.500DB<END>

affects: All instruments

command: SENSe:FIBer:TYPE?

syntax: SENSe:FIBer:TYPE?

description: Queries the fiber type of the measurement module.

parameters: none

response:

Possible values are: MONomode

MULTimode

example: sens:fib:type? → MULT<END>

affects: All instruments

Page 96

Operations on Traces and Measurements

command: SENSe:POWer:FREQuency?

syntax: SENSe:POWer:FREQuency? description: Queries the detected power meter input frequency. parameters: none

response: Valid responses are: CW, LI, and the current frequency in Hz or KHz

example:

sens:pow:freq? → 270HZ<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: SENSe:POWer:REFerence

syntax: SENSe:POWer:REFerence<wsp><value>

[pW|nW|uW|mW|Watt|dBm] description: Sets the power meter reference value parameters: 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.

response: none

example:

sens:pow:ref 4dBm

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: SENSe:POWer:REFerence?

syntax: SENSe:POWer:REFerence? description: Queries the power meter reference value and units parameters: none

response: The reference as a float value in dBm, W or dB.

NO T E If the reference state is relative, units are dBm or W.

If the reference state is absolute, units are dB

example: sens:pow:ref? → +4DBM<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 97

Operations on Traces and Measurements

command: SENSe:POWer:REFerence:DISPlay

syntax: SENSe:POWer:REFerence:DISPlay

description: Takes the current power meter value as the reference value

parameters: none

response: none

example:

sens:pow:ref:disp

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: SENSe:POWer:REFerence:STATe

syntax: SENSe:POWer:REFerence:STATe<wsp><boolean>

description: Sets the power meter display to relative or absolute

parameters: A boolean value: 0 – relative

1 - absolute

response: none

example:

sens:pow:ref:stat 1

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: SENSe:POWer:REFerence:STATe?

syntax: SENSe:POWer:REFerence:STATe?

description: Inquires whether the current power meter display is relative or

absolute

parameters: none

response: A boolean value: 0 – relative

1 - absolute

example:

sens:pow:ref:stat? → 1<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 98

Operations on Traces and Measurements

command: SENSe:POWer:UNIT

syntax: SENSe:POWer:UNIT<wsp><boolean> description: Sets the power meter power unit parameters: A boolean value: 0 – dBm

1 - Watt

or DBM or W

response: none

example:

sens:pow:unit 1

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: SENSe:POWer:UNIT?

syntax: SENSe:POWer:UNIT? description: Inquires the current power meter power unit parameters: none

response: DBM or W

example:

sens:pow:unit? → W<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: SENSE:POWer:WAVelength

syntax:

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

description: Sets the current power meter wavelength. parameters: The wavelength as a float value in nm/um/mm/m.

response: none

example:

sens:pow:wav 1550E-3um

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 99

Operations on Traces and Measurements

command: SENSE:POWer:WAVelength?

syntax:

SENSE:POWer:WAVelength?

description: Inquires the current power meter wavelength.

parameters: none

response: The wavelength as a float value in nm.

example

sens:pow:wav? → +1550NM<END>

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

Page 100

Operations on Traces and Measurements

4.4 Signal Generation – The SOURce Subsystem

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

command: [SOURce:]AM[:INTernal]:FREQuency[1]

syntax: [SOURce:]AM[:INTernal]:FREQency[1]<wsp><freq> description: Sets the modulation frequency of the internal source parameters: Valid units are: CW, F270HZ, F1KHZ, F2KHZ, and CODE

response: none

example:

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

command: [SOURce:]AM[:INTernal]:FREQuency[1]?

syntax: [SOURce:]AM[:INTernal]:FREQency[1]? description: Queries the current modulation frequency of the internal source parameters: none

response: Valid units are: CW, F270HZ, F1KHZ, F2KHZ, and CODE

example:

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

am:freq f270hz

am:freq? → F270HZ<END>

command: [SOURce:]AM[:INTernal]:FREQuency2

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

response: none

example:

am:freq2 f1hz

affects: Mini-OTDR, Mini-FBL, and Rack OTDR

100