MX40C RemoteControlUserGuide
MX40C RemoteControlUserGuide
Remote Control
User Guide
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2
Table of Contents
Chapter 1 Introduction.................................................................................................................................................... 1
1.1. Description ........................................................................................................................................... 1
1.2. Interfacing the Computer and the MX & MBX Series, TLX1, & TLX2 Instrument ...................................... 1
Chapter 2 Supported Commands..................................................................................................................................... 4
2.1. Command Return Codes ........................................................................................................................ 5
2.2. RF Amplifier Commands ........................................................................................................................ 6
2.3. Laser Control Commands ....................................................................................................................... 8
2.4. Mach-Zehnder EO Intensity Modulator Commands .............................................................................. 11
2.5. System Commands .............................................................................................................................. 14
2.6. Variable Optical Attenuator (VOA) Commands .................................................................................... 16
Chapter 3 Remote Control Software .............................................................................................................................. 18
3.1. Installing the Software and Opening a Connection with the Instrument ............................................... 18
3.2. Using the Remote Control Application ................................................................................................. 19
3.3. Software Application Screenshots ....................................................................................................... 21
3.4. Custom Application Development........................................................................................................ 23
Chapter 4 Thorlabs Worldwide Contacts ....................................................................................................................... 24
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 1: Introduction
Chapter 1 Introduction
1.1. Description
The MX & MBX series, TLX1, & TLX2 instruments may be remotely controlled via SCPI-type serial commands. This
requires connecting a computer running the Microsoft® Windows® 7 operating system, or later versions, to the
instrument using a USB cable, or connecting a computer running any operating system to the RS-232 port on the
instrument. Serial commands are sent to the USB or RS-232 ports located on the back panel of the instrument.
The touchscreen interface remains active while the instrument is controlled remotely, and instrument
functionality remains accessible through the touchscreen interface.
This document describes the process of interfacing the instrument with the controlling computer, defines the serial
commands, and includes information about the remote control software tool that serves as an example and a
tutorial for sending the serial commands. To download the remote control software tool and supporting files for
your MX & MBX series, TLX1, & TLX2 instrument, visit the following page and type in the instrument’s Item #:
https://www.thorlabs.com/manuals.cfm
1.2. Interfacing the Computer and the MX & MBX Series, TLX1, & TLX2 Instrument
The following sections use the MX40G Electrical-to-Optical Converter as an example, but the procedure and
guidelines apply to all MX & MBX series, TLX1, & TLX2 instruments. These instruments may be connected with a
computer via USB or RS-232 ports located on the back panel, as shown in Figure 1.
Please note that using both USB and RS-232 connections at the same time is not supported. If it is necessary to
change from a USB to a RS-232 connection, or vice versa, first power off the instrument, change the connection,
and then power on the instrument. This will ensure that the instrument recognizes the new connection.
B1 B2 B3 B4
Label Description
B1 I/O Port (HDDB15 Connector)
B2 Laser Interlock (2.5 mm Connector)
B3 RS-232 Port (DB9 Connector)
B4 USB Port (USB Type B Connector)
B5 Power Connector
B6 Power Switch
Supply On; Supply Off
B5 B6
Connecting to the USB Port on the Back Panel of the MX & MBX Series, TLX1, & TLX2 Instrument
A USB cable can be used to connect a computer running Windows 7, or later, with the port on the back panel of
the instrument as shown in Figure 2. The USB port is type-B. A USB cable with a type-B connector on one end and
a type-A connector on the other would allow connection with most computers.
Figure 2 Connecting the Computer and Instrument via the USB Ports
When discovered by the Windows PC, the instrument will appear as a human interface device (HID), rather than
as a virtual serial port. The HID class includes the computer mouse and keyboard. Please note that PC terminal
software, such as Tera Term, cannot be used to communicate with the instrument via USB cable. This is due to PC
terminal software requiring the connected instrument to be recognized by the PC as a virtual serial port. The
Thorlabs remote control application discussed in Chapter 3 can scan for, discover, and open a connection with the
connected instrument.
Connecting to the RS-232 Port on the Back Panel of the MX & MBX Series, TLX1, & TLX2 Instrument
If the controlling computer has an RS-232 port, or if a USB to RS-232 adapter is connected to the computer’s USB
port, an RS-232 cable can be used to make the physical connection between the computer and the RS-232 port
on the back panel of the instrument. Any software capable of sending and receiving data using serial ports can
then be used to control the instrument. Configure the serial port of the controlling computer for 115200 baud, 8
bits, no parity, 1 stop bit, and no flow control. The Thorlabs remote control application discussed in Chapter 3 can
also control MX & MBX series, TLX1, & TLX2 instruments via an RS-232 connection. The pin assignments for the
DB9 connector on the back panel of the instrument are described by Figure 3 and the table below.
RS-232 Connector
Pin # Description
1 Not Connected
2 RS-232 Input
3 RS-232 Output
4 Not Connected
Figure 3 RS-232 DB9 Connector on the 5 Digital Ground
Back Panel of the MX & MBX Series, 6 Not Connected
TLX1, & TLX2 Instrument 7 Not Connected
8 Not Connected
9 Not Connected
Page 2 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 1: Introduction
Connecting to the MX & MBX Series, TLX1, & TLX2 Instrument Using the RS-232 Port on the Controlling
Computer
Figure 4 illustrates the physical connection when the RS-232 ports on the instrument and the controlling computer
are used. The details of the connection depend on the controlling computer’s RS-232 port. When it is a:
• 9-pin DB9 male connector, an option is to use a female-to-female 9-pin “null modem” cable. National
Instruments® explains the difference between a standard and a null modem cable here:
http://digital.ni.com/public.nsf/allkb/1EE0DD8AF67922FA86256F720071DECF
• 25-pin DB25 male connector, a null modem cable that converts between 25 and 9 pins can be used.
In either case, if a null modem cable is not available, a null modem adapter could be used with a standard cable.
Figure 4 Connecting the Computer and MX & MBX Series, TLX1, & TLX2 Instrument via the RS-232 Ports
If the USB port on the controlling computer is used, a USB cable terminating in a USB to RS-232 adapter can be
used to allow connection to a null modem cable. When the connector on the adapter is a 9-pin DB9 male, and the
null model cable has two 9-pin female DB9 connectors, it is possible to use the adapter and null modem cable to
make a connection between the computer’s USB and the instrument’s RS-232 ports. This is illustrated in Figure 5.
Figure 5 Connecting the USB Port on the Computer to the RS-232 Port on the Instrument
Please note that the USB port on the instrument should not be connected to the RS-232 port on the controlling
computer; this configuration is not supported.
Following this convention, many commands in the “Syntax” columns of the following tables include both
uppercase and lowercase letters. Uppercase letters identify the shortest acceptable form of the commands. If
including additional characters, all command characters must be included. (For example, VOA:SET? and
VOA:SETPOINT? are the only acceptable variations of the VOA:SETpoint? command.)
Each SCPI command string sent to the instrument must be terminated with either <new line> (<NL>) character
(ASCII decimal 10), <CR><NL> (ASCII decimal 13 10), <CR> (ASCII decimal 13), or <NL><CR> (ASCII decimal
10 13). IEEE 488 specifies that the standard termination is the <NL> character. For every SCPI message that is
sent to the instrument that warrants a response, the instrument terminates the returned response with a <NL>
character.
The commands described below have been developed as a custom set, as no device in the SCPI standard is an
exact analogue.
Please note that not every command described in the following sections applies to every MX & MBX series, TLX1,
& TLX2 Item #. In order for a command to apply to a specific instrument, the instrument must have the related
built-in component. For example, the Laser Control Commands do not apply to instruments that do not include an
internal tunable laser. The following table lists the commands supported by each instrument.
Valid commands will return a value of 1 on receipt. Valid queries return a value/string as noted in the query
descriptions in Sections 0 through 2.6. The following table lists possible return values for exception handling.
Page 4 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
Page 6 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
Be advised that there will be a delay between when requested laser state is specified in a “set” command and
when the requested state becomes the active laser state, as the instrument requires a finite period of time to
execute commands. Typical execution times are given in the following table for each relevant command. After
setting laser parameter(s), the LASer:SETpoint? command can be used to determine the laser’s active status.
Page 8 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
Page 10 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
Page 12 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
Trigger MZM MZM:RESET Triggers a MZM bias calibration and returns a 1. While the calibration is
Calibration running, the MZM:CAL? command returns a 1.
Get MZM Status MZM:SETpoint? A 1 is returned and a steady green dot shows in the Bias field of the
instrument’s touchscreen when the MZM bias is stable and at setpoint.
A 0 is returned and the green dot in the Bias field blinks while the MZM
is not at setpoint.
Get Post-MZM MZM:TAP:DBM? Returns the optical power, as a floating point value in dB, output by the
Power in dBm MZM. This value is the scaled optical power measurement made at a
tap located at the output of the MZM.
Get Post-MZM MZM:TAP:MW? Returns the optical power, as a floating point value in mW, output by
Power in mW the MZM. This value is the scaled optical power measurement made at
a tap located at the output of the MZM.
Get MZM Bias MZM:Voltage? Returns the current MZM bias voltage as a floating point value in Volts.
Voltage
Get MZM Bias MZM:VOLTAGE2? MX110G and MX100E variants ONLY. Reports second bias voltage as a
Voltage 2 floating point value in Volts.
Page 14 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
Page 16 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 2: Supported Commands
3.1. Installing the Software and Opening a Connection with the Instrument
Begin by downloading the application software by visiting the following link, typing in the Item # of the instrument,
and clicking on the Software Download Icon shown in the list of files available for download.
https://www.thorlabs.com/manuals.cfm
Unzip the file whose name begins with “RCUP.” Keep the “Remote Control Utility Program.exe” file in the same
directory with the “platforms” folder and other supporting files, as the application will not run if these are
separated.
Before running the application, connect the instrument and the controlling computer using the appropriate
cabling as described in Section 1.2. Power on the instrument and ensure the power button on the front panel is
glowing green and the touchscreen is active. Wait until the computer discovers the instrument, and then launch
the application. The application window is shown in Figure 7. The actual application window does not include the
red, green, blue, violet and orange outlines shown in Figure 7, these outlines were drawn on an image of the
window for illustrative purposes.
Page 18 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 3: Remote Control Software
Select the “Connection Type” radio button corresponding to the utilized connector on the instrument. (The
locations of the radio buttons are indicated by the red outline in Figure 7.) Then click the “Connect” button to
open a connection to the instrument.
After clicking the “Connect” button, the “Status” field, which is located at the bottom of the region enclosed by
the green outline, should show a number of lines of text. If the application established a connection with the
instrument, the text shown in the status field will conclude with “Device Opened Successfully.”
If a connection was not established between the computer and instrument, the text in the “Status” field will note
the failure. A common reason for a failure to connect is that the instrument has not been recognized by the
computer; the software cannot find the instrument unless it has been discovered by the computer. It may take up
to 30 seconds for the computer to recognize the instrument. If the device fails to open successfully, we
recommend closing the Remote Control application, waiting a few seconds, re- opening the application, and
attempting again to connect to the instrument. Other reasons the application may fail to successfully open a
connection to the instrument include the connection already being open or another copy of the application
running. If none of these are the source of the problem, and the problem persists when a different USB cable is
used, please contact Thorlabs’ Technical Support for assistance.
Command responses can be saved or cleared from the Remote Instrument Output field by using the Save and
Clear buttons to the right of the Remote Instrument Output field and bordered in an orange outline in Figure 7.
Commands sent by the computer and written to the PC Output field can be saved or cleared by using the Save
and Clear buttons to the right of the PC Output field and bordered in the orange outline in Figure 7. Properly
formatted text files, either by using the save of the PC Output field or by user entry, which contain SCPI commands
can be loaded to the application using the Load button. Once loaded, the user can select the Start button to begin
to send, in sequence, the loaded text file SCPI commands to the instrument. Once started, the user may select the
Stop button to stop sending commands to the instrument. Hitting the Start button again will begin the sequence
at the start of the loaded file.
The following examples illustrate the operation of the software and the interaction between the software and the
touchscreen interface on the front panel of the instrument that includes a built-in laser, such as the MX40G.
• The text “LAS:CHAN 5”, which is the command sent to the instrument, is printed to the “PC Output” field
(within green outline).
• After a short delay, the text “1” is printed to the “Remote Instrument Output” field (within green outline).
This indicates the command was received by the instrument.
• The text printed to the “Status” field indicates the response was received.
• The text “LAS:CHAN?” , which is the command sent to the instrument, is printed to the “PC Output” field
(within green outline).
• After a short delay, the text “5”, which is the most recent ITU channel requested, is printed to the “Remote
Instrument Output” field (within green outline).
Example: Using the Software Application with the MX40G’s Front Panel Touchscreen
• Navigate to the Laser Settings Page, which is
shown in Figure 8, from the Home Screen
• After a short delay, the text “6”, which is the ITU Figure 8 Laser Settings Page of the MX40G
channel entered using the touchscreen, is
printed to the “Remote Instrument Output”
field (within green outline).
Page 20 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 3: Remote Control Software
The functions in the VOA tab (Figure 10) correspond to the commands described in Section 2.6: Variable Optical
Attenuator (VOA) Commands.
The functions in the Amp tab (Figure 11) correspond to the commands described in Section 2.2: RF Amplifier
Commands.
The functions in the MZM Bias tab (Figure 12) correspond to the commands described in Section 2.4: Mach-
Zehnder EO Intensity Modulator Commands.
Page 22 TTN116413-D04
Remote Control User Guide for MX & MBX Series, TLX1, & TLX2 Chapter 3: Remote Control Software
The functions in the System tab (Figure 13) correspond to the commands described in Section 2.5: System
Commands.
When the computer is connected to the RS-232 port on the MX & MBX series, TLX1, & TLX2 instrument, commands
are sent directly to the instrument’s universal asynchronous receiver/transmitter (UART). This is not the case for
applications communicating with the instrument over USB. In this case, commands sent by the computer address
a Silicon Labs® USB to UART bridge chip built into the instrument. The UART is interfaced to the bridge chip. A
dynamic-link library (DLL) available from Silicon Labs’ website can be used to communicate with the bridge chip.
If you have questions or would like guidance as you develop a custom test configuration, please contact us. We
are happy to assist you.
sales@thorlabs.com sales@thorlabs.com
techsupport@thorlabs.com techsupport@thorlabs.com
EU Importer UK Importer
Thorlabs GmbH Thorlabs Ltd.
Münchner Weg 1 204 Lancaster Way Business Park
D-85232 Bergkirchen Ely CB6 3NX
Germany United Kingdom
sales.de@thorlabs.com sales.uk@thorlabs.com
europe@thorlabs.com techsupport.uk@thorlabs.com
Page 24 TTN116413-D04
www.thorlabs.com