Tektronix TekExpress USB2 5 Series MSO Help User manual

Download

TekExpress® USB2 Automated Test Solution

Printable Application Help

*P077142900*

077-1429-00

TekExpress® USB2 Automated Test Solution

Printable Application Help

www.tek.com

077-1429-00

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

TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.

Contacting Tektronix

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

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

■

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

■

Worldwide, visit www.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 ...................................................................................................... 5

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

Downloading and installing the software ....................................................................................... 7

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

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

Application directories and their contents ...................................................................................... 9

File name extensions .................................................................................................................... 10

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

Operating basics

Launch the application .................................................................................................................. 13

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

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

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

Options menu overview ........................................................................................................... 18

Instrument control settings ...................................................................................................... 19

View connected instruments ................................................................................................... 20

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

Application Panels

Setup panel ................................................................................................................................... 23

Setup controls overview .......................................................................................................... 23

Set DUT parameters ................................................................................................................ 24

Select tests ............................................................................................................................... 26

Set acquisition parameters ....................................................................................................... 27

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

Configuration tab parameters .................................................................................................. 30

TekExpress® USB2 Printable Application Help i

Table of Contents

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

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

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

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

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

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

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

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

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

Reports panel ................................................................................................................................ 41

Reports panel overview ........................................................................................................... 41

Select report options ................................................................................................................ 42

View a report ........................................................................................................................... 44

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

Running tests

Test process flow .......................................................................................................................... 47

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

Running tests ................................................................................................................................ 48

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

Saving and recalling test setup files

Test setup files overview .............................................................................................................. 49

Save a test setup file ..................................................................................................................... 49

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

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

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

TekExpress USB2 programmatic interface

About the programmatic interface ................................................................................................ 53

To enable remote access ............................................................................................................... 54

Requirements for developing TekExpress USB2 client ............................................................... 56

Remote proxy object ..................................................................................................................... 57

Client proxy object ....................................................................................................................... 58

Client programmatic interface example ....................................................................................... 59

Program remote access code example .......................................................................................... 62

Command list ................................................................................................................................ 63

Select Record Length () ........................................................................................................... 63

ii TekExpress® USB2 Printable Application Help

Application status() ................................................................................................................. 65

Check session saved() ............................................................................................................. 66

Connect() ................................................................................................................................. 67

Disconnect() ............................................................................................................................ 68

DUT automation() ................................................................................................................... 69

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

Get current status info() ........................................................................................................... 72

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

Get pass fail status() ................................................................................................................ 74

Get report parameter() ............................................................................................................. 75

Get results value() ................................................................................................................... 76

Lock server() ........................................................................................................................... 77

Lock session() .......................................................................................................................... 77

Query status() ......................................................................................................................... 78

Register status change notification() ....................................................................................... 79

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

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

Save session as() ...................................................................................................................... 84

Select device() ......................................................................................................................... 84

Select pre-recorded waveform files ......................................................................................... 85

Select port() ............................................................................................................................. 85

Select probe type() ................................................................................................................... 87

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

Select power condition() ......................................................................................................... 90

Select qualifier() ...................................................................................................................... 91

Select single test() ................................................................................................................... 93

Select suite() ............................................................................................................................ 95

Select test method() ................................................................................................................. 95

Select test mode() .................................................................................................................... 97

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

Select test point:Far End ........................................................................................................ 100

Select Tier() ........................................................................................................................... 101

Send response() ..................................................................................................................... 103

Select versions() .................................................................................................................... 104

Set or get the DUT ID ........................................................................................................... 106

Set instrument() ..................................................................................................................... 107

Set verbose mode() ................................................................................................................ 108

Status() ................................................................................................................................... 109

Transfer images() .................................................................................................................. 109

Table of Contents

TekExpress® USB2 Printable Application Help iii

Table of Contents

Transfer result() ..................................................................................................................... 111

Transfer waveforms() ............................................................................................................ 111

Unlock server() ...................................................................................................................... 112

Unlock session() .................................................................................................................... 112

SCPI commands

About SCPI command ................................................................................................................ 113

Socket configuration for SCPI commands ................................................................................. 113

TEKEXP:*IDN? ......................................................................................................................... 121

TEKEXP:*OPC? ........................................................................................................................ 121

TEKEXP:ACQUIRE_MODE .................................................................................................... 122

TEKEXP:ACQUIRE_MODE? .................................................................................................. 122

TEKEXP:EXPORT .................................................................................................................... 123

TEKEXP:INFO? ......................................................................................................................... 123

TEKEXP:INSTRUMENT .......................................................................................................... 124

TEKEXP:INSTRUMENT? ........................................................................................................ 124

TEKEXP:LASTERROR? ........................................................................................................... 125

TEKEXP:LIST? .......................................................................................................................... 125

TEKEXP:MODE ........................................................................................................................ 126

TEKEXP:MODE? ...................................................................................................................... 127

TEKEXP:POPUP ....................................................................................................................... 127

TEKEXP:POPUP? ...................................................................................................................... 128

TEKEXP:REPORT .................................................................................................................... 128

TEKEXP:REPORT? ................................................................................................................... 129

TEKEXP:RESULT? ................................................................................................................... 129

TEKEXP:SELECT ..................................................................................................................... 130

TEKEXP:SELECT? ................................................................................................................... 131

TEKEXP:SETUP ........................................................................................................................ 131

TEKEXP:STATE ....................................................................................................................... 132

TEKEXP:STATE? ...................................................................................................................... 132

TEKEXP:VALUE ...................................................................................................................... 133

TEKEXP:VALUE? .................................................................................................................... 134

Command parameters list ........................................................................................................... 135

Examples ................................................................................................................................... 141

Reference

Handle error codes ...................................................................................................................... 143

HSETT controller ....................................................................................................................... 144

iv TekExpress® USB2 Printable Application Help

Table of Contents

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

Signal validation ......................................................................................................................... 144

TekExpress® USB2 Printable Application Help v

Table of Contents

vi TekExpress® USB2 Printable Application Help

Welcome

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

Key features and benefits

■

Comprehensive test coverage; select or deselect individual tests

Precise debugging and troubleshooting

USB-IF Signal Quality measurements integrated with TekExpress USB2

Automated Receiver Sensitivity measurement

User-friendly interface for plot inspection

Minimizes user intervention when performing time-consuming testing

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

Complete programmatic interface enables automation scripts to call TekExpress USB2 functions

■

Flexible probe configuration

TekExpress® USB2 Printable Application Help vii

Welcome

■

Comprehensive signal validation check

■

Automated DUT test mode control

viii TekExpress® USB2 Printable Application Help

Getting help and support

Conventions used in help

Online Help uses the following conventions:

■

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

■

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

Table 2: Icon descriptions

Icon Meaning

This icon identifies important information.

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

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

Technical support

General information

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

Contacting Tektronix for more information.

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

■

All instrument model numbers

■

Hardware options, if any

■

Probes used

■

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

■

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

2 TekExpress® USB2 Printable Application Help

Getting help and support

■

Application specific

information

Software version number

■

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

■

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

■

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

■

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

■

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

TekExpress® USB2 Printable Application Help 3

Getting help and support

4 TekExpress® USB2 Printable Application Help

Getting started

Minimum system requirements

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

Table 3: TekExpress USB2 system requirements

Component Requirement

Oscilloscope See Supported Instruments

Processor Same as the oscilloscope

Operating System Same as the oscilloscope:

Memory Same as the oscilloscope

Hard Disk Same as the oscilloscope

Display Same as the oscilloscope

Firmware TekScope 1.6.3 and later (Windows 10, 64-bit

Software

only)

■

TekExpress Framework version 4.5.0

■

Iron Python 2.7.3

■

PyVISA-1.3

■

Microsoft .NET 4.0 framework

■

Microsoft Internet Explorer 6.0 SP1 or later

■

Adobe Reader 8.0 or equivalent software for viewing portable document format (PDF) files

TekExpress® USB2 Printable Application Help 5

Getting started

Supported instruments

Table 4: Required equipments

Resource Model supported

Oscilloscope Tektronix MSO54, MSO56, MSO58

AWG AWG70001A, AWG70002A, AWG7102,

AWG7122B, AWG7122C, AWG5014B, AWG5014C, AWG5012C, AWG5002C

Probes

■

Two TCA-SMA adapters

■

TCP0030A or TCP202/A probe

■

TDP1500, TDP3500, or P6248 differential probe

■

TAP1500 or P6245 single-ended probe

See also

Host test fixtures

Device test fixtures

Minimum system requirements

■

USB2SIGQUAL fixture set (USB-IF host/ device SQ)

■

USB2/3_DD fixture (USB-IF Drop-Droop fixture)

■

TDSUSBF (Tektronix fixture)

■

USB2SIGQUAL fixture set (USB-IF host/ device SQ)

■

USB2/3_DD fixture (USB-IF Drop-Droop fixture)

■

TDSUSBF (Tektronix fixture)

6 TekExpress® USB2 Printable Application Help

Getting started

Downloading and installing the software

Complete the following steps to download and install the latest TekExpress USB2 application. See Minimum system requirements for compatibility.

1. Go to www.tek.com

2. Click Downloads. In the Downloads menu, select DOWNLOAD TYPE as

Software and enter USB2 in the MODEL OR KEYWORD field and click SEARCH.

See also

3. Select the latest version of software and follow the instructions to download. Copy the executable file to the oscilloscope.

4. Double-click the executable and follow the on-screen instructions. The software is installed at C:\Program Files\Tektronix\TekExpress\USB2\.

5. Select Application > TekExpress USB2 from the oscilloscope menu to launch the application.

Minimum system requirements

Supported instruments

TekExpress® USB2 Printable Application Help 7

Getting started

Activate the license

Follow the steps to activate the TekExpress USB2 license:

1. From the oscilloscope menu bar, click Help > About.

2. Click Install License; browse and select the license file (.Lic).

3. Follow the prompts of the oscilloscope to activate the license.

NOTE. Contact Tektronix to purchase the TekExpress USB2 license.

See also

View software version

See also

View version and license information

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

To view version information for TekExpress USB2, click Options > About TekExpress.

To view the license installed and option key information, from the oscilloscope menu, click Help > About.

Activate the license

8 TekExpress® USB2 Printable Application Help

Getting started

Application directories and their contents

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

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

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

Table 5: Application directories and usage

Directory names Usage

AWG Files Contains files required for Receiver Sensitivity

measurement

Bin Contains TekExpress USB2 application libraries

Compliance Suites Contains compliance-specific files

Custom Settings Contains custom settings files

Examples Contains various support files

Filter Files Contains filter files required for executing

receiver sensitivity measurement

ICP Contains instrument and TekExpress USB2

application-specific interface libraries

Images Contains images

Lib Contains utility files specific to the TekExpress

USB2 application

Report Generator Contains style sheets for report generation

Tools Contains instrument and TekExpress USB2

application-specific files

TekExpress® USB2 Printable Application Help 9

Getting started

See also

File name extensions

View test-related files

File name extensions

The TekExpress USB2 application uses the following file name extensions:

File name extension Description

.py Python sequence file

.xml Test-specific configuration information

(encrypted) files Application log files

.wfm Test waveform files

.mht Test result reports (default)

Test reports can also be saved in HTML format

.xslt Style sheet used to generate reports

.pdf Test result reports

Application help document

.csv Test result reports

Plot data

See also

View test-related files

Application directories and their contents

10 TekExpress® USB2 Printable Application Help

Getting started

Where test files are stored

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

■

C:\Users\<username>\Documents\My TekExpress\USB2

■

C:\Users\<username>\Documents\My TekExpress\USB2\Untitled Session

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

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

See also

Application directories and usage

File name extensions

TekExpress® USB2 Printable Application Help 11

Getting started

12 TekExpress® USB2 Printable Application Help

Operating basics

Launch the application

To launch the TekExpress USB2 application, select Application > TekExpress USB2 from the oscilloscope menu.

The oscilloscope opens the TekExpress USB2 application:

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

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

TekExpress® USB2 Printable Application Help 13

Operating basics

See also

Application controls

Application panel overview

Application panels overview

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

14 TekExpress® USB2 Printable Application Help

Operating basics

Table 6: 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 acquisition 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.

Plots View a summary of plot generated during run.

See also

Application controls

TekExpress® USB2 Printable Application Help 15

Operating basics

Global application controls

Application controls

Table 7: Application controls descriptions

Item Description

Options menu

Test Panel buttons

Menu to display global application controls.

Controls that open panels for configuring test settings and options.

Start / Stop button

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

16 TekExpress® USB2 Printable Application Help

Operating basics

Item Description

Pause / Continue button

Clear button

Application window move icon

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

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

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

Minimize button

Minimizes the application.

TekExpress® USB2 Printable Application Help 17

Operating basics

Item Description

Close button

Mini view / Normal view

Closes 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 automatically moves to the mini view when you click the Start button.

Options menu overview

See also.

Application panel overview

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

The Options menu has the following selections:

Menu Function

Default Test Setup Opens an untitled test setup with defaults

selected

Open Test Setup Opens a saved test setup

Save Test Setup Saves the current test setup selections

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

one

Open Recent Displays a menu of recently opened test setups

to select from

Instrument Control Settings Detects, lists, and refreshes the connected

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

Keep On Top Keeps the TekExpress USB2 application on top

of other open windows on the desktop

Email Settings Use to configure email options for test run and

results notifications

18 TekExpress® USB2 Printable Application Help

Operating basics

Menu Function

Help Displays the TekExpress USB2 help

About TekExpress

■

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

■

Provides access to License information for your TekExpress USB2 installation

■

Provides a link to the Tektronix Web site

Options menu

Instrument control

settings

See also.

Application controls

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

To access, click Options > Instrument Control Settings.

TekExpress® USB2 Printable Application Help 19

Operating basics

Use the Instrument Control Settings feature to search for connected instruments and view instrument connection details. You can select listed connected instruments for use in the Global Settings tab in the test Configuration pane.

View connected

instruments

Configure email settings

TekExpress® USB2 Printable Application Help 21

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

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

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

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

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

Operating basics

4. (Required) In the Server Configuration section, type the SMTP Server address of the Mail server configured at the client location, and the SMTP Port number, in the corresponding fields.

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

NOTE. If any of the above required fields are left blank, the settings will not be saved and email notifications will not be sent.

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

■

Reports: Select to receive the test report with the notification email.

■

Status Log: Select to receive the test status log with the notification email. If you select this option, select whether you want to receive the full log or just the last 20 lines.

6. In the Email Configuration section:

■

Email Format: Select the message file format to send: HTML (the default) or plain text.

■

Max Email Size (MB): Enter a maximum file size for the email message. Messages with attachments larger than this limit will not be sent. The default is 5 MB.

■

Number of Attempts to Send: Enter the number to limit the number of attempts that the system makes to send a notification. The default is 1. You can also specify a timeout period.

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

8. To test your email settings, click Test Email.

9. To apply your settings, click Apply.

10. Click Close when finished.

Email settings

22 TekExpress® USB2 Printable Application Help

Application Panels

Setup panel

Setup controls overview

The Setup panel contains sequentially ordered tabs that 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® USB2 Printable Application Help 23

Application Panels

Set DUT parameters

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

Click Setup > DUT to access the DUT parameters:

Table 8: 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)

Acquire live waveforms Acquire active signals from the DUT for

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

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

measurement and analysis.

saved test setup

24 TekExpress® USB2 Printable Application Help

Application Panels

Setting Description

Select DUT Sets the DUT device type to test (Device, Host

or Hub). Selecting the DUT device type preloads other fileds on the DUT panel.

Test Mode

Version Lists the supported USB 2.0 generations.

Device Profile

Low Speed, Full Speed and High Speed Sets the available test parameters for the Device

Test Method Sets the algorithms used to measure and

■

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

Profile area. Device Profile parameter availability depends on the Test Mode setting. The default test mode setting is High Speed.

analyze the signal.

■

USBET: Select to perform measurements implemented in USBET.

■

Tektronix: Select to perform measurements implemented by Tektronix.

Test point Sets the Near End or Far End test point location.

■

Near End: Select if you connect the device with a captive cable.

■

Far End: Select if you connect the device with other than captive cable.

Signal Direction Sets the Up or Down stream data signal

direction.

■

Up Stream: Direction of data is towards the host.

■

Down Stream: Direction of data is away from the host.

Tier Sets the Tier based on the position in the hub

where the device is connected.

TekExpress® USB2 Printable Application Help 25

Application Panels

Setting Description

Power Condition Sets the energy source as Self Powered or Bus

Powered.

■

Self Powered: Select if the power is drawn from an external energy source.

■

Bus Powered: Select if the power is drawn from the USB port.

Port Enter the number of port used to connect to the

host.

See also.

Select a test

Select tests

Use the Test Selection tab to select USB 2.0 tests. Listed tests depend on settings in the DUT panel.

26 TekExpress® USB2 Printable Application Help

Application Panels

Table 9: Test Selection tab settings

Setting Description

Deselect All, Select All buttons Deselect or select all tests in the list.

Tests Click a test to select or deselect. Selecting a test

also shows details about that test in the Test Description pane. The application automatically selects all required tests when in Compliance mode.

Schematic button Shows an equipment and test fixture setup

schematic (connection diagram) for the selected test. Use to set up the equipment and fixtures or to verify the setup before running the test.

NOTE. All tests are selected by default.

See also.

Set acquisition parameters

Select the Acquisition tab in the Setup panel to view test acquisition parameters. You can also use this tab to load pre-recorded (saved) test session waveform files on which you can run tests.

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

TekExpress® USB2 Printable Application Help 27

Application Panels

NOTE. TekExpress USB2 acquires all waveforms required by each test group and generation being tested before performing analysis.

Table 10: Acquisitions tab settings

Setting Description

Differential Configuration Lists the signal type and input channel assigned

to that type.

Single Ended Configuration Click in a Source fields to assign a channel

source to a signal type.

Qualifier Acquires the signals from the reference device.

Select the appropriate channel.

Probe Type Sets the probe type based on the

measurements.

View Probes button Shows the detected probe configurations, and

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

TekExpress USB2 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 USB2\Untitled Session\<dutid>\<date>_<time>. Images created for each analysis, test session 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.

28 TekExpress® USB2 Printable Application Help

Application Panels

See also.

Running tests on prerecorded saved waveforms

Running tests on

prerecorded (saved)

waveforms

To load a saved waveform file on which to run tests:

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 (For example, LSSQ, FSSQ, HSSQ).

The Select a Waveform file dialog box appears.

5. Select the required waveform file(s). You must select all waveforms required for the acquisition type.

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.

TekExpress® USB2 Printable Application Help 29

Application Panels

Configuration tab

parameters

Use the Configuration tab to set and view global instrument parameters for the selected tests. Available fields for editing depend 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.

Configuration tab: global

settings and measurement

parameters

See also.

Configuration tab: Global settings parameters

The following table lists the Configuration tab settings and measurement parameters. Fields shown on this tab can change depending on selected items.

Configuration > Global Settings

30 TekExpress® USB2 Printable Application Help

Application Panels

Configuration > Measurements > Low Speed

Configuration > Measurements > High Speed

TekExpress® USB2 Printable Application Help 31

Application Panels

Configuration > Measurements > Power Measurements

32 TekExpress® USB2 Printable Application Help

Application Panels

Table 11: Configuration tab Global and Measurement Settings

Control Description

Test Mode Determines whether test parameters are in

compliance or are able to be edited.

■

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

■

User Defined: Enables editing of measurement configuration.

Limits Editor button Opens the Limits Editor dialog box.

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

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 Tab Displays a list of the connected instruments.

Instruments Detected Displays a list of the connected instruments

found during the instrument discovery. Instrument types include equipment such as oscilloscopes and signal sources (AWG). Select Options > Instrument Control Settings to

refresh the connected instrument list.

DUT Control Display options for controlling DUT test mode.

Manual: Select this option to control DUT test mode

manually.

Automated: Select this option to let TekExpress USB2

control the DUT test mode. Controller PC IP: Enter the IP address of Controller PC or Laptop.

Scope Bandwidth Sets the oscilloscope bandwidth to use for Low

Speed, Full Speed and High Speed tests. Select the bandwidth from the drop-down menu.

TekExpress® USB2 Printable Application Help 33

Application Panels

Control Description

Measurements Setting Tab Displays a list of selected measurements and

tests.

Acquire/Analyze Tab Sets additional parameters for specified

measurements. For example, if you select Eye Diagram measurement under High Speed Signal Quality, the Acquire and Analyze tabs are populated with additional parameters to set. Probe Type: Select the appropriate probe. Custom Eye Mask: Browse to select a mask file. Record Length: Enter the record length value in the text box or use the TekExpress keypad. VBus: Select the appropriate source for bus voltage from the drop-down. Trigger: Select the appropriate source for trigger from the drop-down. Device Type: Select the appropriate device type from the drop-down.

Preferences tab

See also.

About acquisitions

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

34 TekExpress® USB2 Printable Application Help

Application Panels

Table 12: Preferences tab settings

Setting Description

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

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.

Always display waiver mask for High Speed near end and Low Speed eye diagrams

Sets the application to add the waiver mask for High Speed near end and Low Speed eye diagrams to the reports.

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.

Test status view

TekExpress® USB2 Printable Application Help 35

Application Panels

Log view

Table 13: Status panel : Log View pane 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.

See also.

Application panel overview

36 TekExpress® USB2 Printable Application Help

Results panel

Application Panels

Results panel overview

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

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

Set viewing preferences for this panel from the Preferences menu in the upper right corner. Viewing preferences include showing whether a test passed or failed, summary or detailed results, and enabling wordwrap.

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.

■

To clear all test results displayed, click Clear.

■

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

TekExpress® USB2 Printable Application Help 37

Application Panels

See also.

View a report

Application panels overview

View test-related files

Files related to tests are stored in the C:\Users\<username>\Documents\My TekExpress\USB2 folder. Each test setup in this folder has a test setup file and a test setup folder, both with the test setup name.

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

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

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

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

The first time you run a new, unsaved session, the session files are stored in the Untitled Session folder located at C:\Users\<username>\Documents\\My TekExpress\USB2. When you name and save the session, the files are placed in a folder with the name that you specify. A copy of the test files stay in the Untitled Session folder until you run a new test or until you close the application.

See also.

File name extensions

38 TekExpress® USB2 Printable Application Help

Application Panels

Preferences menu

Plots panel

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

■

To stop the test and send an email when test fails, select Preferences > On Test Failure, stop and notify me of the failure.

■

To display the weiver mask for High Speed near end and Low Speed eye diagrams in the reports, select Preferences > Always display weiver mask for High Speed near end and Low Speed eye diagrams.

See also.

Results panel overview

The Plots panel displays a summary of plot generated during run.

Depending on DUT speed and selected measurement(s), application will generate one/two plot(s) for each speed. These two plots are waveform plot and eye diagram plot.

These plots have zoom, cursors, save, and dock/undock features.

TekExpress® USB2 Printable Application Help 39

Application Panels

See also

NOTE. TekExpress USB2 keeps a copy of USBET generated plots in the saved test session folder.

Application panel overview

40 TekExpress® USB2 Printable Application Help

Application Panels

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.

See also.

About panels

TekExpress® USB2 Printable Application Help 41

Application Panels

Select report options

Click the Reports button and use the Reports panel controls to select which test result information will be included in the report, and the naming conventions to use for the report.

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

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

Table 14: Report options

Setting Description

Report Generation

Generate new report Creates a new report.

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

current session’s test results report.

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

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

Report name Displays the name and location from which to

open a report. The default location is at C:\Users

\<username>\Documents\My TekExpress \USB2\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, enter a new 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: \Users\<username>\Documents\My TekExpress \USB2 \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 or PDF).

42 TekExpress® USB2 Printable Application Help

Application Panels

Setting Description

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 Result

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

View a report.

Include detailed results Select to include detailed results of a test

Include plot images Select to include plotted diagrams such as Eye

diagram.

Include setup configuration Select 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 Select to automatically open the report in a Web

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

View button 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.

TekExpress® USB2 Printable Application Help 43

Application Panels

View a report

Report contents

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.

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

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 include comments in the test report, any comments you added in the tab are shown at the top of the report.

Test result summary

44 TekExpress® USB2 Printable Application Help

DUT

Application Panels

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

See also.

Results panel overview

View test-related files

TekExpress® USB2 Printable Application Help 45

Application Panels

46 TekExpress® USB2 Printable Application Help

Running tests

Test process flow

Allow test instrument to warm up for 20 minutes before running tests and use the following list to set up and perform USB2 tests.

1. Set up test equipment.

2. Verify that required instruments are connected to USB2 fixtures.

3. Set DUT parameters.

4. Select tests.

5. View acquisition settings.

6. Set global signal-related parameters.

7. Select test notification preferences.

8. Select report options.

9. Check the prerun checklist.

10. Click Start to Run tests.

See also

About test setups

About running tests

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.

See also

Minimum system requirements

View connected instruments

TekExpress® USB2 Printable Application Help 47

Running tests

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 USB2 application on top, select Keep On Top from the Options menu.

See also

Prerun checklist

Configuration tab parameters

Make sure that all the required instruments are properly warmed up for 20 minutes before running tests and do the following before you click the Start button to run a test:

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

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

sources):

a. In TekExpress USB2, click Setup > Configuration.

b. Click Global Settings.

c. In the Instrument 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).

See also

48 TekExpress® USB2 Printable Application Help

Instrument and DUT connection setup

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:\USB2.

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

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

TekExpress® USB2 Printable Application Help 49

Saving and recalling test setup files

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.

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:\USB2\<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:\USB2.

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

50 TekExpress® USB2 Printable Application 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 including the captured waveforms from 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 are paired with a folder of the same name. For 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® USB2 Printable Application Help 51

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.

The File Open dialog box appears.

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

52 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

About the programmatic interface

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

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

■

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

■

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

TekExpress USB2 leverages .Net Marshalling to enable the Programmatic Interface for TekExpress USB2 Client. TekExpress USB2 provides a client library for TekExpress USB2 clients to use the programmatic interface. The TekExpress USB2 client library is inherited from .Net MarshalByRef class to provide the proxy object for the clients. The TekExpress USB2 client library maintains a reference to the TekExpress USB2 Server and this reference allows the client to control the server state.

TekExpress® USB2 Printable Application Help 53

TekExpress USB2 programmatic interface

See also

Requirements for Developing TekExpress Client

To enable remote access

To access and remotely control an instrument using the TekExpress USB2 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 USB2

■

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 USB2 application.

6. On the client side, include controller.exe through which TekExpress USB2 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.

54 TekExpress® USB2 Printable Application Help

TekExpress USB2 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 USB2 applications (depending on the one for which you need to create a rule):

■

TekExpress USB2.exe

■

TekExpress.exe

NOTE. See Application directories and content for the path to the application files.

4. Click Next.

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

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

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

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

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

9. Scroll through the Inbound Rules list and verify that the list shows the rule

that you just entered.

10. Repeat steps 1 through 9 to enter the other TekExpress USB2 executable if it is missing from the list. Enter TekExpress USB2 PI as the name.

TekExpress® USB2 Printable Application Help 55

TekExpress USB2 programmatic interface

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

12. Exit the Windows Firewall tool.

To use the remote access:

1. Obtain the IP address of the instrument on which you are running TekExpress USB2.

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

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

Requirements for developing TekExpress USB2 client

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

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.

56 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

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,

//Get a reference to the remote object

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

TekExpress® USB2 Printable Application Help 57

TekExpress USB2 programmatic interface

Client proxy object

The 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

58 TekExpress® USB2 Printable Application Help

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

TekExpress® USB2 Printable Application Help 59

TekExpress USB2 programmatic interface

Process flowchart

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

2. Get the client ID that is created when connecting to the remote object. This client ID is one of the required parameters to communicate with the server.

NOTE. The server 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.

60 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

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.

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.

Handler of status change

notification

See also

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.

Program remote access code example

TekExpress® USB2 Printable Application Help 61

TekExpress USB2 programmatic interface

Program remote access code example

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

Table 15: Remote access code example

Task Code

Start the application

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

clientID = m_Client.getClientID

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

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

Get the current state information mClient.GetCurrentStateInfo(clientID,

WaitingMsbBxCaption, WaitingMsbBxMessage, WaitingMsbBxButtontexts)

Send the response mClient.SendResponse(clientID,

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

Save results 'Save all results values from folder for current

run m_Client.TransferResult(clientID, logDirname)

Unlock the server m_Client.UnlockServer(clientID)

Disconnect from server m_Client.Disconnect()

Exit the application

62 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Command list

Select Record Length ()

Command name Parameters Description Return value Example

SetGeneralParam eter

clientID device devicesuite

parameterString

Sets the data rate parameter.

String that gives the status of the operation after it was performed. The return value is "" (an empty String) on success.

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

out string clientID

Name Type Direction Description

clientid string OUT Identifier of the client

that is connected to the server clientId = unique number + ipaddress of the client. For example, 1065–192.157.98.70

string device

Name Type Direction Description

device string IN Specifies the name of

the device. For USB

2.0 testing, set the device as Device, Host or Hub.

string devicesuite

Name Type Direction Description

devicesuite string IN Specifies the name of

the USB 2.0 device suite enclosed in quotes. Valid values are

Device Connector,Host Connector and Hub Connector.

TekExpress® USB2 Printable Application Help 63

TekExpress USB2 programmatic interface

string parameterString (for record length)

Name Type Direction Description

parameterString string IN A string containing two

parameters separated by a $ symbol, enclosed in quotes. The first parameter is the Record Length. Valid value is

RecordLength

The second parameter sets the Record Length. See the following string examples:

Examples:

Example: with device set as Device and devicesuite set as Device Connector:

Given default value beside $ and the range next to it as given below:

■

String example for ' Low Speed Tests ' : "RecordLength_LSSQ$80 " (Range: 50-500)

■

String example for ' Full Speed Tests ' : "RecordLength_FSSQ$25" (Range: 20-500)

■

String example for ' High Speed Tests ' : "RecordLength_HSSQ$40 " (Range: 15-1000)

String example for other ' High Speed Tests ' :

■

"RecordLength_EL28_EL29_EL31$40" (Range:50-1000)

■

"RecordLength_EL38$50" (Range: 5-90)

■

"RecordLength_EL40$50" (Range:40-2000)

■

"RecordLength_EL27$100" (Range:40-1000)

■

"RecordLength_EL28$50" (Range:25-1000)

■

"RecordLength_EL21_EL22_EL25$50"(Range:25-1000)

■

"RecordLength_EL22$10"(Range:9-20)

■

"RecordLength_Inrush$10" (Range:1-200)

64 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Exampel: with device set as Host/Hub and devicesuite set as Host Connector/Hub Connector:

■

String example for ' Low Speed Tests ' : "RecordLength_LSSQ$80 " (Range: 50-500)

■

String example for ' Full Speed Tests ' : "RecordLength_FSSQ$25 " (Range: 20-500)

■

String example for ' High Speed Tests ' :"RecordLength_HSSQ$40" (Range: 15-1000)

String example for other ' High Speed Tests ' :

"RecordLength_EL33_EL34$5" (Range:2-100)

"RecordLength_EL35$5" (Range:2-100)

"RecordLength_EL39$50" (Range:5-90)

"RecordLength_EL41$50" (Range:40-2000)

"RecordLength_EL21_EL23_EL25$50" (Range:25-1000)

Application status()

"RecordLength_EL22$10" (Range:9-20)

"RecordLength_EL25$50" (Range:25-1000)

"RecordLength_Droop$5" (Range:2-1000)

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:

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

Return value. String value that gives the status of the server application.

TekExpress® USB2 Printable Application Help 65

TekExpress USB2 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.ApplicationStatus(clientID)

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

Related command(s).

Get Current State Info

Query status

Send response

Status

in string clientId example

clientId = <client_id_number>-<client_IP_address>.

For example, 1065–192.157.98.70

Check session saved()

CheckSavedSession(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.

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)

Related command(s).

Recall session

Save session

Save session as

66 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Connect()

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.

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.

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

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

TekExpress® USB2 Printable Application Help 67

TekExpress USB2 programmatic interface

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;

}

Related command(s).

Disconnect

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.

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

68 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

DUT automation()

Command name Parameters Description Return value Example

SetGeneralParam eter

clientID device devicesuite

parameterString

Sets the data rate parameter.

String that gives the status of the operation after it was performed. The return value is "" (an empty String) on success.

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

out string clientID

Name Type Direction Description

clientid string OUT Identifier of the client

that is connected to the server clientId = unique number + ipaddress of the client. For example, 1065–192.157.98.70

string device

Name Type Direction Description

device string IN Specifies the name of

the device. For USB

2.0 testing, set the device as Device, Host or Hub.

string devicesuite

Name Type Direction Description

devicesuite string IN Specifies the name of

the USB 2.0 device suite enclosed in quotes. Valid values are

Device Connector,Host Connector and Hub Connector.

TekExpress® USB2 Printable Application Help 69

TekExpress USB2 programmatic interface

string parameterString (for test rate)

Name Type Direction Description

parameterString string IN A string containing two

parameters separated by a $ symbol, enclosed in quotes. The first parameter is the Test mode. Valid value is DUT

paramaters

The second parameter sets the test mode. Valid value is

55.577.88.89. String example: "DUT Automation$True".

Related command(s).

Enter controller PC IP

address()

Enter controller PC IP address

Command name Parameters Description Return value Example

SetGeneralParam eter

clientID device devicesuite

parameterString

Sets the data rate parameter.

String that gives the status of the operation after it was performed. The return value is "" (an empty String) on success.

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

out string clientID

Name Type Direction Description

clientid string OUT Identifier of the client

that is connected to the server clientId = unique number + ipaddress of the client. For example, 1065–192.157.98.70

70 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

string device

Name Type Direction Description

device string IN Specifies the name of

the device. For USB

2.0 testing, set the device as Device, Host or Hub.

string devicesuite

Name Type Direction Description

devicesuite string IN Specifies the name of

the USB 2.0 device suite enclosed in quotes. Valid values are

Device Connector,Host Connector and Hub Connector.

string parameterString (for test rate)

Name Type Direction Description

parameterString string IN A string containing two

parameters separated by a $ symbol, enclosed in quotes. The first parameter is the Test mode. Valid value is Controller PC

The second parameter sets the test mode. Valid value is

55.577.88.89. String example: "Controller PC IP $23.55.78.99".

Related command(s).

DUT automation

TekExpress® USB2 Printable Application Help 71

TekExpress USB2 programmatic interface

Get current status info()

GetCurrentStatusInfo(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.

WaitingMsbBxCaption string OUT The wait state or error

state caption 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

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

Return value. This command does not return any value.

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

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

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

72 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Related command(s).

Application status

Query status

Send response

Get or set timeout value()

Command name Parameters Description Return value Example

GetTimeOut() string clientID Returns the

current timeout period set by the client

SetTimeOut() string clientID

string time

Sets a timeout period specified by the client. After this timeout period expires, the server is unlocked automatically.

String that gives the status of the operation after it was performed The default return value is 1800000.

String that gives the status of the operation after it was performed On success the return value is “TimeOut Period Changed”.

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.GetTimeOut()

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.SetTimeOut(clien tID, desiredTimeOut)

out string clientID

Name Type Direction Description

clientiD string OUT Identifier of the client

that is connected to the server clientID = unique number + IPaddress of the client. For example, 1065–192.157.98.70

string time

Name Type Direction Description

time string IN The time in seconds

that refers to the timeout period

The time parameter gives the timeout period, which is the time the client is allowed to be locked and idle. After the timeout period if the client is still idle, it gets unlocked.

TekExpress® USB2 Printable Application Help 73

TekExpress USB2 programmatic interface

The time parameter should be a positive integer; otherwise, the client is prompted to provide a valid timeout period.

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

Get pass fail status()

GetPassFailStatus(clientId, device, deviceConnector, test). This command gets the

pass or fail status of the measurement after test completion.

NOTE. Execute this command after completing the measurement.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server

device string IN Specifies the DUT type

(Host.

deviceConnector string IN string with device

connection type. Valid values are Host

Connector

test string IN Specifies the name of

the test for which to obtain the pass or fail status.

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

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

74 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Get report parameter()

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

gets the general report details such as oscilloscope model,TekExpress Firm Ware version and Application version.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server

device string IN Specifies the DUT type

(Host.

deviceConnector string IN string with device

connection type. Valid values are Host 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

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

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

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

TekExpress® USB2 Printable Application Help 75

TekExpress USB2 programmatic interface

Get results value()

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

device string IN Specifies the DUT type

(Host.

deviceConnector string IN string with device

connection type. Valid value is Host

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

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

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

Example. GetResultsValue(clientId, “Host”, “Host Connector”, test, "Value");

76 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Lock server()

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

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

Unlock server

Lock session()

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

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...”;

}

TekExpress® USB2 Printable Application Help 77

TekExpress USB2 programmatic interface

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

Unlock session

Query status()

QueryStatus (clientID, out status): This command transfers Analyze panel status messages from the server to the client.

Table 16: Parameters

Parameter Type Direction Description

clientID string IN Identifier of the client

that is connected to the server

status string array OUT The list of status

messages generated during the run

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

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)

78 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Related command(s).

Application status

Get current state Info

Send response

notification()

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

statusChangeHandler Delegate of type

TekExpressClient.Statu sChangeHandler

IN Handler

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

TekExpress® USB2 Printable Application Help 79

TekExpress USB2 programmatic interface

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

Run with set

configurations or stop the

run operation

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

}

Command name Parameters Description Return value Example

Run() string clientID Runs the selected

tests Note After the server is set up and configured, run it remotely using this function.

Stop() string clientID Stops the running

tests. Note

String that gives the status of the operation after it was performed. The return value is "Run started..." on success.

String that gives the status of the operation after it was performed The return value is "Stopped..." on success.

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.Run(clientID)

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.Stop(clientID)

80 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

out string clientID

Name Type Direction Description

clientiD string OUT Identifier of the client

that is connected to the server clientID = unique number + IPaddress of the client. For example, 1065–192.157.98.70

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

NOTE. When the session is stopped, the client is prompted to stop the session and is stopped at the consent.

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

TekExpress® USB2 Printable Application Help 81

TekExpress USB2 programmatic interface

Save, recall or query a

saved session

Command name Parameters Description Return value Example

CheckSessionSav ed()

RecallSession() string clientID

SaveSession() string clientID

SaveSessionAs() string clientID

string clientID out bool saved

string name

This method checks whether the current session is saved.

Recalls a saved session. The client provides the session name.

Saves the current session. The client provides the session name.

Saves the current session under a different name every time this method is called. The client provides the session name.

Return value is either True or False

String that gives the status of the operation after it was performed The return value is “Session Recalled...”

String that gives the status of the operation after it was performed The return value is "Session Saved..."/"Failed... "

String that gives the status of the operation after it was performed The return value is "Session Saved..."

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.CheckSessionSa ved(m_clientID, out savedStatus)

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.RecallSession(cli entID, savedSessionNam e)

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.SaveSession(clie ntID, desiredSessionNa me)

m_Client = new Client() //m_Client is a reference to the Client class in the Client DLL. returnval as string returnval=m_Clien t.SaveSessionAs(c lientID, desiredSessionNa me)

82 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

out string clientID

Name Type Direction Description

clientid string OUT Identifier of the client

that is connected to the server clientId = unique number + ipaddress of the client. For example, 1065–192.157.98.70

out bool saved

Name Type Direction Description

saved bool OUT Boolean representing

whether the current session is saved

This parameter is used as a check in SaveSession() and SaveSessionAs() functions.

string name

Name Type Direction Description

name string IN The name of the

session being recalled

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

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

If the server is locked, the application displays "Server is locked by another client."

If the session is unlocked, the application displays "Lock session to execute the command."

If the server is not found, the application displays "Server not foundDisconnect!."

If the fail condition is not one of the above types, the application displays "Failed."

TekExpress® USB2 Printable Application Help 83

TekExpress USB2 programmatic interface

Save session as()

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

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.

Select device()

Related command(s). '

Recall session

Save session

Selectdevice(clientId, device, true). This command selects the DUT type ( Host).

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is connected to the server

device string IN String with the device

DUT type. Valid value is Host .

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

Example. SelectDevice(clientId, "Host", true);

84 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Select pre-recorded

waveform files

Set pre-recorded waveform files (clientID, bset, ERRORString). This command

selects the “Use pre-recorded waveform files” control in the DUT panel of the application UI.

Parameters.

Parameter Type Direction Description

clientId string IN Identifier of the client

that is performing the remote function

bset string IN This should be “True”

or “False” based on the condition

ERRORString string IN Error message to print

if the command did not execute

Return value. 1 if pass, -1 if fail.

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

the Client DLL.

returnval as Integer = m_Client.SetPrerecorded(clientId, True, “ ”)

Where:

Select port()

clientId = clientId

bset= True

Error= ""

Comments.

Use Recall session() before using this command.

Command name Parameters Description Return value Example

SetGeneralParam eter

clientID device devicesuite

parameterString

Sets the data rate parameter.

String that gives the status of the operation after it was performed. The return value is "" (an empty String) on success.

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

TekExpress® USB2 Printable Application Help 85

TekExpress USB2 programmatic interface

out string clientID

Name Type Direction Description

clientid string OUT Identifier of the client

that is connected to the server clientId = unique number + ipaddress of the client. For example, 1065–192.157.98.70

string device

Name Type Direction Description

device string IN Specifies the name of

the device. For USB

2.0 testing, set the device asHub

string devicesuite

Name Type Direction Description

devicesuite string IN Specifies the name of

the USB 2.0 device suite enclosed in quotes. Valid value is Hub

Connector.

string parameterString (for test rate)

Name Type Direction Description

parameterString string IN A string containing two

parameters separated by a $ symbol, enclosed in quotes. The first parameter is the Ports. Valid value is

Ports

The second parameter sets the Test Method. Valid values are Tier 1,

Tire 2,Tire 3,Tire 4,Tire 5,Tire 6

String example: "Port $1".

86 TekExpress® USB2 Printable Application Help

TekExpress USB2 programmatic interface

Select probe type()

Command name Parameters Description Return value Example

SetGeneralParam eter

out string clientID

Name Type Direction Description

clientid string OUT Identifier of the client

clientID device devicesuite

parameterString

Sets the data rate parameter.

String that gives the status of the operation after it was performed. The return value is "" (an empty String) on success.

that is connected to the server clientId = unique number + ipaddress of the client. For example, 1065–192.157.98.70

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

string device

Name Type Direction Description

device string IN Specifies the name of

the device. For USB

2.0 testing, set the device as Device, Host or Hub

string devicesuite

Name Type Direction Description

devicesuite string IN Specifies the name of

the USB 2.0 device suite enclosed in quotes. Valid values are

Device Connector,Host Connector and Hub Connector.

TekExpress® USB2 Printable Application Help 87

TekExpress USB2 programmatic interface

string parameterString (for test rate)

Name Type Direction Description

parameterString string IN A string containing two

parameters separated by a $ symbol, enclosed in quotes. The first parameter is the Probe Type: DUT Signal Probing. Valid value is Probe Type:

DUT Signal Probing

The second parameter sets the Probe Type: DUT Signal Probing. Valid values are

Differential, and Single-ended.

String example: "Probe Type:DUT Signal Probing$Differential".

Get results value for sub

measurement()

GetResultsValueforsubmeasurements (clientId, device, deviceConnector, test, parameterString, rownumber). This command gets the result values of the sub

measurement after the run.

88 TekExpress® USB2 Printable Application Help

Tektronix TekExpress USB2 5 Series MSO Help User manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Table of Contents

Welcome

Getting help and support

Related documentation

Conventions used in help

Technical support

Getting started

Minimum system requirements

Supported instruments

Downloading and installing the software

Activate the license

View software version

Application directories and their contents

File name extensions

Where test files are stored

Operating basics

Launch the application

Application panels overview

Global application controls

Application controls

Options menu overview

Configure email settings

Application Panels

Setup panel

Setup controls 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

Plots panel

Reports panel

Reports panel overview

Select report options

View a report

Report contents

Running tests

Test process flow

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 USB2 programmatic interface

About the programmatic interface

To enable remote access

Requirements for developing TekExpress USB2 client

Remote proxy object

Client proxy object

Client programmatic interface example

Program remote access code example

Command list

Select Record Length ()

Application status()

Check session saved()

Connect()

Disconnect()

DUT automation()

Get current status info()

Get or set timeout value()

Get pass fail status()

Get report parameter()

Get results value()

Lock server()

Lock session()

Query status()

Save session as()