Data Sheet

Teledyne LeCroy Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol
Suite
3
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 ...... Error Return Codes ................................................................. 8
1.5 ...... Note Regarding VBS Return Values ....................................... 9
2 Primary Dual Interface for Analyzer ......................................................... 9
2.1 ...... IUsbAnalyzer Dual Interface ................................................... 9
2.1.1 IAnalyzer::GetVersion ......................................................................... 9
2.1.2 IAnalyzer::GetSerialNumber ............................................................. 12
2.1.3 IAnalyzer::OpenFile........................................................................... 13
2.1.4 IAnalyzer::StartGeneration ................................................................ 15
2.1.5 IAnalyzer::StopGeneration ................................................................ 16
2.1.6 IAnalyzer::StartRecording ................................................................. 17
2.1.7 IAnalyzer::StopRecording ................................................................. 19
2.1.8 IAnalyzer::MakeRecording ................................................................ 20
2.1.9 IAnalyzer::LoadDisplayOptions ......................................................... 21
2.1.10 IAnalyzer::GetRecordingOptions ....................................................... 22
2.1.11 IUsbAnalyzer::StopRecordingAndWaitForTrace ............................... 23
2.1.12 IUsbAnalyzer::get_ApplicationFolder (property) ................................ 27
2.1.13 IUsbAnalyzer::get_ApplicationDataFolder (property) ........................ 28
2.1.14 IUsbAnalyzer::StartUsb3Generation ................................................. 29
2.1.15 IUsbAnalyzer::StopUsb3Generation ................................................. 32
2.1.16 IUsbAnalyzer::PauseUsb3Generation............................................... 34
2.1.17 IUsbAnalyzer::ResumeUsb3Generation ........................................... 36
2.1.18 IUsbAnalyzer::UsbUnplugPlug .......................................................... 37
2.2 ...... IUsbAnalyzer3 interface ........................................................ 38
2.2.1 IUsbAnalyzer3:: IssueManualTrig ..................................................... 38
2.3 ...... IUsbAnalyzer4 interface ........................................................ 39
2.3.1 IUsbAnalyzer4::GetRecordingStatus................................................. 39
2.3.2 IUsbAnalyzer4::ResetUsb3Trainer .................................................... 39
2.3.3 IUsbAnalyzer4::IsUsb3GenerationIdle .............................................. 40
2.3.4 IUsbAnalyzer4::SwitchVBus .............................................................. 40
2.4 ...... IUsbAnalyzer5 interface ........................................................ 41
2.4.1 IUsbAnalyzer5::BindUnit ................................................................... 41
2.4.2 IUsbAnalyzer5::MergeTraceFiles ...................................................... 41
2.5 ...... IUsbAnalyzer6 interface ........................................................ 42
2.5.1 IUsbAnalyzer6::WaitForUsb3GenerationIdle .................................... 42
2.5.2 IUsbAnalyzer6::WaitForRecordingStatus .......................................... 42
2.6 ...... IUsbAnalyzer7 interface ........................................................ 44
2.6.1 IUsbAnalyzer7::GetLicensedCapability ............................................. 44