Tektronix TekExpress RIN User manual

TekExpress® RIN Measurement Solution for DSA8300 Digital Serial Analyzer Sampling Oscilloscope

Printable Application Help

*P077102001*

077-1020-01

TekExpress® RIN Measurement Solution for DSA8300 Digital Serial Analyzer Sampling Oscilloscope

Printable Application Help

www.tek.com

077-1020-01

Copyright © Tektronix. All rights reserved. Licensed software products are owned by Tektronix or its subsidiaries or suppliers, and are protected by national copyright laws and international treaty provisions. Tektronix products are covered by U.S. and foreign patents, issued and pending. Information in this publication supersedes that in all previously published material. Specifications and price change privileges reserved.

TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.

TekExpress is a registered trademark of Tektronix, Inc.

Contacting Tektronix

Tektronix, Inc. 14150 SW Karl Braun Drive P.O. Box 500 Beaverton, OR 97077 USA

For product information, sales, service, and technical support:

■

In North America, call 1-800-833-9200.

■

Worldwide, visit www.tek.com to find contacts in your area.

Welcome .............................................................................................................................................. v

Getting help and support

Related documentation ................................................................................................................... 1

Conventions used in help ................................................................................................................ 2

Technical support ........................................................................................................................... 2

Getting started

Installing the software .................................................................................................................... 5

Minimum system requirements ................................................................................................. 5

Windows 7 user account settings .............................................................................................. 6

Install the software .................................................................................................................... 7

Verify application installation ................................................................................................... 7

View software version .............................................................................................................. 7

Required My TekExpress folder settings .................................................................................. 8

Map the My TekExpress folder to drive X ................................................................................ 8

Set the My TekExpress folder permissions ............................................................................... 9

Application directories and their contents ............................................................................... 10

File name extensions ............................................................................................................... 11

Where test files are stored ....................................................................................................... 11

Operating basics

Run the application ....................................................................................................................... 13

Exit the application ....................................................................................................................... 14

Application panels overview ........................................................................................................ 14

Global application controls ........................................................................................................... 16

Application controls ................................................................................................................ 16

Options menu overview ........................................................................................................... 17

TekExpress instrument control settings .................................................................................. 18

View connected instruments ................................................................................................... 19

Email settings .......................................................................................................................... 21

Configure email settings .......................................................................................................... 21

Application test panels .................................................................................................................. 23

Setup tabs ................................................................................................................................ 23

Preferences tab ........................................................................................................................ 29

TekExpress RIN Printable Application Help i

Table of Contents

Status panel overview .............................................................................................................. 30

Results panel ............................................................................................................................ 31

Reports panel ........................................................................................................................... 33

Pre-measurement calibration procedures

Pre-measurement calibration guidelines ....................................................................................... 39

Oscilloscope calibration ............................................................................................................... 40

Instrument noise measurement ..................................................................................................... 41

External attenuation ...................................................................................................................... 42

Instrument and DUT connection setup ......................................................................................... 44

Running tests ................................................................................................................................ 45

Prerun checklist ............................................................................................................................ 45

Saving and recalling test setup files

Test setup files overview .............................................................................................................. 47

Save a test setup file ..................................................................................................................... 47

Open (load) a saved test setup file ................................................................................................ 48

Create a new test setup file based on an existing one ................................................................... 48

TekExpress programmatic interface

About the programmatic interface ................................................................................................ 49

To enable remote access ............................................................................................................... 50

Requirements for developing TekExpress client .......................................................................... 52

Remote proxy object ..................................................................................................................... 53

Client proxy object ....................................................................................................................... 54

Client programmatic interface example ....................................................................................... 55

Program remote access code example .......................................................................................... 58

RIN programmer interface commands ......................................................................................... 59

ApplicationStatus() .................................................................................................................. 59

ChangeDutId() ......................................................................................................................... 60

CheckSessionSaved() .............................................................................................................. 61

Connect() ................................................................................................................................. 62

Disconnect() ............................................................................................................................ 63

GetCurrentStateInfo() .............................................................................................................. 64

GetDutId() ............................................................................................................................... 65

GetReportParameter() ............................................................................................................. 66

GetResultsValue() ................................................................................................................... 68

GetTimeOut() .......................................................................................................................... 70

ii TekExpress RIN Printable Application Help

Table of Contents

LockSession() .......................................................................................................................... 71

QueryStatus() ........................................................................................................................... 72

RecallSession() ........................................................................................................................ 73

Run() ........................................................................................................................................ 74

SaveSession() .......................................................................................................................... 74

SaveSessionAs() ...................................................................................................................... 75

SendResponse() ....................................................................................................................... 76

SelectDevice() ......................................................................................................................... 78

SelectSuite() ............................................................................................................................ 78

SelectTest() .............................................................................................................................. 79

SetDutId() ................................................................................................................................ 79

SetTimeOut() ........................................................................................................................... 80

setVerboseMode() ................................................................................................................... 81

TransferResult() ....................................................................................................................... 83

UnlockSession() ...................................................................................................................... 83

SetGeneralParameter command .............................................................................................. 85

Algorithms

RIN and RIN CW ......................................................................................................................... 89

RINxOMA .................................................................................................................................... 90

TekExpress RIN Printable Application Help iii

Table of Contents

iv TekExpress RIN Printable Application Help

Welcome

Welcome to the TekExpress® RIN Automated Measurement Solution Software application (referred as TekExpress RIN in the rest of the document). TekExpress RIN provides an automated, simple, and efficient way to take RIN (Relative Intensity Noise) and RINxOMA (Optical Modulation Amplitude) measurements on optical signals.

Key features of TekExpress RIN include:

■

Take accurate RIN (continuous waveform and NRZ modulated waveform) and RINxOMA measurements on repeating patterns.

■

Measure RIN on CW (continuous waveform) signal

■

Programmatic interface lets you run scripts for automated RIN testing

TekExpress RIN Printable Application Help v

Welcome

vi TekExpress RIN Printable Application Help

Getting help and support

Conventions used in help

Help uses the following conventions:

■

The term “DUT” is an abbreviation for Device Under Test.

■

The term “select” is a generic term that applies to the two methods of choosing a screen item (button, control, list item): using a mouse or using the touch screen.

Table 2: Icon descriptions

Icon Meaning

This icon identifies important information.

This icon identifies conditions or practices that could result in loss of data.

This icon identifies additional information that will help you use the application more efficiently.

Technical support

General information

Tektronix values your feedback on our products. To help us serve you better, please send us your suggestions, ideas, or comments on your application or oscilloscope. Contact Tektronix through mail, telephone, or the Web site. See

Contacting Tektronix at the front of this document for contact information.

When you contact Tektronix Technical Support, please include the following information (be as specific as possible):

■

All instrument model numbers

■

Hardware options, if any

■

Modules used

■

Your name, company, mailing address, phone number, FAX number

■

Please indicate if you would like to be contacted by Tektronix about your suggestion or comments.

2 TekExpress RIN Printable Application Help

Getting help and support

■

Application specific

information

Software version number

■

Description of the problem such that technical support can duplicate the problem

■

If possible, save the setup files for all the instruments used and the application

■

If possible, save the TekExpress setup files, log.xml, *.TekX (session files and folders), and status messages text file

TekExpress RIN Printable Application Help 3

Getting help and support

4 TekExpress RIN Printable Application Help

Getting started

Installing the software

Minimum system

requirements

The following table shows the minimum system requirements to run TekExpress RIN.

Table 3: System requirements

Component Description

Oscilloscope Tektronix DSA8300 Digital Serial Analyzer

Firmware Version: 6.4.1.0 or greater 80SJNB Software Version: 4.0.8.0 or greater Opt ADVTRIG Opt JNB01 80CXX series Optical Sampling module

Processor Same as the oscilloscope

Operating System Same as the oscilloscope:

■

Windows 7

■

Windows 7 user account settings

Memory Same as the oscilloscope

Hard Disk Same as the oscilloscope

Display Super VGA resolution or higher video adapter (800 x 600 minimum video

Firmware

resolution for small fonts or 1024 x 768 minimum video resolution for large fonts). The application is best viewed at 96 dpi display settings

■

TekScope 6.4.1.0 or greater (for Windows 7)

■

80SJNB SW Version: 4.0.8.0 or greater

If TekExpress is running on an instrument that has a video resolution less than 800x600, connect and configure a second monitor to the instrument.

TekExpress RIN Printable Application Help 5

Getting started

Component Description

Software

■

TekExpress Framework (version 4.0.x or greater) installed.

■

IronPython 2.7.3 installed

■

PyVisa 1.0.0.25 installed

■

Microsoft .NET 4.0 Framework

■

Opt ADVTRIG – Advanced triggers with pattern sync (required for RIN testing)

■

Microsoft Internet Explorer 7.0 SP1 or greater, or other Web browser for viewing reports

■

Adobe Reader software 7.0 or greater for viewing portable document format (PDF) files

Windows 7 user account

settings

Other Devices

■

Microsoft compatible mouse or compatible pointing device.

■

Two USB ports (four USB ports recommended).

Windows 7 instruments need to have the User Account Control Settings set to

Never Notify. To set User Account Control Settings:

1. Go to Control Panel > User Accounts > Change User Account Control settings.

2. Set it to Never Notify as shown in the image.

6 TekExpress RIN Printable Application Help

Getting started

Install the software

Use the following steps to obtain the latest TekExpress RIN software from the Tektronix Web site and install on any compatible instrument running Microsoft Windows 7 (32-bit). See Minimum system requirements for details.

1. Close all applications (including the TekScope application).

2. Go to the www.tek.com Web site and locate the Downloads fields.

3. Enter TekExpress RIN in the Model or Keyword field, select Software from the Select Download Type list, and click GO.

4. Select the latest version of software. Follow instructions to download the

software file.

5. Copy or download the RIN installer executable file to the oscilloscope.

6. Double-click the installer .exe file to extract the installation files and launch

the InstallShield Wizard. Follow the on-screen instructions.

Software is installed at C:\Program Files\Tektronix\TekExpress\TekExpress RIN

7. Verify application installation.

View software version

To verify the installation was successful:

1. Open the TekScope application.

2. Click the Application menu.

3. Verify that RIN is listed in the Application menu.

4. Click RIN to open the TekExpress RIN application. Verify that the

application opens successfully.

See also. Required My TekExpress folder settings

Use the following instructions to view version information for the application and for the application modules such as the Programmatic Interface and the Programmatic Interface Client.

To view version information for RIN, click the Options button in TekExpress and select About TekExpress.

TekExpress RIN Printable Application Help 7

Getting started

NOTE. This example shows a typical Version Details dialog box, and may not reflect the actual values as shown when you open this item in the application.

1. Map the My TekExpress folder to drive X

2. Set the My TekExpress folder permissions

See also. Application directories and usage

File name extensions

The first time you run TekExpress RIN, it creates the following folders on the oscilloscope:

■

\My Documents\My TekExpress\RIN

■

\My Documents\My TekExpress\RIN\Untitled Session

Shared My TekExpress folder is mapped to drive X: on the instrument running the RIN application. RIN uses this shared folder to save session waveform files and for other application file transfer operations.

Follow the below procedure to map the My TekExpress folder on the instrument to be drive X:

1. Open Microsoft Windows Explorer.

2. From the Windows Explorer menu, click Computer and select Map network drive.

3. Select the Drive letter as X: (if there is any previous connection on X:,

disconnect it first through Tools > Disconnect Network drive menu of Windows Explorer. If you do not see the Tools menu, press the Alt key).

4. In the Folder field, enter the remote My TekExpress folder path (for example, \\192.158.97.65\My TekExpress).

To determine the IP address of the instrument where the My TekExpress folder exists, do the following:

1. On the instrument where the My TekExpress folder exists, click Start and select Run.

2. Enter cmd and press Enter.

3. At the command prompt, enter ipconfig and press Enter.

8 TekExpress RIN Printable Application Help

NOTE. The My TekExpress folder has the share name format <domain><user ID>My TekExpress .

If the instrument is not connected to a domain, the share name format is <instrument name><user ID>My TekExpress .

NOTE. If the X: drive is mapped to any other shared folder, the application displays a warning message asking you to disconnect the X: drive manually.

File name extensions

Where test files are stored

The TekExpress RIN application uses the following file name extensions:

File name extension Description

.TekX Application session files (the extensions may not be displayed)

.py Python sequence file

.xml Test-specific configuration information (encrypted) files

Application log files

.wfm Test waveform files

.mht Test result reports (default)

Test reports can also be saved in HTML format

.pdf Test result reports

Application help document

.xslt Style sheet used to generate reports

Operating basics

Run the application

To launch the TekExpress RIN application, select Application > RIN from the TekScope menu. The oscilloscope opens the TekExpress RIN application:

When you first run the application after installation, the application checks for a file called Resources.xml located in the C:\Users\<username>\My Documents \My TekExpress\RIN folder. The Resources.xml file gets mapped to the X: drive when the application launches. Session files are then stored inside the X:\RIN folder.

The Resources.xml file contains information about available network-connected instruments. If this file is not found, the application runs an instrument discovery program to detect connected instruments before launching RIN.

NOTE. Do the steps in the Required My TekExpress folder settings topic before running tests with the RIN application for the first time.

To keep the RIN application window on top, select Keep On Top from the RIN

Options menu. If the application goes behind the oscilloscope application, click

Application > RIN to move the application to be in front.

TekExpress RIN Printable Application Help 13

Operating basics

Exit the application

Application controls

Application panel overview

Exit the application

To exit the application, click on the application title bar. Follow on-screen prompts to save any unsaved session, save test setup files, or exit the application.

NOTE. Using other methods to exit the application can result in abnormal termination of the application.

Application panels overview

TekExpress RIN uses panels to group related configuration, test, and results settings. Click on a button to open the associated panel. A panel may have one or more tabs that list the selections available in that panel. Controls in a panel can change depending on settings made in that panel or another panel.

14 TekExpress RIN Printable Application Help

Operating basics

Table 5: Application panels overview

Panel Name Purpose

Setup control overview The Setup panel shows the test setup controls. Click the Setup button to

open this panel. Use this panel to:

■

Set DUT parameters

■

Select tests

■

Set acquisition tab parameters

■

Set the configuration tab parameters

■

Set test notification parameters in the Preferences tab

Status View the progress and analysis status of the selected tests, and view test

logs.

Results View a summary of test results and select result viewing preferences.

Reports Browse for reports, save reports as specific file types, specify report

naming conventions, select report content to include (such as summary information, detailed information, user comments, setup configuration, application configuration), and select report viewing options.

Global application controls

Application controls

Table 6: Application controls descriptions

Item Description

Options menu

Test Panel buttons

Start / Stop button

Menu to display global application controls.

Controls that open panels for configuring test settings and options.

Use the Start button to start the test run of the measurements in the selected order. If prior acquired measurements have not been cleared, the new measurements are added to the existing set. The button toggles to the Stop mode while tests are running. Use the Stop button to abort the test.

Pause / Continue button

Use the Pause button to temporarily interrupt the current acquisition. When a test is paused, the button name changes to “Continue.”

16 TekExpress RIN Printable Application Help

Operating basics

Item Description

Clear button

Application window move icon

Use the Clear button to clear all existing measurement results. Adding or deleting a measurement, or changing a configuration parameter of an existing measurement, also clears measurements. This is to prevent the accumulation of measurement statistics or sets of statistics that are not coherent. This button is available only on the Results panel.

Place the cursor over the three-dot pattern in the upper left corner of the application window. When the cursor changes to a hand, drag the window to the desired location.

Options menu overview

The Options menu is located near the upper-right corner of the application.

The Options menu has the following selections:

Menu Function

Default Test Setup Opens an untitled test setup with defaults selected

Pattern Length: 511 Continuous Waveform: Not selected Data Rate: 25.781 Gbps Source: CH1 (CH3, if installed module is only CH3). Trigger Source: External Signal Conditioning: Filter

Values displayed in Wavelength, Filter, and Bandwidth fields depend on the installed optical module.

Open Test Setup Opens a saved test setup

Save Test Setup Saves the current test setup selections

Save Test Setup As Creates a new test setup based on an existing one

Open Recent Displays a menu of recently opened test setups to select from

Instrument Control Settings

Keep On Top Keeps the TekExpress RIN application on top of other open windows on

Email Settings Use to configure email options for test run and results notifications

Open Current Suite RunSession

Detects, lists, and refreshes the connected instruments found on specified connections (LAN, GPIB, USB, and so on)

the desktop

Allows the user to select the specific run setup, from the saved session

TekExpress RIN Printable Application Help 17

Operating basics

Menu Function

Help Displays the TekExpress RIN help

About TekExpress

■

Displays application details such as software name, version number, and copyright

■

Provides a link to the end-user license agreement

■

Provides a link to the Tektronix Web site

Options menu

TekExpress instrument

control settings

Tektronix TekExpress RIN User manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Table of Contents

Welcome

Getting help and support

Related documentation

Conventions used in help

Technical support

Getting started

Installing the software

Install the software

7. Verify application installation.

View software version

1. Map the My TekExpress folder to drive X

See also. Set the My TekExpress folder permissions

File name extensions

Where test files are stored

Operating basics

Run the application

Exit the application

Application panels overview

Global application controls

Application controls

Options menu overview