Tektronix TekExpress USB 3.0 User manual

Download

TekExpress®USB

ZZZ

USB 3.0 Automated Test Solution Software

Printable Application Help

*P077085300*

077-0853-00

TekExpress®USB USB 3.0 Automated Test Solution Software

ZZZ

Printable Application Help

www.tektronix.com

077-0853-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. Speciﬁcations and price change privileges reserved.

TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.

TekExpress is a registered trademark of Tektronix, Inc.

TriMode is a trademark of Tektronix, Inc.

TekExpress USB 3.0 Application Help, 076-0321-00.

Contacting Tektronix

Tektronix, Inc. 14150 SW P.O . B o x 5 0 0 Beaverton, OR 97077 USA

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

In Nor Worldwide, visit www.tektronix.com to ﬁnd contacts in your area.

Karl Braun Drive

th America, call 1-800-833-9200.

Table of Contents

Getting help and support

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

Conventions used in help .......................................................................................... 1

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

Getting started

Installing the software

Minimum system requirements . ................................ ................................ ............. 3

Windows 7 user account settings.......... .................................. ................................ . 4

Supported instruments......................................................................................... 5

Install the software........ .................................. ................................ ................... 6

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

Activate the license............................................................................................ 7

View software version and license information . ................................ ........................... 8

Required \My TekExpress folder settings .... ..... ..... .... . .... . .... ..... ..... .... . .... . .... . .... ..... ... . . 9

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

Set the \My TekExpress folder permissions ............................................................... 11

Application directories and their contents ................................................................. 12

File name extensions ......................................................................................... 13

Where test ﬁles are stored.................................. ................................ .................. 14

TekExpress

USB key features ........................ ................................ .......................... 15

Table of Contents

Operating basics

Run the application ................................................................................................ 17

Exit the application ................................................................................................ 18

Application controls and menus

Global application controls

Application controls ..... ................................ ................................ ................ 18

Options menu

Options menu overview ............................................................................ 19

TekExpress instrument control settings

Instrument control settings .... . .... ..... ..... .... . .... . .... . .... . .... ..... ..... ..... ... . . .... . .... . 20

View connected instruments ....................................................................... 21

Email settings

Email settings.......................... ................................ .............................. 23

Conﬁgure email settings... . .... ..... ..... .... . .... . .... ... . . .... . .... ..... ..... .... . .... . .... .... . . 23

Application test panels

Application panels overview............................................................................ 26

TekExpress USB Automated Test Solution Help i

Table of Contents

Setup tabs

Setup control overview ............................................................................. 27

Set DUT parameters .................... .................................. .......................... 27

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

Acquisitions tab

Set acquisition parameters ......................................................................... 30

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

Conﬁgure test parameters

Conﬁguration tab parameters ...... ................................ ................................ 32

Conﬁguration tab: Global Settings parameters ... . .... . .... ..... .... . .... . .... ..... ..... .... . ... 33

Conﬁguration tab: Measurements ................................................................. 35

Preferences tab ........................................................................................... 36

Status panel overview ................... ................................ ................................ 37

Results panel

Results panel overview ....... .................................. ................................ .... 38

Preferences menu ....................... .................................. .......................... 39

View test-related ﬁ les ............................. ................................ .................. 40

Reports panel

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

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

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

Report contents .............................. ................................ ........................ 44

Running tests

Test proc ess ﬂow................................................................................................... 45

Deskew real-time oscilloscopes... . .... ..... .... . .... . .... ..... .... . .... . .... ... . . .... . .... ..... ... . . .... ..... ... 45

Instrument and DUT connection setup.. ................................ ................................ ........ 47

Running tests....................................................................................................... 47

Prerun checklist.................................................................................................... 48

Saving and recalling test setup ﬁles

Test setup ﬁles overview.......................................................................................... 49

Save a test setup ﬁ le............................................................................................... 49

Open (load) a saved test setup ﬁle ............................................................................... 50

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

TekExpress programmatic interface

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

To enable remote access .......................................................................................... 51

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

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

Client proxy object .......................... ................................ ................................ ...... 55

ii TekExpress USB Automated Test Solution Help

Table of Contents

Client programmatic interface example. .................................. ................................ ...... 57

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

USB-TX programmer interface commands

Command list

ApplicationStatus() ...................................................................................... 61

ChangeDutId() ............................... ................................ ............................ 62

CheckSessionSaved()............................ ................................ ........................ 64

Connect() ......................... .................................. ................................ ...... 64

Disconnect() ............ .................................. ................................ ................ 67

GetCurrentStateInfo() ....... ................................ ................................ ............ 68

GetDutId() ............................ .................................. ................................ .. 70

GetPassFailStatus() ...................................................................................... 71

GetReportParameter() ................................................................................... 71

GetResultsValue()........................................................................................ 73

GetTimeOut()............................................................................................. 74

LockSession() ............................................................................................ 75

QueryStatus()................... ................................ .................................. ........ 76

RecallSession()..... .................................. ................................ .................... 77

Run() ...................................................................................................... 78

SaveSession()............................................................................................. 79

SaveSessionAs() ......................................................................................... 80

SendResponse() ...... ................................ .................................. .................. 81

SelectDevice().......... ................................ .................................. ................ 82

SelectSuite() .......... .................................. ................................ .................. 83

SelectTest() ............................................................................................... 84

SetDutId()................................................................................................. 85

The SetGeneralParameter command

SetGeneralParameter().............. ................................ ................................ 85

paramString values for SetGeneralParameter command

Select test p

Select test method................................................................................... 87

Set SSC mode ....................................................................................... 88

Set de-embed ﬁlter mode........................................................................... 88

Select de-embed ﬁlter ﬁle ...... ................................ ................................ .... 89

Set embed ﬁlter mode............................................................................... 90

Select embed ﬁlter ﬁle ............................ ................................ .................. 91

Set CTLE ﬁlter mode ............. ................................ ................................ .. 92

Select CTLE ﬁlter ﬁle ...... ................................ .................................. ...... 92

Set probing conﬁguration .......................................................................... 93

Set b andwidth for LFPS acquisition .. ..... ..... .... . .... . .... ..... ... . . .... . .... ..... .... . .... . .. 93

Set CM Measurement TriMode™ Probe mode .................................................. 94

Set Auto Recovery mode........................................................................... 94

oint.......................... .................................. .......................... 87

TekExpress USB Automated Test Solution Help iii

Table of Contents

Set verify toggle mode.............................................................................. 95

Set record length .................................................................................... 95

Set LFPS trigger lower limit . .... ..... ... . . .... . .... ..... .... . .... . .... ..... ... . . .... . .... ..... .... 96

Set LFPS trigger upper limit . .... ..... ... . . .... . .... ..... .... . .... . .... ..... ... . . .... . .... ..... .... 96

Set LFPS trigger level ... ..... .... . .... . .... ..... ..... .... . .... . .... ..... ..... .... . .... . .... ..... ... 97

Set LFPS mid edge reference level.. .... . .... . .... ..... ..... .... . .... . .... ..... ..... .... . .... . .... 97

Set hysteresis level .......................... .................................. ...................... 98

Set AFG number of cycles ......................................................................... 98

Set AFG frequency...... ................................ .................................. .......... 99

Set AFG voltage level high ........................................................................ 99

Set AFG voltage level low ....................................................................... 100

Set signal pattern validation mode .............................................................. 100

SetTimeOut() ........................................................................................... 101

setVerboseMode().................. .................................. ................................ .. 102

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

Stop() ............................ ................................ ................................ ........ 104

TransferImages() ....................................................................................... 105

TransferReport() ........................... .................................. .......................... 106

UnlockSession()........................................................................................ 107

Select panel parameters ....... ................................ .................................. ...... 108

Reference

Handle error codes......................................... ................................ ...................... 111

Limits Editor: compare string deﬁnitions... .... . .... . .... . .... . .... ..... ... . . .... . .... . .... ..... ..... .... . ... 111

De-Embedding and channel embedding information

De-Embedding and channel embedding overview.............................. ........................ 112

Host ﬁlter information.......................... ................................ ............................ 113

Device ﬁlter information........................... .................................. ...................... 116

DUT/Filter combinations . ..... .... . .... . .... ... . . .... . .... ..... ... . . .... . .... ..... .... . .... . .... ... . . .... . 118

Creating ﬁlter ﬁles with SDLA

SDLA ﬁlter creation requirements ........................................................................ 118

Setting up SDLA to generate USB Tx ﬁlters .. .................................. ........................ 119

To create a CTLE ﬁlter using SDLA .. ................................ ................................ ........ 120

To create a device back panel ﬁlter using SDLA............................................................. 121

To create a host ﬁlter using SDLA............................................................................. 123

Signal validation

LFPS pattern type validation . .... . .... ... . . .... . .... .... . .... . .... .... . .... . .... .... . .... . .... .... . .... . .. 124

CP0 pattern type validation................................................................................ 125

CP1 pattern type validation................................................................................ 125

CP0 CP1 CP7 toggle mechanisms

Oscilloscope-based toggle .... . .... ... . . .... . .... . .... ..... .... . .... . .... . .... ..... .... . .... . .... . .... ..... 126

AWG-based toggle.......................................... .................................. .............. 127

iv TekExpress USB Automated Test Solution Help

Index

Table of Contents

AFG-based toggle .......................................................................................... 128

Manual toggle............. ................................ ................................ .................. 130

TekExpress USB Automated Test Solution Help v

Table of Contents

vi TekExpress USB Automate d Test Solution Help

Getting help and support Related documentation

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.

TekExpress USB Automated Test Solution Help 1

Getting help and support Technical support

Table 2: Icon descriptions

Icon Meaning

This icon identiﬁes important information.

This icon identiﬁes conditions or practices that could result in loss of data.

This icon identiﬁes additional information that will help you use the application more efﬁciently.

xxx

Technical support

Tektronix values your feedback on our products. To help us serve you better, please send us your suggesti telephone, or the Web site. See Contacting Tektronix

ons, ideas, or comments on your application or oscilloscope. Contact Tektronix through mail,

for more information.

When you c

ontact Tektronix Technical Support, please include the following information (be as speciﬁcas

possible):

General information

All instrument model numbers

Hardware options, if any

sused

Probe

Yo ur name, company, mailing address, phone number, FAX number

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

lication speciﬁc information

App

Software version number

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

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

If possible, save the TekExpress setup ﬁles, log.xml, *.TekX (session ﬁles and folders), and status

messages text ﬁle

If possible, save the waveform on which you are performing the measurement as a .wfm ﬁle

2 TekExpress USB Automated Test Solution Help

Getting started Minimum system requirements

Minimum system requirements

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

Table 3: Syst

Oscilloscope See Supported instruments (see page 5)

Processor Operating System Same as the oscilloscope:

Memory

Hard Disk

Display

Firmware

em requirements

Same as the oscilloscope

Windows 7 (64-bit only) SP1 Windows 7 user account settings (see page 4) Same as the oscilloscope Same as the oscilloscope Super VGA resolution or higher video adapter (800 x 600 minimum video resolution

for small fonts or 1024 x 768 minimum video resolution for large fonts). The

ation is best viewed at 96 dpi display settings

applic

pe 6.7.4.3 and later (for Windows 7)

TekS co

TekExpress USB Automated Test Solution Help 3

Getting started Windows 7 user account settings

Table 3: System requirements (cont.)

Software TekExpress Framework (version 3.0.x or later) installed.

Microsoft .NET 4.0 Framework

SigTest 3.2.x or later installed.

DPOJET Jitter and Eye Analysis Tool (version 6.0.x or later) with Advanced Jitter

and Eye analysis (DJA option) installed.

(Optional- required for USB3 testing) SuperSpeed USB DPOJET Module

(DPOJET option USB3)

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)

ﬁles.

(Optional) Serial Data Link Analysis (SDLA) software for Channel De-Embed,

for custom ﬁlter development.

Other Devices Microsoft compatible mouse or compatible pointing device.

Two USB ports (four USB ports recommended).

PCI-GPIB or equivalent interface for instrument connectivity2.

xxx

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

Express is installed on a Tektronix oscilloscope, TekExpress cannot use the virtual GPIB port to communicate with oscilloscope applications.

If Tek If using external devices for instrument connectivity (such as USB-GPIB adapters or equivalent), enable the Talker Listener utility in the GPIB menu of the Tektronix MSO/DPO/DSA oscilloscope.

Windows 7 user account settings

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.

4 TekExpress USB Automated Test Solution Help

Getting started Supported instruments

See also

Support

ed oscilloscopes

(see page 5)

Supported instruments

Table 4: Required equipment

Resource Model supported

time oscilloscope

Real-

Probes

Host test ﬁxtures TF-USB3-A-P (for best signal quality)

Compliance testing: Tektronix MSO/DPO/DSA71000 Series oscilloscopes with a bandwidth of 12 GHz or greater

ative measurements: MSO/DPO/DSA70804 Series oscilloscopes

Norm

CS-SMA cables

Two T P7313SMA differential probe P7500 differential probe

r more mechanical ﬂexibility use TF-USB-B-R (with included 13 cm USB

3.0 Cable - Part number 174-5772-00). For precision De-embed of TF-USB3-A plug ﬁxture, order TF-USB3-AB-KIT

ncludes Cal Kit).

(i TF-USB3-KIT (includes short USB 3.0 cable) USB-IF ﬁxtures

TekExpress USB Automated Test Solution Help 5

Getting started Install the software

Table 4: Required e quipment (cont.)

Resource Model sup po rted

Device test ﬁxtures TF-USB3-A-R (includes short USB 3.0 Cable)

USB-IF ﬁxtures

Tektronix AWG/AFG instruments Tektronix AWG7102, AWG7122 Series with options 6,8

Tektronix AWG5014B, AWG5014C Tektronix AFG3252, AFG3252C, AFG3251, AFG3251C, AFG3102,

AFG3102C, AFG3101, AFG3101C

xxx

Available through USB-IF.

See also

Minimum system requirements (see page 3)

Install the software

Use the following steps to obtain the latest USB-TX software from the Tektronix Web site and install on any compatible instrument running Microsoft Windows 7 (64-bit). See Minimum System Requirements

(see page 3) for details.

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

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

3. Ente

r tekexpress usb in the Model or Keyword ﬁeld, select Software from the Select Download

Type list, and click GO.

4. Sel

ect the latest version of software. Follow instructions to download the software ﬁle.

5. Copy or download the USB-TX installer executable ﬁle to the oscilloscope.

6. Double-click the installer .exe ﬁle to extract the installation ﬁles and launch the InstallShield Wizard.

Follow the on-screen instructions.

Software is installed at

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

7. Verify application installation (see page 7)

See also

Minimum system requirements (see page 3) Supported instruments (see page 5) Required \My TekExpress folder settings (see page 9)

6 TekExpress USB Automated Test Solution Help

Getting started Verify application installation

Verify application installation

To verify the installation was successful:

1. Open the TekScope application.

2. Click the Analyze menu.

3. Verify that Te kExp ress USB is listed in the Analyze menu.

4. Click Te kEx

successfully.

press USB to open the USB-TX application. Verify that the application opens

See also

Activate the license (see page 7) Required \My TekExpress folder settings (see page 9)

Activate the license

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

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

The Te

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

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

See

kScope Option Installation wizard opens.

also

View version and license information (see page 8)

quired \My TekExpress folder settings

TekExpress USB Automated Test Solution Help 7

(see page 9)

Getting started View software version and license information

View software version and license information

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 USB-TX:

1. In the USB-TX application, click the Options button and select About TekExpress.

2. Click the View Version Details link to view the version numbers of the installed test suites.

NOTE. This example shows a typical Version Details dialog box, and may not reﬂect the actual values as show

To view license and option key information:

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

2. Scroll through the Options section list to locate USB: TekExpress USB.

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

n when you open this item in the application.

See also

Activate the license (see page 7) Options menu (see page 19)

8 TekExpress USB Automated Test Solution Help

Getting started Required \My TekExpress folder settings

Required \My TekExpress folder settings

Before you run tests for the ﬁrst time, do the following:

1. Map the \My TekExpress folder to Drive X

2. Set the \My TekExpress folder permissions (see page 11)

(see page 10)

See also

Application directories and usage (see page 12) File name extensions (see page 13)

TekExpress USB Automated Test Solution Help 9

Getting started Map the My TekExpress folder to drive X

Map the My TekExpress folder to drive X

The ﬁrst time you run TekExpress USB, it creates the following folders on the oscilloscope:

\My Documents\My TekExpress\USB

\My Documents\My TekExpress\USB\Untitled Session

YouneedtomapthesharedMy Te kExpress folder as drive X: on the instrument running the USB-TX application. USB-TX uses this shared folder to save session waveform ﬁles and for other application ﬁle transfer operations.

To map the My TekExpress folder on the instrument to be drive X:

1. Open Microsoft Windows Explorer.

2. From the W

3. Select the Drive letter as X: (if there is any previous connection on X:, disconnect it ﬁrst through

Tools > D press the Alt key).

4. In the F

My TekExpress

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

To det

1. On the instrument where the

2. Enter cmd and press Enter.

3. At the command prompt, enter ipconﬁg and press Enter .

NOTE. The My TekExpress folder has the share name format

If the instrument is not connected to a domain, the share name format is

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.

indows Explorer menu, click Computer and select Map network drive.

isconnect Network drive menu of Windows Explorer. If you do not see the Tools menu,

older ﬁeld, enter the remote

My TekExpress folder exists, click Start and select Run.

My TekExpress folder path (for example, \\192.158.97.65\

<domain><user ID>My TekExpress

<instrument name><user

See also

Set the \My TekExpress folder permissions (see page 11) Application directories and usage (see page 12) File name extensions (see page 13)

10 TekExpress USB Automated Test Solution Help

Getting started Set the \My TekExpress folder permissions

Set the \My TekExpress folder permissions

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

the \My TekExpress folder to Drive X

Map Application directories and usage (see page 12) File name extensions (see page 13)

TekExpress USB Automated Test Solution Help 11

(see page 10)

Getting started Application directories and their contents

Application directories and their contents

TekExpress US

B application

The TekExpress USB application ﬁles are installed at the following location:

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

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

Table 5: Application directories and usage

Directory names Usage

Bin Compliance Suites Contains compliance-speciﬁc ﬁles Documents

Examples ICP Contains instrument and USB-TX application-speciﬁc

Lib Report Generator Contains style sheets for report generation Tools

xxx

Contains USB-TX application libraries

Contains the technical documentation for the USB-TX application

Contains various support ﬁles

interface libr a ries Contains utility ﬁles speciﬁc to the USB-TX application

Contains instrument and USB-TX application-speciﬁc ﬁles

See also

View test-related ﬁles (see page 40) File name extensions (see page 13)

12 TekExpress USB Automated Test Solution Help

Getting started File name extensions

File name extensions

The TekExpress USB application uses the following ﬁle name extensions:

File name extension Description

.TekX

.py

.xml

.wfm Test wavef .mht

.ﬂt Filter ﬁles .xslt

xxx

See also

Application session ﬁles (the extensions may not be displayed)

Python sequence ﬁle Test-speciﬁcconﬁguration information (encrypted) ﬁles Applicati

Test resu Test reports can also be savedinHTMLformat

page 41)

Style sheet used to generate reports

on log ﬁles

orm ﬁles

lt reports (default)

(see

View test-related ﬁles (see page 40) Application directories and their contents (see page 12)

TekExpress USB Automated Test Solution Help 13

Getting started Where test ﬁles are stored

Where test ﬁles are stored

When you launch TekExpress USB for the ﬁrst time, it creates the following folders on the oscilloscope:

\My Documents\My TekExpress\USB

\My Documents\My TekExpress\USB\Untitled Session

Every time you launch TekExpress USB, an Untitled Session folder is created in the USB folder. The

Untitled Session folder is automatically deleted when you exit the USB application. To preserve your

test session ﬁles, save the test setup before exiting the TekExpress application.

CAUTION. Do not modify any of the session ﬁles or folders because this may result in loss of data or corrupted session ﬁles. Each session has multiple ﬁles associated with it. When you save a session, a .TekX ﬁle, and a

See also

Map the \My TekExpress folder to Drive X (see page 10) Set the \My TekExpress folder permissions (see page 11) Application directories and usage (see page 12) File name extensions (see page 13)

folder named for the session that contains associated ﬁles, is created on the oscilloscope X: drive.

14 TekExpress USB Automated Test Solution Help

Getting started TekExpress®USB key features

TekExpress®USB key features

Welcome to the TekExpress® U SB Automated Test Solution Software application (referred to as TekExpress USB or USB in the rest of the document). TekExpress USB provides an automated, simple, and efﬁcient way to test USB transmitter interfaces and devices consistent to the requirements of the USB 3.0 speciﬁcations.

Key features and beneﬁts of TekExpress USB include:

Comprehensive test coverage; select or deselect individual tests

Precise debugging and troubleshooting

Accurate and reliable results

Intel SigTest is integrated into the TekExpress framework

Reduced time required to run tests

Minimizes user intervention when performing time-consuming testing

SSC Measurements controlled through a single UI control

Able to select individual ﬁlters for de-embedding, embedding, and equalization

Automatically detect Tektronix TriMode™ P7500 series probes

De-emphasis measurement uses CP7 pattern

Automatic compliance pattern toggle from CP1-CP7

Consolidated report with both SigTest and DPOJET measurement results

LFPS Vcm-AC measurement support using a Tektronix TriMode Probe

TekExpress USB Automated Test Solution Help 15

Getting started TekExpress®USB key features

Conﬁguration panel features:

DUT speciﬁcAFG/AWGconﬁguration for pattern toggle

Automatically save channel waveforms.

Support common mode measurements with TriMode P7500 series probes

Automatica not use’

Extended pr

Complete programmatic interface enables automation scripts to call USB-TX functions

NOTE. The

USB 3.0 near end measurement ‘Vtx-de-ratio’ analyzes using the CP7 pattern.

lly recover oscilloscope settings when ‘CP0 CP1 CP7 Toggle using’ is s et to ‘Do

obing conﬁgurations (Single Ended (Ch1-Ch3), Single Ended (Ch2-Ch4))

16 TekExpress USB Automated Test Solution Help

Operating basics Run the application

Run the application

To launch the TekExpress USB application, do either of the following:

Select Analyze > TekExpress USB from the TekScope menu.

Double-click any saved TekExpress USB session ﬁle (<ﬁle name>.TekX).

The oscilloscope opens the TekExpress USB application:

When you ﬁrst run the application after installation, the application checks for a ﬁle called

Resources.xml located in the C:\Users\<username>\My TekExpress\USB folder. The

Resources.xml ﬁle gets mapped to the

de the

insi instruments. If this ﬁle is not found, the application runs an instrument discovery program to detect connected instruments before launching USB.

NOTE. Do the steps in the Required \My TekExpress folder settings tests with the USB application for the ﬁrst time.

To keep the USB application window on top, select Keep On Top from the USB Options menu (see

page 19). If the application goes behind the oscilloscope application, click Analyze > TekExpress USB

to move the application to be in front.

TekExpress USB Automated Test Solution Help 17

X:\USB folder. The Resources.xml ﬁle contains information about available network-connected

X: drive when the application launches. Session ﬁles are then stored

(see page 9) topic before running

Operating basics Exit the application

See also

Required My TekExpress folder settings (see page 9) Activate the license (see page 7) Exit the application (see page 18) Application Application panel overview (see page 26)

controls

(see page 18)

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 ﬁles, or exit the application.

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

Application controls

Table 6: Application controls descriptions

Item Description

Options menu (see page 19)

Test Panel buttons (see page 26)

Start / Stop button Use the Start button to start the test run of the measurements in the selected order.

Pause / Continue button

Menu to display global application controls.

Controls that open panels for conﬁguring test settings and options.

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.

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

18 TekExpress USB Automated Test Solution Help

Operating basics Options menu overview

Table 6: Application controls descriptions (cont.)

Item Description

Clear button Use the Clear button to clear all existing measurement results. Adding or deleting a

measurement, or changing a conﬁguration 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

Application window move icon

xxx

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.

(see page 38).

See also

Application panel overview (see page 26)

Options menu overview

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

The Options menu

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

Instrument Control Settings (see page 20) Detects, lists, and refreshes the connected instruments

Keep O n Top Keeps the TekExpress USB application on top of other open

Email Settings (see page 23) Usetoconﬁgure email options for test run and results

(see page 20) has the following selections:

from

found on speciﬁed connections (LAN, GPIB, USB, and so on)

windows on the desktop

notiﬁcations

TekExpress USB Automated Test Solution Help 19

Operating basics Instrument control settings

Menu Function

Help About TekExpress

Displays the TekExpress USB help

Displays application details such as software name,

version numbe

r, and copyright

xxx

Options menu

See also

Provides acc

your USB-TX installation

Provides a l ink to the Tektronix Web site

ess to license i nformation

(see page 8) for

Application controls (see page 18)

Instrument control settings

Use the TekExpress Instrument Control Settings dialog box to search for and list the connected resources (instruments) found on speciﬁed connections (LAN, GPIB, USB, and so on), and each instruments connection information.

Access this dialog box from the Options menu.

20 TekExpress USB Automated Test Solution Help

Operating basics View connected instruments

Use the Instrument Control Settings feature to search for connected instruments (see page 21) and view instrument connection details. Connected instruments displayed here can be selected for use under Global Settings in the test conﬁguration section.

See also

Options menu overview (see page 19)

View connected instruments

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 USB-TX 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.

Instrument search i s 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.

TekExpress USB Automated Test Solution Help 21

Operating basics View connected instruments

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 details of the instruments are displayed in the Retrieved Instruments table. The time and date of instrument refresh is displayed in the Last Updated ﬁeld.

See also

Conﬁguration test parameters (see page 35) Equipment connection setup (see page 47)

22 TekExpress USB Automated Test Solution Help

Operating basics Email settings

Email settings

Use the Email Settings utility to conﬁgure email notiﬁcations (see page 23) to receive notiﬁcations when a test completes, produces an error, or fails. Select the type of test session information to include in the notiﬁcation

Select Options > Email Settings to open this dialog box.

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

, such as test reports and test logs, the email message format, and the email message size limit.

See also

Conﬁgure email settings (see page 23) Options menu (see page 19) Select test notiﬁcation preferences (see page 36)

Conﬁgure email settings

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

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

2. (Required) For Recipient email Address(es), enter one or more email addresses to which to send the

test notiﬁcation. To include multiple addresses, separate the addresses with commas.

TekExpress USB Automated Test Solution Help 23

(see page 25) dialog box.

Operating basics Conﬁgure email settings

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 th

4. (Required) In the Server Conﬁguration section, type the SMTP Server address of the Mail server conﬁgured at

If this server requires password authentication, enter a valid login name, password, and host name in the corre

NOTE. If any of the above required ﬁelds are left blank, the settings will not be saved and email notiﬁcations will not be sent.

5. In the Email Attachments section, select from the following options:

e email server used. For example: DPO72016C_B130099@yourcompany.com.

the client location, and the SMTP Port number, in the corresponding ﬁelds.

sponding ﬁelds.

Reports

Status Log: Select to receive the test status log with the notiﬁcation email. If you select this

option

6. In the Email Conﬁguration section:

Select the message ﬁle format to send: HTML (the default) or plain text.

Enter a maximum ﬁle siz e for the email message. Messages with attachments larger than this limit will not be sent. The default is 5 MB.

Enter the number in the Number of Attempts to Send ﬁeld, to limit the number of attempts that the system makes to send a notiﬁcation. The default is 1. You can also specify a timeout period.

7. Select the Email Test Results When complete or on error check box. Use this check box to quickly enable or disable email notiﬁcations.

8. To test your email settings, click Te st Ema i l.

9. To apply your settings, click Apply.

10. Click Close when ﬁnished.

: Select to receive the test report with the notiﬁcation email.

, then also select whether you want to receive the full log or just the last 20 lines.

24 TekExpress USB Automated Test Solution Help

Operating basics Conﬁgure email settings

Email settings

TekExpress USB Automated Test Solution Help 25

Operating basics Application panels overview

Application panels overview

TekExpress USB uses panels to group related conﬁguration, 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.

Table 7: Application panels overview

Panel Name Purpose

Setup (see page 27) The Setup panel shows the test setup controls. Click the Setup button to open

this panel. Use this panel to:

Select DUTparameters (see page 27).

Select the test(s) (see page 28).

Set acquisitions parameters (see page 30) for selected tests.

Conﬁguration test parameters (see page 35)

Select test notiﬁcation preferences (see page 36). Status (see page 37) View the progress and analysis status of the selected tests, and view test logs. Results (see page 38) View a summary of test results and select result viewing preferences. Reports (see page 40) Browse for reports, save reports as speciﬁc ﬁle types, specify report naming

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

xxx

26 TekExpress USB Automated Test Solution Help

Operating basics Setup control overview

See also

Application controls (see page 18)

Setup control

The Setup pan execution process. Click on a tab to open the associated controls.

overview

el contains sequentially ordered tabs that help guide you through a typical test setup and

The tabs on this panel are:

DUT: S

Test Selection: Select test(s) (see page 28)

Acquisitions: Select acquisition parameters (see page 30)

Conﬁguration: Set conﬁguration parameters (see page 35)

Preferences: Select test fail notiﬁcation preferences (see page 36)

et the DUT parameters

Set DUT parameters

Use the DUT tab to select parameters for the device under test. The settings are global and apply to all tests for the current session. DUT settings also affect the list of available tests in the Test Selection tab.

Click Setup > DUT to access the DUT parameters:

(see page 27)

TekExpress USB Automated Test Solution Help 27

Operating basics Select tests

Table 8: DUT tab settings

Setting Description

DUT ID

Adds an option

al text label for the DUT to reports. The default value is DUT001. The

maximum number of characters is 32. You cannot use the following characters in a ID name: (.,..,...,\,/:?”<>|*) Opens a Comments dialog box in which to enter optional text to add to a report.

Comments icon (to the right

of the DUT ID ﬁeld)

Maximum siz test report, see Select report options

e is 256 characters. To enable or disable comments appearing on the

(see page 41).)

Acquire live w aveforms Acquire active signals from the DUT for measurement and analysis. Use prerecorded waveform ﬁles Run tests on a saved waveform. Open (load) a saved test setup (see page 50) Version

Lists the supported USB test speciﬁcation(s). Electrical Test Spec Lists the supported electrical test speciﬁcation(s). Select DUT Sets the DUT device type to test (Device or H o st). Test Mode

Compliance: Preselects tests and parameters needed to meet compliance

speciﬁcations for the selected device type. Disables the compliance ﬁlter controls.

User Deﬁned: Enables the user to select speciﬁc tests and set custom

parameters for tests (using the Conﬁguration button).

Device Pro ﬁ le

Select Test Method Select the algorithms used to measure and analyze the signal. DPOJET is the

default test method. Test point

Select the appropriate test point location from those listed.

Only Compliance (TP1) - Far End test point is available when Sigtest o r Both are

selected. Spread Spectrum C locking Select this check box if your DUT supports Spread Spectrum Clocking (SSC). Selects

SSC tests based on your DUT conﬁguration. Filters for the link Lists de-embed, embed, and CTLE ﬁlter ﬁ les used for the current DUT near end

and far end test points. Use ﬁlters to take cable and ﬁxture signal path length and

characteristics into account.

Click the ... button to view and select other ﬁlter ﬁles.

These controls are not available when Test Mode is set to Compliance.

DeEmbeding and Channel Embedding Overview

xx x

(see page 112)

See also

Select a test (see page 28)

Select tests

Use the Test Selection tab to select USB-TX tests.

28 TekExpress USB Automated Test Solution Help

Operating basics Select tests

Table 9: Test Selection tab settings

Setting Descript

Deselec

Test s

Show MOI button Opens the USB-TX Method of Implementation (MOI) PDF ﬁle. Schematic button Shows an equipment and test ﬁxture setup schematic for the selected test. Use to set

xxx

tAll, Select All buttons

Deselect or select all tests in the list. Click on

Description pane. All required tests are selected when in Compliance test mode. Measurements are grouped according to standard speciﬁcations such as Tx

Inform Clocking (see page 29), Tx Normative Eye Mask (see page 30), and LFPS measurement (see page 30).

up th

ion

a test to select or unselect. Highlight a test to show details in the Test

ative Electrical Parameters

e equipment and ﬁxtures or to verify the setup before running the test.

(see page 29), Normative Spread Spectrum

NOTE. All tests are selected by default.

nformative Electrical Parameters

Tx I

Includes UI-Unit Interval, VTx-Diff-PP-Differential PP Tx voltage swing, TCDR_Slew_Max-

ximum Slew Rate, Rj-Tx-random jitter-Dual Dirac, and Mask Hits measurements.

ormative Spread Spectrum Clocking

Includes TSSC-Freq-Dev-Max, TSSC-Freq-Dev-Min, TSSC-Mod-Rate-SSC Modulation rate, and TSSC USB Proﬁle measurements.

TekExpress USB Automated Test Solution Help 29

Operating basics Set acquisition parameters

Tx-Normative Eye Mask

Includes TJ-Tx total jitter-Dual D Height- Transmitter Eye Mask, and Width@BER measure ments.

Low Frequency Periodic Signaling (LFPS) Measurement

Includes LFPS Duty Cycle, LFPS Fall Time, LFPS Rise Time, LFPS TPeriod, LFPS TBurst, LFPS TRepeat, LFPS Vcm-AC, and LFPS VTx-DIFF-PP mesurements. Refer to the USB MOI document, LFPS measurement section, for more information.

NOTE. The application does not show the oscilloscope cursor1 and 2 for each burst. The analysis is done for the entire acquisition, for all bursts, and the

See also

Set acquisition parameters (see page 30)

Set acquisition parameters

Use the Acquisition tab in the Setup panel to view test acquisition parameters. You also use this tab to load and prerecorded (saved) test session waveform ﬁles on which to run tests.

irac at 10E-12 BER, DJ-Tx-deterministic Jitter-Dual Dirac, Eye

n displays the result statistics.

Contents displayed on this tab depend on the DUT type and selected tests.

Acquisitions tab: using active waveforms

NOTE. USB-TX acquires all waveforms required by each test group before performing analysis.

30 TekExpress USB Automated Test Solution Help

Operating basics Running tests on prerecorded (saved) w aveforms

Table 10: Acquisitions tab settings

Setting Description

View Probes button

Show Acquire Parameters Shows the various parameters related to each acquisition of a test. The parameters

Acquire Ste

xxx

pByStep

Shows the dete or disable probe signal source access in the application. Only available for live waveforms.

listed depen Shows a prom

Continue to proceed to the next acquisition.

cted probe conﬁguration. Use the View Probes dialog box to enable

d on the selected tests.

pt at the end of each acquisition and pauses the application. Click

USB-TX saves all acquisition waveforms to ﬁles by default. Waveforms are saved to a folder that is unique to each session (a session starts when you click the Start button). The folder path is

Session\

. Images created for each analysis, CSV ﬁles with result values,

X:\USB\Untitled

reports, and other information speciﬁc to that particular execution are also saved in this folder.

When the session is saved, content is moved to that session folder and the “Untitled Session” name is replaced by the session name.

See also

Running tests on prerecorded saved waveforms (see page 31)

Running tests on prerecorded (saved) waveforms

To load a saved waveform ﬁle:

1. Click DUT.

2. Click Use pre-recorded waveform ﬁles.

3. Click Acquisitions. The Waveform Filename column now shows browse buttons.

Acquisitions tab: using prerecorded (saved) waveforms

TekExpress USB Automated Test Solution Help 31

Operating basics Conﬁguration tab parameters

4. Click the browse button ( ) for each test acquisition type (CP0, CP1, LFPS).

5. Navigate to and select the appropriate waveform ﬁle(s). You will need to select all waveforms required

for the acquisition type.

6. To change, remove, or add a ﬁle to the list, click the browse button next to the ﬁle name to change, and

use the menu items to replace, remove (delete) or add a ﬁle in the list.

7. Click Start.

Conﬁgurati

Use the Con ﬁelds are available to edit depends on the selected test mode (Compliance or User Deﬁned) as set in this tab or the DUT tab.

NOTE. You cannot change test parameters that are grayed out.

on tab parameters

ﬁguration tab to set and view global instrument parameters for the selected tests. Which

Conﬁguration tab: Global Settings

32 TekExpress USB Automated Test Solution Help

Operating basics Conﬁguration tab: Global Settings parameters

Conﬁguration tab: Measurements

See also

Conﬁguration tab: Global Settings parameters (see page 33) Conﬁguration tab: Measurements parameters (see page 35)

Conﬁguration tab: Global Settings parameters

The following table lists the Conﬁguration tab settings and parameters. Fields shown on this tab can change depending on selected items.

TekExpress USB Automated Test Solution Help 33

Operating basics Conﬁguration tab: Global Settings parameters

Table 11: Conﬁguration tab Global Settings

Control Description

Test Mode Determines whether test parameters are in compliance or can be edited.

Compliance: Most test parameter values cannot be edited. Select this for

compliance mo

de testing.

User Deﬁned:

Limits Editor button

Instruments Detected

CM measurement using TriMode™ Probe with DPOJET Test Met hod

CP0 CP1 CP7 Record Length Sets the waveform record length. Signal Validation Sets the signal validation actions. Select from the available list items. Probing Conﬁguration Sets the signal probe conﬁguration (single-ended or differential) for all available

LFPS Acquisition Bandwidth (GHz)

Opens the Li In User Deﬁned Mode, use the Limits Editor to edit individual test limit settings.

To edit a value, click that ﬁeld and either select from the displayed list or enter a new value. Use scroll bars to view all available ﬁelds.

Limits Editor: compare string deﬁnitions

In Compliance M ode, use the Limits Editor to view the measurement high and low limits used for selected tests. You cannot edit values while in Compliance mode.

Displays a list of the connected instruments found during the instrument discovery. Instrument types include equipment such as oscilloscopes and signal sources (AFG, AWG). Select Op tio ns > Instrument Control S etting s to refresh the connected

instrument list (see page 20).

Set this when using a supported Tektronix TriMode probe for signal acquisition of the LFPS Vcm-AC measurement. The TriMode Probe can switch between differential, single ended and common mode (CM) measurements without changing the probe. In CM mode, it generates CM signal by taking two Single Ended inputs (D+ and D-).

The application applies post-processing on the entire LFPS CM acquisition, after applying compliance ﬁlters.

This control is only valid for the DPOJET test method.

channel selections (Ch1 – Ch 4) Sets the oscilloscope bandwidth for Low Frequency Periodic Signal (LFPS)

acquisition. Valid range is 5 GHz to 12 GHz in 1 GHz steps.

Enables editing of ﬁlters for the link.

mits Editor dialog box.

(see page 111)

34 TekExpress USB Automated Test Solution Help

Operating basics Conﬁguration tab: Measurements

Table 11: Conﬁguration tab Global Settings (cont.)

Control Description

LFPS ﬁelds Sets LFPS waveform parameters. If the oscilloscope does not properly trigger on

the DUT LFPS signal, adjust these trigger settings to enable the oscilloscope to detect and trigger on the LFPS signal.

AFG ﬁelds Sets AFG parameters. If the oscilloscope does not properly trigger on the DUT LFPS

signal, adjust these AFG settings to enable the oscilloscope to detect and trigger on the LFPS signal.

This is applicable if AFG is selected as the Toggle tool.

xxx

NOTE. If AWG is selected as the Toggle tool, the application enables the Verify Toggle Status check box. Use this

function to identify if the DUT toggled twice instead of one time.

NOTE. If Do not use is selected as the Toggle tool, the application enables the Auto Recovery Settings check b

ox. Use this function to automatically recover the oscilloscope settings if modiﬁed by the user

during test execution.

See also

About acquisitions (see page 30) Limits Editor: compare string deﬁnitions (see page 111)

Conﬁguration tab: Measurements

Lists all selected tests. There are no measurement parameter or c onﬁguration setting controls in the Measurements tab.

See also

Set acquisition parameters (see page 30) Limits Editor: compare string deﬁnitions (see page 111)

TekExpress USB Automated Test Solution Help 35

Operating basics Preferences tab

Preferences tab

Use the Preferences tab to set the application action when a test measurement fails.

Table 12: Preferences tab settings

Setting Description

On Test Failure, stop and notify me of the failure

xxx

Stops the test and sends an email when a test fails. Click Email Settings to verify that Email Test Results when complete or on error is

selected, and to verify the address to which the email is sent.

36 TekExpress USB Automated Test Solution Help

Operating basics Status panel overview

Status panel overview

The Status button accesses the Test Status and Log View tabs, which provide status on test acquisition and analysis (Te st Status The applicat Log View tab to view these items while tests are running.

ion opens the Test Status tab when you start a test run. You can select the Test Status or the

Test status view

(see page 37) tab) and a listing of test tasks performed (Log View (see page 37) tab).

Log view

TekExpress USB Automated Test Solution Help 37

Operating basics Results panel overview

Table 13: Status panel settings

Control Description

Message History Show Detaile

d Log

Window that li Enables reco

sts all executed test operations and timestamp information.

rding a more-detailed history of test execution.

NOTE. This must be selected before starting a measurement.

Auto Scroll Enables automatic scrolling of the log view as information is added to the log during

the test. Clear Log Clears all messages from the log view. Save Saves the log ﬁletoatextﬁle. Use the standard Save File window to navigate to and

specify th

xxx

e folder and ﬁle name to which to save the log text.

See also

Application panel overview (see page 26)

Results panel overview

When a test ﬁnishes, the application automatically opens the Results panel to display a summary of signal and preset test results.

The Overall Test Result is displayed at the top left of the Results table. If all of the tests for the session pass, the overall test result is Pass. If one or more tests fail, the overall test result is Fail.

Set viewing preferences for this panel from the Preferences menu

(see page 39) in the upper right corner.

Viewing preferences include showing w hether a test passed or failed, summary or detailed results, and enabling wordwr

ap.

NOTE. NAN (Not A Number) is displayed in the test results if an invalid waveform was supplied for the test.

38 TekExpress USB Automated Test Solution Help

Operating basics Preferences menu

Each test result occupies a row in the Results table. By default, results are displayed in summary format with the measurement details collapsed and with the Pass/Fail column visible. Change the view in the following way

To expand and collapse tests to show more or less detail, click the plus and minus buttons in the table.

To expand the width of a column, place the cursor over the vertical line that separates the column from the column to the right. When the cursor changes to a double-ended arrow, hold down the mouse button and d

To clear all test results displayed, click Clear.

Use the Preferences menu (see page 39) to change how some items display in the Results panel.

rag the column to the desired width.

See also

View a report (see page 43) Applica

tion panels overview

(see page 26)

Preferences menu

The Preferences menu is part of the Results panel display. Use the Preferences menu to change how

tems display in the Results panel.

some i

To show or hide the Pass/Fail column, select Preferences > Show Pass/Fail.

To collapse all expanded tests, select Preferences > View Results Summary.

To expand all tests listed, select Preferences > View Results Details.

To enable or disable the wordwrap feature, select Preferences > Enable Wordwrap.

See also

Results panel overview (see page 38)

TekExpress USB Automated Test Solution Help 39

Operating basics View test-related ﬁles

View test-related ﬁles

Files related to tests are stored in the My TekExpress\USB folder. Each test setup in this folder has a test setup ﬁle and a test setup folder, both with the test setup name.

The test setup ﬁle is preceded by the TekExpress icon and usually has no visible ﬁle name extension.

Inside the test setup folder is another folder named for the DUT ID used in the test sessions. The default is DUT001.

Inside the DUT001 folder are the session folders and ﬁles. Each session also has a folder and ﬁle pair, both named for the test session using the naming convention (date)_(time). Each session ﬁle is stored outside its matching session folder:

Each session folder contains image ﬁles of any plots generated from running the test session. If you selected to save all waveforms or ran tests using prerecorded waveform ﬁles, these are included here.

The ﬁrst time you run a new, unsaved session, the session ﬁles are stored in the folder located at ..\My TekExpre ss\USB. When you name and save the session, the ﬁles are placed in a folder with the name that you specify. A copy of the test ﬁles stay in the Untitled Session folder until you run a new test or until you close the USB-TX application.

also

See

File name extensions (see page 13)

quired \My TekExpress folder settings

Reports panel overview

Use the Reports panel to browse for reports, name and save reports, select test content to include in reports, and select report viewing options.

Untitled Session

(see page 9)

40 TekExpress USB Automated Test Solution Help

Operating basics Select report options

For infor

mation on setting up reports, see Select report options

reports, see View a Report

See also

About panels (see page 26)

Select report options

Click the Reports button and use the Reports panel controls to select which test result information to include in the report, and the naming conventions to use for the report. For example, a lways give the report a unique name or select to have the same name increment each time you run a particular test.

Select report options before running a test or when creating and saving test setups. Report settings are included in saved test setups.

In the Reports panel, select from the following report options:

Table 14: Report options

Setting Description

Report Generation

Generate new report Creates a new report. Append with previous run session Replace current test in previous

run session

(see page 41). For information on viewing

(see page 43).

Appends the latest test results to the end of the current test results report. Replaces the previous test results with the latest test results. Results from newly

added tests are appended to the end of the report.

TekExpress USB Automated Test Solution Help 41

Operating basics Select report options

Table 14: Report options (cont.)

Setting Description

Report name

Displays the name and location from which to open a report. The default location is at \My TekExpress\USB\Untitled Session. The report ﬁle in this folder gets overwritten each time you run a test unless you specify a unique name or select to auto increment the report name.

Change the report name or location.

Do one of the following:

In the Report Path ﬁeld, type over the current folder path and name.

Double-click in the Report Path ﬁeld and then make selections from the popup keyboard and click the Enter button.

Be sure to include the entire folder path, the ﬁle name, and the ﬁle extension. For example: C:\Documents and Settings\your user name\My Documents\My TekExpress\USB\DUT001_Test_72.7.1.3.mht.

NOTE. You cannot set the ﬁle location using the Browse button.

Open an existing report.

Click Browse, locate and select the report ﬁle and then click View at the bottom of the panel.

Save as type Saves a report in the speciﬁed ﬁle type. Lists supported ﬁle types to choose from.

NOTE. If you select a ﬁle type different from the default, be sure to change the

report ﬁle name extension in the Report Name ﬁeldtomatch.

Auto increment report name if duplicate

Contents To Save

Include pass/fail results summary Sets the application to include the color block labeled Test Result (indicating whether

Include detailed results

Include plot images Include setup conﬁ guration Sets the application to include hardware and software information in the summary

Include user comments

Append reports Append with previous run session

Sets the application to automatically increment the name of the report ﬁle if the application ﬁnds a ﬁle with the same name as the one being generated. For example: DUT001, DUT002, DUT003. This option is enabled by default.

the test passed or failed) in the report. For details, see Report Contents in View

a report (see page 43).

Sets the application to include parameter limits, execution time, and test-speciﬁc comments generated during the test.

Sets the application to include plotted diagrams such as Eye diagrams.

box at the top of the report. Information includes: the oscilloscope model and serial number, probe model and serial number, the oscilloscope ﬁrmware version, SPC and factory calibration status, and software v ersions for applications used in the measurements.

Select to include any comments about the test that you or another user added in the DUT tab of the Setup panel. Comments appear in the Comments section, under the summary box at the beginning of each report.

42 TekExpress USB Automated Test Solution Help

Operating basics View a report

Table 14: Report options (cont.)

Setting Description

View Report After G enerating

View Generate Report Generates a new report based on the current analysis results. Save As Specify a name for the report.

xxx

Automatically opens the report in a Web browser when the test completes. This option is selected by default.

Click to view the most current report.

View a report

The application automatically generatesareportwhentestanalysisiscompletedanddisplaysthereport in your Reports panel before running the test). If you cleared this check box, or to view a different test report, do the following:

1. Click the Reports button.

default Web browser (unless you cleared the View Report After Generating check box in the

2. Click

the Browse button and locate and select the report ﬁle to view.

3. In the Reports panel, click View.

Forinformationonchangingtheﬁle type, ﬁle name, and other report options, see Select report options

(see page 41).

TekExpress USB Automated Test Solution Help 43

Operating basics Report contents

Report contents

A report shows speciﬁed test details, such as detailed results and plots, as set in the Reports panel.

NOTE. NAN (Not A Number) is displayed in the report contents if an invalid waveform was supplied for the test.

Setup conﬁguration information

Setup conﬁguration information is listed in the summary box at the beginning of the report. This information includes the oscilloscope model and serial number, and software versions. To exclude this informat running the test.

ion from a report, clear the Include Setup Conﬁguration check box in the Reports panel before

User comments

If you selected to include comments in the test report, any comments you added in the DUT tab are shownatthetopofthereport.

Test result summary

The Test Result column indicates whether a test passed or failed. If the test passed, the cell text is green. If the test failed, the text is red. To exclude this information from a report, clear the Include Pass/Fail Results Summary check box in the Reports panel before running the test.

See also

Results panel overview (see page 38) View test-related ﬁles (see page 40)

44 TekExpress USB Automated Test Solution Help

Running tests Test process ﬂow

Test process ﬂow

Use the following list to set up and performing USB-TX tests.

1. Allow test instruments to warm up (~20 minutes).

2. Deskew the real-time oscilloscope

3. Setuptestequipment

4. Verify that required instruments are connected to USB-TX

5. Set DUT parameters

6. Select tests

7. View acquisition settings

8. Set global signal-related parameters

9. Select test notiﬁcation preferences

10. Select report options

11. Check the prerun checklist

12. Click Start to Run tests (see page 47).

(see page 28).

(see page 47).

(see page 27).

(see page 30).

(see page 41).

(see page 48)

(see page 45).

(see page 33).

(see page 36).

See also

About test setups (see page 49) About running tests (see page 47)

(see page 21).

Deskew real-time oscilloscopes

Use the following procedure to deskew direct input SMA channels on a real time oscilloscope.

NOTE. DPOJET has an automatic deskew option under Analyze > Jitter And Eye Analysis > Deskew. Refer to y our DPOJET online help for information on how to deskew the channels.

1. Run Signal Path C ompensation (SPC) on the oscilloscope.

2. Connect a SMA Power Splitter (preferred) or SMA 50 Ω coaxial “T” connector to the Fast Edge

output of the oscilloscope.

3. Connect SMA cables from each of the two channels to be deskewed to the power splitter (or SMA coaxial “T” connector). It is best to use matched cables when making high speed serial measurements. It is important to use the same cables that will be used for subsequent measurements.

TekExpress USB Automated Test Solution Help 45

Running tests Deskew real-time oscilloscopes

4. Select Default Setup, and then select Autoset on the oscilloscope front panel.

5. Set the oscilloscope for 70% to 90% full screen amplitude on both channels. Center both traces

so that they overlap.

6. Make sure that volts/div, position, and offset are identical for the two channels being deskewed.

7. Set the time/div to approximately 100 ps/div or less, with sample rate at 1 ps/pt. T hese settings

are not critical, but should be close.

8. Set the horizontal acquisition mode to average,whichprovidesamorestabledisplay.

9. Select Deskew from the Ve rtic al menu.

10. Verify tha

11. In the deskew control window, select the channel to deskew (typically CH3 or CH4). Adjust the

deskew to

NOTE. Typicalvaluesareinthe10’sofpsorlesswithcables connected directly from Fast Edge to SMA inputs. If you are using a switch box (for example, Keithley), deskew the complete path from where the test ﬁxture connects, through the switch, and into the oscilloscope. Deskew values in these cases may be as much as 30 ps or more.

NOTE. There can be signiﬁcant differences in the skew between two TCA-SMA adapters. If you ﬁnd that a system requires a very large correction, obtain a pair of TCA-SMA adapters that closely match each other to reduce the amount of correction.

NOTE. TekExpress retains the user conﬁgured Deskew values, and does not override the values during test runs.

t the reference channel (typically CH1 or CH2) is set to 0 ps deskew.

overlay the rising edge as best as possible.

46 TekExpress USB Automated Test Solution Help

Running tests Instrument and DUT connection setup

Instrument and DUT connection setup

Click the Setup > Test Selection > Schematic buttontoopenaPDFﬁle that shows the compliance test setup diagrams (instrument, DUT, and cabling) for supported testing conﬁgurations.

See also

Minimum sys View connected instruments (see page 21)

Running t

After sel run the tests. While tests are running, you cannot access the Setup or Reports panels. To monitor the test progress, switch back and forth between the Status panel and the Results panel.

The application displays a report when the tests are complete. While the tests are running, other applications may display windows in the background. The TekScope application takes precedence over other applications, but you can switch to other applications by using the Alt + Tab key combination. To keep the TekExpress USB application on top, select Keep On Top from the TekExpress Options menu.

See al

Conﬁguration tab parameters (see page 32)

tem requirements

(see page 3)

ests

ecting and conﬁguring tests, review the prerun checklist

(see page 48) andthenclickStart to

TekExpress USB Automated Test Solution Help 47

Running tests Prerun checklist

Prerun checklist

Do the following before you click Start to run a test:

NOTE. If this is the ﬁrst time you are running a test on the application, make sure that you have done the steps in Requ

1. Make sure that all the required instruments are properly warmed up (approximately 20 minutes).

2. Perform Signal Path Compensation (SPC)

a. On the oscilloscope main menu, select the Utilities menu.

b. Select Instrument Calibration.

c. Follow the on-screen instructions.

ired \My TekExpress folder settings

(see page 9) before continuing.

3. Verify t

a. In USB-TX, click Setup > Conﬁguration.

b. Click Global Settings.

c. In the Instruments Detected list, verify that the test setup instruments are shown. If they are not,

hat the correct instruments are connected (oscilloscope and signal sources):

click the arrow button to list and select from all detected instruments. If the required instrument is still not listed, use the TekExpress Instrument Control Settings dialog box to scan for and detect

ruments (see View connected instruments

inst

(see page 21)).

See also

Instrument and DUT connection setup (see page 47)

48 TekExpress USB Automated Test Solution Help

Saving and recalling test setup ﬁles Test setup ﬁles overview

Test setup ﬁles overview

Saved test setup information (such as the selected oscilloscope, general parameters, acquisition parameters, measurement limits, waveforms (if applicable), and other conﬁguration settings) are all saved under the setup name at

Use test setups to:

Run a new session, acquiring live waveforms, using a saved test conﬁguration.

Createanewtestsetupbasedonanexistingone.

View all the information associated with a saved test, including the log ﬁle, the history of the test status as it executed, and the results summary.

Run a saved test using saved waveforms.

See also

Save a test setup (see page 49) Recall a s

X:\USB.

aved test setup

(see page 50)

Save a test setup ﬁle

Save a test setup before or after running a test to save the test settings. Create a new test setup from any open setup or from the default setup. When you select the default test setup, all p arameters are returned to the application’s default values.

To immediately sa ve the current setup session to the same setup name, select Options > Save Test Setup.

To immediately save the current setup session to a new setup name, select Options > Save Test Setup As.

To create and save a new setup from the default test setup:

1. Select Options > Default Test Setup to return the application to default test settings.

2. Click the application Setup button and use the setup tabs to set required options and parameters (DUT,

Test Selection, and so on).

3. Click the application Reports button and set your report options

4. Optional: Click Start to run the test and verify that it runs correctly and captures the speciﬁed test

information and reports. If it does not, edit the parameters and repeat this step until the test runs to your satisfaction.

Running the test helps verify that all parameters are set correctly, but it is not a necessary step.

5. Select Options > Save Test Setup.Entertheﬁle name for the new setup ﬁ le. The application saves the ﬁle to X:\USB\<session_name.

(see page 41).

TekExpress USB Automated Test Solution Help 49

Saving and recalling test setup ﬁles Open (load) a saved test setup ﬁ le

See also

Test pr ocess ﬂow (see page 45) View test-related ﬁles (see page 40) Conﬁguration tab parameters (see page 32)

Open (load) a saved test setup ﬁle

These instructions are for recalling saved test setups.

1. Select Options > Open Test Setup.

2. Select the setup from the list and click Open.SetupﬁlesmustbelocatedatX:\USB.

See also

About test setups (see page 49) Create a new test setup based on an existing one (see page 50) Test setups overview (see page 45)

Create a new test setup ﬁlebasedonanexistingone

Use this method to create a variation on a test setup without having to create the setup from the beginning.

1. Select Options > Open Test Setup.

2. Select a setup from the list and then click Open.

3. Use the Setup and Reports panels to modify the parameters to meet your testing requirements.

4. Sel

5. Enter a test setup name and click Save.

See also

A Set DUT parameters (see page 27) Conﬁguration parameters (see page 35) Select acquisitions (see page 30)

ect Options > Save Test Setup As.

bout test setups

(see page 49)

50 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface About the programmatic interface

About the programmatic interface

The Programmatic interface seamlessly integrates the TekExpress test automation application with the high-level automation layer. This also lets you control the state of the TekExpress application running on a local or a rem

ote computer.

The follo

TekExpress leverages .Net Marshalling to enable the Programmatic Interface for TekExpress Client. TekExpress provides a client library for TekExpress clients to use the programmatic interface. The TekEx clients. The TekExpress client library maintains a reference to the TekExpress Server and this reference allows the client to control the server state.

wing terminology is used in this section to simplify description text:

TekExpress Client: A high-level automation application that communicates with TekExpress using TekExpr

TekExpress Server: The TekExpress application when being controlled by TekExpress Client.

ess Programmatic Interface.

press client library is inherited from .Net MarshalByRef class to provide the proxy object for the

See also

Requirements for Developing TekExpress Client (see page 54)

To enable remote access

To access and remotely control an instrument using the TekExpress programmatic interface, you need to change speciﬁc ﬁrewall settings as follows:

1. Access the Windows Control Panel and open the Windows Firewall tool (Start > Control Panel > All Control Panel Items > Windows Firewall).

2. Click Advance Settings > Inbound Rules.

TekExpress USB Automated Test Solution Help 51

TekExpress programmatic interface To enable remote access

3. Scroll through the Inbound Rules list to see if the following items (or with a similar name) are shown:

TekExpress USB

TekExpress

4. If both items are shown, you do not need to set up any rules. Exit the Windows Firewall tool.

5. If one or both are missing, use the following procedure to run the New Inbound Rule Wizard and add

these executables to the rules to enable remote access to the TekExpress application.

Run the New Inbound Rule Wizard

1. Click on New Rule (in Actions column) to start the New Inbound Rule Wizard.

2. Verify that Program is selected in the Rule Type panel and click Next.

3. Click Browse in the Program panel and navigate to and select one of the following TekExpress

applications (depending on the one for which you need to create a rule):

4. TekExpress USB.exe

5. TekExpress.exe

NOTE. See Application directories and content

6. Click Next.

7. Verify that Allow the connection is selected in the Action panel and click Next.

(see page 12) for the path to the application ﬁles.

8. Verify that all ﬁelds are selected (Domain, Private,andPublic)intheProﬁle panel and click Next.

9. Use the ﬁelds in the Name panel to enter a name and optional description for the rule. For example,

a name for the TekExpress USB application could be TekExpress USB RX Application.Add description text to further identify the rule.

52 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface To enable remote access

10. Click Finish to return to the main Windows Firewall screen.

11. Scroll through the Inbound Rules list and verify that the list shows the rule that you just entered.

12. Repeat steps 1 through 11 to enter the other TekExpress executable if it is missing from the list. Enter TekE

13. Scroll through the Inbound Rules list and verify that the list shows the rule that you just entered.

14. Exit the Windows Firewall tool.

xpress PI as the name.

To use th

1. Obtain the IP address of the instrument on which you are running TekExpress USB. For example,

2. On the PC from which you are accessing the remote instrument, use the instrument IP address as part

e remote access:

134.64

of the

object obj = piClient.Connect(“134.64.235.198”,out clientid);

.235.198.

TekExpress USB PI code to acc ess that instrument. For example:

TekExpress USB Automated Test Solution Help 53

TekExpress programmatic interface Requirements for developing TekExpress client

Requirements for developing TekExpress client

While developing TekExpress Client, use the TekExpressClient.dll. The client can be a VB .Net, C# .Net, Python, or Web application. The examples for interfaces in each of these applications are in the

Samples fold

References required

TekExpressClient.dll has an internal reference to IIdlglib.dll and IRemoteInterface.dll

IIdlglib.dll has a reference to TekDotNetLib.dll.

er.

IRemoteI

nterface.dll

provides the interfaces required to perform the remote automations. It is an

interface that forms the communication line between the server and the client.

IIdlgli

b.dll

provides the methods to generate and direct the secondary dialog messages at the

client-end.

NOTE. The end-user client application does not need any reference to the above mentioned DLL ﬁles. It is essential to have these DLLs (IRemoteInterface.dll, IIdlglib.dll and TekDotNetLib.dll) in the same folder as that of TekExpressClient.dll.

red steps for a client

Requi

The client uses the following steps to use TekExpr essClient.dll to programmatically control the

er:

serv

Develop a client UI to access the interfaces exposed through the server. This client loads

ExpressClient.dll

Tek

to access the interfaces. After TekExpressClient.dll is loaded, the client UI can call the speciﬁc functions to run the operations requested by the client. When the client is up and running, it does the following to run a remote operation:

1. To connect to the server, the client provides the IP address of the PC where the server is running.

he client locks the server application to avoid conﬂict with any other Client that may try to control

2.T

the server simultaneously. “Lock” would also d isable all user controls on the server so that server state cannot be changed by manual operation.

If any other client tries to access a server that is locked, it will receive a notiﬁcation that the server is locked by another client.

3. When the client has connected to and locked the server, the client can access any of the programmatic

controls needed to run the remote automations.

4. After the client operations ﬁnish, the client unlocks the server.

54 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Remote proxy object

Remote proxy object

The server exposes a remote object to let the remote client access and perform the server-side operations remotely. The proxy object is instantiated and exposed at the server-end through marshalling.

The following is an example:

RemotingConfiguration.RegisterWellKnownServiceType (typeof (Te kExpressRemoteInterface), “TekExpress Remote interface”, WellKnownObjectMode.Singleton);

This object lets the remote client access the interfaces exposed at the server side. The client gets the reference to this object when the client gets connected to the server.

For example,

//Get a reference to the remote object

remoteObject = (IRemoteInterface)Activator.GetObject(typeof(IRemoteInterface), URL.ToString());

Client proxy object

Client exposes a proxy object to receive certain information.

TekExpress USB Automated Test Solution Help 55

TekExpress programmatic interface Client proxy object

For example,

//Register the client proxy object

WellKnownServiceTypeEntry[] e = RemotingConfiguration.GetRegisteredWellKnownServiceTypes();

clientInterface = new ClientInterface();

RemotingConfiguration.RegisterWellKnownServiceType(typeof(ClientInterface), “Remote Client Interface”, WellKnownObjectMode.Singleton);

//Expose the client proxy object through marshalling

RemotingS

ervices.Marshal(clientInterface, "Remote Client Inteface");

The client proxy object is used for the following:

To get the secondary dialog messages from the server.

To get the ﬁle transfer commands from the server while transferring the report.

Examples

clientObject.clientIntf.DisplayDialog(caption, msg,iconType, btnT ype);

clien

tObject.clientIntf.TransferBytes(buffer, read, fileLength);

For more information, click the following links:

Secondary Dialog Message Handling

The s econdary dialog messages from the Secondary Dialog library are redirected to the client-end when a client is performing the automations at the remote end.

In the secondary dialog library, the assembly that is calling for the dialog box to be displayed is checked and if a remote connection is detected, the messages are directed to the remote end.

File Transfer Events

56 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Client programmatic interface example

When the client requests the transfer of the report, the server reads the report and transfers the ﬁle by calling the ﬁle transfer methods at the client-end.

Client programmatic interface example

An example of the client programmatic interface is described and shown as follows:

Process ﬂowchart

TekExpress USB Automated Test Solution Help 57

TekExpress programmatic interface Client programmatic interface example

58 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Client programmatic interface example

1. Connect to a server or remote object using the programmatic interface provided.

2. Get the client ID that is created when connecting to the remote object. This client ID is one of the

required parameters to communicate with the server.

NOTE. The server identiﬁes the client with this ID only and rejects any request if the ID is invalid.

3. Lock the server for further operations. This disables the application interface.

NOTE. You can get values from the server or set values from the server to the client only if the application is locked.

4. Register for receiving notiﬁcations on status change events on the server. To register you need to give a handler as a parameter.

NOTE. Whenever there is a change in the status of the server, all the clients registered with the server receive a notiﬁcation from the server.

5. Select the tests that you want to run through the programmatic interface.

6. Set the necessary parameters for each test.

7. Run the tests.

8. Poll for the status of the application.

NOTE. Skip step 8 if you are registered for the status change notiﬁcation and the status is Ready.

9. After completing the tests, get the results.

eate a report or display the results and verify or process the results.

10.Cr

11. Unlock the server after you complete all the tasks.

12. Disconnect from the remote object.

andler of status change notiﬁcation

1. Get the status. If the status is Wait or Error, get the information that contains the title, message description, and the expected responses for the status.

2. Perform the actions based on the status information.

3. Set the response as expected.

TekExpress USB Automated Test Solution Help 59

TekExpress programmatic interface Program remote access code example

See also

Program remote access code example (see page 60)

Program remote access code example

This code example shows how to communicate between a remote PC and TekExpress USB

Table 15: Remote access code example

Task Code

Start the application

Connect through an IP address.

Lock the server Disable the

Popups Set the DUT ID Runwithset

conﬁgurations Wait for the test to

complete.

Get the current state information

Send the response

Save results 'Save all results values from folder for current run

Unlock the server Disconnect from

erver

s Exit the

application

xxx

m_Client.Connect("localhost") 'True or False

clientID = m_Client.getClientID

m_Client.LockServer(clientID)

m_Client.SetVerboseMode(clientID, false)

m_Client.SetDutId(clientID, "DUT _Name")

m_Client.Run(clientID)

Thread.Sleep(500)

m_Client.Application_Status(clientID)

Select Case status

Case "Wait"

mClient.GetCurrentStateInfo(clientID, WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButtontexts)

mClient.SendResponse(clientID, W aitingMsbBxCaption, WaitingMsb-

essage, WaitingMsbBxResponse)

BxM

End Select

Loop Until status = "Ready"

Client.TransferResult(clientID, logDirname)

m_Client.UnlockServer(clientID)

m_Client.Disconnect()

60 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface ApplicationStatus()

ApplicationStatus()

ApplicationS

tatus(clientId)

This method gets the status (ready, running, paused) of the server application.

Parameters

Name Type Direction Description

clientId string IN

xxx

Identiﬁer of the client that is performing the remote function.

clientId example

(see page 62)

NOTE. The Fail condition for PI commands occurs in any of the following cases:

The server is LOCKED and the message displayed is "Server is locked by another client".

The session is UNLOCKED and the message displayed is "Lock Session to execute the command".

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Return value

String value that gives the status of the server application.

Example

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL.

returnval as string

returnval=m_Client.ApplicationStatus(clientID)

Comments

The application is in the Running, Paused, Wait, or Error state at any given time.

Related command(s)

GetCurrentStateInfo (see page 68) QueryStatus (see page 76) SendResponse (see page 81)

TekExpress USB Automated Test Solution Help 61

TekExpress programmatic interface ChangeDutId()

Status (see page 103)

in string clie

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

ChangeDutId()

ChangeDutId(clientId, dutName)

This command changes the DUT id of the set-up. The client has to provide a valid DUT id.

Parameters

Parameter Type Direction Description

clientId

dutName

xxx

Return value

ntId example

String

Identiﬁer of the c lient that is performing the remote function.

clientId example

The new DUT id of the set-up.

(see page 62)

String that indicates the status of the operation upon completion.

NOTE. The Fail condition for PI commands occurs in any of the following cases:

TheserverisLOCKEDandthemessagedisplayed is "Server is locked by another client".

ThesessionisUNLOCKEDandthemessagedisplayed is "Lock Session to execute the command".

TheserverisNOTFOUNDandt

he message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Example

If (dut Id.Length <=0 && locked == true)

return “Enter a valid DUT-ID”;

returnVal = remoteObject.ChangeDutId(clientId, dutId);

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

return “DUT Id Changed...”;

62 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface ChangeDutId()

else

return CommandFailed(returnVal);

Comments

If the dutName parameter is null, the client is prompted to provide a valid DUT id.

Related com

GetDutId (see page 70)

mand(s)

TekExpress USB Automated Test Solution Help 63

TekExpress programmatic interface CheckSessionSaved()

CheckSessionSaved()

CheckSession

Saved(clientID, out savedStatus)

This command checks whether the current session is saved.

Parameters

Parameter Type Direction D escription

clientId string IN

savedStatus

xxx

boolean

OUT

Identiﬁer of the client that is performing the remote function.

clientId example

Boolean representing whether the current session is saved

(see page 62)

Return value

Return value is either True or False.

Example

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL.

returnval as string

returnval=m_Client.CheckSessionSaved(m_clientID, out savedStatus)

Comments

Related command(s)

CheckSessionSaved RecallSession SaveSession SaveSessionAs

Connect()

Connect(hostIPAddress, clientInterface, out clientID)

This command connects the client to the server. The client provides the IP address of the server to connect to the server. The server provides a unique clientId when the client is connected to it.

64 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Connect()

NOTE. The server must be active and running for the client to connect to the server. Any number of clients can be connected to the server at a time.

Parameters

Parameter Type Direction Description

HostIPAddress string IN

clientIntf clientId string

xxx

string IN

OUT Identiﬁer of the client that is performing the

The IP address of the server to which the client is trying to connect. This is required to establish the c onnection between the server and the client.

The handle of the remote object interface

remote function.

clientId example

(see page 62)

Return value

Value that indicates the connection status (connection was established or an error occurred). The return value can be a boolean value (true), or a string (returning the error message).

NOTE. The Fail condition for PI commands occurs in any of the following cases:

The server is LOCKED and the message displayed is "Server is locked by another client".

The session is UNLOCKED and the message displayed is "Lock Session to execute the command".

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Example

try {

IPAddress[] hostIPAddr = Dns.GetHostAddresses(Dns.GetHostName());

// Connect to the remoter Server

remoteObject.Connect(hostIPAddress, clientInterface, out clientID);

return true;

}

catch (Exception error)

{

return error;

}

TekExpress USB Automated Test Solution Help 65

TekExpress programmatic interface Connect()

Comments

The server has to be active and running for the client to connect to the server. Any number of clients can be connected to the server at a time. Each client will get a unique id.

Related comm

Disconnect (see page 64)

and(s)

66 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Disconnect()

Disconnect()

Disconnect(c

lientId)

This command disconnects the client from the server it is connected to.

Parameters

Parameter Type Direction Description

clientId string IN

xxx

Identiﬁer of the client that is performing the remote function.

clientId example

Return value

Integer value that indicates the status of the operation upon completion.

1: Succe

–1: Failure

Example

try

(see page 62)

{

string returnVal = UnlockServer (clientId);

remoteObject.Disconnect (clientId);

return 1;

}

Comments

When the client is disconnected, it is unlocked from the server and then disconnected. The id is reused.

Related command(s)

Connect (see page 64)

TekExpress USB Automated Test Solution Help 67

TekExpress programmatic interface GetCurrentStateInfo()

GetCurrentStateInfo()

GetCurrentSt

ateInfo(clientID, WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButton-

texts)

This command gets the additional information of the states when the application is in Wait or Error state.

Except client ID, all the others are Out parameters.

NOTE. This command is used when the application is running and is in the wait or error state.

Parameters

Parameter Type Direction D escription

clientId string IN

WaitingMsbBxCaption

WaitingMsbBxMessage

WaitingMsbBxButtontexts

xxx

string

string array

OUT

OUT The wait state/error state message

OUT An array of strings containing the

Identiﬁer of the client that is performing the remote function.

clientId example

The wait state or error state message sent to you

sent to you

possible response types that you can send

(see page 62)

NOTE. The Fail condition for PI commands occurs in any of the following cases:

TheserverisLOCKEDandthemessagedisplayed is "Server is locked by another client".

ThesessionisUNLOCKEDandthemessagedisplayed is "Lock Session to execute the command".

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Return value

This command does not return any value.

This function populates the Out parameters that are passed when invoking this function.

Example

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL

68 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface GetCurrentStateInfo()

mClient.GetCurrentStateInfo(clientID, WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButtontexts)

Comments

Related command(s)

ApplicationStatus (see page 61) QueryStatus (see page 76)

nse

SendRespo

(see page 81)

TekExpress USB Automated Test Solution Help 69

TekExpress programmatic interface GetDutId()

GetDutId()

GetDutId(cli

entId, out dutId)

This command returns the DUT id of the current set-up.

Parameters

Parameter Type Direction Description

clientId string IN

dutId string

xxx

OUT The DUT id of the set-up.

Identiﬁer of the client that is performing the remote function.

clientId example

Return value

String that gives the timeout period (in seconds) of the client.

Example

returnVal = remoteObject.GetDutId(clientId, out dutId);

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

{

(see page 62)

return id;

}

else

return CommandFailed(returnVal);

Comments

The dutId is an OUT parameter whose value is set after the server processes the request.

Related command(s)

ChangeDutId (see page 62) SetDutId (see page 85)

70 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface GetPassFailStatus()

GetPassFailStatus()

GetPassFailS

tatus(clientId, device, deviceConnector, test)

This command gets the pass or fail status of the measurement after test completion.

NOTE. Execu

te this command after completing the measurement.

Parameters

Parameter Type Direction D escripti

clientId string IN

device string IN

deviceC

test

xxx

onnector

string IN string with device connection type.

string IN

Identiﬁer to the server

clientId example

Speciﬁes the DUT type (Host or Device)

Valid va

Device Connector

Speciﬁes the name of the test for w hich to obtain the pass or fail status.

of the client that is connected

lues are Host Connector and

Return value

(see page 62)

String value that indicates the status of the operation upon completion.

Example

GetPassFailStatus(clientId, “Device”, “Device Connector”, test);

GetPassFailStatus(clientId, “Host”, “Host Connector”, test);

GetReportParameter()

GetReportParameter(clientId, device, suite, test, parameterString)

This command gets the general report details such as oscilloscope model and TekExpress version.

TekExpress USB Automated Test Solution Help 71

TekExpress programmatic interface GetReportParameter()

Parameters

Parameter Type Direction D escription

clientId string IN

device string IN

deviceConnector

test

parameterString

xxx

string IN string with

string IN

Identiﬁer of the client that is connected to the server

ple

clientId exam

Speciﬁes the Device).

Valid values are Host Connector and

Device Connector

Speciﬁes the name of the test for which to obtain t result value.

Speciﬁes to return the measured value for the indicated test. Enter “Scope Model” , “ or “Application Version” for this argument

(see page 62)

DUT type (Host or

device c onnection type.

he pass or fail status or a test

TekExpress Version”,

NOTE. The Fail condition for PI commands occurs in any of the following cases:

TheserverisLOCKEDandthemessagedisplayed is "Server is locked by another client".

ssion is UNLOCKED and the message d isplayed is "Lock Session to execute the command".

The se

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

urn value

Ret

The return value is the connected oscilloscope model, TekExpress base software version, or USB-TX

lication version.

app

Example

GetReportParameter(clientId, “Device”, “Device Connector”, test, "Application Version")

72 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface GetResultsValue()

GetResultsValue()

GetResultsVa

lue(clientId, device, deviceConnector, test, parameterString)

This command gets the result values of the spe ciﬁ ed measurement after the run.

Parameters

Parameter Type Direction Description

clientId string IN

device string IN

deviceConnector

test

parameterString

xxx

string IN string with device connection type.

string IN

Identiﬁer of the client that is connected to the server

clientId example

Speciﬁes the DUT type (Host or Device).

Valid values are Host Connector and

Device Connector

Speciﬁes the name of the test for w hich to obtain the test result value.

Speciﬁes to return the measured value for the indicated test. Enter “Value” for this argument

(see page 62)

NOTE. The Fail condition for PI commands occurs in any of the following cases:

The server is LOCKED and the message displayed is "Server is locked by another client".

The session is UNLOCKED and the message displayed is "Lock Session to execute the command".

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Return value

String value that indicates the status of the operation upon completion. Returns the result value in the form of a string.

Example

GetResultsValue(clientId, “Device”, “Device Connector”, test, "Value");

TekExpress USB Automated Test Solution Help 73

TekExpress programmatic interface GetTimeOut()

GetTimeOut()

GetTimeOut(c

lientId)

Returns the current timeout period set by the client.

Parameters

Parameter Type Direction D escription

clientId string IN

xxx

Identiﬁer of the client that is connected to the server

clientId example

(see page 62)

Return value

String value that indicates the status of the operation upon completion. The d efault return value is

1800000. Returnval as string.

NOTE. The Fail condition for PI commands occurs in any of the following cases:

TheserverisLOCKEDandthemessagedisplayed is "Server is locked by another client".

ThesessionisUNLOCKEDandthemessagedisplayed is "Lock Session to execute the command".

rver is NOTFOUND and the message displayed is "Server not found...Disconnect!".

The se

When none of these fail conditions occur, then the message displayed is "Failed...".

Example

lient = new Client() //m_Client is a reference to the Client class in the Client DLL.

m_C

returnval as string

returnval=m_Client.GetTimeOut()

mments

Related command(s)

SetTimeOut (see page 101)

74 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface LockSession()

LockSession()

LockSession(

clientId)

This command locks the server. The client has to call this command before running any of the remote automations

. The server is locked by only one client.

Parameters

Parameter Type Direction Description

clientId string IN

xxx

Identiﬁer of the client that is performing the remote function.

clientId example

(see page 62)

Return value

Returns the status of the operation upon completion.

Example

if (locked)

return “Session has already been locked!”;

returnVal = remoteObject.LockSession(clientId);

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

{

locked = true;

return “Session Locked...”;

}

Comments

When the client tries to lock a server that is locked by another client, the client gets a message that the server is already locked and it has to wait until the server is unlocked.

Iftheclientlockstheserverandisidleforacertain amount of time, then the server is automatically unlocked from that client.

Related command(s)

UnlockSession (see page 107)

TekExpress USB Automated Test Solution Help 75

TekExpress programmatic interface QueryStatus()

QueryStatus()

QueryStatus(

clientID, out status)

This command transfers Analyze panel status messages from the server to the client.

Parameters

Parameter Type Direction D escription

clientID string IN

status

xxx

string array

OUT The list of status messages generated

NOTE. The Fail condition for PI commands occurs in any of the following cases:

TheserverisLOCKEDandthemessagedisplayed is "Server is locked by another client".

ThesessionisUNLOCKEDandthemessagedisplayed is "Lock Session to execute the command".

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Identiﬁer of the client that is connected to the server

clientId example

during the run

(see page 62)

Return value

String value that indicates the status of the operation upon completion. On success the return value is “Transferred...”.

Example

returnVal=m_Client.QueryStatus(clientID, out statusMessages)

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

return “Status updated...”

else

return CommandFailed(returnVal)

Related command(s)

ApplicationStatus (see page 61) GetCurrentStateInfo (see page 68)

76 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface RecallSession()

SendResponse (see page 81)

RecallSession()

RecallSession(clientId,sessionName)

Recalls a s aved session. The name of the session is provided by the client.

ame

Identiﬁer of the client that is performing

e function.

string IN

the remot

clientId example

The name of the session being recalled.

Parameter

Parameter Type Direction Description

clientId string IN

sessionN

xxx

Return value

that indicates the status of the operation upon completion.

String

Example

returnVal = remoteObject.RecallSession(clientId,sessionName);

OP_STATUS)returnVal == OP_STATUS.SUCCESS)

if ((

return “Session Recalled...”;

else

return CommandFailed(returnVal);

(see page 62)

Comments

The name parameter cannot be empty. If it is empty, the client is prompted to provide a valid name.

elated command(s)

SaveSession (see page 79) SaveSessionAs (see page 80)

TekExpress USB Automated Test Solution Help 77

TekExpress programmatic interface Run()

Run()

Run(clientId

)

Runs the setup. Once the server is set up and conﬁgured, it can be run remotely using this function.

Parameters

Parameter Type Direction D escription

clientId string IN

xxx

Identiﬁer of the client that is connected to the server

clientId example

(see page 62)

Return value

String that returns the status of the operation after completion.

Example

returnVal = remoteObject.Run(clientId);

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

n “Run started...”;

retur

else

return CommandFailed(returnVal);

ments

Com

When the run is performed the status of the run is updated periodically using a timer.

78 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface SaveSession()

SaveSession()

SaveSession(

clientId,sessionName)

Saves the current session. The name of the session is provided by the client.

Parameters

Parameter Type Direction Description

clientId string IN

sessionName string IN

xxx

Identiﬁer of the client that is connected to the server

clientId example

The name of the session being saved.

Return value

String that indicates the status of the operation upon completion.

Example

returnVal = remoteObject.SaveSession(clientId,sessionName);

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

retur

n “Session Saved...”;

(see page 62)

else

return CommandFailed(returnVal);

ments

Com

The name parameter cannot be empty. If it is empty, the client is prompted to provide a valid name.

Once the session is saved under ‘name,’ you cannot use this command to save the session with a different name. Use SaveSessionAs to save the session to a new name.

Related command(s)

RecallSession (see page 77) SaveSessionAs (see page 80)

TekExpress USB Automated Test Solution Help 79

TekExpress programmatic interface SaveSessionAs()

SaveSessionAs()

SaveSessionA

s(clientId,sessionName)

Saves the current session in a different name every time this command is called. The name of the session is provided by t

he client.

Parameters

Parameter Type Direction D escriptio

clientId string IN

sessionName string IN

xxx

Identiﬁer to the server

clientId example

The name of the session being saved.

of the client that is connected

(see page 62)

Return value

String that indicates the status of the operation upon completion.

Example

returnVal = remoteObject.SaveSessionAs(clientId,sessionName);

if ((OP_STATUS)returnVal == OP_STATUS.SUCCESS)

return “Session Saved...”;

else

return CommandFailed(returnVal);

Comments

e same session is saved under different names using this command. The name parameter cannot be

Th empty. If it is empty, the client is prompted to provide a valid name.

Related command(s)

RecallSession (see page 77) SaveSession (see page 79)

80 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface SendResponse()

SendResponse()

SendResponse

(clientID, WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButtontexts)

After receiving the additional information using the command GetCurrentStateInfo(), the client can decide which respon

se to send and then send the response to the application using this function. The response should be one of the strings that was received earlier as a string array in the GetCurrentStateInfo function. The _caption and _message should match the information received earlier in the GetCurrentStateInfo function.

NOTE. This command is used when the application is running and is in the wait or error state.

Paramete

Parameter Type Direction Description

clientId string IN

WaitingMsbBxCaption

WaitingMsbBxMessage

WaitingMsbBxButtontexts

xxx

string

string array

Identiﬁer of the client that is connected to the server

clientId example

OUT

OUT The wait state/error state message

OUT An array of strings containing the

The wait state or error state message sent to you

sent to you

possible response types that you can send

(see page 62)

NOTE. The Fail condition for PI commands occurs in any of the following cases:

The server is LOCKED and the message displayed is "Server is locked by another client".

The session is UNLOCKED and the message displayed is "Lock Session to execute the command".

The server is NOTFOUND and the message displayed is "Server not found...Disconnect!".

When none of these fail conditions occur, then the message displayed is "Failed...".

Return value

This command does not return any value.

Example

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL

TekExpress USB Automated Test Solution Help 81

TekExpress programmatic interface SelectDevice()

mClient.SendResponse(clientID, out WaitingMsbBxCaption, out WaitingMsbBxMessage, out WaitingMsbBxButtontexts)

Related command(s)

ApplicationStatus (see page 61) GetCurrentStateInfo (see page 68) QueryStatus (see page 76)

SelectDevice()

SelectDevice(clientId, device, true)

This command selects the DUT type (Host or Device).

Paramet

Parameter Type Direction D escription

clientId string IN

devic

xxx

ers

Identiﬁer of the client that is connected

erver

to the s

clientId example

strin

String with the device DUT type. Valid values are Host and Device.

Return value

String value that indicates the status of the operation upon completion.

Example

SelectDevice(clientId, "Device", true);

SelectDevice(clientId, "Host", true);

(see page 62)

82 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface SelectSuite()

SelectSuite()

SelectSuite(

clientId, device, deviceConnector, true)

This command selects one of the two suites: "Device Connector" or "Host Connector."

Parameters

Parameter Type Direction Description

clientId string IN

device string IN

deviceConnector

xxx

Return

value

string IN string with device connection type.

Identiﬁer of the client that is connected to the server

clientId example

String with the device DUT type. Valid values are Host and Device.

Valid values are Host Connector and

Device Connector

(see page 62)

String value that indicates the status of the operation upon completion.

Example

tSuite(clientId,"Device","Device Connector",true);

Selec

SelectSuite(clientId,"Device","Host Connector",true);

SelectSuite(clientId,"Host","Device Connector",true);

SelectSuite(clientId,"Host","Host Connector",true);

TekExpress USB Automated Test Solution Help 83

TekExpress programmatic interface SelectTest()

SelectTest()

SelectTest(c

lientId, device, deviceConnector, test, true)

This command selects a test.

Parameters

Parameter Type Direction D escription

clientId string IN

device string IN

deviceConnector

test

xxx

Return

value

string IN string with device connection type.

string IN

Identiﬁer of the client that is connected to the server

clientId example

String with the device DUT type. Valid values are Host and Device.

Valid values are Host Connector and

Device Connector

Name of the USB-TX test.

String value that indicates the status of the operation upon completion.

Example

(see page 62)

ctTest(clientId, device, deviceConnector, "UI-Unit Interval", true);

Sele

84 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface SetDutId()

SetDutId()

SetDutId(cli

entID,newDutId)

This command changes the DUT ID of the setup. The client must provide a valid DUT ID.

Parameters

Parameter Type Direction Description

clientId string IN

newDutId string IN

xxx

Identiﬁer of the client that is connected to the server

clientId example

The new DUT ID of the setup.

(see page 62)

Return value

String that gives the status of the operation after it was performed.

Return

value is “DUT Id Changed” on success.

Example

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL.

returnval as string

rn=m_Client.SetDutId(clientID,desiredDutId)

retu

Comments

Related command(s)

GetDutId (see page 70)

SetGeneralParameter()

SetGeneralParameter(clientId, device, deviceConnection, "", paramString)

This command sets the general parameter and its value based on the "paramString" argument values as listed.

TekExpress USB Automated Test Solution Help 85

TekExpress programmatic interface SetGeneralParameter()

Parameters

Parameter Type Direction D escription

clientId string IN

device string IN

deviceConnector

test

parameterString

xxx

string IN string with device connection type.

string IN

Identiﬁer of the client that is connected to the server

clientId example

Speciﬁes the DUT type (Host or Device).

Valid values are Host Connector and

Device Connector

Speciﬁes the name of the test for which to obtain the pass or fail status or a test result value. Enter a null value for this ﬁeld ("").

Speciﬁes the control to set. See the following links for argument values and examples for this ﬁeld.

(see page 62)

Return value

String value that indicates the status of the operation upon completion.

paramString argument values

Use the following links to see the paramString values associated with speciﬁc application settings.

Select CTLE ﬁlter ﬁle Select de-embed ﬁlter ﬁle (see page 89) Select embed ﬁlter ﬁle (see page 91) Select test method (see page 87) Select test point (see page 87) Set AFG frequency (see page 99) Set AFG number of cycles (see page 98) Set AFG voltage level high (see page 99) Set AFG voltage level low (see page 100) Set Auto Recovery mode (see page 94) Set bandwidth for LFPS acquisition (see page 93) Set CM Measurement TriMode Probe mode (see page 94) Set CTLE ﬁlter mode (see page 92) Set de-embed ﬁlter mode (see page 88) Set embed ﬁlter mode (see page 90) Set LFPS hysteresis level (see page 98) Set LFPS mid edge reference level (see page 97) Set LFPS trigger level (see page 97) Set LFPS trigger lower limit (see page 96) Set LFPS trigger upper limit (see page 96) Set probing conﬁguration (see page 93)

(see page 92)

86 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Select test point

Set record length (see page 95) Set signal pattern validation mode (see page 100) Set SSC mode (s Set verify toggle mode (see page 95)

ee page

88)

Select test point

Use this paramString value to set the DUT test point used by the application. This is the same as selecting the Test Point control on the DUT tab.

The value in bold font is the default value.

Values:

Version$Compliance (TP1) - Far End

Version$Tx Pins - Near End

Version$Custom

Example

SetGeneralParameter(clientId, Device, Device connector, "", "Version$Compliance (TP1) – Far End");

SetGene

ralParameter(clientId, Host, Host Connector, "", "Version$Tx Pins – Near End");

Select test method

Use this paramString value to set the test method used by the application. This is the same as using the Select Test Method controls on the DUT tab.

The value in bold font is the default value.

Values:

Test Tool$USB-IF Software (SigTest)

Test Tool$DPOJET

Test Tool$Both

Example

SetGeneralParameter(clientId, Device, Device Connector, "", "Test Tool$USB-IF Software (SigTest)")

SetGeneralParameter(clientId, Device, Device Connector, "", "Test Tool$Both");

TekExpress USB Automated Test Solution Help 87

TekExpress programmatic interface Set SSC mode

Set SSC mode

Use this paramString value to set the enable or disable the Spread Spectrum Clocking (SSC) mode used by the application for supported DUTs. This is the same as selecting the Spread Spectrum Clocking control on th

The value in bold font is the default value.

Values:

e DUT tab.

SSC On$tru

SSC On$false

Example

SetGene

SetGeneralParameter(clientId, Device, Device Connector, "", "SSC On$false");

ralParameter(clientId, Device, Device Connector, "", "SSC On$true");

Set de-embed ﬁlter mode

Use this paramString value to enable or disable de-embedding ﬁlter ﬁles. This is the same as selecting the De-Embed check box on the DUT tab.

The value in bold font is the default value.

ues:

Val

Compliance (TP1) - Far End - Deembed Filter Option$[true |false]

Tx Pins - Near End - Deembed Filter Option$[true | false]

Custom - Deembed Filter Option$[true | false]

Example

SetGeneralParameter(clientId, device, deviceConnector, "", "Compliance (TP1) - Far End - Deembed Filter Option$true”);

SetGeneralParameter(clientId, device, deviceConnector, "", "Custom - Deembed Filter Option$false”);

88 TekExpress USB Automated Test Solution Help

TekExpress programmatic interface Select de-embed ﬁlter ﬁle

Select de-embed ﬁ lter ﬁle

Use this paramString value to select the de-embed ﬁle to use by the application. This is the same as selecting a ﬁle from the De-Embed control on the DUT tab.

Custom ﬁlter ﬁles must be in the same directory as the application-provided ﬁlter ﬁles.

The value in bold font is the default value.

Values:

Compliance (TP1) - Far End - Deembed Filter File Path$[Tx_Device_TF_8G.ﬂt | custom_ﬁle_name.ﬂt]

Tx Pins - Near End - Deembed Filter File Path$[Tx_Device_TF_8G.ﬂt|custom_ﬁle_name.ﬂt]

Custom - Deembed Filter File Path$[Tx_Device_TF_8G.ﬂt|custom_ﬁle_name.ﬂt]

Example

SetGeneralParameter(clientId, device, deviceConnector, "", “Compliance (TP1) - Far End - Deembed Filter File Path$Tx_Device_TF_8G.ﬂt”);

SetGeneralParameter(clientId, device, deviceConnector, "", “Compliance (TP1) - Far End - Deembed Filter File Path$SpecialTestCase.ﬂt”);

TekExpress USB Automated Test Solution Help 89

TekExpress programmatic interface Set embed ﬁlter mode

Set embed ﬁlter mode

Use this paramString value to enable or disable ﬁlter embedding. This is the same as selecting the Embed check box on the DUT tab.

The value in bold font is the default value.

Values:

Compliance (TP1) - Far End - Deembed Filter Option$[true |false]

Tx Pins - Near End - Deembed Filter Option$[true | false]

Custom - Deembed Filter Option$[true | false]

Example

SetGeneralParameter(clientId, device, deviceConnector, "", "Compliance (TP1) - Far End - Embed Filter Option$true”);

SetGeneralParameter(clientId, device, deviceConnector, "", "Custom - Embed Filter Option$false”);

90 TekExpress USB Automated Test Solution Help

Tektronix TekExpress USB 3.0 User manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Getting help and support Related documentation

Related documentation

Conventions used in help

Technical support

Getting started Minimum system requirements

Minimum system requirements

Windows 7 user account settings

Supported instruments

Install the software

Verify application installation

Activate the license

View software version and license information

Required \My TekExpress folder settings

Map the My TekExpress folder to drive X

Set the \My TekExpress folder permissions

Application directories and their contents

File name extensions

TekExpress®USB key features

Operating basics Run the application

Run the application

Exit the application

Application controls

Options menu overview

The Options menu

Instrument control settings

View connected instruments

Operating basics Email settings

Email settings

Application panels overview

Operating basics Setup control overview

Set DUT parameters

Select tests

Set acquisition parameters

Running tests on prerecorded (saved) waveforms

Preferences tab

Status panel overview

Results panel overview

Preferences menu

Reports panel overview

Select report options

View a report

Report contents

Running tests Test process ﬂow

Deskew real-time oscilloscopes

Running tests Instrument and DUT connection setup

Instrument and DUT connection setup

Prerun checklist

TekExpress programmatic interface About the programmatic interface

About the programmatic interface

To enable remote access

Requirements for developing TekExpress client

Remote proxy object

Client proxy object

Client programmatic interface example

Program remote access code example

ApplicationStatus()

ChangeDutId()

CheckSessionSaved()

Connect()

Disconnect()

GetCurrentStateInfo()

GetDutId()

GetPassFailStatus()

GetReportParameter()

GetResultsValue()

GetTimeOut()

LockSession()

QueryStatus()

RecallSession()

Run()

SaveSession()

SaveSessionAs()

SendResponse()

SelectDevice()

SelectSuite()

SelectTest()