Automation Command
Reference Manual
for
WaveSurfer 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.
918499 RevA
AUTOMATION COMMAND REFERENCE MANUAL - INTRODUCTION
918499 Rev A
iii
Introduction
This manual provides a comprehensive reference of all the commands available to a controlling application when using
WaveSurfer 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.
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-11
app.Acquisition.Cx...................................................................................................................................................
1-11
app.Acquisition.Cx.Out.Result.................................................................................................................................
1-20
app.Acquisition.Horizontal.......................................................................................................................................
1-20
app.Acquisition.Trigger............................................................................................................................................
1-26
app.Acquisition.Trigger.Cx......................................................................................................................................
1-28
app.Acquisition.Trigger.Ext.....................................................................................................................................
1-30
app.Acquisition.Trigger.Serial.................................................................................................................................
1-32
app.Acquisition.Trigger.Serial.I2C...........................................................................................................................
1-34
app.Acquisition.Trigger.Serial.Protocol (Standard = "CAN")...................................................................................
1-36
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2C").....................................................................................
1-39
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2S").....................................................................................
1-42
app.Acquisition.Trigger.Serial.Protocol (Standard = "LIN").....................................................................................
1-45
app.Acquisition.Trigger.Serial.Protocol (Standard = "MIL1553").............................................................................
1-47
app.Acquisition.Trigger.Serial.Protocol (Standard = "RS232")................................................................................
1-59
app.Acquisition.Trigger.Serial.Protocol (Standard = "SPI").....................................................................................
1-62
app.Acquisition.Trigger.Serial.Protocol (Standard = "UART").................................................................................
1-64
app.Cursors.............................................................................................................................................................
1-67
app.Display..............................................................................................................................................................
1-69
app.ElectricalTelecom.............................................................................................................................................
1-76
app.ElectricalTelecom.ET.......................................................................................................................................
1-80
app.ElectricalTelecom.ET.Out.Result.....................................................................................................................
1-82
app.HardCopy.........................................................................................................................................................
1-82
app.LabNotebook....................................................................................................................................................
1-85
app.LogicAnalyzer...................................................................................................................................................
1-90
app.LogicAnalyzer.Digitalx......................................................................................................................................
1-91
app.LogicAnalyzer.Digitalx.Out.Result....................................................................................................................
1-93
app.LogicAnalyzer.Trigger.......................................................................................................................................
1-93
app.Math..................................................................................................................................................................
1-107
app.Math.Functions.................................................................................................................................................
1-107
app.Math.Fx............................................................................................................................................................
1-107
app.Math.Fx.Operator1Setup..................................................................................................................................
1-114
app.Math.Fx.Out.Result..........................................................................................................................................
1-114
app.Math.Fx.Zoom..................................................................................................................................................
1-115
iv
918499 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.Math.XY............................................................................................................................................................
1-116
app.Math.XY.Out.Result..........................................................................................................................................
1-119
app.Measure...........................................................................................................................................................
1-119
app.Measure.Measure............................................................................................................................................
1-121
app.Measure.PRemote...........................................................................................................................................
1-121
app.Measure.PRemote.histo.Result........................................................................................................................
1-123
app.Measure.PRemote.last.Result..........................................................................................................................
1-123
app.Measure.PRemote.max.Result........................................................................................................................
1-123
app.Measure.PRemote.mean.Result......................................................................................................................
1-123
app.Measure.PRemote.min.Result.........................................................................................................................
1-123
app.Measure.PRemote.num.Result........................................................................................................................
1-123
app.Measure.PRemote.sdev.Result........................................................................................................................
1-123
app.Measure.PRemote.Statistics............................................................................................................................
1-123
app.Measure.Px......................................................................................................................................................
1-123
app.Measure.Px.histo.Result..................................................................................................................................
1-127
app.Measure.Px.last.Result....................................................................................................................................
1-127
app.Measure.Px.max.Result...................................................................................................................................
1-127
app.Measure.Px.mean.Result.................................................................................................................................
1-127
app.Measure.Px.min.Result....................................................................................................................................
1-127
app.Measure.Px.num.Result...................................................................................................................................
1-127
app.Measure.Px.Operator.......................................................................................................................................
1-127
app.Measure.Px.Out.Result....................................................................................................................................
1-127
app.Measure.Px.sdev.Result..................................................................................................................................
1-128
app.Measure.Px.Statistics.......................................................................................................................................
1-128
app.Memory.............................................................................................................................................................
1-128
app.Memory.Memories............................................................................................................................................
1-128
app.Memory.Mx.......................................................................................................................................................
1-128
app.Memory.Mx.Out.Result.....................................................................................................................................
1-131
app.Memory.Mx.Zoom............................................................................................................................................
1-131
app.PassFail............................................................................................................................................................
1-132
app.PassFail.LastPass.Result.................................................................................................................................
1-133
app.PassFail.NumPassed.Result............................................................................................................................
1-134
app.PassFail.Qx......................................................................................................................................................
1-134
app.PassFail.Qx.Out.Result....................................................................................................................................
1-135
app.PassFail.Rate.Result........................................................................................................................................
1-135
app.PassFail.Tests.Result.......................................................................................................................................
1-135
app.Preferences......................................................................................................................................................
1-135
v
918499 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.Preferences.EMail............................................................................................................................................
1-137
app.RecallSetupLock..............................................................................................................................................
1-138
app.SaveRecall.......................................................................................................................................................
1-138
app.SaveRecall.Setup.............................................................................................................................................
1-138
app.SaveRecall.Table.............................................................................................................................................
1-142
app.SaveRecall.Utilities...........................................................................................................................................
1-143
app.SaveRecall.Waveform......................................................................................................................................
1-144
app.SerialDecode....................................................................................................................................................
1-148
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioI2S")..............................................................................
1-149
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioLJ")................................................................................
1-152
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioRJ")...............................................................................
1-154
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioTDM")............................................................................
1-157
app.SerialDecode.Decode[n].Protocol (Protocol = "CAN").....................................................................................
1-160
app.SerialDecode.Decode[n].Protocol (Protocol = "CANHL").................................................................................
1-161
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANHL")...........................................................................
1-162
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANLAN")........................................................................
1-163
app.SerialDecode.Decode[n].Protocol (Protocol = "I2C").......................................................................................
1-164
app.SerialDecode.Decode[n].Protocol (Protocol = "LIN").......................................................................................
1-165
app.SerialDecode.Decode[n].Protocol (Protocol = "MIL1553")...............................................................................
1-166
app.SerialDecode.Decode[n].Protocol (Protocol = "RS232")..................................................................................
1-167
app.SerialDecode.Decode[n].Protocol (Protocol = "SIOP")....................................................................................
1-169
app.SerialDecode.Decode[n].Protocol (Protocol = "SPI").......................................................................................
1-172
app.SerialDecode.Decode[n].Protocol (Protocol = "SPICustom")...........................................................................
1-175
app.SerialDecode.Decode[n].Protocol (Protocol = "SPIDDR")...............................................................................
1-178
app.SerialDecode.Decode[n].Protocol (Protocol = "SSPI").....................................................................................
1-181
app.SerialDecode.Decode[n].Protocol (Protocol = "UART")...................................................................................
1-184
app.SerialDecode.Decodex.....................................................................................................................................
1-185
app.SerialDecode.Decodex.Decode.......................................................................................................................
1-188
app.SerialDecode.Decodex.Out.Result...................................................................................................................
1-189
app.SystemControl..................................................................................................................................................
1-190
app.Utility.DateTimeSetup.......................................................................................................................................
1-190
app.Utility.Options...................................................................................................................................................
1-193
app.Utility.Remote...................................................................................................................................................
1-194
app.Utility.Remote.IOManager.CIOPortU3GPIB.....................................................................................................
1-195
app.Utility.Remote.IOManager.CLSIBPort..............................................................................................................
1-195
app.WaveScan........................................................................................................................................................
1-195
app.WaveScan.ScanDecode..................................................................................................................................
1-196
vi
918499 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.WaveScan.ScanDecode.Out.Result................................................................................................................
1-197
app.Zoom................................................................................................................................................................
1-197
app.Zoom.Zx...........................................................................................................................................................
1-197
app.Zoom.Zx.Out.Result.........................................................................................................................................
1-200
app.Zoom.Zx.Zoom.................................................................................................................................................
1-200
vii
918499 RevA
Automation Command and Query Reference Manual - Control Reference
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
918499 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
918499 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
918499 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
918499 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
918499 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
918499 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
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
CalNeeded
Integer
ClearSweeps
Action
HorOffset
Double
TriggerMode
Enum
1-7
918499 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
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 -1e-006 to 1e-006 step 4e-009
Range
same as "app.Acquisition.Horizontal.HorOffset.cvar"
Description
1-8
918499 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
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
AuxInCoupling
Enum
Sets the input coupling for the Auxiliary input path.
Description
AuxInCoupling
Enum
AuxMode
Enum
CalMode
Enum
Mode
Enum
1-9
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' 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
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
Square
Square wave
1-10
918499 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
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
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
BandwidthLimit
Enum
ClearSweeps
Action
Coupling
Enum
Deskew
Double
1-11
918499 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
EnhanceResType
Enum
FindScale
Action
InterpolateType
Enum
Invert
Bool
LabelsPosition
String
LabelsText
String
Persisted
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-12
918499 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-13
918499 RevA
Automation Command and Query Reference Manual - Control Reference
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 -1.8e-006 to 1.8e-006 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
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
1-14
918499 RevA
Automation Command and Query Reference Manual - Control Reference
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-15
918499 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
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
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-16
918499 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-17
918499 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-18
918499 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-19
918499 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
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.
app.Acquisition.Horizontal
This group of variables controls the timebase, the sampling, and the trigger delay.
AcquiredSegments
Integer
AcquisitionDuration
Double
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
Source
Enum
1-20
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AcquiredSegments
Integer
From 0 to 100000 step 1
Range
AcquisitionDuration
Double
From 1e-012 to 1e+012 step 1e-015
Range
Queries the duration of the last completed acquisition. The result may depend on the spacing of the
triggers in sequence mode, and it may depend on the number of averages when a channel is
in averaging mode.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Obtain the duration of the last completed acquistion.
AcqDuration = app.Acquisition.Horizontal.AcquisitionDuration
MsgBox AcqDuration
Example
ExtClockFrequency
Double
From 0.001 to 100000 step 0.001
Range
ExtCoupling
Enum
Specific to WR and WS series of the scope.
Sets/Queries coupling of external trigger/clock input.
Description
Values
DC1M
DC50
HorOffset
Double
From -1e-006 to 2e-006 step 4e-009
Range
Sets/Queries the horizontal position of the trigger time, relative to the origin set by HorOffsetOrigin, in
seconds. Positive to the right, negative to the left. The setting resolution is about 1% to 2&.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the horizontal trigger offset to 200 ns.
app.Acquisition.Horizontal.HorOffset = 2.0e-7
Example
TimePerPoint
Double
UseLegacyDefault
Enum
1-21
918499 RevA
Automation Command and Query Reference Manual - Control Reference
HorOffsetOrigin
Double
From 0 to 10 step 1
Range
Sets/Queries the origin, in graticule divisions, of the time scale in which HorOffset is measured.
The value 0 corresponds to the left edge of the graticule. The value 10 corresponds to the right edge
of the graticule. Requesting a value outside the range will select the nearest allowed value.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the origin of the horizontal trigger offset to 4.0 divisions.
app.Acquisition.Horizontal.HorOffsetOrigin = 4.0
Example
HorScale
DoubleLockstep
From 2e-010 to 1000 step 2e-009, locked to 1 2 5, fine grain allowed=false, on=false
Range
Sets/Queries the horizontal scale in time per division.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the horizontal acquisition scale to 200 ns/div.
app.Acquisition.Horizontal.HorScale = 2.0e-7
Example
HorUnits
String
Any number of characters
Range
Queries the units in which the horizontal scale is measured.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Obtain the units of the horizontal scale.
HorizUnit = app.Acquisition.Horizontal.HorUnits
Example
MaxSamples
DoubleLockstep
From 500 to 1e+007 step 25000, locked to 1 2.5 5, fine grain allowed=false, on=false
Range
Sets/Queries the maximum permissible number of samples to be used in the acquisition memories.
At the faster sample rates, the actual number used may be less than this maximum.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the available memory length per channel to 500
app.Acquisition.Horizontal.MaxSamples = 500
Example
1-22
918499 RevA
Automation Command and Query Reference Manual - Control Reference
NumPoints
Integer
From 2 to 100000000 step 1
Range
Queries the number of samples in the current setting of the acquisition memory. For sequence mode,
this refers to the number if samples per segment, not to the number in the complete set.
Use MaxSamples to limit the number of samples acquired.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Obtain the number of points being used in the acquisition memory.
NumberOfPoints = app.Acquisition.Horizontal.NumPoints
MsgBox NumberOfPoints
Example
NumSegments
Integer
From 2 to 500 step 1
Range
Sets/Queries the number of segments in the sequence mode of acquisition. Only valid when
SampleMode = "Sequence'
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Enable sequence mode and capture 500 segments
app.Acquisition.Horizontal.SampleMode = "Sequence"
app.Acquisition.Horizontal.NumSegments = 500
Example
ReferenceClock
Enum
Sets/Queries the source of the acquisition reference clock.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the source of the reference clock to External.
app.Acquisition.Horizontal.ReferenceClock = "EXT"
Example
Values
EXT
External reference (use rear-panel BNC)
INT
Internal reference clock
1-23
918499 RevA
Automation Command and Query Reference Manual - Control Reference
SampleClock
Enum
Sets/Queries the source for the sample clock.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the sample clock to expect an external source.
app.Acquisition.Horizontal.SampleClock = "External"
Example
Values
INT
SampleMode
Enum
Sets/Queries the mode of acquisition as real-time or sequence or random interleaved sampling. Note
that RIS mode and sequence mode are not available over the entire range of time-bases, and are not
available simultaneously.
WaveExpert differences: CIS and SEQ are the only timebase modes.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the mode of acquisition to random interleaved sampling.
app.Acquisition.Horizontal.SampleMode = "RIS"
' WaveExpert example
app.Acquisition.Horizontal.SampleMode = "CIS"
Example
Values
RealTime
WStream
SamplingRate
Double
From 500 to 5e+009 step (2 digits)
Range
Queries the sampling rate. This is the effective sampling rate of the traces, rather than the sample
rate of the ADCs.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Inspect the effective sampling rate of the signal.
SamplingRate = app.Acquisition.Horizontal.SamplingRate
Example
1-24
918499 RevA
Automation Command and Query Reference Manual - Control Reference
SequenceTimeout
Double
From 0.01 to 100 step 0.01
Range
Sets/Queries the timeout in segment mode of acquisition if insufficient triggers are received.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the sequence mode timeout to 10 seconds
app.Acquisition.Horizontal.SequenceTimeout = 10.0
Example
SequenceTimeoutEnable
Bool
Sets/Queries the enabling of the sequence mode timeout.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Enable the sequence mode timeout.
app.Acquisition.Horizontal.SequenceTimeoutEnable = True
Example
SetExtClockFrequency
Bool
Source
Enum
Values
C1
C2
C3
C4
Ext
ExtDivide10
Line
TimePerPoint
Double
From 1e-012 to 1e+012 step 1e-012
Range
Queries the time interval between successive samples in the acquisition.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Obtain the time per point of the acquisition.
timePerPt = app.Acquisition.Horizontal.TimePerPoint
MsgBox timePerPt
Example
1-25
918499 RevA
Automation Command and Query Reference Manual - Control Reference
UseLegacyDefault
Enum
Values
Never
No
Yes
app.Acquisition.Trigger
This group of cvars controls all aspects of the trigger, except for trigger delay, which is in Acquisition.Horizontal.
Names of the form app.Acquisition.Trigger.Sources.xxxx are aliases of simpler names which are described in this
section of the manual. Examples of alias pairs are as follows -
app.Acquisition.Trigger.Sources("Cx") is equivalent to app.Acquisition.Trigger.Cx
app.Acquisition.Trigger.Sources("Ext") is equivalent to app.Acquisition.Trigger.Ext
app.Acquisition.Trigger.Sources("Line") is equivalent to app.Acquisition.Trigger.Line
Please see under Acquisition.Channels("Cx") for a programming example.
HoldoffType
Enum
Sets/Queries type of hold-off trigger.
Description
Values
Events
Holdoff by events, specified in HoldoffEvents
Off
No Trigger Holdoff
Time
Holdoff by time, specified in HoldoffTime
HoldoffType
Enum
PatternType
Enum
ProbeName
String
Source
Enum
Type
Enum
ZeroLevel
Action
1-26
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PatternType
Enum
Sets/Queries the pattern (Logic) trigger type.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the pattern trigger type to Nand.
app.Acquisition.Trigger.Type = "Logic"
app.Acquisition.Trigger.PatternType = "Nand"
Example
Values
And
Nand
Nor
Or
ProbeName
String
Any number of characters
Range
The name of the probe connected to the Ext trigger input
("None" if no probe is present)
Description
Source
Enum
Sets/Queries the trigger source.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the trigger source to external.
app.Acquisition.Trigger.Source = "Ext"
Example
Values
C1
C2
C3
C4
Ext
ExtDivide10
Line
1-27
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Type
Enum
Sets/Queries the trigger type (mode).
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the trigger type to glitch.
app.Acquisition.Trigger.Type = "Glitch"
Example
Values
Dropout
Edge
Glitch
Interval
Logic
Qualify
Runt
Serial
SlewRate
State
TV
Width
ZeroLevel
Action
Sets the trigger level to zero volts.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the trigger level to zero volts.
app.Acquisition.Trigger.ZeroLevel
Example
app.Acquisition.Trigger.Cx
This group of varables controls triggering from the input channels C1, C2, C3 and C4.
InputImpedance
Enum
InputImpedance
Enum
Level
Double
Level2
Double
PatternState
Enum
Slope
Enum
WindowSize
Double
1-28
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Reads the input impedance of channel C1, in Ohms
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the input impedance of C1 trigger.
ZinC1 = app.Acquisition.Trigger.C1.InputImpedance
MsgBox ZinC1
Example
Values
50
Level
Double
From -0.205 to 0.205 step 0.0005
Range
Sets/Queries the trigger level for the internal trigger from channel Cx. The setting resolution ranges
from about 1.5% to about 2.5%, depending on the numerical value.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the trigger level to 55 mV for triggering on channel C1.
app.Acquisition.Trigger.C1.Level = 0.055
Example
Level2
Double
From -0.205 to 0.205 step 0.0005
Range
PatternState
Enum
Sets/Queries the pattern state for the input channel Cx. Only valid when the trigger mode is set to
'Logic'.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the pattern state for channel C1 to low.
app.Acquisition.Trigger.C1.PatternState = "Low"
Example
Values
DontCare
High
Low
1-29
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Slope
Enum
Sets/Queries the direction of the transition to be used for internal triggering from channel Cx.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the direction of the transition as negative
' for triggering on channel C1.
app.Acquisition.Trigger.C1.Slope = "Negative"
Example
Values
Either
Negative
Positive
Window
WindowSize
Double
From 0.02 to 0.205 step 0.0005
Range
app.Acquisition.Trigger.Ext
This group of variables controls the external trigger.
Coupling
Enum
Sets/Reads the input coupling of the external trigger input.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the input coupling of the external trigger input.
ZinCoupling = app.Acquisition.Trigger.Ext.Coupling
MsgBox ZinCoupling
Example
Values
AC
DC
HFREJ
Coupling
Enum
InputImpedance
Enum
Level
Double
Level2
Double
PatternState
Enum
Slope
Enum
WindowSize
Double
1-30
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LFREJ
InputImpedance
Enum
Reads the input impedance of the external trigger.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the input impedance of external trigger input.
ZinExt = app.Acquisition.Trigger.Ext.InputImpedance
MsgBox ZinExt
Example
Values
50
Level
Double
From -0.41 to 0.41 step 0.001
Range
Sets/Queries the trigger level for the external trigger.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the trigger level to 55 mV for triggering from
' the external trigger socket.
app.Acquisition.Trigger.Ext.Level = 0.055
Example
Level2
Double
From -0.41 to 0.41 step 0.001
Range
PatternState
Enum
Sets/Queries the pattern state for the external trigger input.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the pattern state to low for triggering from
' the external trigger socket.
app.Acquisition.Trigger.Ext.PatternState = "Low"
Example
Values
DontCare
High
Low
1-31
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Slope
Enum
Sets/Queries the direction of the transition used for the external trigger.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the direction of the transition as positive for triggering
' from the external trigger socket.
app.Acquisition.Trigger.Ext.Slope = "Positive"
Example
Values
Either
Negative
Positive
Window
WindowSize
Double
From 0.04 to 0.41 step 0.001
Range
app.Acquisition.Trigger.Serial
ClockSource
Enum
Defines channel with the clock signal (if applies to protocol) to trigger on serial data
Description
Values
C1
C2
C3
C4
Ext
ExtDivide10
ClockSource
Enum
CSSource
Enum
DataSource
Enum
LevelAbsolute
Double
LevelHighAbsolute
Double
Protocol
Enum
1-32
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSSource
Enum
Defines channel with the chip select signal (if applies to protocol) to trigger on serial data
Description
Values
C1
C2
C3
C4
Ext
ExtDivide10
DataSource
Enum
Defines channel with the Data signal (mandatory) to trigger on serial data
Description
Values
C1
C2
C3
C4
Ext
ExtDivide10
LevelAbsolute
Double
From 0 to 5 step 0.1
Range
Defines the threshold level applied to Serial data inputs (Data, Clock, CS)
Description
LevelHighAbsolute
Double
From 0 to 5 step 0.1
Range
Defines the upper threshold level applied to tri-modal Serial Data protocol inputs (FlexRay)
Description
1-33
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Protocol
Enum
Defines the actual active trigger Serial standard (Protocol)
Description
Values
CAN
I2C
I2S
LIN
MIL1553
RS232
SPI
UART
app.Acquisition.Trigger.Serial.I2C
AckCondition
Enum
Values
Ack
DontCare
NoAck
AckCondition
Enum
AddressLength
Enum
AddressValue
BitPattern
AddressWithRW
Bool
AtPosition
Enum
ByteBitOrder
Enum
DefaultLevel
Double
Direction
Enum
FrameCondition
Enum
NeedDualLevels
Bool
NeededSources
Enum
PatternLength
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
SupportsDigital
Bool
ViewingMode
Enum
1-34
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AddressLength
Enum
Values
10Bits
7Bits
AddressValue
BitPattern
MaxBits=10 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
AddressWithRW
Bool
AtPosition
Enum
Values
DontCare
Value
ByteBitOrder
Enum
Values
LSB
MSB
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
Direction
Enum
Values
DontCare
Read
Write
FrameCondition
Enum
Values
Addr
AddrData
EEPROM
FrameLength
NoAck
Restart
Start
Stop
NeedDualLevels
Bool
1-35
918499 RevA
Automation Command and Query Reference Manual - Control Reference
NeededSources
Enum
Values
ClockSource
DataSource
PatternLength
Integer
From 0 to 12 step 1
Range
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
PatternValue
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
SupportsDigital
Bool
ViewingMode
Enum
Values
Binary
Hex
app.Acquisition.Trigger.Serial.Protocol (Standard = "CAN")
AdaptedSamplingPoint
Double
AddressFormat
Enum
AddressOperator
Enum
AddressValue
BitPattern
AddressValue2
BitPattern
BitRate
Double
ByteOrder
Enum
1-36
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AdaptedSamplingPoint
Double
From 20 to 90 step 0.01
Range
AddressFormat
Enum
Values
ALL
EXT
STD
AddressOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
AddressValue
BitPattern
MaxBits=29 NumBits=11 NumBytes=2 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
DefaultLevel
Double
NeedDualLevels
Bool
NeededSources
Enum
NumSamplingPoints
Enum
PatternBitLength
Integer
PatternBitPos
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
RequestedSamplingPoint
Double
SignType
Enum
SupportsDigital
Bool
SynchJumpWidth
Integer
TriggerCondition
Enum
Tseg1
Integer
Tseg2
Integer
ViewingMode
Enum
1-37
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AddressValue2
BitPattern
MaxBits=29 NumBits=11 NumBytes=2 AllowedBitValues=01 PaddingChar=1
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
BitRate
Double
From 10000 to 1e+006 step 1
Range
ByteOrder
Enum
Values
Intel
Motorola
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
NeedDualLevels
Bool
NeededSources
Enum
Values
DataSource
NumSamplingPoints
Enum
Values
1
3
PatternBitLength
Integer
From 0 to 64 step 1
Range
PatternBitPos
Integer
From 0 to 63 step 1
Range
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
1-38
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PatternValue
BitPattern
MaxBits=64 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=64 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
RequestedSamplingPoint
Double
From 20 to 90 step 0.01
Range
SignType
Enum
Values
SignedInt
UnsignedInt
SupportsDigital
Bool
SynchJumpWidth
Integer
From 1 to 4 step 1
Range
TriggerCondition
Enum
Values
All
Error
ID
IdData
Remote
Tseg1
Integer
From 3 to 16 step 1
Range
Tseg2
Integer
From 2 to 8 step 1
Range
ViewingMode
Enum
Values
Binary
Hex
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2C")
AckCondition
Enum
1-39
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AckCondition
Enum
Values
Ack
NoAck
AddressLength
Enum
Values
10Bits
7Bits
AddressValue
BitPattern
MaxBits=10 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
AddressWithRW
Bool
AtPosition
Enum
Values
Value
ByteBitOrder
Enum
Values
LSB
MSB
AddressLength
Enum
AddressValue
BitPattern
AddressWithRW
Bool
AtPosition
Enum
ByteBitOrder
Enum
DefaultLevel
Double
Direction
Enum
FrameCondition
Enum
NeedDualLevels
Bool
NeededSources
Enum
PatternLength
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
SupportsDigital
Bool
ViewingMode
Enum
1-40
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
Direction
Enum
Values
Read
Write
FrameCondition
Enum
Values
Addr
AddrData
EEPROM
FrameLength
NoAck
Restart
Start
Stop
NeedDualLevels
Bool
NeededSources
Enum
Values
ClockSource
DataSource
PatternLength
Integer
From 0 to 12 step 1
Range
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
1-41
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PatternValue
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
SupportsDigital
Bool
ViewingMode
Enum
Values
Binary
Hex
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2S")
AudioChannel
Enum
Values
Left
Right
AudioChannel
Enum
BitsInChannel
Integer
ByteBitOrder
Enum
ChipSelCondition
Enum
ClockPol
Enum
DefaultLevel
Double
EnableInterFrame
Bool
I2SCondition
Enum
I2SVariant
Enum
NeedDualLevels
Bool
NeededSources
Enum
PatternBitsLen
Integer
PatternLength
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
StartBitInChannel
Integer
SupportsDigital
Bool
TimeOutLenInNanoSec
Double
ViewingMode
Enum
WSFrameStart
Enum
1-42
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitsInChannel
Integer
From 1 to 32 step 1
Range
ByteBitOrder
Enum
Values
LSB
MSB
ChipSelCondition
Enum
Values
Auto
Manual
None
ClockPol
Enum
Values
Negative
Positive
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
EnableInterFrame
Bool
I2SCondition
Enum
Values
Clip
Data
FallingEdge
Glitch
Mute
RisingEdge
I2SVariant
Enum
Values
I2S
LJ
RJ
NeedDualLevels
Bool
1-43
918499 RevA
Automation Command and Query Reference Manual - Control Reference
NeededSources
Enum
Values
ClockSource
CSSource
DataSource
PatternBitsLen
Integer
From 1 to 32 step 1
Range
PatternLength
Integer
From 0 to 8 step 1
Range
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
PatternValue
BitPattern
MaxBits=32 NumBits=32 NumBytes=4 AllowedBitValues=01X PaddingChar=X
PadAlign=Right SizeAlign=BitVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=32 NumBits=32 NumBytes=4 AllowedBitValues=01 PaddingChar=0
PadAlign=Right SizeAlign=BitVar Format=Ehex
Range
StartBitInChannel
Integer
From 0 to 31 step 1
Range
SupportsDigital
Bool
TimeOutLenInNanoSec
Double
From 4e-008 to 0.0026214 step 4e-008
Range
ViewingMode
Enum
Values
Binary
Hex
1-44
918499 RevA
Automation Command and Query Reference Manual - Control Reference
WSFrameStart
Enum
Values
Falling
Rising
app.Acquisition.Trigger.Serial.Protocol (Standard = "LIN")
AddressOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
AddressValue
BitPattern
MaxBits=6 NumBits=6 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
AddressValue2
BitPattern
MaxBits=6 NumBits=6 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
AddressOperator
Enum
AddressValue
BitPattern
AddressValue2
BitPattern
BitRate
Double
DefaultLevel
Double
NeedDualLevels
Bool
NeededSources
Enum
PatternLength
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
SupportsDigital
Bool
TriggerCondition
Enum
ViewingMode
Enum
1-45
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 300 to 20000 step 1
Range
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
NeedDualLevels
Bool
NeededSources
Enum
Values
DataSource
PatternLength
Integer
From 0 to 8 step 1
Range
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
PatternValue
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
SupportsDigital
Bool
TriggerCondition
Enum
Values
Break
Error
FrameID
IDData
1-46
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
Binary
Hex
app.Acquisition.Trigger.Serial.Protocol (Standard = "MIL1553")
BitRate
Double
C1_ModeCode
Enum
C1_ModeCodeOP
Enum
C1_RTAddress
BitPattern
C1_RTAddress2
BitPattern
C1_RTAddressOP
Enum
C1_RTSubAddress
BitPattern
C1_RTSubAddress2
BitPattern
C1_RTSubAddressOP
Enum
C1_WordCount
Integer
C1_XmitRcv
Enum
C2_ModeCode
Enum
C2_ModeCodeOP
Enum
C2_RTAddress
BitPattern
C2_RTAddress2
BitPattern
C2_RTAddressOP
Enum
C2_RTSubAddress
BitPattern
C2_RTSubAddress2
BitPattern
C2_RTSubAddressOP
Enum
C2_WordCount
Integer
C2_XmitRcv
Enum
D_PatternBitLength
Integer
D_PatternBitPos
Integer
D_PatternOperator
Enum
D_PatternValue
BitPattern
D_PatternValue2
BitPattern
DefaultLevel
Double
IMGTimeFrom
Double
IMGTimeOperator
Enum
IMGTimeTo
Double
NeedDualLevels
Bool
NeededSources
Enum
RespTimeFrom
Double
RespTimeOperator
Enum
RespTimeTo
Double
RHSRatio
Integer
S1_BcastRcvdBit
Enum
1-47
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 500000 to 4e+007 step 1000
Range
S1_BusyBit
Enum
S1_DynBusCtrlBit
Enum
S1_InstrBit
Enum
S1_MsgErrorBit
Enum
S1_RTAddress
BitPattern
S1_RTAddress2
BitPattern
S1_RTAddressOP
Enum
S1_SRQBit
Enum
S1_SubSystFlagBit
Enum
S1_TermFlagBit
Enum
S2_BcastRcvdBit
Enum
S2_BusyBit
Enum
S2_DynBusCtrlBit
Enum
S2_InstrBit
Enum
S2_MsgErrorBit
Enum
S2_RTAddress
BitPattern
S2_RTAddress2
BitPattern
S2_RTAddressOP
Enum
S2_SRQBit
Enum
S2_SubSystFlagBit
Enum
S2_TermFlagBit
Enum
SupportsDigital
Bool
TrigOnBadManchesterEncoding
Bool
TrigOnBadWordCount
Bool
TrigOnIdleError
Bool
TrigOnInvalidSync
Bool
TrigOnNonContiguousData
Bool
TrigOnParityError
Bool
TrigOnStatusAddressMismatch
Bool
TrigOnSyncError
Bool
Type
Enum
TypeTransfer
Enum
1-48
918499 RevA
Automation Command and Query Reference Manual - Control Reference
C1_ModeCode
Enum
Values
0DynamicBusControl
10Reserved
11Reserved
12Reserved
13Reserved
14Reserved
15Reserved
16TransmitVectorWord
17Synchronize
18TransmitLastComman
19TransmitBITWord
1Synchronize
20SelectedTransmitterSh
21OverrideSelectedTran
22Reserved
23Reserved
24Reserved
25Reserved
26Reserved
27Reserved
28Reserved
29Reserved
2TransmitStatusWord
30Reserved
31Reserved
3InitiateSelfTest
4TransmitterShutdown
5OverrideTransmitterShu
6InhibitTerminalFlag
7OverrideInhibitTerminal
8ResetRemoteTerminal
9Reserved
C1_ModeCodeOP
Enum
Values
Equal
Greater
GreaterOrEqual
NotEqual
Smaller
SmallerOrEqual
1-49
918499 RevA
Automation Command and Query Reference Manual - Control Reference
C1_RTAddress
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C1_RTAddress2
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C1_RTAddressOP
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
C1_RTSubAddress
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C1_RTSubAddress2
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C1_RTSubAddressOP
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
C1_WordCount
Integer
From 0 to 31 step 1
Range
1-50
918499 RevA
Automation Command and Query Reference Manual - Control Reference
C1_XmitRcv
Enum
Values
0
1
X
C2_ModeCode
Enum
Values
0DynamicBusControl
10Reserved
11Reserved
12Reserved
13Reserved
14Reserved
15Reserved
16TransmitVectorWord
17Synchronize
18TransmitLastComman
19TransmitBITWord
1Synchronize
20SelectedTransmitterSh
21OverrideSelectedTran
22Reserved
23Reserved
24Reserved
25Reserved
26Reserved
27Reserved
28Reserved
29Reserved
2TransmitStatusWord
30Reserved
31Reserved
3InitiateSelfTest
4TransmitterShutdown
5OverrideTransmitterShu
6InhibitTerminalFlag
7OverrideInhibitTerminal
8ResetRemoteTerminal
9Reserved
1-51
918499 RevA
Automation Command and Query Reference Manual - Control Reference
C2_ModeCodeOP
Enum
Values
Equal
Greater
GreaterOrEqual
NotEqual
Smaller
SmallerOrEqual
C2_RTAddress
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C2_RTAddress2
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C2_RTAddressOP
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
C2_RTSubAddress
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
C2_RTSubAddress2
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
1-52
918499 RevA
Automation Command and Query Reference Manual - Control Reference
C2_RTSubAddressOP
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
C2_WordCount
Integer
From 0 to 31 step 1
Range
C2_XmitRcv
Enum
Values
0
1
X
D_PatternBitLength
Integer
From 0 to 16 step 1
Range
D_PatternBitPos
Integer
From 0 to 511 step 1
Range
D_PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
D_PatternValue
BitPattern
MaxBits=16 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
1-53
918499 RevA
Automation Command and Query Reference Manual - Control Reference
D_PatternValue2
BitPattern
MaxBits=16 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
IMGTimeFrom
Double
From 0 to 3.2752e-005 step 8e-009
Range
IMGTimeOperator
Enum
Values
Greater
InRange
OutRange
Smaller
IMGTimeTo
Double
From 0 to 3.2752e-005 step 8e-009
Range
NeedDualLevels
Bool
NeededSources
Enum
Values
DataSource
RespTimeFrom
Double
From 0 to 3.2752e-005 step 8e-009
Range
RespTimeOperator
Enum
Values
Greater
InRange
OutRange
Smaller
RespTimeTo
Double
From 0 to 3.2752e-005 step 8e-009
Range
RHSRatio
Integer
From 0 to 100 step 1
Range
1-54
918499 RevA
Automation Command and Query Reference Manual - Control Reference
S1_BcastRcvdBit
Enum
Values
0
1
X
S1_BusyBit
Enum
Values
0
1
X
S1_DynBusCtrlBit
Enum
Values
0
1
X
S1_InstrBit
Enum
Values
0
1
X
S1_MsgErrorBit
Enum
Values
0
1
X
S1_RTAddress
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
S1_RTAddress2
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
1-55
918499 RevA
Automation Command and Query Reference Manual - Control Reference
S1_RTAddressOP
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
S1_SRQBit
Enum
Values
0
1
X
S1_SubSystFlagBit
Enum
Values
0
1
X
S1_TermFlagBit
Enum
Values
0
1
X
S2_BcastRcvdBit
Enum
Values
0
1
X
S2_BusyBit
Enum
Values
0
1
X
1-56
918499 RevA
Automation Command and Query Reference Manual - Control Reference
S2_DynBusCtrlBit
Enum
Values
0
1
X
S2_InstrBit
Enum
Values
0
1
X
S2_MsgErrorBit
Enum
Values
0
1
X
S2_RTAddress
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
S2_RTAddress2
BitPattern
MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
S2_RTAddressOP
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
S2_SRQBit
Enum
Values
0
1
X
1-57
918499 RevA
Automation Command and Query Reference Manual - Control Reference
S2_SubSystFlagBit
Enum
Values
0
1
X
S2_TermFlagBit
Enum
Values
0
1
X
SupportsDigital
Bool
TrigOnBadManchesterEncoding
Bool
TrigOnBadWordCount
Bool
TrigOnIdleError
Bool
TrigOnInvalidSync
Bool
TrigOnNonContiguousData
Bool
TrigOnParityError
Bool
TrigOnStatusAddressMismatch
Bool
TrigOnSyncError
Bool
Type
Enum
Values
Error
Timing
Transfer
Word
1-58
918499 RevA
Automation Command and Query Reference Manual - Control Reference
TypeTransfer
Enum
Values
All
BCRTRcv
Modecommand
ModecommandDataRcv
ModecommandDataXmit
RTBCXmit
RTRT
app.Acquisition.Trigger.Serial.Protocol (Standard = "RS232")
AtPosition
Enum
Values
Value
BitRate
Double
From 300 to 1e+007 step 1
Range
AtPosition
Enum
BitRate
Double
ByteBitOrder
Enum
DefaultLevel
Double
FrameDelimiter
Enum
InterFrameMinBits
Integer
NeedDualLevels
Bool
NeededSources
Enum
NumDataBits
Integer
ParityType
Enum
PatternLength
Integer
PatternOperator
Enum
PatternPosition
Integer
PatternValue
BitPattern
PatternValue2
BitPattern
Polarity
Enum
RS232Mode
Bool
StopBitLength
Enum
SupportsDigital
Bool
TrigOnBadParity
Bool
UARTCondition
Enum
ViewingMode
Enum
1-59
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ByteBitOrder
Enum
Values
LSB
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
FrameDelimiter
Enum
Values
Manual
None
InterFrameMinBits
Integer
From 1 to 65535 step 1
Range
NeedDualLevels
Bool
NeededSources
Enum
Values
DataSource
NumDataBits
Integer
From 5 to 8 step 1
Range
ParityType
Enum
Values
Even
None
Odd
PatternLength
Integer
From 0 to 12 step 1
Range
1-60
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
PatternPosition
Integer
From -1 to 2047 step 1
Range
PatternValue
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
Polarity
Enum
Values
IdleLow
RS232Mode
Bool
StopBitLength
Enum
Values
1.5bit
1bit
2bits
SupportsDigital
Bool
TrigOnBadParity
Bool
UARTCondition
Enum
Values
Data
1-61
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
Binary
Hex
app.Acquisition.Trigger.Serial.Protocol (Standard = "SPI")
ByteBitOrder
Enum
Values
LSB
MSB
ChipSelCondition
Enum
Values
Auto
Manual
ByteBitOrder
Enum
ChipSelCondition
Enum
ClockPhase
Enum
ClockPolarity
Enum
CSPolarity
Enum
DefaultLevel
Double
EnableInterFrame
Bool
NeedDualLevels
Bool
NeededSources
Enum
PatternBitLength
Integer
PatternBitPos
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
SignType
Enum
SPIVariant
Enum
SupportsDigital
Bool
TimeOutLen
Double
ViewingMode
Enum
1-62
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ClockPhase
Enum
Values
0
1
ClockPolarity
Enum
Values
0
1
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
EnableInterFrame
Bool
NeedDualLevels
Bool
NeededSources
Enum
Values
ClockSource
CSSource
DataSource
PatternBitLength
Integer
From 0 to 96 step 1
Range
PatternBitPos
Integer
From 0 to 95 step 1
Range
1-63
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
PatternValue
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=BitVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=BitVar Format=Ehex
Range
SignType
Enum
Values
SignedInt
UnsignedInt
SPIVariant
Enum
Values
DDR
SIOP
SPI
SSPI
SupportsDigital
Bool
TimeOutLen
Double
From 4e-008 to 0.0026214 step 4e-008
Range
ViewingMode
Enum
Values
Binary
Hex
app.Acquisition.Trigger.Serial.Protocol (Standard = "UART")
AtPosition
Enum
1-64
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AtPosition
Enum
Values
Value
Bit9State
Enum
Values
0
1
X
BitRate
Double
From 300 to 1e+007 step 1
Range
ByteBitOrder
Enum
Values
LSB
MSB
AtPosition
Enum
Bit9State
Enum
BitRate
Double
ByteBitOrder
Enum
DefaultLevel
Double
FrameDelimiter
Enum
InterFrameMinBits
Integer
NeedDualLevels
Bool
NeededSources
Enum
NumDataBits
Integer
ParityType
Enum
PatternLength
Integer
PatternOperator
Enum
PatternPosition
Integer
PatternValue
BitPattern
PatternValue2
BitPattern
Polarity
Enum
StopBitLength
Enum
SupportsDigital
Bool
TrigOnBadParity
Bool
UARTCondition
Enum
ViewingMode
Enum
1-65
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
FrameDelimiter
Enum
Values
Manual
None
InterFrameMinBits
Integer
From 1 to 65535 step 1
Range
NeedDualLevels
Bool
NeededSources
Enum
Values
DataSource
NumDataBits
Integer
From 5 to 9 step 1
Range
ParityType
Enum
Values
Even
None
Odd
PatternLength
Integer
From 0 to 12 step 1
Range
PatternOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
PatternPosition
Integer
From -1 to 2047 step 1
Range
1-66
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PatternValue
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
PatternValue2
BitPattern
MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0
PadAlign=Left SizeAlign=ByteVar Format=Ehex
Range
Polarity
Enum
Values
IdleHigh
IdleLow
StopBitLength
Enum
Values
1.5bit
1bit
2bits
SupportsDigital
Bool
TrigOnBadParity
Bool
UARTCondition
Enum
Values
Data
ViewingMode
Enum
Values
Binary
Hex
app.Cursors
This set of variables controls the cursor system.
Track
Bool
Track
Bool
XPos1
Double
XPos2
Double
YPos1
Double
YPos2
Double
1-67
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Sets/Queries the state of tracking of a pair of cursors. If tracking is enabled then when the first cursor
is moved, the second will track at a constant distance from it.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set cursors tracking on.
app.Cursors.Track = True
Example
XPos1
Double
From -1.79769e+308 to 1.79769e+308 step 0
Range
Sets/Queries the horizontal position of the first cursor, in the units of the horizontal variable.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the horizontal position of the first cursor to 50 ns.
app.Cursors.XPos1 = 50e-9
Example
XPos2
Double
From -1.79769e+308 to 1.79769e+308 step 0
Range
Sets/Queries the horizontal position of the second cursor, in the units of the horizontal variable.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the horizontal position of the second cursor to 4.5 ms.
app.Cursors.XPos2 = 4.5e-3
Example
YPos1
Double
From -3.99 to 3.99 step 0.01
Range
Sets/Queries the vertical position of the first cursor, in graticule divisions.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the vertical position of the first cursor.
app.Cursors.YPos1 = 3.4
Example
1-68
918499 RevA
Automation Command and Query Reference Manual - Control Reference
YPos2
Double
From -3.99 to 3.99 step 0.01
Range
Sets/Queries the vertical position of the second cursor, in graticule divisions.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the vertical position of the second cursor.
app.Cursors.YPos2 = 2.1
Example
app.Display
This set of variables controls the properties of the screen display of the instrument.
AxisLabels
Bool
C1Color
Color
C1PrintColor
Color
C2Color
Color
C2PrintColor
Color
C3Color
Color
C3PrintColor
Color
C4Color
Color
C4PrintColor
Color
ClearSweeps
Action
DisplayMode
Enum
F1Color
Color
F1PrintColor
Color
FactoryDefault
Action
GridIntensity
Integer
GridMode
Enum
M1Color
Color
M1PrintColor
Color
M2Color
Color
M2PrintColor
Color
M3Color
Color
M3PrintColor
Color
M4Color
Color
M4PrintColor
Color
Persisted
Bool
PersistenceLastTrace
Bool
PersistenceSaturation
Integer
PersistenceStyle
Enum
PersistenceTime
Enum
PreviewPrintColors
Action
TraceStyle
Enum
1-69
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AxisLabels
Bool
Sets/Queries the visibility of the labels that show the horizontal and vertical limits of each grid.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Show the axis labels.
app.Display.AxisLabels = True
Example
C1Color
Color
From 0 to 16777215
Range
Sets/Queries the color of trace C1, using a number in the range 0 to FFFFFF in hexadecimal. The
possible colors are made from any combination of the primary colors, which are set in hexadecimal as
Blue = &HFF0000, Green = &HFF00, Red = &HFF. The value may be entered in decimal or in
hexadecimal, though hexadecimal is usually more convenient. Note that if the intensity of a color is to
be reduced or increased by a numerical factor, an AND operation must be used afterwards, to prevent
corruption of other primary colors.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
Red = &Hff: Green = &H80: Blue = &H00
' Set the color of channel C1 trace to orange
app.Display.C1Color = (Blue * &H10000) + (Green * &H100) + Red
Example
C1PrintColor
Color
From 0 to 16777215
Range
Sets/Queries the color, in the printing palette, of trace C1, using a number in the range 0 to FFFFFF in
hexadecimal. The primary colors are Blue = &HFF0000, Green = &HFF00, Red = &HFF in
hexadecimal.
The value may be entered in decimal or in hexadecimal.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
Red = &Hff: Green = &H80: Blue = &H00
' Set the color of channel C1 trace to orange for printing.
app.Display.C1PrintColor = (Blue * &H10000) + (Green * &H100) + Red
Example
C2Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
1-70
918499 RevA
Automation Command and Query Reference Manual - Control Reference
C2PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
C3Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
C3PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
C4Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
C4PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
ClearSweeps
Action
Initiates the Clear Sweeps operation. Clears history only for persistence traces, see the main Clear
Sweeps control 'app.ClearSweeps', or the ClearSweeps control in other subsystems for other options.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Initiate a clear sweeps action for persistence traces.
app.Display.ClearSweeps
Example
1-71
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DisplayMode
Enum
Sets/Queries the display mode as either "Scope", showing the normal instrument screen, or
"WebEdit", showing the web processor editing panel. Note that WebEdit mode is available only with
certain software options, including XMATH and XMAP.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Switch to WebEdit mode
app.Display.DisplayMode = "WebEdit"
Example
Values
Scope
F1Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
F1PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
FactoryDefault
Action
Restores the display of the instrument to the factory default settings
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Restore the display to the factory pre-set state.
app.Display.FactoryDefault
Example
GridIntensity
Integer
From 0 to 100 step 1
Range
Sets/Queries the grid intensity as a percentage of the maximum value, with a resolution of 1%.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the grid intensity to 60% of the maximum.
app.Display.GridIntensity = 60
Example
1-72
918499 RevA
Automation Command and Query Reference Manual - Control Reference
GridMode
Enum
Sets/Queries the grid mode. The commands "Single" and "Dual", for example, set the grid mode until
countermanded. "Auto" allows the instrument to set the grid mode most suitable for the current
number of visible traces.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Enter Octal grid mode
app.Display.GridMode = "Octal"
Example
Values
Single
Single grid mode
XY
XY grid mode
XYSingle
XY + Single grid mode
M1Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
M1PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
M2Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
M2PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
M3Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
1-73
918499 RevA
Automation Command and Query Reference Manual - Control Reference
M3PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
M4Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
M4PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
Persisted
Bool
Sets/Queries whether persistence mode is in use. If the previously set persistence mode is per trace,
the persisted cvar will be set as true by this command, even if none of the traces has been set to
persistence mode.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the state of persistence mode.
Persist = app.Display.Persisted
Example
PersistenceLastTrace
Bool
Sets/Queries whether the last created trace is shown over the persistence trace.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence display to show the last trace
' on top of the persistence trace.
app.Display.PersistenceLastTrace = True
Example
1-74
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PersistenceSaturation
Integer
From 0 to 100 step 1
Range
Sets/Queries the population level, relative to the maximum possible level, at which the persistence
traces reach maximum intensity, and above which there are no further changes in color or intensity.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence saturation level to 60%.
app.Display.PersistenceSaturation = 60
Example
PersistenceStyle
Enum
Sets/Queries the type of persistence trace displayed.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence style to color graded.
app.Display.PersistenceStyle = "ColorGraded"
Example
Values
Analog
ColorGraded
PersistenceTime
Enum
Sets/Queries decay time for trace persistence, expressed as a number of seconds, or as "infinity".
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence time to 10 seconds.
app.Display.PersistenceTime = "10s"
Example
Values
0.5s
10s
1s
20s
2s
5s
Infinite
1-75
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PreviewPrintColors
Action
Show the instrument display in the current color scheme selected for printing.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Show the current color scheme selected for printing.
app.Display.PreviewPrintColors
Example
TraceStyle
Enum
Sets/Queries the style in which traces are drawn.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the state of the persistence mode.
TraceStyle = app.Display.TraceStyle
Example
Values
Line
Connect adjacent samples with straight lines
Points
Show only the sample points
app.ElectricalTelecom
Root Automation node to control Electrical Telecom (ET-PMT) package. This package is performing Pulse Mask Test
on diferent SONET/SDH standards.
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard, run the test and get results after a while
app.ElectricalTelecom.Standard = "E1Tp"
app.ElectricalTelecom.Source = "C2"
app.ElectricalTelecom.Setup
app.ElectricalTelecom.Run
app.Sleep 10000
app.ElectricalTelecom.Pause
passed = CStr(app.ElectricalTelecom.NumPass)
tested = CStr(app.ElectricalTelecom.NumTested)
MsgBox passed + " passed of " + tested + " tests"
Example
ClearSweeps
Action
Polarity
Enum
Run
Action
Setup
Action
Source
Enum
Standard
Enum
Stop
Action
VerticalAlign
Action
1-76
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
The ClearSweeps allows you to reset the sweep count and start testing over again.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard, run the test and clear the counter after a while
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Setup
app.ElectricalTelecom.Run
app.Sleep 5000
app.ElectricalTelecom.Pause
app.Sleep 5000
app.ElectricalTelecom.ClearSweeps
Example
Polarity
Enum
In many electrical standards, such as DS-1, alternate “ones” are inverted. Each time a one is
transmitted it is either a positive or negative going pulse depending upon the polarity of the
previous one. This type of coding is referred to as AMI (alternate mark inversion). The Polarity
control allows you to select which polarity (positive or negative) pulse to test.
The STS-3E and STM-1E standards use CMI (code mark inversion) pulse coding. In CMI coding,
a one remains high for the full bit period while a zero has a transition to the low state in the middle
of the bit period. The Polarity control allows you to select whether a 1 or 0 is to be tested.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select a stadard and set polarity to 'neg'
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Polarity = "neg"
app.ElectricalTelecom.Setup
Example
Values
neg
Negative pulse
pos
Positive pulse
1-77
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Run
Action
The Setup button applies the appropriate settings to the oscilloscope for testing the selected
standard. Different standards require a particular termination, and an error message will appear at
the bottom of the oscilloscope screen if the wrong (or no) adapter is present. However, this error
will not prevent the instrument from making the measurement; that is, measurements can be
made without the specific adapters. But if the signal is out of range for the standard, the setup
operation will generate an error message and the Run button will be grayed out. The signal will
appear on the screen, but no testing will be possible.
Before the Setup button is pressed, the Run and Clear Sweeps buttons appear grayed out.
These buttons become available (not grayed out) upon successful completion of a setup. At that
time, a Re-Align button will replace the Setup button.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard and run the test
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Setup
app.ElectricalTelecom.Run
app.Sleep 5000
app.ElectricalTelecom.Pause 'pause the test after 5 seconds
app.Sleep 5000
app.ElectricalTelecom.Run 'and continue after 5 other seconds
Example
Setup
Action
After the Telecom Standard has been choosed, the Source set, the 'Setup' command will perform all
acquisition setup, make the appropriate alignments and make test ready to run.
This is one of the action to control the state machine of Mask Testing : Setup, ReAlign, Stop, Pause,
Run and VerticalAlign.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard and run the test
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Setup
app.ElectricalTelecom.Run
app.Sleep 5000
app.ElectricalTelecom.Pause 'pause the test after 5 seconds
Example
1-78
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Source
Enum
Specify on which channel (C1 to C4) the electrical signal to be tested is connected.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard and the source
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Source = "C4"
app.ElectricalTelecom.Setup
Example
Values
C1
C2
C3
C4
Standard
Enum
Select the Telecom Standards that will be used to make alignments and mask test.
Available standards are listed in the 'Standard' field of this database :
D:\Masks\PulseMasksProp.mdb. (whithout spaces and special characters).
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard and the source
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Source = "C4"
app.ElectricalTelecom.Setup
Example
Values
DS1
ANSI T1 DS1 standard on 100 ohm line (using AP100)
DS3
ANSI T1 DS3 standard on 75 ohm coax (using PP090 probe)
E1coax
ITU-T E1 on 75 ohm coax (using PP090 probe)
E1TP
ITU-T E1 on 120 ohm twisted pairs (using AP120 probe)
E2
ITU-T E2 on 75 ohm coax (using PP090 probe)
E3
ITU-T E3 on 75 ohm coax (using PP090 probe)
E4
ITU-T E4 on 75 ohm coax (using PP090 probe)
Off
STM1E
ITU-T STM-1E on 75 ohm coax (using PP090 probe)
STS1
ANSI T1 STS-1 on 75 ohm coax (using PP090 probe)
STS3E
ANSI T1 STS-3E on 75 ohm coax (using PP090 probe)
1-79
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Stop
Action
Stop the test and reset counters. After this command, a new 'Setup' must be made.
This is one of the action to control the state machine of Mask Testing : Setup, ReAlign, Stop, Pause,
Run and VerticalAlign.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.WaveMasterApplication.1")
'Select an stadard and run the test
app.ElectricalTelecom.Standard = "E1Coax"
app.ElectricalTelecom.Setup
app.ElectricalTelecom.Run
app.Sleep 5000
app.ElectricalTelecom.Pause 'pause the test after 5 seconds
app.Sleep 5000
app.ElectricalTelecom.Stop 'Stop the test
Example
VerticalAlign
Action
For test that allow that, it's possible to perform a Vertical re-alignment .
Description
app.ElectricalTelecom.ET
Aligned waveform output of Electrical Telecom package. From there, all it's diplay settings can be changed. See
"executive setup" chapter for more details.
BipolarLevel
Double
From -100 to 100 step 1e-005
Range
ClearSweeps
Action
Clear any accumulated result data. Useful for example to restart an average, or parameter statistics.
Description
BipolarLevel
Double
ClearSweeps
Action
LabelsPosition
String
LabelsText
String
LFCutoff
Double
Persisted
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ShowLastTrace
Bool
Source
Enum
UseGrid
String
View
Bool
ViewLabels
Bool
1-80
918499 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
LabelsText
String
Any number of characters
Range
LFCutoff
Double
From 1 to 5e+010 step 4
Range
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
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
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
Values
0.5s
10s
1s
20s
2s
5s
Infinite
1-81
918499 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
Source
Enum
Values
C1
C2
C3
C4
UseGrid
String
Any number of characters
Range
View
Bool
Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display
graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure,
etc.
Description
ViewLabels
Bool
Sets/Queries whether the user-defined labels for the trace are visible.
See Also: LabelsPosition and LabelsText controls.
Description
app.ElectricalTelecom.ET.Out.Result
app.HardCopy
This set of variables controls the transfer of information about the screen display to destinations such as such as disc
files, internal memories, printers and remote computers.
Destination
Enum
Directory
FileName
EMailMessage
String
GridAreaOnly
Bool
HardcopyArea
Enum
ImageFileFormat
Enum
PreferredFilename
String
Print
Action
PrintLogo
Bool
1-82
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Destination
Enum
Sets/Queries the destination for hard copy.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the destination for hard copy to e-mail.
app.Hardcopy.Destination = "EMail"
Example
Values
Clipboard
Send to clipboard for pasting into other applications
EMail
Send image in an E-Mail
File
Store image in a file
Printer
Print to a local, or networked printer
Remote
Special case used for remote printing, not usually used
Directory
FileName
Any number of characters
Range
Sets/Queries the directory for hard copy to a file.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the directory for hard copy to files as "D:\HC"
app.Hardcopy.Directory = "D:\HC"
Example
EMailMessage
String
Any number of characters
Range
Sets/Queries the e-mail message.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Create the e-mail message - "Results for run 89".
app.Hardcopy.EMailMessage = "Results for run 89"
Example
UseColor
Enum
1-83
918499 RevA
Automation Command and Query Reference Manual - Control Reference
GridAreaOnly
Bool
Sets/Queries whether hard copy is of grid area only.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the status of Grid Area Only.
GridArea = app.Hardcopy.GridAreaOnly
Example
HardcopyArea
Enum
Sets/Queries the area of the screen to be included in a hard copy.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Select the DSO screen area for hard copy.
app.Hardcopy.HardCopyArea = "DSOWindow"
Example
Values
DSOWindow
Include only the DSO window
FullScreen
Include the full display screen
GridAreaOnly
Include the grid area only (doesn't include menus)
ImageFileFormat
Enum
Sets/Queries the file format for hard copy data.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Select the format PNG for a file of hard copy data.
app.Hardcopy.Destination = "File"
app.Hardcopy.ImageFileFormat = "PNG"
Example
Values
BMP
Windows Bitmap
BMPCOMP
8-bit Windows Bitmap
JPEG
JPEG - JFIF Compliant
PNG
Portable Network Graphics
PSD
Adobe Photoshop 3.0
TIFF
Tagged Image File Format
1-84
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PreferredFilename
String
Any number of characters
Range
Sets/Queries the preferred file name to use for hard copy.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the preferred filename to PrintFile.
app.Hardcopy.PreferredFilename = "PrintFile"
Example
Print
Action
Initiates a hard copy.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Initiate a hard copy.
app.Hardcopy.Print
Example
PrintLogo
Bool
Control whether the LeCroy logo will be superimposed on hardcopies.
Description
UseColor
Enum
Defines the color scheme to be used when printing.
Description
Values
BW
Optimized for black and white printers
Print
Use print colors (white background)
Std
As presented on DSO display
app.LabNotebook
Provides access to the 'LabNotebook' feature. This allows the entire scope state (Waveforms, Setups, Display
Images) to be stored, annotated, recalled, emailed, etc.
AttachFilesToEMail
Bool
BackupDatabase
Action
BackupFilename
String
BackupFolder
FileName
BackupToFolder
Action
BackupToMemoryStick
Action
ClearFilter
Action
CompactDatabase
Action
ConnectToFPHardCopy
Bool
1-85
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Save the current state of the DSO into the Notebook
app.LabNotebook.ScribbleBeforeSaving = False
app.LabNotebook.PromptBeforeSaving = False
app.LabNotebook.Save
' Create a PDF report, and store it in the root of drive
C:app.LabNotebook.ReportsDirectory = "C:\"
app.LabNotebook.Format = "PDF"
app.LabNotebook.CreateReport
' Send the report in an email
app.Preferences.Email.Mode = "SMTP"
app.Preferences.Email.DefaultRecipient = "somebody@somewhere.com"
app.LabNotebook.EMailRecord
Example
AttachFilesToEMail
Bool
If true, the DSO Setup, and all enabled waveforms will be attached to any emailed report.
Description
CreateReport
Action
DeleteAll
Action
DeleteRecord
Action
EMailRecord
Action
FilterRecords
Action
FlashBackToRecord
Action
Format
Enum
HardcopyArea
Enum
InternalView
Action
MyLabNotebookMD
FileName
NextRecord
Action
PreviousRecord
Action
PrintRecord
Action
PromptBeforeSaving
Bool
RecordList
Enum
ReportLogo
FileName
ReportsDirectory
FileName
Save
Action
ScribbleBeforeSaving
Bool
StartNew
Action
UseDefaultLogo
Bool
UseDefaultTemplate
Bool
UsePrintColor
Bool
ViewRecord
Action
XSLTemplate
FileName
1-86
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BackupDatabase
Action
Backup the current LabNotebook database. Note that this control will present a modal dialog,
prompting for the backup filename and folder.
Use the BackupToFolder control to skip the dialog.
Description
BackupFilename
String
Any number of characters
Range
Contains the filename into which the LabNotebook is stored, when the BackupDatabase request is
made.
Description
BackupFolder
FileName
Any number of characters
Range
Contains the folder into which the LabNotebook is stored, when the BackupDatabase request is made.
Description
BackupToFolder
Action
Create a backup of the current LabNotebook database into the file specified by the
BackupFolder/BackupFilename controls.
Description
BackupToMemoryStick
Action
Create a backup of the current LabNotebook database into a file on an attached memory stick.
Description
ClearFilter
Action
Clear the NoteBook entry filter.
Description
CompactDatabase
Action
Compact the LabNotebook database. Useful if entries have been deleted from the database, to
reclaim disk space.
Description
ConnectToFPHardCopy
Bool
If True, the front-panel 'Print Screen' button is overridden to create a LabNotebook entry instead of its
normal function.
Description
CreateReport
Action
Create a report (PDF/RTF/HTML) of the currently selected notebook entry.
Description
1-87
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DeleteAll
Action
Delete all LabNotebook entries.
Note that this action will popup a modal dialog, requesting confirmation.
Description
DeleteRecord
Action
Delete the currently selected LabNotebook record.
Note that this will popup a modal dialog requesting confirmation.
Description
EMailRecord
Action
Email the currently selected record, in the selected format (PDF/RTF/HTML), to the recipient specified
in the email setup (app.Preferences.Email).
Description
FilterRecords
Action
Popup a dialog proposing various filtering methods, including date, and/or keword based filters.
Description
FlashBackToRecord
Action
Restore (FlashBack) the scope to the state that it was in when the current lab notebook entry was
saved.
This may include the setup, and active waveforms.
Description
Format
Enum
File Format in which exported reports are saved.
Description
Values
HTML
PDF
Adobe Acrobat file
RTF
Rich-text file (MS Wordpad, Word, etc.)
HardcopyArea
Enum
Defines the region of the display that is stored when creating a new entry in the notebook.
Description
Values
DSOWindow
Contents of DSO window, incl. dialog + menu bar
FullScreen
Entire windows display area
GridAreaOnly
Grid area only
1-88
918499 RevA
Automation Command and Query Reference Manual - Control Reference
InternalView
Action
View the selected Lab Notebook entry within the DSO's graticule area.
Contrast with the 'ViewRecord' control, which presents the selected Lab Notebook entry in an external
HTML browser.
Description
MyLabNotebookMD
FileName
Any number of characters
Range
Filename of the currently active Lab Notebook database.
Description
NextRecord
Action
Move to (select) the next entry in the notebook.
Description
PreviousRecord
Action
Move to (select) the previous entry in the notebook.
Description
PrintRecord
Action
Print the selected Lab Notebook entry. This action will present a popup allowing the target printer to be
selected .
Description
PromptBeforeSaving
Bool
If true, the DSO will prompt the interactive user for a summary, and description, before the notebook
entry is created.
Description
RecordList
Enum
The list of entries in the Lab Notebook, named using a GUID.
Description
Values
ReportLogo
FileName
Any number of characters
Range
Contains the full pathname of the logo which will appear on Lab Notebook pages.
Description
ReportsDirectory
FileName
Any number of characters
Range
The directory in which Lab Notebook reports are created.
Description
1-89
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Save
Action
Initiate the creation of a new Lab Notebook entry.
Description
ScribbleBeforeSaving
Bool
If True, the DSO will allow the interactive user to 'scribble' (annotate) the report page before it is saved.
Description
StartNew
Action
Start a new Lab Notebook. This action will prompt the interactive user for the filename of the new Lab
Notebook database file.
Description
UseDefaultLogo
Bool
If True, the default logo is used on Lab Notebook pages. If False, the logo specifeid by the
ReportLogo control is used instead.
Description
UseDefaultTemplate
Bool
If True, the default xsl template is used when creating reports from LabNotebook pages.
If False, the template file specified by the XSLTemplate control is used instead.
Description
UsePrintColor
Bool
If True, 'print colors' are used when storing an image of the display. These use a white background, as
opposed to black, to save toner/ink.
Description
ViewRecord
Action
View the selected Lab Notebook entry in an external HTML browser.
Contrast with the 'ViewInternal' control, which presents the selected Lab Notebook entry within the
DSO's graticule area.
Description
XSLTemplate
FileName
Any number of characters
Range
Filename of the XSL template used in creating reports from Lab Notebook pages.
Description
app.LogicAnalyzer
LALogicFamilyA
Enum
LALogicFamilyB
Enum
LAThresholdA
Double
LAThresholdB
Double
LineNames
String
1-90
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LALogicFamilyA
Enum
Values
CMOS2.5V
CMOS3.3V
CMOS5V
ECL
PECL
TTL
UserDefined
LALogicFamilyB
Enum
Values
CMOS2.5V
CMOS3.3V
CMOS5V
ECL
PECL
TTL
UserDefined
LAThresholdA
Double
From -4.9 to 5.27 step 0.01
Range
LAThresholdB
Double
From -4.9 to 5.27 step 0.01
Range
LineNames
String
Any number of characters
Range
List of Digital Line Names
Description
SkewAnalogTrigger
Double
From -1e-006 to 1e-006 step 1e-009
Range
SkewAnalogTrigger
Double
app.LogicAnalyzer.Digitalx
BusName
String
Digital0
Bool
Digital1
Bool
Digital2
Bool
1-91
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BusName
String
Any number of characters
Range
Digital0
Bool
Digital1
Bool
Digital2
Bool
Digital3
Bool
Digital4
Bool
Digital5
Bool
Digital6
Bool
Digital7
Bool
DisplayMode
Enum
Values
Collapse
Expand
LineHeight
Double
From 0.2 to 10 step 0.02
Range
LineNames
String
Any number of characters
Range
UseGrid
String
Any number of characters
Range
Digital3
Bool
Digital4
Bool
Digital5
Bool
Digital6
Bool
Digital7
Bool
DisplayMode
Enum
LineHeight
Double
LineNames
String
UseGrid
String
VerPosition
Double
View
Bool
1-92
918499 RevA
Automation Command and Query Reference Manual - Control Reference
VerPosition
Double
From -3.8 to 10 step 0.05
Range
View
Bool
Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display
graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure,
etc.
Description
app.LogicAnalyzer.Digitalx.Out.Result
app.LogicAnalyzer.Trigger
DigitalPatternArrayLogic0
Enum
DigitalPatternArrayLogic1
Enum
DigitalPatternArrayLogic10
Enum
DigitalPatternArrayLogic11
Enum
DigitalPatternArrayLogic12
Enum
DigitalPatternArrayLogic13
Enum
DigitalPatternArrayLogic14
Enum
DigitalPatternArrayLogic15
Enum
DigitalPatternArrayLogic16
Enum
DigitalPatternArrayLogic17
Enum
DigitalPatternArrayLogic18
Enum
DigitalPatternArrayLogic19
Enum
DigitalPatternArrayLogic2
Enum
DigitalPatternArrayLogic20
Enum
DigitalPatternArrayLogic21
Enum
DigitalPatternArrayLogic22
Enum
DigitalPatternArrayLogic23
Enum
DigitalPatternArrayLogic24
Enum
DigitalPatternArrayLogic25
Enum
DigitalPatternArrayLogic26
Enum
DigitalPatternArrayLogic27
Enum
DigitalPatternArrayLogic28
Enum
DigitalPatternArrayLogic29
Enum
DigitalPatternArrayLogic3
Enum
DigitalPatternArrayLogic30
Enum
DigitalPatternArrayLogic31
Enum
DigitalPatternArrayLogic4
Enum
DigitalPatternArrayLogic5
Enum
DigitalPatternArrayLogic6
Enum
DigitalPatternArrayLogic7
Enum
1-93
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic0
Enum
Allows to select a value for digital line 0 of Logic Pattern Trigger. Value can be Zero, One, Don't Care,
Rising Edge, Falling Edge or Either Edge.
Description
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic8
Enum
DigitalPatternArrayLogic9
Enum
DigitalTriggerByteHex0
String
DigitalTriggerByteHexA0
String
DigitalTriggerSet
Enum
DigitalTriggerType
Enum
I2CAccessType
Enum
I2CAddressCompare
Enum
I2CAddressValue
String
I2CAddressValueLast
String
I2CDataCompare
Enum
I2CDataValue
String
I2CDataValueLast
String
I2CTriggerType
Enum
Interval
Enum
IntervalHigh
Double
LAConnectWarn
String
LATriggerWarn
String
LogicBusSource
Enum
Source
Enum
SPIBitsPerPacket
Integer
SPIInactivePeriodBetweenPacketEnabled
Bool
SPIInactivePeriodBetweenPacketValue
Double
SPITriggerFormat
Enum
SPITriggerMode
Enum
SPITriggerSource
Enum
SPITriggerValue
String
SPITriggerValueLast
String
SPIWhichBitArrivesFirst
Enum
TrigSlope
Enum
Type
Enum
1-94
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic1
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic10
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic11
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic12
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-95
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic13
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic14
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic15
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic16
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-96
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic17
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic18
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic19
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic2
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-97
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic20
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic21
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic22
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic23
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-98
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic24
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic25
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic26
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic27
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-99
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic28
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic29
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic3
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic30
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-100
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic31
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic4
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic5
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic6
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-101
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalPatternArrayLogic7
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic8
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalPatternArrayLogic9
Enum
Values
DontCare
EitherEdge
FallingEdge
One
RisingEdge
Zero
DigitalTriggerByteHex0
String
Any number of characters
Range
DigitalTriggerByteHexA0
String
Any number of characters
Range
DigitalTriggerSet
Enum
Values
Dontcare
EitherEdge
FallingEdge
One
RisingEdge
Zero
1-102
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DigitalTriggerType
Enum
Values
Interval
Logic
LogicBus
I2CAccessType
Enum
Values
AcknowledgedRead
AcknowledgedReadWrite
AcknowledgedWrite
NotAcknowledgedRead
NotAcknowledgedRead
NotAcknowledgedWrite
Read
ReadWrite
Write
I2CAddressCompare
Enum
Values
Matching
NotMatching
I2CAddressValue
String
Any number of characters
Range
I2CAddressValueLast
String
Any number of characters
Range
I2CDataCompare
Enum
Values
Matching
NotMatching
I2CDataValue
String
Any number of characters
Range
I2CDataValueLast
String
Any number of characters
Range
1-103
918499 RevA
Automation Command and Query Reference Manual - Control Reference
I2CTriggerType
Enum
Values
Address
AnyCycle
DataAndAddress
Interval
Enum
Values
GreaterThan
InRange
LessThan
OutOfRange
IntervalHigh
Double
From 8e-009 to 0.00837 step 8e-009
Range
LAConnectWarn
String
Any number of characters
Range
LATriggerWarn
String
Any number of characters
Range
LogicBusSource
Enum
Allows to select the Digital Source of Logic Bus trigger. Only those bits that are defined to be part of
selected Digital Group are allowed to be defined in the Logic Bus trigger value.
Description
Values
Digital1
Digital2
Digital3
Digital4
1-104
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Source
Enum
Values
A0
A1
A10
A11
A12
A13
A14
A15
A2
A3
A4
A5
A6
A7
A8
A9
B0
B1
B10
B11
B12
B13
B14
B15
B2
B3
B4
B5
B6
B7
B8
B9
SPIBitsPerPacket
Integer
From 2 to 32 step 1
Range
SPIInactivePeriodBetweenPacketEnabled
Bool
SPIInactivePeriodBetweenPacketValue
Double
From 8e-009 to 0.00837 step 8e-009
Range
1-105
918499 RevA
Automation Command and Query Reference Manual - Control Reference
SPITriggerFormat
Enum
Values
ASCII
Binary
Hexadecimal
SPITriggerMode
Enum
Values
CPHAS0CPOL0
CPHAS0CPOL1
CPHAS1CPOL0
CPHAS1CPOL1
SPITriggerSource
Enum
Values
MISO
MOSI
SPITriggerValue
String
Any number of characters
Range
SPITriggerValueLast
String
Any number of characters
Range
SPIWhichBitArrivesFirst
Enum
Values
LSB
MSB
TrigSlope
Enum
Values
Negative
Positive
Type
Enum
Values
I2C
Interval
Logic
1-106
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.Math
Variables of the form app.Math.xxxx control the mathematical functions F1 through F8.
Names of the form app.Math.Functions("Fx").xxxx are aliases of simpler names which are described in this section of
the manual. Examples of alias pairs are as follows -
app.Math.Functions("Fx") is equivalent to app.Math.Fx
app.Math.Functions("Fx").Out.Result is equivalent to app.Math.Fx.Out.Result
app.Math.Functions("Fx").Zoom is equivalent to app.Math.Zoom.Fx
Please see under Acquisition.Channels for a programming example.
ClearSweeps
Action
Clear sweeps for history functions such as average, histogram and trend. See also the general
'app.ClearSweeps' control which clears accumulated data for all subsystems, including persistence,
measurement statistics, etc.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Clear sweeps for all history functions.
app.Math.ClearSweeps
Example
ResetAll
Action
Reset the math subsystem to its default state.
All currently selected math operators, and other settings will be lost.
Description
ClearSweeps
Action
ResetAll
Action
app.Math.Functions
Names of the form app.Math.Functions("Fx").xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Math. Examples of alias pairs are as follows -
app.Math.Functions("Fx") is equivalent to app.Math.Fx
app.Math.Functions("Fx").Out.Result is equivalent to app.Math.Fx.Out.Result
app.Math.Functions("Fx").Zoom is equivalent to app.Math.Zoom.Fx
Please see under Acquisition.Channels for a programming example.
app.Math.Fx
This set of variables controls the math functions F1 through F8.
ClearSweeps
Action
DoResetZoom
Action
DoStoreToMemoryTrace
Action
Equation
String
1-107
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
Clears accumulated data for a single function trace.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Reset accumulation for trace F1
app.Math.F1.ClearSweeps
Example
DoResetZoom
Action
Resets the zoom state of math trace Fx.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Reset zoom of math function F3.
app.Math.F3.DoResetZoom
Example
DoStoreToMemoryTrace
Action
Store data from math function Fx to a memory trace.
Destination for F1 will be M1, F2 will be M2, etc.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Store math function F2 to a memory trace.
app.Math.F2.DoStoreToMemoryTrace
Example
LabelsPosition
String
LabelsText
String
MathMode
Enum
Operator1
Enum
Persisted
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ShowLastTrace
Bool
Source1
Enum
UseGrid
String
View
Bool
ViewLabels
Bool
1-108
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Equation
String
Any number of characters
Range
Queries the equation which defines the math function Fx.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the definition of math function F3.
EquationF3 = app.Math.F3.Equation
MsgBox EquationF3
Example
LabelsPosition
String
Any number of characters
Range
Sets / Queries the horizontal position of the label attached to the trace Fx. 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 F1, one at 0ns, and one at 55ns
app.SetToDefaultSetup
app.Math.F1.View = True
app.Math.F1.ViewLabels = True
app.Math.F1.LabelsPosition = "0.0, 55e-9"
app.Math.F1.LabelsText = "Hello,World"
Example
LabelsText
String
Any number of characters
Range
Sets / Queries the text that appears in labels attached to acquisition trace Cx. Multiple labels may be
specified by using comma as a delimiter. See the documentation on LabelsPosition for an example of
use.
Description
1-109
918499 RevA
Automation Command and Query Reference Manual - Control Reference
MathMode
Enum
Sets/Queries the math mode.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the mode of the math function F1
app.Math.F1.MathMode = "TwoOperators"
Example
Values
OneOperator
Single math operator
TwoOperators
Chain two math operators
1-110
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Operator1
Enum
Sets/Queries the first operator of math function Fx. When MathMode = "OneOperator, this is the only
math operator, when MathMode = "TwoOperator", this is the first of two operators. Note that when
MathMode = "Graph", this control has no effect.
Note also that the list of available math operators varies depending upon the instrument model
number, and the list of installed software options.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Define the first operator of math function F1 as an Average
app.Math.F1.View = True
app.Math.F1.MathMode = "OneOperator"
app.Math.F1.Operator1 = "Average"
Example
Values
AbsoluteValue
Average
Derivative
Difference
EnhancedResolution
Envelope
FFT
Floor
Integral
Invert
Null
Product
Ratio
Reciprocal
Rescale
Roof
Square
SquareRoot
Sum
Zoom
1-111
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Persisted
Bool
Sets/Queries the persisted state of the function 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 F3.
app.Math.F3.Persisted = 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 F1.
app.Math.F1.PersistenceSaturation = 40
Example
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 trace F1 to 10 seconds.
app.Math.F1.PersistenceTime = "10s"
Example
Values
0.5s
10s
1s
20s
2s
5s
Infinite
1-112
918499 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")
' Do not show the last trace for the persistence trace of trace F1.
app.Math.F1.ShowLastTrace = False
Example
Source1
Enum
Sets/Queries the first source of the first operator in Fx. Note that the two possible sources of
Operator1 are Source1 and Source2, Source3 is the second source to Operator2, with the first source
of Operator2 being the ouput of Operator1.
Note that the list of available sources is dependent upon the instrument model, and it's installed
software options.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Define the first source of math function F1 as C3.
app.Math.F1.Source1 = "C3"
Example
Values
C1
C2
C3
C4
Digital1
Digital2
Digital3
Digital4
ET
M1
M2
M3
M4
Z1
Z2
Z3
Z4
1-113
918499 RevA
Automation Command and Query Reference Manual - Control Reference
UseGrid
String
Any number of characters
Range
Sets/Queries the grid in use for the math trace Fx.
See also app.Acquisition.Cx.UseGrid.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Place math trace F3 on grid YT4.
app.Math.F3.UseGrid = "YT4"
Example
View
Bool
Sets/Queries whether the trace of math function Fx is visible. Note that even when math traces are
not visible, but are being used as inputs to other math functions and/or measurements, they are
computed.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Show math trace F3.
app.Math.F3.View = True
Example
ViewLabels
Bool
Sets/Queries whether trace labels, defined with LabelsText and LabelsPosition controls, are shown.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Show the user-defined trace label for trace F1
app.Math.F1.ViewLabels = True
Example
app.Math.Fx.Operator1Setup
This node is dynamically created, and will contain the controls for the operator currently selected into Operator1.
See the Math/Measure Control reference at the end of this manual for a lost of these controls.
app.Math.Fx.Out.Result
Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other
cvars are changed after that acquisition was completed. This distinction between "Out.Result" properties and other
cvars is most important when the trigger mode is Single or Stopped. You should treat "Out.Result" properties as read-
only.
For a detailed description of all properties available for the output of a Math Function, please see Chapter 1.
1-114
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.Math.Fx.Zoom
This set of variables controls the zoom functions for math trace Fx.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Turn on trace F1, will default to Zoom-Only
app.Math.F1.View = True
app.Math.F1.Source1 = "C1"
' Zoom trace F1 by a factor of 2 horizontally and vertically
app.Math.F1.Zoom.Rese
Example
HorPos
Double
From -0.5 to 0.5 step (8 digits)
Range
Sets/Queries the horizontal position of center of the grid on the zoomed trace Fx. The unit of
measurement is the screen width, that is, 0.3 means a shift of three of the ten divisions. A positive
value moves the trace to the left.
Description
HorZoom
Double
From 0.1 to 1e+006 step (8 digits)
Range
Sets/Queries the horizontal magnification of the trace Fx. The magnification will be in a 1 2 5 10
sequence unless variable horizontal magnification has been set.
Description
ResetZoom
Action
Reset the trace Fx to x1 zoom and zero offset in both axes, so that it is identical to its input trace.
Description
VariableHorZoom
Bool
Sets/Queries the ability to zoom horizontally by a continuously variable factor. Note that if a horizontal
zoom of 0.9 is set, while variable zoom is off, the horizontal zoom will be set to 1.0. If the variable
zoom is then enabled, the factor of 0.9 will have been remembered, and it will be used. Note that the
previous value will not be remembered during a power-cycle.
Description
HorPos
Double
HorZoom
Double
ResetZoom
Action
VariableHorZoom
Bool
VariableVerZoom
Bool
VerPos
Double
VerZoom
Double
1-115
918499 RevA
Automation Command and Query Reference Manual - Control Reference
VariableVerZoom
Bool
Sets/Queries the ability to zoom vertically by a continuously variable factor. Note that if a vertical
zoom of 0.9 is set, while variable zoom is off, the vertical zoom will be set to 1.0. If the variable zoom
is then enabled, the factor of 0.9 will have been remembered, and it will be used. Note that the
previous value will not be remembered during a power-cycle.
Description
VerPos
Double
From -1.5 to 1.5 step (8 digits)
Range
Sets/Queries the vertical position of center of the grid on the zoomed trace Fx. The unit of
measurement is the screen height, that is, 0.375 means a shift of three of the eight divisions. A
positive value moves the trace downwards.
Description
VerZoom
Double
From 0.1 to 100 step (8 digits)
Range
Sets/Queries the vertical magnification of the trace Fx. The magnification will be in a 1 2 5 10
sequence unless VariableVerZoom has been set to True, in which case it will be continuously variable.
Description
app.Math.XY
This set of variables controls the display of data in X vs. Y mode. Only Valid when the instrument is in XY, XYSingle,
or XYDual display modes.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Switch to XY+Dual Grid Mode
app.Display.GridMode = "XYDual"
' Configure XY to show C1 vs. C2 in 3D Persistence mode
app.Math.XY.InputX = "C1"
app.Math.XY.InputY = "C2"
app.Math
Example
ClearSweeps
Action
Clears persistence X-Y plot.
Description
ClearSweeps
Action
InputX
Enum
InputY
Enum
Persisted
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ShowLastTrace
Bool
1-116
918499 RevA
Automation Command and Query Reference Manual - Control Reference
InputX
Enum
Sets/Queries the name of the input channel for the X axis of the X-Y plot.
Description
Values
C1
C2
C3
C4
Digital1
Digital2
Digital3
Digital4
ET
F1
M1
M2
M3
M4
Z1
Z2
Z3
Z4
1-117
918499 RevA
Automation Command and Query Reference Manual - Control Reference
InputY
Enum
Sets/Queries the name of the input channel for the Y axis of the X-Y plot.
Description
Values
C1
C2
C3
C4
Digital1
Digital2
Digital3
Digital4
ET
F1
M1
M2
M3
M4
Z1
Z2
Z3
Z4
Persisted
Bool
Sets/Queries the persisted state of the X-Y plot. 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
PersistenceSaturation
Integer
From 0 to 100 step 1
Range
Sets/Queries the saturation threshold for persisted X-Y plot. 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
1-118
918499 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 the Xy
persistence. See the general description above for a discussion of the locked and unlocked
persistence modes.
Description
Values
0.5s
10s
1s
20s
2s
5s
Infinite
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
app.Math.XY.Out.Result
Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other
cvars are changed after that acquisition was completed. This distinction between "Out.Result" properties and other
cvars is most important when the trigger mode is Single or Stopped. You should treat "Out.Result" properties as read-
only.
Note that this XY result object is very similar, but not identical to the result object exposed by the channel and math
traces. The differences are due to the fact that the XY trace returns pairs of data values, one for X, one for Y.
For a detailed description of all properties available for the output of an XY trace, please see Chapter 1.
app.Measure
Variables of the form app.Measure control the parameters P1 through P8, and their associated statistical results and
histicons.
Names of the forms app.Measure.Measure("Premote").xxxx and app.Measure.Measure("Px").xxxx are aliases of
simpler names which are described in this section of the manual. Examples of alias pairs are as follows -
app.Measure.Measure("Premote").OutResult is equivalent to app.Measure."Premote".OutResult
app.Measure.Measure("Px").Statistics is equivalent to app.Measure.Px.Statistics
Please see under Acquisition.Channels for a programming example.
ClearAll
Action
ClearSweeps
Action
SetGateToDefault
Action
ShowMeasure
Bool
1-119
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' get into the custom parameter mode
app.Measure.MeasureMode = "MyMeasure"
app.Measure.ClearAll
app.Measure.StatsOn = True
app.Measure.HistoOn = False
' Configure P1 to measure a
Example
ClearAll
Action
Resets all parameter setups, turning each of the parameters view to "off", the MeasurementType to
"measure"and the selected paramEngine to "Null".
Description
ClearSweeps
Action
Clears the accumulated statistics for parametersP1 to P8 as well as the acumulated statistics for their
associated histicons.
Description
SetGateToDefault
Action
Sets the measure gate to its default state. Valid only when in either Std. Vertical or Std. Horizontal
measurement modes. For MyMeasure see the equivalent controls under Px.
Description
ShowMeasure
Bool
Defines whether the measure results table is displayed or not.
Description
StatsOn
Bool
Sets/Queries the visibility of parameter statistics. Note: the statistics are accumulated whether the
view of them is on or not, so you needn't have StatsOn = "On" to collect statistics.
Description
StdGateStart
Double
From 0 to 10 step 0.01
Range
Sets/Queries the position of the left hand limit of the measure gate (n divisions).
Valid only when in either Std. Vertical or Std. Horizontal measurement modes. For MyMeasure see the
equivalent controls under Px.
Description
StatsOn
Bool
StdGateStart
Double
StdGateStop
Double
1-120
918499 RevA
Automation Command and Query Reference Manual - Control Reference
StdGateStop
Double
From 0 to 10 step 0.01
Range
Sets/Queries the position of the right hand limit of the measure gate (in divisions). Valid only when in
either Std. Vertical or Std. Horizontal measurement modes. For MyMeasure see the equivalent
controls under Px.
Description
app.Measure.Measure
Names of the forms app.Measure.Measure("Premote").xxxx and app.Measure.Measure("Px").xxxx are aliases of
simpler names which are described in the section of the manual which is devoted to app.Measure. Examples of alias
pairs are as follows -
app.Measure.Measure("Premote").OutResult is equivalent to app.Measure."Premote".OutResult
app.Measure.Measure("Px").Statistics is equivalent to app.Measure.Px.Statistics
Please see under app.Acquisition.Channels("Cx") for a programming example.
app.Measure.PRemote
GateByRange
Bool
GateByWform
Bool
GateByRange
Bool
GateByWform
Bool
WformSource
Enum
1-121
918499 RevA
Automation Command and Query Reference Manual - Control Reference
WformSource
Enum
Values
C1
C2
C3
C4
DigitalA0
DigitalA1
DigitalA10
DigitalA11
DigitalA12
DigitalA13
DigitalA14
DigitalA15
DigitalA2
DigitalA3
DigitalA4
DigitalA5
DigitalA6
DigitalA7
DigitalA8
DigitalA9
DigitalB0
DigitalB1
DigitalB10
DigitalB11
DigitalB12
DigitalB13
DigitalB14
DigitalB15
DigitalB2
DigitalB3
DigitalB4
DigitalB5
DigitalB6
DigitalB7
DigitalB8
DigitalB9
ET
F1
M1
M2
M3
M4
Z1
1-122
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Z2
Z3
Z4
app.Measure.PRemote.histo.Result
app.Measure.PRemote.last.Result
app.Measure.PRemote.max.Result
app.Measure.PRemote.mean.Result
app.Measure.PRemote.min.Result
app.Measure.PRemote.num.Result
app.Measure.PRemote.sdev.Result
app.Measure.PRemote.Statistics
app.Measure.Px
This set of variables controls the parameters P1 through P8, (when the MeasureMode is "MyMeasure", otherwise
these are predefined) and the statistical results and histicons which depend on them.
GateByRange
Bool
1-123
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
app.Measure.MeasureMode = "MyMeasure"
' Set parameter P1 to math on parameters.
App.Measure.P1.MeasurementType = "math"
Example
GateByRange
Bool
If True, only measurements who's value(s) fall between the limits defined by the LowerLimit and
UpperLimit controls, are accepted.
Description
GateByWform
Bool
If True, measurements are gated by the state of the waveform defined by the WformSource control.
Description
GateStart
Double
From 0 to 10 step 0.01
Range
Sets/Reads the position of the left hand edge of the measure gate for parameter Px.
Description
GateStop
Double
From 0 to 10 step 0.01
Range
Sets/Reads the position of the right hand edge of the measure gate for parameter Px.
Description
MeasurementType
Enum
Sets/Queries the measurement type of the parameter Px.
Description
Values
measure
Standard measurement mode (parametric of a trace waveform)
GateByRange
Bool
GateByWform
Bool
GateStart
Double
GateStop
Double
MeasurementType
Enum
ParamEngine
Enum
Source1
Enum
1-124
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ParamEngine
Enum
Sets/Queries the parameter (measurement on a trace) for Px. This setting applies only if the
MeasurementType control is set to "measure".
Description
Values
Amplitude
Area
Base
Delay
DutyCycle
Fall
Fall8020
Frequency
I2StoValue
Maximum
Mean
Minimum
Null
OvershootNegative
OvershootPositive
PeakToPeak
Period
Phase
Rise
Rise2080
RootMeanSquare
Skew
StandardDeviation
Top
Width
WidthNegative
1-125
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Source1
Enum
Sets/Queries the first trace source of the parameter Px. Used only when MeasurementType =
"measure", for MeasurementType = "math", refer to PSource1.
Description
Values
C1
C2
C3
C4
DigitalA0
DigitalA1
DigitalA10
DigitalA11
DigitalA12
DigitalA13
DigitalA14
DigitalA15
DigitalA2
DigitalA3
DigitalA4
DigitalA5
DigitalA6
DigitalA7
DigitalA8
DigitalA9
DigitalB0
DigitalB1
DigitalB10
DigitalB11
DigitalB12
DigitalB13
DigitalB14
DigitalB15
DigitalB2
DigitalB3
DigitalB4
DigitalB5
DigitalB6
DigitalB7
DigitalB8
DigitalB9
ET
F1
M1
M2
1-126
918499 RevA
Automation Command and Query Reference Manual - Control Reference
M3
M4
Z1
Z2
Z3
Z4
app.Measure.Px.histo.Result
app.Measure.Px.last.Result
app.Measure.Px.max.Result
app.Measure.Px.mean.Result
app.Measure.Px.min.Result
app.Measure.Px.num.Result
app.Measure.Px.Operator
This path specifies that the selected ParamEngine or ArithEngine control variables are "here"
app.Measure.Px.Out.Result
Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other
cvars are changed after that acquisition was completed. This distinction between "Out.Result" properties and other
cvars is most important when the trigger mode is Single or Stopped. You should treat "Out.Result" properties as read-
only.
1-127
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.Measure.Px.sdev.Result
app.Measure.Px.Statistics
This set of variables controls the statistical summaries that are provided for all the parameters.
app.Memory
Variables of the form app.Memory.xxxx control the memories M1 through M4.
Names of the form app.Memory.Memories("Mx").xxxx are aliases of simpler names which are described in this
section of the manual. Examples of alias pairs are as follows -
app.Memory.Memories("Mx").Out.Result is equivalent to app.Memory.Mx.Out.Result
app.Memory.Memories("Mx").Zoom is equivalent to app.Memory.Mx.Zoom
Please see under app.Acquisition.Channels("Cx") for a programming example.
ClearAllMem
Action
Clears the contents of all trace memories.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Clear the contents of all trace memories.
app.Memory.ClearAllMem
Example
ClearAllMem
Action
app.Memory.Memories
Names of the form app.Memory.Memories("Mx").xxxx are aliases of simpler names which are described in the
section of the manual which is devoted to app.Memory. Examples of alias pairs are as follows -
app.Memory.Memories("Mx").Out.Result is equivalent to app.Memory.Mx.Out.Result
app.Memory.Memories("Mx").Zoom is equivalent to app.Memory.Mx.Zoom
Please see under Acquisition.Channels for a programming example.
app.Memory.Mx
This set of variables controls the memories M1 through M4.
ClearMem
Action
1-128
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ClearMem
Action
Initiates a clear memory operation for memory Mx.
Description
Copy
Action
Copy the trace specified by the Source1 control into this memory.
Description
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
LabelsText
String
Any number of characters
Range
Action
Copy
Action
LabelsPosition
String
LabelsText
String
Source1
Enum
UseGrid
String
UserText
String
View
Bool
ViewLabels
Bool
1-129
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Source1
Enum
Source trace for Copy operations (see 'Copy' control)
Description
Values
C1
C2
C3
C4
Digital1
Digital2
Digital3
Digital4
ET
F1
M2
M3
M4
Z1
Z2
Z3
Z4
UseGrid
String
Any number of characters
Range
Sets/Queries the grid used for memory trace Mx.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set memory trace M2 to use grid YT3.
app.Memory.M2.UseGrid = "YT3"
Example
UserText
String
Any number of characters
Range
Text field, used to attach arbitrary comments to a memory waveform.
Description
View
Bool
Sets/Queries whether memory trace Mx is visible.
Description
1-130
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewLabels
Bool
Sets/Queries whether labels are visible for trace Mx.
Description
app.Memory.Mx.Out.Result
See app.Acquisition.Cx.Out.Result for a definition of methods and properties used to access the Mx waveform result.
app.Memory.Mx.Zoom
This set of variables controls zooming of the memory traces M1 through M4.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Save C1 into M1
app.SaveRecall.Waveform.SaveTo = "Memory"
app.SaveRecall.Waveform.SaveSource = "C1"
app.SaveRecall.Waveform.SaveDestination = "M1"
app.SaveRecall.Waveform.DoSave
Example
HorPos
Double
From -0.5 to 0.5 step (8 digits)
Range
Sets/Queries the horizontal position of center of the grid on the zoomed trace Mx. The unit of
measurement is the screen width, that is, 0.3 means a shift of three of the ten divisions. A positive
value moves the trace to the left.
Description
HorZoom
Double
From 0.1 to 1e+006 step (8 digits)
Range
Sets/Queries the horizontal magnification of the trace Mx. The magnification will be in a 1 2 5 10
sequence unless variable horizontal magnification has been set.
Description
ResetZoom
Action
Resets the zoom for trace Mx.
Description
HorPos
Double
HorZoom
Double
ResetZoom
Action
VariableHorZoom
Bool
VariableVerZoom
Bool
VerPos
Double
VerZoom
Double
1-131
918499 RevA
Automation Command and Query Reference Manual - Control Reference
VariableHorZoom
Bool
Sets/Queries the ability to zoom horizontally by a continuously variable factor as opposed to a factor
that follows a 1, 2, 5 sequence.
Description
VariableVerZoom
Bool
Sets/Queries the ability to zoom vertically by a continuously variable factor as opposed to a factor that
follows a 1, 2, 5 sequence.
Description
VerPos
Double
From -1.5 to 1.5 step (8 digits)
Range
Sets/Queries the vertical position of center of the grid on the zoomed trace Mx. The unit of
measurement is the screen height, that is, 0.375 means a shift of three of the eight divisions. A
positive value moves the trace downwards.
Description
VerZoom
Double
From 0.1 to 100 step (8 digits)
Range
Sets/Queries the vertical magnification of the trace Mx. The magnification will be in a 1 2 5 10
sequence unless variable vertical magnification has been set.
Description
app.PassFail
Names of the forms app.PassFail("Qremote").xxxx and app.PassFail("Qx").xxxx are aliases of simpler names which
are described in this section of the manual. Examples of alias pairs are as follows -
app.PassFail.PassFail("Qremote").Operator is equivalent to app.PassFail.Qremote.Operator
app.PassFail.PassFail("Qx").Out.Result is equivalent to app.PassFail.Qx.Out.Result
Please see under app.Acquisition.Channels("Cx") for a programming example.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Setup Parameter P1 to be the amplitude of C1
app.Measure.MeasureMode = "MyMeasure"
app.Measure.P1.ParamEngine = "Ampl"
app.Measure.P1.Source1 = "C1"
app.Measure.P1.View = True
Example
ActionOn
Enum
Alarm
Bool
PredefinedConditions
Enum
PrintScreen
Bool
Pulse
Bool
Save
Bool
Stop
Bool
Testing
Bool
1-132
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ActionOn
Enum
Sets/Queries whether a Pass condition or a Fail condition will initiate the pre-selected actions.
Description
Values
Fail
Pass
Alarm
Bool
Sets/Queries whether Alarm is included in the PassFail actions.
Description
PredefinedConditions
Enum
Sets/Queries the logical criteria that must be met in a pass-fail test. For example, the condition
AnyTrue means that the pass-fail criterion is met if at least one of the test conditions results in a True
result.
Description
Values
AllTrue
PrintScreen
Bool
Sets/Queries whether Print Screen is included in the PassFail actions.
Description
Pulse
Bool
Sets/Queries whether Pulse is included in the PassFail actions. This action emits a pulse from the Aux
output socket.
Description
Save
Bool
Sets/Queries whether Save is included in the PassFail actions.
Description
Stop
Bool
Sets/Queries whether Stop is included in the PassFail actions.
Description
Testing
Bool
Sets/Queries whether PassFail testing is on.
Description
app.PassFail.LastPass.Result
1-133
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.PassFail.NumPassed.Result
app.PassFail.Qx
This set of variables controls the tests Q1 through Q8 in the pass fail system.
ClearSweeps
Action
ClearSweeps
Description
ConditionEngine
Enum
Sets/Queries whether pass-fail test Qx uses mask testing or parameter comparison.
Description
Values
MaskTestCondition
Equation
String
Any number of characters
Range
Inspects the equation for pass-fail test Qx. A typical equation would be "All P3 < 0.7071".
Description
ShortDescription
String
Any number of characters
Range
ShortDescription
Description
View
Bool
Sets/Queries whether pass-fail test Qx is visible.
Description
ClearSweeps
Action
ConditionEngine
Enum
Equation
String
ShortDescription
String
View
Bool
WSource1
Enum
1-134
918499 RevA
Automation Command and Query Reference Manual - Control Reference
WSource1
Enum
WSource1
Description
Values
C1
C2
C3
C4
ET
F1
M1
M2
M3
M4
XY
Z1
Z2
Z3
Z4
app.PassFail.Qx.Out.Result
Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other
cvars are changed after that acquisition was completed. This distinction between "Out.Result" properties and other
cvars is most important when the trigger mode is Single or Stopped. You should treat "Out.Result" properties as read-
only.
app.PassFail.Rate.Result
app.PassFail.Tests.Result
app.Preferences
This set of variables controls user preferences for the instrument setup and operation.
AudibleFeedback
Bool
EnhancedPrecisionMode
Bool
HorOffsetControl
Enum
Language
Enum
1-135
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AudibleFeedback
Bool
Sets/Queries whether audible feedback is enabled, to sound when a control is touched.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Turn on the audible feedback function.
app.Preferences.AudibleFeedback = True
Example
EnhancedPrecisionMode
Bool
EnhancedPrecisionMode
Description
HorOffsetControl
Enum
HorOffsetControl.
Description
Values
Div
Time
Language
Enum
Language
Description
Values
ChineseSimplified
English
French
German
Italian
Japanese
Korean
OffsetControl
Enum
Sets/Queries whether Vertical Offset constant in Volts or Divisions when the vertical scale control is
changed.
Description
Values
Div
Volts
OffsetControl
Enum
1-136
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.Preferences.EMail
This set of variables controls user preferences for the instrument e-mail system.
E-Mail may be sent when the hardcopy button is pressed when the hardcopy system is appropriately configured. Two
standards are supported, SMTP (Simple Mail Transport Protocol), and MAPI (Messaging Application Programming
Interface).
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure the originator and recipient addresses, replace these with
' appropriate values for your corporate network.
app.Preferences.Email.DefaultRecipient = "recipientAddress@do
Example
DefaultRecipient
String
Any number of characters
Range
Sets/Queries the default recipient of e-mail transmissions.
Description
Mode
Enum
Sets/Queries the transmission mode for e-mail.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set e-Mail mode to MAPI.
app.Preferences.EMail.Mode = "MAPI"
Example
Values
MAPI
Messaging Application Programming Interface (Uses Outlook Express by default)
SMTP
Simple Mail Transfer Protocol, requires an SMTP server
OriginatorAddress
String
Any number of characters
Range
Sets/Queries the originator address for e-mail. This may be any address, and will be used when the
recipient replies to a mail, note that the instrument doesn't necessarily have to have it's own E-Mail
account in order to use this.
Description
DefaultRecipient
String
Mode
Enum
OriginatorAddress
String
SendTestMail
Action
SMTPServer
String
1-137
918499 RevA
Automation Command and Query Reference Manual - Control Reference
SendTestMail
Action
Sends a message by e-mail to test the system.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Send an e-Mail message to test the system.
app.Preferences.EMail.SendTestMail
Example
SMTPServer
String
Any number of characters
Range
Sets/Queries the name of the SMTP Server for e-mail. Ask your system administrator if you are
unsure of what value to set this to.
Description
app.RecallSetupLock
app.SaveRecall
Controls for the Save/Recall subsystem. Includes nodes for saving and recalling both Waveforms and Panels
(Setups).
ShowLSIBExport
Action
ShowSaveTable
Action
ShowLSIBExport
Action
ShowSaveTable
Action
app.SaveRecall.Setup
Controls for Saving and Recalling instrument setups.
DoRecallDefaultNvlPanel
Action
DoRecallDefaultPanel
Action
DoRecallPanel
Action
DoSavePanel
Action
InternalName1
String
InternalName2
String
InternalName3
String
InternalName4
String
InternalName5
String
InternalName6
String
1-138
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Reset to default setup
app.SaveRecall.Setup.DoRecallDefaultPanel
' Store the current setup into the first of the 6 setup stores.
app.SaveRecall.Setup.InternalName1 = "My Setup1"
Example
DoRecallDefaultNvlPanel
Action
Recalls the factory set NVL (preference) panel settings. These are controls which are not affected
when the default panel is recalled, and includes items such as the color preferences, remote control
preferences, etc. Use with care!, especially when invoking via the VBS? Remote command via GPIB
or TCP/IP, which could result in the controller being disconnected when the default port is selected.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Recall the factory default nvl panel settings.
app.SaveRecall.Setup.DoRecallDefaultNvlPanel
Example
DoRecallDefaultPanel
Action
Recalls the factory set panel settings.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Recall the factory default panel settings.
app.SaveRecall.Setup.DoRecallDefaultPanel
Example
PanelDir
FileName
PanelFilename
FileName
RecallInternal1
Action
RecallInternal2
Action
RecallInternal3
Action
RecallInternal4
Action
RecallInternal5
Action
RecallInternal6
Action
SaveInternal1
Action
SaveInternal2
Action
SaveInternal3
Action
SaveInternal4
Action
SaveInternal5
Action
SaveInternal6
Action
1-139
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DoRecallPanel
Action
Recall the panel file named in the PanelFilename control.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Create the filename for the next panel setup to be recalled.
app.SaveRecall.Setup.PanelFilename = "Setup89"
' Recall the panel setup from the named file.
app.SaveRecall.Setup.DoRecallPanel
Example
DoSavePanel
Action
Saves the current panel settings to the previously specified file. If the filename already exists, the file
will be over-written without a prompt.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Create the filename for the next panel setup save.
app.SaveRecall.Setup.PanelFilename = "TestSave"
' Save the panel setup to the named file.
app.SaveRecall.Setup.DoSavePanel
Example
InternalName1
String
Any number of characters
Range
Sets/Queries the name of internal panel setup memory 1.
Description
InternalName2
String
Any number of characters
Range
Please see InternalName1.
Description
InternalName3
String
Any number of characters
Range
Please see InternalName1.
Description
InternalName4
String
Any number of characters
Range
Please see InternalName1.
Description
1-140
918499 RevA
Automation Command and Query Reference Manual - Control Reference
InternalName5
String
Any number of characters
Range
Please see InternalName1.
Description
InternalName6
String
Any number of characters
Range
Please see InternalName1.
Description
PanelDir
FileName
Any number of characters
Range
Directory in which setups are stored/recalled.
Description
PanelFilename
FileName
Any number of characters
Range
Sets/Queries the current filename for saving a panel setup. Note that a '.lss' extension is automatically
appended if not supplied.
Description
RecallInternal1
Action
Recall the settings which are stored in internal panel memory 1.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Recall the settings from internal panel memory 1.
app.SaveRecall.Setup.RecallInternal1
Example
RecallInternal2
Action
Please see RecallInternal1.
Description
RecallInternal3
Action
Please see RecallInternal1.
Description
RecallInternal4
Action
Please see RecallInternal1.
Description
1-141
918499 RevA
Automation Command and Query Reference Manual - Control Reference
RecallInternal5
Action
Please see RecallInternal1.
Description
RecallInternal6
Action
Please see RecallInternal1.
Description
SaveInternal1
Action
Saves the current instrument settings into internal panel memory 1.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Save the current settings into internal panel memory 1.
app.SaveRecall.Setup.SaveInternal1
Example
SaveInternal2
Action
Please see SaveInternal1.
Description
SaveInternal3
Action
Please see SaveInternal1.
Description
SaveInternal4
Action
Please see SaveInternal1.
Description
SaveInternal5
Action
Please see SaveInternal1.
Description
SaveInternal6
Action
Please see SaveInternal1.
Description
app.SaveRecall.Table
Delimiter
Enum
DoSave
Action
SaveSource
Enum
TableDir
FileName
TableFormat
Enum
TableTitle
String
1-142
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Delimiter
Enum
Values
Comma
Semicolon
Space
Tab
DoSave
Action
SaveSource
Enum
Values
AllDisplayed
TableDir
FileName
Any number of characters
Range
TableFormat
Enum
Values
ASCII
Excel
TableTitle
String
Any number of characters
Range
app.SaveRecall.Utilities
Controls used to manage files and folders, including the ability to create and delete folders, and the ability to delete
files.
CreateDir
Action
Creates the directory specified in the Directory control.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Create a named directory
app.SaveRecall.Utilities.Directory = "C:\MyDir"
Example
CreateDir
Action
DeleteAll
Action
DeleteFile
Action
Directory
FileName
1-143
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.SaveRecall.Utilities.CreateDir
DeleteAll
Action
Deletes all files in the directory specified by the Directory control without a cautionary prompt.
Use with care! Files cannot be recovered if deleted accidentally.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Delete all files without showing a yes/no prompt.
app.SaveRecall.Utilities.Directory = "C:\MyDir"
app.SaveRecall.Utilities.DeleteAll
Example
DeleteFile
Action
Deletes the file named by the Filename control
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Delete the named file
app.SaveRecall.Utilities.Filename = "C:\MyDir\MyFile.txt"
app.SaveRecall.Utilities.DeleteFile
Example
Directory
FileName
Any number of characters
Range
Defines the directory which will be used for the operations in this automation node.
Description
app.SaveRecall.Waveform
Contains controls used for saving and recalling waveforms.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
Example
Delimiter
Enum
DoRecall
Action
DoSave
Action
RecallDestination
Enum
RecallFrom
Enum
RecallSource
Enum
SaveDestination
Enum
SaveSource
Enum
SaveTo
Enum
TraceTitle
String
WaveFormat
Enum
WaveformDir
FileName
1-144
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' Save C1 into M1
app.SaveRecall.Waveform.SaveTo = "Memory"
app.SaveRecall.Waveform.SaveSource = "C1"
app.SaveRecall.Waveform.SaveDestination = "M1"
app.SaveRecall.Waveform.DoSave
Delimiter
Enum
Sets/Queries the delimiter to use when saving data in ASCII text mode.
Description
Values
Comma
Semicolon
Space
Tab
DoRecall
Action
Recall waveform data into a trace memory. Source may be either an internal memory (M1..M4), or a
file on a mass-storage device, depending on the state of the 'RecallFrom' control.
Description
DoSave
Action
Save waveform data into an internal memory, or file on a mass-storage device, using the pre-specified
source and destination.
Description
RecallDestination
Enum
Sets/Queries the destination for waveform recall. When the DoRecall action is executed the waveform
will be transferred into this destination trace.
Description
Values
M1
M2
M3
M4
RecallFrom
Enum
Sets/Queries the type of source for waveform recall.
Description
Values
File
Recall from file on a mass-storage device
Memory
Recall from one of the internal memories (M1..M4)
1-145
918499 RevA
Automation Command and Query Reference Manual - Control Reference
RecallSource
Enum
Sets/Queries the source for recalling waveform data. Used only when recalling from an internal
memory with RecallSource = "Memory".
Description
Values
M1
M2
M3
M4
SaveDestination
Enum
Sets/Queries the destination to which waveform data will be saved. Used only when the SaveTo =
"Memory".
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Setup to store trace C2 into M4 and perform the save operation
app.SaveRecall.Waveform.SaveTo = "Memory"
app.SaveRecall.Waveform.SaveSource = "C2"
app.SaveRecall.Waveform.SaveDestination = "M4"
app.SaveRecall.Waveform.DoSave
Example
Values
M1
M2
M3
M4
1-146
918499 RevA
Automation Command and Query Reference Manual - Control Reference
SaveSource
Enum
Sets/Queries the source from which waveform data will be saved.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the destination to memory for waveform save.
app.SaveRecall.Waveform.SaveTo = "Memory"
' Set the source to C2, for saving a waveform.
app.SaveRecall.Waveform.SaveSource = "C2"
' Set the destination to memory M4, for saving a waveform.
app.SaveRecall.Waveform.SaveDestination = "M4"
' Save waveform data as previously specified.
app.SaveRecall.Waveform.DoSave
Example
Values
AllDisplayed
C1
C2
C3
C4
Digital1
Digital2
Digital3
Digital4
ET
F1
M1
M2
M3
M4
Z1
Z2
Z3
Z4
1-147
918499 RevA
Automation Command and Query Reference Manual - Control Reference
SaveTo
Enum
Sets/Queries type of destination for waveform save.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the destination to Memory for waveform save.
app.SaveRecall.Waveform.SaveTo = "Memory"
Example
Values
File
Save into file on a mass-storage device
Memory
Save into an internal memory (M1..M4)
TraceTitle
String
Any number of characters
Range
Sets/Queries the title (prefix) to use when naming saved traces. This prefix will have the family
(sequence) number appended to it when forming the filename.
Description
WaveFormat
Enum
Sets/Queries the format to use when saving waveform data into a file. 'Binary' is the most efficient,
storing one or two bytes per data sample, depending upon the number of significant bits. When in
ASCII mode, the Subformat and Delimiter controls define the data format.
Description
Values
ASCII
Plain ASCII files with choice of various delimiters
Binary
LeCroy's standard binary waveform format
Excel
MathCad
MATLAB
WaveformDir
FileName
Any number of characters
Range
Sets/Queries the directory for storing waveform files.
Description
app.SerialDecode
AnnotationPositionPreference
Enum
LinkedToTrigger1
Bool
LinkedToTrigger2
Bool
LinkedToTrigger3
Bool
LinkedToTrigger4
Bool
SelectDecoder
Enum
1-148
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AnnotationPositionPreference
Enum
Values
OnNoisyTrace
OnTrace
LinkedToTrigger1
Bool
LinkedToTrigger2
Bool
LinkedToTrigger3
Bool
LinkedToTrigger4
Bool
SelectDecoder
Enum
Values
Decode1
Decode2
Decode3
Decode4
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioI2S")
Annotate
Enum
BitOrder
Enum
BitsInChannel
Integer
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSOffset
Integer
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
IgnoreCS
Bool
MinSamplesPerBit
Integer
ViewingMode
Enum
1-149
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Annotate
Enum
Values
All
Left
Right
BitOrder
Enum
Values
LSB
MSB
BitsInChannel
Integer
From 1 to 32 step 1
Range
BitsPerByte
Integer
From 2 to 32 step 1
Range
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
Negative
Positive
ColumnState
String
Any number of characters
Range
1-150
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Falling
Rising
CSOffset
Integer
From 0 to 31 step 1
Range
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
IgnoreCS
Bool
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
1-151
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
Binary
dB
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioLJ")
Annotate
Enum
Values
All
Left
Right
BitOrder
Enum
Values
LSB
MSB
Annotate
Enum
BitOrder
Enum
BitsInChannel
Integer
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSOffset
Integer
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
IgnoreCS
Bool
MinSamplesPerBit
Integer
ViewingMode
Enum
1-152
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitsInChannel
Integer
From 1 to 32 step 1
Range
BitsPerByte
Integer
From 2 to 32 step 1
Range
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
Negative
Positive
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
1-153
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Falling
Rising
CSOffset
Integer
From 0 to 31 step 1
Range
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
IgnoreCS
Bool
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
ViewingMode
Enum
Values
Binary
dB
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioRJ")
Annotate
Enum
1-154
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Annotate
Enum
Values
All
Left
Right
BitOrder
Enum
Values
LSB
MSB
BitsInChannel
Integer
From 1 to 32 step 1
Range
BitsPerByte
Integer
From 2 to 32 step 1
Range
BitOrder
Enum
BitsInChannel
Integer
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSOffset
Integer
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
IgnoreCS
Bool
MinSamplesPerBit
Integer
ViewingMode
Enum
1-155
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
Negative
Positive
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
CSLevelType
Enum
Values
Absolute
Percent
1-156
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLockMode
Enum
Values
Falling
Rising
CSOffset
Integer
From 0 to 31 step 1
Range
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
IgnoreCS
Bool
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
ViewingMode
Enum
Values
Binary
dB
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioTDM")
Annotate
Enum
BitOrder
Enum
BitsInChannel
Integer
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
1-157
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Annotate
Enum
Values
All
Audio1
Audio2
Audio3
Audio4
Audio5
Audio6
Audio7
Audio8
BitOrder
Enum
Values
LSB
MSB
BitsInChannel
Integer
From 1 to 32 step 1
Range
BitsPerByte
Integer
From 2 to 32 step 1
Range
ClockPhase
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSOffset
Integer
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
IgnoreCS
Bool
MinSamplesPerBit
Integer
ViewingMode
Enum
1-158
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
Negative
Positive
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
CSLevelType
Enum
Values
Absolute
Percent
1-159
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLockMode
Enum
Values
Falling
Rising
CSOffset
Integer
From 0 to 31 step 1
Range
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
IgnoreCS
Bool
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
ViewingMode
Enum
Values
Binary
dB
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "CAN")
BitRate
Double
ColumnState
String
GMLAN
Bool
LevelPercent
Double
LevelType
Enum
ShowStuffBits
Bool
Tolerance
Double
1-160
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 10 to 2e+007 step 1
Range
ColumnState
String
Any number of characters
Range
GMLAN
Bool
LevelPercent
Double
From 0 to 100 step 0.1
Range
LevelType
Enum
Values
Absolute
Percent
ShowStuffBits
Bool
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
Hexadecimal
ViewingMode
Enum
app.SerialDecode.Decode[n].Protocol (Protocol = "CANHL")
BitRate
Double
From 10 to 2e+007 step 1
Range
BitRate
Double
ColumnState
String
GMLAN
Bool
LevelPercent
Double
LevelType
Enum
ShowStuffBits
Bool
Tolerance
Double
ViewingMode
Enum
1-161
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ColumnState
String
Any number of characters
Range
GMLAN
Bool
LevelPercent
Double
From 0 to 100 step 0.1
Range
LevelType
Enum
Values
Absolute
Percent
ShowStuffBits
Bool
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
Hexadecimal
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANHL")
BitRate
Double
From 10 to 2e+007 step 1
Range
ColumnState
String
Any number of characters
Range
GMLAN
Bool
BitRate
Double
ColumnState
String
GMLAN
Bool
LevelPercent
Double
LevelType
Enum
ShowStuffBits
Bool
Tolerance
Double
ViewingMode
Enum
1-162
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LevelPercent
Double
From 0 to 100 step 0.1
Range
LevelType
Enum
Values
Absolute
Percent
ShowStuffBits
Bool
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
Hexadecimal
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANLAN")
BitRate
Double
From 10 to 2e+007 step 1
Range
ColumnState
String
Any number of characters
Range
GMLAN
Bool
LevelPercent
Double
From 0 to 100 step 0.1
Range
BitRate
Double
ColumnState
String
GMLAN
Bool
LevelPercent
Double
LevelType
Enum
ShowStuffBits
Bool
Tolerance
Double
ViewingMode
Enum
1-163
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LevelType
Enum
Values
Absolute
Percent
ShowStuffBits
Bool
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
Hexadecimal
app.SerialDecode.Decode[n].Protocol (Protocol = "I2C")
AddressWithRW
Bool
BitRate
Double
From 10 to 2e+006 step 1
Range
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ColumnState
String
Any number of characters
Range
AddressWithRW
Bool
BitRate
Double
ClockLevelPercent
Double
ClockLevelType
Enum
ColumnState
String
DataLevelPercent
Double
DataLevelType
Enum
Tolerance
Double
ViewingMode
Enum
1-164
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
ASCII
Binary
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "LIN")
BitRate
Double
From 1000 to 20000 step 1
Range
ColumnState
String
Any number of characters
Range
LevelPercent
Double
From 0 to 100 step 0.1
Range
LevelType
Enum
Values
Absolute
Percent
BitRate
Double
ColumnState
String
LevelPercent
Double
LevelType
Enum
LINVersion
Enum
Tolerance
Double
1-165
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LINVersion
Enum
Values
ALL
J2602
Rev1.3
Rev2.x
Tolerance
Double
From 0.01 to 10 step 0.01
Range
app.SerialDecode.Decode[n].Protocol (Protocol = "MIL1553")
BitRate
Double
From 1000 to 2e+007 step 50
Range
ColumnState
String
Any number of characters
Range
FBO
Double
From 0 to 50 step 0.1
Range
HalfSyncWidth
Double
From 4e-008 to 0.025 step 1e-008
Range
LevelHAbsolute
Double
From -10 to 10 step 0.05
Range
BitRate
Double
ColumnState
String
FBO
Double
HalfSyncWidth
Double
LevelHAbsolute
Double
LevelHType
Enum
LevelLAbsolute
Double
LevelLType
Enum
MinSamplesPerBit
Integer
NPproximity
Double
TableMode
Enum
ViewingMode
Enum
1-166
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LevelHType
Enum
Values
Absolute
Percent
LevelLAbsolute
Double
From -10 to 10 step 0.05
Range
LevelLType
Enum
Values
Absolute
Percent
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
NPproximity
Double
From 1e-009 to 0.005 step 1e-009
Range
TableMode
Enum
Values
Transfer
Word
ViewingMode
Enum
Values
Binary
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "RS232")
BitRate
Double
ByteOrderUI
Enum
ColumnState
String
DataBitsUI
Integer
LevelPercent
Double
LevelType
Enum
Parity
Enum
ParityUI
Enum
PolarityUI
Enum
StopBitsUI
Enum
Tolerance
Double
1-167
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 30 to 5e+008 step 1
Range
ByteOrderUI
Enum
Values
LSB
MSB
ColumnState
String
Any number of characters
Range
DataBitsUI
Integer
From 5 to 16 step 1
Range
LevelPercent
Double
From 0 to 100 step 0.1
Range
LevelType
Enum
Values
Absolute
Percent
Parity
Enum
Values
Even
Mark
None
Odd
Space
ParityUI
Enum
Values
Even
None
Odd
ViewingMode
Enum
1-168
918499 RevA
Automation Command and Query Reference Manual - Control Reference
PolarityUI
Enum
Values
IdleHigh
IdleLow
StopBitsUI
Enum
Values
1
2
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
ASCII
Binary
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "SIOP")
BitOrder
Enum
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ClockPolarity
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
InterFrameTime
Double
MinSamplesPerBit
Integer
TDMChannel
Integer
ViewingMode
Enum
1-169
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitOrder
Enum
Values
LSB
MSB
BitsPerByte
Integer
From 2 to 32 step 1
Range
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
0
1
ClockPolarity
Enum
Values
0
1
ColumnState
String
Any number of characters
Range
1-170
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Both
Falling
Rising
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
Values
Auto
Manual
1-171
918499 RevA
Automation Command and Query Reference Manual - Control Reference
InterFrameTime
Double
From 1e-009 to 10 step 1e-009
Range
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
TDMChannel
Integer
From 1 to 8 step 1
Range
ViewingMode
Enum
Values
ASCII
Binary
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "SPI")
BitOrder
Enum
BitOrder
Enum
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ClockPolarity
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
InterFrameTime
Double
MinSamplesPerBit
Integer
TDMChannel
Integer
ViewingMode
Enum
1-172
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Values
LSB
MSB
BitsPerByte
Integer
From 2 to 32 step 1
Range
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
0
1
ClockPolarity
Enum
Values
0
1
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
1-173
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Both
Falling
Rising
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
Values
Auto
Manual
InterFrameTime
Double
From 1e-009 to 10 step 1e-009
Range
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
1-174
918499 RevA
Automation Command and Query Reference Manual - Control Reference
TDMChannel
Integer
From 1 to 8 step 1
Range
ViewingMode
Enum
Values
ASCII
Binary
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "SPICustom")
BitOrder
Enum
Values
LSB
MSB
BitOrder
Enum
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ClockPolarity
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
InterFrameTime
Double
MinSamplesPerBit
Integer
TDMChannel
Integer
ViewingMode
Enum
1-175
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitsPerByte
Integer
From 2 to 32 step 1
Range
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
0
1
ClockPolarity
Enum
Values
0
1
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
1-176
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Both
Falling
Rising
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
Values
Auto
Manual
InterFrameTime
Double
From 1e-009 to 10 step 1e-009
Range
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
TDMChannel
Integer
From 1 to 8 step 1
Range
1-177
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
ASCII
Binary
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "SPIDDR")
BitOrder
Enum
Values
LSB
MSB
BitsPerByte
Integer
From 2 to 32 step 1
Range
BitOrder
Enum
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ClockPolarity
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
InterFrameTime
Double
MinSamplesPerBit
Integer
TDMChannel
Integer
ViewingMode
Enum
1-178
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
0
1
ClockPolarity
Enum
Values
0
1
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
1-179
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Both
Falling
Rising
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
Values
Auto
Manual
InterFrameTime
Double
From 1e-009 to 10 step 1e-009
Range
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
TDMChannel
Integer
From 1 to 8 step 1
Range
1-180
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
ASCII
Binary
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "SSPI")
BitOrder
Enum
Values
LSB
MSB
BitsPerByte
Integer
From 2 to 32 step 1
Range
BitOrder
Enum
BitsPerByte
Integer
ByteSlicer
Enum
ClockLevelPercent
Double
ClockLevelType
Enum
ClockPhase
Enum
ClockPolarity
Enum
ColumnState
String
Conversion
Enum
CSLevelPercent
Double
CSLevelType
Enum
CSLockMode
Enum
CSPolarity
Enum
DataLevelPercent
Double
DataLevelType
Enum
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
InterFrameTime
Double
MinSamplesPerBit
Integer
TDMChannel
Integer
ViewingMode
Enum
1-181
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ByteSlicer
Enum
Values
CSbased
CSbasedMulti
HolebasedMulti
NoHole
Std
UserCol
ClockLevelPercent
Double
From 0 to 100 step 0.1
Range
ClockLevelType
Enum
Values
Absolute
Percent
ClockPhase
Enum
Values
0
1
ClockPolarity
Enum
Values
0
1
ColumnState
String
Any number of characters
Range
Conversion
Enum
Values
Binary
Binary2Cpl
CSLevelPercent
Double
From 0 to 100 step 0.1
Range
1-182
918499 RevA
Automation Command and Query Reference Manual - Control Reference
CSLevelType
Enum
Values
Absolute
Percent
CSLockMode
Enum
Values
Both
Falling
Rising
CSPolarity
Enum
Values
ActiveHigh
ActiveLow
DataLevelPercent
Double
From 0 to 100 step 0.1
Range
DataLevelType
Enum
Values
Absolute
Percent
DDR
Bool
IgnoreCS
Bool
InterFrameSetup
Enum
Values
Auto
Manual
InterFrameTime
Double
From 1e-009 to 10 step 1e-009
Range
MinSamplesPerBit
Integer
From 4 to 100 step 1
Range
TDMChannel
Integer
From 1 to 8 step 1
Range
1-183
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
ASCII
Binary
Dec
Hex
app.SerialDecode.Decode[n].Protocol (Protocol = "UART")
BitRate
Double
From 30 to 5e+008 step 1
Range
ByteOrderUI
Enum
Values
LSB
MSB
ColumnState
String
Any number of characters
Range
DataBitsUI
Integer
From 5 to 16 step 1
Range
LevelPercent
Double
From 0 to 100 step 0.1
Range
BitRate
Double
ByteOrderUI
Enum
ColumnState
String
DataBitsUI
Integer
LevelPercent
Double
LevelType
Enum
Parity
Enum
ParityUI
Enum
PolarityUI
Enum
StopBitsUI
Enum
Tolerance
Double
ViewingMode
Enum
1-184
918499 RevA
Automation Command and Query Reference Manual - Control Reference
LevelType
Enum
Values
Absolute
Percent
Parity
Enum
Values
Even
Mark
None
Odd
Space
ParityUI
Enum
Values
Even
None
Odd
PolarityUI
Enum
Values
IdleHigh
IdleLow
StopBitsUI
Enum
Values
1
2
Tolerance
Double
From 0.01 to 10 step 0.01
Range
ViewingMode
Enum
Values
ASCII
Binary
Hex
app.SerialDecode.Decodex
AnnotationPosition
Enum
1-185
918499 RevA
Automation Command and Query Reference Manual - Control Reference
AnnotationPosition
Enum
Values
Bottom
Centered
OnNoisyTrace
OnTrace
Top
DataSource
Enum
OutputFile
FileName
Protocol
Enum
View
Bool
ViewDecode
Bool
1-186
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DataSource
Enum
The Data Source has to be entered here. The source can be any channel, function or memory. The
Data Source is required for every protocol supported whereas Clock and Chip Select might not be
Description
Values
C1
C2
C3
C4
DigitalA0
DigitalA1
DigitalA10
DigitalA11
DigitalA12
DigitalA13
DigitalA14
DigitalA15
DigitalA2
DigitalA3
DigitalA4
DigitalA5
DigitalA6
DigitalA7
DigitalA8
DigitalA9
DigitalB0
DigitalB1
DigitalB10
DigitalB11
DigitalB12
DigitalB13
DigitalB14
DigitalB15
DigitalB2
DigitalB3
DigitalB4
DigitalB5
DigitalB6
DigitalB7
DigitalB8
DigitalB9
ET
F1
M1
M2
1-187
918499 RevA
Automation Command and Query Reference Manual - Control Reference
M3
M4
Z2
Z3
Z4
OutputFile
FileName
Any number of characters
Range
The name and path of the File used to export the Decoded Table
Description
Protocol
Enum
The protocol currently decoded by this Decoder. At the time of this writing (July of 2007) we support 7
protocols:8b10, CAN, FlexRay, I2C, LIN, UART, SPI. The options purchased govern the list of visible
protocol in this field.
Description
Values
AudioI2S
AudioLJ
AudioRJ
AudioTDM
CAN
CANHL
GMCANHL
GMCANLAN
I2C
LIN
MIL1553
RS232
SIOP
SPI
SPICustom
SPIDDR
SSPI
UART
View
Bool
Turns the Table View on and off.
Description
ViewDecode
Bool
Turns the Annotation View on and off.
Description
app.SerialDecode.Decodex.Decode
1-188
918499 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 10 to 2e+007 step 1
Range
The Bitrate of the data stream to be decoded
Description
ColumnState
String
Any number of characters
Range
This variable lists the visibility state of the columns in the decoded table
Each column is named, followed by an equal sign and the state on or off.
On turns on the column, off turns it off.
Description
The following command would show 3 columns
Time=on|Data=on|DataLength=on
whereas this comand would only show Time and DataLength
Time=on|Data=on|DataLength=off
Example
LevelPercent
Double
From 0 to 100 step 0.1
Range
The threshold between zeros and ones expressed in Percent of the distance between top and base.
Description
LevelType
Enum
The selection between absolute and relative threshold mode
Description
Values
Absolute
Percent
ViewingMode
Enum
Selects viewing mode, usually between Binary,Hexadecimal, ASCII
Description
Values
Hexadecimal
BitRate
Double
ColumnState
String
LevelPercent
Double
LevelType
Enum
ViewingMode
Enum
app.SerialDecode.Decodex.Out.Result
1-189
918499 RevA
Automation Command and Query Reference Manual - Control Reference
app.SystemControl
FrontPanelEventTimestamp
String
Any number of characters
Range
ModalDialogTimeout
Integer
From 0 to 120 step 1
Range
Set a timeout, in units of seconds, used to auto-dismiss modal dialogs, with their default responses.
Description
PersistentMessage
String
Any number of characters
Range
FrontPanelEventTimestamp
String
ModalDialogTimeout
Integer
PersistentMessage
String
app.Utility.DateTimeSetup
This set of variables controls user the date and time setup. In addition to manual controls for hh/mm/ss, dd/mm/yy,
there is the ability to set the time and date from an Internet clock using the SNTP protocol.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set time/date from the NIST Internet clock
app.Utility.DateTimeSetup.SetFromSNTP
Example
CurrentDateAndTime
String
Any number of characters
Range
Reads the current date and time from the real-time calendar and clock.
Description
CurrentDateAndTime
String
Day
Integer
Hour
Integer
Minute
Integer
Month
Integer
Second
Integer
SetFromSNTP
Action
Validate
Action
Year
Integer
1-190
918499 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the current date and time from the real-time calendar and clock.
app.Utility.DateTimeSetup.CurrentDateAndTime
Example
Day
Integer
From 1 to 31 step 1
Range
Sets/Queries the day of the month setting of the real-time clock as a number.
The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate
is sent. All time/date controls are validated at the same time.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the day of the month as 21.
app.Utility.DateTimeSetup.Day = 21
app.Utility.DateTimeSetup.Validate
Example
Hour
Integer
From 0 to 23 step 1
Range
Sets/Queries the hours setting of the real-time clock as a number.
The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate
is sent. All time/date controls are validated at the same time.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the hour as 13.
app.Utility.DateTimeSetup.Hour = 13
app.Utility.DateTimeSetup.Validate
Example
Minute
Integer
From 0 to 59 step 1
Range
Sets/Queries the minutes setting of the real-time clock as a number.
The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate
is sent. All time/date controls are validated at the same time.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the minute as 34.
app.Utility.DateTimeSetup.Minute = 34
app.Utility.DateTimeSetup.Validate
Example
1-191
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Month
Integer
From 1 to 12 step 1
Range
Sets/Queries the month setting of the real-time clock as a number.
The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate
is sent. All time/date controls are validated at the same time.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the month as August.
app.Utility.DateTimeSetup.Month = 8
app.Utility.DateTimeSetup.Validate
Example
Second
Integer
From 0 to 59 step 1
Range
Sets/Queries the seconds setting of the real-time clock as a number.
The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate
is sent. All time/date controls are validated at the same time.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the seconds as 55.
app.Utility.DateTimeSetup.Second = 55
app.Utility.DateTimeSetup.Validate
Example
SetFromSNTP
Action
Sets the real time clock from the simple network time protocol.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the real time clock from the simple network time protocol.
app.Utility.DateTimeSetup.SetFromSNTP
Example
1-192
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Validate
Action
Validates any new settings. This action is equivalent to clicking 'Validate Changes' on the Date/Time
page.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the day, hour, and minute, and validate.
app.Utility.DateTimeSetup.Day = 3
app.Utility.DateTimeSetup.Hour = 5
app.Utility.DateTimeSetup.Minute = 8
app.Utility.DateTimeSetup.Validate
Example
Year
Integer
From 2000 to 2037 step 1
Range
Sets/Queries the year setting of the real-time clock as a number.
The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate
is sent. All time/date controls are validated at the same time.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set the year as 2003.
app.Utility.DateTimeSetup.Year = 2003
app.Utility.DateTimeSetup.Validate
Example
app.Utility.Options
Options subsystem, contains controls to query the list of installed software and hardware options.
InstalledHWOptions
String
Any number of characters
Range
Shows a list of the installed hardware options.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the list of installed hardware options and present
' in a popup dialog
MsgBox app.Utility.Options.InstalledHWOPtions
Example
InstalledHWOptions
String
InstalledSWOptions
String
ScopeID
String
1-193
918499 RevA
Automation Command and Query Reference Manual - Control Reference
InstalledSWOptions
String
Any number of characters
Range
Shows list of installed software options.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the list of installed software options and display
' in a popup dialog
MsgBox app.Utility.Options.InstalledSWOPtions
Example
ScopeID
String
Any number of characters
Range
Queries the ID of the instrument. This ID should be specified when purchasing software options for
your instrument.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Read the ID of the instrument.
MsgBox app.Utility.Options.ScopeID
Example
app.Utility.Remote
Controls related to the remote control section of the instrument. Note that in this context Automation is not considered
part of 'Remote'. Remote control currently includes control using ASCII remote commands from GPIB or TCP/IP.
Assistant
Enum
Sets/Queries the setting of the remote assistant.
Description
Values
EO
Log errors only
FD
Log all remote commands/queries
OFF
Turn the assistant off
Assistant
Enum
Interface
Enum
RestrictControl
Enum
SetToErrorsOnlyAndClearAtStartup
Bool
1-194
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Interface
Enum
Sets/Queries the currently selected type of currently selected remote control interface.
Description
Values
LXI
Off
TCPIP
RestrictControl
Enum
Sets/Queries whether remote control is restricted to certain hosts, where the host name is defined
either by IP address, or dns name.
Description
Values
No
Yes
SetToErrorsOnlyAndClearAtStartup
Bool
Enable the resetting of the remote assistant to 'Errors Only' mode when the instrument is reset. Also
ensure s that the remote assistant log is cleared upon startup.
This control is set by default to lower the risk that the remote assistant will be set to 'Full Dialog' mode
and be forgotten, causing a decrease in remote control performance.
Description
app.Utility.Remote.IOManager.CIOPortU3GPIB
GpibAddress
Integer
From 1 to 30 step 1
Range
GpibAddress
Integer
app.Utility.Remote.IOManager.CLSIBPort
app.WaveScan
This is the root of the WaveScan automation hierarchy.
WaveScan enables you to search for unusual events in a single capture, or to scan for an event in many
acquisitions over a long period of time.
It may be considered a kind of software trigger.
Enable
Bool
1-195
918499 RevA
Automation Command and Query Reference Manual - Control Reference
Enable
Bool
Sets/Queries the WaveScan enabled state.
Description
FindRare1Sigma
Action
Preset the filter limit and delta to find rare events. Uses the history of measurements since the last
Clear Sweeps, or control change, to set the limit and delta to capture +/- 1 sigma events.
Description
FindRare3Sigma
Action
Preset the filter limit and delta to find rare events. Uses the history of measurements since the last
Clear Sweeps, or control change, to set the limit and delta to capture +/- 3 sigma events.
Description
FindRare5Sigma
Action
Preset the filter limit and delta to find rare events. Uses the history of measurements since the last
Clear Sweeps, or control change, to set the limit and delta to capture +/- 5 sigma events.
Description
FindUseMean
Action
Setup the filter to find measurements with values > the current statistical mean.
Description
ShowTimes
Bool
FindRare1Sigma
Action
FindRare3Sigma
Action
FindRare5Sigma
Action
FindUseMean
Action
ShowTimes
Bool
app.WaveScan.ScanDecode
ClearSweeps
Action
Clear any accumulated result data. Useful for example to restart an average, or parameter statistics.
Description
TableLocation
String
Any number of characters
Range
ClearSweeps
Action
TableLocation
String
View
Bool
1-196
918499 RevA
Automation Command and Query Reference Manual - Control Reference
View
Bool
Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display
graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure,
etc.
Description
app.WaveScan.ScanDecode.Out.Result
app.Zoom
QuickZoom
Action
Zoom all Cx that are on at an horizontal factor of 10.
Description
ResetAll
Action
Reset all Zx to their default settings.
Description
QuickZoom
Action
ResetAll
Action
app.Zoom.Zx
ClearSweeps
Action
Clear any accumulated result data. Useful for example to restart an average, or parameter statistics.
Description
ClearSweeps
Action
DoStoreToMemoryTrace
Action
Equation
String
LabelsPosition
String
LabelsText
String
Persisted
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ShowLastTrace
Bool
Source
Enum
UseGrid
String
View
Bool
ViewLabels
Bool
1-197
918499 RevA
Automation Command and Query Reference Manual - Control Reference
DoStoreToMemoryTrace
Action
Store the content of Zx into the corresponding Memory Slot (Mx).
Description
Equation
String
Any number of characters
Range
Same as app.Math.Fx.Equation.
Description
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
LabelsText
String
Any number of characters
Range
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
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
1-198
918499 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
Values
0.5s
10s
1s
20s
2s
5s
Infinite
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
Source
Enum
Zoom source trace.
Description
Values
C1
C2
C3
C4
Digital1
Digital2
Digital3
Digital4
ET
F1
M1
M2
M3
M4
Z2
Z3
Z4
1-199
918499 RevA
Automation Command and Query Reference Manual - Control Reference
UseGrid
String
Any number of characters
Range
Sets/Queries the grid in use for the zoom trace Zx.
See also app.Acquisition.Cx.UseGrid.
Description
View
Bool
Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display
graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure,
etc.
Description
ViewLabels
Bool
Sets/Queries whether the user-defined labels for the trace are visible.
See Also: LabelsPosition and LabelsText controls.
Description
app.Zoom.Zx.Out.Result
app.Zoom.Zx.Zoom
HorPos
Double
From -0.5 to 0.5 step (8 digits)
Range
Horizontal Position of the trace, normalized to a value between -0.5 and 0.5. A value of zero is the
default, and indicates no position change relative to the source trace.
Description
HorZoom
Double
From 0.1 to 1e+006 step (8 digits)
Range
Horizontal Zoom setting. Locked to a 1, 2, 5 sequence unless VariableHorZoom is set to True .
Description
HorPos
Double
HorZoom
Double
ResetZoom
Action
VariableHorZoom
Bool
VariableVerZoom
Bool
VerPos
Double
VerZoom
Double
1-200
918499 RevA
Automation Command and Query Reference Manual - Control Reference
ResetZoom
Action
Resets the zoom settings to their default values.
Description
VariableHorZoom
Bool
Enable/Disable the variable Horizontal Zoom control. If enabled, the HorZoom control may be set to a
value other than the standard 1, 2, 5 sequence.
Description
VariableVerZoom
Bool
Enable/Disable the variable Vertical Zoom control. If enabled, the VerZoom control may be set to a
value other than the standard 1, 2, 5 sequence.
Description
VerPos
Double
From -1.5 to 1.5 step (8 digits)
Range
Vertical Position of the trace, normalized to a value between -1.5 and 1.5. A value of zero is the
default, and indicates no position change relative to the source trace.
Description
VerZoom
Double
From 0.1 to 100 step (8 digits)
Range
Vertical Zoom setting. Locked to a 1, 2, 5 sequence unless VariableVerZoom is set to True .
Description
1-201
918499 RevA
Automation Command and Query Reference Manual - Processor Reference Table of Contents
Average.......................................................................................................................................................................
2-1
Derivative....................................................................................................................................................................
2-2
EnhancedResolution...................................................................................................................................................
2-3
Envelope.....................................................................................................................................................................
2-3
FFT..............................................................................................................................................................................
2-4
Floor............................................................................................................................................................................
2-5
Integral........................................................................................................................................................................
2-5
Rescale.......................................................................................................................................................................
2-6
Roof.............................................................................................................................................................................
2-7
Amplitude....................................................................................................................................................................
2-8
Area.............................................................................................................................................................................
2-8
Base............................................................................................................................................................................
2-9
Maximum.....................................................................................................................................................................
2-9
Mean...........................................................................................................................................................................
2-9
Minimum......................................................................................................................................................................
2-9
OvershootNegative......................................................................................................................................................
2-10
OvershootPositive.......................................................................................................................................................
2-10
PeakToPeak................................................................................................................................................................
2-10
Phase..........................................................................................................................................................................
2-10
RootMeanSquare........................................................................................................................................................
2-13
Skew............................................................................................................................................................................
2-14
StandardDeviation.......................................................................................................................................................
2-16
Top..............................................................................................................................................................................
2-16
i
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
AVERAGE
app.Math.Fx.OperatorYSetup (Operator = "Average")
Waveform Averaging.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Turn trace F1 on and setup to average the data from C1
' Average mode is set to Continuous
app.Math.F1.View = True
app.Math.F1.Operator1 = "Average"
app.Math.F1.MathMode = "OneOpe
Example
AverageType
Enum
Sets / Queries the averaging mode. Continuous and Summation modes are supported.
Description
Values
Continuous
Summed
ClearSweeps
Action
Clears all averaged sweeps.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Clear sweeps for average in trace F1.
app.Math.F1.Operator1Setup.ClearSweeps
Example
InvalidInputPolicy
Bool
AverageType
Enum
ClearSweeps
Action
InvalidInputPolicy
Bool
Sweeps
Integer
2-1
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
Sweeps
Integer
From 1 to 1000000 step 1
Range
Sets / Queries the number of sweeps to be averaged when trace Fx is set to averaging - continuous or
summed.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set number of sweeps to be averaged in trace F1 as 20.
app.Math.F1.Operator1Setup.Sweeps = 20
Example
DERIVATIVE
app.Math.Fx.OperatorYSetup (Operator = "Derivative")
Computes the derivative of the waveform (next_sample_value - this_sample_value) / horizontal_sample_interval.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Start a find scale operation for derivative function trace F1
app.Math.F1.View = True
app.Math.F1.MathMode = "OneOperator"
app.Math.F1.Operator1 = "Derivative"
app.Math.F1.Operato
Example
EnableAutoScale
Bool
Sets/Queries whether the autoscale function is enabled for the derivative function trace Fx. If enabled,
an auto-scale operation is performed whenever the setup changes.
Description
FindScale
Action
Initiates a Find Scale action, to set a suitable vertical scale for the derivative function trace Fx.
Description
VerOffset
Double
From -1e+006 to 1e+006 step 1e-009
Range
Sets/Queries the vertical offset of the derivative function trace Fx.
Description
EnableAutoScale
Bool
FindScale
Action
VerOffset
Double
VerScale
DoubleLockstep
2-2
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
VerScale
DoubleLockstep
From 1e-012 to 1e+013 step 10000, locked to 1 2 5, fine grain allowed=false, on=false
Range
Sets/Queries the vertical scale of the derivative function Fx.
Description
ENHANCEDRESOLUTION
app.Math.Fx.OperatorYSetup (Operator = "EnhancedResolution")
Bits
Enum
Number of bits of enhanced resolution. ERES is a FIR filter with a gaussian frequency response.
Description
Values
0.5
Enhance by 0.5 bits
1
Enhance by 1 bits
1.5
Enhance by 1.5 bits
2
Enhance by 2 bits
2.5
Enhance by 2.5 bits
3
Enhance by 3 bits
Bits
Enum
ENVELOPE
app.Math.Fx.OperatorYSetup (Operator = "Envelope")
Envelope of minimum and maximum values for an ensemble of sweeps, or 'Extrema'
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure F3 to be an envelope of C1
app.Math.F3.View = True
app.Math.F3.Source1 = "C1"
app.Math.F3.MathMode = "OneOperator"
app.Math.F3.Operator1 = "Envelope"
app.Math.F3.Operat
Example
ClearSweeps
Action
Initiates a Clear Sweeps operation for envelope function trace Fx.
Description
ClearSweeps
Action
LimitNumSweeps
Bool
Sweeps
Integer
2-3
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
LimitNumSweeps
Bool
Sweeps
Integer
From 1 to 1000000 step 1
Range
Sets/Queries the maximum number of sweeps to be used by the envelope function trace Fx.
Description
FFT
app.Math.Fx.OperatorYSetup (Operator = "FFT")
Fast Fourier Transform of waveform data.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure F3 to perform an FFT of C1
app.Math.F3.View = True
app.Math.F3.Source1 = "C1"
app.Math.F3.MathMode = "OneOperator"
app.Math.F3.Operator1 = "FFT"
app.Math.F3.Operator1Se
Example
SuppressDC
Bool
Enables/Disables suppression of the value at zero frequency in the FFT spectrum.
Description
Type
Enum
Sets/Queries the type of FFT spectrum for function trace Fx.
Description
Values
Magnitude
Magnitude with linear vertical scale
PowerSpectrum
Power Spectrum
SuppressDC
Bool
Type
Enum
Window
Enum
2-4
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
Window
Enum
Sets/Queries the type of window for the FFT function trace Fx.
Description
Values
BlackmanHarris
FlatTop
Hamming
Rectangular
VonHann
FLOOR
app.Math.Fx.OperatorYSetup (Operator = "Floor")
Most negative or minimum values for an ensemble of sweeps, or "Floor"
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure F1 to measure the Floor of the first 1000
' sweeps of C1
app.Math.F1.View = True
app.Math.F1.Source1 = "C1"
app.Math.F1.MathMode = "OneOperator"
app.Math.F1.Operator1
Example
ClearSweeps
Action
Initiates a clear sweeps action for the Floor function trace Fx.
Description
LimitNumSweeps
Bool
Sweeps
Integer
From 1 to 1000000 step 1
Range
Sets/Queries the maximum number of sweeps for the Floor function trace Fx.
Description
ClearSweeps
Action
LimitNumSweeps
Bool
Sweeps
Integer
INTEGRAL
app.Math.Fx.OperatorYSetup (Operator = "Integral")
Integral of the linearly rescaled (multiplier and adder) input.
Adder
Double
AutoFindScale
Bool
2-5
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure F1 to integrate C1
app.Math.F1.View = True
app.Math.F1.Source1 = "C1"
app.Math.F1.MathMode = "OneOperator"
app.Math.F1.Operator1 = "Integral"
app.Math.F1.Operator1Setup
Example
Adder
Double
From -1e-009 to 1e-009 step 1e-012
Range
Sets/Queries the additive A for the integral function Fx, where Fx = M . Input + A.
Description
AutoFindScale
Bool
Set/Query the state of the 'AutoFindScale' cvar, which enables the automatic scaling of the Integral
when the acquisition setup changes.
Description
FindScale
Action
Initiates an action to find suitable vertical offset and scale for the integral function trace Fx.
Description
Multiplier
Double
From -1e+006 to 1e+006 step 1e-006
Range
Sets/Queries the multiplying constant M for the integral function Fx, where Fx = M . Input + A
Description
VerOffset
Double
From -1e+006 to 1e+006 step 1e-015
Range
Sets/Queries the vertical offset for the integral function trace Fx.
Description
VerScale
DoubleLockstep
From 1e-012 to 1e+007 step 0.01, locked to 1 2 5, fine grain allowed=false, on=false
Range
Sets/Queries the vertical scale for the integral function trace Fx.
Description
FindScale
Action
Multiplier
Double
VerOffset
Double
VerScale
DoubleLockstep
RESCALE
app.Math.Fx.OperatorYSetup (Operator = "Rescale")
2-6
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
Linearly transform the vertical values of a waveform.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure F1
app.Math.F1.View = True
app.Math.F1.Source1 = "C1"
app.Math.F1.MathMode = "OneOperator"
app.Math.F1.Operator1 = "Rescale"
app.Math.F1.Operator1Setup.Adder = 2.0
app
Example
Adder
Double
From -1e+018 to 1e+018 step (9 digits)
Range
Sets/Queries the additive constant A in the rescale function Fx = M.Input + A
Description
CustomUnit
Bool
Enables/Disables the application of a custom unit of measurement to the rescale function trace Fx.
Description
Multiplier
Double
From -1e+018 to 1e+018 step (9 digits)
Range
Sets/Queries the multiplicative constant M in the rescale function Fx = M.Input + A
Description
Adder
Double
CustomUnit
Bool
Multiplier
Double
ROOF
app.Math.Fx.OperatorYSetup (Operator = "Roof")
Most positive or maximum values for an ensemble of sweeps, or "Roof"
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Configure F1 to measure the Roof of the first 1000
' sweeps of C1
app.Math.F1.View = True
app.Math.F1.Source1 = "C1"
app.Math.F1.MathMode = "OneOperator"
app.Math.F1.Operator1 =
Example
ClearSweeps
Action
ClearSweeps
Action
LimitNumSweeps
Bool
Sweeps
Integer
2-7
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
Initiates a clear sweeps action for the roof function trace Fx.
Description
LimitNumSweeps
Bool
Sweeps
Integer
From 1 to 1000000 step 1
Range
Sets/Queries the maximum number of sweeps for the Roof function trace Fx.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set function trace F2 to roof.
app.Math.F2.Operator1 = "Roof"
' Set the maximum number of sweeps to 150.
app.Math.F2.Operator1Setup.Sweeps = 150
Example
AMPLITUDE
app.Measure.Px.Operator (ParamEngine = "Amplitude")
AREA
app.Measure.Px.Operator (ParamEngine = "Area")
Calculates the area of the input waveform relative to zero.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P1 to area.
app.Measure.P1.View = True
app.Measure.P1.MeasurementType = "measure"
app.Measure.P1.ParamEngine = "Area"
app.Measure.P1.Source1 = "C1"
' Enable cycli
Example
Cyclic
Bool
Enables/Disables cyclic calculation of area parameter Px, that is calculated using a whole number of
cycles of the signal.
Note: the HelpMarkers aid in observing over which region of the waveform the measurement is made.
Description
Cyclic
Bool
2-8
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
BASE
app.Measure.Px.Operator (ParamEngine = "Base")
MAXIMUM
app.Measure.Px.Operator (ParamEngine = "Maximum")
Calculates the maximum vertical value of the waveform
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
app.Measure.P1.ParamEngine = "Maximum"
Example
MEAN
app.Measure.Px.Operator (ParamEngine = "Mean")
Calculates the mean value of the input waveform's vertical values. When Cyclic = true, the range of values used is
limited to a whole number of cycles.
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P1 to mean.
app.Measure.P1.ParamEngine = "Mean"
' Set the mean parameter for cyclic measurements.
app.Measure.P1.Operator.Cyclic = true
Example
Cyclic
Bool
Sets/Queries whether the mean parameter Px is to be measured over a number of complete cycles.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P2 to mean.
app.Measure.P2.ParamEngine = "Mean"
' Set the mean parameter for cyclic measurements.
app.Measure.P2.ParamEngine.Cyclic = True
Example
Cyclic
Bool
MINIMUM
app.Measure.Px.Operator (ParamEngine = "Minimum")
Calculates the minimum value of a waveform
Example
2-9
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
app.Measure.P1.ParamEngine = "Minimum"
Example
OVERSHOOTNEGATIVE
app.Measure.Px.Operator (ParamEngine = "OvershootNegative")
OVERSHOOTPOSITIVE
app.Measure.Px.Operator (ParamEngine = "OvershootPositive")
PEAKTOPEAK
app.Measure.Px.Operator (ParamEngine = "PeakToPeak")
PHASE
app.Measure.Px.Operator (ParamEngine = "Phase")
OutputType
Enum
Sets/Queries the output type for Phase Px.
Description
OutputType
Enum
RefFindLevel
Action
RefHysteresis
Double
RefLevelType
Enum
RefPercentLevel
Double
RefSlope
Enum
SigFindLevel
Action
SigHysteresis
Double
SigLevelType
Enum
SigPercentLevel
Double
SigSlope
Enum
2-10
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P1 to phase difference.
app.Measure.P1.ParamEngine = "Phase"
' Set the output unit as radians.
app.Measure.P1.Operator.OutputType = "Radians"
Example
Values
Degrees
DEGREES360
Percent
Radians
RADIANSTWOPI
RefFindLevel
Action
Find the test level for the reference trace.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P3 to phase difference.
app.Measure.P3.ParamEngine = "Phase"
' Find the test level for the reference trace.
app.Measure.P3.Operator.RefFindLevel
Example
RefHysteresis
Double
From 0 to 10 step 0.1
Range
Sets/Queries the hysteresis range for the reference trace.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P1 to phase difference.
app.Measure.P1.ParamEngine = "Phase"
' Set the reference hysteresis in graticule divisions.
app.Measure.P1.Operator.RefHysteresis = 0.7
Example
2-11
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
RefLevelType
Enum
Sets/Queries the unit of measurement for the test level of the reference trace.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P1 to phase difference.
app.Measure.P1.ParamEngine = "Phase"
' Set the reference level to be measured in absolute units.
app.Measure.P1.Operator.RefLevelType = "Absolute"
Example
Values
Absolute
Percent
RefPercentLevel
Double
From 0 to 100 step 1
Range
Sets/Queries the test level for the reference trace in percent.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P3 to phase difference.
app.Measure.P3.ParamEngine = "Phase"
' Set the reference test level in percent.
app.Measure.P3.Operator.RefPercentLevel = 55
Example
RefSlope
Enum
Sets/Queries the polarity of the measured reference transitions.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P1 to phase difference.
app.Measure.P1.ParamEngine = "Phase"
' Set the reference slope to negative.
app.Measure.P1.Operator.RefSlope = "Neg"
Example
Values
Both
Neg
Pos
2-12
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
SigFindLevel
Action
Causes the engine to find a suitable level for either SigLevelType ("Absolute"or "Percent")
Description
SigHysteresis
Double
From 0 to 10 step 0.1
Range
Sets/Queries the hysteresis range for the signal.
Description
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
' Set parameter P3 to phase difference.
app.Measure.P3.ParamEngine = "Phase"
' Set the signal hysteresis in graticule divisions.
app.Measure.P3.Operator.SigHysteresis = 0.7
Example
SigLevelType
Enum
Sets/Queries which level to use "Percent" or "Absolute" for transitions on the signal
Description
Values
Absolute
Percent
SigPercentLevel
Double
From 0 to 100 step 1
Range
Sets/Queries the test level for the signal in percent.
Description
SigSlope
Enum
Sets/Queries the polarity of the measured signal transitions.
Description
Values
Both
Neg
Pos
ROOTMEANSQUARE
app.Measure.Px.Operator (ParamEngine = "RootMeanSquare")
Cyclic
Bool
Cyclic
Bool
2-13
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
If true, the calculation is limited to a whole number of cycles detected in the input.
Description
SKEW
app.Measure.Px.Operator (ParamEngine = "Skew")
Calculates the skew between two clock signal waveforms
' Visual Basic Script
Set app = CreateObject("LeCroy.XStreamDSO")
app.Measure.MeasureMode = "MyMeasure"
app.Measure.P1.ParamEngine = "Skew"
Example
Clock1FindLevel
Action
Automatically find a suitable level for Clock1, for either "Percent" or "Absolute" levels
Description
Clock1Hysteresis
Double
From 0 to 10 step 0.1
Range
Sets/Queries hysteresis for transition detection used for Clock1
Description
Clock1LevelIs
Enum
Sets/Queries whether to use Percent or Absolute levels for Clock1
Description
Values
Absolute
Percent
Clock1FindLevel
Action
Clock1Hysteresis
Double
Clock1LevelIs
Enum
Clock1PctLevel
Double
Clock1Slope
Enum
Clock2FindLevel
Action
Clock2Hysteresis
Double
Clock2LevelIs
Enum
Clock2PctLevel
Double
Clock2Slope
Enum
Deskew
Double
UpSamplingFactor
Integer
2-14
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
Clock1PctLevel
Double
From 0 to 100 step 1
Range
Sets/Queries the "Percent" of the amplitude of Clock1 to use for a transition level, if Clock1LevelIs =
"Percent"
Description
Clock1Slope
Enum
Sets/Queries the polarity of transitions detected on Clock1
Description
Values
Both
Neg
Pos
Clock2FindLevel
Action
Using ParamEngine = "Skew", please refer to the corresponding variable for the Hold Time parameter.
Description
Clock2Hysteresis
Double
From 0 to 10 step 0.1
Range
Sets/Queries hysteresis for transition detection used for Clock1
Description
Clock2LevelIs
Enum
Sets/Queries whether to use Percent or Absolute levels for Clock2
Description
Values
Absolute
Percent
Clock2PctLevel
Double
From 0 to 100 step 1
Range
Sets/Queries the "Percent" of the amplitude of Clock2 to use for a transition level, if Clock2LevelIs =
"Percent"
Description
2-15
918499 RevA
Automation Command and Query Reference Manual - Processor Reference
Clock2Slope
Enum
Sets/Queries the polarity of transitions detected on Clock2
Description
Values
Both
Neg
Pos
Deskew
Double
From -1e-008 to 1e-008 step 1e-012
Range
UpSamplingFactor
Integer
From 1 to 20 step 1
Range
STANDARDDEVIATION
app.Measure.Px.Operator (ParamEngine = "StandardDeviation")
Cyclic
Bool
If true, the calculation is limited to a whole number of cycles detected in the input.
Description
Cyclic
Bool
TOP
app.Measure.Px.Operator (ParamEngine = "Top")
2-16
918499 RevA
Thank you for using Remote Control
and Automation on your WaveSurfer
Oscilloscope.