JDS Uniphase T-BERD MTS 8000, T-BERD 6000A, T-BERD 5800 Getting Started Manual

21165803 rev 002
Remote Operation Getting Started Guide
This guide describes remote operation and control of a Transport Module, Multi-Service Application Module (MSAM), or T-BERD/MTS 5800 using SCPI commands.
SCPI command syntax and format requirements are presente d alo ng w ith instr uction s on how to establish a connection to a module and initiate example applications. A list of commands and queries that apply to all applications concludes this section as a refere nce for basic remote control applications.
Controlled modules may be a part of an MTS-8000 or MTS 6000A Test Platform. As these platforms are physically diff erent, only those phys ical features that apply directly to remo te operations will be discussed when necessary.
The sections contained in this chapter are as follows: – “About the T-BERD/MTS 8000, 6000A, and 5800” on p age2
“Remote control flow” on page 4“Command syntax and format requirements” on page 4“Getting the module port number” on page 6“Getting the remote control port number” on page 7“Working with applications” on page 11“Using setups, actions, and results” on page 14“Rebooting an instrument” on page 19“Example remote control procedur e s” on page 19“Demo Remote Control Scripts” on page25“SCPI command reference” on page 26
Transport Module, DMC, MSAM, and 5800 Remote Operation 1
Remote Operation Getting Started Guide
About the T-BERD/MTS 8000, 6000A, and 5800
About the T-BERD/MTS 8000, 6000A, and 5800
Before beginning a remote session, you should be familiar with the products and modules, found in the T-BERD
Transport Module, and MSAM Getting Started Guide and T-BERD/MTS 5800 Getting Started Manual.
The following terms have a specific meaning when referring to the T-BERD/MTS 8000 or 6000A:
10/100/1000 Ethernet — Used to represent 10/100/1000 Mbps Ethernet. The
connector panel also uses 10/100/1000M to identify the connector used for 10/100/ 1000 Mbps Ethernet testing.
1GigE — Used to represent 1 Gigabit Ethernet. The Transport Module connector
panel also uses GigE to identify the optical connector used for 1 Gigabit Ethernet testing.
10GigE — Used to represent 10 Gigabit Ethernet. The Transport Module connector
panel also uses 10GE and 10G to identify the optical connectors used for 10 Gigabit Ethernet LAN and WAN testing.
–Action — Refers to an item that triggers some change to the test interface, such as
inserting an alarm or enabling the laser. In the user interface, these are located in the Actions toolbar at the bottom of the main results screen.
Application module — Used to refer to the component that provides test functionality
to the assembled instrument. This manual supports two application modules: the Transport Module, and the MSAM.
– Assembly — Used to refer to a complete set of components assembled as an instru-
ment and used for testing. This manual supports three assemblies: The Transport Module assembly, consisting of an T-BERD MTS 8000 base unit and T ransport Module, the MSAM assembly, consisting of a MSAM, Physical Interface Modules (PIMs), and a T-BERD MTS 6000A base unit, and a DMC assembly, consisting of up to two MSAMs, up to four PIMs, a Dual Module Carrier (DMC), and a T-BERD MTS 8000 base unit.
Base unit — The unit which connects to the application module and power adapter,
providing the user interface and a variety of connectivity and work flow tools. If optioned to do so, the base unit also allows you to measure emitted power, received power, and optical link loss on fiber optic networks.
Battery Module — The module connected to the back of the T-BERD / MTS 8000
base unit, which supplies power whenever it is not provided using the power adapter.
Component— Used to refer to an individual hardware component which is connected
to the other components to build a test instrument (assembly). This manual supports the following components: the Transport Module, the MSAM, and the DMC. The base units are documented in separate manuals.
–DMC — Dual Module Carrier. The DMC is a two slot chassis which you ca n connect to
the T-BERD / MTS 8000 base unit to test using up to two MSAM application modules and four Physical Interface Modules (PIMs).
FC — Used to represent Fibre Channel on the Transport Module connector panel and
the Transport Mod ule and M SAM use r i nterfa c e to iden tify the optica l conn ectors used for Fibre Channel testing.
MTS 8000 and T-BERD⁄MTS 6000A Dual Module Carrier,
2 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
About the T-BERD/MTS 8000, 6000A, and 5800
JDSU Ethernet test set — A test set marketed by JDSU and designed to transmit an
Acterna Test Packet (ATP) payload. These packets carry a time stamp used to calcu­late a variety of test results. The FST-2802 TestPad, the SmartClass Ethernet tester, the HST with an Ethernet SIM, the T-BERD/MTS 8000 Transport Module, and the T-BERD/MTS 6000A MSAM can all be configured to transmit and analyze ATP payloads, and can be used in end-to-end and loopback configurations during testing.
MSAM Multiple Services Application Module — Referred to generically as “the
instrument” when inserted in the T-BERD / MTS 6000A base unit or the DMC with a
PIM. The MSAM provides testing functionality for the base unit. – MTS 8000 and MTS 6000A See T-BERD/MTS 8000 and T-BERT 6000A.OC-n — Used to refer to each of the optical SONET rates supported by the Transport
Module or MSAM (OC-3, OC-12, OC-48, and OC-192), where “n” represents the
user-selected line rate. – OTN — Optical Transport Network. – OTU1 — Optical Transport Unit 1. A 2.7G OTN sign al d esigned to ca rr y a SONET OC-
48 or SDH STM-16 client signal. OTU1 is used on the connector panel and the
Transport Module and MSAM user interfaces to identify the connectors and applica-
tions used for 2.7G OTN testing. – OTU2 — Optical Transport Unit 2. A 10.7G, 11.05G, or 11.1G OTN signal designed to
carry SONET OC-192, SDH STM-64, or 10GigE Ethernet WAN and LAN client signals.
OTU2 is used on the <product name> connector panel and the Transport Module and
MSAM user interfaces to identify the connectors and applications used for 10.7G,
11.05G, or 11.1G OTN te sting.
PIM The physical interface module (PIM) inserted into one of up to two ports
provided on the MSAM chassis. PIMs supply the physical connectors (interfaces)
required to connect the MSAM to the circuit under test. A variety of cables, SFPs, and
XFPs are offered as options, and can used to connect the PIMs to the circuit. –Result — Refers to a measurement made by the test ap plication. In the user interface,
these are displayed in the result windows and in the software LED panel on the main
Results screan. – Setup — Refers to a setting of a test application that is usually changable by the user.
In the user interface, they are located on the Setup screen and on the main Result
screen in the horizontal toolbars. – SFP — Small form-factor pluggable module. Used on the connector panel and
throughout this manual to represent pluggable optical modules. –Slice — Used as a generic term for an applicaiton module or battery module. Typical
use is referring to the Transport Module, as the “BERT slice”. After assembling a T-
BERD/MTS 8000 base unit to a battery module and then to the Transport Module, the
instrument resembles a sandwich; thus, the indivicual components are slices. – STM-n — Used to refer to each of the optical SDH rates supported by the Transport
Module or MSAM (STM-1, STM-4, STM-16, and STM-64), where “n” represents the
user-selected line rate. – STS-1 — Used to refer to the electrical equivalent of OC-1 (51.84 Mbps) supported by
the Transport Module or MSAM. – STM-1e — Used to refer to the electrical equivalent of STM-1 (155.52 Mbps)
supported by the Transport Module or MSAM.
Transport Module, DMC, MSAM, and 5800 Remote Operation 3
Remote Operation Getting Started Guide
Remote control flow
T-BERD MTS 8000 and T-BERD MTS 6000A — The family of products, typically
a combination of a base unit, a battery module, and one or more application modules. The Dual Module Carrier (DMC) can be used on the T-BERD / MTS 8000 platform to test using two MSAMs.
The products are branded T-BERD in North American and branded MTS in Europe, and are interchangeably referred to as the T-BERD 8000, MTS 8000, MTS-6000, MTS5800 and Media Test Set 6000 throughout supporting documentation.
Transport Module — Referred to generically as “the instrument” when connected to
the T-BERD / MTS 8000 base unit. The T ranspor t Module provides testin g functionality for the base unit.
XFP — 10 Gigabit Small Form Factor Pluggable optical transceiver. A variety of
optional XFPs are available for testing 10 Gigabit fibre circuits.
Remote control flow
When running a remote control session, the basic flow is as follows:
1 Obtain the remote control port number 2 Start remote control 3 Interacting with the applications
a query for running applications b launching an application c using setup, action, and results d restarting a test
e configuring a timed test 4 Exiting the application(s) 5 Leaving remote control
Command syntax and format requirements
Before starting the remote session you sould become familiar with the syntax and format requirements.
Command case-
sensitivity
SCPI command headers are not case sensitive , so both commands below are correct and return the Signal Present test result.
:SENSE:DATA? CSTatus:PHYSical:SIGNal
:sense:data? CSTatus:PHYSical:SIGNal
Result names are not case sensitive, so both commands below return the Signal Present test result.
:SENSE:DATA? CSTatus:PHYSical:SIGNal
4 Transport Module, DMC, MSAM, and 5800 Remote Operation
:SENSE:DATA? cstatus:physical:signal
Setup and action values are case-sensitive.
:SENSe:PAYLoad:BERT:PATTern ALL_ONESCorrect :SENSe:PAYLoad:BERT:PATTern all_onesIncorrect
Remote Operation Getting Started Guide
Command syntax and format requirements
Sockets and
messages
Issuing multiple
commands
Serial command
processing
Short-form v. Long-
form commands
All remote control communications are socket-based TCP/IP. Any message passed via remote control must be terminated with a newline character ("\n") as shown (or ENTER in direct entry mode).
:INITiate\n
Without the following \n, a message may be interpreted incorrectly or cause an error condi­tion.
You can issue multiple commands on a single line by separating each of the commands using a semicolon. The following examples show correct and incorrect presentation of the multiple commands.
:INITiate; :SYSTem:ERRor:NEXT?\nCorrect :INITiate :SYSTem:ERRor:NEXT?\nIncorrect
The remote control system processes commands sequentially in the order they are received. It does not process multiple commands simultaneously. If a command is sent while another command is still being processed, the second command will not be processed until the first command has been fully executed.
Commands may be abbreviated using the short form (the capital lette rs in the comma nd). Each word in the command may be either the long or short-form.
If long-form is used, the entire word must be specified; "partial" long -form is not recognized. The following examples show the complete long-fo rm ver sio n fo llow ed by var iou s, sh or t-
form versions of the same command. The final example shows an exam ple of "partial" long­form that is not acceptable.
:SENSe:DATA? CSTatus:PHYSical:SIGNal Correct :SENSe:DATA? CST:PHYS:SIGNCorrect :SENS:DATA? CSTatus:PHYS:SIGNalCorrect :SENS:DATA? CST:PHYS:SIGNCorrect :SENS:DATA? CST:PHYS:SIGNaIncorrect
Transport Module, DMC, MSAM, and 5800 Remote Operation 5
Remote Operation Getting Started Guide
Getting the module port number
Getting the module port number
Starting remote
operation
Obtaining the module
port number
The first step is to start remote operation
1 Open a TCP/IP socket connection to the unit on port 8000. 2 Start remote operation.
*REM
IMPORTANT:
The *REM command must always be the first command sent after opening a socket (to port 8000, the module port, or the RC port). On the ANT pla tforms this was not necessary - they allowed you to connect, acce ss ap plic at ion s, disconnect, then reconnect and continue without having to send *REM again; on the MTS platforms, it is required.
Before issuing any SCPI commands, a socket connection to the module must be estab­lished.
Module identification and location
In order to establish a connection, the module must be identified and located. Since multiple layers (slices) of transport modules (MTS-8000) and installation locations
(sides) for Multi-Service Application Modules (MSAM) are possible, the exact location of the module to which a connection is being made must be verified.
There are two arguments that are required in the following commands and queries that establish the exact physical location of the module being used in the test. These are indi­cated as <side> value as follows:
<side>
–PWRS - Power Side - specify this location when connecting to an MSAM connected to
an MTS-6000A
OR
on the right side (viewed from front of base unit) of MTS-8000 dual carrier (same side
as power connector). – OPPS - Opposite Side - specify this location when connecting to an MSAM connected
to the left side (viewed from front of base unit) of MTS-8000 dual carrier (far side from
power connector). – BOTH - specify this location when connecting to full-width Transport Module (on MTS-
8000).
and <slice>. These are required arguments and must be filled with a
NOTE
The <side> parameter was added to the ":SYST:FUNC" commands in ver­sion 8.0 of the MTS-8000 BERT software and version 3.0 on the MTS-6000. For previous versions, this parameter must be omitted.
6 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Getting the remote control port number
<slice>
SLIC1 - specify this location when connecting to an MTS-6000A MSAM
OR to the transport module connected directly to the MTS-8000.
– SLIC2, SLIC3 - specify this location when connecting to the second or third transport
module (counting from the front) on an MTS-8000.
NOTE
For MTS-6000A, <side> will always be PWRS and <slice> will always be SLIC1.
Verify the location of the module to which a connection is being made:
Example procedure
MOD:FUNC:LIST?
replacing <side> and <slice> as detailed in “Module identification and location” on
page 6.
If the module is located where queried, the system will respond with “BERT”.
1 Verify whether the module is powered.
MOD:FUNC:SEL? <side>,<slice>,"BERT" example: MOD:FUNC:SEL? PWRS,SLIC1,"BERT" The module will return “OFF” or “ON”.
2 If the module state response was OFF, turn ON the module:
MOD:FUNC:SEL <side>,<slice>,"BERT",ON
3 Query the module’s port number.
MOD:FUNC:PORT? <side>,<slice>,"BERT" The module will return its port number.If the module is in a ready state, the response to
the port query will be the port number, for example “8002”. If the port is not in a ready state, the response will be -1 . This port number will be needed in the next step.
<side>,<slice>
Getting the remote control port number
1 Open a TCP/IP socket to the module port obtained in “Module identification and loca-
tion” on page 6.
2 Enable remote operations on the module:
*REM
3 Verify the BERT module is ready
:SYST:FUNC:READY? <side>,<slice>,"BERT"
Returns 1 if the BERT module is in a ready state (i.e. po were d o n and finishe d b ooting up), 0 otherwise.
Transport Module, DMC, MSAM, and 5800 Remote Operation 7
Remote Operation Getting Started Guide
Getting the remote control port number
4 Enable the remote control socket and return its port number
:SYST:FUNC:PORT? <side>,<slice>,"BERT"
Returns this module's remote control port number. If the module is not in a ready state,
the response will be -1.
Remote modes
Default Mode
GUI Mode
Remote operations are often conducted when the re is no physical access to th e base unit where applications can be directly implemented using the Graphical User Interface (GUI). Alternate situations can exist where remote operations need to be monitored by a techni­cian at the base unit or even supplemented with input from the base unit.
The default remote operational mode disables the Graphical User Interface (GUI) on the base unit. This mode is activated by the implementation of the following command with no optional values:
*REM
In this mode, the GUI is disabled and a message is displayed indicating the unit is under remote control. At any time the GUI is enabled or disabled, all currently running applicaitons will be shut down.
Alternatively, remote control may be used without deactivating the GUI. This mode can be used to debug remote control tests and to verify that commands have the expected behavior; the default mode is recommended for routine automated tasks. To activate GUI mode, two optional parameters may be a dded to the *REM command on the remote con trol port: <GUI-mode> and <access-mode>.
<GUI-mode> parameter
The <GUI-mode> parameter has three variables that can be defined: – HIDDEN - when specified, the GUI is disabled (default if not specified).
VISIBLE - when specified, the GUI is enabled. – CURRENT - when specified, whatever is currently set will continue to be applied to the
new application or command.
<access-mode> parameter
The <access-mode> parameter has three variables that can be defined. – READ_ONLY - when specified, a GUI user may navigate the UI but not change any
settings (default, if not specified). – FULL - when specified, a GUI user may change settings. – CURRENT - when specified, whatever is currently set will continue to be applied to the
new application or command. These modes may be activated by the implementation of the REM command and speci-
fying the alternate parameters as follows:
*REM <GUI-mode> <access-mode>
8 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Getting the remote control port number
Remote Mode
Indicators
To inform the local user of the base unit of the GUI mode specified by the remote opera­tions, one of two icons will display on the GUI.
Read-Only
The Read-Only icon will display when the *REM <access-mode> has been set to READ_ONLY.
Full-Access
The Full-Access icon will display when the *REM <access-mode> has been set to FULL. Once remote control has been started with the GUI active, an "Access Mode" entry will
become available in the Tools menu, which allows the GUI user to switch between read­only or full-access mode.
Global Commands
*REM
*RST
*IDN?
The following commands are recognized by remote control. The *RST, *IDN? and *OPC? commands are loosely based on the SCPI standar d, but may not have the same behavior. Other common commands from the SCPI standard starting with "*" are not supported.
The *REM command is usually the first command issued once connected to the remote control port. This puts the unit into remote control mode. By default, this will shut down any running applications, disable the graphical user interface (GUI), and display a message indicating the unit is under remote control.
*REM may be given additional parameters to keep the GUI active, and possibly prevent another user from modifying any settings while the GUI-enabled remote control mode is active.
The *RST command shuts down all running applications and clears any saved application settings. This is useful for closing multiple applications at one time, or to ensure that a newly launched application isn't affected by any settings made in a previous test.
The *IDN? command returns identifying information about the test unit in the form of a comma separated list. The manufacturer , software name, mod ule id, and software ver sion number are provided.
> *IDN? JDSU,BERT,A1-4690290,V11.1
Transport Module, DMC, MSAM, and 5800 Remote Operation 9
Remote Operation Getting Started Guide
Getting the remote control port number
*OPC?
*GUI
The operation complete query from the SCPI standar d is recognized, but does not have the same behavior the standard describes. This due to the fact that in remote control, commands are processed serially; a command will not be processed until all previous commands are completed. This means that *OPC? will not be processed until all previous operations are complete, at which point it will always return 1.
It is recommended that the :SYSTem:ERRor? query be used instead of *OPC?, as it also provides error checking on the prev iou s com m a nd .
This command terminates remote control mode and restores the GUI interface. All applica­tions that were running under remote control will be shut down, and first application in the test menu will be launched. Alternatively , the application to launch may be specified as an optional parameter.
The example below shows this command with a parameter to launch 10/100/1000M Ethernet Layer 2 Traffic Terminate. Keep in mind the *GUI command may take some time to process. The 0, "No error" message may not show up for a minute or two.
> *GUI TermEth10ML2Traffic
> :SYSTem:ERRor?
0, "No error"
Switching to
Remote Control
mode
Prepare BERT Application
Using the information discovered in “Getting the remote control port number” on page 7, establish a socket connection to the BERT application port so the BERT application can be set for operation.
To prepare the BERT application port for use, it must be reset to its default configuration, shutting down all running applications.
Start Remote Operation
Set the BERT application for remote operations:
*REM
Exits all running applications and shows a message on the screen indicating the unit is under remote control.
Reset BERT
Optional. Exit all currently running applications and restore the default configurations:
*RST
Query for Error Status
To verify that the system has been reset, the system must be checked for errors. There will be no return from this query until the reset sequence has been completed. This may take a little while but a 90 second time-out on this command should be sufficient.
Check the system for errors:
10 Transport Module, DMC, MSAM, and 5800 Remote Operation
:SYSTem:ERRor?
The return from this command will be 0, "No error" the *RST command is finished.
Remote Operation Getting Started Guide
Working with applications
. There will be no return until
When the 0, "No error" completed. The system is now ready to have testing applications started on that module
Working with applications
System Commands
Check for Errors :SYSTem:ERRor?
If a remote control command has an error, no message will be returned unless requested with ":SYSTem:ERRor?". The response to this command is an error code number and a brief description in quotes. The description will be one of the messages in the table below, possibly followed by more information.
response is received, the desired module connection has been
.
Error code Error message Error code Error message
0 No error -141 Invalid character data
-100 Command Error -144 Character data too long
-102 Syntax Error -150 String data error
-103 Invalid separator -151 Invalid string data
-108 Parameter not allowed -200 Execution error
-109 Missing parameter -220 Parameter error
-113 Undefined header -221 Settings conflict
-120 Numeric data error -222 Data out of range
-121 Invalid character in number -224 Illegal parameter value
-138 Suffix not allowed -231 Data questionable
It is recommended that this command is sent automatically after any query command (ending with a '?'). If a command is errored, checking ":SYSTem:ERRor?" will immediatly report the mistake, while not checking it will result in the mistake being silently ignored.
Examples:
> *REM > :INITiate > :SYSTem:ERRor?
-221, "Settings conflict; no application has been selected"
> :SENSe:MISSpelled:COMMand?
Transport Module, DMC, MSAM, and 5800 Remote Operation 11
Remote Operation Getting Started Guide
Working with applications
> :SYSTem:ERRor?
-113, "Undefined header; could not find
':sense:misspelled:command'"
List Available
Applications
:SYST e m:APPLication:APPLications?
This command returns a comma-separated list of all applications that can be launched in addition to any applications currently running.
If an existing application is using a particular interface, then all other applications that use that interface type will be unavailable unless another suitable interface is available. For example, if a 10/100/1000M electrical Ethernet application is using the only Ethernet po rt, all other 10/100/1000M Ethernet applications will be unavailable and therefore will not show up in this query. To determine the full list of applications a unit supports, query this command when no other applications are running.
Example:
> :SYSTem:APPLication:APPLications?
TermDs1Bert,ThruDs1Bert,SingleMonDs1Bert,...
For units that have multiple ports, this query can also be given additional parameters to request the applications that are available to a specific port. The first parameter is reserved for internal use; use the value "none". The second p arameter spe cifies the port to query: 1 or 2.
Example:
> :SYSTem:APPLication:APPLications? none 2
MonEth10ML2Traffic,TermEth10ML2Loopback,...
List Currently
Running Applications
:SYST e m:APPLication:CAPPlications?
This command returns a comma-separated list of the unique identifiers for all currently running applications. The return values returned from this query may be used to select an application (using the :SYSTem:APPLication:SELect command).
Example:
> :SYSTem:APPLication:CAPPlications?
TermStm16Au4Vc4E4Bert_121,TermStm64Au4Vc4E4Bert_121
Launch an
Application
:SYST e m:APPLication:LAUNch <application name> [port]
This command will launch the specified application. This operation is different from normal GUI interaction in that the application will be launched in addition to any existing applica­tions; it will not replace the currently running application. The port number on which to launch the application (1 or 2) may be specified as an optional parameter if the unit has a second port. If not specified, the default is the first available port. If no open port s are avail­able, an error message will be stored (accessible with the :SYSTem:ERROR? command) and no action will be taken.
12 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Working with applications
Examples:
Launch 2G Fibre Channel on port 1 (or port 2 if port 1 is unavailable)
> :SYSTem:APPLication:LAUNch TermFc1GL2Traffic
Launch 2G Fibre Channel on port 2
> :SYSTem:APPLication:LAUNch TermFc1GL2Traffic 2
Another key difference from laun ching the test on the GUI is that in remote control, the test will come up in the "stopped" state, leaving most test results unreadable. The remote control user should usually send the :INITiate command after initializing the remote session.
:SYST e m:APPLication:LAUNch?
Adding a question mark (?) to the end of the launch command will query for the application identifier of the most recently launched application. This identifier may be used to select the application using the :SYSTem:APPLication:SELect command.
Example:
> :SYSTem:APPLication:LAUNch? TermFc1GL2Traffic_121
Select an Application :SYSTem:APPLication:SELect <application id>
This command selects a specific running instance of an applica tion, which directs all subse­quent commands to that application. It must be sent after the application is launched and the unique id for that application instance has been obtained.
The application id will be the application name followed by a 3-digit number. The first two digits represent the "slice" number and the "side" number where the module is located (see the documentation on Connecting to Remote Control for more explanation of these), and will always be the same within a particular remote control connection. The third digit repre­sents the port number: 1 or 2. The example below shows two instances of the same ethernet application, one running on port 1 and one running on port 2, and the command to select the one running on port 1.
Example:
> :SYSTem:APPLication:CAPPlications? TermEth10ML2Traffic_121,TermEth10ML2Traffic_122 > :SYSTem:APPLication:SELect TermEth10ML2Traffic_121 > :SYSTem:ERRor? 0, "No error"
Remote Control
Session
Commands
A remote control session maintains information about a specific connection to an applica­tion. Once an application has been selected, a remote control session must be created and started before the user can interact with the application.
Transport Module, DMC, MSAM, and 5800 Remote Operation 13
Remote Operation Getting Started Guide
Using setups, actions, and results
:SESSion:CREate
:SESSion:STARt
:SESSion:END
Common Application
Commands
This command creates a remote control session with the selected application.
This command starts a previously created remote control session.
This command terminates the current remote control session. The session will automati­cally be ended when an application is shut down or the remote connection is terminated.
The following commands apply to all test applications.
:INITiate
The :INITiate command starts the test if it is in the "stopped" state.
:ABORt
The :ABORt command stops the test if it is in the "running" state. To perform a test restart and restart all test measurement results, perform a test stop,
followed by a test start.
Example:
> :ABORt
> :INITiate
> :SYSTem:ERRor?
0, "No error"
:EXIT
Shuts down the currently running application.
Using setups, actions, and results
Setup commands
A unique SCPI command exists for every setup. The setup value should be space-separa ted from the command, but there should be no
space before the port number and/or question mark.
NOTE
Commands do not return any values unless they are a que ry. Remember to check each command with the :SYSTem:ERRor? query. If you do not check each command, and one is incorrect, the error message does not indicate the incorrect command.
14 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Using setups, actions, and results
Setup values specification
Setup value format
String values
T o ch ange a setup, issue the SCPI command for that setup followed by the new value. The command in the following example sets (or changes) the receive pattern on port 2 to all ones:
:SENSe:PAYLoad:BERT:PATTern1 ALL_ONES
For setups that are arrays, you can specify an index or list indices of the array element(s) that you want. A colon (:) can be used to denote an index range (within the @ specification of the channel) followed by the status value.
The following example disables (0) time slot 4 (first line) and enables (1) time slots 1, 2, 3 and 7 (second line) in fractional E1:
:SOURce:PDH:E1:CHANnel (@4) 0 :SOURce:PDH:E1:CHANnel (@1:3,7) 1
Setup values do not follow standard SCPI naming conventions and must be stated using the string values and enumerated value formats illustrated in the following examples. As with all values, setup values need to be space-separated from the command.
String values are used for setups where the exact string is not a value defined by the SCPI implementation. String values must be enclosed in double quotes.
Port Definition
Enumerated Values
Correct format
:SOURce:DATA:MAC:IPV6:TX:DESTination:ADDRess "ff00::1234:2345"
Incorrect format
:SOURce:DATA:MAC:IPV6:TX:DESTination:ADDRess ff00::1234:2345
Port definitions are generally not required in setup s u nless a d ual po rt a pplica tion is be ing tested. If no number is specified, 0 (port 1) is assumed.
To specify port numbers in dual port applications, add a zero-based port number (0 for port 1, 1 for port 2) directly after the command (or before the ? if you are issuing a query).
The setup value should be space-separated from the command, but there should be no space before the port number and/or question mark.
NOTE
Remember to check each command with the SYST:ERR? query. If you do not check each command, and one is incorrect, the error message does not indicate the incorrect command.
Enumerated values are used for setups that have specified settings defined by the SCPI implementation. Enumerated setup values are case sensitive and should not be enclosed in quotes.
Transport Module, DMC, MSAM, and 5800 Remote Operation 15
Remote Operation Getting Started Guide
Using setups, actions, and results
Correct format
:SENSe:PAYLoad:BERT:PATTern ALL_ONES
Incorrect format
:SENSe:PAYLoad:BERT:PATTern "ALL_ONES"
:SENSe:PAYLoad:BERT:PATTern all_ones
Investigate the command line specifications, found elsewhere in this document, for a more complete list of string values and enumerated values that apply to various commands.
Query values
Initiating actions
Initiate command
To query the current value of the setup, issue the SCPI command for that setup followed by a question mark.
The commands in the following examples both query for the transmit DS1 framing on line 0 (as described in “Port Definition” on page 15):
:SOURce:PDH:DS1:FRAMING?
:SOURce:PDH:DS1:FRAMING0?
A unique SCPI command exists for every action. The examples in this section will show how actions can be implemented, and status can be queried and toggled using the same root command with minor variations on its initiation.
NOTE
Remember to check each command with the SYST:ERR? query. If you do not check each command, and one is incorrect, the error message does not indicate the incorrect command.
The command in the following example inserts a single bit error o n line 0 (line assumed to be 0 when not indicated):
:SOURce:PAYLoad:BERT:INSert:TSE
Query state
To discover what is the state of error rate insertion action (on line 0) the:RATE? query is added:
:SOURce:PAYLoad:BERT:INSert:TSE:RATE?
:SOURce:PAYLoad:BERT:INSert:TSE:RATE0?
Initiate command
To turn error rate insertion ON (on line 0):
:SOURce:PAYLoad:BERT:INSert:TSE:RATE ON
:SOURce:PAYLoad:BERT:INSert:TSE:RATE0 ON
Toggling actions
Many action commands simply toggle the action ON and OFF.
16 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Using setups, actions, and results
The following command toggles error rate insertion (rever ses its state) for line 0.
:SOURce:PAYLoad:BERT:INSert:TSE:RATE
Executing the same command a second time without a parameter will turn error rate inse r­tion back to its original state (OFF).
Port Definition
Further resources
Querying results
As with setups, the zero-based port index (0 for port 1 and 1 for port 2) may optionally be specified at the end of the command (or before the "?" if a query is issued).
If no number is specified, 0 (port 1) is assumed.
Investigate the action initiation specifications, found elsewhere in this document, for a more complete list of actions commands.
Action commands do not return any value unless they are queries. To obtain the results of the tests initiated, a query must be issued.
All test results are queried using the following command:
[:SENSe]:DATA <result name>
where
– [:SENSe] is an [optional] entry.
[line] represents the port number. It is not necessary to enter the port num b er
unless a dual port application is running. For dua l p ort ap plication s, "0" corre sponds to port 1; "1" corresponds to port 2. Usage: [:SENSe]:DATA[line]? <result name>
[array indices] specifies indices for results that are arrays. For example,
(@1,3:5) indicates that the query result s are for indices 1, 3, 4 and 5. Note that index numbering is zero-based. Usage:[:SENSe]:DATA[line]? [array indices] <result name>
result name is the name of the result to be queried. These examples query for the value of the signal presen t result on line 1 (the second port),
illustrating that [:SENSe] is optional:
:SENSe:DATA1? CSTATUS:PHYSICAL:SIGNAL :DATA1? CSTATUS:PHYSICAL:SIGNAL
The following examples query for the value o f pattern sync present result on line 0 (the first port), illustrating the optional nature of defining port 0:
:SENSE:DATA? CSTatus:PAYLoad:BERT:PATTern:SYNC :SENS:DATA0? CST:PAYL:BERT:PATT:SYNC :DATA? CST:PAYL:BERT:PATT:SYNC :DATA0? CST:PAYL:BERT:PATT:SYNC
Transport Module, DMC, MSAM, and 5800 Remote Operation 17
Remote Operation Getting Started Guide
Using setups, actions, and results
NOTE
Not-a-Number formats from the SCPI standard are supported. If a result is not applicable or is out of range, a result query will return an appropriate value as shown below.
9.91e+37 Not Applicable/Not Ready
(cannot be calculated from current information)
9.90e+37 Over range
-9.90e+37 Under range
Result groups
Group definition
Group result report
Result group
examples
Result commands may be added to user-defined groups, which allow the simultaneous query and reporting of multiple parameter result values.
The format of a command to add a result parameter to a gr ou p is:
:SENSe:DATA:GROUP [group name] [result parameter]
where – [group name] specifies the name of the group. – [result parameter] is the data parameter being tested that is to be reported when
the group results report is queried.
A result can only be in a group once; no change will be made to the group if it is added
again.
Once a group is defined, it can be queried with the following command:
:SENSe:DATA:GROUP? [group name]
This will return the list of result values separated by semicolons (;) in the order in which
they were added to the group.
The following example creates and queries a small group of Ethernet results:
:SENSe:DATA:GROUP summary CSTatus:PHYSical:SIGNal
:SENSe:DATA:GROUP summary CSTatus:PCS:PHY:SYNC:ACTive
:SENSe:DATA:GROUP summary CSTatus:MAC:ETH:FRAMe:DETect
:SENSe:DATA:GROUP? summary
The last command will return something like "1; 0; 9.91e+37", indicating signal is
on, sync is off, and frame detect is not available.
Reset group deletion
Result groups are a report of multiple parameter results from a currently running applica­tion. Result groups are not retained beyond the current session.
All result groups will be deleted when the remote control session is closed with ":SESSion:END".
18 Transport Module, DMC, MSAM, and 5800 Remote Operation
Rebooting an instrument
To reboot the unit, establish a socket connection to port 8000. The *REM command must be sent first. Then send the following command:
:SYSTem:REBoot
The time to reboot will depend on the platform type. Query the :SYST:FUNC:READY? <side>,<slice>,"BERT" command on the module port to
determine when the reboot is complete and BER T so f tware i s running again (s ee “Getting
the remote control port number” for information on this command). This will bring the unit
back into GUI mode. Any remote connections will need to be reestablished.
Example remote control procedures
This section includes a few examples of common procedures you may encounter. Lines that begin with ">" indicate that a command is being sent by the user to the remote control socket connection. If the command returns a value, the response is shown on the next line.
Remote Operation Getting Started Guide
Rebooting an instrument
Connecting to an
instrument and
obtaining the
remote control
port number
Connecting to a MTS-
6000A
“Connecting to an instrument and obtaining the remote control port number” on
page 19
“Starting Remote Control” on page 21“Application interaction” on page 22
Remote control is accessed by connecting to the test unit on a specific port number. This number is determined by connecting to port 8000 and obtaining a port to access the module, then connecting to that port and querying for its remote control port. Below are a few examples of this process for specific platforms.
The MTS-6000A only supports the use of a single module (MSAM). Therefore when connecting to that platform, the paramete rs supplied to the commands below should always be PWRS,SLIC1,"BERT".
1 Open a TCP/IP socket connection to the unit on port 8000.
> *REM
> MOD:FUNC:SEL? PWRS,SLIC1,"BERT" (Optional query to verify the module
is powered on, returns "OFF" or "ON")
ON
> MOD:FUNC:PORT? PWRS,SLIC1,"BERT" (Query for the module's port
number)
8002
Transport Module, DMC, MSAM, and 5800 Remote Operation 19
Remote Operation Getting Started Guide
Example remote control procedures
2 Open a TCP/IP socket connection to the unit on the port number returned by the
previous step.
> *REM > :SYST:FUNC:READY? PWRS,SLIC1,"BERT" (Optional query to verify the
BERT application is running and ready to communicate, returns "0" or "1")
1 > :SYST:FUNC:PORT? PWRS,SLIC1,"BERT" (Query for the port number to
remote control)
8003
The port number returned by the final command can be used to establish a remote contr ol connection, as shown in “Starting Remote Control” on page 21.
Connecting to a MTS-
8000 transport
module
The MTS-8000 supports the use o f multiple transport modules. When connecting to one of these, the "slice id" must be provided to indicate the desired module. Slice ids are specified as as SLIC1, SLIC2, etc. with SLIC1 being the closest module to the front display. The example below connects to the first (or only) slice, SLIC1.
1 1. Open a TCP/IP socket connection to the unit on port 8000. Lines starting with ">"
indicate commands sent by the user.
> *REM > MOD:FUNC:SEL? BOTH,SLIC1,"BERT" (Optional query to verify the module is
powered on, returns "OFF" or "ON") ON
> MOD:FUNC:PORT? BOTH,SLIC1,"BERT" (Query for the module's port number) 8002
2 Open a TCP/IP socket connection to the unit on the port number returned by the
previous step.
> *REM > :SYST:FUNC:READY? BOTH,SLIC1,"BERT" (Optional query to verify the
BERT application is running and ready to communicate, returns "0" or "1")
1 > :SYST:FUNC:PORT? BOTH,SLIC1,"BERT" (Query for the port number to
remote control)
8003
The port number returned by the final command can be used to establish a remote contr ol connection, as shown in “Starting Remote Control” on page 21.
Connecting to an
MTS-8000 dual MSAM
carrier
The MTS-8000 supports the use of multiple dual MSAM carrier modules, each of which may have up to two MSAM modules. When connecting to one of these, the "side" and the "slice id" must be provided to indicate the desired module. The side parameter is either OPPS - indicating the MSAM is on the side opposite the power connector (the left side when viewed from the front), or PWRS - on the same side as the po wer connector (the right side when viewed from the front). Slice ids are specified as as SLIC1, SLIC2, etc. with SLIC1 being the closest module to the front display. The example below connects to an MSAM on left side (OPPS) of the first slice (SLIC1).
20 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Example remote control procedures
1 Open a TCP/IP socket connection to the unit on port 8000.
> *REM
> MOD:FUNC:SEL? OPPS,SLIC1,"BERT" (Optional query to verify the module is
powered on, returns "OFF" or "ON")
ON
> MOD:FUNC:PORT? OPPS,SLIC1,"BERT" (Query for the module's port number)
8002
2 Open a TCP/IP socket connection to the unit on the port number returned by the
previous step.
> *REM
> :SYST:FUNC:READY? OPPS,SLIC1,"BERT" (Optional query to verify the
BERT application is running and ready to communicate, returns "0" or "1")
1
> :SYST:FUNC:PORT? OPPS,SLIC1,"BERT" (Query for the port number to
remote control)
8003
The port number returned by the final command can be used to establish a remote contr ol connection, as shown in “Starting Remote Control” on page 21.
Starting Remote
Control
Remote Control with
GUI disabled (default)
Remote Control with
GUI enabled
Once the port number for remote control h as been o btained (see “Connecting to an instru-
ment and obtaining the remote con trol port number” on page 19), remote control mode may
be activated with the *REM command. It is recommended that the ":SYSTem:ERRor?" command be sent after every non-query command, as this is the easiest way to verify that each command is processed successfully. Lines starting with ">" indicate commands sent by the user.
This command will shut down the GUI and display a message indicate the unit is under remote control. All running applications will be stopped.
> *REM (This may take a few seconds if an application is running...)
> :SYSTem:ERRor? (This command may be sent in the mean time, but will not be
processed until *REM is finished.)
0, "No error" (Once this message is received, the switch to remote control mode
is complete.)
This command does not shut down the GUI, or any running applications.
> *REM VISIBLE (This may take a few seconds.)
> :SYSTem:ERRor? (This command may be sent in the mean time, but will not be
processed until *REM is finished.)
0, "No error" (Once this message is received, the switch to remote control
mode is complete.)
Transport Module, DMC, MSAM, and 5800 Remote Operation 21
Remote Operation Getting Started Guide
Example remote control procedures
Application
interaction
Querying for running
applications
Launching an
application
Once the test unit is in remote control mode, the following commands may be useful to determine what applications can be launched.
> :SYSTem:APPLication:APPLications?
Get a list of available application names. The return value for this command depends on what is currently running. To get the list of all applications the unit supports, send this query when no applications are running.
TermDs1Bert,ThruDs1Bert,SingleMonDs1Bert,... > :SYSTem:APPLication:CAPPlication?
Get a list of identifiers for applications that are currently running.
TermStm4Au3Vc3Bert_121,TermEth1GL3Traffic_122 > :SYSTem:APPLication:LAUNch?
Get the identifier of the most recently launched application.
TermEth1GL3Traffic_122
Once the test unit is in remote control mode, the following commands may be sent to launch an application (in this example, 1GigE L3 Traffic Terminate).
> :SYSTem:APPLication:LAUNch TermEth1GL3Traffic
Launch the application (same as "Add test" on the GUI; other running applications will not be shut down by this command). This may take a few seconds...
> :SYSTem:ERRor?
This command may be sent in the mean time, but will not be processed until the appli­cation launch is finished.
0, "No error"
Once the application is running, this message will be returned.
> :SYSTem:APPLication:LAUNch?
Get the id of the most recently launched application.
TermEth1GL3Traffic_121 > :SYSTem:APPLication:SELect TermEth1GL3Traffic_121
Select that application id.
> :SYSTem:ERRor? 0, "No error"
> :SESSion:CREate
Create a new remote session
> :SESSion:STARt
Start the session
22 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Example remote control procedures
> :SYSTem:ERRor?
0, "No error"
> :INITiate
Start the test. (When applications are launched through remote control, they begin in
the "stopped" state).
> :SYSTem:ERRor?
0, "No error"
When using remote control with the GUI enabled and an desired application is already running, a similar process can be followed to connect to it. Use the ":SYSTem:APPLica­tion:CAPPlication?" query to find its application id, select the app lication, then create and start a remote session. ":INIT iate" only needs to b e sent if the test is in the "stopped" state.
This example also illustrates use of the :SYST em:ERRor? query . The user sh ould have this command sent automatically after every non-query command and the 0, "No error" response should be expected. Doing so will provide vital information in the event of a command error or connection issue.
Restarting the test
Using setups, actions,
and results (inserting
and checking an
alarm)
T o restart the te st using remote control, send the test stop command followed by a test st art.
> :ABORtTest stop
> :INITiateTest start
The following commands demonstrate the use of applica tion setups, actions and resu lts. In this example, assume we have launched and initialized the DS1 BERT Terminate applica­tion (TermD s1 Bert). Lines starting with ">" indicate commands sent by the user.
> :SOURce:ALARm:TYPE?
Query the current alarm type setup
"Ds1LofAlarm"
Note: some query commands return values with double quotes (") and some do not.
Making remote control scripts quote-insensitive when checking returned values is
highly recommended.
> :SOURce:ALARm:TYPE Ds1AisAlarm
Set the alarm type setup to AIS.
> :SOURce:PDH:DS1:INSert:AIS ON
Enable the AIS alarm insertion action
> :SOURce:PDH:DS1:INSert:AIS?
Query the current state of the AIS alarm insertion action
ON
Transport Module, DMC, MSAM, and 5800 Remote Operation 23
Remote Operation Getting Started Guide
Example remote control procedures
> :SENSe:DATA? CSTatus:PDH:DS1:AIS
Query the AIS alarm result
1
If the unit is self-looped, it will detect the AIS.
> :SOURce:PDH:DS1:INSert:AIS OFF
Turn the alarm back off
> :SENSe:DATA? CSTatus:PDH:DS1:AIS
Query the AIS alarm result again
0
Configuring a timed
test
Exiting an application
There are three test timing modes: not timed, timed test, and delayed-start timed test. This example demonstrates how to configure each of those.
> :SENSe:TEST:ENABle OFF
Sets the test type to "Not Timed"
> :SENSe:TEST:ENABle ON
Sets the test type to "Timed Test"
> :SENSe:TEST:DURation 3600
Set the timed test duration in seconds
> :SENSe:TEST:ENABle DELAYED
Sets the test type to "Delayed-start timed test"
> :SENSe:TEST:DURation 3600
Set the timed test duration in seconds
> :SENSe:TEST:DELay:DATE "10/31/2011"
Set the start test date
> :SENSe:TEST:DELay:TIME "23:00:00"
Set the start test time
To shut down an application through remote control, it must first be selected. If the applica­tion is already selected and a session has been created, that session should be ended.
> :SYSTem:APPLication:SELect TermDs1Bert_121 > :EXIT
or
> :SESSion:END > :EXIT
24 Transport Module, DMC, MSAM, and 5800 Remote Operation
Remote Operation Getting Started Guide
Demo Remote Control Scripts
Leaving remote
control mode
The *GUI command shuts down all applications running under remote contol and restores the GUI interface. This command may take some time to finish processing. The ":SYSTem:ERRor?" query will still indicate when *GUI is complete, but most other remote control commands (except *REM, *RST, etc.) will no longer work.
> *GUI
Return to GUI mode, make take a while...
> :SYSTem:ERRor?
This command will return once the GUI is back up.
0, "No error"
Demo Remote Control Scripts
The following Perl scripts are provided on the the USB stick to demonstrate how to establish and use a remote control session to the various platforms. They ar e all similar , only differing in the way the script arguments are processed.
RC-Transport.pl - to connect to a Transport Module in a T-BERD/MTS-8000 Usage: perl RC-Transport.pl <unit ip> <slice #>
RC-6000A.pl - to connect to an MSAM module a T-BERD/MTS-6000A Usage: perl RC-6000A.pl <unit ip>
RC-DMC.pl - to connect to an MSAM module a T-BERD/MTS-8000 dual MSAM carrier Usage: perl RC-DMC.pl <unit ip> <side> <slice #>
RC-5800.pl - to connect to an MTS-5800 Usage: perl RC-5800.pl <unit ip>
Script parameters: – <unit ip> - the IP address of the unit
<side> - optional, specifies which slot of the DMC to communicate with
OPPS - (default) left side ("opposite side" from the power connector )
PWRS - right side ("power side", same side as the power connector) – <slice #> - optional, specifies which module to communicate with
1 - (default) the module closest to the front display
2, 3, etc - second or third modules, counting from the front
Transport Module, DMC, MSAM, and 5800 Remote Operation 25
Remote Operation Getting Started Guide
SCPI command reference
SCPI command reference
A full list of SCPI commands, along with this manual as HTML, is availabl e on the USB stick that shipped with your instrument.
Communications Test and Measurement Solutions One Milestone Center Court Germantown, Maryland 20876-7100 USA Toll Free 1-855-ASK-JDSU • Tel +1-240-404-2999 • Fax +1-240-404-2195
www.jdsu.com
© Copyright 2013 JDS Uniphase Corporation. All rights reserved. JDSU, Enabling Broadband and Optical Innovation, Communications Test and Measurement Solutions, and the logo are trademarks of JDS Uniphase Corporation. Windows is a registered trademark of Microsoft Corporation in the United States and other countries. All other trademarks and registered trademarks are the property of their respective owners. Specifications, terms, and conditions are subject to change without notice.
Loading...