User’s Manual AQ7277 Remote OTDR Communication Interface
IM AQ7277-17EN 2nd Edition Foreward Thank you for purchasing YOKOGAWA’s AQ7277. This Communication Interface User’s Manual describes the functions and commands of USB and Ethernet interface. To ensure proper use of the USB/Ethernet interfaces, please read this manual thoroughly.Keep the manual in a safe place for quick reference whenever a question arises.
Notes • The contents of this manual are subject to change without prior notice as a result of improvements in instrument’s performance and functions. • Every effort has been made in the preparation of this manual to ensure the accuracy of its contents. However, should you have any questions or find any errors, please contact your nearest YOKOGAWA representative. • Copying or reproduction of all or any part of the contents of this manual without YOKOGAWA’s permission is strictly prohibited.
Trademarks • Microsoft, Internet Explorer, Windows, and WindowsVista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. • Adobe, Acrobat, and PostScript are either trademarks or registered trademarks of Adobe Systems incorporated. • For purposes of this manual, the ® and TM symbols do not accompany their respective registered trademark names or trademark names. • Other product names are registered trademarks or trademarks of their respective holders.
Revisions 1st Edition: March 2011 2nd Edition: October 2017
2nd Edition :October 2017 (YMI) All Rights Reserved, Copyright © 2011, Yokogawa Test & Measurement Corporation
IM AQ7277-17EN i How to Use this Manual
Structure of the Manual This User’s Manual consists of the following sections: Chapter 1 Remote Control Function Overview Gives an overview of the various communication interfaces.
Chapter 2 Connecting the PC Describes the functions and specifications of the USB interface and the Ethernet Interface used to control the AQ7277 from a PC.
Chapter 3 Before Programming Describes the syntax used to transmit commands.
Chapter 4 Remote Commands Describes each command that is available.
ii IM AQ7277-17EN Conventions Used in This Manual
Notations Used in the Procedural Explanations On pages that describe the operating procedures in each chapter, the following notations are used to distinguish the procedure from their explanations.
Procedure This subsection contains the operating procedure used to carry out the function described in the current section. The procedures are written with inexperienced users in mind; experienced users may not need to carry out all the steps.
Explanation This subsection describes the setup parameters and the limitations on the procedures.
Note Calls attention to information that is important for proper operation of the instrument.
Units Symbol Description Example k 1000 400km K 1024 459KB (file size)
IM AQ7277-17EN iii Conventions Used in This Manual
Symbols Used in Syntax Descriptions Symbols which are used in the syntax descriptions in Chapter 4 are shown below. These symbols are referred to as BNF notation (Backus-Naur Form). For detailed information, see section 3.4, “Data.”
Symbol Description Example Example of Input <> Defined value SET:M
iv IM AQ7277-17EN Index 1
How to Use this Manual...... ii Conventions Used in This Manual...... iii 2
Chapter 1 Remote Control Function Overview 1.1 Remote Interface...... 1-1 1.2 Switching between Remote and Local Modes...... 1-2 3
Chapter 2 Connecting the PC 2.1 Connecting via the USB...... 2-1 4 2.2 Connecting via the Ethernet Interface...... 2-2
Chapter 3 Before Programming 3.1 Messages...... 3-1 5 3.2 Commands...... 3-3 3.3 Response...... 3-6 3.4 Data...... 3-7 App 3.5 Synchronization with the Controller...... 3-11
Chapter 4 Commands 4.1 A List of Commands...... 4-1 Index 4.2 Common Commands...... 4-4 4.3 Device-Specific Commands...... 4-6 ACQuire Group...... 4-6 ANALysis Group...... 4-9 COMMunicate Group...... 4-13 DISPlay Group...... 4-14 FILE Group...... 4-16 MENU Group...... 4-16 MISC Group...... 4-17 NETWork Group...... 4-18 SETup Group...... 4-19 STATus Group...... 4-19 WAVedata Group...... 4-20 SYSTem Group...... 4-21 4.4 Condition Register...... 4-22 4.5 Output Queue and Error Queue...... 4-23 4.6 Error Messages...... 4-24
IM AQ7277-17EN v Chapter 1 Remote Control Function Overview 1.1 Remote Interface 1 Remote Control Function Overview
The AQ7277 is equipped with the following remote interfaces. 2
USB 1.1 Interface (Type B. See Chapter 2) This interface is used by a controller such as a PC to remotely control the AQ7277. A controller is connected to this interface. 3 Remote commands are used to control the AQ7277. Dedicated commands for the AQ7277 complying with SCPI (Standard Commands for Programmable Instruments) are available for the remote commands (see chapter 4). 4
Ethernet Interface (See Chapter 2) This interface is used by a controller such as a PC to remotely control the AQ7277 via the network. 5
Downloading the Library and Driver The items below are needed on the PC to use the communication functions via the USB App interface. • Communication Library(TMCTL) • USB connection device driver between the PC and AQ7277(YKUSB) Index The items below are needed on the PC to use the communication functions via the Ethernet interface. • Communication Library(TMCTL)
The library and driver above can be downloaded from the following Web page. http://www.yokogawa.com/tm/dl_driver.htm
IM AQ7277-17EN 1-1 1.2 Switching between Remote and Local Modes
When Switching from Local to Remote Mode The AQ7277 is in local mode when it is being controlled with the remote controller for the AQ7277 Remote OTDR. It is in remote mode when it is being controlled through the use of communication commands. In remote mode, the soft keys on the remote controller for the AQ7277 Remote OTDR are disabled.
• All keys except the "Local" key are disabled. • Settings entered in local mode are passed on even when the AQ7277 switches to remote mode.
When Switching from Remote to Local Mode In remote mode, if you press Local on the remote controller for the AQ7277 Remote OTDR, the AQ7277 switches to local mode.
• You will be able to use the remote controller for the AQ7277 Remote OTDR. • Settings entered in remote mode are retained even when the AQ7277 switches to local mode.
1-2 IM AQ7277-17EN Chapter 2 Connecting the PC 2.1 Connecting via the USB 1
You can control the AQ7277 from a PC using the USB interface. 2 Connecting the PC USB Interface Functions and Specifications Reception Function You can specify the same settings as those specified by front panel key operations. 3 Receives output requests for measured and computed data, setup data, and error codes.
Transmission Function 4 Outputs measured and computed data. Outputs setup data and the status byte. Outputs error codes that have occurred. 5 USB Interface Specifications Electrical and mechanical specifications: Conforms to USB Rev.1.0 Connector: Type B connector (receptacle) App Number of ports: 1 Power supply: Self-powered Compatible PC systems: PCs with standard USB ports running Windows XP, Windows Vista,or Windows 7. Index (A separate device driver is required to connect to a PC.)
Connection Procedure Connecting a USB Cable to Remotely Control the AQ7277 Connect a USB cable to the Type B connector.
Precautions to Be Taken When Connecting the Cable • Connect the USB cable by inserting the connector firmly into the USB connector. • Do not connect or disconnect the USB cable after the power is turned ON until the AQ7277 is ready for operation (approximately 20 s).
IM AQ7277-17EN 2-1 2.2 Connecting via the Ethernet Interface
You can control the AQ7277 from a PC by connecting the AQ7277 to a LAN using the Ethernet interface. Ethernet Interface Functions and Specifications Reception Function You can specify the same settings as those specified by AQ7277 Remote Controller. Receives output requests for measured and computed data, setup data, and error codes.
Transmission Function Outputs measured and computed data. Outputs setup data and the status byte. Outputs error codes that have occurred.
Ethernet Interface Specifications Number of communication ports: 1 Electrical and mechanical specifications: Conforms to IEEE802.3 Transmission system: Ethernet (10BASE-T/100BASE-TX) Data rate: 10 Mbps/100 Mbps Communication protocol: TCP/IP Connector type: RJ45 connector Port number used: 10001/tcp
Note When using the Ethernet interface, a user name and password are required when connecting to the network. For the procedure to enter the user name and password, see the User,s Manual of AQ7277 Remote Controller
2-2 IM AQ7277-17EN 2.2 Connecting via the Ethernet Interface
Connection Procedure 1 Connect a UTP (Unshielded Twisted-Pair) cable or an STP (Shielded Twisted-Pair) cable that is connected to a hub, for example, to the 100BASE-TX port. 2 Precautions to Be Taken When Connecting the Cable Connecting the PC • Be sure to use a straight cable via a hub for the connection between the AQ7277 and the PC. • When using a UTP cable (straight cable), use a cable of category 5. 3
Note Set the TCP/IP address using the remote controller for the AQ7277 Remote OTDR. For the procedure, see the user's manual for the remote controller for the AQ7277 Remote OTDR. 4
5
App
Index
IM AQ7277-17EN 2-3 Chapter 3 Before Programming 3.1 Messages 1
Blocks of message data are transferred between the controller and this instrument during 2 communications.Messages sent from the controller to this instrument are called program messages, and messages sent back from this instrument to the controller are called response messages. If a program message contains a query command, i.e.a command which requests a 3 response, this instrument returns a response message. A single response message is Before Programming always returned in reply to a program message. 4 Program Messages Program Message Unit A program message consists of one or more programmessage units; each unit corresponds to one command. This instrument executes commands one by one 5 according to the order in which they are received. Program message units are delimited by a ";. "For a description of the format of the program message unit, refer to the explanation given furtherbelow. App
Example :ACQuire:AVERage:MODE HIREFLECTION;TIME AUTO
Index Unit Unit
Example :ACQuire:AVERage:MODE HIREFLECTION
Header Data
IM AQ7277-17EN 3-1 3.1 Messages
Response Messages
Unit Unit
Example 1200
Data Header Data
If a program message contains more than one query, responses are made in the same order as the queries. Normally, each query returns only one response message unit, but there are some queries which return more than one response message unit. The first response message unit always responds to the first query, but it is not always true that the 'n'th unit always responds to the 'n'th query. Therefore, if you want to make sure that a response is made to eachquery, the program message must be divided up into individual messages.
Points to Note Concerning Message Transmission • It is always possible to send a program message if the previous message which was sent did not contain any queries. • If the previous message contained a query, it is not possible to send another program message until a response message has been received. An error will occur if a program message is sent before a response message has been received in its entirety. A response message which has not been receivedwill be discarded. • If an attempt is made by the controller to receive a response message, even if there it no response message, an error will occur. An error will also occur if the controller makes an attempt to receive a response message before transmission of a program message has been completed. • If a program message of more than one unit is sent and some of the units are incomplete, this instrument receives program message units which the instrument thinks complete and attempts to execute them. However, these attempts may not always be successful and a response may not always be returned, even if the program message contains queries.
3-2 IM AQ7277-17EN 3.2 Commands 1
There are two types of command (program header)which can be sent from the controller 2 to this instrument. They differ in the format of their program headers.
Common command header Common Command Header Commands defined in IEEE 488.2-1987 are called common 3
commands. Before Programming An asterisk (*) must always be attached to the beginning of a command. An example of a common command *CLS 4
Compound header Compound Header Commands designed to be used only with this instrument are 5 classified and arranged in a hierarchy according to their function. The format of a compound header is below. A colon (:) must be used when specifying a lower-level header. App An example of a compound header : ACQuire: AVERage: MODE
Index
IM AQ7277-17EN 3-3 3.2 Commands
When Concatenating Commands Command Group A command group is a group of commands which havethe same compound header. A command group maycontain sub-groups.
Example Commands relating to acquisition settings :ACQuire:AVERage:MODE :ACQuire:ATTenuation :ACQuire:AVERage:TYPE :ACQuire:DRANge :ACQuire:PWIDth :ACQuire:REALtime:STARt :ACQuire:SETTing
When Concatenating Commands of the SameGroup This instrument stores the hierarchical level of the command which is currently being executed, andperforms analysis on the assumption that the nextcommand to be sent will also belong to the same level.Therefore, it is possible to omit the header if thecommands belong to the same group. Example :ACQuire:AVERage:MODE HIREFLECTION;TIME AUTO
When Concatenating Commands of DifferentGroups A colon (:) must be included before the header of a command, if the command does not belong to the same group as the preceding command. It is impossible to omit a colon (:). Example :ACQuire:AVERage:MODE HIREFLECTION;:DISPlay:CURSor :SECond ON
When Concatenating Common Commands Common commands defined in IEEE 488.2-1987 are independent of hierarchical level. Thus, it is not necessary to add a colon (:) before a commoncommand. Example :ACQuire:AVERage:MODE HIREFLECTION;*CLS;TIME AUTO
When Separating Commands with
3-4 IM AQ7277-17EN 3.2 Commands
Upper-level Query 1 An upper-level query is a compound header to which aquestion mark is appended. Execution of an upper-level query allows all a group’s settings to be output atonce. Some query groups comprising more than threehierarchical levels can output all their lower level settings. 2 Example :ANALysis:THReshold?
Note • In reply to a query, a response can be returned as a program message to this instrument. 4 Transmitting a response can restore the settings made when the query was executed. • Not all a group’s information will necessarily be sent out as a response. Some upper- levelqueries will not return setup data which is not currently in use. 5 Header Interpretation Rules This instrument interprets the header receivedaccording to the following rules. • Mnemonics are not case sensitive. App Example "DRANge" can also be written as"drange" or "Drange."
• The lowercase part of a header can be omitted. Index Example "DRANge" can also be written as"DRANG" or "DRAN."
• If the header ends with a question mark, the command is a query. It is not possible to omit the question mark. Example "DRANge?" cannot be abbreviated to anything shorter than "DRAN?."
• If the "x" at the end of a mnemonic is omitted, it is assumed to be "1." ExampleIf "M
Note A mnemonic is a character string made up of alphanumeric characters.)
IM AQ7277-17EN 3-5 3.3 Response
Form On receiving a query from the controller, this instrument returns a response message to the controller. A response message is sent in one of the following two forms.
Response Consisting of a Header and Data If the query can be used as a program messagewithout any change, a command header is attachedto the query, which is then returned. Example:ACQUire:MODE?
Response Consisting of Data Only If the query cannot be used as a program messageunless changes are made to it (i.e. it is a query-onlycommand), no header is attached and only the datais returned. Some query-only commands can bereturned after a header is attached to them. Example:MEASure:CHANnel1:PTOPeak:VALue?
When Returning a Response without a Header It is possible to remove the header from a responseconsisting of a header and data. The"COMMunicate:HEADer" command is used to do this.
Abbreviated Form Normally, the lowercase part is removed from are sponse header before the response is returned to the controller. Naturally, the full form of the header canalso be used. For this, the "COMMunicate:VERBose" command is used. The part enclosed by [ ] is also omitted in the abbreviatedform.
3-6 IM AQ7277-17EN 3.4 Data 1
A data section comes after the header. A space must be included between the header 2 and the data. The data contains conditions and values. Data is classified as below.
Data Description
• Decimal values which are sent from the controller tothis instrument can be sent in any of the forms to
IM AQ7277-17EN 3-7 3.4 Data
Form Example
Symbol Word Description EX Exa 1018 PE Peta 1015 T Tera 1012 G Giga 109 MA Mega 106 K Kilo 103 M Milli 10–3 U Micro 10–6 N Nano 10–9 P Pico 10–12 F Femto 10–15 A Atto 10–18
Symbol Word Description M Meter Distance S Second Time dB Decibel Level UM Micro meter Wavelength
•
3-8 IM AQ7277-17EN 3.4 Data
Form Example
#B
4 •
Index • As with a header, the "COMMunicate:VERBose"command can be used to return a response message in its full form. Alternatively, the abbreviated form can be used. • The "COMMunicate:HEADer" command does not affect
• When
IM AQ7277-17EN 3-9 3.4 Data
• Response messages are always enclosed in double quotation marks. •I f a character string contains a double quotation mark ("), the double quotation mark will be replaced by two concatenated double quotation marks ("").This rule also applies to a single quotation mark within a character string. •
• If you input an
• #N Indicates that the data is
3-10 IM AQ7277-17EN 3.5 Synchronization with the Controller 1
Achieving Synchronization If you send the following program message when receiving averaging measurement 2 data, the data may be retrieved before the completion of the measurement. ACQuire: AVERage: STARt; : WAVedata: DISPlay: SEND: ASCii? 3 In such case, the following method must be used to synchronize with the end of the Before Programming acquisition.
Using the STATus:CONDition? Query 4 The "STATus:CONDition?" command is used to query the contents of the condition register. Whether averaging measurement waveforms are being retrieved can be determined by reading bit 1 of the condition register. 5 If bit 1 of the condition register is "1", waveforms are being retrieved. Otherwise, it is stopped.(Bit 1 is "0".) App Note For details on the condition register, see section 4.4, "Condition Register."
Index
IM AQ7277-17EN 3-11 Chapter 4 Commands List of Commands 1
Common Commands 2 Command Function Page *CLS(Clear Status) Clears all event status registers, the summary of which is reflected in the 4-4 status byte register. *ESE(Standard Event Status Enable) Sets/queries the standard event enable register. 4-4 *ESR?(Standard Event Status Queries the standard event status register and simultaneously clears it. 4-4 3 Register) *IDN? (Identification) Queries the instrument type and firmware version. 4-4 *RST (Reset) Executes a device reset to return the instrument to the known (default) 4-4 status. 4 *SRE(Service Request Enable) Sets/queries the service request enable register. 4-4 *STB?(Read Status Byte) Queries the current value of the status byte register. 4-5 Commands *TST?(Self Test) Performs the instrument's self-test and queries the status. 4-5 Device-Specific Commands 5 Command Function Page ACQuire Group :ACQuire:ATTenuation Sets the attenuation or queries the current setting. 4-6 App :ACQuire:AUTO:ATTenuation? Queries the attenuation for AUTO. 4-6 :ACQuire:AUTO:DRANge? Queries the distance range for AUTO. 4-6 :ACQuire:AUTO:PWIDth? Queries the pulse width for AUTO. 4-6 :ACQuire:AVERage:COUNt? Queries the current average count. 4-6 :ACQuire:AVERage:INDex Sets the average count or queries the current setting. 4-6 Index :ACQuire:AVERage:MODE Sets the average mode or queries the current setting. 4-6 :ACQuire:AVERage:STARt Executes the averaging measurement. 4-6 :ACQuire:AVERage:STOP Stops the averaging measurement. 4-7 :ACQuire:AVERage:TIME Sets the average time or queries the current setting. 4-7 :ACQuire:AVERage:TYPE Sets the average unit or queries the current setting. 4-7 :ACQuire:DRANge Sets the distance range or queries the current setting. 4-7 :ACQuire:OFFSet Sets the horizontal measurement start position or queries the current 4-7 setting. :ACQuire:PWIDth Sets the pulse width or queries the current setting. 4-8 :ACQuire:REALtime:STARt Executes the realtime measurement. 4-8 :ACQuire:REALtime:STOP Stops the realtime measurement. 4-8 :ACQuire:SMPinterval:DATA Sets the sampling interval or queries the current setting. 4-8 :ACQuire:SMPinterval:VALue? Queries the sampling interval. 4-8 :ACQuire:WAVelength Sets the measured wavelength or queries the current setting. 4-8 :ACQuire:SELection:DRANge? Queris the selectable distance range. 4-9 :ACQuire:SELection:WAVelength? Queris the selectable measured wavelength. 4-9 :ACQuire:SELection:PWIDth? Queris the selectable pulse width. 4-9 :ACQuire:SELection:ATTenuation? Queris the selectable attenuatio. 4-9 :ACQuire:SELection:SMPinterval? Queris the selectable sampling interval. 4-9 ANALysis Group :ANALysis:ASEarch:EXECute Executes auto detection. 4-9 :ANALysis:ASEarch:NUMber? Queries the number of auto detection events. 4-9 :ANALysis:BCOefficient Sets the backscattering light level of the current wavelength or queries 4-9 the current setting. :ANALysis:IOR Sets the group refraction index of the current wavelength or queries the 4-9 current setting. :ANALysis:CURSor:DELete Clears the cursor. 4-9 :ANALysis:CURSor:DISTance Sets the cursor position or queries the current setting. 4-9 :ANALysis:CURSor:DECibel? Queries the cursor dB (decibel). 4-10 :ANALysis:CURSor:LINK Sets the cursor link or queries the cursor link setting. 4-10 :ANALysis:EMARker:LMTechnique Sets the approximation method (event) or queries the current setting. 4-10 :ANALysis:EMARker:SET:M1 Sets marker M1 of the current event or queries the current setting. 4-10 :ANALysis:EMARker:SET:M2 Sets marker M2 of the current event or queries the current setting. 4-10 :ANALysis:EMARker:SET:M3 Sets marker M3 of the current event or queries the current setting. 4-10
IM AQ7277-17EN 4-1 4.1 A List of Commands
Command Function Page :ANALysis:EMARker:SET:Y2 Sets marker Y2 of the current event or queries the current setting. 4-10 :ANALysis:DUNit Sets the distance unit or queries the current setting. 4-10 :ANALysis:EVENt:CURRent:INDex Changes the current event. 4-10 :ANALysis:EVENt:CURRent:NOTE Sets the event note or queries the current setting. 4-10 :ANALysis:EVENt:IOR Sets the section IOR of the current event or queries the current setting. 4-11 :ANALysis:EVENt:CURRent:PEAK? Retrieves the peak decibel of the current event. 4-11 :ANALysis:EVENt:FIX Event Fix 4-11 :ANALysis:EVENt:CURRent:DISTance? Retrieves the distance of the current event. 4-11 :ANALysis:EVENt:CURRent:LOSS? Retrieves the splice loss of the current event. 4-11 :ANALysis:EVENt:CURRent:RETurnloss? Retrieves the return loss of the current event. 4-11 :ANALysis:EVENt:CURRent:CUMLoss? Retrieves the accumulated loss of the current event. 4-11 :ANALysis:EVENt:CURRent:UNITloss? Retrieves the loss per unit (dB/m) of the current event. 4-11 :ANALysis:EVENt:CURRent:TYPE? Retrieves the event type of the current event. 4-11 :ANALysis:EVENt:CURRent:IOR? Retrieves the section IOR of the current event. 4-11 :ANALysis:EVENt:DELete Deletes the current event. 4-11 :ANALysis:EVENt:INSert Inserts the event at the cursor position. 4-11 :ANALysis:FEDetection Sets the fault event display or queries the current setting. 4-11 :ANALysis:FMARker:DELete Deletes the marker. 4-12 :ANALysis:FMARker:LMTechnique Sets the approximation method of the marker or queries the current 4-12 setting. :ANALysi s:FMARker:LOSS? Queries the splice loss. 4-12 :ANALysis:FMARker:RETurnloss:VALue? Queries the return loss. 4-12 Queries the saturation of the return loss. 4-12 :ANALysis:FMARker:REFLection:VALue? Queries the reflection level. 4-12 Queries the saturation of the reflection level. 4-12 :ANALysis:FMARker:LEFT:LOSS? Queries the loss between markers 1 and 2. 4-12 :ANALysis:FMARker:LEFT:DISTance? Queries the distance between markers 1 and 2. 4-12 :ANALysis:FMARker:LEFT:UNITloss? Queries the slope between markers 1 and 2. 4-12 :ANALysis:FMARker:RIGHt:LOSS? Queries the loss between markers 2 and 3. 4-12 :ANALysis:FMARker:RIGHt:DISTance? Queries the distance between markers 2 and 3. 4-12 :ANALysis:FMARker:RIGHt:UNITloss? Queries the slope between markers 2 and 3. 4-12 :ANALysis:FMARker:SET:M
IM AQ7277-17EN 4-3 4.2 Common Commands
*IDN? (Identification) *CLS(Clear Status) Function Queries the instrument type and firmware version. Function Clears all event status registers, the summary Syntax of which is reflected in the status byte register. *IDN? Example *IDN? -> YOKOGAWA,AQ7277-B01, Syntax *CLS SN123456789,F1.00 Example *CLS Description • Clears all queues, with the exception of the SN123456789: Serial number output queue, and all event registers, with the (9 digit string) exception of the MAV summary message. F1.00:Firmware version Description Outputs 4 field data delimited by a comma. • After executing this command, OCIS (Operation Field 1: Manufacturer “YOKOGAWA” Complete Command Idle State) and OQIS Field 2: Model “AQ7277-B01” (Operation Complete Query Idle State) are Field 3: Instrument serial number "SN123456789" brought about. Field 4: Software version "F1.00" *ESE(Standard Event Status Enable) Function Sets/queries the standard event enable register. *RST (Reset) Function Executes a device reset to return the instrument to Syntax *ESE
4-4 IM AQ7277-17EN 4.2 Common Commands
*STB?(Read Status Byte) 1 Function Queries the current value of the status byte register. Syntax *STB? Example *STB? -> 251 2 Description STB will not be cleared even when the contents of the register are read.
*TST?(Self Test) Function Performs the instrument's self-test and queries the 3 status. Syntax *TST? Example *TST? -> 0 4
Description Executes the operations below among the Commands initialization sequence at startup and outputs the results. The screen retains the waveform screen while the initialization is in progress. 5 Internal battery check Internal memory read check "0" is returned if both checks are successful, "1" if they are not. App
Index
IM AQ7277-17EN 4-5 4.3 Device-Specific Commands
ACQuire Group :ACQuire:AVERage:COUNt? Function Queries the current average count. The commands in this group deal with the waveform Syntax :ACQuire:AVERage:COUNt? acquisition. Change the measurement conditions through Example :ACQuire:AVERage:COUNt? -> remote control while the measurement is stopped. You :ACQ:AVER:COUN 0 cannot change the measurement conditions while realtime or averaging measurement is in progress. Only :REALtime: :ACQuire:AVERage:INDex STOP or AVERage:STOP is valid while the measurement is in Function Sets the average count or queries the current progress. setting. Syntax :ACQuire:AVERage :ACQuire:ATTenuation :INDex {AUTO|E2_10|E2_11…….E2_20} Function Sets the attenuation or queries the current setting. :ACQuire:AVERage:INDex? Syntax :ACQuire:ATTenuation {
4-6 IM AQ7277-17EN 4.3 Device-Specific Commands
:ACQuire:AVERage:STOP :ACQuire:DRANge 1 Function Stops the averaging measurement. Function Sets the distance range or queries the current Syntax :ACQuire:AVERage:STOP setting. Example :ACQuire:AVERage:STOP Syntax :ACQuire:DRANge {
IM AQ7277-17EN 4-7 4.3 Device-Specific Commands
:ACQuire:PWIDth :ACQuire:SMPinterval:DATA Function Sets the pulse width or queries the current setting. Function Sets the sampling interval or queries the current Syntax :ACQuire:PWIDth {
4-8 IM AQ7277-17EN 4.3 Device-Specific Commands
:ACQuire:SELection:DRANge? ANALysis Group 1 Function Queris the selectable distance range. The commands in this group deal with waveform analysis. Syntax :ACQuire:SELection:DRANge? Sample :ACQUIRE:SELECTION:DRANGE? -> :ANALysis:ASEarch:EXECute :ACQUIRE:SELECTION:DRANGE 500, Function Executes auto detection. 2 1000, … ,4000000 Syntax :ANALysis:ASEarch:EXECute Description The value that you can Example :ANALysis:ASEarch:EXECute specify varies depending on the wavelength setting. :ANALysis:ASEarch:NUMber? Function Queries the number of auto detection events. 3 The selectable distance range varies Syntax :ANALysis:ASEarch:NUMber? depending on the wavelength. Example :ANALysis:ASEarch:NUMber? -> Setting the distance range :ANAL:ASE:NUM 2 Auto: AUTO 4
500m: 500 :ANALysis:BCOefficient Commands 1km: 1000 Function Sets the backscattering light level of the current 2km: 2000 wavelength or queries the current setting. 5km: 5000 Syntax :ANALysis:BCOefficient {
IM AQ7277-17EN 4-9 4.3 Device-Specific Commands
:ANALysis:CURSor:DECibel? :ANALysis:EMARker:SET:Y2 Function Queries the cursor dB (decibel). Function Sets marker Y2 of the current event or queries the Syntax :ANALysis:CURSor:DECibel? current setting. Example :ANALysis:CURSor:DECibel? -> Syntax :ANALysis:EMARker:SET:Y2 :ANAL:CURS:DEC 32.878 :ANALysis:EMARker:SET:Y2? Example :ANALysis:EMARker:SET:Y2 :ANALysis:CURSor:LINK Function Sets the cursor link or queries the cursor link :ANALysis:EMARker:SET:Y2? -> setting. :ANAL:EMAR:SET:Y2 7.3777700E+03 Description The marker is set to the cursor position when you Syntax :ANALysis:CURSor:LINK {
4-10 IM AQ7277-17EN 4.3 Device-Specific Commands
:ANALysis:EVENt:IOR :ANALysis:EVENt:CURRent:CUMLoss? 1 Function Sets the section IOR of the current event or Function Retrieves the accumulated loss of the current queries the current setting. event. Syntax :ANALysis:EVENt:IOR {
Sample :ANALYSIS:EVENT:CURRENT:LOSS? -> Example :ANALYSIS:EVENT:CURRENT:UNITLOSS? -> Commands 2.000 2.000 Description The index number must be set ahead of time Description The index number must be set ahead of time with with the :ANALysis:EVENt:CURRent:INDex the :ANALysis:EVENt:CURRent:INDex command 5 command before using this command. before using this command.
:ANALysis:EVENt:FIX :ANALysis:EVENt:CURRent:TYPE? Function Event Fix Function Retrieves the event type of the current event. App Syntax :ANALysis:EVENt:FIX
IM AQ7277-17EN 4-11 4.3 Device-Specific Commands
:ANALysis:FMARker:DELete :ANALysis:FMARker:LEFT:LOSS? Function Deletes the marker. Function Queries the loss between markers 1 and 2. Syntax :ANALysis:FMARker:DELete Syntax :ANALysis:FMARker:LEFT:LOSS? Example :ANALysis:FMARker:DELete Example :ANALysis:FMARker:LEFT:LOSS? -> :ANAL:FMAR:LEFT :ANALysis:FMARker:LMTechnique Function Sets the approximation method of the marker or :LOSS 137.00000E-03 queries the current setting. :ANALysis:FMARker:LEFT:DISTance? Syntax :ANALysis:FMARker Function Queries the distance between markers 1 and 2. :LMTechnique {LSA|TPA} Syntax :ANALysis:FMARker:LEFT:DISTance? :ANALysis:FMARker:LMTechnique? Example :ANALysis:FMARker:LEFT:DISTance? -> Example :ANALysis:FMARker:LMTechnique LSA :ANAL:FMAR:LEFT :ANALysis:FMARker:LMTechnique? -> :DIST 490.20000E+00 :ANAL:FMAR:LMT TPA Description Least squares approximation: LSA :ANALysis:FMARker:LEFT:UNITloss? Function Queries the slope between markers 1 and 2. Two point approximation: TPA Syntax :ANALysis:FMARker:LEFT:UNITloss? Example :ANALysis:FMARker:LEFT:UNITloss? -> :ANALysi s:FMARker:LOSS? Function Queries the splice loss. :ANAL:FMAR:LEFT :UNIT 279.00000E-03 Syntax :ANALysis:FMARker:LOSS? Example :ANALysis:FMARker:LOSS? -> :ANALysis:FMARker:RIGHt:LOSS? :ANAL:FMAR:LOSS 162.00000E-03 Function Queries the loss between markers 2 and 3. Syntax :ANALysis:FMARker:RIGHt:LOSS? :ANALysis:FMARker:RETurnloss:VALue? Example Function Queries the return loss. :ANALysis:FMARker:RIGHt:LOSS? -> :ANAL:FMAR:RIGH Syntax :ANALysis:FMARker:RETurnloss:VALue? :LOSS -159.00000E-03 Example :ANALysis:FMARker:RETurnloss :VALue? -> :ANAL:FMAR:RET:VAL :ANALysis:FMARker:RIGHt:DISTance? 47.003000E+00 Function Queries the distance between markers 2 and 3. Syntax :ANALysis:FMARker:RIGHt:DISTance? :ANALysis:FMARker:RETurnloss: Example :ANALysis:FMARker:RIGHt SATurated? :DISTance? -> :ANAL:FMAR:RIGH Function Queries the saturation of the return loss. :DIST 232.95000E+00 Syntax :ANALysis:FMARker:RETurnloss :ANALysis:FMARker:RIGHt:UNITloss? :SATurated? Function Queries the slope between markers 2 and 3. Example :ANALysis:FMARker:RETurnloss Syntax :ANALysis:FMARker:RIGHt:UNITloss? :SATurated? -> :ANAL:FMAR:RET:SAT 1 Example Description Unsaturated: 0 :ANALysis:FMARker:RIGHt Saturated: 1 :UNITloss? -> :ANAL:FMAR:RIGH :UNIT -683.00000E-03 :ANALysis:FMARker:REFLection:VALue? Function Queries the reflection level. :ANALysis:FMARker:SET:M
4-12 IM AQ7277-17EN 4.3 Device-Specific Commands
:ANALysis:REFerence:DELete COMMunicate Group 1 Function Deletes the distance reference. The commands in this group deal with communications. Syntax :ANALysis:REFerence:DELete Example :ANALysis:REFerence:DELete :COMMunicate? Function Queries all settings related to communications. 2 :ANALysis:REFerence:DISTance Syntax Function Sets the distance reference or queries the current :COMMunicate? Example setting. :COMMUNICATE? -> :COM:HEAD 1;VERB 0 Syntax :ANALysis:REFerence:DISTance :COMMunicate:HEADer 3 :ANALysis:REFerence:DISTance? Function Sets whether to include a header in the response Example :ANALysis:REFerence:DISTance to a query or queries the current setting. :ANALysis:REFerence:DISTance? -> ANAL Syntax :COMMunicate:HEADer {
:ANALysis:THReshold:RLOSs Function Sets the threshold level of the return loss or queries the current setting. Syntax :ANALysis:THReshold:RLOSs {
:ANALysis:THReshold:SLOSs Function Sets the threshold level of the splice loss or queries the current setting. Syntax :ANALysis:THReshold:SLOSs {
:ANALysis:TRACefix:STATe Function Sets the tracefix or queries the current setting. Syntax :ANALysis:TRACefix: STATe {
IM AQ7277-17EN 4-13 4.3 Device-Specific Commands
DISPlay Group :DISPlay:DECibel:UPPer Function Sets the display start level or queries the current The commands in this group deal with the screen display. setting. Syntax :DISPlay:DECibel:UPPer {
4-14 IM AQ7277-17EN 4.3 Device-Specific Commands
:DISPlay:DIVide:DECibel :DISPlay:OVERview 1 Function Sets the vertical zoom rate or queries the current Function Sets overview display or queries the current setting. setting. Syntax :DISPlay:DIVide:DECibel {
Syntax :DISPlay:DIVide:DISTance {
:DISPlay:GTYPe Function Sets grid display or queries the current setting. Syntax :DISPlay:GTYPe {OFF|LINE|DOTS} :DISPlay:GTYPe? Example :DISPlay:GTYPe OFF :DISPlay:GTYPe? -> :DISP:GTYP 0 Description Disable: OFF Line: LINE Dots: DOTS
:DISPlay:IMARk Function Sets the marker information display or queries the current setting. Syntax :DISPlay:IMARk {
:DISPlay:ISCale Function Initializes the display scale. Syntax :DISPlay:ISCale Example :DISPlay:ISCale
IM AQ7277-17EN 4-15 4.3 Device-Specific Commands
FILE Group MENU Group
The commands in this group can be used to save event lists The commands in this group are used to set the function or and waveform data to files in CSV and other formats. marker mode or query the settings.
:FILE:CSV:EVENt:VALid :MENU:ERRor:CLEar Function Confirms if it is possible to make the csv format of Function Deleting the error dialog display the event list. Syntax :MENU:ERRor:CLEar Syntax :FILE:CSV:EVENt:VALid? Example :MENU:ERROR:CLEAR Sample :FILE:CSV:EVENT:VALID ON :MENU:FUNCtion :FILE:CSV:EVENt:GET Function Sets the function mode or queries the current Function Gets the CSV format of the event list. setting. Syntax :FILE:CSV:EVENt:GET? Syntax :MENU:FUNCtion {OTDR|TOP} Sample :FILE:CSV:EVENT:GET #812345678.... Description Block data format. :MENU:FUNCtion? Example :MENU:FUNCtion OTDR :FILE:CSV:TRACe:VALid :MENU:FUNCtion? -> :MENU:FUNC OTDR Function Confirms if it is possible to make the csv format of Description Top menu: TOP the trace data. OTDR: OTDR Syntax :FILE:CSV:TRACe:VALid? Sample :MENU:MARKer :FILE:CSV:TRACE:VALID ON Function Sets the marker mode or queries the current :FILE:CSV:TRACe:GET setting. Function Gets the CSV format of the trace data. Syntax :MENU:MARKer {TRACE|LINE} Syntax :FILE:CSV:TRACe:GET? :MENU:MARKer? Sample :FILE:CSV:TRACE:GET #812345678.... Example :MENU:MARKer TRACE Description Block data format. :MENU:MARKer? -> :MEN:MARK LINE
:FILE:SOR:VALid? Function Confirms if it is possible to make the SOR format of the trace data. Syntax :FILE:SOR:VALid
:FILE:SOR:GET? Function Gets the sor format of trace. Syntax :FILE:SOR:GET? Sample :FILE:SOR:VALid? -> :FILE:SOR:VALID #6123456ABCDEFGHJ1234567890 Description Block data format.
4-16 IM AQ7277-17EN 4.3 Device-Specific Commands
MISC Group :MISC:DATE:HOUR 1 Function Sets the hour or queries the current setting. The commands in this group deal with the date, time, Syntax :MISC:DATE:HOUR {
:MISC:RLOSsmode Function Sets the reflection display or queries the current setting. Syntax :MISC:RLOSsmode {NORMAL | NTT} :MISC:RLOSsmode? Sample :MISC:RLOSSMODE NORMAL :MISC:RLOSSMODE? -> :MISC:RLOSSMODE NTT Description Return loss: NORMAL Reflection: NTT
IM AQ7277-17EN 4-17 4.3 Device-Specific Commands
NETWork Group :NETWork:GATeway Function Sets the gateway or queries the current setting. The commands in this group can be used to set and query Syntax :NETWork:GATeway < network settings such as the IP address and user name. :NETWork:GATeway? Example :NETWORK:GATEWAY "255.255.255.0" :NETWork:CONTrol:PASSword Function Sets the Password or queries the current setting. :NETWORK:GATEWAY? -> Syntax :NETWork:CONTrol:PASSword :NETWORK:GATEWAY "255.255.255.0" Description It cannot be set if NETWork:STATe is turned OFF.
4-18 IM AQ7277-17EN 4.3 Device-Specific Commands SETup Group STATus Group 1 The commands in this group deal with the initialization of the The commands in the STATus group are used to make settings. You can reset the settings to factory default. settings and inquiries related to the communication status function. :SETup:INITialize 2 Function Initializes all the settings to factory default. :STATus? Function Queries all settings related to the communication status function. Syntax :STATus? 3 Example :STATUS? -> :STAT:QEN 1;QMES 1
:STATus:CONDition? Function Queries the contents of the condition register. 4 Syntax :STATus:CONDition? Example :STATUS:CONDITION? -> 16 Commands Description For details on the condition register, see section 5.4, "Condition Register." 5 :STATus:ERRor? Function Queries the error code and message information (top of the error queue). Syntax :STATus:ERRor? App Example :STATUS:ERROR? -> 113,"Undefined header"
:STATus:QENable Function Sets whether to store messages other than errors Index to the error queue or queries the current setting. Syntax :STATus:QENable {
:STATus:QMESsage Function Sets whether or not to attach message information to the response to the “:STATus:ERRor?” query or queries the current setting. Syntax :STATus:QMESsage {
IM AQ7277-17EN 4-19 4.3 Device-Specific Commands
WAVedata Group :WAVedata:SEND:STARt Function Sets the start distance of the wavedata or queries The commands in this group deal with the waveform data. the current setting. Syntax :WAVedata:SEND:STARt {
:WAVedata:OLDType:SEND? Function Queries the waveform data in Dot 4 format. Syntax :WAVedata:OLDType:SEND? Example :WAVedata:OLDType:SEND? -> #51000••• Description Block data format.
:WAVedata:SEND:ASCii? Function Queries the waveform data in ASCII format. Syntax :WAVedata:SEND:ASCii? Example :WAVedata:SEND:ASCii? -> 0.000,1.234,•••
:WAVedata:SEND:BINary? Function Queries the waveform data in binary format. Syntax :WAVedata:SEND:BINary? Example :WAVedata:SEND:BINary? -> #6123456ABCD••• Description Block data format.
4-20 IM AQ7277-17EN 4.3 Device-Specific Commands SYSTem Group 1 :SYSTem:REBoot Function Execution of restarting Syntax :SYSTem:REBoot Example :SYSTEM:REBOOT 2
3
4 Commands
5
App
Index
IM AQ7277-17EN 4-21 4.4 Condition Register
The condition register indicates the internal condition of the instrument.
Condition Register 15 14 13 12 11 10 9 8 76 5 4 3 2 1 0 :STATus:CONDition? 0 WRM 0 0 00 0 0 0 AR PC 0 AS 0 AVE REAL
The meaning of each bit of the condition register is as follows: Bit 0 REAL Set to 1 while the realtime measurement is in progress. Bit 1 AVE Set to 1 while the averaging measurement is in progress. Bit 3 AS Set to 1 while auto searching. Bit 5 PC Set to 1 while the plug is being checked. Bit 6 AR Set to 1 while the auto range measurement is in progress. Bit 14 WRM Set to 1 during warm-up.
4-22 IM AQ7277-17EN 4.5 Output Queue and Error Queue 1
Overview of the Output Queue 2 The output queue is provided to store responsemessages to queries. For example, when the :WAVeform:SEND? query is sent to request output of the acquired waveform, the response data will be stored in the output queue until it is read out.The example below 3 shows that data is stored recordby record in the output queue, and is read out oldestitem first, newest item last.
The output queue is emptied in the following cases (in addition to whenread-out is 4
performed). Commands •When a new message is received from thecontroller •When dead lock occurs (page 4-2) •When a device clear command (DCL or SDC) isreceived 5 •When power is turned ON again
The output queue cannot be emptied using the *CLS command. To see whether the App output queue is emptyor not, check bit 4 (MAV) of the status byte.
Index D2 D1 D1 D2
D1
Overview of the Error Queue The error queue stores the error No. and message when an error occurs. For example, if the controller sends an incorrect program message, the number,“113, “Undefined header”,” and the error message are stored in the error queue, when the error is displayed.The contents of the error queue can be read using the:STATus:ERRor? query. As with the output queue,messages are read oldest first, newest last (refer to theprevious page).If the error queue becomes full, the final message willbe replaced by message “350, “Queue overflow”.” The error queue is emptied in the following cases (inaddition to when read-out is performed). •When the *CLS command is received •When power is turned ON again To see whether the error queue is empty or not, checkbit 2 (EAV) of the status byte.
IM AQ7277-17EN 4-23 4.6 Error Messages
Error in Execution Code Message 50 *OPC/? exists in message. 102 Syntax error. 103 Invalid separator. 104 Data type error. 108 Parameter not allowed. 109 Missing parameter. 111 Header separator error. 112 Program mnemonic too long. 113 Undefined header. 114 Header suffix out of range. 120 Numeric data error. 123 Exponent too large. 124 Too many digits. 128 Numeric data not allowed. 131 Invalid suffix. 134 Suffix too long. 138 Suffix not allowed. 141 Invalid character data. 144 Character data too long. 148 Character data not allowed. 150 String data error. 151 Invalid string data. 158 String data not allowed. 161 Invalid block data. 168 Block data not allowed. 171 Invalid expression. 178 Expression data not allowed. 181 Invalid outside macro definition. 210 Communication not allowed during trace analysis 211 Communication not allowed during measurement. 221 Setting conflict. 222 Data out of range. 223 Data invalid 224 Illegal parameter value. 241 Hardware missing. 260 Expression error. 270 Macro error. 272 Macro execution error. 273 Improper macro label. 275 Macro definition too long. 276 Macro recursion error. 277 Macro redefinition not allowed. 278 Macro header not found. 350 Queue overflow. 410 Query INTERRUPTED. 420 Query UNTERMINATED. 430 Query DEADLOCKED. 440 Query UNTERMINATED after indefinite response.
4-24 IM AQ7277-17EN 4.6 Error Messages Code Message 1 500 The measurement condition is failed. Please reset ****** in SETTING menu. 501 Not executable during measurement. Please stop the measurement and execute again. 502 The measurement cannot be started during printing. Please either wait until the end of the printing or interrupt the printing. 503 The measurement cannot be started during the file operation. Please either interrupt the file operation or wait until the end 2 of the file operation. 504 The measurement could not be completed within the specified averaging duration. Please modify the averaging duration. 505 Hardware failed, and needs to be repaired. Please contact Yokogawa’s representatives. 506 Hardware failed, and needs to be repaired. Please contact Yokogawa’s representatives. 3 507 Hardware failed, and needs to be repaired. Please contact Yokogawa’s representatives. 508 Hardware failed, and needs to be repaired. Please contact Yokogawa’s representatives. 509 Hardware failed, and needs to be repaired. Please contact Yokogawa’s representatives. 560 When the event fix is ON, the distance reference setup cannot be performed. 4
800 This function is not supported. Commands 814 Failed network initialize. Please confirm network connection and setting. 816 Network setting is updated. Rebooting is required to reflect the changes. 817 Test Error occurred. 5 818 Test succeeded. 900 Backup data is damaged. this instrument starts up with the factory setting. 901 Optical connector is not correctly connected. Please clean and reconnect the connector again. App 909 The temperature inside the instrument is too high. The instrument may be damaged if it is kept using in this condition. The instrument will be powered off in 10 sec. Please do not power it on till the battery is cooled down. 910 The temperature inside the instrument is too low. The instrument may be damaged if it is kept using in this condition. The instrument will be powered off in 10 sec. Please do not power it on till the battery is cooled down. 911 The Voltage of AC power supply is too low. The instrument may be damaged if it is kept using in this condition. The Index instrument will be powered off in 10 sec. Please make sure of using the dedicated AC adapter. 912 The Voltage of AC power supply is too high. The instrument may be damaged if it is kept using in this condition. The instrument will be powered off in 10 sec. Please make sure of using the dedicated AC adapter. 917 The temperature inside the instrument is increasing. Please stop measuring, and wait for a while. 918 The temperature inside the instrument is too high. The measurement was aborted. Please power it off. 921 There is incoming light. Or, optical module may be damaged. 922 Incorrect date and time setting. Set the correct date and time. 923 The ambient temperature is out of range. The light source cannot be turned on. 925 Please use AC adapter.
IM AQ7277-17EN 4-25