Teledyne WaveRunner User Manual
Automation Command
Reference Manual
for
WaveRunner Oscilloscopes
LeCroy Corporation
700 Chestnut Ridge Road
Chestnut Ridge, NY, 10977-6499
Tel: (845) 578-6020, Fax: (845) 578 5985
Internet: www.lecroy.com
© 2010 by LeCroy Corporation. All rights reserved.
LeCroy and other product or brand names are trademarks or requested trademarks of their respective holders. Information in this publication supersedes all earlier
versions. Specifications are subject to change without notice.
918500 RevA
AUTOMATION COMMAND REFERENCE MANUAL - INTRODUCTION
Introduction
This manual provides a comprehensive reference of all the commands available to a controlling application when using
WaveRunner oscilloscopes. Automation enables the controlling application to run on the instrument itself.
PLEASE NOTE THE FOLLOWING:
Available commands include ones for purchased options you may or may not have on your oscilloscope. For more
information, contact your local LeCroy sales office for more information about options available for your instrument.
While we encourage the use of our code examples provided in our manuals, cutting and pasting code samples
directly from this .pdf manual into scripts cause syntax errors (typically illegal ASCII quotation characters). Carefully
review code sample formatting during reuse.
The information in this manual is split into Control and Processor sections, each with their own table of contents.
918500 Rev A
iii
Automation Command and Query Reference Manual - Control Reference Table of Contents
app...........................................................................................................................................................................
1-1
app.Acquisition........................................................................................................................................................
1-7
app.Acquisition.AuxOutput......................................................................................................................................
1-9
app.Acquisition.Channels........................................................................................................................................
1-12
app.Acquisition.Cx...................................................................................................................................................
1-12
app.Acquisition.Cx.Out.Result.................................................................................................................................
1-22
app.Acquisition.Horizontal.......................................................................................................................................
1-22
app.Acquisition.Trigger............................................................................................................................................
1-29
app.Acquisition.Trigger.Cx......................................................................................................................................
1-32
app.Acquisition.Trigger.Digital.................................................................................................................................
1-34
app.Acquisition.Trigger.Ext.....................................................................................................................................
1-35
app.Acquisition.Trigger.Serial.................................................................................................................................
1-37
app.Acquisition.Trigger.Serial.I2C...........................................................................................................................
1-38
app.Acquisition.Trigger.Serial.Protocol (Standard = "CAN")...................................................................................
1-41
app.Acquisition.Trigger.Serial.Protocol (Standard = "FLX")....................................................................................
1-44
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2C").....................................................................................
1-49
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2S").....................................................................................
1-51
app.Acquisition.Trigger.Serial.Protocol (Standard = "LIN").....................................................................................
1-54
app.Acquisition.Trigger.Serial.Protocol (Standard = "MIL1553").............................................................................
1-56
app.Acquisition.Trigger.Serial.Protocol (Standard = "RS232")................................................................................
1-69
app.Acquisition.Trigger.Serial.Protocol (Standard = "SPI").....................................................................................
1-72
app.Acquisition.Trigger.Serial.Protocol (Standard = "UART").................................................................................
1-74
app.Cursors.............................................................................................................................................................
1-77
app.Display..............................................................................................................................................................
1-79
app.ElectricalTelecom.............................................................................................................................................
1-90
app.ElectricalTelecom.ET.......................................................................................................................................
1-95
app.ElectricalTelecom.ET.Out.Result.....................................................................................................................
1-98
app.HardCopy.........................................................................................................................................................
1-99
app.LabNotebook....................................................................................................................................................
1-102
app.LogicAnalyzer...................................................................................................................................................
1-107
app.LogicAnalyzer.Digitalx......................................................................................................................................
1-110
app.LogicAnalyzer.Digitalx.Out.Result....................................................................................................................
1-112
app.LogicAnalyzer.Trigger.......................................................................................................................................
1-112
app.Math..................................................................................................................................................................
1-123
app.Math.Functions.................................................................................................................................................
1-124
app.Math.Fx............................................................................................................................................................
1-124
app.Math.Fx.Operator1Setup..................................................................................................................................
1-134
iv
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.Math.Fx.Out.Result..........................................................................................................................................
1-134
app.Math.Fx.Zoom..................................................................................................................................................
1-135
app.Math.XY............................................................................................................................................................
1-136
app.Math.XY.Out.Result..........................................................................................................................................
1-142
app.Measure...........................................................................................................................................................
1-142
app.Measure.Measure............................................................................................................................................
1-148
app.Measure.PRemote.histo.Result........................................................................................................................
1-148
app.Measure.PRemote.last.Result..........................................................................................................................
1-148
app.Measure.PRemote.max.Result........................................................................................................................
1-148
app.Measure.PRemote.mean.Result......................................................................................................................
1-148
app.Measure.PRemote.min.Result.........................................................................................................................
1-148
app.Measure.PRemote.num.Result........................................................................................................................
1-148
app.Measure.PRemote.sdev.Result........................................................................................................................
1-149
app.Measure.PRemote.Statistics............................................................................................................................
1-149
app.Measure.Px......................................................................................................................................................
1-149
app.Measure.Px.histo.Result..................................................................................................................................
1-157
app.Measure.Px.last.Result....................................................................................................................................
1-157
app.Measure.Px.max.Result...................................................................................................................................
1-157
app.Measure.Px.mean.Result.................................................................................................................................
1-157
app.Measure.Px.min.Result....................................................................................................................................
1-157
app.Measure.Px.num.Result...................................................................................................................................
1-157
app.Measure.Px.Operator.......................................................................................................................................
1-157
app.Measure.Px.Out.Result....................................................................................................................................
1-157
app.Measure.Px.sdev.Result..................................................................................................................................
1-158
app.Measure.Px.Statistics.......................................................................................................................................
1-158
app.Memory.............................................................................................................................................................
1-158
app.Memory.Memories............................................................................................................................................
1-158
app.Memory.Mx.......................................................................................................................................................
1-158
app.Memory.Mx.Out.Result.....................................................................................................................................
1-161
app.Memory.Mx.Zoom............................................................................................................................................
1-162
app.PassFail............................................................................................................................................................
1-163
app.PassFail.LastPass.Result.................................................................................................................................
1-165
app.PassFail.NumPassed.Result............................................................................................................................
1-165
app.PassFail.Qx......................................................................................................................................................
1-165
app.PassFail.Qx.Out.Result....................................................................................................................................
1-170
app.PassFail.Rate.Result........................................................................................................................................
1-170
app.PassFail.Tests.Result.......................................................................................................................................
1-170
v
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.Preferences......................................................................................................................................................
1-170
app.Preferences.EMail............................................................................................................................................
1-172
app.RecallSetupLock..............................................................................................................................................
1-173
app.SaveRecall.......................................................................................................................................................
1-173
app.SaveRecall.Setup.............................................................................................................................................
1-174
app.SaveRecall.Table.............................................................................................................................................
1-178
app.SaveRecall.Utilities...........................................................................................................................................
1-179
app.SaveRecall.Waveform......................................................................................................................................
1-180
app.SDA..................................................................................................................................................................
1-185
app.SDA.BadBits.....................................................................................................................................................
1-200
app.SDA.BadBits.Out.Result...................................................................................................................................
1-208
app.SDA.Bits...........................................................................................................................................................
1-208
app.SDA.Bits.Out.Result.........................................................................................................................................
1-210
app.SDA.Eye...........................................................................................................................................................
1-210
app.SDA.Eye.Out.Result.........................................................................................................................................
1-213
app.SDA.FindFreqReference..................................................................................................................................
1-213
app.SDA.FindFreqReference.Out.Result................................................................................................................
1-213
app.SDA.FindFreqStream.......................................................................................................................................
1-213
app.SDA.FindFreqStream.Out.Result.....................................................................................................................
1-214
app.SDA.FindLevelReference.................................................................................................................................
1-214
app.SDA.FindLevelReference.Out.Result...............................................................................................................
1-215
app.SDA.FindLevelStream......................................................................................................................................
1-215
app.SDA.FindLevelStream.Out.Result....................................................................................................................
1-215
app.SDA.Mask2Hits................................................................................................................................................
1-215
app.SDA.Mask2Hits.Out.Result..............................................................................................................................
1-215
app.SDA.Mask2Out.................................................................................................................................................
1-216
app.SDA.Mask2Out.Out.Result...............................................................................................................................
1-216
app.SDA.MaskHits..................................................................................................................................................
1-216
app.SDA.MaskHits.Out.Result................................................................................................................................
1-216
app.SDA.MaskOut...................................................................................................................................................
1-216
app.SDA.MaskOut.Out.Result.................................................................................................................................
1-217
app.SDA.PRBS.......................................................................................................................................................
1-217
app.SDA.PRBS.Out.Result.....................................................................................................................................
1-220
app.SDA.SDAStatus...............................................................................................................................................
1-220
app.SDA.TIE...........................................................................................................................................................
1-220
app.SDA.TIE.Out.Result.........................................................................................................................................
1-223
app.SDA.TIEF.........................................................................................................................................................
1-223
vi
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA.TIEF.Out.Result.......................................................................................................................................
1-224
app.SerialDecode....................................................................................................................................................
1-224
app.SerialDecode.Decode[n].Protocol (Protocol = "8B10B")..................................................................................
1-224
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioI2S")..............................................................................
1-225
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioLJ")................................................................................
1-228
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioRJ")...............................................................................
1-231
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioTDM")............................................................................
1-234
app.SerialDecode.Decode[n].Protocol (Protocol = "CAN").....................................................................................
1-236
app.SerialDecode.Decode[n].Protocol (Protocol = "CANHL").................................................................................
1-237
app.SerialDecode.Decode[n].Protocol (Protocol = "FLX")......................................................................................
1-238
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANHL")...........................................................................
1-240
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANLAN")........................................................................
1-240
app.SerialDecode.Decode[n].Protocol (Protocol = "I2C").......................................................................................
1-241
app.SerialDecode.Decode[n].Protocol (Protocol = "LIN").......................................................................................
1-243
app.SerialDecode.Decode[n].Protocol (Protocol = "MIL1553")...............................................................................
1-243
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE1X1")..............................................................................
1-245
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE1X2")..............................................................................
1-246
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE4X1")..............................................................................
1-247
app.SerialDecode.Decode[n].Protocol (Protocol = "RS232")..................................................................................
1-248
app.SerialDecode.Decode[n].Protocol (Protocol = "SIOP")....................................................................................
1-250
app.SerialDecode.Decode[n].Protocol (Protocol = "SPI").......................................................................................
1-253
app.SerialDecode.Decode[n].Protocol (Protocol = "SPICustom")...........................................................................
1-256
app.SerialDecode.Decode[n].Protocol (Protocol = "SPIDDR")...............................................................................
1-259
app.SerialDecode.Decode[n].Protocol (Protocol = "SSPI").....................................................................................
1-262
app.SerialDecode.Decode[n].Protocol (Protocol = "UART")...................................................................................
1-265
app.SerialDecode.Decode[n].Protocol (Protocol = "USART").................................................................................
1-266
app.SerialDecode.Decodex.....................................................................................................................................
1-269
app.SerialDecode.Decodex.Decode.......................................................................................................................
1-274
app.SerialDecode.Decodex.Out.Result...................................................................................................................
1-275
app.SerialDecode.FlexRayMeasure........................................................................................................................
1-275
app.SerialDecode.FLXEye......................................................................................................................................
1-277
app.SerialDecode.FLXEye.Out.Result....................................................................................................................
1-281
app.SerialDecode.Measure.....................................................................................................................................
1-281
app.SpecAnalyzer...................................................................................................................................................
1-287
app.SpecAnalyzer.SpecAn......................................................................................................................................
1-290
app.SpecAnalyzer.SpecAn.Out.Result....................................................................................................................
1-293
app.SpecAnalyzer.SpecAnTable.............................................................................................................................
1-293
vii
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SpecAnalyzer.SpecAnTable.Out.Result...........................................................................................................
1-294
app.SystemControl..................................................................................................................................................
1-294
app.Utility.DateTimeSetup.......................................................................................................................................
1-294
app.Utility.Options...................................................................................................................................................
1-298
app.Utility.Remote...................................................................................................................................................
1-299
app.Utility.Remote.IOManager.CIOPortU3GPIB.....................................................................................................
1-300
app.Utility.Remote.IOManager.CLSIBPort..............................................................................................................
1-300
app.WaveScan........................................................................................................................................................
1-300
app.WaveScan.ScanDecode..................................................................................................................................
1-301
app.WaveScan.ScanDecode.Out.Result................................................................................................................
1-301
app.WaveScan.ScanHisto......................................................................................................................................
1-302
app.WaveScan.ScanHisto.Histogram.....................................................................................................................
1-304
app.WaveScan.ScanHisto.Out.Result....................................................................................................................
1-306
app.WaveScan.ScanHisto.Zoom............................................................................................................................
1-306
app.WaveScan.ScanOverlay..................................................................................................................................
1-307
app.WaveScan.ScanOverlay.Out.Result................................................................................................................
1-309
app.WebEditor.........................................................................................................................................................
1-309
app.XPort.................................................................................................................................................................
1-311
app.Zoom................................................................................................................................................................
1-311
app.Zoom.Zx...........................................................................................................................................................
1-313
app.Zoom.Zx.Out.Result.........................................................................................................................................
1-317
app.Zoom.Zx.Zoom.................................................................................................................................................
1-317
viii
918500 RevA
Automation Command and Query Reference Manual - Control Reference
LECROY.XSTREAMDSO
app
This is the root of the automation hierarchy, all other nodes are accessed from this point.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Popup a dialog containing the instrument model
MsgBox "Model is: " & app.InstrumentModel
Example
AutoSetup
Action
Starts an AutoSetup operation. When input channels are visible, AutoSetup operates only on those
visible channels. If no channels are visible, all channels are affected by AutoSetup. With more than
one channel visible, the first visible channel in numerical order, that has a detectable signal applied to
it, is automatically set up for edge triggering.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Start an Auto-Setup process.
app.AutoSetup
Example
AutoSetup
Action
ClearSweeps
Action
Exit
Action
FirmwareVersion
String
Height
Property
HideClock
Bool
InstrumentID
String
InstrumentModel
String
Left
Property
Maximize
Action
Minimize
Action
Quit()
Method
ResetPreferences
Action
Restore
Action
SetToDefaultSetup
Action
Shutdown
Action
Sleep([in] double timeoutMilliseconds)
Method
Top
Property
TouchScreenEnable
Bool
WaitUntilIdle([in] double timeoutSeconds)
Method
Width
Property
Windowed
Action
WindowState
Property
1-1
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
Clears all accumulated sweeps for all subsystems. These include Channel Pre-Processing, Math,
Measure, and Display Persistence. Note that subsystem-specific clear sweeps controls are also
available. For the details please refer to the ClearSweeps control for each subsystem.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Clear all accumulated sweeps for all subsystems.
app.ClearSweeps
Example
Exit
Action
Equivalent to app.Quit() method.
Description
FirmwareVersion
String
Any number of characters
Range
Queries the firmware version of the instrument in the form - "1.0.0 (build 12345)"
Description
' Microsoft Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Query the firmware version number of the instrument.
MsgBox "Firmware Version is: " + app.FirmwareVersion
Example
Height
Property
Sets/Queries the height in pixels of the instrument display on the PC screen.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the height of the instrument window to 400 pixels.
app.Height = 400
Example
HideClock
Bool
Hides/Shows the clock that resides in the lower-right corner of the display of the instrument.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Hide the clock for 3 seconds.
app.HideClock = True
app.Sleep(3000)
app.HideClock = False
Example
1-2
918500 RevA
Automation Command and Query Reference Manual - Control Reference
InstrumentID
String
Any number of characters
Range
Reads the complete ID of the instrument in the format: "LECROY,WM8500,WM000001,0.0.0",
which includes the maker, the instrument model number, the serial number, and the version number.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Present the ID of the instrument.
MsgBox app.InstrumentID
Example
InstrumentModel
String
Any number of characters
Range
Queries the model number of the instrument.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Present the model number of the instrument.
MsgBox app.InstrumentModel
Example
Left
Property
Sets/Queries the position in pixels of the left edge of the instrument display on the PC screen. The
position is measured from the left edge of the screen to the left edge of the instrument window.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the position of the left edge of the instrument window to 100 pixels.
app.Left = 100
Example
Maximize
Action
Maximize the instrument window to fill the underlying desktop.
Equivalent to app.WindowState = 1
Description
1-3
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Minimize
Action
Minimizes the instrument window to reveal the underlying desktop. It will display a small window in the
bottom right corner of the display, which when clicked will restore the window to full-screen mode. To
programmatically restore the window refer to the app.WindowState control.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Minimize the instrument display.
app.Minimize
Example
Quit()
Method
Closes the instrument application. The instrument will prompt the user with an 'Are you sure?' dialog
before closing down. Note that until the user responds to the dialog, control via Automation will be
blocked.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Quit the instrument application with a confirmation prompt.
app.Quit
Example
ResetPreferences
Action
Resets all scope preferences to their default states. The set includes the current remote
communications port, the color palette settings, etc. but does not include the main DSO controls such
as V/Div, T/Div, etc. These main instrument controls can be reset using the SetToDefaultSetup control.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Reset all instrument preferences.
app.ResetPreferences
Example
Restore
Action
Restore the instrument display to its position and size before the last minimize request.
Description
1-4
918500 RevA
Automation Command and Query Reference Manual - Control Reference
SetToDefaultSetup
Action
Restores the instrument setup to its default state. Note that certain settings will not be restored to the
default state. These are the user preferences, such as the current remote communications port, and
the color settings, which may be reset, if required, using the ResetPreferences action.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Restore the instrument to its default state.
app.SetToDefaultSetup
Example
Shutdown
Action
Shuts down the instrument. It will prompt the user with an 'Are you sure?' dialog before shutting down.
Note that until the user responds to the dialog, control via Automation will be blocked.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Shut down the instrument with a confirmation prompt.
app.Shutdown
Example
Sleep([in] double timeoutMilliseconds)
Method
Causes the main execution thread of the instrument application to sleep for the specified time period,
defined in milliseconds.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
MsgBox "Sleeping for 10 seconds..."
app.Sleep(10000)
MsgBox "Sleep finished"
Example
Top
Property
Sets/Queries the position in pixels of the top edge of the instrument display on the PC screen. The
position is measured downwards from the top of the screen to the top of the instrument window.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the position of the top edge of the instrument window to 100 pixels.
app.Top = 100
Example
1-5
918500 RevA
Automation Command and Query Reference Manual - Control Reference
TouchScreenEnable
Bool
Sets/Queries the state of the touch-screen enable control. This is equivalent to the front-panel Touch
Screen button.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Disable touch-screen if it is enabled.
if app.TouchScreenEnable = True then
app.TouchScreenEnable = False
End if
Example
WaitUntilIdle([in] double timeoutSeconds)
Method
Waits until either the application is idle or the specified timeout expires, specified in seconds. This
evaluates to True if the application completes before the timeout expires, and to False if a timeout
occurs.
When Trigger mode is Auto or Run, the application is never Idle. In this case the call to WaitUntilIdle
returns after the next acquisition and any configured processing.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Wait with a timeout of five seconds.
app.WaitUntilIdle(5)
Example
Width
Property
Sets/Queries the width in pixels of the instrument display on the PC screen.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the width of the instrument window to 800 pixels.
app.Width = 800
Example
Windowed
Action
Places the instrument application in windowed mode (as opposed to full-screen mode). Places the
application in the upper-part of the display screen with a sizable border.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument display into the windowed mode.
app.Windowed
Example
1-6
918500 RevA
Automation Command and Query Reference Manual - Control Reference
WindowState
Property
Sets/Queries the state of the PC window used by the instrument display.
0 windowed
1 full screen
2 minimized
Trying to set values greater than 2 or less than 0 will result in the value 0 (windowed) being set.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument window state to windowed.
app.WindowState = 0
Example
ACQUISITION
app.Acquisition
This group of variables controls the input channels C1, C2, C3 and C4, the timebase, the trigger, and the Aux Output.
Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in this section of
the manual. Examples of alias pairs are as follows -
app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx
app.Acquisition.Channels(1) is equivalent to app.Acquisition.C1
app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
Acquire([in] double timeoutSeconds, [in] long bForceTriggerOnTimeout)
Method
Action/Query. Takes a single acquisition. The first of the two arguments specifies a timeout; the
second, which is optional, specifies whether or not to force a trigger when the timeout occurs.
Evaluates to True if a trigger occurred, or False if a timeout occurred.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Start an acquisition, wait for up to 5 seconds for a trigger
' event, force a software trigger if a hardware trigger is not
' detected before the 5 second timeout expires.
triggerDetected = app.Acquisition.Acquire(5, true)
Example
Acquire([in] double timeoutSeconds, [in] long bForceTriggerOnTimeout)
Method
Calibrate
Action
CalibrateAll
Action
CalNeeded
Integer
ClearSweeps
Action
HorOffset
Double
TriggerMode
Enum
1-7
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Calibrate
Action
Initiates a full calibration of the acquisition system of the instrument.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Start a calibration.
app.Acquisition.Calibrate
Example
CalibrateAll
Action
CalNeeded
Integer
From -2147483648 to 2147483647 step 1
Range
Query: Indicates whether calibration is required or not.
Based on hexadecimal bit value, it provides following information:
0x00000001: Front end calibration is required
0x00000002: Digitizers delay matching is required
0x00000004: Digitizers gain matching is required
0x00000008: Trigger level calibration is required
0xFFFFFFFF(-1): All of above calibrations are required
Description
ClearSweeps
Action
Resets any accumulated average data or persistence data for channel waveforms (C1..C4). Valid only
when one or more channels have waveform averaging or persistence enabled in their pre-processing
settings. Note that an average may be reset on an individual basis using
app.Acquisition.Cx.ClearSweeps control.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Clear accumulated sweeps for channels C1...C4
app.Acquisition.ClearSweeps
' Clear accumulated sweeps for only C1
app.Acquisition.C1.ClearSweeps
Example
HorOffset
Double
From -2.5e-007 to 2.5e-007 step 1e-009
Range
same as "app.Acquisition.Horizontal.HorOffset.cvar"
Description
1-8
918500 RevA
Automation Command and Query Reference Manual - Control Reference
TriggerMode
Enum
Sets/Queries the trigger mode, using values from the following list Auto, Norm, Normal, Single, Stopped.
Auto: After a timeout, if a real hardware trigger is not received, then force a trigger so there are
automatically lots of updates.
Normal: Accepts triggers as rapidly as the system permits, but likewise will wait "forever" for a trigger,
without updating anything.
Single: Arm the acquisition system to acquire once, and do not rearm automatically after. Once a
trigger is received and the data processed, the instrument finishes in the "Stopped" state.
Stop: Finishes the current acquisition and does not re-arm.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Place the instrument in stopped mode and take one acquisition.
app.Acquisition.TriggerMode = "Stopped"
app.Acquisition.Acquire(5)
Example
Values
Auto
Auto-trigger
Normal
Normal Trigger
Single
Single Trigger
Stopped
No trigger possible, Stopped
AUXOUTPUT
app.Acquisition.AuxOutput
Controls for the Auxilliary output BNC, which can be programmed as a simple square-wave signal source, or as a
pulse which is asserted when various events occur, including Trigger Enabled, Trigger Out, and Pass/Fail.
' Microsoft Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Setup the Auxiliary output to be a squarewave with an amplitude
' of 500mV a frequency of 5kHz
app.Acquisition.AuxOutput.Mode = "Square"
app.Acquisition.AuxOutput.Amplitu
Example
Amplitude
Double
From 0.05 to 1 step 0.001
Range
Amplitude
Double
AuxInCoupling
Enum
AuxMode
Enum
CalMode
Enum
Frequency
DoubleLockstep
Mode
Enum
1-9
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Sets/Queries the amplitude of the signal on the AUX OUT connector. Note that this is the amplitude of
the signal into a 1Mohm load. Into 50 ohms the output voltage will be halved (since the source
impedance is nominally 50 ohms). Units are Volts.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the amplitude of the signal from the AUX OUT connector
' to 0.6 V into 1 megohm, or 0.3 V into 50 ohms.
app.Acquisition.AuxOutput.Amplitude = 0.6
Example
AuxInCoupling
Enum
Sets the input coupling for the Auxiliary input path.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the coupling of the Auxiliary socket, when used as an input, to
ground.
' In this condition, no input signal reaches the instrument.
app.Acquisition.AuxOutput.AuxInCoupling = "GND"
Example
Values
DC50
DC, 50ohms coupling
GND
Grounded
AuxMode
Enum
Configures AUX Output type in WR and WS series of scopes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the Auxiliary output to trigger output signal.
app.Acquisition.AuxOutput.AuxMode = "TriggerOut"
Example
Values
Off
No output
PassFail
Pulse on Pass fail condition
TriggerEnabled
Trigger enabled signal from trigger circuitry.
TriggerOut
Internal trigger output signal from trigger circuitry
1-10
918500 RevA
Automation Command and Query Reference Manual - Control Reference
CalMode
Enum
Configures Cal Output type in WR and WS series of scopes.
Description
' Follwoing example will set CAL output to 1 KHz, 0.5V square wave.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set cal output to Square wave
app.Acquisition.AuxOutput.CalMode = "Square"
' Set cal output amplitude to 0.5 V with 1 MOhm impedence
app.Acquisition.AuxOutput.Amplitude = "0.5"
' Set cal output frequency to 1 KHz
app.Acquisition.AuxOutput.Frequency = "1000"
Example
Values
DCLevel
DC Level with 1 Mohm o/p impedence
Off
Off
Square
Square wave
Frequency
DoubleLockstep
From 250 to 1e+006 step 10, locked to 1 2.5 5, fine grain allowed=false, on=false
Range
This control only has effect when the AuxOutput mode is "Square".
Sets/Queries the auxiliary output frequency of the squarewave. Units are Hertz.
Note that WaveMaster models (and derivatives) have a limit of 5MHz, WavePro 7000 models (and
derivatives) have a limit of 1MHz.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the frequency of the signal from the AUX OUT
' connector to 1 MHz.
app.Acquisition.AuxOutput.Frequency = 1e6
Example
1-11
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Mode
Enum
Sets/Queries the output mode of the AUX OUT connector. (Applicable to WM, SDA, DDA, WP series
of scopes)
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the output of the AUX OUT connector to output
' a pulse on a pre-determined Pass-Fail decision.
app.Acquisition.AuxOutput.Mode = "PassFail"
Example
Values
DCLevel
Emit a DC level
Off
Output Disabled
PassFail
Pulse-out controlled by Pass/Fail system
Square
Square-wave signal generator
TriggerEnabled
Pulse-out when trigger is enabled
TriggerOut
Pulse-out when trigger occurs
CHANNELS
app.Acquisition.Channels
This group of variables controls the acquisition channels C1, C2, C3 and C4.
Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Acquisition. Examples of alias pairs are as follows app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx
app.Acquisition.Channels(1) is equivalent to app.Acquisition.C1
app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
Set app = CreateObject("LeCroy.XStreamDSO")
For X = 1 To 4
app.Acquisition.Channels(X).VerScale = 0.2
Next
Example
CX
app.Acquisition.Cx
This group of variables controls the input channels C1, C2, C3 and C4.
Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Acquisition. Examples of alias pairs are as follows app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx
app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
AverageSweeps
Integer
AxisXRotation
Integer
AxisYRotation
Integer
BandwidthLimit
Enum
ClearSweeps
Action
1-12
918500 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Setup Channel C1
app.Acquisition.C1.VerScale = 0.5
app.Acquisition.C1.VerOffset = 0.0
app.Acquisition.C1.Coupling = "DC50"
' Setup Channel C2
app.Acquisition.C2.VerScale = 0.1
Example
AverageSweeps
Integer
From 1 to 1000000 step 1
Range
Sets/Queries the number of averaging sweeps for input channel Cx. This is distinct from the math
function app.Math.Fx. If the number of sweeps is 1 (the default value), the data will not be averaged.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the number of sweeps for channel C1 to 25.
app.Acquisition.C1.AverageSweeps = 25
Example
Coupling
Enum
Deskew
Double
EnhanceResType
Enum
FindScale
Action
InterpolateType
Enum
Invert
Bool
LabelsPosition
String
LabelsText
String
Persist3DQuality
Enum
Persisted
Bool
Persistence3d
Bool
PersistenceMonoChrome
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ProbeAttenuation
Double
ProbeName
String
ShowLastTrace
Bool
UseGrid
String
VerOffset
Double
VerScale
DoubleLockstep
VerScaleVariable
Bool
View
Bool
ViewDecode
Bool
ViewLabels
Bool
1-13
918500 RevA
Automation Command and Query Reference Manual - Control Reference
AxisXRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the state of the X Axis rotation control, used only in 3-D persistence modes to control the
viewing position. See the general description above for a discussion of the locked and unlocked
persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the X-axis to 35 degrees for trace C3.
app.Acquisition.C3.AxisXRotation = 35
Example
AxisYRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the state of the Y Axis rotation control, used only in 3-D persistence modes to control the
viewing position. See the general description above for a discussion of the locked and unlocked
persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the Y-axis to 25 degrees for trace C3.
app.Acquisition.C3.AxisYRotation = 25
Example
BandwidthLimit
Enum
Sets/Queries the bandwidth limit for input channel Cx, in Hz. Note that this control is an enum, and
therefore requires a string value, and not a scalar value.
Note that bandwidth limit choices vary between DSO models.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the bandwidth limit for C2 to 20 MHz.
app.Acquisition.C2.BandwidthLimit = "20MHz"
Example
Values
200MHz
20MHz
Full
1-14
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
Clears all accumulated average data and persistence data for this channel. See
app.Acquisition.ClearSweeps for a control that clears accumulated data for channels 1..4, or
app.ClearSweeps for a control that clears accumulated data for all subsystems (including
Math/Measure/Display, etc.)
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Reset channel C1
app.Acquisition.C1.ClearSweeps
' Reset channels C1..C4
app.Acquisition.ClearSweeps
Example
Coupling
Enum
Sets/Queries the input coupling of input channel Cx.
Note that coupling choices vary between instrument models. WavePro 7000 instruments for example
support AC1M and DC1M modes in addition to DC50 and GND choices.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Inspect the input coupling for channel C2
CoupleC2 = app.Acquisition.C2.Coupling
' Set the coupling to DC, 50 ohms
app.Acquisition.C2.Coupling = "DC50"
Example
Values
AC1M
DC1M
DC50
Gnd
Deskew
Double
From -4.5e-007 to 4.5e-007 step 1e-012
Range
Sets/Queries the deskew of input channel Cx to produce a required alignment with another trace.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
Example
1-15
918500 RevA
Automation Command and Query Reference Manual - Control Reference
EnhanceResType
Enum
Enhance resolution setting (Noise Filter). Set to 'None' to turn off the filter.
Description
Values
0.5bits
1.5bits
1bits
2.5bits
2bits
3bits
None
FindScale
Action
Starts FindScale operation for this chanel. This operation will adjust channel's v/div and offset control
such that the signal is visible on the screen with in +/- 3 div.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
'Find vertical scale of channel 1
app.Acquisition.C1.FindScale
Example
InterpolateType
Enum
Sets/Queries the type of interpolation used for input channel Cx. Note that Sinx/x interpolation
increases the size of the trace by a factor of 10, beware when using this option with long records.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the interpolation for channel C3 to (sin x)/x
app.Acquisition.C3.InterpolateType = "Sinxx"
Example
Values
Linear
Linear interpolation
Sinxx
Sinx/x interpolation
Invert
Bool
Sets/Queries whether input channel Cx is inverted.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set channel C2 to be inverted.
app.Acquisition.C2.Invert = True
Example
1-16
918500 RevA
Automation Command and Query Reference Manual - Control Reference
LabelsPosition
String
Any number of characters
Range
Sets / Queries the horizontal position of the label attached to the acquisition trace Cx. The unit of
measurement is the unit of the horizontal scale. The measurement is made from the trigger point.
Note that this control is a string, not a numeric value. This allows multiple labels to be positioned, as
shown in the example below.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Add a couple of labels to trace C1, one at 0ns, and one at 55ns
app.SetToDefaultSetup
app.Acquisition.C1.ViewLabels = True
app.Acquisition.C1.LabelsPosition = "0.0,55e-9"
app.Acquisition.C1.LabelsText = "Hello,World"
Example
LabelsText
String
Any number of characters
Range
Persist3DQuality
Enum
Sets/Queries the state of the 3D Persistence quality control, which controls the way that the
persistence trace is rendered. See the general description above for a discussion of the locked and
unlocked persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence 3-D to shaded for trace C2.
app.Acquisition.C2.Persist3DQuality = "Shaded"
Example
Values
Shaded
Solid
WireFrame
1-17
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Persisted
Bool
Sets/Queries the persisted state of the waveform. If the Display.LockPersistence control is set to
'AllLocked' then the persisted state of all displayed waveforms will be the same. If the
Display.LockPersistence control is set to 'PerTrace' then the persisted state of each waveform may be
independently controlled.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence on for trace C1
app.Display.LockPersistence = "PerTrace"
app.Acquisition.C1.Persisted = True
Example
Persistence3d
Bool
Sets/Queries the 3D persistence state. If True, then the persistence display for this channel will be
displayed as a three dimensional surface map. See the general description above for a discussion of
the locked and unlocked persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence plot as 3-D for trace C1
app.Acquisition.C1.Persistence3D = True
Example
PersistenceMonoChrome
Bool
Sets/Queries the monochrome persistence state. If True, then the persistence display for this channel
will be monochromatic, whether 2-D or 3-D. See the general description above for a discussion of the
locked and unlocked persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence monochrome on for trace C4.
app.Acquisition.C4.PersistenceMonoChrome = True
Example
PersistenceSaturation
Integer
From 0 to 100 step 1
Range
Sets/Queries the saturation threshold for persisted waveforms.
All information at this level or above will be recorded with the same color or intensity.
See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence saturation level for trace C1.
app.Acquisition.C1.PersistenceSaturation = 60
Example
1-18
918500 RevA
Automation Command and Query Reference Manual - Control Reference
PersistenceTime
Enum
Sets/Queries the state of the Persistence Time control. Controls the persistence decay time for this
trace. See the general description above for a discussion of the locked and unlocked persistence
modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence time for the persistence trace of channel C1 to 10
seconds.
app.Acquisition.C1.PersistenceTime = "10s"
Example
Values
0.5s
10s
1s
20s
2s
5s
Infinite
ProbeAttenuation
Double
From 1e-006 to 10000 step 1e-006
Range
Sets/Queries the probe attenuation. The probe attenuation is the factor by which the signal is made
smaller, for example, 10 means that the probe divides by 10, and is referred to as a ÷10 probe. Note
that certain passive probes may be marked as 'x10', even though they actually divide the input signal
by a factor of 10.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the probe attenuation for channel C1 to 100
app.Acquisition.C1.ProbeAttenuation = 100
Example
ProbeName
String
Any number of characters
Range
Queries the name of connected probe.
Description
1-19
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ShowLastTrace
Bool
Sets/Queries the state of the Show Last Trace control. If True then when this trace is displayed in
persistence mode the last acquired waveform will be superimposed on the accumulating persistence
map.
See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Makes the last acquired trace invisible for the
' persistence trace of channel C1.
app.Acquisition.C1.ShowLastTrace = False
Example
UseGrid
String
Any number of characters
Range
Sets/Queries the graticule on which the trace is displayed. Typical values include:
YT1..YT8: one of the YT graticules used in Single, Dual, Quad, and Octal display modes.
NotOnGrid: not displayed on any graticule.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Switch to dual grid mode, place C1 on the lower graticule
' and C2 on the upper graticule.
app.Display.GridMode = "Dual"
app.Acquisition.C1.UseGrid = "YT2"
app.Acquisition.C2.UseGrid = "YT1"
Example
VerOffset
Double
From -1 to 1 step 0.0005
Range
Sets/Queries the vertical offset of input channel Cx. The setting resolution in volts lies in the range
0.25% to 0.5%, depending on the numerical value.
Note that the available offset range is dependent upon the current V/Div setting, and also the
instrument model.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the vertical offset for C1 to 10 mV.
app.Acquisition.C1.VerOffset = 0.01
Example
1-20
918500 RevA
Automation Command and Query Reference Manual - Control Reference
VerScale
DoubleLockstep
From 0.002 to 10 step 0.0005, locked to 1 2 5, fine grain allowed=true, on=false
Range
Sets/Queries the vertical scale (in Volts/Division) of an input channel. When variable gain
(VerScaleVariable control) is disabled, the control will clip values to a 1..2..5 sequence. When variable
gain is enabled, the setting resolution lies in the range 1% to 2%, depending upon the numerical value.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set C1 to a scale of 250mV/Div in Variable Scale mode
app.Acquisition.C1.VerScaleVariable = True
app.Acquisition.C1.VerScale = 0.25
Example
VerScaleVariable
Bool
Sets/Queries the state of the variable vertical scale control for channel Cx. When the variable scale is
enabled, the setting resolution lies in the range 1% to 2%, depending on the numerical value. If a
knowledge of the exact value is important, the value should be read back after a setting has been
made.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the variable vertical scale for C1 to On.
app.Acquisition.C1.VerScaleVariable = True
Example
View
Bool
Sets/Queries the channel's 'Viewed' state. When True the channel waveform is displayed on one of
the display graticules. Note that even when a channel is not visible it may be used as a source for
Math, Measure, etc.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Make channel C3 visible.
app.Acquisition.C3.View = True
Example
ViewDecode
Bool
1-21
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ViewLabels
Bool
Sets/Queries whether the user-defined labels for the trace are visible.
See Also: LabelsPosition and LabelsText controls.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Show the user-defined label for trace C2.
app.Acquisition.C2.ViewLabels = True
Example
RESULT
app.Acquisition.Cx.Out.Result
Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other
controls are changed after that acquisition was completed. This distinction between "Out.Result" properties and other
controls is most important when the trigger mode is Single or Stopped. You should treat "Out.Result" properties as
read-only.
Several of these properties mention the 'frame', this is the term used to describe the visible portion of the trace, which
is generally smaller than the acquired waveform. The frame could be used for example to display a 500pt. window
onto a 1Mpt. Trace, or vertically it could be used to show the 'center' 10mV of a 100mV pk trace.
For a full overview of the properties of waveform (or other ) results, please see Chapter 1.
HORIZONTAL
app.Acquisition.Horizontal
This group of variables controls the timebase, the sampling, and the trigger delay.
AcquiredSegments
Integer
AcquisitionDuration
Double
ActiveChannels
Enum
ExtClockFrequency
Double
ExtCoupling
Enum
HorOffset
Double
HorOffsetOrigin
Double
HorScale
DoubleLockstep
HorUnits
String
MaxSamples
DoubleLockstep
NumPoints
Integer
NumSegments
Integer
ReferenceClock
Enum
SampleClock
Enum
SampleMode
Enum
SamplingRate
Double
SequenceTimeout
Double
SequenceTimeoutEnable
Bool
SetExtClockFrequency
Bool
1-22
918500 RevA
Loading...