Tektronix TekExpress USB3.2 Tx Automated Test Solution Software Help User manual

Download

TekExpress® USB3.2 Tx USB 3.2 Automated Test Solution Software

Printable Application Help

*P077093906*

077-0939-06

TekExpress® USB3.2 Tx USB 3.2 Automated Test Solution Software

Printable Application Help

www.tek.com

077-0939-06

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

TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.

Contacting Tektronix

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

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

■

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

■

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

Welcome ............................................................................................................................................ vii

Getting help and support

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

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

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

Getting started

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

Required windows 7/ windows 10 user account setting ................................................................. 4

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

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

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

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

View software version .................................................................................................................... 9

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

Set the my TekExpress folder permissions ..................................................................................... 9

Application directories and their contents .................................................................................... 11

File name extensions .................................................................................................................... 12

Where test files are stored ............................................................................................................ 13

Operating basics

Run the application ....................................................................................................................... 16

Application panels overview ........................................................................................................ 18

Global application controls ........................................................................................................... 20

Application controls ................................................................................................................ 20

Options menu overview ........................................................................................................... 21

TekExpress instrument control settings .................................................................................. 23

Configure email settings .......................................................................................................... 25

Setup panel ................................................................................................................................... 27

Setup panel overview .............................................................................................................. 27

Set DUT parameters ................................................................................................................ 28

Select tests ............................................................................................................................... 32

Set acquisition parameters ....................................................................................................... 34

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

TekExpress USB3.2 Tx Automated Test Solution Help i

Table of Contents

Set configuration tab parameters ............................................................................................. 37

Preferences tab ........................................................................................................................ 41

Status panel ................................................................................................................................... 42

Status panel overview .............................................................................................................. 42

Results panel ................................................................................................................................. 44

Results panel overview ............................................................................................................ 44

View test-related files .............................................................................................................. 45

Preferences menu .................................................................................................................... 46

Reports panel ................................................................................................................................ 47

Reports panel overview ........................................................................................................... 47

Select report options ................................................................................................................ 48

View a report ........................................................................................................................... 50

Report contents ........................................................................................................................ 51

Running tests

Test process flow .......................................................................................................................... 53

Deskew real-time oscilloscopes .................................................................................................... 54

Instrument and DUT connection setup ......................................................................................... 55

Running tests ................................................................................................................................ 55

Prerun checklist ............................................................................................................................ 56

Saving and recalling test setup files

Test setup files overview .............................................................................................................. 57

Save a test setup file ..................................................................................................................... 57

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

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

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

TekExpress programmatic interface

About the programmatic interface ................................................................................................ 61

To enable remote access ............................................................................................................... 62

Requirements for developing TekExpress client .......................................................................... 64

Remote proxy object ..................................................................................................................... 65

Client proxy object ....................................................................................................................... 66

Client programmatic interface example ....................................................................................... 67

Program remote access code example .......................................................................................... 70

USB-TX programmer interface commands .................................................................................. 71

ApplicationStatus() .................................................................................................................. 71

ii TekExpress USB3.2 Tx Automated Test Solution Help

CheckSessionSaved() .............................................................................................................. 72

Connect() ................................................................................................................................. 72

Disconnect() ............................................................................................................................ 74

GetCurrentStateInfo() .............................................................................................................. 75

GetDutId() ............................................................................................................................... 76

SetDutId() ................................................................................................................................ 77

GetGeneralParameter() ............................................................................................................ 77

GetReportParameter() ............................................................................................................. 78

GetResultsValue() ................................................................................................................... 80

GetSelectedVersions() ............................................................................................................. 81

GetTimeOut() .......................................................................................................................... 81

LockServer() ............................................................................................................................ 82

LockSession() .......................................................................................................................... 83

QueryStatus() ........................................................................................................................... 84

RecallSession() ........................................................................................................................ 85

RegisterStatusChangeNotification() ........................................................................................ 85

Run() ........................................................................................................................................ 87

SaveSession() .......................................................................................................................... 87

SaveSessionAs() ...................................................................................................................... 88

SelectSingleTest() ................................................................................................................... 89

SendResponse() ....................................................................................................................... 90

SelectDevice() ......................................................................................................................... 91

SelectSuite() ............................................................................................................................ 92

SelectTest() .............................................................................................................................. 92

test values for SelectTest command ........................................................................................ 94

SetInstrument() ........................................................................................................................ 96

SetPreRecorded() ..................................................................................................................... 97

SetTimeOut() ........................................................................................................................... 98

SetVerboseMode() ................................................................................................................... 99

Status() ................................................................................................................................... 100

Stop() ..................................................................................................................................... 100

TransferImages() ................................................................................................................... 101

TransferResult() ..................................................................................................................... 102

TransferWaveforms() ............................................................................................................ 102

UnlockServer() ...................................................................................................................... 103

UnlockSession() .................................................................................................................... 103

GetPassFailStatus() ............................................................................................................... 104

SetGeneralParameter() .......................................................................................................... 105

paramString values for SetGeneralParameter command ....................................................... 106

Table of Contents

TekExpress USB3.2 Tx Automated Test Solution Help iii

Table of Contents

SCPI commands

About SCPI command ................................................................................................................ 117

Socket configuration for SCPI commands ................................................................................. 117

TEKEXP:*IDN? ......................................................................................................................... 125

TEKEXP:*OPC? ........................................................................................................................ 125

TEKEXP:ACQUIRE_MODE .................................................................................................... 126

TEKEXP:ACQUIRE_MODE? .................................................................................................. 126

TEKEXP:EXPORT .................................................................................................................... 127

TEKEXP:INFO? ......................................................................................................................... 127

TEKEXP:INSTRUMENT .......................................................................................................... 128

TEKEXP:INSTRUMENT? ........................................................................................................ 128

TEKEXP:LASTERROR? ........................................................................................................... 129

TEKEXP:LIST? .......................................................................................................................... 129

TEKEXP:POPUP ....................................................................................................................... 130

TEKEXP:POPUP? ...................................................................................................................... 130

TEKEXP:REPORT .................................................................................................................... 131

TEKEXP:REPORT? ................................................................................................................... 131

TEKEXP:RESULT? ................................................................................................................... 132

TEKEXP:SELECT ..................................................................................................................... 133

TEKEXP:SELECT? ................................................................................................................... 133

TEKEXP:SETUP ........................................................................................................................ 134

TEKEXP:STATE ....................................................................................................................... 134

TEKEXP:STATE? ...................................................................................................................... 135

TEKEXP:VALUE ...................................................................................................................... 135

TEKEXP:VALUE? .................................................................................................................... 136

Command parameters ................................................................................................................. 137

Examples .................................................................................................................................... 148

Reference

Handle error codes ...................................................................................................................... 151

Signal validation ......................................................................................................................... 152

LFPS pattern type validation ................................................................................................. 152

CPx pattern type validation ................................................................................................... 153

Compliance pattern toggle mechanisms ..................................................................................... 154

Oscilloscope-based toggle ..................................................................................................... 154

AWG-based toggle ................................................................................................................ 156

AFG-based toggle .................................................................................................................. 157

iv TekExpress USB3.2 Tx Automated Test Solution Help

Table of Contents

Manual toggle ........................................................................................................................ 158

TekExpress USB3.2 Tx Automated Test Solution Help v

Table of Contents

vi TekExpress USB3.2 Tx Automated Test Solution Help

Welcome

Welcome to the TekExpress® USB3.2 Tx Automated Test Solution Software application (referred to as USB3.2 Tx in the rest of the document). TekExpress USB3.2 Tx provides an automated, simple, and efficient way to test USB3.2 Tx transmitter interfaces and devices for USB-IF compliance and allows you to correlate Sig Test results with DPOJET for better margin, debugging, and analysis.

Key features and benefits

■

Automated solution for USB Type C, Standard, and Micro connectors which support USB3.2 Tx specification and CTS (Gen1 & Gen 2).

DPOJET plugin for USB Type C, Standard, and Micro connectors which support USB3.2 Tx specification and CTS (Gen1 & Gen 2) with setup files and MOI.

Support embedding Channels (1 m, 2 m, and 3 m cable) and their respective filter files for Type C, Standard, and Micro connectors.

Automated Lane Switching for reversible Type C connector.

Command line support for SigTest (latest released version by USB-IF).

Manual support for compliance to debug with DPOJET USB and USBSSP plug-ins.

TekExpress USB3.2 Tx Automated Test Solution Help vii

Welcome

viii TekExpress USB3.2 Tx Automated Test Solution Help

Getting help and support

Technical support

Conventions used in help

Online help uses the following conventions:

■

Technical support

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

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

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.

General information

Application specific

information

■

All instrument model numbers

■

Hardware options, if any

■

Probes used

■

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

■

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

■

Software version number

■

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

■

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

■

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

■

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

2 TekExpress USB3.2 Tx Automated Test Solution Help

Getting started

Minimum system requirements

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

Table 2: USB3.2 system requirements

Component Requirement

Oscilloscope See Supported instruments

Processor Same as the oscilloscope

Operating System Same as the oscilloscope:

Memory Same as the oscilloscope

Hard Disk Same as the oscilloscope

Display Super VGA resolution or higher video adapter (800 x

Firmware

■

Windows 7/ Windows 10 (64-bit only) SP1 Windows 7/

Windows 10 user account settings

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

■

TekScope 10.8.1 and later (for Windows 7)

■

TekScope 10.10.0 and above (for Windows 10)

Software

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

■

Microsoft .NET 4.0 Framework

■

DPOJET Jitter and Eye Analysis Tool (version 10.0.10 or higher) with Advanced Jitter and Eye analysis (DJA option) installed.

■

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

■

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

■

Serial Data Link Analysis (SDLA) software, version 3.0.4 or later, for Channel De-Embed, for custom filter development.

TekExpress USB3.2 Tx Automated Test Solution Help 3

Getting started

Required windows 7/ windows 10 user account setting

Windows 7/ Windows 10 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 the sliding control to Never Notify as shown in the image, and click OK.

Windows 7

4 TekExpress USB3.2 Tx Automated Test Solution Help

Getting started

Windows 10

See also

Supported oscilloscopes

TekExpress USB3.2 Tx Automated Test Solution Help 5

Getting started

Supported instruments

Table 3: Required equipment

Resource Model supported

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

oscilloscopes (Windows 7/ Windows 10 OS):

■

16 GHz bandwidth and above required for both Gen1 (5 Gbps) and Gen2 (10 Gbps) Normative and Informative measurements.

■

12.5 GHz bandwidth and above is suitable for Gen1 (5 Gbps) Normative and Informative measurements.

■

8 GHz bandwidth model is suitable for Gen1 (5 Gbps) debug only.

Probes Two TCA-SMA cables

Two SMP cables P7313SMA differential probe P7500 TriMode probe

USB3.2 Standard and Micro-B fixtures

The USB31AET fixture includes all Standard and Micro-B test fixtures for USB3.2 Tx compliance testing. This fixture set includes Tx Host and device testing, captive device testing, and Rx cal testing.

USB3.2 Type C fixtures

Tektronix AWG/AFG instruments

Tektronix Power Supply instruments

■

For Gen1 (5 Gb/s), use the USB3.0 Electrical Test Fixture.

■

For Gen2 (10 Gb/s), use th USB31AET fixture set.

■

The USB31CET fixture includes Type C fixtures for USB3.2 Tx Type C compliance testing.

■

The fixture set includes Tx Host and Device testing, captive device testing, and Rx Cal testing.

AWG7102, AWG7122 series with options 6, 8 AWG70001A, AWG70002A AWG5202, AWG5204 and AWG5208, AWG5014B, AWG5014C, AWG5012C, AWG5002C AFG3051C, AFG3052C, AFG3101, AFG3101C, AFG3102, AFG3102C, AFG3251, AFG3251C, AFG3252, AFG3252C, AFG3151C, AFG3152C AFG31101 /AFG31102, AFG31151 /AFG31152 or AFG31251 / AFG31252

PWS4205, PWS4305, PWS4323, PWS4602, PWS4721 AWG7102, AWG7122B, AWG7122C

6 TekExpress USB3.2 Tx Automated Test Solution Help

Getting started

Resource Model supported

Connector Type Standard Standard A to B connector

Micro Micro A and micro B connector

Type C Symmetrical connector on both

side

See also

Install the software

Minimum system requirements

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

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

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

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

4. Select the latest version of software, and then follow instructions to

download the software file.

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

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

the InstallShield Wizard.

Follow the on-screen instructions. The software is installed at C:\Program Files (x86)\Tektronix\TekExpress\TekExpress USB3.2 Tx

7. Verify application installation

NOTE. To test Gen2 capable hosts, use the HSET tool. The HSET tool configures the host into the compliance mode.

A to mini-B from USB-IF is not compliant any more.

TekExpress USB3.2 Tx Automated Test Solution Help 7

Getting started

See also

Minimum system requirements

Supported instruments

Required My TekExpress folder settings

Verify application installation

To verify the installation was successful:

1. Open the TekScope application.

2. Click the Analyze menu.

3. Verify that TekExpress USB3.2 Tx is listed in the Analyze menu.

4. Click TekExpress USB3.2 Tx to open the application.

Verify that the application opens successfully.

See also

Activate the license

Required My TekExpress folder settings

Activate the license

See also

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

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

The TekScope Option Installation wizard opens.

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.

View version and license information

Required My TekExpress folder settings

8 TekExpress USB3.2 Tx Automated Test Solution Help

Getting started

View software version

To view version information for TekExpress USB3.2 Tx, click the Options button and select About TekExpress.

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

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

2. Scroll through the Options list to locate USB: TekExpress USB3.2 Tx and

USBSSP-Tx: TekExpress USB3.2 Tx .

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

See also

Activate the license

Options menu

Required my TekExpress folder settings

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

permissions.

See also

Application directories and usage

File name extensions

Set the my TekExpress folder permissions

Ensure 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, ensure that the option Encrypt

contents to secure data is NOT selected.

TekExpress USB3.2 Tx Automated Test Solution Help 9

Getting started

See also

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

Application directories and usage

File name extensions

10 TekExpress USB3.2 Tx Automated Test Solution Help

Getting started

Application directories and their contents

TekExpress USB3.2 Tx

application

The TekExpress USB3.2 Tx application files are installed at the following location:

C:\Program Files (x86)\Tektronix\TekExpress\TekExpress USB3.2 Tx

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

Table 4: Application directories and usage

Directory names Usage

Bin It contains USB3.2 TX application libraries.

Compliance Suites It contains compliance-specific files.

Examples It contains various support files.

ICP It contains instrument and USB3.2 TX

application-specific interface libraries.

Lib It contains utility files specific to the USB3.2 TX

application.

Report Generator It contains style sheets for report generation.

Setup Files It contains setup files.

Tools It contains instrument and USB3.2 TX

application-specific files.

.pdf, .chm Help files

TekExpress USB3.2 Tx Automated Test Solution Help 11

Getting started

See also

File name extensions

View test-related files

File name extensions

The TekExpress USB3.2 Tx application uses the following file name extensions:

File name extension Description

.TekX Application session files (the extensions may not

be displayed)

.py Python sequence file

.xml Test-specific configuration information

(encrypted) files Application log files

.wfm Test waveform files

.mht Test result reports (default)

Test reports can also be saved in HTML format

.flt Filter files

.xslt Style sheet used to generate reports

.pdf, .chm Help files

See also

View test-related files

Application directories and their contents

12 TekExpress USB3.2 Tx Automated Test Solution Help

Getting started

Where test files are stored

When you launch TekExpress USB3.2 Tx for the first time, it creates the following folders on the oscilloscope:

■

\My Documents\My TekExpress\USB3.2 Tx

■

\My Documents\My TekExpress\USB3.2 Tx\Untitled Session

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

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

See also

Set the My TekExpress folder permissions

Application directories and usage

File name extensions

TekExpress USB3.2 Tx Automated Test Solution Help 13

Getting started

14 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

TekExpress USB3.2 Tx Automated Test Solution Help 15

Operating basics

Run the application

To start the TekExpress USB3.2 Tx application, do either of the following:

■

Select Analyze > TekExpress USB3.2 Tx from the TekScope menu.

■

The oscilloscope opens the TekExpress USB3.2 Tx application.

16 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

When you first run the application after installation, the application checks for a file called Resources.xml located in the C:\Users\<username>\My TekExpress\USB3.2 Tx folder. The Resources.xml file gets mapped to the X: drive when the application launches. Session files are then stored inside the X:\USB3.2 Tx folder. The Resources.xml file contains information about available network-connected instruments. If this file is not found, the application runs an instrument discovery program to detect connected instruments before launching USB3.2 Tx.

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

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

TekExpress USB3.2 Tx Automated Test Solution Help 17

Operating basics

See also

Required My TekExpress folder settings

Activate the license Application controls

Application panel overview

Application panels overview

TekExpress USB3.2 Tx uses panels to group related configuration, test, and results settings. Click 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.

18 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Table 5: Application panels overview

Panel Name Purpose

Setup The Setup panel shows the test setup controls. Click the Setup

button to open this panel. Use this panel to:

■

Select DUT parameters.

■

Select the test(s).

■

Set acquisitions parameters for selected tests.

■

Select test notification preferences.

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

view test logs.

Results View a summary of test results and select result viewing

preferences.

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

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

See also

Application controls

TekExpress USB3.2 Tx Automated Test Solution Help 19

Operating basics

Global application controls

Application controls

Table 6: Application controls descriptions

Item Description

Options menu

Test Panel buttons

Start / Stop button

Pause / Continue button

Menu to display global application controls.

Controls that open panels for configuring test settings and options.

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

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

Clear button

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

20 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Item Description

Minimize button

Quit button

Mini view/ Normal view

Use the Minimize button to minimize the application.

Use the Quit button to exit the application.

Toggles the application between Mini view and Normal view. Mini view displays the run messages with the time stamp, progress bar, Start/Stop button, and Pause/Continue button. The application moves to Mini view when you click the Start button.

Options menu overview

Configure email settings

Setup panel

Setup panel overview

The Setup panel contains sequentially ordered tabs that help guide you through a typical test setup and execution process. Click a tab to open the associated panel and controls.

The tabs on this panel are:

DUT: Set the DUT parameters

Test Selection: Select test(s)

Acquisitions: Select acquisition parameters

Preferences: Select test fail notification preferences

TekExpress USB3.2 Tx Automated Test Solution Help 27

Operating basics

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. The DUT settings available and the options in the drop-down list depends on the selections made in the settings. DUT settings also affect the list of available tests in the Test Selection tab.

28 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Click Setup > DUT to access the DUT parameters:

Table 7: DUT tab settings

Setting Description

DUT ID Adds an optional 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 an ID name: (.,..,...,\,/:?”<>|*).

Opens a Comments dialog box in which to enter

Comments icon (to the right of the DUT

ID field)

Help Opens the help document with DUT page

Acquire live waveforms Acquire active signals from the DUT for

Use prerecorded waveform files Run tests on a saved waveform. Open (load) a

DUT Type

optional text to add to a report. Maximum number of characters is 256. To enable or disable comments appearing on the test report, see Select report options).

selected.

measurement and analysis.

saved test setup.

■

Device: Select the DUT type as Device.

■

Host: Select the DUT type as Host.

TekExpress USB3.2 Tx Automated Test Solution Help 29

Operating basics

Setting Description

Version Lists the supported USB3.2 generations

■

USB3.2 Gen1

■

USB3.2 Gen2

Fixture

■

USB-IF: For Standard and Type-C connector of USB3.2 Gen1 and USB3.2 Gen2

Connector Select the appropriate connector form the

options.

■

Standard: For Type A and Type B, select Standard.

■

Micro: For Micro B, select Micro.

■

Type C: Select for Type C

Captive Select Captive check box if DUT type is Captive/

Tethered. Captive check box is applicable only if you select DUT Type as Device and Connector type as Type C or Standard.

Low power mode Selected when USB 3.2 DUT is operating in low

power mode.

Channel It is a combination of different length of cables

and PCBs. Depending on channel selection, different filters will be selected on the DUT tab.

■

Long: Consists of 3 m cable or 1 m cable with PCB assembly.

■

Short: Only PCBs, no cables attached.

■

Both: For Long and Short channel to be executed in single execution. During execution, user needs to change the channel from Long to Short as prompted by application.

Lane Selection Select the Lane Selection as Lane 0, Lane 1 or

Both. This configuration is enabled only when the Connector type is Type C.

Test Mode

■

Compliance: Preselects tests and parameters needed to meet compliance specifications for the selected device type. Disables the compliance filter controls.

■

User Defined: Enables the user to select specific tests and set custom parameters for tests (using the Configuration button).

Device Profile

30 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Setting Description

Test Point Select the appropriate test point location from

those listed. Only Compliance (TP4) - Far End test point is available when Test Mode is set to Compliance. For Tx Pins - Near End and Custom test point, select Test Mode as User Defined.

Data Rates Sets the test data rate (5 Gbps, 10 Gbps, or

Both).

Test Method Sets the algorithms used to measure and

analyze the signal. SigTest (USB-IF) is default test method for Compliance.

■

DPOJET: Select to perform measurements implemented in DPOJET.

■

SIGTest(USB-IF): Select to perform measurements implemented in SIGTest (USB-IF).

■

Both: Select to perform measurement implemented in DPOJET and SIGTest (USB-IF) simultaneously.

SigTest Displays the SigTest version for Gen1 and

Gen2.

Spread Spectrum Clocking Select this check box if your DUT supports

Spread Spectrum Clocking (SSC). Selects SSC tests based on your DUT configuration.

TekExpress USB3.2 Tx Automated Test Solution Help 31

Operating basics

Setting Description

Radio Friendly Clocking(5Gb/s) Select this check box to select the Radio

Friendly Clocking. This option is available only when Datarate 5 Gb/s is selected.

Filter Selection Click to view and select the filter files. Lists de-

embed, embed, and CTLE filter files or settings used for the current DUT test points. Use filters to take cable and fixture signal path length and characteristics into account. This configuration is enabled only when the Test Mode is User

Defined and the Channel type is Long or Both.

Select tests

Figure 1: Filter Selection

For USB3.2 Gen2, CTLE is performed using SDLA with default value as "Optimize". You can also select a specific CTLE index when in the User Defined test mode.

Set acquisition parameters

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

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

NOTE. USB3.2 Tx acquires all waveforms required by each test group and generation being tested (Gen1, Gen2) before performing analysis.

34 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Table 9: Acquisitions tab settings

Setting Description

Device Lists the signal type and input channel assigned

to that type. Click on Source fields to assign a channel source to a signal type.

The (Source) channels are auto selected, based on the probe type used and Lane selected on the DUT tab.

Refresh sources Updates the list of available channel sources as

used by the Source fields in the Device list. Click this button if you change channel connections in the test setup.

View probes Use the View Probes dialog box to show the

detected probe configurations, and to enable or disable probe signal source access in the application. Only available for the live waveforms.

CM measurement using TriMode™ Probe with DPOJET test method

Signal Validation Sets the signal validation actions. Select from

Delete waveform after analysis Select to delete the waveforms after analyzing

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 filters. This control is only valid for the DPOJET test method.

the available list items.

from the current acquisition. This is applicable only for live waveforms.

TekExpress USB3.2 Tx Automated Test Solution Help 35

Operating basics

USB3.2 Tx saves all acquisition waveforms to files 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 X:\TekExpress USB3.2 Tx\Untitled Session \<dutid>\<date>_<time>. Images created for each analysis, reports, and other information specific to that session 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

Running tests on

prerecorded (saved)

waveforms

To load a saved waveform file:

1. Click DUT.

2. Click Use pre-recorded waveform files.

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

buttons.

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

5. Navigate to and select the appropriate waveform file(s). You must select all waveforms required for the acquisition type.

36 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

6. To change, remove, or add a file to the list, click the browse button next to the file name to change, and use the menu items to replace, remove (delete) or add a file in the list.

7. Click Start.

Set configuration tab

parameters

Use the Configuration tab to set and view global instrument parameters for the selected tests. Which fields are available to edit depends on the selected test mode (Compliance or User Defined) as set in this tab or the DUT tab.

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

TekExpress USB3.2 Tx Automated Test Solution Help 37

Operating basics

Table 10: Configuration tab settings

Setting Description

Compliance Mode Select Compliance Mode. By default, Compliance Mode is

selected.

User Defined Mode Select User Defined Mode.

Limits Editor Opens the Limits Editor dialog box.

In User Defined Mode, use the Limits Editor to edit individual test limit settings.

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

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

Global Settings

38 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Setting Description

Instruments Detected Displays a list of the connected instruments found during the

instrument discovery. Instrument types include equipment such as oscilloscopes and signal sources (AFG, AWG) and power supply. Select Options > Instrument Control Settings to

refresh the connected instrument list.

Toggle tool setup Click to configure the device selected to Toggle. The Toggle Tool

Setup window displays the configurations for the selected

Toggle Using in the Instruments Detected dialog box.

Figure 2: Toggle Tool Setup for AFG

Power Cycle DUT Setup Click to configure the power cycle setup. The Power Cycle DUT

Setup displays the configurations for the selected DUT Power Cycle Method in the Instruments Detected dialog box.

Figure 3: Power Cycle DUT Setup for power supply

CP Settings Select User Define Mode to enable the controls of CP Settings tab.

Record Length (M) Set the record length for 5 Gb/s and 10 Gb/s. The default values

are as follows:

■

Gen1 CP0: 10 M

■

Gen1 CP1: 20 M

■

Gen2: 20 M

Range: 5 M - 30 M

TekExpress USB3.2 Tx Automated Test Solution Help 39

Operating basics

Setting Description

Sample Rate (GS/s) Set the sample rate for 5Gb/s and 10 Gb/s. The default values

are as follows:

■

Gen1: 50 GS/s

■

Gen2: 100 GS/s

The minimum and maximum values are as follows:

■

Gen1: Min: 25 GS/s, Max: 100 GS/s

■

Gen2: Min: 50 GS/s, Max: 100 GS/s

Bandwidth (GHz) Set the bandwidth for 5 Gb/s and 10 Gb/s. The default values are

as follows:

■

Gen1: 12.5 GHz

■

Gen2: 16 GHz

The minimum and maximum bandwidth values depend on the oscilloscope bandwidth limits.

Do Not Autoset Select not to autoset. Selecting this check box, enables the

Vertical Scale (mV/div) control.

Vertical Scale (mV/dv) Set the vertical scale for 5 Gb/s and 10 Gb/s. The default values

are as follows:

■

Gen1: 60 mV/div

■

Gen2: 60 mV/div

The minimum and maximum vertical scale values depend on the oscilloscope resolution.

Trigger Level (mV) Set the trigger level (mV) for 5 Gb/s and 10 Gb/s. The default

values are as follows:

■

Gen1: 10 mV

■

Gen2: 10 mV

Range: -100 mV - 300 mV

LFPS Settings

Width Trigger Lower Limit (ns) Set the width trigger lower limit in nanoseconds. The default

value is 10 ns. Range: 1 ns - 15 ns

Width Trigger Upper Limit (ns) Set the width trigger upper limit in nanoseconds. The default

value is 40 ns. Range: 15 ns - 100 ns

Trigger Level (mV) Set the trigger level in millivolt. The default value is 140 mV.

Range: 20 mV - 250 mV

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.

40 TekExpress USB3.2 Tx Automated Test Solution Help

Setting Description

Mid Edge Ref Level (mV) Set the mid edge ref level in millivolt. The default value is

150 mV. Range: 100 mV - 1000 mV

Hysteresis Level (mV) Set the hysteresis level in millivolt. The default value is 50 mV.

Range: 10 mV - 300 mV

Acquisition Bandwidth (GHz) Select the acquisition bandwidth from the drop-down list. The

default value is 5 GHz.

Operating basics

NOTE. If Toggle Using is AWG, select the check box in the Toggle Setup to verify the toggle status.

NOTE. If Toggle Using is Do not use, select the check box in the Toggle Setup to automatically recover the oscilloscope settings.

Preferences tab

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

TekExpress USB3.2 Tx Automated Test Solution Help 41

Operating basics

Table 11: Preferences tab settings

Setting Description

Actions on Test Measurement Failure

Show alert when new deskew values are configured on TekScope

On Test Failure, stop and notify me of the failure Stops the test and sends an email when a test

Popup Settings

Auto close Warnings and Informations during Sequencing Auto close after <no> Seconds

Auto close Error Messages during Sequencing. Show in Reports. Auto close after <no> Seconds

Select to show alert when new deskew values are configured on TekScope. By default, it is selected.

fails. Click Email Settings button and verify that “Email Test Results when complete or on error” is selected, and to verify the address to which the email is sent.

Select to auto close warnings/informations during sequencing. Set the Auto close time. By default, it is unselected.

Select to auto close Error Messages during Sequencing. Set the Auto close time. By default, it is unselected.

Status panel

Status panel overview

The Status button accesses the Test Status and Log View tabs, which provide status on test acquisition and analysis (Test Status tab) and a listing of test tasks performed (Log View tab). The application opens the Test Status tab when you start a test run. You can select the Test Status or the Log View tab to view these items while tests are running.

42 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Test status view

Log view

TekExpress USB3.2 Tx Automated Test Solution Help 43

Operating basics

Results panel

Table 12: Status panel settings

Control Description

Message History Window that lists all executed test operations

and timestamp information.

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 file to a text file. Use the standard

Save File window to navigate to and specify the folder and file name to which to save the log text.

Results panel overview

When a test finishes, the application automatically opens the Results panel to display a summary of test results.

44 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

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 in the upper right corner. Viewing preferences include showing whether a test passed or failed, summary or detailed results, and enabling wordwrap.

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

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 ways:

■

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 drag the column to the desired width.

View test-related files

■

To clear all test results displayed, click Clear.

■

Use the Preferences menu to change how some items display in the Results panel.

Preferences menu

Reports panel

Reports panel overview

Use the Reports panel to view saved reports, name and save reports from the current session, select test content to include in reports, and select report viewing options.

For information on setting up reports, see Select report options. For information on viewing reports, see View a Report.

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, always 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 13: Report options

Setting Description

Report Update Mode

Generate new report Creates a new report.

Append with previous run session Appends the latest test results to the end of the

current session’s test results report.

Include header in appended reports Select to include header in the appended

reports.

Replace current test in previous run session Replaces the previous test results with the latest

test results. Results from newly added tests are appended at the end of the report.

Report Creation Settings

■

In previous run, current session: Select to replace the previous run of the current session.

■

In any run, any session: Select to replace the test of any previous run and session. Selecting this option enables a browse button which displays a list of previous sessions and runs to select.

48 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Setting Description

Report name Displays the name and location from which to

open a report. The default location is at \My TekExpress\USB3.2 Tx\Untitled Session. The report file 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 field, type over the current folder path and name.

■

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

Be sure to include the entire folder path, the file name, and the file extension. For example: C: \Documents and Settings\your user name\My Documents\My TekExpress\USB3.2 Tx \DUT001_Test_72.7.1.3.mht.

NOTE. You cannot set the file location using the Browse button.

Open an existing report.

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

Save as type Saves a report in the selected output format

(Web archive, PDF or CSV).

Auto increment report name if duplicate Sets the application to automatically increment

the name of the report file if the application finds a file with the same name as the one being generated. For example: DUT001, DUT002, DUT003. This option is enabled by default.

Contents To Save

Include pass/fail info in details table Select to include the column labeled Test

Results (indicating whether the test passed or failed) in the report. For details, see Report Contents in View a

report.

Include detailed results Includes detailed results in the report

Include plot images Sets the application to include plots such as Eye

diagrams.

TekExpress USB3.2 Tx Automated Test Solution Help 49

Operating basics

Setting Description

Include setup configuration Sets the application to include hardware and

software information in the summary box at the top of the report. Information includes: the oscilloscope model and serial number, probe model and serial number, the oscilloscope firmware version, SPC and factory calibration status, and software versions for applications used in the measurements.

Include user comments 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.

View Report After Generating Automatically opens the report in a Web browser

when the test completes. This option is selected by default.

View Click to view the most current report.

Generate Report Generates a new report based on the current

(most-recent) analysis results.

Save As Specify a name for the report.

View a report

The application automatically generates a report when test analysis is completed and displays the report in your default Web browser (unless you cleared the View Report After Generating check box in the 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.

2. Click the Browse button and locate and select the report file to view.

3. In the Reports panel, click View.

For information on changing the file type, file name, and other report options, see

Select report options.

50 TekExpress USB3.2 Tx Automated Test Solution Help

Operating basics

Report contents

A report shows specified 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 configuration information

Setup configuration 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 information from a report, clear the Include Setup Configuration check box in the Reports panel before running the test.

User comments

If you selected to include comments in the test report, any comments you added in the DUT tab are shown at the top of the report.

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.

Running tests

Test process flow

Use the following list to set up and performing USB3.2 Tx tests.

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

2. Deskew the real-time oscilloscope.

3. Set up test equipment.

4. Verify that required instruments are connected to USB3.2 Tx.

5. Set DUT parameters.

6. Select tests.

7. View acquisition settings.

8. Set global signal-related parameters.

9. Select test notification preferences.

10. Select report options.

See also

11. Check the prerun checklist

12. Click Start to Run tests.

About test setups

About running tests

TekExpress USB3.2 Tx Automated Test Solution Help 53

Running tests

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. Refer to your DPOJET online help for information on how to deskew the channels.

1. Run Signal Path Compensation (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 during deskew that you will use for subsequent measurements.

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. These settings are not critical, but should be close.

8. Set the horizontal acquisition mode to average, which provides a more stable display.

9. Select Deskew from the Vertical menu.

10. Verify that the reference channel (typically CH1 or CH2) is set to 0 ps

deskew.

11. In the deskew control window, select the channel to deskew (typically CH3 or CH4). Adjust the deskew to overlay the rising edge as best as possible.

NOTE. Typical values are in the 10’s of ps or less with cables 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 fixture 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 significant differences in the skew between two TCA-SMA adapters. If you find 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.

54 TekExpress USB3.2 Tx Automated Test Solution Help

Running tests

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

Instrument and DUT connection setup

Click the Setup > Test Selection > Schematic button to open a PDF file that shows the compliance test setup diagrams (instrument, DUT, and cabling) for supported testing configurations.

Running tests

See also

Minimum system requirements

View connected instruments

After selecting and configuring tests, review the prerun checklist and then click Start to 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 USB3.2 Tx application on top, select Keep On Top from the TekExpress Options menu.

Configuration tab parameters

TekExpress USB3.2 Tx Automated Test Solution Help 55

Running tests

Prerun checklist

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

NOTE. If this is the first time you are running a test on the application, make sure that you have done the steps in Required My TekExpress folder settings before continuing.

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.

3. Verify that the correct instruments are connected (oscilloscope and signal

sources):

See also

a. In USB3.2 Tx, click Setup > Configuration.

b. Click Global Settings.

c. In the Instruments Detected list, verify that the test setup instruments

are shown. If they are not, 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 instruments (see View connected instruments).

Instrument and DUT connection setup

56 TekExpress USB3.2 Tx Automated Test Solution Help

Saving and recalling test setup files

Test setup files overview

Saved test setup information (such as the selected oscilloscope, general parameters, acquisition parameters, measurement limits, waveforms (if applicable), and other configuration settings) are all saved under the setup name at X:\USB3.2 Tx.

Use test setups to:

■

Run a new session, acquiring live waveforms, using a saved test configuration.

■

Create a new test setup based on an existing one.

■

View all the information associated with a saved test, including the log file, 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 file

Save a test setup

Recall a saved test setup

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 parameters are returned to the application’s default values.

To immediately save 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 specified test information and reports. If it does not, edit the parameters and repeat this step until the test runs to your satisfaction.

TekExpress USB3.2 Tx Automated Test Solution Help 57

Saving and recalling test setup files

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

5. Select Options > Save Test Setup. Enter the file name for the new setup file. The application saves the file to X:\USB3.2 Tx\<session_name>.

See also

Test process flow

View test-related files

Configuration tab parameters

Open (load) a saved test setup file

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 files must be located at X:\USB3.2 Tx.

See also

About test setups

Create a new test setup based on an existing one

Test setups overview

Run a saved test in prerecorded mode

58 TekExpress USB3.2 Tx Automated Test Solution Help

Saving and recalling test setup files

Run a saved test in prerecorded mode

Use this option to rerun a complete test using just the oscilloscope and the saved test setup files, if you selected to save the captured waveforms when you originally ran the saved test.

NOTE. When you run a saved test in prerecorded mode and then save it under the same name, the test results are saved in a new session folder named for the date and time of the session. Any test settings that you changed for the session are saved as a new test session file and be paired with a folder of the same name. Example. When you open a test setup that has multiple sessions and you select a session from the Run session list in the DUT tab, the settings associated with that test session are restored.

Each test session folder has a matching test session file that stores the individual test settings for that session.

1. Use the Options menu to Open a saved test setup file

2. Select Setup > DUT and then select Use pre-recorded waveform files. A

Run session drop-down list appears that displays the previous saved sessions for this test.

See also

3. Select the session to run. NOTE. If you select a session for which no waveform files were saved, you will receive an error message. Either select another test session or select waveform files to use.

4. Click Start.

5. To save the test results, session settings, and related files, save the test setup

before selecting another test setup or exiting the application.

About test setups

Create a new test setup based on an existing one

Test setups overview

TekExpress USB3.2 Tx Automated Test Solution Help 59

Saving and recalling test setup files

Create a new test setup file based on an existing one

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. Select Options > Save Test Setup As.

5. Enter a test setup name and click Save.

See also

About test setups

Set DUT parameters

Select acquisitions

60 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress 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 remote computer.

The following terminology is used in this section to simplify description text:

■

TekExpress Client: A high-level automation application that communicates with TekExpress using TekExpress Programmatic Interface.

■

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

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 TekExpress client library is inherited from .Net MarshalByRef class to provide the proxy object for the clients. The TekExpress client library maintains a reference to the TekExpress Server and this reference allows the client to control the server state.

TekExpress USB3.2 Tx Automated Test Solution Help 61

TekExpress programmatic interface

See also

Requirements for Developing TekExpress Client

To enable remote access

To access and remotely control an instrument using the TekExpress programmatic interface, you need to change specific firewall settings as follows:

1. Access the Windows Control Panel and open the Windows Firewall tool

2. Click Advance Settings > Inbound Rules.

3. Scroll through the Inbound Rules list to see if the following items (or with a

(Start > Control Panel > All Control Panel Items > Windows Firewall).

similar name) are shown:

■

TekExpress USB3.2 Tx

■

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.

6. On the client side, include controller.exe through which TekExpress USB3.2 Tx application is remotely controlled. For example, if the application is controlled using python scripts the "ipy64.exe" should be included as part of Inbound rules.

62 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

Run the New Inbound Rule

Wizard

1. Click 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 USB3.2 Tx.exe

5. TekExpress.exe

NOTE. See Application directories and contentfor the path to the application files.

6. Click Next.

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

8. Verify that all fields are selected (Domain, Private, and Public) in the Profile panel and click Next.

9. Use the fields in the Name panel to enter a name and optional description for

the rule. For example, a name for the TekExpress USB3.2 Tx application could be TekExpress USB3.2 Tx Application. Add description text to further identify the rule.

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 TekExpress PI as the name.

TekExpress USB3.2 Tx Automated Test Solution Help 63

TekExpress programmatic interface

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.

To use the remote access:

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

2. On the PC from which you are accessing the remote instrument, use the instrument IP address as part of the TekExpress USB3.2 Tx PI code to access that instrument. For example:

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

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 folder.

■

References required

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

■

IIdlglib.dll has a reference to TekDotNetLib.dll.

■

IRemoteInterface.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.

■

IIdlglib.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 files. It is essential to have these DLLs (IRemoteInterface.dll, IIdlglib.dll and TekDotNetLib.dll) in the same folder as that of TekExpressClient.dll.

64 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

Required steps for a client

The client uses the following steps to use TekExpressClient.dll to programmatically control the server:

Develop a client UI to access the interfaces exposed through the server. This client loads TekExpressClient.dll to access the interfaces. After TekExpressClient.dll is loaded, the client UI can call the specific 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.

2. The client locks the server application to avoid conflict with any other Client that may try to control the server simultaneously. “Lock” would also disable 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 notification 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 finish, the client unlocks the server.

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 (TekExpressRemoteInterface), “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,

TekExpress USB3.2 Tx Automated Test Solution Help 65

TekExpress programmatic interface

//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.

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

RemotingServices.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 file transfer commands from the server while transferring the report.

Examples

clientObject.clientIntf.DisplayDialog(caption, msg,iconType, btnType);

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

For more information, click the following links:

Secondary Dialog Message Handling

66 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

The secondary 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

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

Client programmatic interface example

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

Process flowchart

TekExpress USB3.2 Tx Automated Test Solution Help 67

TekExpress programmatic interface

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

68 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

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 identifies 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 notifications 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 notification from the server.

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

Handler of status change

notification

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 notification and the status is Ready.

9. After completing the tests, get the results.

10. Create a report or display the results and verify or process the results.

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

12. Disconnect from the remote object.

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 USB3.2 Tx Automated Test Solution Help 69

TekExpress programmatic interface

See also

Program remote access code example

This code example shows how to communicate between a remote PC and TekExpress USB3.2 Tx.

Table 14: Remote access code example

Task Code

Start the application

Connect through an IP address. m_Client.Connect("localhost") 'True or False

Lock the server m_Client.LockServer(clientID)

Disable the Popups m_Client.SetVerboseMode(clientID, false)

Set the DUT ID m_Client.SetDutId(clientID, "DUT_Name")

Run with set configurations m_Client.Run(clientID)

Wait for the test to complete. Do

Get the current state information mClient.GetCurrentStateInfo(clientID,

Send the response mClient.SendResponse(clientID,

Save results 'Save all results values from folder for current

Unlock the server m_Client.UnlockServer(clientID)

Disconnect from server m_Client.Disconnect()

Exit the application

clientID = m_Client.getClientID

Thread.Sleep(500) m_Client.Application_Status(clientID) Select Case status Case "Wait"

WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButtontexts)

WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxResponse) End Select Loop Until status = "Ready"

run m_Client.TransferResult(clientID, logDirname)

70 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

USB-TX programmer interface commands

ApplicationStatus()

ApplicationStatus(clientId). This method gets the status (ready, running, paused)

of the server application.

Parameters.

Name Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function. clientId example

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

QueryStatus

SendResponse

Status

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

TekExpress USB3.2 Tx Automated Test Solution Help 71

TekExpress programmatic interface

CheckSessionSaved()

CheckSessionSaved(clientID, savedStatus). This command checks whether the

current session is saved.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function. clientId example

savedStatus boolean OUT Boolean representing

whether the current session is saved

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). RecallSession

Connect()

SaveSession

SaveSessionAs

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

Connect(hostIPAddress, clientInterface, 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.

NOTE. The server must be active and running for the client to connect to the server. You can connect multiple clients to the server at a time.

72 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

Parameters.

Parameter Type Direction Description

HostIPAddress string IN The IP address of the

server to which the client is trying to connect. This is required to establish the connection between the server and the client.

clientIntf string IN The handle of the

remote object interface

clientId string OUT Identifier of the client

that is performing the remote function. clientId example

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).

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;

}

Comments. The server has to be active and running for the client to connect to the server. You can connect multiple clients to the server at a time. Each client is assigned a unique id.

TekExpress USB3.2 Tx Automated Test Solution Help 73

TekExpress programmatic interface

Related command(s). Disconnect in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

Disconnect()

Disconnect(clientId). This command disconnects the client from the server it is

connected to.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier 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: Success

–1: Failure

Example. try

{

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 in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

74 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

GetCurrentStateInfo()

GetCurrentStateInfo(clientID, WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButtontexts). 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 Description

clientId string IN Identifier of the client

that is performing the remote function. clientId example

WaitingMsbBxCaption string OUT The wait state or error

state message sent to you

WaitingMsbBxMessage string OUT The wait state/error

state message sent to you

WaitingMsbBxButtonte xts

string array OUT An array of strings

containing the possible response types that you can send

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

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

Comments.

TekExpress USB3.2 Tx Automated Test Solution Help 75

TekExpress programmatic interface

Related command(s). ApplicationStatus

QueryStatus

SendResponse

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

GetDutId()

GetDutId(clientId, dutId). This command returns the DUT id of the current set-up.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function. clientId example

dutId string OUT The DUT id of the set-

up.

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)

{

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). SetDutId in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

76 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

SetDutId()

SetDutId(clientID, 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 Identifier of the client

that is connected to the server clientId example

newDutId string IN The new DUT ID of the

setup.

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

return=m_Client.SetDutId(clientID, desiredDutId);

Comments.

GetGeneralParameter()

Related command(s). GetDutId in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

GetGeneralParameter(clientID, device, suite, test, paramString). This command gets the general parameter value based on the parameter name.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function. clientId example

device string IN Device DUT type

suite string IN Host type

test string IN Specifies the name of

the test for which to obtain Pass/Fail status or a test result value. Enter a null value for this field.

paramString string IN Specifies the control to

set.

TekExpress USB3.2 Tx Automated Test Solution Help 77

TekExpress programmatic interface

Return value. String value that indicates the parameter value for a selected parameter name.

Example. m_Client.GetGeneralParameter(clientId, "Drive", "Transmitter", " ", "DUT control");

Where:

clientId = clientId

device ="Drive"

suite = "Transmitter"

paramString = "DUT control"

Related command(s). SetGeneralParameter in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

GetReportParameter()

GetReportParameter(clientId, device, suite, test, parameterString). This command

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

78 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server clientId example

device string IN Specifies the DUT type

(Host or Device).

deviceConnector string IN string with device

connection type. Valid values are Host

Connector and Device Connector

test string IN Specifies the name of

the test for which to obtain the pass or fail status or a test result value.

parameterString string IN Specifies to return the

measured value for the indicated test. Enter

“Scope Model”, “TekExpress Version”, or “Application Version”

for this argument

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

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

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

TekExpress USB3.2 Tx Automated Test Solution Help 79

TekExpress programmatic interface

GetResultsValue()

GetResultsValue(clientId, device, deviceConnector, test, parameterString). This

command gets the result values of the specified measurement after the run.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server clientId example

device string IN Specifies the DUT type

(Host or Device).

deviceConnector string IN string with device

connection type. Valid values are Host

Connector and Device Connector

test string IN Specifies the name of

the test for which to obtain the test result value.

parameterString string IN Specifies to return the

measured value for the indicated test. Enter “Value” for this argument

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");

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

80 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

GetSelectedVersions()

GetSelectedVersions(clientID, device, suite, versions). This command is used to

select the particular version for a specific suite.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function clientId example

device string IN Device DUT type

suite string IN Host type

versions string[ ] IN An array containing the

versions of the specified site

Return value. Returns an empty string if the command is executed properly, otherwise returns a string as “Failed.”

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

GetTimeOut()

Example. m_Client = new Client();

Note: m_Client is a reference to the Client class in the Client DLL

Versions as string= m_Client.GetSelectedVersions(clientId, Device, Suite, Version_Strings);

GetTimeOut(clientId). Returns the current timeout period set by the client.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server clientId example

Return value. String value that indicates the status of the operation upon completion. The default return value is 1800000. Returnval as string.

TekExpress USB3.2 Tx Automated Test Solution Help 81

TekExpress programmatic interface

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

returnval as string

returnval=m_Client.GetTimeOut()

Comments.

Related command(s). SetTimeOut in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

LockServer()

LockServer(clientID). This command locks the server to which it is connected.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function clientId example

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

Example. try

{

string returnVal = remoteObject.lockServer(clientId);

remoteObject.connect(clientId);

return 1;

}

Related command(s). UnlockServer in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

82 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

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 Identifier of the client

that is performing the remote function clientId example

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.

If the client locks the server and is idle for a certain amount of time, then the server is automatically unlocked from that client.

Related command(s). UnlockSession in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

TekExpress USB3.2 Tx Automated Test Solution Help 83

TekExpress programmatic interface

QueryStatus()

QueryStatus(clientID, out status). This command transfers Analyze panel status

messages from the server to the client.

Parameters.

Parameter Type Direction Description

clientID string IN Identifier of the client

that is connected to the server clientId example

status string array OUT The list of status

messages generated during the run

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

GetCurrentStateInfo

SendResponse

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

84 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

RecallSession()

RecallSession(clientId,sessionName). Recalls a saved session. The name of the

session is provided by the client.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function. clientId example

sessionName string IN The name of the

session being recalled.

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

Example. returnVal = remoteObject.RecallSession(clientId,sessionName);

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

return “Session Recalled...”;

else

return CommandFailed(returnVal);

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

RegisterStatusChangeNoti

fication()

Related command(s). SaveSession

SaveSessionAs

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

RegisterStatusChangeNotification(clientID, statusChangeHandler). There are two ways to poll the application when it comes out of the Busy state. This command registers when there is an event, which indicates that activity is complete.

This command is used to select the particular version for a specific suite.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function clientId example

statusChangeHandler Delegate of type

TekExpressClient.Statu sChangeHandler

IN Handler

TekExpress USB3.2 Tx Automated Test Solution Help 85

TekExpress programmatic interface

Return value. Returns an empty string when the operation is successful; otherwise it returns an error description.

Example. m_Client.RegisterStatusChangeNotification(clientId, new TekExpressClient.StatusChangeHandler (OnStatusChange));

public void OnStatusChange(string _status)

{

_status = m_Client.Application_Status(clientId);

if (_status.CompareTo("Wait") == 0 || _status.CompareTo("Error") == 0)

{

string caption = "", message = "";

string[] buttonTexts = null;

m_Client.GetCurrentStateInfo(clientId, out caption, out message, out buttonTexts);

Console.WriteLine("Caption:" + caption);

Console.WriteLine("Message:" + message);

Console.WriteLine("Message Type:" + FormatStringArray(buttonTexts));

Console.WriteLine("Press Enter to send response . Waiting for Response...");

string response = Console.ReadLine();

m_Client.SendResponse(clientId, caption, message, response);

Console.WriteLine("Message Response " + response + " Sent");

}

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

86 TekExpress USB3.2 Tx Automated Test Solution Help

TekExpress programmatic interface

Run()

Run(clientId). Runs the setup. Once the server is set up and configured, it can be

run remotely using this function.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server clientId example

Return value. String that returns the status of the operation after completion.

Example. returnVal = remoteObject.Run(clientId);

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

return “Run started...”;

else

return CommandFailed(returnVal);

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

Related command(s). Stop in string clientId example

SaveSession()

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

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 Identifier of the client

that is connected to the server clientId example

sessionName string IN 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)

return “Session Saved...”;

else

return CommandFailed(returnVal);

TekExpress USB3.2 Tx Automated Test Solution Help 87

TekExpress programmatic interface

Comments. 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

SaveSessionAs

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

SaveSessionAs()

SaveSessionAs(clientId,sessionName). Saves the current session in a different

name every time this command is called. The name of the session is provided by the client.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server clientId example

sessionName string IN The name of the

session being saved.

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. The same session is saved under different names using this command. The name parameter cannot be empty. If it is empty, the client is prompted to provide a valid name.

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

Related command(s). RecallSession

SaveSession

88 TekExpress USB3.2 Tx Automated Test Solution Help

Tektronix TekExpress USB3.2 Tx Automated Test Solution Software Help User manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Table of Contents

Welcome

Getting help and support

Related documentation

Technical support

Conventions used in help

Getting started

Minimum system requirements

Required windows 7/ windows 10 user account setting

Supported instruments

Install the software

Verify application installation

Activate the license

View software version

Required my TekExpress folder settings

Set the my TekExpress folder permissions

Application directories and their contents

File name extensions

Where test files are stored

Operating basics

Run the application

Application panels overview

Global application controls

Application controls

Options menu overview

Configure email settings

Setup panel

Setup panel overview

Set DUT parameters

Select tests

Set acquisition parameters

Preferences tab

Status panel

Status panel overview

Results panel

Results panel overview

View test-related files

Preferences menu

Reports panel

Reports panel overview

Select report options

View a report

Report contents

Running tests

Test process flow

Deskew real-time oscilloscopes

Instrument and DUT connection setup

Running tests

Prerun checklist

Saving and recalling test setup files

Test setup files overview

Save a test setup file

Open (load) a saved test setup file

Run a saved test in prerecorded mode

Create a new test setup file based on an existing one

TekExpress 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

USB-TX programmer interface commands

ApplicationStatus()

CheckSessionSaved()

Connect()

Disconnect()

GetCurrentStateInfo()

GetDutId()

SetDutId()

GetGeneralParameter()

GetReportParameter()

GetResultsValue()

GetSelectedVersions()

GetTimeOut()