Tektronix TekExpress USB2 User manual

TekExpress® USB2 Automated Test Solution

Printable Application Help

*P077102100*

077-1021-00

TekExpress® USB2 Automated Test Solution

Printable Application Help

Supports TekExpress USB2 Product Firmware V1.0 and above

www.tektronix.com

077-1021-00

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.

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.tektronix.com to find contacts in your area.

Welcome .............................................................................................................................................. 5

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

Supported instruments ............................................................................................................... 6

Required windows 7 user account setting ................................................................................. 6

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

Verify application installation ................................................................................................... 8

Activate the license ................................................................................................................... 8

View software version ............................................................................................................... 8

Required my TekExpress folder settings ................................................................................... 9

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 controls ..................................................................................................................... 15

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

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

Instrument control settings ...................................................................................................... 18

View connected instruments ................................................................................................... 18

Email settings .......................................................................................................................... 20

Configure email settings .......................................................................................................... 20

Application Panels

Application panels overview ........................................................................................................ 23

TekExpress® USB2 Printable Application Help i

Table of Contents

Setup tab ....................................................................................................................................... 25

Setup controls overview .......................................................................................................... 25

Set DUT parameters ................................................................................................................ 26

Select tests ............................................................................................................................... 28

Set acquisition parameters ....................................................................................................... 29

Running tests on prerecorded (saved) waveforms .................................................................. 31

Configuration tab parameters .................................................................................................. 31

Configuration tab: global settings and measurement parameters ............................................ 32

Preferences tab ........................................................................................................................ 34

Status panel overview ................................................................................................................... 35

Results panel ................................................................................................................................. 37

Results panel overview ............................................................................................................ 37

Preferences menu .................................................................................................................... 38

View test-related files .............................................................................................................. 38

Plots panel ..................................................................................................................................... 39

Reports panel ................................................................................................................................ 40

Reports panel overview ........................................................................................................... 40

Select report options ................................................................................................................ 41

View a report ........................................................................................................................... 43

Report contents ........................................................................................................................ 43

Running tests

Test process flow .......................................................................................................................... 45

Instrument and DUT connection setup ......................................................................................... 45

Running tests ................................................................................................................................ 46

Prerun checklist ............................................................................................................................ 46

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

Run a saved test in prerecorded mode .......................................................................................... 49

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

TekExpress USB2 programmatic interface

About the programmatic interface ................................................................................................ 51

To enable remote access ............................................................................................................... 52

Requirements for developing TekExpress USB2 client ............................................................... 54

ii TekExpress® USB2 Printable Application Help

Remote proxy object ..................................................................................................................... 55

Client proxy object ....................................................................................................................... 56

Client programmatic interface example ....................................................................................... 58

Program remote access code example .......................................................................................... 60

Command list ................................................................................................................................ 61

Application status() ................................................................................................................. 61

Check session saved() ............................................................................................................. 62

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

Disconnect() ............................................................................................................................ 64

DUT automation() ................................................................................................................... 64

Enter controller PC IP address() .............................................................................................. 66

Get current status info() ........................................................................................................... 67

Get or set timeout value() ........................................................................................................ 68

Get pass fail status() ................................................................................................................ 70

Get report parameter() ............................................................................................................. 70

Get results value() ................................................................................................................... 72

Lock server() ........................................................................................................................... 73

Lock session() .......................................................................................................................... 73

Query status() ......................................................................................................................... 74

Register status change notification() ....................................................................................... 75

Run with set configurations or stop the run operation ............................................................ 76

Save, recall or query a saved session ...................................................................................... 78

Save session as() ...................................................................................................................... 80

Select device() ......................................................................................................................... 80

Select pre-recorded waveform files ......................................................................................... 81

Select port() ............................................................................................................................. 82

Select probe type() ................................................................................................................... 83

Get results value for sub measurement() ................................................................................. 85

Select power condition() ......................................................................................................... 86

Select qualifier() ...................................................................................................................... 87

Select single test() ................................................................................................................... 89

Select suite() ............................................................................................................................ 90

Select test method() ................................................................................................................. 90

Select test mode() .................................................................................................................... 92

Select test point:Near End() .................................................................................................... 93

Select test point:Far End .......................................................................................................... 95

Select Tier() ............................................................................................................................. 96

Send response() ....................................................................................................................... 98

Select versions() ...................................................................................................................... 99

Table of Contents

TekExpress® USB2 Printable Application Help iii

Table of Contents

Set or get the DUT ID ........................................................................................................... 100

Set instrument() ..................................................................................................................... 102

Set verbose mode() ................................................................................................................ 102

Status() ................................................................................................................................... 103

Transfer images() .................................................................................................................. 104

Transfer result() ..................................................................................................................... 105

Transfer waveforms() ............................................................................................................ 105

Unlock server() ...................................................................................................................... 106

Unlock session() .................................................................................................................... 106

Reference

Handle error codes ...................................................................................................................... 107

HSETT controller ....................................................................................................................... 108

Setting up controller PC for automated DUT test mode ....................................................... 108

Signal validation ......................................................................................................................... 108

iv TekExpress® USB2 Printable Application Help

Welcome

Welcome to the TekExpress® USB2 Automated Test Solution application. TekExpress USB2 is a Signal Quality, Non-Signal Quality, Power Measurement and Receiver Sensitivity Measurement solution, which provides an automated, simple, and efficient way to test USB2 interfaces and devices consistent to the requirements of the USB2 specifications.

Key features and benefits

■

Comprehensive test coverage; select or deselect individual tests

Precise debugging and troubleshooting

USB-IF Signal Quality measurements integrated with TekExpress USB2

Automated Receiver Sensitivity measurement

User-friendly interface for plot inspection

Minimizes user intervention when performing time-consuming testing

Consolidated report for High Speed, Full Speed and Low Speed measurements

Complete programmatic interface enables automation scripts to call TekExpress USB2 functions

■

Flexible probe configuration

■

Comprehensive signal validation check

■

Automated DUT test mode control

■

USB-IF Signal Quality measurements integrated with TekExpress USB2

Getting help and support

Conventions used in help

Online 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 for more 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

■

Probes 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® USB2 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 and send the setup files for all the instruments used and the application

■

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

■

If possible, save and send the waveform on which you are performing the measurement as a .wfm file

■

If possible, log files of Tektronix HSETT Controller from folder C:\Program Files\Tektronix\TekApplication\Tektronix.\HSETT Controller\

TekExpress® USB2 Printable Application Help 3

Getting help and support

4 TekExpress® USB2 Printable Application Help

Getting started

Installing the software

Minimum system

requirements

The following table shows the minimum system requirements needed for an oscilloscope to run TekExpress USB2.

Table 3: TekExpress USB2 system requirements

Component Requirement

Oscilloscope See Supported instruments

Processor Same as the oscilloscope

Operating System Same as the oscilloscope:

■

Windows 7 (64-bit only) SP1 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 resolution for small fonts or 1024 x 768 minimum video resolution

Firmware

Software

for large fonts). The application is best viewed at 96 dpi display settings

■

TekScope 6.8.1 and later (for Windows 7)

■

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

■

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

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

TekExpress® USB2 Printable Application Help 5

Getting started

Supported instruments

Table 4: Required equipment

Resource Model supported

Real-time oscilloscope Tektronix DPO/DSA/MSO70000C, D, and DX

series oscilloscopes (Windows 7 OS 64 bits) Tektronix MSO/DPO5000 and MSO/DPO5000B Series

Probes Two TCA-SMA cables

P7313SMA differential probe TCP0030A/TCP202/A probe TDP1500/TDP2500 differential probe P7500 differential probe

Host test fixtures USB-IF fixture set (host/device SQ and drop/

Device test fixtures USB-IF fixtures (host/device SQ and drop/droop)

Tektronix AWG instruments AWG7102, AWG7122 Series

droop) TDSUSBR (Tek fixture)

TDSUSBR (Tek fixture)

All AWG7000, AWG5000 Series AWG5014B, AWG5014C,AWG5012C, AWG5002C, AWG7001A, AWG7002A

Install the software

Use the following steps to obtain the latest TekExpress USB2 software from the Tektronix Web site and install on any compatible instrument running Microsoft Windows 7 (64-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 usb2 in the Model or Keyword field, select Software from the Select Download Type list, and click GO.

4. Select the latest version of software from the search result. Follow

instructions to download the software file.

5. Copy or download the TekExpress USB2 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 (x86)\Tektronix

\TekExpress\TekExpress USB2

7. Verify application installation

See also.

Minimum system requirements

Supported instruments

Required \My TekExpress folder settings

TekExpress® USB2 Printable Application Help 7

Getting started

Verify application

installation

Activate the license

To verify the installation was successful:

1. Open the TekScope application.

2. Click the Analyze menu.

3. Verify that TekExpress USB2 is listed in the Analyze menu.

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

opens successfully.

See also.

Activate the license

Required \My TekExpress folder settings

Activate the license using the Option Installation wizard in the TekScope application:

1. In the TekScope application menu bar, click Utilities > Option Installation.

TheTekScope Option Installation wizard opens.

2. Push the F1 key on the oscilloscope keyboard to open the Option Installation help topic.

View software version

3. Follow the directions in the help topic to activate the license.

See also.

View version and license information

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 TekExpress USB2, click the Options button and select About TekExpress.

To view license and option key information in the TekScope applicaion:

1. In the TekScope application, select Help > About TekScope.

The Options dialog box is displayed.

2. Scroll through the Options list to locate USB2: TekExpress USB2.

3. To view the Option installation key value, look below the Options list.

See also.

Activate the license

Options menu

8 TekExpress® USB2 Printable Application Help

Getting started

Required my TekExpress

folder settings

Set the my TekExpress

folder permissions

Before you run tests for the first time, you need to Set the \My TekExpress folder

permissions.

See also.

Application directories and usage

File name extensions

Make sure that the My TekExpress folder has read and write access. Also verify that the folder is not set to be encrypted:

1. Right-click the folder and select Properties.

2. Select the General tab and then click Advanced.

3. In the Advanced Attributes dialog box, make sure that the option Encrypt contents to secure data is NOT selected.

4. Click the Security tab and verify that the correct read and write permissions

are set.

See also.

Application directories and usage

File name extensions

TekExpress® USB2 Printable Application Help 9

Getting started

Application directories

and their contents

The TekExpress USB2 application files are installed at the following location:

C:\Program Files (x86)\Tektronix\TekExpress\TekExpress USB2

The following table lists the application directory names and their purpose.

Table 5: Application directories and usage

Directory names Usage

Bin Contains TekExpress USB2 application libraries

Compliance Suites Contains compliance-specific files

Examples Contains various support files

ICP Contains instrument and TekExpress USB2

application-specific interface libraries

Lib Contains utility files specific to the TekExpress

USB2 application

Report Generator Contains style sheets for report generation

Tools Contains instrument and TekExpress USB2

application-specific files

AWG Files Contains files required for Receiver Sensitivity

measurement

See also.

View test-related files

File name extensions

10 TekExpress® USB2 Printable Application Help

Getting started

File name extensions

Where test files are stored

The TekExpress USB2 application uses the following file name extensions:

File name extension Description

.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

.xslt Style sheet used to generate reports

See also.

View test-related files

Application directories and their contents

When you launch TekExpress USB2 for the first time, it creates the following folders on the oscilloscope:

■

\My Documents\My TekExpress\USB2

■

\My Documents\My TekExpress\USB2\Untitled Session

Every time you launch TekExpress USB2, an Untitled Session folder is created in the USB2 folder. The Untitled Session folder is automatically deleted when you exit the application. To preserve your test session files, save the test setup before exiting the application.

CAUTION.

Do not modify any of the session files or folders because this may result in loss of data or corrupted session files. Each session has multiple files associated with it. When you save a session, the application creates a .TekX file, and a folder named for the session that contains associated files, on the oscilloscope X: drive.

See also.

Set the \My TekExpress folder permissions

Application directories and usage

File name extensions

TekExpress® USB2 Printable Application Help 11

Getting started

12 TekExpress® USB2 Printable Application Help

Operating basics

Run the application

To start the TekExpress USB2 application, select Analyze > TekExpress USB2 from the TekScope menu.

The oscilloscope opens the TekExpress USB2 application:

When you first run the application after installation, the application checks for

Resources.xml located in the C:\Users\<username>\My TekExpress \USB2 folder. The Resources.xml file gets mapped to the X: drive when the

application launches. Session files are then stored inside the X:\USB2 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 TekExpress USB2.

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

TekExpress® USB2 Printable Application Help 13

Operating basics

To keep the TekExpress USB2 application window on top, select Keep On Top from the Options menu. If the application goes behind the oscilloscope application, click Analyze > TekExpress USB2 to move the application to be in front.

Exit the application

Required My TekExpress folder settings

Activate the license

Exit the application

Application controls

Application panel overview

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.

14 TekExpress® USB2 Printable Application Help

Operating basics

Application controls

Table 6: Application controls descriptions

Item Description

Options menu

Test Panel buttons

Menu to display global application controls.

Controls that open panels for configuring test settings and options.

Start / Stop button

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.

TekExpress® USB2 Printable Application Help 15

Operating basics

Item Description

Pause / Continue button

Clear button

Application window move icon

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

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

Options menu overview

The Options menu is located in 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

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 Detects, lists, and refreshes the connected

instruments found on specified connections (LAN, GPIB, USB, and so on)

Keep On Top Keeps the TekExpress USB2 application on top

of other open windows on the desktop

Email Settings Use to configure email options for test run and

results notifications

Help Displays the TekExpress USB2 help

About TekExpress

■

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

Options menu

■

Provides access to License information for your TekExpress USB2 installation

■

Provides a link to the Tektronix Web site

TekExpress® USB2 Printable Application Help 17

Operating basics

Use the Instrument Control Settings dialog box to view or search for connected instruments required for the tests. The application uses TekVISA to discover the connected instruments on all selected connection types.

NOTE. The correct instruments for the current test setup must be connected and recognized by the application before running tests.

To refresh the list of connected instruments:

1. From the Options menu, select Instrument Control Settings.

2. In the Search Criteria section of the Instrument Control Settings dialog

box, select the connection types of the instruments for which to search.

18 TekExpress® USB2 Printable Application Help

Operating basics

Instrument search is based on the VISA layer, but different connections determine the resource type, such as LAN, GPIB, and USB. For example, if you choose LAN, the search will include all the instruments supported by TekExpress that are communicating over the LAN.

3. Click Refresh. TekExpress searches for connected instruments.

4. After searching, the dialog box lists the instrument-related details based on

the search criteria you selected. For example, if you selected LAN and GPIB as the search criteria, the application checks for the availability of instruments over LAN, then GPIB, and then lists detected instruments on those connection types.

The Retrieved Instruments table lists instrument details. The time and date of the last time this table was updated is displayed in the Last Updated field.

Email settings

Use the Email Settings utility to configure email notifications to receive an email message when a test completes, produces an error, or fails. Select the type of test session information to include in the email, such as test reports and test logs, the email message format, and the email message size limit.

Select Options > Email Settings to open this dialog box.

NOTE. Recipient email address, sender’s address, and SMTP Server are mandatory fields.

Configure email settings

See also.

Configure email settings

Options menu

Select test notification preferences

Use the Email Settings dialog box to be notified by email when a test completes, fails, or produces an error:

1. Select Options > Email Settings to open the Email Settings dialog box.

2. (Required) For Recipient email Address(es), enter one or more email

addresses to which the test notification has to be sent. To include multiple addresses, separate the addresses with commas.

3. (Required) For Sender’s Address, enter the email address used by the instrument. This address consists of the instrument name followed by an underscore followed by the instrument serial number, then the @ symbol and the email server used. For example: DPO72016C_B130099@yourcompany.com.

20 TekExpress® USB2 Printable Application Help

+ 94 hidden pages

Tektronix TekExpress USB2 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

Supported instruments

Install the software

Activate the license

View software version

File name extensions

Where test files are stored

Operating basics

Run the application

Exit the application

Application controls

Options menu

Options menu overview

Use the Instrument Control Settings dialog box to view or search for connected instruments required for the tests. The application uses TekVISA to discover the connected instruments on all selected connection types.

Email settings

Configure email settings