Tektronix TekExpress USB Online Help
xx
TekExpress USB
ZZZ
Automated Solutions
Online Help
*P077035001*
077-0350-01
TekExpress USB
Automated Solutions
ZZZ
Online Help
www.tektronix.com
077-0350-01
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.
TekExpress is a registered trademark of Tektronix, Inc.
TekExpress USB Automated Solutions Online help, 076-0196-01.
Contacting Tektronix
Tektroni
14200 SW Karl Braun Drive
P. O . Box 5 00
Beaverton, OR 97077
USA
x, Inc.
For pro
duct information, sales, service, and technical support:
In North America, call 1-800-833-9200.
Worldwide, visit www.tektronix.com to find contacts in your area.
Table of Contents
General Safety Summary ......................................................................................... iii
Introduction
Using Online Help..................... ................................ ................................ ............. 1
Related Documentation ............. ................................ ................................ ............... 1
Conventions .............................. ................................ .................................. ......... 2
Techn i c a
Getting Started
What is new in this release ........................................................................................ 5
Accessories................... .................................. ................................ ..................... 5
Minimum System Requirements..................... ................................ ............................. 6
Application Directories and Usage .................................... ................................ ........... 6
File Name Extensions.............................................................................................. 8
How To Activate the License......................................... ................................ ............. 8
Before You Click Run............................................................................................. 10
l Support ............................... .................................. ................................ . 3
Table of Contents
Operating Basics
TekExpress Application Overview .............................................................................. 13
Starting the Application..................... .................................. ................................ .... 14
Resizing the Application Window ............... .................................. .............................. 14
Exiting the Application . . .. . .. .. . .. .. . .. .. ... ... .. . .. . .. . .. . .. .. . .. . .. . .. . .. ... ... .. . .. . .. . .. . .. .. . .. . .. . .. . .. ... . 15
Global Controls ............ ................................ .................................. ...................... 15
Menus
File Menu.................... ................................ .................................. ................ 16
View Menu ............ ................................ ................................ ........................ 17
Tools Menu .................................................................................................... 17
Help Menu..................................................................................................... 19
How To
Deskew Real Time Oscilloscopes .. . .. . .. . .. ... .. . .. . .. . .. . .. . .. ... ... .. . .. . .. . .. . .. ... ... .. . .. . .. . .. . .. ... ... .. 21
Select the Test(s)................... ................................ .................................. .............. 22
Configure and Run the Test(s)........................................ ................................ ............ 24
View and Select Connected Instruments ...................... ................................ .................. 28
Use the Prerecorded Waveform for Analysis................................................................... 30
View the Progress of Analysis ..... ................................ ................................ .............. 32
View the Report.................................................................................................... 34
View Test Related Files................... ................................ ................................ ........ 35
Use Filters . . .. .. . .. . .. . .. ... .. . .. . .. ... .. . .. . .. . .. .. . .. . .. . .. . .. .. . .. . .. . .. . .. .. . .. . .. . .. ... .. . .. . .. ... .. . .. . .. . .. .. 36
TekExpress USB Automated Solutions Help i
Table of Contents
Using the Nonstandard Filter .. . .. . .. .. . .. . .. ... .. . .. . .. . .. .. . .. . .. . .. . .. .. . .. . .. ... .. . .. . .. . .. .. . .. . .. . .. . .. 36
Using the Nonstandard Waveform Mask........................................... ........................ 37
Application Examples
Testing a Device Transmitter Using DPOJET Application
Set Up the Equipment ........................................................................................ 39
Testing Deterministic Jitter on a Device Front Panel . .. . .. . .. ... ... .. . .. . .. . .. . .. .. . .. . .. . .. . .. ... ... .. . . 40
TekExpress Programmatic Interface
About the Programmatic Interface............................................................................... 45
Server and Client Proxy Objects ................................................................................. 47
Remote Proxy Object............................. ................................ ............................ 47
Client Proxy Object..... .................................. ................................ .................... 48
Programmatic Interface APIs
Connect() ...................................................................................................... 49
Disconnect()................................................................................................... 51
LockSession() ..... .................................. ................................ .......................... 52
UnlockSession() .............................................................................................. 53
SetTimeOut()................................ ................................ ................................ .. 54
GetTimeOut() ................................................................................................. 55
GetDutId() ..................................................................................................... 56
ChangeDutId() ................................................................................................ 57
SaveSession() ................................................................................................. 58
SaveSessionAs() ........ ................................ .................................. .................... 59
RecallSession()................................................................................................ 60
Run() ..... .................................. ................................ ................................ .... 61
Stop()........................................................................................................... 62
QueryStatus().................................................................................................. 63
TransferReport() .............................................................................................. 64
CheckSessionSaved() .............................. ................................ .......................... 65
ApplicationStatus() ......... .................................. ................................ ................ 66
ErrorCodes ......................................................................................................... 67
Example ............................................................................................................ 67
Troubleshooting
Instrument Connectivity .......................................................................................... 69
TestStand Run time Engine Installation....................................... .................................. 69
Reference
Shortcut Keys .................. .................................. ................................ .................. 71
Index
ii TekExpress USB Automated Solutions Help
General Safety Summary
Review the following safety precautions to avoid injury and prevent damage to this product or any
products connected to it.
To avoid potential hazards, use this product only as specified.
Only qualified personnel should perform service procedures.
While using this product, you may need t o access other parts of a larger system. Read the safety sections
of the other component manuals for warnings and cautions related to operating the system.
To Avoid Fire or Personal Injury
Connect and disconnect properly. Connect the probe output to the measurement instrument before
connecting the probe to the circuit under test. Connect the probe reference lead to the circuit under test
before c
under test before disconnecting the probe from the measurement instrument.
onnecting the probe input. Disconnect the probe input and the probe reference lead from the circuit
General Safety Summary
Observ
Consult the product manual for further ratings information before making connections to the product.
Do not
Do not operate with sus p ected failures. If you suspect that there is damage to this product, have it inspected
by qu
Avoid exposed circuitry. Do not touch exposed connections and components when power is present.
e all terminal ratings. To av o i d fire or shock hazard, observe all ratings and markings on the product.
operate without covers. Do not operate this product with covers or panels removed.
alified service personnel.
Terms in This Manual
ese terms may appear in this manual:
Th
WARNING. Warning statements identify conditions or practices that could result in injury or loss of life.
CAUTION. Caution statements identify conditions or practices that could result in damage to this product
or other
property.
TekExpress USB Automated Solutions Help iii
General Safety Summary
iv TekExpress USB Automated Solutions Help
Introduction Using Online Help
Using Online Help
Select Help from the menu to open the help file. You can also find an electronic copy of the help file in the
Documents directory on the 063-4068-XX DVD.
Tables of Contents (TOC) tab — Organizes the Help into book-like sections. Select a book icon to open
a section; select any of the topics listed under the book.
Index tab — Enables you to scroll a list of alphabetical keywords. Select the topic of interest to bring
up the appropriate help page.
Search tab — Allows a text-based search.
Follow these steps:
1. Type the word or phrase you want to find in the search box. If the word or phrase is not found, try the
Index tab.
2. Choose a topic in the lower box, and then select the Display button.
General Help Functions
Select the Print button from the Help topics menu bar to print a topic.
To return to the previous window, select the Back button.
Use hyperlinks to jump from one topic to another.
ebackbuttonisgrayedoutorajumpisnotavailable,choosetheHelpTopicsbuttontoreturnto
If th
the originating help folder.
ated Documentation
Rel
addition to TekExpress USB Online Help, the following documentation is included with the software:
In
DPOJET SuperSpeed (USB 3.0) Setup Library Methods of Implementation (MOI) for Verification,
ebug and Characterization, Tektronix part number 077-0266-xx.
D
TekExpress USB Online Help (PDF version), Tektronix part number 077-0350-xx.
TekExpress USB Automated Solutions Help 1
Introduction Conventions
Conventions
The 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 mechanical methods of choosing an option:
using a mouse or using the touch screen.
Table 1: Ico
Icon Meaning
xxx
n descriptions
This icon i
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.
dentifies important information.
2 TekExpress USB Automated Solutions Help
Introduction Technical Support
Technical Support
Tektronix values your feedback on our products. To help us serve you better, please send us your
suggestions, ideas, or comments on your application or oscilloscope.
When you contact Tektronix Technical Support, please include the following information (be as specificas
possible):
General Information
All instru
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.
ment model numbers.
Application Specific Information
Software version number.
Description of the problem such that technical support can duplicate the problem.
If possible, save the setup files for all the instruments used and the application.
ssible, save the application setup files, log.xml and status messages text file.
If po
If possible, save the waveform on which you are performing the measurement as a .wfm file.
Forward the information to technical support using one of these methods:
E-mail – techsupport@tektronix.com
FAX – (503) 627-5695
TekExpress USB Automated Solutions Help 3
Introduction Technical Support
4 TekExpress USB Automated Solutions Help
Getting Started What is new in this release
What is new in this release
This version of TekExpress USB provides the following feature enhancements:
The USB transmitter solution support test automation in the TekExpress framework providing
customers with a complete solution for USB 3.0 verification, characterization, debug, and compliance.
Accessories
About the Test Fixture
For Host Testing. TF-USB3-A-P (for best signal quality) or for more mechanical flexibility use
TF-USB-B-R (with included 13 cm USB 3.0 Cable - Part n umber 174-5772-00). For precision De-Embed
of TF-USB3-A plug fixture, order TF-USB3-AB-KIT (includes Cal Kit).
For Device Testing. TF-USB3-A-R (includes short USB 3.0 Cable).
Supported Probes
llowing probes support TekExpress USB application:
The fo
P7313 SMA differential probe
P7500 Tri-Mode probe
TekExpress USB Automated Solutions Help 5
Getting Started Minimum System Requirements
Minimum System Requirements
The minimum system requirements for a PC to run the application are as follows:
Table 2: System requirements
Processor
Pentium 4/M or equivalent processor.
Operating System Windows XP Service Pack 2.
Memory
Hard Disk
512 MB of memory.
Approximately 2 GB of available hard-disk space for the recommended
installation, which includes full TekExpress installation and distributed
components.
Drive DVD drive
Display
Super VGA resolution or higher video adapter (800x600 minimum video
resolution for small fonts or 1024x768 minimum video resolution for large fonts).
The application is best viewed at 96 dpi display settings
1
.
Software TekExpress Framework (v1.3.4 or later) installed.
DPOJET Jitter and Eye Analysis Tool (v2.5.0.7 or later) with Advanced Jitter
and Eye analysis (DJA option) installed.
SDLA software for Channel De-Embed for custom filter development
(optional).
Microsoft Internet Explorer 6.0 SP1 or later.
Adobe Reader 6.0 or equivalent software for viewing portable document
format (PDF) files.
Other Devices Microsoft compatible mouse or compatible pointing device.
Four USB ports (2 USB ports minimum).
PCI-GPIB or equivalent interface for instrument connectivity2.
xxx
1
If TekExpress is running o n an instrument that has a video resolution lower than 800x600 (for example, sampling oscilloscope), it is recommended
to connect a secondary monitor and this has to be enabled before launching the application.
2
If TekExpress is installed on a Tektronix oscilloscope, the virtual GPIB port cannot be used by Tek
applications.
If external devices like USB-GPIB or equivalent are used for instrument connectivity, ensure that the Talker Listener utility is enabled in the
DPO/DSA oscilloscope’s GPIB menu.
Application Directories and Usage
Express for communicating with oscilloscope
Related Topics
File Name Extensions
How To Activate the License
View Test Related Files
The complete path of the directory structure is C:\Program Files\Tektronix\TekExpress\Tek-
Express USB
.
6 TekExpress USB Automated Solutions Help
Getting Started Application Directories and Usage
The application directory and associated files are organized as follows:
The following table lists the default directory names and their usage:
Table 3: Default directory names and their usage
Directory names Usage
InstallDir\TekExpress Contains the TekExpress application and associated
files.
\TekExpress\TekExpress USB Contains files specific to TekExpress USB.
\TekExpress USB\Compliance Suites Contains compliance specific sequence files. The
folders under this directory represent the devices
to be tested.
\TekExpress USB\Compliance Suites\USB Includes the Device and Host Transmitter folders.
\TekExpress USB\Compliance Suites\USB\Device Includes the “Device Connector” folder.
\TekExpress USB\Compliance Suites\USB\Device\Device
Connector
\TekExpress USB\Compliance Suites\USB\Host Includes the “Host Connector” folder.
Contains application specific files for Device.
TekExpress USB Automated Solutions Help 7
Getting Started File Name Extensions
Table 3: Default directory names and their usage (cont.)
Directory names Usage
\TekExpress USB\Compliance Suites\USB\Host\Host Connector Contains application specific files for Host.
\TekExpress USB\ACP
\TekExpress USB\SCP
\TekExpress USB\ICP
\TekExpress USB \Data Manager
\TekExpress USB \Data Storage
\TekExpress USB\Report Generator
\TekExpress USB\Documents Includes the Method of Implementation documents
\TekExpress USB\Bin
\TekExpress USB\Lib
\TekExpress USB\Tools
xxx
File Name Extensions
Includes instrument and application specific
interface libraries of TekExpress.
Includes the result management specific libraries of
TekExpress are present in these folders.
and technical documentation for the application.
Includes the miscellaneous libraries of TekExpress.
Related Topics
Application Directories and Usage
How To Activate the License
The software uses the following file name extensions:
File name extension Description
.TekX
.seq
.xml
The session file will be saved in this format.
The test sequence file.
The encrypted XML file that contains the test specificconfiguration information. The
log file extension is also xml.
.mht
.PDF
.msk
This file details the test report.
The PDF file that details the method of implementation for the test.
The mas k file.
.fltThefilter file.
.html
xxx
The htm l file.
How To Activate the License
Follow the steps below to activate the license:
NOTE. Ensure that your TekExpress USB dongle is installed on your host system.
Related Topics
Application Directories and Usage
File Name Extensions
1. Click Help > About to view the license information.
8 TekExpress USB Automated Solutions Help
Getting Started How To Activate the License
2. Click the View Version Details link to check the version numbers of the installed test suites.
3. Click the View End-User License Agreement link to open the following Tektronix Software License
Agreement window. Click Print to print the License Agreement.
4. Click License Info to view the available s oftware options. This window shows the license key and the
various options with their status (active or inactive) with the current license key.
TekExpress USB Automated Solutions Help 9
Getting Started Before You Click Run
5. If you are activating the license for the first time, the license key field will be empty. To activate the
license, connect the USB dongle to your computer, enter the license key provided in the license
key certificate, and click Activate. If the activation is successful, a
the license key field.
6. If you ar
e reactivating the license, click Reactivate, enter the new license key and click Activate.
Before You Click Run
sign is displayed next to
After you first launch TekExpress, it creates the following folders on your computer:
\My Documents\My TekExpress
NOTE. Ensure that the “My TekExpress” folder has read and write access.
NOTE. If a user with a different Windows login ID launches TekExpress, a new
created under that user’s
\My Documents\My TekExpress\USB.
\My Documents\My TekExpress\USB\Untitled Sessio n. Every time the USB.exe is
launched an
is deleted when you exit TekExpress.
AUTION. Each session has multiple files associated with it. Do not modify any of the session files and/or
C
folders as this may result in loss of data or corrupted session files.
Untitled Session folder is created under USB folder. The Untitled Session folder
My Documents
folder
My TekExpress
folder is
10 TekExpress USB Automated Solutions Help
Getting Started Before You Click Run
The My TekExpress folder is created as a shared folder with share name as <domain><user
ID> My TekExpress
name><user ID
(or if the PC is not connected to domain then share name is <Computer
> My TekExpress
).
The above shared folder is mapped as X: (X drive) on to the PC where TekExpress is running.
NOTE. If X dri
ve is mapped to any other shared folder, TekExpress will display a warning message window
asking you to disconnect the X: drive manually.
Do the foll
owing before you click Run:
NOTE. Ensure that the network connectivity is enabled on the PC running the TekExpress.
ared
1. Map the sh
My TekExpress folder as X: (X drive) on all the instruments used in test setup
running Microsoft Windows Operating System. This share folder is used to save the waveform files
or any other file transfer operations.
2. Rightclickonthe
My TekExpress folderandopentheProperties dialog box. Select General tab
and then Advanced.IntheAdvanced Attributes window, ensure that the option Encrypt contents
to secure data is NOT selected. Click h
3. Ensure that all the required instruments are properly warmed up, and that S
ere to view the picture.
ignal Path Compen satio n
(SPC) is performed.
Mapping My TekExpress folder
To map the My TekExpress folder on the instruments, follow the steps below:
1. Open Windows Explorer.
2. From the Windows Explorer menu, select To o ls > Ma p N e tw o rk d r ive .
3. Select the Drive letter as X: (if there is any previous connection on X:, disconnect it first through
Tools > Disconnect Network drive menu of Windows Explorer).
4. In the Folder field, enter remote
My TekExpress folder path (for example, \\192.158.97.65\My
TekExpress)
5. You can determine the IP address of the PC where “My TekExpress” folder exists by doing
the following:
Select Start > Run menu on the PC where My TekExpress folder exists.
Enter cmd and click Enter.
At command prompt, type ipconfig.
TekExpress USB Automated Solutions Help 11
Getting Started Before You Click Run
You c a n
1. On the oscilloscope main menu, click Utilities menu.
2. Click Instrument Calibration option.
find SPC by following the steps below:
12 TekExpress USB Automated Solutions Help
Operating Basics TekExpress Application Overview
TekExpress Application Overview
TekExpress is the Tektronix Compliance Test Automation Framework, developed to support current and
future test automation needs of customers. Developed using National Instruments’ TestStand, TekExpress
leverages on
deploying automated test solutions for various serial standards in a relatively short time.
the capabilities of Microsoft .NET framework. It is a highly modular architecture that enables
The TekExpr
DPOJET Timing and Analysis tool. With TekExpress USB, Tektronix provides Fully-Automated Tx
solution for verification, characterization, and debug.
ess U SB application (Opt. USB-TX) is the automated version of USB3.0 measurements from
Key Features
The following are the key features of TekExpress USB application:
Comprehensive test coverage
Precise debugging and troubleshooting
Accura
te and reliable results
TekExpress USB Automated Solutions Help 13
Operating Basics Starting the Application
Related Topics
Starting the Application
Resizing the Application Window
Exiting the Application
To start the application, you can do one of the following:
Click Start > Programs > Tektronix > TekExpress > TekExpress USB. Other applications follow
similar pattern.
Double click the icon on the desktop.
If you have previously save d a session, you can double-click the session file stored under My
TekExpress\USB
.
When the application is launched it displays the splash screen providing launch information. The
application also checks for the presence and validity of the USB dongle.
NOTE. If the application was not terminated properly during the last use, a dialog box prompts to recall
the previously unsaved session.
Related Topics
Resizing the Application Window
Starting the Application
Exiting the Application
To minimize the application, click on the application title bar. To restore the application to its
previous size, select
in the Windows task bar.
To maximize the application, click . To restore it to previous size, click on the application
title bar.
14 TekExpress USB Automated Solutions Help
Operating Basics Exiting the Application
Related Topics
Exiting the Application
Starting the Application
Resizing the Application Window
To exit the application, do one of the following:
Click File > Exit.
Click on the application title bar.
Global Controls
The menus and controls that appear outside the individual tabs are called “Global Controls”. These are
used to specify the devices to be tested.
Table 4: Contro
Control name Function
DUT ID
xxx
ls and Functions
The device ID is specified at the global level and the
information is stored in the default location for all data
files. This fie
special characters (.,..,...,\,/:?”<>|*). The maximum length
of characters allowed is 32.
You will be able to run, pause, resume and stop the tests.
ld cannot be empty and does not allow these
TekExpress USB Automated Solutions Help 15
Operating Basics File Menu
Related Topics
File Menu
View Menu
Tools Menu
Help Menu
Click File on the application menu bar.
The File menu has the following selections:
Menu Function
New Session Starts a default session of TekExpress.
Open Session Opens a saved session.
Save Session Saves the session.
Save Session As Saves a session in a different name.
Recently Recalled Setup Lists all the recent and previously recalled setup files.
Save Report As Saves the report in user specified location.
Print Preview Report
Print Report
Exit
Previews the report before printing.
Opens the Windows “Print” dialog box.
Closes the application.
16 TekExpress USB Automated Solutions Help
Operating Basics View Menu
xxx
View Menu
Click View on the application menu bar.
The View menu has the following selections:
Menu Function
Log
xxx
Tools Menu
Related Topic
File Menu
Tools Menu
Help Menu
s
Opens the log (log.xml) file in the default viewer.
Related Topics
File Menu
View Menu
Help Menu
Deskewing Real Time Oscilloscopes
Click Tools on the application menu bar.
The Tools menu has the below selection:
Menu Function
Instrument Bench
xxx
Opens a dialog box showing the list of instruments attached to the test setup.
Tools > Instrument Bench
The Instrument Bench window shows the list of VISA and Non-VISA resources found on d ifferent
interfaces/connections. It serves two purposes at the launch of TekExpress:
Discovers the connected instruments.
Confirms the instrument connection setup.
When you click Tools > Instrument Bench, the following dialog box is displayed:
TekExpress USB Automated Solutions Help 17
Loading...