Teledyne LeCroy Automation API for Bluetooth Exercisers - Manual (Page 3)

CATC Automation API for CATC Bluetooth Exercisers Manual Version 1.01
iii
T
ABLE OF
C
ONTENTS
1 I
NTRODUCTION ............................................................................................1
1.1 System Requirements ............................................................................................... 1
1.2 Support Resources .................................................................................................... 1
1.3 Setting Up Automation for Local Use ..................................................................... 2
1.4 Setting Up Automation for Remote Use ................................................................. 2
2 A
UTOMATION
API D
ESCRIPTION
......................................................................2
2.1 Initialization .............................................................................................................. 2
2.1.1 BTTrainer
Initialization............................................................................................... 2
2.1.2 Termination ................................................................................................................. 3
2.1.3 Error
Handling............................................................................................................. 3
2.1.4 VARIANTs and CSL CValues ................................................................................... 3
2.2 BTExerciser Class..................................................................................................... 4
2.2.1 OpenScriptManager Method....................................................................................... 4
2.2.2 GetLog Method ........................................................................................................... 5
2.2.3 SaveLog Method ......................................................................................................... 6
2.2.4 ClearLog Method ........................................................................................................ 6
2.2.5 CreateTransmitPipeData Method................................................................................ 7
2.2.6 CreateTransmitPipeFile Method ................................................................................. 7
2.2.7 DeleteTransmitPipe Method ....................................................................................... 8
2.2.8 SaveReceivePipeFile Method ..................................................................................... 8
2.2.9 CloseReceivePipe Method .......................................................................................... 8
2.2.10 DeleteReceivePipe Method......................................................................................... 9
2.2.11 Status Property ............................................................................................................ 9
2.2.12 OnStatusChanged Connection Callback ................................................................... 10
2.2.13 OnScriptRunComplete Connection Callback............................................................ 10
2.3 ScriptManager Class .............................................................................................. 10
2.3.1 LoadScriptFile Method ............................................................................................. 11
2.3.2 LoadModuleFile Method........................................................................................... 11
2.3.3 Start Method.............................................................................................................. 11
2.3.4 Stop Method .............................................................................................................. 12
2.3.5 SetSymbol Method.................................................................................................... 12
2.3.6 IsRunning Property ................................................................................................... 13
2.4 Compiling Binary Script Files ............................................................................... 13