Teledyne-lecroy Automation API for Bluetooth Analyzers Manuel d'utilisateur

3385 Scott Blvd, Santa Clara, CA 95054 Tel: +1/408.727.6600 Fax: +1/408.727.6622 Manual Version 1.408 July, 2004Automation API for CATC Bluetooth A

4Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.401.7 TerminationWhen the application is started in automation mode, the last client to disco

94Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40The Location window displays.Step 2 Select the option Run application on the following comp

95Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40You should see the following settings. If the settings are not the same as those shown, c

96Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40The following screen will display. TCP/IP should appear at the top of the list. If it doe

97Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40• html - Contains a directory with an HTML-based client application called analyzer1.html

98Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 2 Double-click AnalyzerClient.exe. The application will start. If you prefer, you can

99Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40sure that the account that you are using on the Host Controller is the same as the one you

100Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40

101Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40How to Contact CATCLimited Hardware WarrantySo long as you or your authorized representat

102Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40altered by someone other than CATC, Products with missing or altered service tags or seria

103Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40to have the Product repaired by CATC, you agree to pay CATC for the cost to return the Pr

5Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402. Automation API DescriptionThis chapter describes the commands in the BTTracer, Merlin,

104Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40

6Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40diagram represents objects dependance: All interfaces are dual interfaces, which allows simp

7Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40• Primary Dual Interface for Trace• Primary Dual Interface for Recording Options• Errors Co

8Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3 Primary Dual Interface for AnalyzerThe IBTAnalyzer interface derives from IAnalyzer int

9Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.2 IAnalyzer::GetVersionRetrieves the current version of specified subsystemParametersve

10Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40, MB_OK );else::MessageBox(NULL, er.ErrorMessage(), _T("BTAnalyzer client"), MB_O

11Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.3 IAnalyzer::GetSerialNumberRetrieves serial number of analyzer deviceParametersReturn

12Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.4 IAnalyzer::OpenFileOpens trace fileParametersfile_name - string providing the full pa

13Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.5 IAnalyzer::StartGenerationStarts traffic generation from the fileParametersgen_file_

iiAutomation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Document DisclaimerThe information contained in this document has been carefully checked an

14Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.6 IAnalyzer::StopGenerationStops generationReturn valuesE_NOTIMPLRemarksNot implemented

15Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.7 IAnalyzer::StartRecordingStarts recording with specified recording optionsParameters

16Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40try{bt_analyzer->StartRecording( ro_file_name )}catch ( _com_error& er){if (er.Descr

17Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.8 IAnalyzer::StopRecordingStops recording started by StartRecording methodParametersa

18Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.9 IAnalyzer::MakeRecordingMakes recording with specified recording options fileParamete

19Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40// query for VTBL interfaceIBTTrace* bt_trace;hr = trace->QueryInterface( IID_IBTTrace,

20Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.10 IAnalyzer::CreateRecordingSnapshot Causes the analyzer to create a temporary trace

21Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.11 IAnalyzer::LoadDisplayOptionsLoads display options that will apply for trace opened

22Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.12 IAnalyzer::GetRecordingOptionsRetrieves primary interface for access to recording op

23Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.13 IBTAnalyzer::GetBTNeighborhoodRetrieves collection interface for access to bluetoot

iiiAutomation API for CATC Bluetooth AnalyzersCATC Ver. 1.40TABLE OF CONTENTSChapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . .

24Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.14 IBTAnalyzer::SetLinkKeySets link key for specified addressParametersaddr - device ad

25Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.15 IBTAnalyzer::SetPinCodeSets pin code for specified addressParametersaddr - device a

26Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.16 IBTAnalyzer::ResetEncryptionClears all previously set link keys and pin codesParamet

27Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.3.17 IAnalyzer::SetConnectorsConfigurationSets the connectors configuration. Supported o

28Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40"- 'G.P' (Breakout board)\n";Radio dataIn this configuration the connec

29Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Both directions = 3clock_cal_channel - Reserved. Currently not used. Return valuesNot Supp

30Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4 Primary dual interface for traceIBTTrace interface is the primary interface for BTTrac

31Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.1 ITrace::GetNameRetrieves trace nameParameterstrace_name - the name of the traceRetur

32Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.2 ITrace::ApplyDisplayOptionsApplies specified display options to the traceParametersdo

33Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.3 ITrace::SaveSaves trace into file, allows to save a range of packetsParametersfile_n

ivAutomation API for CATC Bluetooth AnalyzersCATC Ver. 1.40ITrace::AnalyzerErrors . . . . . . . . . . . . . . . . . . . . . . 48Primary dual interfac

34Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40if (er.Description().length() > 0)::MessageBox( NULL, er.Description(), _T("BTAnal

35Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.4 ITrace::ExportToTextExports trace into text file, allows to export a range of packet

36Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40_______|_______________________________________________________________________19_____| T(S

37Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.5 ITrace::Close Closes the traceParametersReturn valuesRemarksCloses current tr

38Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.6 ITrace::ReportFileInfoSaves trace information into specified text fileParametersfile_

39Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40ExampleWSH:Set Analyzer = WScript.CreateObject("CATC.Merlin")CurrentDir = Left(W

40Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.7 ITrace::ReportErrorSummarySaves trace error summary information into specified text f

41Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40ExampleWSH:Set Analyzer = WScript.CreateObject("CATC.Merlin")CurrentDir = Left(W

42Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.8 ITrace::ReportTrafficSummarySaves trace traffic summary information into specified te

43Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.9 ITrace::GetPacket Retrieves raw packet representationParameterspacket_number - n

vAutomation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Setting When and How Authentication Should Occur . . . 91Set the Host Name or IP Address of

44Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40NextPacketStr = Left( PacketStr, NumberOfBits )StatusText.innerText = "Packet ( "

45Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40}_stprintf( elem, _T("%d bits"), number_of_bits );_tcscat( packet_message, elem

46Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.10 ITrace::GetPacketsCountRetrieves total number of packets in the traceParametersnumbe

47Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.11 ITrace::GetTriggerPacketNumRetrieves trigger packet numberParameterspacket_number -

48Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.4.12 ITrace::AnalyzerErrors Retrieves trace file errorsParameterslong error_type –

49Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5 Primary dual interface for recording optionsIBTRecOptions interface is the primary in

50Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.1 IRecOptions::LoadLoads recording options from specified fileParametersro_file_name -

51Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.2 IRecOptions::SaveSaves recording options into specified fileParametersro_file_name -

52Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.3 IRecOptions::SetRecModeSets the recording modeParametersrec_mode - enumerated value p

53Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.4 IRecOptions::SetBufferSizeSets the size of buffer to recordParametersbuffer_size - b

viAutomation API for CATC Bluetooth AnalyzersCATC Ver. 1.40

54Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.5 IRecOptions::SetPostTriggerPercentageSets the posttrigger buffer size Parameterspostt

55Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.6 IRecOptions::SetTriggerBeepSets the flag indicating to make a sound when trigger occ

56Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.7 IRecOptions::SetDataTruncateSets the flag indicating that recorded data is to be trun

57Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.8 IBTRecOptions:: SetDataTruncateThis method is not implemented for IBTRecOptions inte

58Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.9 IRecOptions::SetAutoMergeSets the flag indicating that recorded traces on different c

59Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.10 IBTRecOptions::SetAutoMergeThis method is not implemented for IBTRecOptions interfa

60Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.11 IRecOptions::SetSaveExternalSignalsSets the flag indicating to save external signals

61Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.12 IRecOptions::SetTraceFileNameSets the path to the file where trace will be stored a

62Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.13 IRecOptions:: SetFilterPolaritySets the whether to filter in or out the recording ev

63Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.14 IBTRecOptions::SetMasterAddrSets the option master address used by the Analyzer to

1Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.401. Introduction CATC Bluetooth Analyzer Automation is an Automation Application Program In

64Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.15 IBTRecOptions::SetPageTargetAddrSets the page target used by the Analyzer when perfo

65Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.5.16 IRecOptions::ResetResets recording options to its initial stateParametersReturn val

66Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.6 Errors Collection InterfaceThe IAnalyzerErrors dispinterface is a standard collection

67Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.6.1 IAnalyzerErrors::get_ItemParametersindex - index of error in the collectionpacket_nu

68Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.6.2 IAnalyzerErrors::get_CountParametersnumber_of_errors - points to long value where num

69Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40}for ( long i=0; i<errors_count && i<2048/32; i++ ){analyzer_error = analyse

70Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.7 Bluetooth neighborhood collection interfaceThe IBTNeighborhood dispinterface is a stan

71Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.7.1 IBTNeighborhood::get_ItemParametersindex - index of error in the collectionbt_device

72Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.7.2 IBTNeighborhood::get_CountParametersbt_device_count - points to long value where numb

73Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.8 Primary dual interface for bluetooth deviceIBTDevice interface is the primary interfa

2Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40For additional tips, ideas and support for how to use the Automation API, please check the

74Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.8.1 IBTDevice::GetAddressRetrieves the address of deviceParametersaddress - device addres

75Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.8.2 BTDevice:: GetClockHzRetrieves the clock frequency of deviceParametersclock_hz - dev

76Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.8.3 IBTDevice:: GetCoDRetrieves class of deviceParameterscod - class of device Return val

77Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.9 Analyzer events callback interfaceIn order to retrieve the events from BTAnalyzer app

78Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.9.1 IAnalyzerEvents::OnTraceCreatedFired when trace is created; this event is a result of

79Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.402.9.2 _IAnalyzerEvents::OnStatusReportFired when there is a change in analyzer's stat

80Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40<SCRIPT LANGUAGE="VBScript"><!--Function GetRecordingStatus(ByVal State,

81Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40}TCHAR buf[1024];_stprintf( buf, _T("%s, %s"), m_RecordingStatus, m_SyncStatus )

82Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40

83Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Appendix A: DCOM Configuration BTTracer, Merlin, & Merlin Mobile Automation can be r

3Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.401.4 Setting Up Automation for Local UseIf you intend to run Automation on the Host Control

84Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 5 If you write a program in C++, make sure that the Merlin Host Controller is register

85Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 2 Select Run ...The Run dialog appears.Step 3 In the Open edit box within the Run dia

86Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 5 In the Applications tab, scroll down the list of applications and select Merlin.Step

87Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40The following settings display:You see three options: Access Permissions - Determines who

88Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 3 Click the Edit ... button.The Registry Value Permissions dialog box appears.Step 4

89Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 5 Select the group called Everyone.Step 6 Click the Add button.Step 7 Select the grou

90Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Configuring Configuration PermissionsYou are going to give everyone permission to configure

91Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40The following screen displays: Step 2 Make sure that the Interactive User option is select

92Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 2 Select Run ...The Run dialog appears.Step 3 In the Open edit box within the Run dial

93Automation API for CATC Bluetooth AnalyzersCATC Ver. 1.40Step 6 Click the Properties button.Step 7 Click the Authentication drop-down menu and sele