Protocol Solutions Group 3385 Scott Blvd., Santa Clara, CA 95054 Tel: +1/408.653.1260 Fax: +1/408.727.6622 Automation API Reference Manual for USB Protocol Suite Teledyne LeCroy Advisor T3, Mercury T2™, Mercury T2C™, and Voyager M3i/M3x/M310™/M310C™ USB Protocol Suite Software Version 7.40 and above Manual Version 5.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Document Disclaimer The information contained in this document has been carefully checked and is believed to be reliable. However, no responsibility can be assumed for inaccuracies that may not have been detected. Teledyne LeCroy reserves the right to revise the information presented in this document without notice or penalty.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Contents 1 Introduction ................................................................................................ 7 1.1 ...... System Requirements ............................................................. 7 1.2 ...... Setting Up Automation for Local Use ...................................... 7 1.3 ...... Setting Up Automation for Remote Use .................................. 7 1.4 ......
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.7 ...... IUsbAnalyzer8 interface ........................................................45 2.7.1 2.7.1 IUsbAnalyzer8::GetHardwareInfo ..................................................... 45 IUsbAnalyzer8::IsSupportSSP.......................................................... 46 2.8 ...... IusbAnalyzer9 interface .........................................................47 2.8.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.9 ...... IUsbTrace10 interface ........................................................... 82 3.9.1 IUsbTrace10::ExportTransactionsWithPacketsToCsv....................... 82 3.10 ... _ITraceEvents interface ........................................................ 84 3.10.1 ITraceEvents::OnLevelDecodeFinished ............................................ 84 3.11 ...
Teledyne LeCroy Suite 7.1.9 7.1.10 7.1.11 7.1.12 Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol IRecOptions::SetSaveExternalSignals ........................................... 124 IRecOptions::SetTraceFileName .................................................... 125 IRecOptions:: SetFilterPolarity ....................................................... 126 IRecOptions::Reset ........................................................................ 127 7.2 ......
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 1 Introduction The 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.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol The USB Protocol Suite API exposes the following objects and interfaces: Objects Interfaces Description IUsbAnalyzer IUsbAnalyzer3 _IAnalyzerEvents Primary Analyzer interface IUsbTrace IUsbTrace2 Trace file interfaces IUsbRecOptions Recording options interface IUsbDevice USB device interface IAnalyzerErrors Error collection interface UsbAnalyzer Analyzer event source UsbTrace UsbRecOp
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol ANALYZERCOMERROR_UNABLETOMERGEFILES ANALYZERCOMERROR_LEVEL_NOT_AVAILABLE ANALYZERCOMERROR_VARIANT_TYPE_ERROR = 0x80040214 = 0x80040300 = 0x80040301 1.5 Note Regarding VBS Return Values A recent update to the Microsoft Visual Basic Interpreter causes it to no longer perform the implicit type conversions that it once did. There is a very simple workaround for these issues.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol ANALYZERVERSION_SOFTWARE ANALYZERVERSION_BUSENGINE ANALYZERVERSION_FIRMWARE analyzer_version ( 0 ) Software ( 1 ) Bus engine ( 2 ) Firmware Current version of subsystem requested. Value is encoded in BCD. Example: 0x0312 would mean version 3.12 Return values ANALYZERCOMERROR_INVALIDVERSIONTYPE ANALYZERCOMERROR_ANALYZERNOTCONNECTED Specified version type is invalid.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: HRESULT hr; IUsbAnalyzer* poUsbAnalyzer; // create UsbAnalyzer object if ( FAILED( CoCreateInstance( CLSID_UsbAdvisor, NULL, CLSCTX_SERVER, IID_IUsbAnalyzer, (LPVOID *)&poUsbAnalyzer ) ) return; WORD sw_version; try { sw_version = poUsbAnalyzer ->GetVersion( ANALYZERVERSION_SOFTWARE ); } catch ( _com_error& er) { if (er.Description().length() > 0) ::MessageBox( NULL, er.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.2 IAnalyzer::GetSerialNumber HRESULT GetSerialNumber ( [out, retval] WORD* serial_number ); Retrieves the serial number of the Analyzer device. Parameters Return values ANALYZERCOMERROR_INVALIDVERSIONTYPE ANALYZERCOMERROR_ANALYZERNOTCONNECTED Specified version type is invalid. Analyzer device is not connected. Remarks Example WSH: CurrentDir = Left(WScript.ScriptFullName, InstrRev(WScript.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.3 IAnalyzer::OpenFile HRESULT OpenFile ( [in] BSTR file_name, [out, retval] IDispatch** trace ); Opens a trace file. Parameters file_name String providing the full pathname to the trace file trace Address of a pointer to the UsbTrace object primary interface Return values ANALYZERCOMERROR_UNABLEOPENFILE Unable to open file.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Example WSH: CurrentDir = Left(WScript.ScriptFullName, InstrRev(WScript.ScriptFullName, "\")) Set Analyzer = WScript.CreateObject("CATC.USBTracer") Set Trace = Analyzer.OpenFile (CurrentDir & "Input\errors.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.4 IAnalyzer::StartGeneration HRESULT StartGeneration ( [in] BSTR gen_file_name, [in] long gen_mode, [in] long loop_count ); Starts USB 2.0 traffic generation from the file. Parameters gen_file_name String providing the full pathname to the generation file.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.5 IAnalyzer::StopGeneration HRESULT StopGeneration ( ); Stops any current USB 2.0 generation in progress. Return values ANALYZERCOMERROR_UNABLESTARTGENERATION Remarks Stop any current traffic generation. Example 16 Unable to stop generation (invalid state, etc.).
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.6 IAnalyzer::StartRecording HRESULT StartRecording ( [in] BSTR ro_file_name ); Starts recording with specified recording options. Parameters ro_file_name String providing the full pathname to recording options file. If the parameter is omitted, then recording starts with the default recording options. Return values ANALYZERCOMERROR_EVENTSINKNOTINSTANTIATED Event sink was not instantiated.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: IUsbAnalyzer* usb_analyzer; BSTR ro_file_name; . . . try { usb_analyzer->StartRecording( ro_file_name ) } catch ( _com_error& er) { if (er.Description().length() > 0) ::MessageBox( NULL, er.Description(), _T("UsbAnalyzer client"), MB_OK ); else ::MessageBox( NULL, er.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.7 IAnalyzer::StopRecording HRESULT StopRecording ( [in] BOOL abort_upload ); Stops a recording started by the StartRecording method. Parameters abort_upload TRUE, if caller wants to abort upload, no trace file is created. FALSE, if you want to upload the recorded trace Return values ANALYZERCOMERROR_EVENTSINKNOTINSTANTIATED Event sink was not instantiated.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.8 IAnalyzer::MakeRecording HRESULT MakeRecording ( [in] BSTR ro_file_name, [out, retval] IDispatch** trace ); Makes a recording with the specified recording options file. Parameters ro_file_name String providing the full pathname to recording options file; If the parameter is omitted, then recording starts with the default recording options.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.9 IAnalyzer::LoadDisplayOptions HRESULT LoadDisplayOptions ( [in] BSTR do_file_name ); Loads display options that apply for traces opened or recorded later. Parameters do_file_name String providing the full pathname to display options file Return values ANALYZERCOMERROR_UNABLELOADDO Unable to load display options file. Remarks Use this method if you want to filter traffic of some type.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.10 IAnalyzer::GetRecordingOptions HRESULT GetRecordingOptions ( [out, retval] IDispatch** recording_options ); Retrieves the primary interface for access to recording options. Parameters recording_options Address of a pointer to the UsbRecOptions object primary interface Return values Remarks UsbRecOptions object is created via this method call, if call was successful.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.11 IUsbAnalyzer::StopRecordingAndWaitForTrace HRESULT StopRecordingAndWaitForTrace ( [out, retval] IDispatch** trace ); Stops recording started by the StartRecording method and returns the pointer to the trace object created.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Example WSH: ' Extract the script name. ScriptName = Right(WScript.ScriptFullName, Len(WScript.ScriptFullName) InstrRev(WScript.ScriptFullName, "\") ) Set Analyzer = WScript.CreateObject( "CATC.UsbTracer" ) CurrentDir = Left(WScript.ScriptFullName, InstrRev(WScript.ScriptFullName, "\")) ' In the code below, we perform four sequential recordings and ' save the traces recorded in the current folder.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: (Raw code without using type library. All error handling is omitted for simplicity) IUsbAnalyzer* pAnalyzer = NULL; // Create UsbAnalyzer object. if ( FAILED( CoCreateInstance( CLSID_UsbAdvisor, NULL, CLSCTX_SERVER, IID_IUsbAnalyzer, (LPVOID *)&pAnalyzer ) ) return; BSTR ro_file_name = SysAllocString( L"test_ro.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: (Microsoft® C++ specific, using type library. All error handling is omitted for simplicity.) IUsbAnalyzerPtr pAnalyzer = NULL; pAnalyzer.CreateInstance( __uuidof(UsbAdvisor) ); if( !pAnalyzer ) return; IUsbTrace2Ptr trace = NULL; for( int i = 0; i < 4; i++ ) { // Start recording using recording options file 'test_ro.rec' located in // the current folder.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.12 IUsbAnalyzer::get_ApplicationFolder (property) HRESULT get_ApplicationFolder( [out, retval] BSTR *app_folder ); Retrieves the full local path to the folder where the USB Protocol Suite application was installed and registered as a COM server.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.13 IUsbAnalyzer::get_ApplicationDataFolder (property) HRESULT get_ApplicationDataFolder( [out, retval] BSTR *app_folder ); Retrieves the full local path to the folder for user-alterable data, such as scripts, traces, and default options files.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.14 IUsbAnalyzer::StartUsb3Generation HRESULT StartUsb3Generation([in,defaultvalue("")] BSTR gen_file_name); Starts generating USB traffic. Parameters gen_file_name USB 3.0 Exerciser script file name to execute. If this parameter is an empty string, the last executed script is repeated.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Example WSH (1): See Automation\wsh\Usb3Exerciser.vbs WSH(2): Set Analyzer = WScript.CreateObject("CATC.UsbTracer", "Analyzer_") ' Tell the USB 3.0 Voyager Exerciser to start generation. Analyzer. StartUsb3Generation CurrentDir & " \Input\Usb3ScriptExample.usb3g" Dim doneGeneration doneGeneration = 0 ' Repeat Generation 49 more times. For RepeatCount = 1 To 49 Do While doneGeneration = 0 WScript.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: IUsbAnalyzerPtr usb_analyzer; . . . try { const char* gen_script_name = "C:\\Usb3ScriptExample.usb3g"; Usb_analyzer->StartUsb3Generation(_bstr_t( gen_script_name ) ); } catch (_com_error& er) { if (er.Description().length() > 0) ::MessageBox( NULL, er.Description(), _T("USBAnalyzer client"), MB_OK ); else ::MessageBox( NULL, er.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.15 IUsbAnalyzer::StopUsb3Generation HRESULT StopUsb3Generation (); Stops USB 3.0 generation started by the StartUsb3Generation method. Parameters Return values ANALYZERCOMERROR_ANALYZERNOTCONNECTED Analyzer is not connected Remarks Stops generation started by the StartUsb3Generation method.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: IUsbAnalyzerPtr usb_analyzer; . . . try { usb_analyzer ->StopUsb3Generation(); } catch (_com_error& er) { if (er.Description().length() > 0) ::MessageBox( NULL, er.Description(), _T("UsbAnalyzer client"), MB_OK ); else ::MessageBox( NULL, er.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.16 IUsbAnalyzer::PauseUsb3Generation HRESULT PauseUsb3Generation (); Pauses the currently running USB 3.0 generation. Parameters Return values ANALYZERCOMERROR_ANALYZERNOTCONNECTED Analyzer is not connected ANALYZERCOMERROR_WRONGCALL Analyzer is not running Remarks Pauses the generation started by the StartUsb3Generation method. Generation pauses if the Exerciser is running.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: IUsbAnalyzerPtr usb_analyzer; . . . try { usb_analyzer->PauseUsb3Generation(); } catch (_com_error& er) { if (er.Description().length() > 0) ::MessageBox( NULL, er.Description(), _T("UsbAnalyzer client"), MB_OK ); else ::MessageBox( NULL, er.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.1.17 IUsbAnalyzer::ResumeUsb3Generation HRESULT ResumeUsb3Generation (); Resumes the USB 3.0 generation paused by the PauseUsb3Generation command. Parameters Return values ANALYZERCOMERROR_ANALYZERNOTCONNECTED Analyzer is not connected Remarks Resumes the generation paused by the PauseUsb3Generation method. The generation returns to the running state from the paused state.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol C++: IUsb3AnalyzerPtr usb_analyzer; . . . try { usb_analyzer->ResumeUsb3Generation(); } catch (_com_error& er) { if (er.Description().length() > 0) ::MessageBox( NULL, er.Description(), _T("UsbAnalyzer client"), MB_OK ); else ::MessageBox( NULL, er.ErrorMessage(), _T("UsbAnalyzer client"), MB_OK ); return 1; } 2.1.
Teledyne LeCroy Suite 2.2 Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol IUsbAnalyzer3 interface The IUsbAnalyzer3 interface is the third interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : 1D96A60E-AA3A-45e1-B6D5-C6AA27E65910 2.2.1 IUsbAnalyzer3:: IssueManualTrig HRESULT IssueManualTrig (); Issues manual trigger event to cause force trigger in analyzer engine.
Teledyne LeCroy Suite 2.3 Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol IUsbAnalyzer4 interface The IUsbAnalyzer4 interface is the forth interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : D793E9EE-58EE-4237-9D2A-41DBB61DCDF8 2.3.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.3.3 IUsbAnalyzer4::IsUsb3GenerationIdle HRESULT IsUsb3GenerationIdle ([out] VARIANT* gen_idle); This method could be used to poll generation state after starting generation. The method returns status of generation process. User may use this method to poll status of generation and go to next step according to polling result.
Teledyne LeCroy Suite 2.4 Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol IUsbAnalyzer5 interface The IUsbAnalyzer5 interface is the fifth interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : 47CCA8A8-C4AC-4b90-ABD1-16DC2A5351FE 2.4.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.5 IUsbAnalyzer6 interface The IUsbAnalyzer6 interface is the sixth interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : 866DA1BD-9AD4-4627-A32A-C0F229684300 2.5.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Parameters wait_time_milisec Specifies time-out for waiting before return in milliseconds desired_state Specify desired analyzer state(s) [see remarks] to return from spent_time_milisec Pointer to long value which returns spent time in this method method is_done reached or time-out happened Pointer to boolean value indicating desired state has been Return values ANALYZERCOMERROR_ANALYZERNOTC
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.6 IUsbAnalyzer7 interface The IUsbAnalyzer7 interface is the seventth interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : 13D7A1C9-6753-42A5-BFE0-6F55FB0C0FA4 2.6.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.7 IUsbAnalyzer8 interface The IUsbAnalyzer8 interface is the eightth interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : 3A362B48-4222-403A-9B65-CED0E0A59DE8 2.7.1 IUsbAnalyzer8::GetHardwareInfo HRESULT GetHardwareInfo ( [out, retval] int* info) The method returns the product hardware type.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.7.1 IUsbAnalyzer8::IsSupportSSP HRESULT IsSupportSSP ( [out, retval] BOOL* is_support) The method returns that product supports USB3.1 SSP protocol or not. This includes both analyzer/exerciser engines. Please noted that in addition to supporting SSP protocol by product, specific licenses should be included to be able to work with SSP protcol engines.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.8 IusbAnalyzer9 interface The IUsbAnalyzer9 interface is the 9th interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : 38024874-326B-4C5E-A5A1-820B0311E7DF 2.8.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 2.9 IusbAnalyzer10 interface The IUsbAnalyzer8 interface is the 10th interface for the UsbAnalyzer object. It inherits and extends some analyzer-related functionality exposed via the IUsbAnalyzer interface. IID : B00652D4-B649-42AB-BCFF-13123DA33A00 2.9.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3 Primary Dual Interface for Trace 3.1 IUsbTrace Dual Interface IUsbTrace interface is the primary interface for the UsbTrace object. It derives from the ITrace interface that implements the common functionality for all Teledyne LeCroy Analyzers.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.1 ITrace::GetName HRESULT GetName ( [out, retval] BSTR* trace_name ); Retrieves the trace name. Parameters trace_name Name of the trace Return values Remarks This name can be used for presentation purposes. Do not forget to free the string returned by this method call. Example WSH: Set Analyzer = WScript.CreateObject("CATC.USBTracer") CurrentDir = Left(WScript.ScriptFullName, InstrRev(WScript.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.2 ITrace::ApplyDisplayOptions HRESULT ApplyDisplayOptions ( [in] BSTR do_file_name ); Applies the specified display options to the trace. Parameters do_file_name String providing the full pathname to display options file Return values ANALYZERCOMERROR_UNABLELOADDO Unable to load display options file.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.3 ITrace::Save HRESULT Save ( [in] BSTR file_name, [in, defaultvalue(-1)] long packet_from, [in, defaultvalue(-1)] long packet_to ); Saves the trace into a file and allows you to save a range of packets. Parameters file_name String providing the full pathname to file where trace is saved packet_from Beginning packet number when you are saving a range of packets.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.4 ITrace::ExportToText HRESULT ExportToText ( [in] BSTR file_name, [in, defaultvalue(-1)] long packet_from, [in, defaultvalue(-1)] long packet_to ); Exports the trace into a text file and allows you to export a range of packets. Parameters file_name String providing the full pathname to file where trace is exported packet_from Beginning packet number when you are exporting a range of packets.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol File E:\AnalyzerSw\Chief20\OfficialUTGFiles\SRP.usb. From Packet #13 to Packet #24. Packet# _______|_______________________________________________________________________ 13_____| Dir(-->) Suspend( 37.000 ms) Time-stamp(00016.0097 3086) _______|_______________________________________________________________________ 14_____| Dir(-->) Reset( 3.017 µs) Time-stamp(00016.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.5 ITrace::Close HRESULT Close ( ); Closes the trace. Parameters Return values Remarks Closes current trace but does not releases interface pointer. Call the IUnknown::Release method right after this method call. No ITrace method call succeeds after calling the ITrace::Close method. (Currently there is no need to call ITrace::Close directly since IUnknown::Release closes the trace.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.6 ITrace::ReportFileInfo HRESULT ReportFileInfo ( [in] BSTR file_name ); Saves trace information into the specified text file. Parameters file_name String with full pathname to file where trace information report is created Return values ANALYZERCOMERROR_UNABLESAVE Unable to create trace information report. Remarks Creates trace information file if necessary.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Example WSH: Set Analyzer = WScript.CreateObject("CATC.USBTracer") CurrentDir = Left(WScript.ScriptFullName, InstrRev(WScript.ScriptFullName, "\")) Set Trace = Analyzer.MakeRecording (CurrentDir & "Input\test_ro.rec") Trace.ReportFileInfo CurrentDir & "Output\file_info.txt" C++: IUsbTrace* usb_trace; TCHAR file_name[_MAX_PATH]; . . .
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.7 ITrace::ReportErrorSummary HRESULT ReportErrorSummary ( [in] BSTR file_name ); Saves trace error summary information into the specified text file. Parameters file_name String providing the full pathname to file where error summary report is created Return values ANALYZERCOMERROR_UNABLESAVE Unable to create trace information report. Remarks Creates error summary file if necessary.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Example WSH: Set Analyzer = WScript.CreateObject("CATC.USBTracer") CurrentDir = Left(WScript.ScriptFullName, InstrRev(WScript.ScriptFullName, "\")) Set Trace = Analyzer.MakeRecording (CurrentDir & "Input\test_ro.rec") Trace.ReportErrorSummary CurrentDir & "Output\error_summary.txt" C++: IUsbTrace* usb_trace; TCHAR file_name[_MAX_PATH]; . . .
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.8 ITrace::ReportTrafficSummary HRESULT ReportTrafficSummary( [in] BSTR file_name ); Saves trace traffic summary information into the specified text file. Parameters file_name String providing the full pathname to file where traffic summary report is created Return values ANALYZERCOMERROR_UNABLESAVE Unable to create or save traffic summary report.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol 3.1.9 ITrace::GetPacket HRESULT GetPacket ( [in] long packet_number, [in, out] VARIANT* packet, [out, retval] long* number_of_bits ); Retrieves the raw packet representation.
Teledyne LeCroy Suite Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol Example VBScript:
