Teledyne LeCroy USB Analyzer Automation Manual - Manual (Page 6)

Teledyne LeCroy Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol
Suite
6
1 Introduction
USB Tracer™, USB Advisor™, and Voyager™ USB Protocol Suite Automation is an Application Program
Interface (API) that allows users to create scripts or programs of commands and run these scripts or
programs locally or remotely over a network. The name Automation is derived from the goal of allowing
engineers to automate test procedures.
The USBTracer, USB Advisor, and Voyager USB Protocol Suite Automation API is composed of a
command set that duplicates most of the functionality of the USBTracer, USB Advisor, and Voyager
Graphical User Interfaces. Automation is implemented through the use of scripts or programs that the
user can write using late binding scripting languages such as VBScript and WSH or early binding
languages such as C++. Teledyne LeCroy provides examples of scripts written in WSH, VBScript, and
C++.
Once an Automation script or program has been created, it can be run on the PC attached to or
transmitted to the PC over a network from a remote location. Automation uses the
Distributed Component Object Model (DCOM) protocol to transmit automation commands over a
network. When run over a network, the Host Controller is configured as a DCOM server and the remote
PC is configured as a DCOM client.
Note:
If you are using any application that uses the Automation Interface to the USB Protocol Suite, and the
system prompts you that it cannot write a trace file to disk:
1. Make sure that the trace-file destination folder has write/create permissions. (For example, the target
directory might be the netwrok file system, which typically does not have write/create permissions.)
2. Make sure that the Windows (or other) Firewall Settings for USB Protocol Suite are set to Public.
1.1 System Requirements
Automation is supported with USBTracer/Trainer and USB Advisor software version 1.7 or higher and
Voyager USB Protocol Suite software version 3.0 or higher. If you have an older version of the software,
you must upgrade. You can get a new version of software from the Teledyne LeCroy web site,
www.teledynelecroy.com/support. You also need a copy of the USBTracer, USB Advisor, and
Voyager USB Protocol Suite Automation software package. This is available from Teledyne LeCroy.
IMPORTANT! To compile with the correct linkage to the USB Automation API code, you must move the
USBAutomation.tlb file from the application's installed directory into a directory from which your
compiler can access the file. For example, for Visual Studio, this typically is the directory that contains
your project file and sources.
1.2 Setting Up Automation for Local Use
If you intend to run Automation on the Analyzer Host Controller (the PC attached to the Analyzer), you
do not need to perform any special configuration. You can simply execute the scripts or programs you
have created, and they run the Analyzer.