Keysight Technologies N7373C Programmer's Manual

No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Keysight Technologies, as governed by United States and international copyright laws. Keysight Technologies, Deutschland GmbH Herrenberger Straße 130 71034 Böblingen, Germany. Manual Part Number 437xB-90A01 Edition Edition 2.0, February 2015 Subject Matter The material in this document is subject to change without notice. Keysight Technologies makes no warranty of any kind with regard to this printed material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Keysight Technologies shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material. Printing History New editions are complete revisions of the guide reflecting 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 find out the current revision of the guide, or to purchase an updated guide, contact your Keysight Technologies representative. Warranty This Keysight Technologies instrument product is warranted against defects in material and workmanship for a period of one year from date of shipment. During the warranty period, Keysight will, at its option, either repair or replace products that prove to be defective. For warranty service or repair, this product must be returned to a service facility designated by Keysight. Buyer shall prepay shipping charges to Keysight and Keysight shall pay shipping charges to return the product to Buyer. However, Buyer shall pay all shipping charges, duties, and taxes for products returned to Keysight from another country. Keysight warrants that its software and firmware designated by Keysight for use with an instrument will execute its programming instructions when properly installed on that instrument. Keysight does not warrant that the operation of the instrument, software, or firmware will 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 modification or misuse, operation outside of the environmental specifications for the product, or improper site preparation or maintenance. No other warranty is expressed or implied. Keysight Technologies specifically 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. Keysight Technologies shall not be liable for any direct, indirect, special, incidental, or consequential damages whether based on contract, tort, or any other legal theory. Assistance Product maintenance agreements and other customer assistance agreements are available for Keysight Technologies products. For any assistance contact your nearest Keysight Technologies Sales and Service Office. Certification Keysight Technologies certifies that this product met its published specifications at the time of shipment from the factory. Keysight Technologies further certifies that its calibration measurements are traceable to the United States National Institute of Standards and Technology, NIST, to the extent allowed by the Institutes’s calibration facility, and to the calibration facilities of other International Standards Organization members. ISO 9001 Certification Produced to ISO 9001 international quality system standard as part of our objective of continually increasing customer satisfac- tion through improved process control.

Transferring code from the 8703A/B to the Keysight N437x Series Lightwave Component Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 LCA System Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 How to configure the LCA for networking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 How to connect the LCA to your network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 How to change network settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Install the LCA Remote Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 How to use the LCA Remote Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Adding references to your project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Declare and create the required objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Basic structure of an LCA client application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Synchronous vs. Asynchronous Method Calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 LCA Remote Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 LCA remote control DLLs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Specific Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Interface structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Enumeration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Class LCAMeasParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Class LCAProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Interface ILCARemoteClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 General commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Measurement commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 The LCA SCPI Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Port Types . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Start/Stop the LCA SCPI Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 The LCA SCPI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Command Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 5

Remove all doubt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Phone or Fax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Keysight online information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Programming Examples 61 VEE Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Getting started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Description of the VEE-example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 VBA/Excel Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Warranty Information 79 Warranty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 6 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

N437xB Series Lightwave Component Analyzer 11 LCA System Configuration 12 How to configure the LCA for networking 12 How to connect the LCA to your network 12 How to change network settings 12 Install the LCA Remote Client 15 Synchronous vs. Asynchronous Method Calls 21 How to use the LCA Remote Client 16 Adding references to your project 16 Declare and create the required objects 18 Basic structure of an LCA client application 19 Troubleshooting 23 LCA Remote Programming 24 LCA remote control DLLs 24 LCA remote control DLLs 24 Specific Commands 25 Interface structure 25 Enumeration 26 Class LCAMeasParams 27 Class LCAProperties 30 Interface ILCARemoteClient 31 General commands 31 Measurement commands 34 Properties 40 The LCA SCPI Interface 43 43 43 Overview Port Types Configuration 45 Remote Operation

LCA SCPI Commands Command Details 48 Remote Operation 8 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

computer. The chapter covers how to write your own applications. The next chapter explains examples based on Keysight VEE and VBA/Excel in more detail. Note that applications for remote control can also be run on the LCA itself, which is useful for automated measurement procedures. The LCA is a remoting enabled, Microsoft .NET instrument that can be controlled across any LAN that can relay an http web page. The provided remote control client has an Active X interface and a .NET interface, so you can program the LCA from many established programming environments such as Visual Basic 6.0 and VBA, as well as from .NET enabled programming environments such as C#. The LCA uses .NET remoting as the foundation for its external communications. Remoting is the process of programs or distributed components interacting across different processes or machines. Beginning with the LCA software version 3.00.03 for Windows XP systems or 3.01.00 with Window 7, an SCPI interface is also available, which may be more comfortable for other environments like Labview. The SCPI interface can be used over either a LAN or USB port. This programming guide supports LCA models beginning with the B generation. These now include: N4373D, N7373C, N4373B, N4374B, N4375D, N4375B, N4376D and N4376B. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 9

Since the LCA interface does not provide any methods to set network analyzer related parameters or to retrieve measurement data from the network analyzer, most applications also need to program the network analyzer. The network analyzer’s native functions can be controlled either using SCPI or COM. We recommend using the COM interface. This is reflected in the programming examples. In .NET remoting, the server program publishes an object on a network channel and the client program subscribes to that channel when loading or connecting to that object. In the case of the LCA, a RemoteObject object is published to an http channel and the subscribing client program is the LCA RemoteClient. A Remoting server is embedded in the LCA Server application. The LCA RemoteClient is a layer of abstraction, which provides an easy to use interface with methods to control the LCA. The LCA Remote Client layer consists of 3 files, named "RemoteClient.dll", "RemoteObjects.dll" and "RemoteClient.tlb". These files are installed as part of the the LCA Remote Client installation package, together with a number of programming examples. Remote Operation 10 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

Lightwave Component Analyzer Tools are available to migrate code from the 8720 network analyzer to the new PNA network analyzer platform at www.keysight.com/find/nadisco The 8703A/B Lightwave Component Analyzers are based on the 8720 network analyzers, so you can use these code conversion tools to migrate existing code to the N437x Series LCA based on the PNA platform. Most of the code in a typical application for the 8703 LCA controls the functionality of the network analyzer. This part of the application can be migrated with these tools. The code related to LCA specific functionality has to be migrated by hand. While this chapter assumes you are familiar with your programming environment, it does not assume familiarity with controlling remote objects from within that environment. Examples are provided for VB.NET, C#, VB 6.0, VBA and Keysight VEE, which can be extrapolated to most environments for controlling the LCA. After installing the LCA Remote Client on your computer, you can find these examples in the folder: C:\Program Files (x86)\Agilent\Agilent LCA Remote Client\Examples The location on your computer depends on the folder in which you installed the LCA Remote Client. The Excel-VBA example pulls data directly from the LCA into Excel. This is very useful if you are setting up measurements manually, but want to analyze the results on your own computer. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 11

How to configure the LCA for networking Remote programming of the LCA with the .NET interface is only possible if the LCA is connected to a local area network (LAN) via the built-in LAN connector. When the LCA is connected to a network, it is also possible to connect it to network printers and remote servers, with access to shared folders and files. How to connect the LCA to your network The LCA comes configured for DHCP networking, and has a default machine name. In many cases, connecting the LCA to your LAN is simply a case of registering the machine name with your IT department. How to change network settings You can change the LCA network settings as needed so that it connects properly to your specific network. NOTE Do not connect the LCA to a network that is configured to automatically install software on network devices. Installing or overwriting files on the LCA computer system may impact the operation of the instrument. Please contact your network administrator or IT department to find out if you have this type of network. NOTE The LCA LAN connector supports 10 Base-T and 100 Base-T Ethernet networks using TCP/IP and other Microsoft supported networking protocols. The LCA uses Microsoft® Windows 7 or XP. NOTE Because your network settings are unique to your IT infrastructure, Keysight Technologies will not be able to assist you with connecting your instrument to your network. Please contact your network administrator or IT department for assistance. For more information, refer to the MS Windows resource kit (available from Microsoft) that is appropriate for your computer system. You can also refer to the online Help for Windows (Start > Help). NOTE Using the SCPI interface, the LCA can also be controlled from a USB port. Remote Operation 12 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

Microsoft® Windows functions. To view or change the computer machine name 1 On the Task bar, click Start, point to Settings, and then click Control Panel. 2 Double-click the System icon and click on the Computer Name tab. From here you can view or change the machine name. 3 When you have finished making changes, restart the instrument. To configure TCP/IP to use DNS or WINS 4 On the Task bar, click Start, point to Settings, and then click Network and Dial-up Connections. 5 Then click Local Area ConnectionProperties. 6 On the General tab (for a local area connection) or the Networking tab (all other connections), click Internet Protocol (TCP/IP), and then click Properties. From here, you can make all desired changes. NOTE By default, as the instrument starts up, you are logged on as an administrator with the logon name PNA-Admin. The login password, which is usually not needed, is "pna" for systems with Windows 7 or "agilent" for systems using Windows XP. Keysight only recommends using the LCA application while you are logged on as an administrator. NOTE If using a protocol other than TCP/IP, please contact your IT department for assistance. NOTE Editing your instrument’s protocols and file access permissions can result in unwanted behaviors that are difficult to reverse. Ensure that your changes are valid! NOTE Please consult with your network administrator concerning advanced TCP/IP and multi-protocol configuration settings to support your network. NOTE Please contact your network administrator or IT department if you have any problems connecting the LCA to your network. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 13

instrument. To configure TCP/IP for static or dynamic addressing • To get started, follow the same steps listed above. NOTE For more information, click Start > Help > Index, and search for “DNS” or “WINS” or “static” or “dynamic.” Remote Operation 14 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

The LCA Remote Client is described in “Overview” on page 6. 1 If not already installed, install the .NET Framework Version 2.0 from Microsoft. Go to www.microsoft.com and search for ‘How to get the Microsoft .NET framework’. Be sure to get the framework and all the service packs. Make sure that you get the framework, not the SDK (software development kit.) 2 The LCA CD shipped with the LCA contains the Remote Client Installation Package to install the LCA specific DLLs and the programming examples. The most recent version of the LCA Remote Client Installation Package is available from the Keysight web site (www.keysight.com/find/lca). • Insert the CD into the CD drive, use Windows Explorer to find LCA Remote Client Installer Folder, or • Start the downloaded installer. 3 If you want to program the network analyzer via its COM interface you need to install the PNAProxy. The installation executable “PNAProxy.exe” can be found on the network analyzer in the folder: C:\Program Files\Agilent\Network Analyzer\Automation Install the PNA Proxy by running the installation program “PNAProxy.exe” on your client machine. When asked to type in the host name or IP address of the remote network analyzer during installation, you do not need to type in anything. You can specify the host name or IP address during program development or execution. NOTE This installation is not for the LCA itself. (Applications using the remote programming commands can be run on the LCA itself without installing the remote client package.) Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 15

Here you can see the basic steps required to write an LCA client application. The code sequences presented here are in VB.NET syntax. For sequences in other languages like C#, VB 6.0, VBA or C++ refer to the different programming examples. You can find these examples in the “Examples” folder, in the “Keysight LCA Remote Client” installation folder. Since most client applications will also control the network analyzer for setting measurement parameters like start- and stop-frequency and for reading out the measurement data, we also show the basic steps required to control the network analyzer using its COM interface over LAN (DCOM). The network analyzer can also be programmed using its SCPI interface, but this is not covered here. For details about programming the network analyzer, please refer to the relevant network analyzer documentation. Adding references to your project In VB.NET, C#, VB 6.0 or VBA projects, you have to add references to the LCA Remote Client Library and to the PNAProxy type library (the network analyzer proxy, assuming you also want to program the network analyzer). The LCA Remtote Client implements two different interface technologies. • In environments which support .NET assemblies, we recommend using the LCA Remote Client .NET assembly directly. • If your programming environment does not support .NET assemblies, use the LCA Remote Client over its COM interface. Here we show how this is done in Microsoft Visual Studio 2005 using the LCA Remote Client .NET assembly directly. When using the COM interface, the basic structure is the same. For the differences, please check the VBA, VB 6.0 and C++ example projects, installed with the LCA Remote Client. 1 From the “Project” menu, select “Add Reference”. 2 Switch to the “Browse” tab. 3 Browse to your LCA Remote Client installation folder. Remote Operation 16 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

5 If you also want to use the network analyzer COM interface, please refer to the network analyzer documentation, including: http://na.support.keysight.com/pna/programming/ Because environments like VB 6.0 or VBA cannot work directly with .NET assemblies, you have to use the COM interface of the LCA Remote Client in such cases. 1 In VB 6.0, from the “Project” menu, select “References”. In VBA, open the “Tools” menu and select “References”. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 17

the following: 2 Select“Keysight Remote Client for the LCA”. Declare and create the required objects The LCA Remote Client defines • three interfaces ILCARemoteClient, ILCAMeasParams, ILCAProperties and • three classes, LCARemoteClient, LCAMeasParams and LCAProperties. Each of these classes implements the corresponding interface. To be able to use the LCA Remote Client, you have to create objects from these classes. ‘ Declare the objects Private lcaClient As Agilent.LCA.RemoteClient.LCARemoteClient Private lcaMeasParams As Agilent.LCA.RemoteClient.LCAMeasParams Private lcaProperties As Agilent.LCA.RemoteClient.LCAProperties …. ‘Create the objects lcaClient = New Agilent.LCA.RemoteClient.LCARemoteClient() lcaMeasParams = New Agilent.LCA.RemoteClient.LCAMeasParams() lcaProperties = New Agilent.LCA.RemoteClient.LCAProperties() Remote Operation 18 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

and create a network analyzer application object. This is quite different to the LCA. When working with the LCA you are creating a local LCA Remote Client object. The connection to the remote LCA server is done with the “Connect” command on the LCA Remote Client interface. When using the network analyzer over its COM interface, you are using DCOM and have to remotely activate the network analyzer interface. For examples on how this is done in different programming environments, see the programming examples installed with the LCA Remote Client. Here we show how this is done in VB.NET: ‘ Declare the object Private pnaClient As AgilentPNA835x.Application … Public Sub Open(ByVal serverName As String) ‘ the class-id of the AgilentPNA835x.Application class Dim clsID As System.Guid = New Guid( "16D3C697-5F97- 11D2-BC1F-0060B0B52EA7") Dim srvtype As System.Type = System.Type.GetTypeFromCLSID( clsID, serverName, True) ‘ now we connect to the remote PNA pnaClient = CType(System.Activator.CreateInstance(srvtype), AgilentPNA835x.IApplication9) End Sub For further details on programming the network analyzer, please refer to the relevant network analyzer documentation. Basic structure of an LCA client application When programming the LCA you have to follow this basic structure: 1 (optional) Set a time-out value lcaClient.SetTimeout(timout_ms) 2 Connect to the LCA server. lcaClient.Connect(serverName) Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 19

session. In the case of the LCA client, this is the GetLCAProperties command. lcaClient.GetLCAProperties(lcaProperties) 3 Open a session on the LCA, and check the return value of the Open() command. A return value False indicates that the Open() command has failed. lcaClient.Open() 4 All commands that change the state of the LCA require an active session opened on the LCA. All these commands have to be enclosed by Open() and Close() commands. Commands which do not change the state of the LCA, like reading properties, only require a passive session on the LCA. 5 When finished with working on the LCA, close the session lcaClient.Close() 6 Before leaving the application, make sure to call the Disconnect() command. This prevents unnecessary processing overhead on the LCA, needed to monitor and close inactive sessions. lcaClient.Disconnect() Remote Operation 20 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

A traditional remote control application consists of a list of actions that you send to the instrument, expecting it to execute them in that order and to tell you when it is done. This makes programming easy - you can do your whole measurement in a single function or sub-routine. In this approach you send the actions to the instrument in synchronous mode. This means that an action you send to the instrument blocks the program flow of the calling thread until it finishes. The advantage is that your program structure is very simple. The drawback is that you have to wait for the instrument to finish the action. For example this could lead to an unresponsive user interface. This can be solved using multithreading . Run the measurement sequence in a new thread while the main thread handles other things like running the user interface. A third possibility is to call potentially time consuming actions asynchronously. The LCA Remote Client lets you call some commands in asynchronous mode. This means that the call returns immediately, even before the action on the instrument has finished execution. In such cases you need an additional method to determine, when an action finishes. The LCA Remote Client offers two different methods to accomplish this. • The first is the property OperationComplete(). This property value is True, when the last asynchronously called operation on the LCA has finished execution. Otherwise the property value is False. • The other method is named WaitForOPC(). This method blocks program execution on the calling thread until the operation on the instrument finishes. Here are two short examples in VB.NET syntax, showing the usage of asynchronous calls: Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 21

oLCAClient.Init_OO(params, False) Do ‘ let the application handle events Application.DoEvents() System.Threading.Thread.Sleep(200) While oLCAClient.OperationComplete = False Using the WaitForOPC() command: oLCAClient.Init_OO(params, False) DoMyActionsAfterCallingInit() ‘ doing some other stuff ‘ When we are done with our own stuff, ‘ we need to wait for Init_OO to finish oLCAClient.WaitForOPC() Remote Operation 22 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

where the Open() call fails. This happens when a session on the LCA is already open. If there are no other applications using the LCA, the most likely reason is that an application finished without closing its session, for example when running an application in the debugger and you terminate it by stopping the debugger. The LCA and the LCA Remote Client have a heartbeat mechanism to detect abandoned sessions. The LCA checks for 60 seconds of inactivity. If nothing happens in this time, the LCA assumes the session has been abandoned and it closes this session, so that other clients are able to open a session. You may want to workaround this behavior during application development. There are two cases here. • If your client application halts on a breakpoint, the heartbeat is suspended, so if your application is suspended for more than 60 seconds, the server closes the session. When you try to continue execution, you get an error telling you that no session is open. To keep sessions open, start the LCA server on the network analyzer with the command-line parameter “NOAUTOCLOSE”. • If you are running into problems restarting your application because aborted sessions are still open, call CloseAll() before the Open() call. NOTE We recommend you only use these workarounds during development. Only use CloseAll() in environments where you are sure no other client could have a session opened. CloseAll() will close sessions from all the LCA clients. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 23

The LCA remote programming interface uses Microsoft.NET Remoting technology. It is controlled by manipulating the properties and methods exposed by the server object. The list of properties and methods in this section describe the interface that is available to a programmer wanting to program the LCA system in other applications. LCA remote control DLLs The LCA RemoteClient DLL provides a communication link with the LCA server. The DLLs are comprised of a set of properties, and methods that together provide a basic set of remote LCA capabilities. The two DLLs of interest are: RemoteClient.dll and RemoteObjects.dll. By default these two DLLs are installed to: C:\Program Files\Agilent\Agilent LCA Remote Control\. Remote Operation 24 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

LCAMeasParams, the LCAProperties and the LCARemoteClient. • The class LCAMeasParams summarizes all possible parameters of your measurement. • The class LCAProperties provides read-only properties, which give you some information about the network analyzer and the LCA. • The class LCARemoteClient provides the methods to connect to the LCA, perform measurements and change hardware settings. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 25

Enumeration Description ELaserState Enumerates the possible laser states, on or off. NotSet LaserOff LaserOn ELaserWvl Enumerates the possible laser wavelengths. NotSet Wvl_850nm Wvl_1310nm Wvl_1550nm EMeasMode Specify if you are doing single ended or differential measurements. Note: differential measurements require a 4-port network analyzer. NotSet SingleEnded Differential EMeasType Enumerates the different LCA measurement types NotSet EE EO OE OO EModBiasOpt Specify how often a modulator bias voltage optimization has to be performed. Once: only once when the laser is switched on. EverySweep: prior to each measurement started by the LCA. Continuous: the optimization loop runs continuously. NotSet Once EverySweep Continuous EOpticalInput Enumerates the optical inputs on the optical test head’s front panel. High power input is comparable to input 2 and standard to input 1. NotSet Standard HighPower ERFSwitch Enumerates the RF switches in a switched LCA system NotSet Source Receiver ERFSwitchState Enumerates the possible settings of the RF switches UnKnown Thru Intern Remote Operation 26 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide Possible values

parameters The following properties control additional optical path deembedding. Property Description Type Default value Wavelength_nm Specify with which laser wavelength the LCA will measure. Enum ELaserWvl NotSet OpticalPower_dBm Specify the optical output power of the LCA in dBm Double 0.0 HighPower_Input If you are using the high power optical input you have to set the HighPower_Input property to true. Boolean False MeasMode Specify if you want to do single ended or differential measurements Enum EMeasMode SingleEnded ModBiasOptimization Specify how often a modulator bias voltage optimization has to be performed Enum EModBiasOpt EverySweep Property Description Type Default value Advanced Enable the possibility to overwrite some of the default behavior of the LCA. In advanced mode you can force the LCA to switch the laser on or off independently of the measurement type. You also have additional Optical- and RF- path deembedding possibilities, or can apply additional deembedding on the receiver and the source side, independent of the measurement type. Boolean – if true, advanced features are active False Laser_On Switch the intern laser on or off. Note: The value of this property is only evaluated in advanced mode. In default mode the laser is switched on or off according to the measurement type. Boolean – if true, the laser is on True Property Description Type Default value UseOpticalConnData With this property you could switch the whole optical path deembedding on or off. Boolean False SrcAttOpt_dB Specify the optical attenuation on the source path in dB. In default mode only evaluated for O/E and O/O measurements. Double 0.0 RcvAttOpt_dB Specify the optical attenuation on the receiver path in dB In default mode only evaluated for E/O and O/O measurements. Double 0.0 Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 27

path deembedding. SrcRefIdx Specify the refractive index of the source path in dB. In default mode only evaluated for O/E and O/O measurements. Double 0.0 RcvRefIdx Specify the refractive index of the receiver path in dB. In default mode only evaluated for E/O and O/O measurements. Double 0.0 SrcLengthOpt_m Specify the geometrical length of the source path in m. In default mode only evaluated for O/E and O/O measurements. Double 0.0 RcvLengthOpt_m Specify the geometrical length of the receiver path in m. In default mode only evaluated for E/O and O/O measurements. Double 0.0 UseOpticalS2PFile Specify if you want to describe the optical paths by the parameters above or by transmission data stored in a s2p file. Only the S21 transmission data is used. Boolean False OptRcvFile The name of the s2p file to use for additional adaptor deembedding on the receiver side In default mode only evaluated for E/O and O/O measurements. String Empty string OptSrcFile The name of the s2p file to use for additional adaptor deembedding on the source side. In default mode only evaluated for O/E and O/O measurements. String Empty string Property Description Type Default value Property Description Type Default value UseElAdaptor With this property you could switch the whole electrical path deembedding on or off. Boolean False ElRcv1File The name of the s2p file to use for electrical adaptor deembedding. This property has to be used for receiver side deembedding in single ended measurements or for the receiver port with the lower number in differential measurements. String Empty string ElRcv2File The name of the s2p file to use for electrical adaptor deembedding. This property has to be used only for the receiver port with the higher number in differential measurements. String Empty string Remote Operation 28 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

deembedding. This property has to be used for source side deembedding in single ended measurements or for the source port with the lower number in differential measurements. String Empty string ElSrc2File The name of the s2p file to use for electrical adaptor deembedding. This property has to be used only for the source port with the higher number in differential measurements. String Empty string CalSetUserCal Name a Calset on the network analyzer which has to be used for the user calibration measurement. If an empty string is passed, the current calset is used. If “NONE” is passed, no calset is applied for the user calibration measurement. String Empty string Property Description Type Default value Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 29

Property Description Type Default value NWAModel The model number of the network analyzer String NumNWAPorts The number of ports of the network analyzer Integer NumOpticalInputs The number of optical inputs of the LCA test head Integer ProductNumber The product number of the LCA system String SerialNumber The serial number of the LCA system String SwitchedArchitecture True: LCA test head has a switched architecture, False: non switched architecture Boolean SoftwareVersion The version of the LCA server software String SourceWvl An array showing all available wavelengths of the LCA test head array ELaserWvl MaxPower_dBm An array holding the maximum optical output power values in dB. These values are correlated to the wavelength values in “SourceWvl” at the same position. array double MinPower_dBm An array holding the minimum optical output power values in dB. These values are correlated to the wavelength values in “SourceWvl” at the same position. array double Remote Operation 30 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

Create a connection to an LCA server application. An LCA client application can only have one open connection to an LCA server at any time. The LCA server could handle several open connections concurrently. Sub Disconnect () Closes the connection to the LCA server application Function IsConnected() As Boolean Checks if a connection to an LCA server already exists. Function Open () As Boolean Opens an active session on the LCA. All commands that change the state of the LCA require an active session. The LCA server allows only one active session at any time. Parameters: ByVal server As String Host name or IP address of the network analyzer where the LCA server is running. Return value: No return value. Parameters: No parameters. Return value: No return value. Parameters: No parameters. Return value: Boolean True: a connection to an LCA server exists False: no connection exists Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 31

active session. Function OpenPassive () As Boolean Opens an passive session on the LCA. All commands that just read settings from the LCA require at least an open passive session. Several passive sessions could be opened concurrently. Sub Close () Closes active session on the LCA. Sub ClosePassive () Closes passive session on the LCA. Sub CloseAll () Closes the active sessions on the LCA. Any measurements that are currently running are aborted. Parameters: No parameters. Return value: Boolean True: A session has been opened False: Opening a session failed Parameters: No parameters. Return value: Boolean True: A session has been opened False: Opening a session failed Parameters: No parameters. Return value: No return value. Parameters: No parameters. Return value: No return value. Remote Operation 32 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

successful Open() command. However, be careful not to disturb any other connected client applications. The LCA automatically closes abandoned sessions after some time (>60s) of inactivity. Sub ResetLCASystem () Restarts the LCA server. Open sessions are closed and running measurements are aborted. A restart is necessary, when the network analyzer application has been restarted or when the LCA testhead has been switched off while the LCA server was running. Sub GetLCAProperties (ByVal properties As RemoteClient.ILCAProperties) Read out the properties of the LCA system. Sub SetTimeout (ByVal timeout_ms As Integer) Set the timeout value for the .NET remoting. A value of 0 or -1 indicates an infinite timeout period, which is also the default value. The timeout value is set in the .NET remoting layer during execution of the “Connect” command. If you want to set a timeout value, you have to do this before calling the “Connect” command. Parameters: No parameters. Return value: No return value. Parameters: No parameters. Return value: No return value. Parameters: ByVal properties As RemoteClient.ILCAProperties The properties are written to this LCAProperties object Return value: No return value. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 33

you can also specify the timeout value in the LCARemoteClient constructor. When using the COM interface you could only use the default constructor, so you have to use this command to specify a non- default timeout value. Measurement commands Sub Init_EE (ByVal parameters As RemoteClient.ILCAMeasParams, ByVal sync As Boolean) Initializes the LCA for a EE measurement. Parameters: ByVal timeout_ms As Integer An integer that specifies the number of milliseconds to wait before a .NET remoting request times out Return value: No return value. Parameters: ByVal parameters As RemoteClient.ILCAMeasParams The measurement parameters for initialization Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. For synchronization use the synchronization methods WaitForOPC or OperationComplete Return value: No return value. Remote Operation 34 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

RemoteClient.ILCAMeasParams, ByVal sync As Boolean) Initializes the LCA for an EO measurement. Sub Init_OE (ByVal parameters As RemoteClient.ILCAMeasParams, ByVal sync As Boolean) Initializes the LCA for an OE measurement. Parameters: ByVal parameters As RemoteClient.ILCAMeasParams The measurement parameters for initialization Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. For synchronization use the synchronization methods WaitForOPC or OperationComplete Return value: No return value. Parameters: ByVal parameters As RemoteClient.ILCAMeasParams The measurement parameters for initialization Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. For synchronization use the synchronization methods WaitForOPC or OperationComplete Return value: No return value. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 35

RemoteClient.ILCAMeasParams, ByVal sync As Boolean) Initializes the LCA for an OO measurement. Parameters: ByVal parameters As RemoteClient.ILCAMeasParams The measurement parameters for initialization Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. For synchronization use the synchronization methods WaitForOPC or OperationComplete Return value: No return value. Remote Operation 36 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

RemoteClient.ILCAMeasParams, ByVal filename As String, ByVal sync As Boolean) Use this command instead of Init_OE if you want the LCA to load and use previously saved user calibration data. The loaded user calibration data will be used by the LCA until the next initialization command is called. See also: SaveUserCalData Sub LoadOETxCalData (ByVal parameters As RemoteClient.ILCAMeasParams, ByVal filename As String, ByVal sync As Boolean) Use this command instead of Init_OE if you want the LCA to load and use previously saved user calibration data. Parameters: ByVal parameters As RemoteClient.ILCAMeasParams The measurement parameters for initialization ByVal filename As String The name of the file containing the user calibration data Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. For synchronization use the synchronization methods WaitForOPC or OperationComplete Return value: No return value. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 37

the next initialization command is called. See also: SaveUserCalData Sub Measure (ByVal continuous As Boolean, ByVal sync As Boolean) Triggers a measurement on the LCA. If you call a continuous measurement while another measurement is running, the original measurement is stopped without starting a new measurement. If you call a single measurement while another measurement is running, this measurement is stopped and a new single measurement is started. It requires that one of the initialization routines above has been called. If no measurement type has been initialized, an “InvalidOperationException” is thrown. The type of the measurement is the one initialized by the last “Init_XX” or “LoadXXTxCalData” call. You should trigger your DUT measurements with this routine, as it takes care of optical DC power dependent deembedding and modulator bias voltage optimization. Parameters: ByVal parameters As RemoteClient.ILCAMeasParams The measurement parameters for initialization ByVal filename As String The name of the file containing the user calibration data Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. For synchronization use the synchronization methods WaitForOPC or OperationComplete Return value: No return value. NOTE Be careful when calling a continuous measurement in synchronous mode. Since the synchronous call blocks the program execution of the calling thread, you can't stop this measurement from the calling thread. It can only be stopped from another thread. Remote Operation 38 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

WaitForOPC or OperationComplete. Sub SaveUserCalData (ByVal filename As String) Save the measured user calibration data into a s2p-file. If no user calibration data has been measured during last OE or OO initialization, default values are stored. This command is only allowed when OE or OO measurement mode is inititalized. Sub Abort () Aborts a currently running measurement or initialization. Sub WaitForOPC () Waits until the last asynchronously called command has finished execution. Exceptions thrown during execution of an asynchronously called command could be caught when calling WaitForOPC() or OperationComplete(). Parameters: ByVal continuous As Boolean True: measurements are done continuously False (default): a single measurement is triggered Optional ByVal sync As Boolean True (default): the call is blocked until initialization is complete False: the call returns immediately. Return value: No return value. Parameters: ByVal filename As String The filename, where the data should be stored. Return value: No return value. Parameters: No parameters. Return value: No return value. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 39

Properties Reading these properties requires only a passive session, while setting these properties requires an active session. LaserWvl_nm As RemoteClient.ELaserWvl Get or set the current wavelength of the LCA optical output in nanometers. LaserPower_dBm As Double Get or set the current power of the LCA optical output in dBm LaserState As RemoteClient.ELaserState Get or set the current state of the LCA optical output OpticalInput As RemoteClient.EOpticalInput Get or set the current optical input of the LCA testhead Parameters: No parameters. Return value: No return value. Parameters: No parameters. Parameters: No parameters. Parameters: No parameters. Parameters: No parameters. Remote Operation 40 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

Setting the RF switches in the LCA testhead. With a non switched LCA system, setting this property has no effect. Trying to set this property to UnKnown, is ignored. Reading this property from a non switched system will always return UnKnown. RFPowerFwd_dBm As Double Gets or sets the RF power on the network analyzer ports for forward measurements. To set this property back to the factory defined default value, set it to Double.NaN or a value < - 200dBm. RFPowerRev_dBm As Double Gets or sets the RF power on the network analyzer ports for reverse measurements. To set this property back to the factory defined default value, set it to Double.NaN or a value < - 200dBm. ReadOnly OpticalDCPower_dBm As Double Get the actual optical DC power, measured by the optical powermeter built into the LCA testhead Parameters: ByVak RFSwich As RemoteClient.ERFSwitch The switch you want to read from or you want to set. Parameters: No parameters. Parameters: No parameters. Parameters: No parameters. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 41

RemoteClient.ILCAProperties See the command GetLCAProperties ReadOnly CurrentMeasType As RemoteClient.EMeasType Get the measurement type which has been initialized by the last call to one of the Init_XX commands or by one of the LoadXXTxCalData commands. ReadOnly OperationComplete As Boolean Get the operation status of the last asynchronously called command. Exceptions thrown during execution of an asynchronously called command could be caught when calling WaitForOPC() or OperationComplete(). Parameters: No parameters. Parameters: No parameters. Parameters: No parameters. Remote Operation 42 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

The LCA instrument is a combined instrument. It is a network analyzer with additional hardware and software to become the LCA. The network analyzer already offers a SCPI interface on different ports. Now the new LCA SCPI interface extends the existing LCA application. It is implemented with the Keysight Translator Framework and the LCA Remote Server. Each SCPI command is intercepted and linked to an LCA Remote Interface method. The LCA SCPI interface is not completely IEEE compliant. It only implements the most necessary common commands besides the application specific commands. Overview Port Types The LCA SCPI interface is available either on a network socket or on the device USB port. Other ports like GPIB are not supported. You may select and configure one of the available types. Using both ports in parallel is not supported. Socket Port The LCA SCPI talker/listener runs on port 5026. The network analyzer SCPI interface runs on port 5025. You may run both SCPI interfaces for the LCA and the network analyzer application in parallel, since they take different socket ports. USB Port The LCA system is an integrated system. The system has only one USB device port which can be used to control the application from a remote PC. Therefore you can use the USB port to control either the network analyzer via SCPI or the LCA application via SCPI. You can’t control both applications over the USB port at the same time. Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 43

the LCA functionality. Therefore if you only run the network analyzer and NOT the LCA SCPI interface, the USB device port is taken by the network analyzer SCPI talker/listener. When you first connect your PC with a USB cable to the LCA (combined instrument), you get the Network Analyzer identification string if you send the *IDN? query. If you start the LCA SCPI interface and configure it to run on the USB device port, you will get theidentification string for the LCA instrument when you send the *IDN? SCPI query. However, if you run the LCA SCPI interface on the socket port and have connected your PC via USB with the LCA instrument, the network analyzer identification string will still be returned. After a system reboot, the USB device port is always taken by the network analyzer SCPI interface by default. The LCA SCPI interface has to be started manually. If you run the LCA SCPI interface on the USB device port and want to switch to the socket port, you have to stop the LCA SCPI interface first, then change the configuration to socket port and save it. This action will restart the network analyzer application automatically, to reclaim the USB device port for the network analyzer. Now the LCA SCPI interface can be restarted with the new configuration. GPIB port The LCA SCPI interface doesn’t support the GPIB port. However you may control the network analyzer application through SCPI over the GPIB port. This gives you the possibility to control the instrument independent of LAN by controlling the LCA application through SCPI over USB and the network analyzer application through SCPI over GPIB. Remote Operation 44 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

either the LAN socket port 5026 or the USB device port. Run the Agilent.LCA.SCPI.Config.exe program or click on the LCA SCPI Configuration shortcut on the network analyzer macro list to select the preferred port. The LCA SCPI talker/listener runs on the socket port 5026 by default. The port is not selectable to avoid conflicts with the network analyzer SCPI interface, which runs on port 5025. For support purposes, you may turn the logging on or off. The logging stores all program outputs into a file. Note: it may fill up your hard disk if you run the SCPI interface in logging mode for a long time. When done with configuration, click the “Save Config” button to store all settings. After saving the settings, the LCA SCPI module will adopt the modified configuration when you click on the “Start SCPI” button. Configuration All LCA modules require the network analyzer application. It should always start after a system reboot automatically. If the network analyzer is not running, please start it manually. Like all other LCA modules, the LCA SCPI module does not start automatically. You have to start it manually. Use the Agilent.LCA.SCPI.Conf.exe program to start or stop the LCA SCPI interface. To launch this program, you may either use the LCA SCPI link in the network analyzer GUI macro list under utilities, or the shortcut LCA SCPI Interface on the desktop or in the program menu. Start/Stop the LCA SCPI Module Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 45

Interface methods and the Agilent Translator Framework. Therefore the LCA Server starts automatically when you start the LCA SCPI interface. When you click on the “Start SCPI” button on the SCPI configuration form, the Agilent Translator Framework starts and loads the Agilent.LCA.SCPI.Module. The LCA Server cannot handle more than one session. Therefor you can run either the LCA Measurement Setup application or the LCA SCPI interface, but not both in parallel. This is the same for the LCA Remote Client. It also connects to the LCA Server and therefore the SCPI interface cannot run at the same time. Overview The LCA SCPI commands do not fulfill the IEEE standard. They just offer a simple way to control the LCA application on a LAN dependent socket port or on a USB port. Except for the *IDN? and :SYST:ERR? Commands, there is always a direct relation between a SCPI command and a method or property of the LCA.Net Remote Interface. LCA SCPI Commands Command Tree *CLS [:LCA]:PNUMber? -> [:LCA]:SNUMber? -> [:LCA]:SOFTware:VERSion? -> :LOAD:OO:CALibration:NAME noquery “” :LOAD:OE:CALibration:NAME noquery “” :MEASurement:ABORt :MEASurement:CALData:SAVE noquery “” :MEASurement:CURRent:TYPE? -> :MEASurement:INITialize:EE :MEASurement:INITialize:EO :MEASurement:INITialize:OE :MEASurement:INITialize:OO :MEASurement:STARt Remote Operation 46 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

:NWA:PORT:NUMBer? -> *OPC? -> <0|1> as string :PARameter:ADVAnced:MODE /? -> <0|1> as string :PARameter:ELECtrical:PATH:DEEMbedding /? -> <0|1> as string :PARameter:ELECtrical:RECeiver:S2PFile[n] /? (index n = 1|2) :PARameter:ELECtrical:SOURce:S2PFile[n] /? -> (index n = 1|2) :PARameter:MEASurement:MODE /? -> :PARameter:MODUlator:BIAS:MODE /? :PARameter:OPTical:INPut:POWer:HIGH /? -> <0|1> as string :PARameter:OPTical:OUTput:POWer /? -> :PARameter:OPTical:PATH:DEEMbedding /? <0|1> as string :PARameter:OPTical:RECeiver:S2PFile /? -> :PARameter:OPTical:S2PFile:USE /? -> <0|1> as string :PARameter:OPTical:SOURce:S2PFile /? -> :PARameter:RECeiver:ATTenuation /? -> :PARameter:RECeiver:PATH:LENGth /? -> :PARameter:RECeiver:REFR:INDex /? -> :PARameter:SOURce:ATTenuation /? -> :PARameter:SOURce:POWer:STATe /? <0|1off|on > :PARameter:SOURce:PATH:LENGth /? -> :PARameter:SOURce:REFR:INDex /? -> :PARameter:USER:CALIbration:CALSet /? -> :PARameter:WAVelength /? -> :RF:POWer:FWD /? -> unit is dBm :RF:POWer:REVerse /? -> unit is dBm :RF:SWITch:STATe /? , :SOURce{n}:MAXPower? qonly -> , n = index of array :SOURce{n}:MINPower? qonly -> , n = index of array :SOURce:POWer /? -> {dBm} :SOURce:STATe /? :SOURce:WAVelength /? -> <1310|1550> as string :SOURce:WAVelength:ALL? qonly -> :THEAd:INPut:MODe /? ->< STD|HIGH> :THEAd:INPut:POWer? qonly unit is dBm :THEAd:INPut:NUMBers? qonly -> :THEAd:SWITched:ARCHitecture? qonly -> <0|1> Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 47

parameters: none response: none example: *cls Command: [:LCA]:PNUMber? syntax: [:LCA]:PNUMber? description: The product number of the LCA system parameters: none response: string C#: (property) ProductNumber example: :PNUM? -> N4373B Command: [:LCA]:SNUMber? syntax: [:LCA]:SNUMber? description: The serial number of the LCA system parameters: none response: string C C#: (property) SerialNumber example: :SNUMber? ->,MY49151038 Command: [:LCA]:SOFTware:VERSion? syntax: [:LCA]:SOFTware:VERSion? description: The version of the LCA server software parameters: none response string C#: (property) example :SOFT:VERS? -> 2.3.10.2 Command: syntax: description: parameters: response: C#: example: :LOAD:OO:CALibration:NAME :LOAD:OO:CALibration:NAME”” Use this command instead of Init_OO if you want the LCA to load and use previously saved user calibration data “” path and filename enclosed in double quotes none (method) LoadOOTxCalData :LOAD:OO:CAL:NAME “c:\temp\test.s2p” Command: syntax: description: parameters: response: C#: :LOAD:OE:CALibration:NAME :LOAD:OE:CALibration:NAME”” Use this command instead of Init_OE if you want the LCA to load and use previously saved user calibration data “” path and file name enclosed in double quotes none (method) LoadOETxCalData :LOAD:OE:CAL:NAME “c:\temp\test.snp” Command Details example: Remote Operation 48 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

parameters: none response: none C#: (method) Abort() example: :MEAS:ABOR Command: :MEASurement:CALData:SAVE syntax: :MEASurement:CALData:SAVE”” description: Save the measured user calibration data into a s2p-file. parameters: “” path and file name enclosed in double quotes response: none C#: (method) SaveUserCalData() example: :MEAS:CALD:SAVE “c:\temp\test.s2p” Command: syntax: description: parameters: response: C#: example: :MEASurement:CURRent:TYPE? :MEASurement:CURRent:TYPE? Get the measurement type that has been initialized by the last call to one of the :MEAS:INIT XX commands or by one of the.:LOAD:XX: commands. none NotSet | EE | EO | OE | OO (method) CurrentMeasType() :MEAS:CURR:TYPE? -> OO Command: :MEASurement:INITialize:EE syntax: :MEASurement:INITialize:EE description: Initializes the LCA for an EE measurement parameters: none response: none C#: (method) Init_EE() example: :MEAS:INIT:EE command: :MEASurement:INITialize:EO syntax: :MEASurement:INITialize:EO description: Initializes the LCA for an EO measurement. parameters: none response: none C#: (method) Init_EO() example: :MEAS:INIT:EO command: :MEASurement:INITialize:OE syntax: :MEASurement:INITialize:OE description: Initializes the LCA for an OE measurement parameters: none response: none C#: (method) Init_OE example: :MEAS:INIT:OE command: :MEASurement:INITialize:OO syntax: :MEASurement:INITialize:OO description: Initializes the LCA for an OO measurement parameters: none response: none C#: (method) Init_OO() example: :MEAS:INIT:OO command: :MEASurement:STARt syntax: MEASurement:STARt[SINGle|CONTinuous] Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 49

while another measurement is running, the original measurement is stopped without starting a new measurement SINGle | CONTinuous none (method) Measure() :MEAS:STAR CONT command: :NWA:MODel? syntax: :NWA:MODel? description: The model number of the network analyzer parameters: none response: string C#: (property) NWAModel example: :NWA:MOD? -> N5245A command: :NWA:PORT:NUMBer? syntax: :NWA:PORT:NUMBer? description: The number of network analyzer ports parameters: none response: integer C#: (property) NumNWAPorts example: :NWA:PORT:NUMBer? -> 4 command: *OPC? syntax: *OPC? description: Retrieves the operation complete state parameters: none response: 0 | 1 C#: (method) OperationComplete() example: *OPC? -> 1 command: syntax: description: parameters: response: C#: example: :PARameter:ADVAnced:MODE? :PARameter:ADVAnced:MODE? Returns 1 if advanced mode is enabled. In advanced mode you can force the LCA to switch the laser on or off, independent of the measurement type. You also have additional optical- and RF- path de-embedding possibilities, or can apply additional de- embedding on the receiver and the source side, independent of the measurement type. none 0 | 1 (property) Advanced :PAR:ADVA:MODE? -> 0 command: syntax: description: parameters: response: C#: example: :PARameter:ADVAnced:MODE :PARameter:ADVAnced:MODEON | OFF | 1 | 0 Enables or disables advance mode, which allows changing some default settings. In advanced mode you can force the LCA to switch the laser on or off, independent of the measurement type. You also have additional optical- and RF-path de-embedding possibilities, or can apply additional de-embedding on the receiver and the source side, independent of the measurement type. ON | OFF | 1 | 0 none (property) Advanced :PAR:ADVA:MODE ON Remote Operation 50 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

electrical path de-embedding is switched on or off. none 1 | 0 (property)UseElAdaptor :PAR:ELEC:PATH:DEEM? -> 0 command: syntax: description: parameters: :PARameter:ELECtrical:PATH:DEEMbedding :PARameter:ELECtrical:PATH:DEEMbeddingON|OFF|1|0 Sets the property which enables or disables the whole electrical path de- embedding . ON | OFF | 1 | 0 response: C#: example: none (property)UseElAdaptor :PAR:ELEC:PATH:DEEM OFF command: syntax: description: parameters: response: C#: example: :PARameter:ELECtrical:RECeiver:S2PFile[1 - 2]? :PARameter:ELECtrical:RECeiver:S2P:FILE[1 - 2]:NAME? Gets the name of the s2p file to use for electrical adaptor de-embedding. File index 1 has to be used for receiver side de-embedding in single-ended measurements or for the receiver port with the lower number in differential measurements. Index 2 has to be used only for the receiver port with the higher number in differential measurements none (property) ElRcv1File / ElRcv2File :PAR:ELEC:REC:S2PFile? -> c:\temp\test.s2p command: syntax: description: parameters: response: C#: example: :PARameter:ELECtrical:RECeiver:S2PFile[1 - 2] :PARameter:ELECtrical:RECeiver:S2P:FILE[1 - 2]:NAME“” Sets the name of the s2p file to use for electrical adaptor de-embedding. File index 1 has to be used for receiver side de-embedding in single-ended measurements or for the receiver port with the lower number in differential measurements. Index 2 has to be used only for the receiver port with the higher number in differential measurements “” path and file name none (property) ElRcv1File / ElRcv2File :PAR:ELEC:REC:S2PFile“c:\temp\test.s2p” Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 51

:PARameter:ELECtrical:SOURce:S2PFile[[ 1- 2]:NAME? Gets the name of the s2p file to use for electrical adaptor de-embedding. This property has to be used with file index 1 for source side de- embedding in single-ended measurements or for the source port with the lower number in differential measurements. Index 2 is the file for the source port with the higher number in differential measurements. none path and file name (property) ElSrc1File / ElSrc2File :PARameter:ELECtrical:SOURce:S2PFile1? -> c:\temp\test.s2p command: syntax: description: parameters: response: C#: example: :PARameter:ELECtrical:SOURce:S2PFile[ 1 - 2] :PARameter:ELECtrical:SOURce:S2PFile[[ 1- 2]“” Sets the name of the s2p file to use for electrical adaptor de- embedding. This property has to be used with file index 1 for source side de-embedding in single-ended measurements or for the source port with the lower number in differential measurements. Index 2 is the file for the source port with the higher number in differential measurements “” path and file name none (property) ElSrc1File / ElSrc2File :PARameter:ELECtrical:SOURce:S2PFile1 “c:\temp\test.s2p” command: :PARameter:MEASurement:MODE? syntax: :PARameter:MEASurement:MODE? description: Returns setting for selecting single-ended or differential measurements parameters: none response: DIFFerential|SINGleended | NOTSet C#: (property) MeasMode example: :PAR:MEAS:MODE? -> NotSet command: :PARameter:MEASurement:MODE syntax: :PARameter:MEASurement:MODEDIFFerential|SINGleended|NOTSet description: Specify single ended or differential measurements parameters: DIFFerential|SINGleended | NOTSet response: none C#: (property) MeasMode example: :PAR:MEAS:MODE SING command: :PARameter:MODUlator:BIAS:MODE? syntax: :PARameter:MODUlator:BIAS:MODE? description: Returns how often a modulator bias voltage optimization will be performed parameters: response: C#: example: none Continuous|EverySweep|Once (property) ModBiasOptimization :PAR:MODU:BIAS:MODE? -> EverySweep Remote Operation 52 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

parameters: CONTinuous|EVERysweep|ONCE response: none C#: (property) ModBiasOptimization example: :PAR:MODU:BIAS:MODE EVER command: :PARameter:OPTical:INPut:POWer:HIGH? synstax: :PARameter:OPTical:INPut:POWer:HIGH? description: Returns the state of the high power input property. parameters: none response: 1 | 0, input power high true = 1, false = 0 C#: (property) HighPower_Input example: :PAR:OPT:INP:POWer:HIGH? -> 0 command: :PARameter:OPTical:INPut:POWer:HIGH syntax: :PARameter:OPTical:INPut:POWer:HIGHON|OFF|1|0 description: Gets the state of the high power input property. parameters: ON | 1 enables high power input, OFF | 0 disables high power input response: none C#: (property) HighPower_Input example: :PAR:OPT:INP:POWer:HIGH ON command: :PARameter:OPTical:OUTput:POWer? synstax: :PARameter:OPTical:OUTput:POWer? description: Returns the optical output power of the LCA in dBm. parameters: none response: power value, the default unit is dBm. C#: (property) OpticalPower_dBm example: :PAR:OPT:OUT:POWer -> -1 command: :PARameter:OPTical:OUTput:POWer synstax: :PARameter:OPTical:OUTput:POWer description: Specify the optical output power of the LCA in dBm. parameters: power , power value in dBm response: none. C#: (property) OpticalPower_dBm example: :PAR:OPT:OUT:POWer -1 command: :PARameter:OPTical:PATH:DEEMbedding? synstax: :PARameter:OPTical:PATH:DEEMbedding? description: Returns whether the whole optical path de-embedding is set on or off. parameters: none response: 1 = optical path de-embedding is enabled, 0 = disabled C#: (property) UseOpticalConnData example: :PAR:OPT:PATH:DEEM? -> 1 command: :PARameter:OPTical:PATH:DEEMbedding syntax: :PARameter:OPTical:PATH:DEEMbeddingON|1|OFF|0 description: Switches the whole optical path de-embedding on or off. parameters: ON | 1 = enabled optical path de-embedding, OFF | 0 = disable response: none C#: (property) UseOpticalConnData example: :PAR:OPT:PATH:DEEM? -> 1 Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 53

embedding on the receiver side. In default mode, only evaluated for E/O and O/O measurements. none path and file name (property) OptRcvFile :PAR:OPT:REC:S2PF? -> c:\temp\test1.s2p command: syntax: description: parameters: response: C#: example: :PARameter:OPTical:RECeiver:S2PFile :PARameter:OPTical:RECeiver:S2PFile”” Sets the name of the s2p file which is used for additional adaptor de- embedding on the receiver side. In default mode only evaluated for E/O and O/O measurements. “” file name and path enclosed in double quotes none (property) OptRcvFile :PAR:OPT:REC:S2PF “c:\temp\test1.s2p” command: syntax: description: parameters: response: C#: example: :PARameter:OPTical:S2PFile:USE? :PARameter:OPTical:S2PFile:USE? Returns whether the optical paths are described by transmission data stored in an s2p file. Only the S21 transmission data is used none 1 = s2p file use enabled, 0 = disabled (property) UseIOpticalS2PFile :PAR:OPT:S2PF:USE? -> 0 command: syntax: description: parameters: response: C#: example: :PARameter:OPTical:S2PFile:USE :PARameter:OPTical:S2PFile:USEON|1|OFF|0 enables or disables description of the optical paths by transmission data stored in an s2p file. Only the S21 transmission data is used ON | 1 = s2p file use enabled, OFF | 0 = disabled none (property) UseIOpticalS2PFile :PAR:OPT:S2PF:USE ON command: syntax: description: parameters: response: C#: example: :PARameter:OPTical:SOURce:S2PFile? :PARameter:OPTical:SOURce:S2PFile? Retrieves the name of the s2p file to use for additional adaptor de- embedding on the source side. In default mode only evaluated for O/E and O/O measurements. none file name and path of the s2p file on the LCA system. (property) OptSrcFile :PAR:OPT:SOUR:S2PF? -> c:\temp\test1.s2p command: synstax: :PARameter:OPTical:RECeiver:S2PFile? :PARameter:OPTical:RECeiver:S2PFile? Remote Operation 54 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

embedding on the source side. In default mode only evaluated for O/E and O/O measurements. “” the file name and path enclosed in double quotes. file name and path of the s2p file on the LCA system. (property) OptSrcFile :PAR:OPT:SOUR:S2PF “c:\temp\test1.s2p” command: syntax: description: parameters: response: C#: example: :PARameter:RECeiver:ATTenuation? :PARameter:RECeiver:ATTenuation? Retrieves the optical attenuation on the receiver path. In default mode only evaluated for E/O and O/O measurements none attenuation value, default unit is dB (property) RcvAttOpt_dB :PAR:REC:ATT? -> 3 command: syntax: description: parameters: response: C#: example: :PARameter:RECeiver:ATTenuation :PARameter:RECeiver:ATTenuation Specifies the optical attenuation on the receiver path. In default mode only evaluated for E/O and O/O measurements attenuation attenuation value, default unit is dB none (property) RcvAttOpt_dB :PAR:REC:ATT 2 command: syntax: description: parameters: response: C#: example: :PARameter:RECeiver:PATH:LENGth? :PARameter:RECeiver:PATH:LENGth? Retrieves the geometrical length of the receiver path in m. In default mode only evaluated for E/O and O/O measurements none The path length value, default unit is meter. (property) RcvLengthOpt_m :PAR:REC:PATH:LENG? -> 0.3 command: syntax: description: parameters: response: C#: example: :PARameter:RECeiver:PATH:LENGth :PARameter:RECeiver:PATH:LENGth Specifies the geometrical length of the receiver path in m. In default mode only evaluated for E/O and O/O measurements length path length value, default unit is meter. none. (property) RcvLengthOpt_m :PAR:REC:PATH:LENG 0.45 command: syntax: description: parameters: response: example: :PARameter:RECeiver:REFR:INDex? :PARameter:RECeiver:REFR:INDex ? Retrieves the refractive index of the receiver path in dB. In default mode only evaluated for E/O and O/O measurements. none the refractive index value, unit is dB. (property) RcvRefIdx :PAR:REC:REFR:IND? -> 0 Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 55

In default mode only evaluated for E/O and O/O measurements. index the receiver refractive value, unit id dB. none (property) RcvRefIdx :PAR:REC:REFR:IND 1.3 command: syntax: description: parameters: response: C#: example: :PARameter:SOURce:ATTenuation? :PARameter:SOURce:ATTenuation? Retrieves the optical attenuation on the source path. In default mode only evaluated for O/E and O/O measurements. none attenuation value in dB (property) SrcAttOpt_dB :PAR:SOUR:ATT? -> 0 command: syntax: description: parameters: response: C#: example: :PARameter:SOURce:ATTenuation :PARameter:SOURce:ATTenuation Specifies the optical attenuation on the source path. In default mode only evaluated for O/E and O/O measurements. attenuation attenuation value in dB none (property) SrcAttOpt_dB :PAR:SOUR:ATT 0.4 command: syntax: description: parameters: response: C#: example: :PARameter:SOURce:POWer:STATe? :PARameter:SOURce:POWer:STATe? Retrieves the internal laser state, on or off. Note: the value of this property is only evaluated in advanced mode. In default mode the laser is switched on or off according to the measurement type. none 1 = internal laser is on, 0 = internal laser is off (property) Laser_On :PAR:SOUR:POW:STAT? -> 1 command: :PARameter:SOURce:POWer:STATe syntax: :PARameter:SOURce:POWer:STATeON|1|OFF|0 description: parameters: response: C#: example: Switches the internal laser on or off. Note: The value of this property is only evaluated in advanced mode. In default mode the laser is switched on or off according to the measurement type ON | 1 to switch the laser on, OFF | 0 to switch the laser off none (property) Laser_On :PAR:SOUR:POW:STAT ON command: syntax: description: parameters: response: C#: example: :PARameter:SOURce:PATH:LENGth? :PARameter:SOURce:PATH:LENGth? Retrieves the geometrical length of the source path in m . In default mode only evaluated for O/E and O/O measurements .none the path length in meter SrcLengthOpt_m :PAR:SOUR:PATH:LENG? -> 0.27 Remote Operation 56 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

default mode only evaluated for O/E and O/O measurements length the path length value, default unit is meter. none SrcLengthOpt_m :PAR:SOUR:PATH:LENG 0.42 command: syntax: description: parameters: response: C#: example: :PARameter:SOURce:REFR:INDex? :PARameter:SOURce:REFR:INDex? Retrieves the refractive index of the source path in dB. In default mode only evaluated for O/E and O/O measurements. none the refractive index (property) SrcRefIdx :PAR:SOUR:REFR:IND? -> 0 command: syntax: description: parameters: response: C#: example: :PARameter:SOURce:REFR:INDex :PARameter:SOURce:REFR:INDex Specifies the refractive index of the source path in dB. In default mode only evaluated for O/E and O/O measurements. index the refractive index value in dB none (property) SrcRefIdx :PAR:SOUR:REFR:IND 0.13 command: syntax: description: parameters: response: C#: example: :PARameter:USER:CALIbration:CALSet? :PARameter:USER:CALIbration:CALSet? Retrieves the name of a Calset on the network analyzer to be used for the user calibration measurement. If an empty string is returned, the current Calset is used. If “NONE” is returned, no Calset is applied for the user calibration measurement. none NONE | path and file name (property) CalSetUserCal :PAR:USER:CAL:CALS? -> c:\temp\calset1.s2p command: syntax: description: parameters: response: C#: example: :PARameter:USER:CALIbration:CALSet :PARameter:USER:CALIbration:CALSet[NONE | “”] Specifies the name of a Calset on the network analyzer to be used for the user calibration measurement. If an empty string is passed, the current Calset is used. If “NONE” is passed, no Calset is applied for the user calibration measurement. NONE| |No argument, None or the path and file name surrounded by double quotes. none (property) CalSetUserCal :PAR:USER:CAL:CALS “c:\temp\calset1.s2p” command: :PARameter:WAVelength? syntax: :PARameter:WAVelength? description: Returns the laser wavelength set on the LCA. parameters: none response: The wavelength and unit as a string. C#: example: (property) Wavelength_nm :PAR:WAV? -> Wvl_1550nm Remote Operation Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 57

parameters: 850 | 1310 | 1550 response: none C#: (property) Wavelength_nm example: :PAR:WAV 1550 command: :RF:POWer:FWD? syntax: :RF:POWer:FWD? description: Gets the RF power on the network analyzer ports for forward measurements parameters: none response: forward power value in dBm C#: (property) RFPowerFwd_dBm example: :RF:POWer:FWD? -> -8 command: :RF:POWer:FWD syntax: :RF:POWer:FWD description: Sets the RF power on the network analyzer ports for forward measurements parameters: power forward power value in dBm response: none C#: (property) RFPowerFwd_dBm example: :RF:POWer:FWD -1 command: :RF:POWer:REVerse? syntax: :RF:POWer:REVerse? description: Gets the RF power on the network analyzer ports for reverse measurements. parameters: none response: RF reverse power value in dBm. C#: (property) RFPowerRev_dBm example: :RF:POW:REV? -> -8 command: syntax: description: parameters: response: C#: example: :RF:POWer:REVerse :RF:POWer:REVerse Sets the RF power on the network analyzer ports for reverse measurements. To set this property back to the factory defined default value, set it to Double.NaN or a value < -200dBm. power RF reverse power value in dBm. none (property) RFPowerRev_dBm :RF:POW:REV -4 command: syntax: description: parameters: response: C#: example: :RF:SWITch:STATe? :RF:SWITch:STATe? Retrieves the RF switch settings in the LCA test-head. With a non- switched LCA system, setting this property has no effect.. Reading this property from a non-switched system will always return Unknown. none NotSet | Receiver | Source , Intern | Thru | Unknown (property) RFSwitchState :RF:SWIT:STAT? -> NotSet, Unknown command: syntax: description: parameters: response: C#: example: :RF:SWITch:STATe :RF:SWITch:STATeREC|SOUR,INT|THRU Setting the RF switches in the LCA testhead. With a non switched LCA system, setting this property has no effect. Trying to set this property to UnKnown, is ignored. Setting this property for a non switched system will stay UnKnown. RECeiver | SOURce , INTern, THRU none (property) RFSwitchState :RF:SWIT:STAT REC,INT Remote Operation 58 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

maximum power for an index n corresponds to the wavelength value from :SOUR:WAV:ALL? at position n. none The maximum power value in dBm. For an invalid index it returns -200 and there is an entry in the error queue. See :SYST:ERR?. (property) MaxPower_dBm :SOUR:MAXP? -> 6 command: syntax: description: parameters: response: C#: example: :SOURce[1 – n]:MINPower? :SOURce[1 – n]:MINPower? Retrieves the minimum optical output power value in dBm. The minimum power for an index n corresponds to the wavelength value from :SOUR:WAV:ALL at position n. none The minimum power value in dBm. For an invalid index it returns -200 and there is an entry in the error queue. See :SYST:ERR?. (property) MimPower_dBm :SOUR:MINP? -> -1 command: :SOURce:POWer? syntax: :SOURce:POWer? description: Gets the current power of the LCA optical output in dBm parameters: none response: Laser power value in dBm. C#: (property) LaserPower_dBm example: :SOUR:POW? -> 5.00375 command: :SOURce:POWer syntax: :SOURce:POWer description: Sets the current power of the LCA optical output in dBm parameters: power Laser power value in dBm response: .none C#: (property) LaserPower_dBm example: :SOUR:POW 2.45 command: :SOURce:STATe? syntax: :SOURce:STATe? description: Gets the current state of the LCA optical output. parameters: none response: LaserOn | LaserOff C#: (property) LaserState example: :SOUR:STAT? -> LaserOn command: :SOURce:STATe syntax: :SOURce:STATeON|OFF|1|0 description: Sets the current state of the LCA optical output. parameters: ON | 1 | OFF | 0 response: none C#: (property) LaserState example: :SOUR:STAT ON command: syntax: :SOURce[1 – n]:MAXPower? :SOURce[1 – n]:MAXPower? command: syntax: description: parameters: response: C#: example: :SOURce:WAVelength? :SOURce:WAVelength? Gets the current wavelength of the LCA optical output. none The wavelength as string together with the unit. (property) LaserWavelength_nm :SOUR:WAV? ->

parameters: none response: comma separated list of wavelengths units. C#: (property) SourceWvl example: : SOUR:WAV:ALL? -> Wvl_1310nm, Wvl_1550nm command: :THEAd:INPut:MODe? syntax: :THEAd:INPut:MODe? description: Gets the current optical input of the LCA test-head. parameters: none response: Standard | HighPower C#: (property) OpticalInput example: THEA:INP:MODE? -> Standard command: :THEAd:INPut:MODe syntax: :THEAd:INPut:MODeSTAN|HIGH description: Sets the current optical input of the LCA test-head. parameters: HIGH | STANdard response: none C#: (property) OpticalInput example: THEA:INP:MODE HIGH command: syntax: description: parameters: response: C#: example: :THEAd:INPut:POWer? :THEAd:INPut:POWer? Gets the actual optical DC power, measured by the optical power meter built into the LCA test-head. none the power value in dBm. (property) OpticalDCPower_dBm :THEA:INP:POW? -> -40.3798 command: :THEAd:INPut:NUMBers? syntax: :THEAd:INPut:NUMBers? description: Gets the number of optical inputs of the LCA test-head parameters: none response: number of optical inputs. C#: (property) NumOpticalInputs example: :THEA:INP:NUMB? -> 2 command: syntax: description: parameters: response: C#: example: :THEAd:SWITched:ARCHitecture? :THEAd:SWITched:ARCHitecture? Gets the LCA test-head architecture. True: LCA test head has switched, False: non-switched architecture. none 0 = false or 1 = true (property) SwtichedArchitecture :THEA:SWIT:ARCH? -> 0 command: syntax: description: parameters: response: C#: example: :SOURce:WAVelength :SOURce:WAVelength Sets the current wavelength of the LCA optical output. The available wavelengths can be retrieved with :SOUR:WAV:ALL? wavelength the wavelength value as string, unit is nm e. g. 1550. none (property) LaserWavelength_nm :SOUR:WAV 1550 Remote Operation 60 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

62 Getting started 62 Description of the VEE-example 70 VBA/Excel Programming Example 74 Further programming examples are installed with the LCA Remote Client in the folder C:\Program Files (x86)\Agilent\Agilent LCA Remote Client\Examples The location on your computer depends on the folder in which you installed the LCA Remote Client. Programming Examples

Keysight VEE is a Visual Engineering Environment that allows you to program by creating intuitive “block diagrams.” You select and edit objects from pull-down menus and connect them to each other by wires to specify the program’s flow, mimicking the order of tasks you want to perform. This makes it easy to get useful results in a short time and in only a few steps. Getting started Starting a complete measurement means interacting • over the .NET interface with the LCA and • over the COM interface with the network analyzer. Programming Examples 62 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

If your version of VEE version can use .NET assemblies, we recommend you reference the LCA Remote Client .NET assembly directly, as described here. If you have an older version of VEE which cannot use .NET assemblies, you need to reference the Active X interface of the LCA Remote Client. This is not described here, but is similar to referencing the PNAProxy, which is described later in this example. 1 After having opened VEE, in the “Device” menu, select “.NET Assembly References”. Figure 2 Calling the .NET Assembly references Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 63

and “RemoteObjects.dll” These are in the folder: C:\Program Files (x86)\Agilent\Agilent LCA Remote Client 3 Enable the flag “Import namespaces after closing”. 4 Ensure that “RemoteClient” and “RemoteObjects” are selected. Figure 3 Selecting the required references 5. Set the flag to import the namespaces “Agilent.LCA.RemoteClient” and click OK Programming Examples 64 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

Browser”. You will find this in the “Device” menu. Select • type: .NET/CLR Objects • assembly: RemoteClient • namespace: Agilent.LCA.RemoteClient to choose the function you want. NOTE Before using one of the functions or properties, you have to create an instance of the constructor. Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 65

Working with the network analyzer To get your measurement data from the network analyzer, you have to use the COM-interface. To be able to communicate with the network analyzer over its COM interface, you have to install the PNAProxy. For information on installing the PNAProxy see “Install the LCA Remote Client” on page 12. Programming Examples 66 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

1 In the “Device” menu, select “ActiveX Automation References”. Figure 5 Calling the ActiveX automation references 2 In the dialog, which appears, enable the “Agilent PNA Series 1.9 Type Library” and click OK. Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 67

Before you can start, you need to declare a variable as object, so Keysight VEE knows you want to create an object. 3 In the “Data” menu, select “Variable”, then “Declare Variable”. 4 As type, select “Object”, and as subtype, select “COM”, which is available in the advanced dialog. Figure 8 Declaration You can set the declared variable in a new formula. 5 In the “Device” menu, select “Formula”. 6 Type the following command into the formula Programming Examples 68 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

IP-Address) where name is the name of the variable you declared, and IP- address by the IP address of the LCA. Figure 9 Setting the variable This creates the identifier for object calls “AgilentPNA835x.Application”. You now find the required functions in the “Function & Object Browser”. You will find this in the “Device” menu, under Function & Object Browser. Select • type: ActiveX Objects • namespace: AgilentPNA835x to choose the function you want. Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 69

Description of the VEE-example You can find the examples in the “Examples” folder in the “Agilent LCA Remote Client” installation folder. In the VEE- example you can switch between the panel and the detail view. The panel view lets you set LCA parameters and control the LCA. Programming Examples 70 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

71

different parts of the program: Figure 12 Detail view Beginning a new session connects to the server. Before opening a new session, make sure no other session is open that could block the LCA. Then you have the right to control the LCA. When you select “open a session”, the program sets the instances of LCARemoteClient, LCAMeasParams and LCAProperties. The program then sets the IP address variable and makes it available to the other parts of the program. NOTE Starting a measurement always needs an open session. That’s why you have to begin with the point open session of the slider list. Programming Examples 72 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

saves them in the properties of the LCAMeasParams. The LCA calls the correct initialization routine for the measurement selected. The “measure”-part makes a DUT measurement. When the measurement is finished, the program retrieves the results from the network analyzer andplots them as an X-Y plot. You can read out our data in the panel view too. Figure 13 Measured data When you have finished working with the LCA, close the session and disconnect from the LCA. Do this by selecting “close session” and pressing “Run”. Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 73

You can find this programming example in the folder: Examples\Excel VBA\ in your LCA Remote Client installation directory. Run the VBA/Excel example: 1 To connect to the LCA you need its IP-address a On the LCA, from the “Start” menu, select “Run”, then enter “cmd.exe”. b Enter “ipconfig” and press Enter. Now you can read off the IP address of the LCA. 2 Configure the security settings for DCOM. CAUTION This procedure sets DCOM security is set to the lowest level. This ensures the application runs. For information on how to apply a more specific DCOM security setting for different environments we recommend your read the related network analyzer documentation. (Chapter: Configure for COM-DCOM Programming in the network analyzer help file) or the document “dcom.rtf” on the network analyzer support CD. Programming Examples 74 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

b Enter “dcomcnfg” and press ENTER. c Expand “Component Services” and “Computers”, and select “My Computer”. d Right click on “My Computer”, and select “Properties”. e Select the “Default Properties” tab. f For the “Default Authentication Level”, choose None. g Close with OK. Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 75

For help, see the document “dcom.rtf” on the network analyzer support CD. 4 Open the Excel workbook “example.xls”. In the field “LCA Name”, enter the host name or the IP address of the LCA. The blue button combines the grey buttons, and runs a full measurement. NOTE If you encounter COM automation errors when running this example, copy the file “Ecel.exe.config” into the folder where the Excel executable is located. This forces the runtime environment to bind Excel with .NET 2.0 at startup. If you have an older version of Excel it might be bound to an older version of the .NET framework by default. Since an application can only be bound to one version of the .NET framework you will see errors in this case, because the LCA Remote Client requires .NET 2.0. This .config file can be found in the same folder as the file “example.xls”. Change the LCA parameters. Select the type of measurement Connect to the LCA and start a new session. Click “measure” to start a measurement. The results are shown on sheet 2 (Data). Click “Draw a chart” to generate a graph of your measurement results (on sheet 2). Disconnect the LCA from the remote interface (end session). Programming Examples 76 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

Programming Examples Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 77

Warranty All system warranties and support agreements are dependent upon the integrity of the Lightwave Component Analyzer. Any modification of the system software or hardware will terminate any obligation that Keysight Technologies may have to the purchaser. Please contact your local Keysight field engineer before embarking in any changes to the system. System In addition to the standard warranty, extended warranty periods, on-site troubleshooting, reduced response times and increased coverage hours can be negotiated under a separate support agreement and will be charged at an extra cost. Remove all doubt Keysight offers a wide range of additional expert test and measurement services for your equipment, including initial start-up assistance onsite education and training, as well as design, system integration, and project management. Our repair and calibration services will get your equipment back to you, performing like new, when promised. You will get full value out of your Keysight equipment throughout its lifetime. Your equipment will be serviced by Keysight-trained technicians using the latest factory calibration procedures, automated repair diagnostics and genuine parts. You will always have the utmost confidence in your measurements. For more information on repair and calibration services, go to www.keysight.com/find/removealldoubt Warranty Information

Get the latest information on the products and applications you select. www.keysight.com/find/emailupdates MyKeysight Quickly choose and use your test equipment solutions with confidence. www.keysight.com/find/mykeysight Keysight Open Keysight Open simplifies the process of connecting and programming test systems to help engineers design, validate and manufacture electronic products. Keysight offers open connectivity for a broad range of systemready instruments, open industry software, PC-standard I/O and global support, which are combined to more easily integrate test system development. www.keysight.com/find/open Warranty Information 80 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

United States: (tel) 800 829 4444 (fax) 800 829 4433 Canada: (tel) 877 894 4414 (fax) 800 746 4866 China: (tel) 800 810 0189 (fax) 800 820 2816 Europe: (tel) 31 20 547 2111 Japan: (tel) (81) 426 56 7832 (fax) (81) 426 56 7840 Korea: (tel) (080) 769 0800 (fax) (080) 769 0900 Latin America: (tel) (305) 269 7500 Taiwan: (tel) 0800 047 866 (fax) 0800 286 331 Other Asia Pacific Countries: (tel) (65) 6375 8100 (fax) (65) 6755 0042 Email: [email protected] Warranty Information Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide 81

Optical test instruments www.keysight.com/find/oct Lightwave Component Analyzers www.keysight.com/find/lca Polarization solutions www.keysight.com/find/pol Spectral analysis products www.keysight.com/comms/octspectral Electro-optical converters www.keysight.com/find/ref Optical test instruments accessories www.keysight.com/comms/oct-accessories Firmware and driver download www.keysight.com/comms/octfirmware Keysight photonic discussion forum www.keysight.com/find/photonic_forum For Network analyzer related literature, please visit: Keysight Network Analyzers: www.keysight.com/find/na Mechanical and Electronic Calibration Kits: www.keysight.com/find/ecal RF Test Accessories, Cabinets, Cables: www.keysight.com/find/accessories Warranty Information 82 Keysight N437x Series Lightwave Component Analyzer, Programmer’s Guide

© Keysight Technologies 2007, 2015 Edition 2.0, February 2015 www.keysight.com