LeCroy Conquest Manuel utilisateur

For Software Version 7.40

September 2008

PROTOCOL SOLUTIONS GROUP

3385 SCOTT BLVD

SANTA CLARA, CA 95054

Conquest

Application Program Interface (API)

Manual

Version 7.40

Document Disclaimer

The information 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.

LeCroy reserves the right to revise the information in this document without notice or penalty.

Trademarks

LeCroy and Conquest are trademarks of LeCroy Corporation.

Universal Serial Bus and On-The-Go are registered trademarks of USB-IF.

Microsoft and Windows are registered trademarks, and Visual C++ and Visual Basic are trademarks, of

Microsoft Corporation.

Borland and Delphi are trademarks of Borland Corporation.

All other trademarks and registered trademarks are property of their respective owners.

This document may be printed and reproduced without additional permission, but all copies should contain

this copyright notice.

Part number: 400-0066-001

WEEE Program

This electronic productis subjectto

disposal and recycling regulations that

varybycountry and region. Many

countries prohibitthe disposal of

waste electronic equipmentin

standard waste receptacles.

For more information about proper

disposal and recycling ofyourCatalyst

product, please visit

www.getcatalyst.com/recycle.

Contents

iii

Introduction - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1

Using the Library - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1

Object Hierarchy - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1

IUsbGeneral Services Interface - - - - - - - - - - - - - - - - - - - - - - - - - - - 2

SetPort- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2

IsHardwareStoped - - - - - - - - - - - - - - - - - - - - - - - - - 2

SaveOutFiles- - - - - - - - - - - - - - - - - - - - - - - - - - - - 3

EnableProtocolError - - - - - - - - - - - - - - - - - - - - - - - - 3

IsEnableProtocolError - - - - - - - - - - - - - - - - - - - - - - - 3

GetMaxMemorySize - - - - - - - - - - - - - - - - - - - - - - - - 3

AttachDevice- - - - - - - - - - - - - - - - - - - - - - - - - - - - 3

AttachToDevice - - - - - - - - - - - - - - - - - - - - - - - - - - 4

GetDeviceIDList - - - - - - - - - - - - - - - - - - - - - - - - - - 4

DetachDevice - - - - - - - - - - - - - - - - - - - - - - - - - - - 4

SaveSmpAsText - - - - - - - - - - - - - - - - - - - - - - - - - - 4

IusbEasyDataCapturePrj Interface- - - - - - - - - - - - - - - - - - - - - - - - - 5

GetCaptureAndTrigger - - - - - - - - - - - - - - - - - - - - - - - 6

GetExerciser - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6

GetSetting - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6

Open- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6

Save - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 7

Run - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 7

Stop - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 7

SetAnalyzerType - - - - - - - - - - - - - - - - - - - - - - - - - - 7

GetAnalyzerType- - - - - - - - - - - - - - - - - - - - - - - - - - 8

SetPAOutFile - - - - - - - - - - - - - - - - - - - - - - - - - - - 8

GetPAOutFile - - - - - - - - - - - - - - - - - - - - - - - - - - - 8

SetTAOutFile- - - - - - - - - - - - - - - - - - - - - - - - - - - - 8

GetTAOutFile - - - - - - - - - - - - - - - - - - - - - - - - - - - 8

SetPreTrigger - - - - - - - - - - - - - - - - - - - - - - - - - - - 9

GetPreTrigger - - - - - - - - - - - - - - - - - - - - - - - - - - - 9

SetEntireMemory- - - - - - - - - - - - - - - - - - - - - - - - - - 9

IsSetEntireMemory - - - - - - - - - - - - - - - - - - - - - - - - - 9

SetSamplesNo - - - - - - - - - - - - - - - - - - - - - - - - - - - 9

GetSamplesNo- - - - - - - - - - - - - - - - - - - - - - - - - - -10

SetRunExerciser - - - - - - - - - - - - - - - - - - - - - - - - - -10

IsSetRunExerciser - - - - - - - - - - - - - - - - - - - - - - - - -10

Contents

CaptureAndTrigger - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 11

SetTriggerType - - - - - - - - - - - - - - - - - - - - - - - - - - 12

GetTriggerType - - - - - - - - - - - - - - - - - - - - - - - - - - 12

SetManualTrig- - - - - - - - - - - - - - - - - - - - - - - - - - - 12

IsSetManualTrig - - - - - - - - - - - - - - - - - - - - - - - - - - 12

SetTriggerDeviceAddress - - - - - - - - - - - - - - - - - - - - - 13

GetTriggerDeviceAddress - - - - - - - - - - - - - - - - - - - - - 13

SetTriggerEndPoint - - - - - - - - - - - - - - - - - - - - - - - - 13

GetTriggerEndPoint - - - - - - - - - - - - - - - - - - - - - - - - 13

SetTriggerDataPacket - - - - - - - - - - - - - - - - - - - - - - - 14

GetTriggerDataPacket - - - - - - - - - - - - - - - - - - - - - - - 14

SetDataCapture1 - - - - - - - - - - - - - - - - - - - - - - - - - 15

GetDataCapture1 - - - - - - - - - - - - - - - - - - - - - - - - - 15

SetDataCapture2 - - - - - - - - - - - - - - - - - - - - - - - - - 16

GetDataCapture2 - - - - - - - - - - - - - - - - - - - - - - - - - 16

SetDataCapture3 - - - - - - - - - - - - - - - - - - - - - - - - - 17

GetDataCapture3 - - - - - - - - - - - - - - - - - - - - - - - - - 17

ExcludeNakedTransactions - - - - - - - - - - - - - - - - - - - - 17

IsExcludeNakedTransactions - - - - - - - - - - - - - - - - - - - 18

ExcludeNYETedTransactions - - - - - - - - - - - - - - - - - - - 18

IsExcludeNYETedTransactions - - - - - - - - - - - - - - - - - - 18

ExcludeKeepAliveEvents - - - - - - - - - - - - - - - - - - - - - 18

IsExcludeKeepAliveEvents- - - - - - - - - - - - - - - - - - - - - 18

ExcludeSOFPackets- - - - - - - - - - - - - - - - - - - - - - - - 19

IsExcludeSOFPackets - - - - - - - - - - - - - - - - - - - - - - - 19

SetTimingPattern - - - - - - - - - - - - - - - - - - - - - - - - - 19

GetTimingPattern - - - - - - - - - - - - - - - - - - - - - - - - - 19

IExerciser - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 20

AddCommand - - - - - - - - - - - - - - - - - - - - - - - - - - - 21

AddUserDefineCommand - - - - - - - - - - - - - - - - - - - - - 22

InsertCommand - - - - - - - - - - - - - - - - - - - - - - - - - - 23

InsertUserDefineCommand - - - - - - - - - - - - - - - - - - - - 24

DeleteCommand- - - - - - - - - - - - - - - - - - - - - - - - - - 24

DeleteAllCommands - - - - - - - - - - - - - - - - - - - - - - - - 25

SetStartOfLoop - - - - - - - - - - - - - - - - - - - - - - - - - - 25

SetEndOfLoop- - - - - - - - - - - - - - - - - - - - - - - - - - - 25

SetRepeatCommand - - - - - - - - - - - - - - - - - - - - - - - 25

FindDevice - - - - - - - - - - - - - - - - - - - - - - - - - - - - 26

GetFoundDevicesNo- - - - - - - - - - - - - - - - - - - - - - - - 26

GetDeviceEndPointsNo - - - - - - - - - - - - - - - - - - - - - - 26

GetEndPointType - - - - - - - - - - - - - - - - - - - - - - - - - 26

GetEndPointDirection - - - - - - - - - - - - - - - - - - - - - - - 27

GetEndPointNo - - - - - - - - - - - - - - - - - - - - - - - - - - 27

Contents

IsDeviceHub - - - - - - - - - - - - - - - - - - - - - - - - - - - -27

SetStartExerciserWith - - - - - - - - - - - - - - - - - - - - - - -28

ISetting - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 29

SetAnalyzerSpeed - - - - - - - - - - - - - - - - - - - - - - - - -30

GetAnalyzerSpeed - - - - - - - - - - - - - - - - - - - - - - - - -30

SetExerciserLoopCounter - - - - - - - - - - - - - - - - - - - - -30

Get ExerciserLoopCounter - - - - - - - - - - - - - - - - - - - - -30

SetExternalTriggerType - - - - - - - - - - - - - - - - - - - - - -31

GetExternalTriggerType - - - - - - - - - - - - - - - - - - - - - -31

EnableNonStdClock - - - - - - - - - - - - - - - - - - - - - - - -31

IsEnableNonStdClock - - - - - - - - - - - - - - - - - - - - - - -31

SetNonStdClockRateType - - - - - - - - - - - - - - - - - - - - -31

GetNonStdClockRateType - - - - - - - - - - - - - - - - - - - - -32

EnableSecondPort - - - - - - - - - - - - - - - - - - - - - - - - -32

IsEnableSecondPort - - - - - - - - - - - - - - - - - - - - - - - -32

SetSecondPortStore - - - - - - - - - - - - - - - - - - - - - - - -32

GetSecondPortStore - - - - - - - - - - - - - - - - - - - - - - - -32

EnableHighSpeedTestMode - - - - - - - - - - - - - - - - - - - -33

IsEnableHighSpeedTestMode - - - - - - - - - - - - - - - - - - -33

SetInfiniteExerciserLoopCounter - - - - - - - - - - - - - - - - - -33

IsInfiniteExerciserLoopCounter - - - - - - - - - - - - - - - - - - -33

API Constants- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 34

Analyzer Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -34

Analyzer Speed definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -34

Trigger Items definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -34

Data Packet Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -35

Timing Analyzer Pattern Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - -35

Capturing Items definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -35

Exerciser Command Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - -36

HUB Features definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -36

HUB Port Features definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -36

Port definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -36

Protocol Error Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -37

External Trigger Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -37

Non Standard Clock Rate Type definitions - - - - - - - - - - - - - - - - - - - - - - - - -37

Second Port Capturing Items definitions - - - - - - - - - - - - - - - - - - - - - - - - - -37

Endpoint Type definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -38

Contents

Endpoint Direction Definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 38

Exerciser Start With event definition - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 38

API Errors - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 39

Exerciser Command Parameters - - - - - - - - - - - - - - - - - - - - - - - - - 40

Introduction

The Conquest™ Application Program Interface (API) is a collection (library) of COM objects.

The API enables programmers to use most of the Conquest Suite software functionality in

their programs for the hardware, to execute a specific project with an event sequence and

program selections. The software is for use with applications developed under

COM Supported Platforms such as Microsoft®Visual C++™, Borland®Delphi™, and

Microsoft Visual Basic™.

Using the Library

To use the library:

1. Copy the Conquest SystemData folder into the system32 folder of the

Windows directory of the PC.

2. Import usb.tlb into your software project.

3. Create a dispatch USBGeneralServices interface. See page 2.

4. Create a dispatch USBEasyDataCapturePrj interface. See page 5.

5. Use the API functions for required settings.

Note: You must run the Conquest Suite software before using the API.

Object Hierarchy

Objects are organized in a hierarchy of interfaces, with a set of methods for each.

Figure 1 Object Hierarchy Definition

IUSBEasyDataCapturePrj

IUSBGeneralService

IExerciser

ISetting

ICaptureAndTrigger

IUsbGeneral Services Interface

SetPort

Declaration: long SetPort(short sPortType)

Input(s): sPortType specifies hardware port type.

Valid port types are introduced in API Constants.

Return Value: Zero if the SetPort was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This method sets the port type and connects the software to the

hardware.

See Also API Errors

IsHardwareStoped

Declaration: long IsHardwareStoped(BOOL* bIsStoped)

Input(s): bIsStoped specifies hardware stop flag.

Return Value: Zero if the IsHardwareStoped was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This function sets bIsStoped to TRUE if hardware is stopped.

Otherwise, sets to FALSE. Returns error code if an error occurs.

See Also API Errors

Method Description

SetPort Set hardware attached port.

IsHardwareStoped Is hardware stopped?

SaveOutFiles Save output file of last run project.

EnableProtocolError Enable or disable protocol errors by Type.

IsEnableProtocolError Is protocol error type enabled or not.

GetMaxMemorySize Get the maximum size of memory.

AttachDevice Attach device.

DetachDevice Detach device.

SaveSmpAsText Save captured data in a text file.

IUsbGeneral Services Interface

SaveOutFiles

Declaration: longSaveOutFiles()

Input(s): None

Return Value: Zero if the SaveOutFiles was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This method saves the output file for Protocol analyzer,

Timing analyzer, or both.

See Also API Errors

EnableProtocolError

Declaration: long EnableProtocolError(short sProtocolErrorType, BOOL bEnable)

Input(s): sProtocolErrorType specifies type of protocol error.

Valid types are introduced in API Constants.

bEnable specifies status of selected protocol error type.

Return Value: Zero if the EnableProtocolError was successful.

Otherwise, non-zero. Each non-zero value indicates an error code.

Remark: Enables or disables a protocol error type.

See Also API Errors

IsEnableProtocolError

Declaration: BOOL IsEnableProtocolError(short sProtocolErrorType)

Input(s) sProtocolErrorType specifies the type of protocol error.

Valid types are introduced in API Constants.

Return Value: Zero if IsEnableProtocolError was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: Returns true if protocol error tspecified by sProtocolErrorType is

enabled. Otherwise, it returns false.

See Also API Errors

GetMaxMemorySize

Declaration: long GetMaxMemorySize(long* lMaxSize)

Input(s): lMaxSize specifies maximum available memory size.

Return Value: Zero if GetMaxMemorySize was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This method sets lMaxSize to available memory size.

See Also API Errors

AttachDevice

Declaration: long AttachDevice()

Input(s): None

Return Value: Zero if AttachDevice was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This function attaches the device to the analyzer.

See Also API Errors

IUsbGeneral Services Interface

AttachToDevice

Declaration: long AttachToDevice(LPCTSTR lpctstrMacAddress)

Input(s): lpctstrMacAddress specifies hardware MAC address.

Return Value: Zero if AttachToDevice was successful. Otherwise, non-zero.

Each nonzero value indicates an error code.

Remark: This method attaches the software to the requested hardware

specified by its MAC address.

See Also API Errors

GetDeviceIDList

Declaration: BSTR GetDeviceIDList(long nPortType)

Input(s): nPortType specifies hardware port type.

Valid port types are listed below.

Return Value: Each Device ID is separated with ',', and each Device ID number is in

hexadecimal format, such as

"0200000E850002D8,0400000E85000131".

Remark: This method enumerates all available devices on the selected port

and returns available device IDs in string format.

DetachDevice

Declaration: long DetachDevice()

Input(s): None

Return Value: Zero if the DetachDevice was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This function detaches the device from the analyzer.

See Also API Errors

SaveSmpAsText

Declaration: long SaveSmpAsText(LPCTSTR strSmpFilePath,

LPCTSTR strTextFilePath)

Input(s): strSmpFilePath specifies path of sample file (.smp).

strTextFilePath specifies path of out text file.

Return Value: Zero if the SaveSmpAsText was successful. Otherwise, non-zero.

Each non-zero value indicates an error code.

Remark: This function converts smp file to text file and saves it.

Manuels Équipement d'enregistrement populaires d'autres marques

KV2 Audio

KV2 Audio 500 Series Manuel utilisateur

Robotics Technologies

Robotics Technologies microBus-Cam II Manuel utilisateur

Seca

Seca 460 Manuel utilisateur

Cognex

Cognex MVS-8000 Series Manuel utilisateur

Mect

Mect MPNC006 Series Manuel utilisateur

Bad Caf

Bad Caf THE LEASH Manuel utilisateur

Strymon

Strymon NIGHTSKY Manuel utilisateur

Mitsubishi Electric

Mitsubishi Electric 16CH DIGITAL RECORDER DX-TL5000U Manuel utilisateur

Tews Technologies

Tews Technologies TPMC465 Manuel utilisateur

Honeywell

Honeywell Excel 50 Manuel utilisateur

SeaLevel

SeaLevel COMM+8.LPCI Manuel utilisateur

Arturia

Arturia AUDIOFUSE STUDIO Manuel utilisateur

Rukra

Rukra RK-1240 Manuel utilisateur

Samson

Samson SCOM Manuel utilisateur

Dynacord

Dynacord DPS260 Manuel utilisateur

Nice

Nice Core Manuel utilisateur

Pyle Pro

Pyle Pro PSS8 Manuel utilisateur

RF-System

RF-System TinyGate Manuel d'utilisation et d'entretien