Agilent 8164A Programmers Guide

HP 8163A Lightwave Multimeter & HP 8164A Lightwave Measurement System

Programming Guide

Notices

This document contains proprietary information that is protected by copyright. All rights are reserved.

No part of this document may be photocopied, reproduced, or translated to another language without the prior written consent of Hewlett-Packard GmbH.

Subject Matter

The information in this document is subject to change without notice.

Hewlett-Packard makes no warranty of any kind with regard to this printed material, including, but not limited to, the implied warranties of merchantability and ﬁtness for a particular purpose.

Hewlett-Packard 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.

Printing History

New editions are complete revisions of the guide reﬂecting alterations in the functionality of the instrument. Updates are occasionally made to the guide between editions. The date on the title page changes when an updated guide is published. To ﬁnd out the current revision of the guide, or to purchase an updated guide, contact your Hewlett-Packard representative.

Control Serial Number: First Edition applies directly to all instruments.

Warranty

ThisHewlett-Packardinstrument product is warranted against defects in material and workmanship for a period of one year from date of shipment. During the warranty period, HP will, at its option,eitherrepairorreplace products that prove to be defective.

For warranty service or repair, this product must be returned to a service facility designated by HP. Buyer shall prepay shipping charges to HP and HP shall pay shipping charges to return the product to Buyer. However, Buyer shall pay all shipping charges, duties, and taxes for products returned to HP from another country.

HP warrants that its software and ﬁrmware designated by HP for use with an instrument will execute its programming instructions when properly installed on that instrument. HP does not warrant that the operation of the instrument, software, or ﬁrmwarewill be uninterrupted or error free.

Limitation of Warranty

The foregoing warranty shall not apply to defects resulting from improper or inadequate maintenance by Buyer, Buyer-supplied software or interfacing, unauthorized modiﬁcation or misuse, operation outside of the environmental speciﬁcations for the product, or improper site preparation or maintenance.

No other warranty is expressed or implied. Hewlett-Packard speciﬁcally disclaims the implied warranties of Merchantability and Fitness for a Particular Purpose.

Exclusive Remedies

The remedies provided herein are Buyer’s sole and exclusive remedies. Hewlett-Packard shall

not be liable for any direct, indirect, special, incidental, or consequential damages whether based on contract, tort, or any other legal theory.

Assistance

Productmaintenance agreements and other customer assistance agreements are available for Hewlett-Packard products. For any assistance contact your nearest Hewlett-Packard Sales and Service Ofﬁce.

Certiﬁcation

Hewlett-Packard Company certiﬁes that this product met its published speciﬁcations at the time of shipment from the factory.

Hewlett-Packard further certiﬁes that its calibration measurements are traceable to the United States National Institute of Standards and Technology, NIST (formerly the United States National Bureau of Standards, NBS) to the extent allowed by the Institutes’s calibration facility,and to the calibration facilities of other International Standards Organization members.

ISO 9001 Certiﬁcation

Produced to ISO 9001 international quality system standard as part of our objective of continually increasing customer satisfaction through improved process control.

08164-91016 E0599 First Edition:

E0599: May 1999 Firmware Revision:

1.0

Hewlett-Packard GmbH Herrenberger Str. 130 71034 Böblingen Germany

HP 8163A Lightwave Multimeter & HP 8164A Lightwave Measurement System

Programming Guide

Front Matter

In this Manual

This manual contains information about SCPI commands which can be used to program the following instruments:

• HP 8163A Lightwave Multimeter

• HP 8164A Lightwave Measurement System

The Structure of this Manual

This manual is divided into 5 parts:

• Chapter 1 gives a general introduction to SCPI programming

with the HP 8163A Lightwave Multimeter and the HP 8164A Lightwave Measurement System.

• Chapter 2 lists all instrument speciﬁc commands.

• Chapters 3 to 5 givefuller explanations of all instrument speciﬁc

commands.

• Chapter 6 gives some example programs showing how the SCPI

commands can be used with the HP 8163A Lightwave Multimeter and the HP 8164A LightwaveMeasurement System.

• The appendixes give information about the HP 816x

VXIplug&play Instrument Driver, compatibility issues, and error codes.

Front Matter

Conventions used in this Manual

• All commands and typed text is written in Courier font, for

example INIT[:IMM].

• SCPI commands are written in mixed case: text that you MUST

printis written in capitals; text which ishelpful but nor necessary is written in lower case.

So, the command INITiate[:IMMediate] can be entered either as init[:imm],orasinitiate[:immediate].It does not matter whether you enter text using capitals or lowercase 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] can be entered as init or initiate:imm.

• A SCPI command which can be eithera command or a query is

appended with the text /?. So, DISPlay:ENABle/? refers to both the command

DISPlay:ENABle and the query DISPlay:ENABle?.

Front Matter

Related Manuals

You can ﬁnd more information about the instruments covered by this manual in the following manuals:

• HP 8163A Lightwave Multimeter & HP 8164A Lightwave

MeasurementSystem User’s Guide (HP Product Number 08164-

91011).

NOTE Please note that User Guides no longer contain programming

information, and must now be used in conjunction with this manual.

If you are not familiar with the HP-IB, 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,

publishedby the Institute of Electrical and ElectronicEngineers.

In addition, the commands not from the IEEE 488.2 standard are deﬁned 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 Hewlett-Packard representative.

Table of Contents

In this Manual ..................................................................... 4

The Structure of this Manual .............................................. 4

Conventions used in this Manual ........................................ 5

Related Manuals ................................................................. 6

1 Introduction to Programming

1.1 HP-IB Interface .......................................................17

Setting the HP-IB Address ................................................. 18

Returning the Instrument to Local Control ......................... 19

1.2 Message Queues ......................................................20

How the Input Queue Works .............................................. 20

The Output Queue .............................................................. 21

The Error Queue ................................................................. 21

1.3 Programming and Syntax Diagram Conventions 21

Short Form and Long Form ................................................ 22

Command and Query Syntax ..............................................22

1.4 Common Commands ..............................................25

Common Command Summary ........................................... 25

Common Status Information .............................................. 26

1.5 The Status Model ....................................................27

Annotations .........................................................................31

Status Command Summary ................................................ 34

Other Commands ................................................................ 34

2 Specific Commands

Table of Contents

2.1 Specific Command Summary ............................... 37

3 Instrument Setup and Status

3.1 IEEE-Common Commands .................................. 47

3.2 Status Reporting – The STATus Subsystem ....... 56

3.3 Interface/Instrument Behaviour Settings – The SYS-

Tem Subsystem ............................................................. 65

4 Measurement Operations & Settings

4.1 Root Layer Command ........................................... 71

4.2 Measurement Functions – The SENSe Subsystem 74

4.3 Signal Generation – The SOURce Subsystem ..... 93

4.4 Triggering - The TRIGger Subsystem ................. 122

Extended Trigger Configuration .........................................129

5 Mass Storage, Display, and Print Functions

5.1 Display Operations – The DISPlay Subsystem ... 137

Table of Contents

6 Programming Examples

6.1 How to Use VISA Calls ...........................................141

1.2 How to Set up a Fixed Laser Source .....................144

1.3 How to Measure Power using FETCH and READ 147

1.4 How to Co-ordinate Two Modules ........................152

1.5 How Power Varies with Wavelength .....................157

1.6 How to Log Results .................................................162

A The HP 816x VXIplug&play Instrument

Driver

A.1 Installing the HP 816x Instrument Driver ...........169

A.2 Using Visual Programming Environments ..........173

Getting Started with HP VEE ............................................. 173

Getting Started with LabView ............................................ 176

Getting Started with LabWindows ..................................... 177

A.3 Features of the HP 816x Instrument Driver ........178

A.4 Directory Structure ................................................179

A.5 Opening an Instrument Session ............................180

A.6 Closing an Instrument Session ..............................181

A.7 VISA Data Types and Selected Constant Definitions 181

A.8 Error Handling .......................................................182

A.9 Introduction to Programming ...............................184

Table of Contents

Example Programs ..............................................................184

VISA-Specific Information .................................................184

Development Environments ................................................184

A.10 Online Information ............................................. 186

2 HP-IB Command Compatibility List

B.1 Compatibility Issues .............................................. 189

HP-IB Bus Compatibility ....................................................189

Status Model ........................................................................189

Preset Defaults .....................................................................189

Removed Command ............................................................189

Obsolete Commands ...........................................................190

Changed Parameter Syntax and Semantics .........................191

Changed Query Result Values ............................................192

Timing Behavior .................................................................193

Error Handling .....................................................................193

Command Order ..................................................................194

Instrument Status Settings ...................................................194

C Error Codes

C.1 HP-IB Error Strings ............................................. 197

List of Figures

Figure 1-1 Remote Control......................................................................................... 19

Figure 1-2 The Event Status Bit ................................................................................. 26

Figure 1-3 The Registers and Filters for a Node......................................................... 28

Figure 1-4 The Operational Status System................................................................. 29

Figure 1-5 The Questionable Status System............................................................... 29

Figure 1-5 The Questionable Status System............................................................... 30

Figure 4-1 Extended Trigger Configuration............................................................... 131

Figure 4-2 Setup for Extended Trigger Configuration Example................................ 133

Figure A-1 Non-Administrator Installation Pop-Up Box........................................... 169

Figure A-2 Message Screen........................................................................................ 170

Figure A-3 Customizing Your Setup.......................................................................... 171

Figure A-4 Program Folder Item Options................................................................... 172

Figure A-5 Device Configuration............................................................................... 174

Figure A-6 Advanced Device Configuration - Plug&play Driver.............................. 175

Figure A-7 FP Conversion Options Box..................................................................... 176

Figure A-8 Windows 95 and Windows NT VXIPNP Directory Structure................. 179

List of Figures

List of Tables

Table 1-1 HP-IB Capabilities...................................................................................... 18

Table 1-2 Units and allowed Mnemonics................................................................... 24

Table 1-3 Common Command Summary................................................................... 25

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

Table B-1 Incompatible HP-IB Bus Commands ........................................................ 189

Table B-2 Removed Commands................................................................................. 190

Table B-3 Obsolete Commands.................................................................................. 191

Table B-4 Commands with Different Parameters or Syntax...................................... 191

Table B-5 Queries with Different Result Values........................................................ 192

Table B-6 Timing Behavior Changes......................................................................... 193

Table B-7 Error Handling Changes ............................................................................ 194

Table B-8 Specific Errors ........................................................................................... 194

Table C-1 Overview for Supported Strings................................................................ 197

Table C-2 Overview for Unsupported Strings............................................................ 201

List of Tables

1 Introduction to

Programming

Introduction to Programming

This chapter gives general information on how to control your instrument remotely.

Descriptions for the actual commands for the instruments are given in the following chapters. The information in these chapters is speciﬁc to the HP 8163A Lightwave Multimeter & HP 8164A Lightwave Measurement System, and assumes that you are already familiar with programming the HP-IB.

Introduction to Programming

HP-IB Interface

1.1 HP-IB Interface

The interface used by your instrument is the HP-IB (HewlettPackard Interface Bus).

HP-IB is the interface used for communication between a controller and an external device, such as the tunable laser source.The HP-IB conforms to IEEE standard 488-1978, ANSI standard MC 1.1 and IEC recommendation 625-1.

If you are not familiar with the HP-IB, then refer to the following books:

• Hewlett-Packard Company. Tutorial Description of Hewlett-

Packard Interface Bus, 1987.

• The International Institute of Electrical and Electronics

Engineers. IEEE Standard 488.1-1987, IEEE Standard Digital Interface for Programmable Instrumentation. New York, NY, 1987

• The International Institute of Electrical and Electronics

Engineers. IEEE Standard 488.2-1987, IEEE Standard Codes,

Formats, Protocols and Common Commands For Use with ANSI/IEEE Std 488.1-1987. New York, NY, 1987

To obtain a copy of either of these last two documents, write to: The Institute of Electrical and Electronics Engineers, Inc.

345 East 47th Street New York, NY 10017 USA.

In addition, the commands not from the IEEE-488.2 standard, are deﬁned according to the Standard Commands for Programmable Instruments (SCPI).

For an introduction to SCPI, and SCPI programming techniques, please refer to the following documents:

• Hewlett-Packard Press (Addison-Wesley Publishing Company,

Inc.). A Beginners Guide to SCPI. Barry Eppler. 1991.

Introduction to Programming

HP-IB Interface

• The SCPI Consortium. Standard Commands for Programmable

Instruments. Published periodically by various publishers. To obtain a copy of this manual, contact your Hewlett-Packard representative.

The interface of the HP 8163A Lightwave Multimeter and of the HP 8164A Lightwave Measurement System to the HP-IB is deﬁned by the IEEE Standards 488.1 and 488.2.

Table 1-1 shows the interface functional subset that the instruments implement.

Mnemonic Function

SH1 Complete source handshake capability AH1 Complete acceptor handshake capability

T6 Basic talker; serial poll; unaddressed to talk if addressed

to listen

L4 Basic listener; unaddressed to listen if addressed to talk;

no listen only SR1 Complete service request capability RL1 Complete remote/local capability

PP0 No parallel poll capability DC1 Device clear capability DT0 No device trigger capability

C0 No controller capability (Controller capability to be

implemented)

Table 1-1 HP-IB Capabilities

Setting the HP-IB Address

There are two ways to set the HP-IB address:

Introduction to Programming

HP-IB Interface

• You can set the HP-IB address by using the command

“:SYSTem:COMMunicate:GPIB[:SELF]:ADDRess” on page 68.

• You can set the HP-IB address from the front panel. See your

instrument’s User’s Guide for more information.

The default HP-IB address is 20.

Returning the Instrument to Local Control

If the instrument is in remote control, a screen resembling Figure 1-1 will appear. Press [Local] if you wish to return the instrument to local control.

Figure 1-1 Remote Control

Introduction to Programming

Message Queues

1.2 Message Queues

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

How the Input Queue Works

The input queue is aFIFO queue (ﬁrst-in ﬁrst-out). Incoming bytes are stored in the input queue as follows:

1 Receiving a byte:

• Clears the output queue.

• Clears Bit 7 (MSB).

2 No modiﬁcation is made inside strings or binary blocks. Outside

strings and binary blocks, the following modiﬁcations are made:

• Lower-case characters are converted to upper-case.

• The characters 0016to 0916and 0B16to 1F16are converted to

spaces (2016).

• Two or more blanks are truncated to one.

3 An EOI (End Or Identify) sent with any character is put into the

input queue as the character followed by a line feed (LF,0A16). If EOI is sent with a LF, only one LF is put into the input queue.

4 The parser starts if the LF character is received or if the input

queue is full.

Clearing the Input Queue

Switching the power off, or sending a Device Interface Clear signal, causes commands that are in the input queue, but have not been executed to be lost.

Introduction to Programming

Programming and Syntax Diagram Conventions

The Output Queue

The output queue contains responses to query messages. The instrument transmits any data from the output queue when a controller addresses the instrument as a talker.

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 Message Available bit (MAV, bit 4) is set in the Status Byte register whenever there is data in the output queue.

The Error Queue

The error queue is 30 errors long. It is a FIFO queue (ﬁrst-in ﬁrstout). That is, the ﬁrst error read is the oldest error to have occurred. A new error is only put into the queue if it is not already in it.

If more than 29 errors are put into the queue, the message:

-350 <Queue Overflow>

is placed as the last message in the queue.

1.3 Programming and Syntax Diagram Conventions

A program message is a message containing commands or queries that you send to the instruments. The following are a few points about program messages:

• You can use either upper-case or lower-case characters.

• You can send several commands in a single message. Each

command must be separated from the next one by a semicolon (;).

Introduction to Programming

Programming and Syntax Diagram Conventions

• A command message is ended by a line feed character (LF) or

<CR><LF>.

• You can use any valid number/unit combination.

In other words, 1500NM,1.5UM and 1.5E-6M are all equivalent.

If you do not specify a unit, then the default unit is assumed. The default unit for the commands are given with command description in the next chapter.

Short Form and Long Form

The instrument accepts messages in short or long forms. For example, the message

:STATUS:OPERATION:ENABLE 768

is in long form. The short form of this message is

:STAT:OPER:ENAB 768

In this manual, the messages are written in a combination of upper and lower case. Upper case characters are used for the short form of the message.

For example, the above command would be written

:STATus:OPERation:ENABle

The ﬁrst colon can be left out for the ﬁrst command or query in your message. That is, the example given above could also be sent as

STAT:OPER:ENAB 768

Command and Query Syntax

All characters not between angled brackets must be sent exactly as shown.

Introduction to Programming

Programming and Syntax Diagram Conventions

The characters between angled brackets (<...>) indicate the kind of data that you should send, or that you get in a response. You do not type the angled brackets in the actual message.

Descriptions of these items follow the syntax description. The following types of data are most commonly used:

string is ascii data. A string is contained between double

quotes ("...") or single quotes (‘...’).

value is numeric data in integer (12), decimal (34.5) or

exponential format (67.8E-9).

wsp is a white space.

Other kinds of data are described as required. The characters between square brackets ([...]) show optional

information that you can include with the message. The bar (|) shows an either-or choice of data, for example, a|b

means either a or b, but not both simultaneously. Extra spaces are ignored, so spaces can be inserted to improve

readability.

Introduction to Programming

Programming and Syntax Diagram Conventions

Units

Where units are given with a command, usually only the base units are speciﬁed. The full sets of units are given in the table below.

Unit Default Allowed Mnemonics

meters M PM, NM, UM, MM, M decibel DB MDB, DB second S NS, US, MS, S

decibel/1mW DBM MDBM, DBM Hertz HZ HZ, KHZ, MHZ, GHZ, THZ Watt Watt PW, NW, UW, MW, Watt

meters per second

Table 1-2 Units and allowed Mnemonics

Data Types

With the commands you give parameters to the instrument and receive response values from the instrument. Unless explicitly speciﬁed these data are given in ASCII format. The following types of data are used:

M/S NM/S, UM/S, MM/S, M/S

• Boolean data may only have the values 0 or 1.

• Integer range is given for each individual command.

• Float variables may be given in decimal or exponential writing

(0.123 or 123E-3).

• A string is contained between double quotes ("...") or single

quotes (‘...’). When the instrument 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

“#<H><Len><Block>”, terminated by <END>; <H> represents the number of digits, <Len> represents the number of

Introduction to Programming

Common Commands

bytes, and <Block> is the data block. For example, for a Binary Block with 1 digit and 6 bytes this is: #16TRACES<END>.

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

Yourinstrument implements all the necessary commands, and some optional ones. This section describes the implemented commands.

Common Command Summary

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

Command Parameter Function Page

*CLS Clear Status Command 47 *ESE Standard Event Status Enable Command 48 *ESE? Standard Event Status Enable Query 48 *ESR? Standard Event Status Register Query 49 *IDN? Identiﬁcation Query 49 *OPC Operation Complete Command 50 *OPC? Operation Complete Query 50 *OPT? Options Query 51 *RST Reset Command 52 *STB? Read Status Byte Query 53 *TST? Self Test Query 54 *WAI Wait Command 55

Table 1-3 Common Command Summary

Introduction to Programming

Common Commands

NOTE These commands are described in more detail in “IEEE-Common

Commands” on page 47.

Common Status Information

There are three registers for the status information. Two of these are status-registers and one is an enable-registers. These registers conform to the IEEE Standard 488.2-1987. You can ﬁnd further descriptions of these registers under *ESE, *ESR?, and *STB?.

Figure 1-2 shows how the Standard Event Status Enable Mask (SESEM) and the Standard Event Status Register (SESR) determine the Event Status Bit (ESB) of the Status Byte.

*ESE sets the Standard Event Status Enable Mask

*STB? returns the Status Byte Register

OSB ESB QSB

Status

Byte

Figure 1-2 The Event Status Bit

001

All bits shown as are unused

Event

Status

Enable

Mask

01234567

Event Status

*ESR? returns the Standard Event Status Register

01234567

111111

01234567

100000

Introduction to Programming

The Status Model

The SESR contains the information about events that are not slot speciﬁc. For details of the function of each bit of the SESR, see “Standard Event Status Register” on page 32.

The SESEM allows you to choose the eventthat may affect the ESB of the Status Byte. If you set a bit of the SESEM to zero, the corresponding event cannot affect the ESB. The default is for all the bits of the SESEM to be set to 0.

The questionable and operation status systems set the Operational Status Bit (OSB) and the Questionable Status Bit (QSB). These status systems are described in “The Status Model” on page 27 “Status Reporting – The STATus Subsystem” on page 56.

NOTE Unused bits in any of the registers change to 0 when you read them.

1.5 The Status Model

Each node of the status circuitry has three registers:

• A condition register (CONDition), which contains the current

status. This register is updated continuously.It is not changed by having its contents read.

• The event register (EVENt), which contains details of any

positive transitions in the corresponding condition register, that is, when a bit changes from 0 → 1. The contents of this register are cleared when it is read. The contents of any higher-level registers are affected with regard to the appropriate bit.

• The enable register (ENABle), which enables changes in the

event register to affect the next stage of registers.

NOTE The event register is the only kind of register that can affect the next

stage of registers.

Introduction to Programming

The Status Model

The structures of the Operational and Questionable Status Systems are similar.Figure 1-5 and Figure 1-4 respectivelydescribe how the Questionable Status Bit (QSB) and the Operational Status Bit (OSB) of the Status Byte Register are determined.

Enable Registers

To the Condition Register of the Next Node

11111

Event Registers

A positive transition in the condition register, when a bit changes from 0 → 1, causes the corresponding bit of the corresponding event register to change from 0 → 1.

Condition Registers

Figure 1-3 The Registers and Filters for a Node

Introduction to Programming

The Status Model

STAT:OPER:ENAB sets

the Operational Status

Enable Summary Mask

OSB

76543210

ESB

QSB

100

*STB? returns the Status Byte Register

STAT3:OPER:ENAB sets the Operational Slot Status

Enable Mask for Slot 3

Operational

Slot Status Enable Mask

7654321015 14 13 12 11 10 9 8

Status

Byte

11 11

Operational Status Enable Summary Mask

7654321015 14 13 12 11 10 9 8

111

7654321015 14 13 12 11 10 9 8

10000

Operational Status Event

Summary Register

STAT:OPER? returns the

Operational Status

Event Summary Register

All bits shown as are unused

7654321015 14 13 12 11 10 9 8

STAT3:OPER? returns the Operational

Slot Status Event Register for Slot 3

Operational

10 00

Slot Status Event Register

Figure 1-4 The Operational Status System

Introduction to Programming

The Status Model

STAT:QUES:ENAB sets

the Questionable Status

Enable Summary Mask

OSB ESB QSB

76543210

010

*STB? returns the Status Byte Register

STAT3:QUES:ENAB sets

the Questionable Slot Status

Enable Mask for Slot 3

Questionable Slot Status Enable Mask

7654321015 14 13 12 11 10 9 8 1

Status

Byte

1111111

Questionable Status Enable Summary Mask

7654321015 14 13 12 11 10 9 8

111

7654321015 14 13 12 11 10 9 8

10000

Questionable Status Event

Summary Register

STAT:QUES? returns the

Questionable Status

Event Summary Register

All bits shown as are unused

7654321015 14 13 12 11 10 9 8 0

1000000

Questionable Slot Status Event Register

STAT3:QUES? returns the Questionable

Slot Status Event Register for Slot 3

Figure 1-5 The Questionable Status System

Introduction to Programming

The Status Model

The Operational/Questionable Slot Status Event Register (OSSER/ QSSER) contains the status of a particular module slot. A bit changes from 0 → 1 when an event occurs, for example, when a laser is switched on. For details of the function of each bit of these registers, see “Operation/Questionable Status Summary Register” on page 32 and “Operation/Questionable Status Summary Register” on page 32.

The Operational/Questionable Slot Enable Status Mask (OSESM/ QSESM) allows you to choose the events for each module slot that may affect the Operational/Questionable StatusEvent Register (see below). If you set a bit of the OSESM/QSESM to zero, the occurence of the corresponding event for this particular module slot cannot affect the Operational/Questionable Status Event Register. The default is for all the bits of the OSESM/QSESM to be set to 0.

The Operational/Questionable Status Event Summary Register (OSESR/QSESR) summarizes the status of every module slot of your instrument. If, for any slot, any bit of the QSSER goes from 0 → 1 AND the corresponding bit of the QSSEM is 1at the same time, the QSESR bit representing that slot is set to 1.

The Operational/Questionable Status Enable Summary Mask (OSESM/QSESM) allows you to choose the module slots that may affect the OSB/QSB of the Status Byte. If any bit of the QSESR goes from 0 → 1 AND the corresponding bit of the QSESM is 1at the same time, the QSB of the Status Byte is set to 1. If you set a bit of the OSESM/QSESM to zero, the corresponding module slot cannot affect the OSB/QSB. The default is for all the bits of the OSESM/QSESM to be set to 0.

Annotations

Status Byte Register

• Bit 3, the QSB, is built from the questionable event status

• Bit 5, the ESB, is built from the SESR and its SESEM.

• Bit 7, the OSB, is built from the operation event status register

and its enable mask.

• All other bits are unused, and therefore set to 0.

Introduction to Programming

The Status Model

Standard Event Status Register

• Bit0 is set if an operation completeeventhasbeen receivedsince

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 ﬁrst call of *ESR? after Power On.

Operation/Questionable Status Summary

• The Operation/Questionable Status Summary consist of a

condition and an event register.

• A "rising" bit in the condition register is copied to the event

• A "falling" bit in the condition register has no effect on the event

• 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/Questionable Status Summary Register

• Bits 0 to 4 are built from the OSSER/QSSER and the OSSEM/

QSSEM.

• A summary of the event register, the condition register and the

enable mask is set in the status byte.

Introduction to Programming

The Status Model

Operation/Questionable Slot Status

• The Operation/Questionable Slot Status consist of a condition

and an event register.

• A "rising" bit in the condition register is copied to the event

• A "falling" bit in the condition register has no effect on the event

• Reading the condition register is non-destructive.

• Reading the event register is destructive.

• A summary of the event register, the condition register and the

enable mask is set in the status byte.

Operation Slot Status Register

• Bit 0 is set if the laser is switched on.

• Bit 1 is set if the Coherence Control is switched on.

• Bit 3 is set if Power Meter zeroing is ongoing.

• All other bits are unused, and therefore set to 0.

Questionable Slot Status Register

• Bit 0 is set if excessive power is set by the user for any source

module or if excessive averaging time is set for any PowerMeter.

• Bit 1 is set if the last Power Meter zeroing failed.

• Bit 2 is set if temperature is out of range.

• Bit 3 is set if laser protection is switched on.

• Bit 4 is set if the module has not settled.

• Bit 5 is set if the module is out of speciﬁcations.

• Bit 6 is set if ARA is recommended.

• Bit 7 is set if the duty cycle is out of range.

• All other bits are unused, and therefore set to 0.

Introduction to Programming

The Status Model

Status Command Summary

*STB? returns status byte, value 0 .. +255 *ESE sets the standard event status enable mask, parameter 0 .. +255 *ESE? returns SESE, value 0 .. +255 *ESR? returns the standard event status register, value 0 .. +255 *OPC parses all program message units in the message queue. *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.

Other Commands

*OPT? returns the installed modules and the slots these modules are installed

in: For example, *OPT? → 81682A, 81533B, 81532A, , Modules 81682A, 81533B, and 81532A are installed in slots 0 to 2 respectively. Slots 3 and 4 are empty.

*WAI prevents the instrument from executing any further commands until the

current command has ﬁnished executing. All pending operations are completed during the wait period.

*IDN? identiﬁes the instrument; returns the manufacturer, instrument model

number, serial number, and ﬁrmware revision level.

2 Speciﬁc Commands

Speciﬁc Commands

This chapter lists all the instrument speciﬁc commands relating to the HP 8163ALightwaveMultimeter and the HP 8164A Lightwave Measurement System, 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.

Speciﬁc Commands

Speciﬁc Command Summary

2.1 Speciﬁc 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 speciﬁc topic. In a subsystem there may be further subnodes.

All the nodes have to be given with a command.For example in the command disp:brig

• DISPlay is the subsystem containing all commands for

controlling the display,

• BRIGhtness is the command selecting brightness.

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

Command Description Page

:DISPlay

:BRIGhtness/? Changes or queries the current display brightness. :CONTrast/? Changes or queries the current display contrast. :ENABle/? Switches the display on or off or queries whether

the display is on or off.

:FETCh[n][:CHANnel[n]][:SCALar]

Table 2-1 Speciﬁc Command Summary

137 137 138

Speciﬁc Commands

Speciﬁc Command Summary

Command Description Page

:POWer[:DC]? Returns the current power value from a sensor.

:INITiate[n]:[CHANnel[n]]

[:IMMediate] Starts a measurement. :CONTinuous/? Starts or Queries a single/continuous

measurement. Switches the lock on/off or returns the current

:LOCK/?

state of the lock.

:OUTPut[n][:CHANnel[n]]

:CONNection/? Selects or returns Analog Output parameter. :PATH/? Sets or returns the regulated path. [:STATe]/? Sets a source’s output terminals to open or closed

or returns the current status of a source’s output terminals.

:READ[n][:CHANnel[n]][:SCALar]

:POWer[:DC]? Returns a value from a sensor.

:SENSe[n][:CHANnel[n]]:CORRection

[:LOSS][:INPut][:MAGNitude]/? Sets or returns the value of correction data for a

sensor.

:COLLECT:ZERO Executes a zero calibration of a sensor module. :COLLECT:ZERO? Returns the current zero state of a sensor module.

:COLLECT:ZERO:ALL

Executes a zero calibration of all sensor modules.

:SENSe[n][:CHANnel[n]]:FUNCtion

:PARameter:LOGGing/? Sets or returns the number of samples and the

averaging time, t

:PARameter:MINMax/? Sets or returns the minmax mode and the window

size.

, for logging.

avg

74 75

93 94 95

77 77 78

Table 2-1 Speciﬁc Command Summary, continued

Speciﬁc Commands

Speciﬁc Command Summary

Command Description Page

:PARameter:STABility/? Sets or returns the total time, delay time and the

averaging time, t :RESult? Returns the data array of the last function. :STATe/? Enables/disables the function mode or returns

whether the function mode is enabled. :THReshold/? Sets or returns the threshold value and the start

mode.

, for stability.

avg

:SENSe[n][:CHANnel[n]]:POWer

:ATIME/? Sets or returns the average time of a sensor. :RANGe[:UPPer]/? Sets or returns the most positive signal entry

expected for a sensor. :RANGe:AUTO/? Sets or returns the range of a sensor to produce the

most dynamic range without overloading. :REFerence/? Sets or returns the reference level of a sensor.

UNIT/? Sets or returns the units used for absolute readings

on a sensor. :WAVelength/? Sets or returns the wavelength for a sensor.

:SENSe[n][:CHANnel[n]]:POWer:REFerence

:DISPlay Sets the reference level for a sensor from the input

power level. :STATe/? Sets or returns whether sensor results are in

relative or absolute units. :STATe:RATio/? Sets or returns whether sensor results are

displayed relative to a channel or to an absolute

reference.

:SLOT[n][:HEAD[n]]

:EMPTy? Returns whether the module slot is empty. :IDN? Returns information about the module.

83 83

85 86

88 91

72 72

Table 2-1 Speciﬁc Command Summary, continued

Speciﬁc Commands

Speciﬁc Command Summary

Command Description Page

:OPTions? Returns the module’s options. :TST? The module performs a selftest and returns the

results.

[:SOURce[n]][:CHANnel[n]]

:MODout/? Returns the mode of the modulation output.

[:SOURce[n]][:CHANnel[n]:]AM

[:INTernal]:FREQuency/? Sets or returns the frequency of an internal signal

source.

:SOURce/? Sets or returnsa source for the modulating system. :STATe/? Turns Amplitude Modulation of a source onor off

or returns whether Amplitude Modulation is onor off.

[:SOURce[n]][:CHANnel[n]:]POWer

[:LEVel][:IMMediate][:AMPLitude]/? Sets or returns the laser output power of a source. [:LEVel]:RISetime/? Sets or returns the laser rise time of a source. :ATTenuation/? Sets or returns the attenuation level for a source. :STATe/? Sets or returns the state of the source output

signal.

:UNIT/? Sets or returns the power units. :WAVelength/? Sets or returns the wavelength source of a dual-

wavelength source.

[:SOURce[n]][:CHANnel[n]:]POWer:ATTenuation

:AUTO/? Selects Automatic or Manual Attenuation Mode

for a source or returns the selected mode.

:DARK/? Enables/disables ‘dark’ position on a source or

returns whether ‘dark’ position is active for a source.

72 73

100

97 99

105 107 101 108

108 110

102

103

Table 2-1 Speciﬁc Command Summary, continued

Speciﬁc Commands

Speciﬁc Command Summary

Command Description Page

[:SOURce[n]][:CHANnel[n]:]WAVelength

[:CW|:FIXed]/? Sets or returns the absolute wavelength of a

source. :FREQuency/? Sets the frequency difference used to calculate a

relative wavelength for a source. :REFerence? Returns the reference wavelength of a source.

[:SOURce[n]][:CHANnel[n]:]WAVelength:CORRection

:ARA Realigns the laser cavity. :ZERO Exexutes a wavelength zero.

[:SOURce[n]][:CHANnel[n]:]WAVelength:REFerence

:DISPlay Sets the reference wavelength of a source to the

value of the output wavelength.

[:SOURce[n]][:CHANnel[n]:]WAVelength:SWEep

:CYCLes/? Sets or returns the number of cycles. :DWELl/? Sets or returns the dwell time. :MODE/? Sets or returns the sweep mode. :PMAX? Returns the highest permissible power for a

wavelength sweep. :REPeat/? Sets or returns the repeat mode.

:SPEed/? Sets or returns the speed for continuous sweeping. :STARt/? Sets or returns the start point of the sweep. :STOP/? Sets or returns the end point of the sweep. [:STATe]/? Stops, starts, pauses or continues a wavelength

sweep or returns the the state of a sweep.

[:SOURce[n]][:CHANnel[n]:]WAVelength:SWEep:STEP

:NEXT Performs the next sweep step.

110

112

113

111 111

113

113 114 115 116

117 117 118 119 119

120

Table 2-1 Speciﬁc Command Summary, continued

Speciﬁc Commands

Speciﬁc Command Summary

Command Description Page

:PREVious Performs the previous sweep step again. [:WIDTh]/? Sets or returns the width of the sweep step.

:SPECial

:REBoot Reboots the mainframe and all modules.

:STATus[n]

:PRESet Presets all Enable Registers.

:STATus:OPERation

[:EVENt]? Returns the Operational Status Event Summary

:CONDition? Returns the Operational Status Condition

Summary Register.

:ENABle/? Sets or queries the Operational Status Enable

Summary Mask.

:STATusn:OPERation

[:EVENt]? Returns the Operational Slot Status Event Register

for slot n.

:CONDition? Returns the Operational Slot Status Condition

:ENABle/? Sets or queries the Operation Slot Status Enable

Mask for slot n.

:STATus:QUEStionable

[:EVENt]? Returns the Questionable Status Event Summary

:CONDition? Returns the Questionable Status Condition

Summary Register.

:ENABle/? Sets or queries the Questionable Status Enable

Summary Mask.

:STATusn:QUEStionable

120 121

Table 2-1 Speciﬁc Command Summary, continued

Speciﬁc Commands

Speciﬁc Command Summary

Command Description Page

[:EVENt]? Returns the Questionable Slot Status Event

Sets or queries the Questionable Slot Status

Enable Mask for slot n

:SYSTem

:DATE/? Sets or returns the instrument’s internal date. :ERRor? Returns the contents of the instrument’s error

queue. :HELP:HEADers? Returns a list of HP-IB commands.

:PRESet Sets all parameters to their default values. :TIME/? Sets or returns the instrument’s internal time. :VERSion? Returns the instrument’s SCPI version.

:SYSTem:COMMunicate:GPIB

[:SELF]:ADDress/? Sets or returns the HP-IB address.

Generates a hardware trigger.

:TRIGger

:CONFiguration/? Sets or returns trigger conﬁguration.

65 66

66 67 67 68

122, 129

127

:TRIGger:CONFiguration

:EXTended/? Sets or returns extended trigger conﬁguration.

:TRIGger[n][CHANnel[n]]

:INPut/? Sets or returns the incoming trigger response . :OUTPut/? Sets or returns the outgoing trigger response.

Table 2-1 Speciﬁc Command Summary, continued

129

123 125

Speciﬁc Commands

Speciﬁc Command Summary

3 Instrument Setup and

Status

Instrument Setup and Status

This chapter gives descriptions of commands that you can use when setting up your instrument. The commands are split into the following separate subsytems:

• IEEE speciﬁc commands that were introduced in “Common

Commands” on page 25.

• STATus subsystem commands that relate to the status model.

• SYSTem subsystem commands that control the serial interface

and internal data.

Instrument Setup and Status

IEEE-Common Commands

3.1 IEEE-Common Commands

“Common Commands” on page 25 gave a brief introduction to the IEEE-common commands which can be used with the instruments. This section gives fuller descriptions of each of these commands.

command:

syntax: *CLS

description: The CLear Status command *CLS clears the following:

parameters: none

response: none

example: *CLS

*CLS

• Error queue

• Standard event status register (SESR)

• Status byte register (STB)

After the *CLS command the instrument is left waiting for the next command. The instrument setting is unaltered by the command, although *OPC/*OPC? actions are cancelled.

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *ESE<wsp><value>

description: The standard Event Status Enable command (*ESE) sets bits in the Stand-

parameters: The bit value for the register (a 16-bit signed integer value):

response: none

example: *ESE 21

*ESE

0 ≤ value ≤ 255

ard Event Status Enable Mask (SESEM) that enable the corresponding bits in the standard event status register (SESR). The register is cleared:

• at power-on,

• by sending a value of zero.

The register is not changed by the *RST and *CLS commands.

Bit Mnemonic

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

Decimal Value

command:

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 16-bit signed integer value).

example: *ESE? → 21<END>

*ESE?

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

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *ESR?

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

parameters none

response The bit value for the register (a 16-bit signed integer value):

example: *ESR? → 21<END>

command:

syntax: *IDN?

description: The IDeNtiﬁcation query *IDN? gets the instrument identiﬁcation over the

parameters: none

response: The identiﬁcation terminated by <END>:

example: *IDN? →

*ESR?

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

Bit Mnemonic

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

Decimal Value

*IDN?

interface.

For example.

HEWLETT-PACKARD

mmmm ssssssss rrrrrrrrrr

HEWLETT-PACKARD,

manufacturer instrument model number (for example 8164A) serial number ﬁrmware revision level

mmmm,ssssssss,rrrrrrrrrr

<END>

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *OPC

description: The instrument parses and executes all program message units in the input

parameters: none

response: none

example: *OPC

command:

syntax: *OPC?

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

parameters: none

response: 1<END> is always returned.

example: *OPC? → 1<END>

*OPC

queue and sets the operation complete bit in the standard event status register (SESR). Thiscommand can be used to avoid ﬁlling the input queue before the previous commands have ﬁnished executing.

The following actions cancel the *OPC command (and put the instrument into Operation Complete, Command Idle State):

• Power-on

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

• *CLS

• *RST

*OPC?

the input queue, sets the operation complete bit in the Standard Event Status register, and places an ASCII ’1’ in the output queue, when the contents of the input queue have been processed.

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

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *OPT?

description: The OPTions query *OPT? returns the modules installed in your

parameters: none

response: Returns the part number of all installed modules, separated by commas.

example: *OPT? → 81682A , , 81533B, 81532A, <END>

*OPT?

instrument.

Slots are listed starting with slot 0, if a large tunable laser source module is installed in slot 0. Slots are listed starting with slot 1, if slot 0 is empty or not recognised. If any slot other than slot 0 is empty or not recognised, two spaces are inserted instead of the module’s part number. See the example below, where slots 1 and 4 are empty.

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *RST

description: The ReSeT command *RST sets the mainframe and all modules to the reset

parameters: none

response: none

example: *RST

*RST

setting (standard setting) stored internally. Pending *OPC? actions are cancelled. The instrument is placed in the idle state awaiting a command. The *RST command clears the error queue. The *RST command is equivalent to the *CLS command AND the syst:preset command. The following are not changed:

• HP-IB (interface) state

• Instrument interface address

• Output queue

• Service request enable register (SRE)

• Standard Event Status Enable Mask (SESEM)

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *STB?

description: The STatus Byte query *STB? returns the contents of the Status Byte

parameters: none

response: The bit value for the register (a 16-bit signed integer value):

example: *STB? → 128<END>

*STB?

Bit Mnemonic Decimal Value

7 (MSB) Operation Status 128 6 Not used 0 5 Event Status Bit 32 4 Not used 0 3 Questionable Status 8 2 Not used 0 1 Not used 0 0 Not used 0

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *TST?

description: The self-TeST query *TST? makes the instrument perform a self-test and

parameters: none

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

example: *TST? → 0<END>

*TST?

place the results of the test in the output queue. If the self-test fails, the results are also put in the error queue. We recommend that you read self-test results from the error 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. The self-test does not require operator interaction beyond sending the *TST? query.

value, where 0 ≤ value ≤ 4294967296):

Bit

31 5-30 4 3 2 1 0

If 16 is returned, the module in slot 4 has failed. If 18 is returned, the modules in slots 1 and 4 have failed. A value of zero indicates no errors.

Mnemonic

Self-test on mainframe Not used Self-test on slot 4 Self-test on slot 3 Self-test on slot 2 Self-test on slot 1 Self-test on slot 0

Decimal Value

2147483648 0 16 8 4 2 1

Instrument Setup and Status

IEEE-Common Commands

command:

syntax: *WAI

description: The WAIt command prevents the instrument from executing any further

parameters: none

response: none

example: *WAI

*WAI

commands until the current command has ﬁnished executing. All pending operations are completed during the wait period.

Instrument Setup and Status

Status Reporting – The STATus Subsystem

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 “The Status Model” on page 27.

command:

syntax: :STATus:OPERation[:EVENt]? description: Returns the Operational Status Event Summary Register (OSESR). parameters: none

response: The sum of the results for the slots (a 16-bit signed integer value, where 0

example:

:STATus:OPERation[:EVENt]?

≤ value ≤ 32767):

Bit

5-15 4 3 2 1 0

Every nth bit is the summary of slot n.

stat:oper? → +0<END>

Mnemonic

Not used Summary of slot 4 Summary of slot 3 Summary of slot 2 Summary of slot 1 Summary of slot 0

Decimal Value

0 16 8 4 2 1

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command:

syntax: :STATusn:OPERation[:EVENt]?

description: Returns the Operational Slot Status Event Register (OSSER) of slot n.

parameters: none

response: The results for the individual slot events (a 16-bit signed integer value, where 0

example:

:STATusn:OPERation[:EVENt]?

≤ value ≤ 32767):

Bit

4-15 3 2 1 0

stat1:oper? → +0<END>

Mnemonic

Not used Slot n: Zeroing started Not used Slot n: Coherence Control has been switched on Slot n: Laser has been switched on

Decimal Value

0 8 0 2 1

command: :STATus:OPERation:CONDition?

syntax: description: parameters:

response: The sum of the results for the individual slots (a 16-bit signed integer value,

example:

:STATus:OPERation:CONDition? Reads the Operational Status Condition Summary Register. none

where 0 ≤ value ≤ 32767):

Bit

5-15 4 3 2 1 0

Every nth bit is the summary of slot n.

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

Mnemonic

Not used Summary of slot 4 Summary of slot 3 Summary of slot 2 Summary of slot 1 Summary of slot 0

Decimal Value

0 16 8 4 2 1

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command:

syntax: :STATusn:OPERation:CONDition?

description: Returns the Operational Slot Status Condition Register of slot n. parameters: none

response: The results for the individual slot events (a 16-bit signed integer value,

example:

:STATusn:OPERation:CONDition?

where 0 ≤ value ≤ 32767):

Bit

4-15 3 2 1 0

stat1:oper:cond? → +0<END>

Mnemonic

Not used Slot n: Zeroing ongoing Not used Slot n: Coherence Control is switched on Slot n: Laser is switched on

Decimal Value

0 8 0 2 1

command: :STATus:OPERation:ENABle

syntax: description:

parameters:

response:

example:

:STATus:OPERation:ENABle<wsp><value> Sets the bits in the Operational Status Enable Summary Mask (OSESM)

that enable the contents of the OSESR to affect the Status Byte (STB). Setting a bit in this register to 1 enables the corresponding bit in the OSESR to affect bit 7 of the Status Byte.

The bit value for the OSESM as a 16-bit signed integer value (0 .. +32767) none

stat:oper:enab 128

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command: :STATus:OPERation:ENABle?

syntax:

description:

parameters:

response:

example:

:STATus:OPERation[:ENABle]? Returns the OSESM for the OSESR none The bit value for the operation enable mask as a 16-bit signed integer

value (0 .. +32767)

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

command: :STATusn:OPERation:ENABle

syntax:

description:

parameters:

response:

example:

:STATusn:OPERation:ENABle<wsp><value> Sets the bits in the Operation Slot Status Enable Mask (OSSEM) for slot n

that enable the contents of the Operation Slot Status Event Register (OSSER) for slot n to affect the OSESR. Setting a bit in this register to 1 enables the corresponding bit in the OSSER for slot n to affect bit n of the OSESR.

The bit value for the OSSEM as a 16-bit signed integer value (0 .. +32767) none

stat:oper:enab 128

command: :STATusn:OPERation:ENABle?

syntax:

description:

parameters:

response:

example:

:STATusn:OPERation[:ENABle]? Returns the OSSEM of slot n none The bit value for the OSSEM as a 16-bit signed integer value (0 .. +32767)

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

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command: :STATus:PRESet

syntax: description:

parameters:

response:

example:

:STATus:PRESet Presets all bits in all the enable masks for both the OPERation and QUES-

tionable status systems to 0, that is, OSSEM, QSSEM, OSESM, and QSESM.

none none

stat:pres

command: :STATus:QUEStionable[:EVENt]?

syntax: description: parameters:

response:

example:

:STATus:QUEStionable[:EVENt]? Returns the Questionable Status Event Summary Register (QSESR). none The sum of the results for the QSESR as a 16-bit signed integer value

(0 .. +32767)

Bit

Mnemonic

5-15

Not used

Summary of slot 4

Summary of slot 3

Summary of slot 2

Summary of slot 1

Summary of slot 0

stat:ques? → +0<END>

Decimal Value

0 16 8 4 2 1

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command:

syntax: :STATusn:QUEStionable[:EVENt]?

description: Returns the questionable status of slot n - the Questionable Slot Status Event

parameters: none

response: The results for the individual slot events (a 16-bit signed integer value, where

example:

:STATusn:QUEStionable[:EVENt]?

0 ≤ value ≤ 32767):

Bit

8-15 7 6 5 4 3 2 1 0

Every nth bit is the summary of slot n.

stat1:oper? → +0<END>

Mnemonic

Not used Slot n: Duty cycle has been out of range Slot n: ARA has been recommended Slot n: Module has been out of speciﬁcation Slot n: Module has settled unsuccessfully Slot n: Laser protection has been on Slot n: Temperature has been out of range Slot n: A Zeroing operation has failed Slot n: Excessive Value has occurred

Decimal Value

0 128 64 32 16 8 4 2 1

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command: :STATus:QUEStionable:CONDition?

syntax: description: parameters:

response:

example:

:STATus:QUEStionable:CONDition? Returns the Questionable Status Condition Summary Register. none The sum of the results for the Questionable Status Condition Summary

Bit

Mnemonic

5-15

Not used

Summary of slot 4

Summary of slot 3

Summary of slot 2

Summary of slot 1

Summary of slot 0

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

Decimal Value

0 16 8 4 2 1

command:

syntax: :STATusn:QUEStionable:CONDition?

description: Returns the Questionable Slot Status Condition Register for slot n.

parameters: none

response: The results for the individual slot events (a 16-bit signed integer value, where

example:

:STATusn:QUEStionable:CONDition?

0 ≤ value ≤ 32767):

Bit

8-15 7 6 5 4 3 2 1 0

Every nth bit is the summary of slot n.

stat1:ques:cond? → +0<END>

Mnemonic

Not used Slot n: Duty cycle is out of range Slot n: ARA recommended Slot n: Module is out of speciﬁcation Slot n: Module has not settled Slot n: Laser protection on Slot n: Temperature out of range Slot n: Zeroing failed Slot n: Excessive Value

Decimal Value

0 128 64 32 16 8 4 2 1

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command: :STATus:QUEStionable:ENABle

syntax:

description:

parameters:

response:

example:

:STATus:QUEStionable:ENABle<wsp><value> Sets the bits in the Questionable Status Enable Summary Mask (QSESM)

that enable the contents of the QSESR to affect the Status Byte (STB). Setting a bit in this register to 1 enables the corresponding bit in the QSESR to affect bit 3 of the Status Byte.

The bit value for the questionable enable mask as a 16-bit signed integer value (0 .. +32767)

none

stat:ques:enab 128

command: :STATus:QUEStionable:ENABle?

syntax:

description:

parameters:

response:

example:

:STATus:QUEStionable[:ENABle]? Returns the QSESM for the event register none The bit value for the QSEM as a 16-bit signed integer value (0 .. +32767)

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

command: :STATusn:QUEStionable:ENABle

syntax:

description:

parameters:

response:

example:

:STATusn:QUEStionable:ENABle<wsp><value> Sets the bits in the Questionable Slot Status Enable Mask (QSSEM) for slot

n that enable the contents of the Questionable Slot Status Register (QSSR) for slot n to affect the QSESR. Setting a bit in this register to 1 enables the corresponding bit in the QSSER for slot n to affect bit n of the QSESR.

The bit value for the QSSEM as a 16-bit signed integer value (0 .. +32767) none

stat:ques:enab 128

Instrument Setup and Status

Status Reporting – The STATus Subsystem

command: :STATusn:QUEStionable:ENABle?

syntax: description: parameters:

response:

example:

:STATusn:QUEStionable[:ENABle]? Returns the QSSEM for slot n none The bit value for the QSSEM as a 16-bit signed integer value (0 .. +32767)

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

Instrument Setup and Status

Interface/Instrument Behaviour Settings – The SYSTem Subsystem

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, and so on)

command: :SYSTem:DATE

syntax:

description:

parameters:

response:

example:

:SYSTem:DATE<wsp><year>,<month>,<day> Sets the instrument’s internal date.

• the ﬁrst value is the year (four digits),

• the second value is the month, and

• the third value is the day.

none

syst:date 1999, 1, 12

command: :SYSTem:DATE?

syntax:

description:

parameters:

response:

example:

:SYSTem:DATE? Returns the instrument’s internal date. none The date in the format year, month, day (16-bit signed integer values)

syst:date? → +1999,+1,+12<END>

Instrument Setup and Status

Interface/Instrument Behaviour Settings – The SYSTem Subsystem

command: :SYSTem:ERRor?

syntax:

description:

parameters:

response:

example:

:SYSTem:ERRor? Returns the next error from the error queue (see “The Error Queue” on

page 21). Each error has the error code and a short description of the error, separated by a comma, for example 0, "No error". Error codes are numbers in the range -32768 and +32767. Negative error numbers are deﬁned by the SCPI standard. Positive error numbers are device dependent.

none The number of the latest error, and its meaning.

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

command: :SYSTem:HELP:HEADers?

syntax: description: parameters:

response:

:SYSTem:HELP:HEADers? Returns a list of HP-IB commands. none Returns a list of HP-IB commands

example: syst:help:head? → Returns a list of all HP-IB commands

Instrument Setup and Status

Interface/Instrument Behaviour Settings – The SYSTem Subsystem

command: :SYSTem:PRESet

syntax:

description:

parameters:

response:

example:

:SYSTem:PRESet Sets the mainframe and all installed modules to their standard settings. This

command has the same function as the Preset hardkey. The following are not affected by this command:

• the HP-IB (interface) state,

• the backlight and contrast of the display,

• the interface address,

• the output and error queues,

• the Service Request Enable register (SRE),

• the Status Byte (STB),

• the Standard Event Status Enable Mask (SESEM), and

• the Standard Event Status Register (SESR).

none none

SYST:PRES

command: :SYSTem:TIME

syntax:

description:

parameters:

response:

example:

:SYSTem:TIME<wsp><hour>,<minute>,<second> Sets the instrument’s internal time.

• the ﬁrst value is the hour (0 .. 23),

• the second value is the minute, and

• the third value is the seconds.

none syst:time 20,15,30

Instrument Setup and Status

Interface/Instrument Behaviour Settings – The SYSTem Subsystem

command: :SYSTem:TIME?

syntax: description: parameters:

response:

example:

:SYSTem:TIME? Returns the instrument’s internal time. none The time in the format hour, minute, second. Hours are counted 0...23 (16-

bit signed integer values).

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

command: :SYSTem:VERSion?

syntax: description: parameters:

response:

example:

:SYSTem:VERSion? Returns the SCPI revision to which the instrument complies. none The revision year and number.

syst:vers? → 1995.0<END>

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

syntax:

description: parameters:

response:

example:

:SYSTem:COMMunicate:GPIB[:SELF]:ADDRess<wsp> <HP-IB Address>

Sets the HP-IB address. The HP-IB Address none

SYST:COMM:GPIB:ADDR 20

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

syntax: description: parameters:

response:

:SYSTem:COMMunicate:GPIB[:SELF]:ADDRess? Returns the HP-IB address. none The HP-IB Address

example: SYST:COMM:GPIB:ADDR? → +20<END>

4 MeasurementOperations&

Settings

Measurement Operations & Settings

This chapter gives descriptions of commands that you can use when you are setting up or performing measurements. The commands are split up into the following subsystems:

• Rootlayer commands that take power measurements,conﬁgures

triggering, and return information about the mainframe and it’s slots

• SENSe subsystem commands that control Power Sensors and

Optical Head Interface Modules.

• SOURce subsystem commands that control Laser Source

modules and Tunable Laser modules.

• TRIGger subsystem commands that control triggering.

Introduction to Programming

Root Layer Command

4.1 Root Layer Command

command:

syntax:

description:

parameters:

response:

example:

command:

syntax:

description:

parameters:

response:

example:

:LOCK

:LOCK<wsp><boolean>, <value> Switches the lock off and on.

High power lasers cannot be switched on, if you switch the lock on. High power lasers are switched off immediately when you switch the lock on.

A boolean value: 0 or OFF: switch lock off

1 or ON: switch lock on <value> is the four-ﬁgure lock password. none

lock 1,1234 -1234 is the default password

:LOCK?

:LOCK? Returns the current state of the lock. none A boolean value: 0: lock is switched off

1: lock is switched on

lock? → 1<END>

The commands in the Slot subsystem allow you to query the following:

• a particular slot, for example, using slot1:empt?,

• an Optical Head attached to an Optical Head Interface Module,

for example, using slot1:head:empt?,

• or, an Optical Head attached to a Dual Optical Head Interface

Module, for example, using slot1:head2:empt?.

Introduction to Programming

Root Layer Command

command:

syntax: description: parameters:

response:

examples: slot1:empt? → 0<END>

command:

syntax: description: parameters:

response:

:SLOT[n][:HEAD[n]]:EMPTy?

:SLOT[n][:HEAD[n]]:EMPTy? Returns whether the module slot is empty. none A boolean value: 0: there is a module in the slot

1: the module slot is empty There is a module in slot1

:SLOT[n][:HEAD[n]]:IDN?

:SLOT[n][:HEAD[n]]:IDN? Returns information about the module. none HEWLETT-PACKARD:

mmmm: ssssssss: rrrrrrrrrr:

manufacturer instrument model number (for example 81533B) serial number date of ﬁrmware revision

example: slot1:idn? →

HEWLETT-PACKARD, 81533B,3411G06054,07-Aug-98<END>

command:

syntax: description: parameters:

response:

:SLOT[n][:HEAD[n]]:OPTions?

:SLOT[n][:HEAD[n]]:OPTions? Returns information about a module’s options. none A string.

example: slot1:opt? → NO CONNECTOR OPTION, NO INSTRUMENT

OPTIONS<END>

Introduction to Programming

Root Layer Command

command:

syntax:

description:

NOTE This command does not perform a selftest. Use selfTeST

parameters:

response:

:SLOT[n][:HEAD[n]]:TST?

:SLOT[n][:HEAD[n]]:TST? The module returns the latest selftest results.

command, *TST? on page 54, to perform a selftest.

none Returns an error code and a short description of the error.

example: slot:tst? → +0,"self test OK"<END>

command:

syntax:

:SPECial:REBoot

description: Reboots the mainframe and all modules.

parameters:

response:

example:

none none

spec:reb

Introduction to Programming

Measurement Functions – The SENSe Subsystem

4.2 Measurement Functions – The SENSe Subsystem

The SENSe subsystem lets you control measurement parameters for a Power Sensor or Optical Head Interface module.

command:

syntax:

description:

parameters:

response:

NOTE If the reference state is absolute, units are dBm or W.

example:

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

:FETCh[n][:CHANnel[n]][:SCAlar]:POWer[:DC]?

:FETCh[n]:[CHANnel[n]][:SCAlar]:POWer[:DC]? Reads the current power meter value. It does not provide its own triggering

and so must be used with either continuous software triggering (see “:INITiate[n]:[CHANnel[n]]:CONTinuous” on page 75) or a directly preceding immediate software trigger (see “:INITiate[n]:[CHANnel[n]][:IMMediate]” on page 74). It returns the power meter value the previous software trigger measured. Any subsequent FETCh command will return the same value, if there is no subsequent software trigger.

none The current power meter value as a ﬂoat value in dBm,W or dB.

If the reference state is relative, units are dB.

fetc1:pow? → +6.73370400E-04<END>

All power meter modules

:INITiate[n]:[CHANnel[n]][:IMMediate]

:INITiate[n]:[CHANnel[n]][:IMMediate] Initiates the software trigger system and completes one full trigger cycle,

that is, one measurement is made. none

none

init

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

:INITiate[n]:[CHANnel[n]]:CONTinuous

:INITiate[n]:[CHANnel[n]]:CONTinuous<wsp><boolean>

description: Sets the software trigger system to continuous measurement mode. parameters:

response:

example:

affects:

command:

syntax:

A boolean value: 0 or OFF: do not measure continuously

1 or ON: measure continuously

none

init2:cont 1

All power meter modules

:INITiate[n]:[CHANnel[n]]:CONTinuous?

description: Queries whether the software trigger system operates continuously

or not

parameters:

response:

example:

affects:

none A boolean value: 0 or OFF: measurement is not continuous

1 or ON: measurement is continuous

init2:cont? → 1<END>

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

NOTE The power meter must be running for this command to be

parameters:

response:

NOTE If the reference state is absolute, units are dBm or W.

example:

affects:

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

:READ[n]:[CHANnel[n]][:SCALar]:POWer[:DC]? Reads the current power meter value. It provides its own software triggering

and does not need a triggering command. If the software trigger system operates continuously (see “:INITiate[n]:[CHANnel[n]]:CONTinuous” on page 75), this command is identical to “:FETCh[n][:CHANnel[n]][:SCAlar]:POWer[:DC]?” on page 74. If the software trigger system does not operate continuously, this command is identical to generating a software trigger (“:INITiate[n]:[CHANnel[n]][:IMMediate]” on page 74) and then reading the power meter value.

effective.

none The current power meter reading as a ﬂoat value in dBm, W or dB.

If the reference state is relative, units are dB.

read1:pow? → +1.33555600E-006<END>

All power meter modules

command:

syntax:

description: parameters:

response:

example:

affects:

:SENSe[n]:[CHANnel[n]]:CORRection[:LOSS][:INPut] [:MAGNitude]

:SENSe[n]:[CHANnel[n]]:CORRection[:LOSS][:INPUT][:MAGNitude] <wsp><value>[DB]

Enters a calibration value for a module. The calibration factor as a ﬂoat value

If no unit type is speciﬁed, decibels (dB) is implied. none

sens1:corr 10DB

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

:SENSe[n]:[CHANnel[n]]:CORRection[:LOSS][:INPut] [:MAGNitude]?

:SENSe[n]:[CHANnel[n]]:CORRection[:LOSS][:INPUT][:MAGNitude]? Returns the calibration factor for a module. none The calibration factor as a ﬂoat value. Units are in dB, although no units are

returned in the response message.

example: sens1:corr? → +1.00000000E+000<END>

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

All power meter modules

:SENSe[n]:[CHANnel[n]]:CORRection:COLLect:ZERO

:SENSe[n]:[CHANnel[n]]:CORRection:COLLect:ZERO Zeros the electrical offsets for a module. none none

sens1:corr:coll:zero

All power meter modules

:SENSe[n]:[CHANnel[n]]:CORRection:COLLect:ZERO?

:SENSe[n]:[CHANnel[n]]:CORREction:COLLect:ZERO? Returns the status of the most recent zero command. none 0:

any other number:

sens1:corr:coll:zero? → 0<END>

All power meter modules

zero succeeded without errors. remote zeroing failed (the number is the error code returned from the operation).

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax: description: parameters:

response:

example:

affects:

:SENSe[n]:[CHANnel[n]]:CORRection:COLLect:ZERO :ALL

SENSe[n]:[CHANnel[n]]:CORRection:COLLect:ZERO:ALL Zeros the electrical offsets for all installed modules. none none

sens:chan:corr:coll:zero:all

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

NOTE Setting parameters for the logging function sets some parameters for

the stability and MinMax functions and vice versa.

command:

syntax:

description:

parameters:

Measurement Running Measurement Stopped

response:

example:

affects:

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:LOGGing

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:LOGGing<wsp> <data points>,<averaging time>[NS|US|MS|S]

Sets the number of data points and the averaging time for the logging function.

Data Points:

Averaging time:

1352 4

If you specify no units for the averaging time value in your command, seconds are used as the default.

none

sens1:func:par:logg 64,1ms

All power meter modules

Data Points is the number of samples that are recorded before the logging mode is completed. Data Points is an integer value. Averaging time is a time value in seconds. There is no time delay between averaging time periods. Use sens:func:par:stab if you want to use delayed measurement.

Averaging Time

687 9

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax: description:

parameters:

response:

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:LOGGing?

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:LOGGing? Returns the number of data points and the averaging time for the logging

function. none

Returns the number of data points as an integer value and the averaging time, t

, as a ﬂoat value in seconds.

avg

example: sens1:func:par:logg? → +64,+1.00000000E-001<END>

affects:

NOTE Setting parameters for the MinMax function setssome parameters for

command:

syntax:

description:

parameters:

response:

example:

affects:

All power meter modules

the stability and logging functions and vice versa.

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:MINMax

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:MINMax<wsp> CONTinous|WINDow|REFResh,<data points>

Sets the MinMax mode and the number of data points for the MinMax function.

CONTinous: WINDow: REFResh:

Data Points is the number of samples that are recorded in the memory buffer used by the WINDow and REFResh modes. Data Points is an integer value. See Chapter 3 of the HP 8163A Lightwave Multimeter & HP 8164A Lightwave Measurement System User’s Guide, for more information on MinMax mode.

none

sens1:func:par:minm WIND,10

All power meter modules

continuous minmax mode window minmax mode refresh minmax mode

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:MINMax?

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:MINMax? Returns the MinMax mode and the number of data points for the MinMax

function. none

CONT: WIND: REFR:

The number of data points is returned as an integer value.

continuous MinMax mode window MinMax mode refresh MinMax mode

example: sens1:func:par:minm? → WIND,+10<END>

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

NOTE Setting parameters for the stability function sets some parameters for

the logging and MinMax functions and vice versa.

command:

syntax:

description:

parameters:

Measurement Running Measurement Stopped

NOTE The total time should be longer than the period time.

response:

example:

affects:

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:STABility

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:STABility<wsp> <total time>[NS|US|MS|S],<period time>[NS|US|MS|S], <averaging time>[NS|US|MS|S]

Sets the total time, period time, and averaging time forthe stability function. Total time:

Period time:

Averaging time:

12345

The period time should be longer than the averaging time.

The number of data points is equal to the total time divided by the period time. Total time, period time, and averaging time are time values in seconds. If you specify no units in your command, seconds are used as the default.

none

sens1:func:par:stab 1s,0.1s,0.1s

All power meter modules

The total time from the start of stability mode until it is completed. A new measurement is started after the completion of every period time. Period time A measurement is averaged over the averaging time.

Averaging Time

Period Time

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:STABility?

:SENSe[n][:CHANnel[n]]:FUNCtion:PARameter:STABility? Returns the total time, period time, and averaging time for the stability func-

tion. none

Total time, delay time, and averaging time are ﬂoat values in seconds.

example: sens1:func:par:stab? → +1.00000000E+000,

+1.00000000E-001,+1.00000000E-001<END>

affects:

command:

syntax:

description:

parameters:

response:

All power meter modules

:SENSe[n][:CHANnel[n]]:FUNCtion:RESult?

:SENSe[n][:CHANnel[n]]:FUNCtion:RESult? Returns the data array of the last function. none The last function’s data array as a binary block, one measurement value is 4

bytes long in Intel byte order.

example: sens1:func:res? → returns a data array

affects:

command:

syntax:

description:

parameters:

response:

All power meter modules

:SENSe[n][:CHANnel[n]]:FUNCtion:STATe

:SENSe[n][:CHANnel[n]]:FUNCtion:STATe<wsp> LOGGing|STABility|MINMax,STOP|STARt

Enables/Disables the logging, MinMax, or stability function mode. LOGGing:

STABility: MINMax: STOP: STARt:

none

Logging function Stability function MinMax function Stop function Start function

example: sens1:func:stat logg,star

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax: description: parameters:

response:

:SENSe[n][:CHANnel[n]]:FUNCtion:STATe?

:SENSe[n][:CHANnel[n]]:FUNCtion:STATe? Returns the function mode and the status of the function. none NONE

LOGGING_STABILITY MINMAX PROGRESS COMPLETE

No function mode selected Logging or stability function MinMax function Function is in progress Function is complete

example: sens1:func:stat? →

LOGGING_STABILITY,COMPLETE<END>

affects:

command:

syntax:

description: parameters:

response:

All power meter modules

:SENSe[n][:CHANnel[n]]:FUNCtion:THReshold

:SENSe[n][:CHANnel[n]]:FUNCtion:THReshold<wsp><mode>, <threshold value>[PW|NW|UW|MW|Watt|DBM]

Sets the start mode and the threshold value. ABOVe:

BELow:

IMMediately: Threshold Value:

none

Function starts when power is above the threshold value. Function starts when power is below the threshold value. Function starts immediately. A ﬂoat value in Watts or dBm.

example: sens1:func:thr? IMM,20nw<END>

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

:SENSe[n][:CHANnel[n]]:FUNCtion:THReshold?

:SENSe[n][:CHANnel[n]]:FUNCtion:THReshold? Returns the start mode and the threshold value. none ABOV:

BEL:

IMM: Threshold Value:

Function starts when power is above the threshold value. Function starts when power is below the threshold value. Function starts immediately. A ﬂoat value in Watts or dBm.

example: sens1:func:thr? → IMM,+2.00000000E-008<END>

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

All power meter modules

:SENSe[n]:[CHANnel[n]]:POWer:ATIME

:SENSe[n]:[CHANnel[n]]:POWer:ATIME<wsp><averaging time> [NS|US|MS|S]

Sets the averaging time for the module. The averaging time as a ﬂoat value in seconds.

If you specify no units in your command, seconds are used as the default. none

sens1:pow:atime 1s

All power meter modules

command:

syntax:

description:

parameters:

response:

:SENSe[n]:[CHANnel[n]]:POWer:ATIME?

:SENSe[n]:[CHANnel[n]]:POWer:ATIME? Returns the averaging time for the module. none The averaging time as a ﬂoat value in seconds.

example: sens1:pow:atime? → +1.00000000E+000<END>

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax: description:

parameters:

response:

example:

affects:

:SENSe[n]:[CHANnel[n]]:POWer:RANGe[:UPPer]

:SENSe[n]:[CHANnel[n]]:POWer:RANGe[:UPPer]<wsp> <value>[DBM] Sets the power range for the module.

The range changes at 10 dBm intervals. The corresponding ranges for linear measurements (measurements in Watts) is given below:

Range

+30 dBm +20 dBm +10 dBm

0 dBm

-10 dBm

-20 dBm

-30 dBm

-40 dBm

The range as a ﬂoat number in dBm. The number is rounded to the closest multiple of 10, because the range changes at 10 dBm intervals. Units are in dBm.

none

sens1:pow:rang -20DBM

All power meter modules

Upper Linear

Power Limit

1999.9 mW

199.99 mW

19.999 mW

1999.9 µW

199.99 µW

19.999 µW

1999.9 nW

199.99 nW

Range

-50 dBm

-60 dBm

-70 dBm

-80 dBm

-90 dBm

-100 dBm

-110 dBm

Upper Linear

Power Limit

19.999 nW

1999.9 pW

199.99 pW

19.999 pW

1.999 pW

0.199 pW

0.019 pW

command:

syntax: description: parameters:

response:

:SENSe[n]:[CHANnel[n]]:POWer:RANGe[:UPPer]?

:SENSe[n]:[CHANnel[n]]:POWer:RANGe[:UPPer]? Returns the range setting for the module none The range setting as a ﬂoat value in dBm

(−110 ≤ value ≤ +30).

example: sens1:pow:rang? → -2.00000000E+001<END>

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

:SENSe[n]:[CHANnel[n]]:POWer:RANGe:AUTO

SENSe[n]:[CHANnel[n]]:POWer:RANGe:AUTO <wsp><boolean> Enables or disables automatic power ranging for the module.

If automatic power ranging is enabled, ranging isautomatically determined by the instrument. Otherwise, it must be set by the sensn:pow:rang command.

A boolean value: 0 or OFF: automatic ranging disabled

1 or ON: automatic ranging enabled

none

sens1:pow:rang:auto 1

All power meter modules

:SENSe[n]:[CHANnel[n]]:POWer:RANGe:AUTO?

:SENSe[n]:[CHANnel[n]]:POWer:RANGe:AUTO? Returns whether automatic power ranging is being used by the module. none A boolean value: 0: automatic ranging is not being used.

1: automatic ranging is being used.

example: sens1:pow:rang:auto? → 1<END>

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description: parameters:

NOTE You must append a unit type

response:

example:

affects:

command:

syntax:

description: parameters:

response:

:SENSe[n]:[CHANnel[n]]:POWer:REFerence

:SENSe[n]:[CHANnel[n]]:POWer:REFerence<wsp> TOMODule|TOREF,<value>PW|NW|UW|MW|Watt|DBM|DB

Sets the sensor reference value. TOMODule:

TOREF: The reference as a ﬂoat value.

• Watts or dBm if you use TOMODule or

• dBm if you use TOREF.

none

sens1:pow:ref toref,-40DBM

All power meter modules

:SENSe[n]:[CHANnel[n]]:POWer:REFerence?

:SENSe[n]:[CHANnel[n]]:POWer:REFerence?<wsp> TOMODule|TOREF

Returns the sensor reference value. TOMODule:

TOREF: The reference as a ﬂoat value.

Sets a reference relative to another channel Sets a constant reference value in Watts or dBm

Returns the reference relative to another channel Returns the constant reference value

example: sens1:pow:ref? toref → -40DBM<END>

affects:

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

:SENSe[n]:[CHANnel[n]]:POWer:REFerence:DISPlay

:SENSe[n]:[CHANnel[n]]:POWer:REFerence:DISPlay Takes the input power level value as the reference value. none none

sens1:pow:ref:disp

All power meter modules

:SENSe[n]:[CHANnel[n]]:POWer:REFerence:STATe

:SENSe[n]:[CHANnel[n]]POWer:REFerence:STATe<wsp><boolean> Sets the measurement units to relative or absolute units. A boolean value: 0 or OFF: absolute

1 or ON: relative

none

sens1:pow:ref:stat 1

All power meter modules

:SENSe[n]:[CHANnel[n]]:POWer:REFerence:STATe?

:SENSe[n]:[CHANnel[n]]POWer:REFerence:STATe? Inquires whether the current measurement units are relative (dB) or absolute

(Watts or dBm). none

A boolean value: 0: absolute

1: relative

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

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description: parameters:

NOTE If you want to reference another power sensor channel, use an integer

response:

examples:

affects:

:SENSe[n]:[CHANnel[n]]:POWer:REFerence:STATe:RATio

:SENSe[n]:[CHANnel[n]]POWer:REFerence:STATe:RATio<wsp> <slot number>|255|TOREF,<channel number>

Selects the reference for the module. slot number:

255 or TOREF: channel number:

value corresponding to the slot for the ﬁrst parameter and an integer value corresponding to the channel for the second value.

If you want to use an absolute reference, use TOREF as the ﬁrst parameter and any integer value as the second parameter.

none

sens1:pow:ref:stat:rat 2,1 sens1:pow:ref:stat:rat TOREF,1

All power meter modules

an integer value representing theslot number you want to reference results are displayed relative to an absolute reference an integer value representing the channel number you want to reference

References channel 2.1 References an absolute reference

command:

syntax: description: parameters:

response:

examples:

affects:

:SENSe[n]:[CHANnel[n]]:POWer:REFerence:STATe:RATio?

:SENSe[n]:[CHANnel[n]]POWer:REFerence:STATe:RATio? Returns the reference setting for the module. none results are displayed relative to an absolute reference or to the current power

reading from another channel.

sens1:pow:ref:stat:rat?

→ +255,+0<END>

sens1:pow:ref:stat:rat?

→ +2,+1<END>

All power meter modules

results are displayed relative to an absolute reference results are displayed relative to channel

2.1

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

example:

affects:

:SENSe[n]:[CHANnel[n]]:POWer:UNIT

:SENSe[n]:[CHANnel[n]]:POWer:UNIT<wsp>DBM|0|Watt|1 Sets the sensor power unit An integer value: 0: dBm

1: Watt

or DBM or Watt none

sens1:pow:unit 1

All power meter modules

:SENSe[n]:[CHANnel[n]]:POWer:UNIT?

:SENSe[n]:[CHANnel[n]]:POWer:UNIT? Inquires the current sensor power unit none An integer value: 0: Current power units are dBm.

1: Current power units are Watts.

sens1:pow:unit? → +1<END>

All power meter modules

Introduction to Programming

Measurement Functions – The SENSe Subsystem

command:

syntax:

description: parameters:

response:

example:

affects:

command:

syntax:

description: parameters:

response:

example

affects:

:SENSE[n]:[CHANnel[n]]:POWer:WAVelength

:SENSE[n]:[CHANnel[n]]:POWer:WAVelength<wsp> <value>|MIN|MAX|DEF [PM|NM|UM|MM|M]

Sets the sensor wavelength. The wavelength as a ﬂoat value in meters. Also allowed are: MIN: minimum programmable value

MAX: maximum programmable value DEF: This is not the preset (*RST) default

value but is half the sum of, the minimum programmable value and the maximum programmable value

none

sens1:pow:wav 1550nm

All power meter modules

:SENSE[n]:[CHANnel[n]]:POWer:WAVelength?

:SENSE[n]:[CHANnel[n]]:POWer:WAVelength? [<wsp>MIN|MAX|DEF]

Inquires the current sensor wavelength. none Also allowed are: MIN: minimum programmable value

MAX: maximum programmable value DEF: This is not the preset (*RST) default

value but is half the sum of, the minimum programmable value and the maximum programmable value

The wavelength as a ﬂoat value in meters.

sens1:pow:wav? → +1.55000000E-006<END>

All power meter modules

Introduction to Programming

Signal Generation – The SOURce Subsystem

4.3 Signal Generation – The SOURce Subsystem

The SOURce subsystem allows you to control a Laser Source or Tunable Laser module.

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

:OUTPut[n][:CHANnel[n]]:CONNection

OUTPut[n][:CHANnel[n]]:CONNection<wsp>MOD|VPP|VPL Sets the analog output parameter. MOD:

VPP: none

outp1:conn mod

All instruments

:OUTPut[n][:CHANnel[n]]:CONNection?

OUTPut[n][:CHANnel[n]]:CONNection? Returns the analog output parameter. none MOD:

VPP:

The modulation frequency modulates the analog output. Output Voltage is proportional to optical power.

example: outp1:conn? → MOD<END>

affects:

All instruments

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax: description: parameters:

response:

example:

affects:

command:

syntax: description: parameters:

response:

:OUTPut[n][:CHANnel[n]]:PATH

:OUTPut[n][:CHANnel[n]]:PATH<wsp><path> Sets the regulated path. HIGHpower:

LOWSse: BHRegulated:

BLRegulated:

none

output1:path high

All instruments

:OUTPut[n][:CHANnel[n]]:PATH?

:OUTPut[n][:CHANnel[n]]:PATH? Returns the regulated path. none HIGHpower:

LOWSse: BHRegulated: BLRegulated:

example: output1:path? → HIGH<END>

affects:

All instruments

The High Power output is regulated. The Low SSE output is regulated. Both outputs are active but only the High Power output is Regulated. Both outputs are active but only the Low SSE output is Regulated.

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax:

description:

parameters:

response:

example:

affects:

command:

syntax:

description:

parameters:

response:

:OUTPut[n][:CHANnel[n]][:STATe]

:OUTPut[n]:STATe<wsp>OFF|ON|0|1 Switches the laser current off and on.

The laser emits light only when the current is on. Set the state to OFF or 0 to switch the laser current off. Set the state to ON or 1 to switch the laser current on. The default is for the laser current to be off.

0 or OFF: 1 or ON:

none

outp 1

All instruments

:OUTPut[n][:CHANnel[n]][:STATe]?

:OUTPut[n][:STATe]? Returns the current state of the laser current. none A boolean value: 0 – laser current off

switch laser current off switch laser current on

example: outp? → 1<END>

affects:

All instruments

1 – laser current on

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax:

description: parameters:

response:

example:

affects:

command:

syntax:

description: parameters:

response:

example:

[:SOURce[n]][:CHANnel[n]]:AM[:INTernal:FREQuency

[:SOURce[n]][:CHANnel[n]]:AM[:INTernal]:FREQuency<wsp> <frequency>[THZ|GHZ|MHZ|KHZ|HZ]

Sets the frequency of the amplitude modulation of the laser output. The frequency as a ﬂoat value in Hz. Also allowed are: MIN: minimum programmable value

MAX: maximum programmable value DEF: This is not the preset (*RST) default value but

is half the sum of, the minimum programmable value and the maximum programmable value

The default units are HZ, although KHZ, MHZ, GHZ, and THZ can also be speciﬁed. The resolution of the frequency is always 1 Hz.

none

sour2:am:freq 270hz

All source modules

[:SOURce[n]][:CHANnel[n]]:AM[:INTernal] :FREQuency?

[:SOURce[n]][:CHANnel[n]]:AM[:INTernal] :FREQuency? [MIN|DEF|MAX]

Returns the frequency of theamplitude modulation as a ﬂoat value in Hertz.

MIN: minimum modulation frequency MAX: maximum modulation frequency DEF: This is not the preset (*RST) default value but is half the sum of, the

minimum modulation frequency and the maximum modulation frequency

modulation frequency relevant to the current value or speciﬁed parameter (if MIN, MAX, or DEF are chosen as a parameter).

sour2:am:freq? min → +2.00000000E+002<END>

All source modules

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax:

description:

parameters:

response:

example:

affects:

[:SOURce[n]][:CHANnel[n]]:AM:SOURce

[:SOURce[n]][:CHANnel[n]]:AM:SOURce<wsp> INT|INT1|INT2|EXT|0|1|2

Selects the type or source of the modulation of the laser output. 0, INT1, or INTernal

1, COHCtrl, or INT2 2, AEXTernal, or EXT 3 or DEXTernal 4 or LFCohctrl 5 or WVLLocking 6 or BACKplane

none

sour2:am:sour int

All source modules can use internal digital modulation All other modulation modes are only available with Tunable Laser modules.

internal digital modulation coherence control external analog modulation external digital modulation low frequency coherence control wavelength locking external digital modulationusing Input Trigger Connector

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax: description: parameters:

response:

[:SOURce[n]][:CHANnel[n]]:AM:SOURce?

[:SOURce[n]][:CHANnel[n]]:AM:SOURce? Returns the current state of modulation. 0

1 2 3 4 5 6

none

example: sour2:am:sour? → +0<END>

affects:

All source modules can use internal digital modulation All other modulation modes are only available with Tunable Laser modules.

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax:

description:

parameters:

NOTE When the internal modulation is selected, the Modulation Output

response:

example:

affects:

[:SOURce[n]][:CHANnel[n]]:AM:STATe

[:SOURce[n]][:CHANnel[n]]:AM:STATe<wsp> OFF|ON|0|1 Enables and disables amplitude modulation of the laser output. A boolean value: OFF or 0: modulation disabled (default)

ON or 1: modulation enabled.

on the front panel outputs a version of themodulating signal that has the same frequency and phase as the modulating signal, but has a ﬁxed, TTL-level amplitude. You canuse this to synchronize your external measuring equipment to your instrument.

To allow foryourpossible synchronizationrequirements,there are two ways in which the signal can be output. Either the signal is combinedwith the laser-readysignal, so that theoutput is keptlow when there is no optical signal being output (for example, while the laser is settling after a change of wavelength). Or the modulation signal is output all the time. This is set by the :SOURCE:MODOUT command (see [:SOURce[n]][:CHANnel[n]]:MODout on page 100).

none

sour2:am:stat 0

All source modules

command:

syntax:

description:

parameters:

response:

[:SOURce[n]][:CHANnel[n]]:AM:STATe?

[:SOURce[n]][:CHANnel[n]]:AM:STATe? Returns the current state of modulation. none A boolean value: 0: modulation is disabled

1: modulation is enabled

example: sour2:am:stat? → 0<END>

affects:

All source modules

Introduction to Programming

Signal Generation – The SOURce Subsystem

command:

syntax: description: parameters:

response:

example:

affects:

command:

syntax: description: parameters:

response:

[:SOURce[n]][:CHANnel[n]]:MODout

[:SOURce[n]][:CHANnel[n]]:MODout<wsp>FRQ|FRQRDY|0|1 Sets the modulation output

FRQ or 0: FRQRDY or 1:

none

sour2:mod 0

All Tunable Laser modules

[:SOURce[n]][:CHANnel[n]]:MODout?

[:SOURce[n]][:CHANnel[n]]:MODout? Returns the mode of the modulation output. none 0:1:modulation signal is output all the time

modulation is combined with the laser-ready signal. In this case, the output is kept low when no optical signal is output (for example, while the laser is settling after a change of wavelength).

modulation signal is output all the time modulation is combined with the laser-ready signal. In this case, the output is kept low when no optical signal is output (for example, while the laser is settling after a change of wavelength).

example: sour2:mod? → 0<END>

affects:

All Tunable Laser modules

100

Agilent 8164A Programmers Guide

Specifications and Main Features

Frequently Asked Questions

User Manual

In this Manual

The Structure of this Manual

Conventions used in this Manual

Related Manuals

1.1 HP-IB Interface

Setting the HP-IB Address

Returning the Instrument to Local Control

1.2 Message Queues

How the Input Queue Works

Clearing the Input Queue

The Output Queue

The Error Queue

1.3 Programming and Syntax Diagram Conventions

Short Form and Long Form

Command and Query Syntax

Units

Data Types

1.4 Common Commands

Common Command Summary

Common Status Information

1.5 The Status Model

Annotations

Status Byte Register

Standard Event Status Register

Operation/Questionable Status Summary

Operation/Questionable Status Summary Register

Operation/Questionable Slot Status

Operation Slot Status Register

Questionable Slot Status Register

Status Command Summary

Other Commands

3.1 IEEE-Common Commands

*CLS

*ESE

*ESE?

*ESR?

*IDN?

*OPC

*OPC?

*OPT?

*RST

*STB?

*TST?

*WAI

3.2 Status Reporting – The STATus Subsystem

:STATus:OPERation[:EVENt]?

:STATusn:OPERation[:EVENt]?

command: :STATus:OPERation:CONDition?

:STATusn:OPERation:CONDition?

command: :STATus:OPERation:ENABle

command: :STATus:OPERation:ENABle?

command: :STATus:PRESet

command: :STATus:QUEStionable[:EVENt]?

:STATusn:QUEStionable[:EVENt]?

command: :STATus:QUEStionable:CONDition?

:STATusn:QUEStionable:CONDition?

command: :STATus:QUEStionable:ENABle

command: :STATus:QUEStionable:ENABle?

3.3 Interface/Instrument Behaviour Settings – The SYSTem Subsystem

command: :SYSTem:DATE

command: :SYSTem:DATE?

command: :SYSTem:ERRor?

command: :SYSTem:HELP:HEADers?

command: :SYSTem:PRESet

command: :SYSTem:TIME

command: :SYSTem:TIME?

command: :SYSTem:VERSion?

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

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

4.1 Root Layer Command

:LOCK

:LOCK?

:SLOT[n][:HEAD[n]]:EMPTy?

:SLOT[n][:HEAD[n]]:IDN?

:SLOT[n][:HEAD[n]]:OPTions?

:SLOT[n][:HEAD[n]]:TST?