Tektronix TekExpress USB2 Automated Test Solution Help User manual
TekExpress® USB2
Automated Test Solution
Printable Application Help
*P077102102*
077-1021-02
TekExpress® USB2
Automated Test Solution
Printable Application Help
Supports TekExpress USB2 Product Firmware V1.0 and above
www.tek.com
077-1021-02
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 .............................................................................................................................................. 7
Getting help and support
Related documentation ................................................................................................................... 1
Conventions used in help ................................................................................................................ 2
Technical support ........................................................................................................................... 2
Getting started
Installing the software .................................................................................................................... 5
Minimum system requirements ................................................................................................. 5
Required windows 7 user account setting ................................................................................. 6
Required windows 10 user account settings .............................................................................. 6
Downloading and installing the software .................................................................................. 7
Supported instruments ............................................................................................................... 8
Verify application installation ................................................................................................... 9
Activate the license ................................................................................................................... 9
View software version ............................................................................................................... 9
Required my TekExpress folder settings ................................................................................. 10
Set the my TekExpress folder permissions ............................................................................. 10
Application directories and their contents ............................................................................... 11
File name extensions ............................................................................................................... 12
Where test files are stored ....................................................................................................... 12
Operating basics
Launch the application .................................................................................................................. 13
Exit the application ....................................................................................................................... 14
Application controls ..................................................................................................................... 15
Options menu ................................................................................................................................ 17
Options menu overview ........................................................................................................... 17
Instrument control settings ...................................................................................................... 18
View connected instruments ................................................................................................... 19
Email settings .......................................................................................................................... 20
Configure email settings .......................................................................................................... 21
Application panels overview
TekExpress® USB2 Printable Application Help i
Table of Contents
Application Panels
Setup tab ....................................................................................................................................... 25
Setup controls overview .......................................................................................................... 25
Set DUT parameters ................................................................................................................ 26
Select tests ............................................................................................................................... 28
Set acquisition parameters ....................................................................................................... 29
Running tests on prerecorded (saved) waveforms .................................................................. 31
Configuration tab parameters .................................................................................................. 32
Configuration tab: global settings and measurement parameters ............................................ 32
Preferences tab ........................................................................................................................ 36
Status panel overview ................................................................................................................... 37
Results panel ................................................................................................................................. 39
Results panel overview ............................................................................................................ 39
Preferences menu .................................................................................................................... 40
View test-related files .............................................................................................................. 40
Plots panel ..................................................................................................................................... 41
Reports panel ................................................................................................................................ 43
Reports panel overview ........................................................................................................... 43
Select report options ................................................................................................................ 44
View a report ........................................................................................................................... 46
Report contents ........................................................................................................................ 46
Running tests
Test process flow .......................................................................................................................... 49
Instrument and DUT connection setup ......................................................................................... 49
Running tests ................................................................................................................................ 50
Prerun checklist ............................................................................................................................ 50
Saving and recalling test setup files
Test setup files overview .............................................................................................................. 51
Save a test setup file ..................................................................................................................... 51
Open (load) a saved test setup file ................................................................................................ 52
Run a saved test in prerecorded mode .......................................................................................... 53
Create a new test setup file based on an existing one ................................................................... 54
ii TekExpress® USB2 Printable Application Help
TekExpress USB2 programmatic interface
About the programmatic interface ................................................................................................ 55
To enable remote access ............................................................................................................... 56
Requirements for developing TekExpress USB2 client ............................................................... 58
Remote proxy object ..................................................................................................................... 59
Client proxy object ....................................................................................................................... 60
Client programmatic interface example ....................................................................................... 61
Program remote access code example .......................................................................................... 64
Command list ................................................................................................................................ 65
Select Record Length () ........................................................................................................... 65
Application status() ................................................................................................................. 67
Check session saved() ............................................................................................................. 68
Connect() ................................................................................................................................. 69
Disconnect() ............................................................................................................................ 70
DUT automation() ................................................................................................................... 71
Enter controller PC IP address() .............................................................................................. 72
Get current status info() ........................................................................................................... 74
Get or set timeout value() ........................................................................................................ 75
Get pass fail status() ................................................................................................................ 76
Get report parameter() ............................................................................................................. 77
Get results value() ................................................................................................................... 78
Lock server() ........................................................................................................................... 79
Lock session() .......................................................................................................................... 79
Query status() ......................................................................................................................... 80
Register status change notification() ....................................................................................... 81
Run with set configurations or stop the run operation ............................................................ 82
Save, recall or query a saved session ...................................................................................... 84
Save session as() ...................................................................................................................... 86
Select device() ......................................................................................................................... 86
Select pre-recorded waveform files ......................................................................................... 87
Select port() ............................................................................................................................. 87
Select probe type() ................................................................................................................... 89
Get results value for sub measurement() ................................................................................. 90
Select power condition() ......................................................................................................... 92
Select qualifier() ...................................................................................................................... 93
Select single test() ................................................................................................................... 95
Select suite() ............................................................................................................................ 97
Select test method() ................................................................................................................. 97
Table of Contents
TekExpress® USB2 Printable Application Help iii
Table of Contents
Select test mode() .................................................................................................................... 99
Select test point:Near End() .................................................................................................. 100
Select test point:Far End ........................................................................................................ 102
Select Tier() ........................................................................................................................... 103
Send response() ..................................................................................................................... 105
Select versions() .................................................................................................................... 106
Set or get the DUT ID ........................................................................................................... 108
Set instrument() ..................................................................................................................... 109
Set verbose mode() ................................................................................................................ 110
Status() ................................................................................................................................... 111
Transfer images() .................................................................................................................. 111
Transfer result() ..................................................................................................................... 113
Transfer waveforms() ............................................................................................................ 113
Unlock server() ...................................................................................................................... 114
Unlock session() .................................................................................................................... 114
SCPI commands
About SCPI command ................................................................................................................ 115
Socket configuration for SCPI commands ................................................................................. 115
TEKEXP:*IDN? ......................................................................................................................... 123
TEKEXP:*OPC? ........................................................................................................................ 123
TEKEXP:ACQUIRE_MODE .................................................................................................... 124
TEKEXP:ACQUIRE_MODE? .................................................................................................. 124
TEKEXP:EXPORT .................................................................................................................... 125
TEKEXP:INFO? ......................................................................................................................... 125
TEKEXP:INSTRUMENT .......................................................................................................... 126
TEKEXP:INSTRUMENT? ........................................................................................................ 126
TEKEXP:LASTERROR? ........................................................................................................... 127
TEKEXP:LIST? .......................................................................................................................... 127
TEKEXP:MODE ........................................................................................................................ 128
TEKEXP:MODE? ...................................................................................................................... 129
TEKEXP:POPUP ....................................................................................................................... 129
TEKEXP:POPUP? ...................................................................................................................... 130
TEKEXP:REPORT .................................................................................................................... 130
TEKEXP:REPORT? ................................................................................................................... 131
TEKEXP:RESULT? ................................................................................................................... 131
TEKEXP:SELECT ..................................................................................................................... 132
TEKEXP:SELECT? ................................................................................................................... 133
TEKEXP:SETUP ........................................................................................................................ 133
iv TekExpress® USB2 Printable Application Help
Table of Contents
TEKEXP:STATE ....................................................................................................................... 134
TEKEXP:STATE? ...................................................................................................................... 134
TEKEXP:VALUE ...................................................................................................................... 135
TEKEXP:VALUE? .................................................................................................................... 136
Command parameters list ........................................................................................................... 137
Examples ................................................................................................................................... 143
Reference
Handle error codes ...................................................................................................................... 145
HSETT controller ....................................................................................................................... 146
Setting up controller PC for automated DUT test mode ....................................................... 146
Signal validation ......................................................................................................................... 146
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
■
Comprehensive signal validation check
■
Automated DUT test mode control
■
USB-IF Signal Quality measurements integrated with TekExpress USB2
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
Installing the software
Minimum system
requirements
The following table shows the minimum system requirements needed for an
oscilloscope to run TekExpress USB2.
Table 3: TekExpress USB2 system requirements
Component Requirement
Oscilloscope See Supported instruments
Processor Same as the oscilloscope
Operating System Same as the oscilloscope:
■
Windows 7 (64-bit only) SP1 Windows
7 user account settings
■
Windows 10 (64-bit only) SP1 Windows
10 user account settings
Memory Same as the oscilloscope
Hard Disk Same as the oscilloscope
Display Super VGA resolution or higher video adapter
(800 x 600 minimum video resolution for small
fonts or 1024 x 768 minimum video resolution
for large fonts). The application is best viewed at
96 dpi display settings
Firmware TekScope 10.3.0 or later for:
1
■
Tektronix DPO/DSA/MSO70000C, D, DX,
and SX series oscilloscopes
■
Tektronix DPO7000C series oscilloscopes
■
Tektronix MSO/DPO5000 and MSO/
DPO5000B series oscilloscopes
Software
1
If TekExpress USB2 is running on an instrument that has a video resolution less than 800x600, connect and configure a second monitor to the
instrument.
■
Microsoft Internet Explorer 7.0 SP1 or later,
or other Web browser for viewing reports.
■
Adobe Reader software 7.0 or later for
viewing portable document format (PDF)
files.
TekExpress® USB2 Printable Application Help 5
Getting started
Required windows 7 user
account setting
Windows 7 instruments need to have the User Account Control Settings set to
Never Notify. To set User Account Control Settings:
1. Go to Control Panel > User Accounts > Change User Account Control
settings.
2. Set the sliding control to Never Notify as shown in the image, and click OK.
Required windows 10 user
account settings
See also.
Supported oscilloscopes
Windows 10 instruments need to have the User Account Control Settings set to
Never Notify. To set User Account Control Settings:
1. Go to Control Panel > User Accounts > Change User Account Control
settings.
2. Set the sliding control to Always notify as shown in the image, and click
OK.
6 TekExpress® USB2 Printable Application Help
See also.
Getting started
Downloading and
installing the software
Supported oscilloscopes
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.
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 Analyze > TekExpress USB2 from the TekScope menu to launch the
application.
TekExpress® USB2 Printable Application Help 7
Getting started
See also.
Minimum system requirements
Supported instruments
Supported instruments
Table 4: Required equipment
Resource Model supported
Real-time oscilloscope Tektronix DPO/DSA/MSO70000C, D, DX, and
SX series oscilloscopes
Tektronix DPO7000C series oscilloscopes
Tektronix MSO/DPO5000 and MSO/DPO5000B
series oscilloscopes
Probes Two TCA-SMA adapters if using DPO/DSA/
MSO70000
TCP0030A or TCP202/A probe
TDP1500, TDP3500, or P6248 differential probe
TAP1500 or P6245 single-ended probe
Host test fixtures USB2SIGQUAL fixture set (USB-IF host/device
Device test fixtures USB2SIGQUAL fixture set (USB-IF host/device
Tektronix AWG instruments AWG70001A, AWG70002A
2
SQ)
USB2/3_DD fixture (USB-IF Droop-Droop
fixture)
TDSUSBF (Tek fixture)
2
SQ)
USB2/3_DD fixture (USB-IF Droop-Droop
fixture)
TDSUSBF (Tek fixture)
AWG7102, AWG7122B
AWG7122C
AWG5014B, AWG5014C, AWG5012C,
AWG5002C, AWG5200A
See also.
Minimum system requirements
2
Available through USB-IF.
8 TekExpress® USB2 Printable Application Help
Getting started
Verify application
installation
Activate the license
To verify the installation was successful:
1. Open the TekScope application.
2. Click the Analyze menu.
3. Verify that TekExpress USB2 is listed in the Analyze menu.
4. Click TekExpress USB2 to open the application. Verify that the application
opens successfully.
See also.
Activate the license
Required \My TekExpress folder settings
Activate the license using the Option Installation wizard in the TekScope
application:
1. In the TekScope application menu bar, click Utilities > Option Installation.
TheTekScope Option Installation wizard opens.
2. Push the F1 key on the oscilloscope keyboard to open the Option Installation
help topic.
View software version
3. Follow the directions in the help topic to activate the license.
See also.
View version and license information
Required \My TekExpress folder settings
Use the following instructions to view version information for the application and
for the application modules such as the Programmatic Interface and the
Programmatic Interface Client.
To view version information for TekExpress USB2, click the Options button and
select About TekExpress.
To view license and option key information in the TekScope applicaion:
1. In the TekScope application, select Help > About TekScope.
The Options dialog box is displayed.
2. Scroll through the Options list to locate USB2: TekExpress USB2.
3. To view the Option installation key value, look below the Options list.
See also.
Activate the license
Options menu
TekExpress® USB2 Printable Application Help 9
Getting started
Required my TekExpress
folder settings
Set the my TekExpress
folder permissions
Before you run tests for the first time, you need to Set the \My TekExpress folder
permissions.
See also.
Application directories and usage
File name extensions
Make sure that the My TekExpress folder has read and write access. Also verify
that the folder is not set to be encrypted:
1. Right-click the folder and select Properties.
2. Select the General tab and then click Advanced.
3. In the Advanced Attributes dialog box, make sure that the option Encrypt
contents to secure data is NOT selected.
4. Click the Security tab and verify that the correct read and write permissions
are set.
See also.
Application directories and usage
File name extensions
10 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
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
See also.
View test-related files
File name extensions
TekExpress® USB2 Printable Application Help 11
Getting started
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
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.
Set the \My TekExpress folder permissions
Application directories and usage
File name extensions
12 TekExpress® USB2 Printable Application Help
Operating basics
Launch the application
To launch the TekExpress USB2 application, select Analyze > TekExpress
USB2 from the TekScope menu.
The oscilloscope opens the TekExpress USB2 application:
When you first run the application after installation, the application checks for
Resources.xml located in the C:\Users\<username>\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.
NOTE. Do the steps in the Required\My TekExpress folder settings topic before
running tests with the TekExpress USB2 application for the first time.
TekExpress® USB2 Printable Application Help 13
Operating basics
To keep the TekExpress USB2 application window on top, select Keep On Top
from the Options menu. If the application goes behind the oscilloscope
application, click Analyze > TekExpress USB2 to move the application to be in
front.
See also
Exit the application
Required My TekExpress folder settings
Activate the license
Exit the application
Application controls
Application panel overview
To exit the application, click on the application title bar. Follow on-screen
prompts to save any unsaved session, save test setup files, or exit the application.
NOTE. Using other methods to exit the application can result in abnormal
termination of the application.
14 TekExpress® USB2 Printable Application Help
Operating basics
Application controls
Table 6: Application controls descriptions
Item Description
Options menu
Test Panel buttons
Menu to display global application controls.
Controls that open panels for configuring test settings and options.
Start / Stop button
Use the Start button to start the test run of the measurements in the selected order. If prior
acquired measurements have not been cleared, the new measurements are added to the
existing set.
The button toggles to the Stop mode while tests are running. Use the Stop button to abort
the test.
TekExpress® USB2 Printable Application Help 15
Operating basics
Item Description
Pause / Continue button
Clear button
Application window move icon
Use the Pause button to temporarily interrupt the current acquisition. When a test is
paused, the button name changes to “Continue.”
Use the Clear button to clear all existing measurement results. Adding or deleting a
measurement, or changing a configuration parameter of an existing measurement, also
clears measurements. This is to prevent the accumulation of measurement statistics or sets
of statistics that are not coherent. This button is available only on the Results panel.
Place the cursor over the three-dot pattern in the upper left corner of the application
window. When the cursor changes to a hand, drag the window to the desired location.
Minimize button
Minimizes the application.
16 TekExpress® USB2 Printable Application Help
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.
See also
Options menu
Options menu overview
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
TekExpress® USB2 Printable Application Help 17
Operating basics
Menu Function
Email Settings Use to configure email options for test run and
results notifications
Help Displays the TekExpress USB2 help
About TekExpress
■
Displays application details such as
software name, version number, and
copyright
■
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.
18 TekExpress® USB2 Printable Application Help
Loading...