Tektronix TekExpress USB2 5 Series MSO Help User manual

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.

Table of Contents

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

Related documentation

The following documents are available as part of the TekExpress® USB2 Automated Test and Compliance Solution application.
Table 1: Product documentation
Item Purpose Location
Application Help Application operation and User
PDF of the help Printable version of the
Interface help
Press F1 on the oscilloscope keyboard to open Application Help.
compiled help
See also
PDF file that ships with TekExpress USB2 application (TekExpress USB2.pdf).
Technical support
TekExpress® USB2 Printable Application Help 1
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
Loading...
+ 132 hidden pages