How it Works
Teledyne
Loading...
WaveRunner
User Manual
460 pgs2.95 Mb0

Teledyne WaveRunner User Manual

Download
Automation Command
Reference Manual
for
WaveRunner Oscilloscopes
LeCroy Corporation
Internet: www.lecroy.com © 2010 by LeCroy Corporation. All rights reserved.
LeCroy and other product or brand names are trademarks or requested trademarks of their respective holders. Information in this publication supersedes all earlier versions. Specifications are subject to change without notice.
918500 RevA
AUTOMATION COMMAND REFERENCE MANUAL - INTRODUCTION
Introduction
This manual provides a comprehensive reference of all the commands available to a controlling application when using
WaveRunner oscilloscopes. Automation enables the controlling application to run on the instrument itself.
PLEASE NOTE THE FOLLOWING:
Available commands include ones for purchased options you may or may not have on your oscilloscope. For more
information, contact your local LeCroy sales office for more information about options available for your instrument.
While we encourage the use of our code examples provided in our manuals, cutting and pasting code samples
directly from this .pdf manual into scripts cause syntax errors (typically illegal ASCII quotation characters). Carefully review code sample formatting during reuse.
The information in this manual is split into Control and Processor sections, each with their own table of contents.
918500 Rev A
iii
Automation Command and Query Reference Manual - Control Reference Table of Contents
app...........................................................................................................................................................................
1-1
app.Acquisition........................................................................................................................................................
1-7
app.Acquisition.AuxOutput......................................................................................................................................
1-9
app.Acquisition.Channels........................................................................................................................................
1-12
app.Acquisition.Cx...................................................................................................................................................
1-12
app.Acquisition.Cx.Out.Result.................................................................................................................................
1-22
app.Acquisition.Horizontal.......................................................................................................................................
1-22
app.Acquisition.Trigger............................................................................................................................................
1-29
app.Acquisition.Trigger.Cx......................................................................................................................................
1-32
app.Acquisition.Trigger.Digital.................................................................................................................................
1-34
app.Acquisition.Trigger.Ext.....................................................................................................................................
1-35
app.Acquisition.Trigger.Serial.................................................................................................................................
1-37
app.Acquisition.Trigger.Serial.I2C...........................................................................................................................
1-38
app.Acquisition.Trigger.Serial.Protocol (Standard = "CAN")...................................................................................
1-41
app.Acquisition.Trigger.Serial.Protocol (Standard = "FLX")....................................................................................
1-44
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2C").....................................................................................
1-49
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2S").....................................................................................
1-51
app.Acquisition.Trigger.Serial.Protocol (Standard = "LIN").....................................................................................
1-54
app.Acquisition.Trigger.Serial.Protocol (Standard = "MIL1553").............................................................................
1-56
app.Acquisition.Trigger.Serial.Protocol (Standard = "RS232")................................................................................
1-69
app.Acquisition.Trigger.Serial.Protocol (Standard = "SPI").....................................................................................
1-72
app.Acquisition.Trigger.Serial.Protocol (Standard = "UART").................................................................................
1-74
app.Cursors.............................................................................................................................................................
1-77
app.Display..............................................................................................................................................................
1-79
app.ElectricalTelecom.............................................................................................................................................
1-90
app.ElectricalTelecom.ET.......................................................................................................................................
1-95
app.ElectricalTelecom.ET.Out.Result.....................................................................................................................
1-98
app.HardCopy.........................................................................................................................................................
1-99
app.LabNotebook....................................................................................................................................................
1-102
app.LogicAnalyzer...................................................................................................................................................
1-107
app.LogicAnalyzer.Digitalx......................................................................................................................................
1-110
app.LogicAnalyzer.Digitalx.Out.Result....................................................................................................................
1-112
app.LogicAnalyzer.Trigger.......................................................................................................................................
1-112
app.Math..................................................................................................................................................................
1-123
app.Math.Functions.................................................................................................................................................
1-124
app.Math.Fx............................................................................................................................................................
1-124
app.Math.Fx.Operator1Setup..................................................................................................................................
1-134
iv
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.Math.Fx.Out.Result..........................................................................................................................................
1-134
app.Math.Fx.Zoom..................................................................................................................................................
1-135
app.Math.XY............................................................................................................................................................
1-136
app.Math.XY.Out.Result..........................................................................................................................................
1-142
app.Measure...........................................................................................................................................................
1-142
app.Measure.Measure............................................................................................................................................
1-148
app.Measure.PRemote.histo.Result........................................................................................................................
1-148
app.Measure.PRemote.last.Result..........................................................................................................................
1-148
app.Measure.PRemote.max.Result........................................................................................................................
1-148
app.Measure.PRemote.mean.Result......................................................................................................................
1-148
app.Measure.PRemote.min.Result.........................................................................................................................
1-148
app.Measure.PRemote.num.Result........................................................................................................................
1-148
app.Measure.PRemote.sdev.Result........................................................................................................................
1-149
app.Measure.PRemote.Statistics............................................................................................................................
1-149
app.Measure.Px......................................................................................................................................................
1-149
app.Measure.Px.histo.Result..................................................................................................................................
1-157
app.Measure.Px.last.Result....................................................................................................................................
1-157
app.Measure.Px.max.Result...................................................................................................................................
1-157
app.Measure.Px.mean.Result.................................................................................................................................
1-157
app.Measure.Px.min.Result....................................................................................................................................
1-157
app.Measure.Px.num.Result...................................................................................................................................
1-157
app.Measure.Px.Operator.......................................................................................................................................
1-157
app.Measure.Px.Out.Result....................................................................................................................................
1-157
app.Measure.Px.sdev.Result..................................................................................................................................
1-158
app.Measure.Px.Statistics.......................................................................................................................................
1-158
app.Memory.............................................................................................................................................................
1-158
app.Memory.Memories............................................................................................................................................
1-158
app.Memory.Mx.......................................................................................................................................................
1-158
app.Memory.Mx.Out.Result.....................................................................................................................................
1-161
app.Memory.Mx.Zoom............................................................................................................................................
1-162
app.PassFail............................................................................................................................................................
1-163
app.PassFail.LastPass.Result.................................................................................................................................
1-165
app.PassFail.NumPassed.Result............................................................................................................................
1-165
app.PassFail.Qx......................................................................................................................................................
1-165
app.PassFail.Qx.Out.Result....................................................................................................................................
1-170
app.PassFail.Rate.Result........................................................................................................................................
1-170
app.PassFail.Tests.Result.......................................................................................................................................
1-170
v
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.Preferences......................................................................................................................................................
1-170
app.Preferences.EMail............................................................................................................................................
1-172
app.RecallSetupLock..............................................................................................................................................
1-173
app.SaveRecall.......................................................................................................................................................
1-173
app.SaveRecall.Setup.............................................................................................................................................
1-174
app.SaveRecall.Table.............................................................................................................................................
1-178
app.SaveRecall.Utilities...........................................................................................................................................
1-179
app.SaveRecall.Waveform......................................................................................................................................
1-180
app.SDA..................................................................................................................................................................
1-185
app.SDA.BadBits.....................................................................................................................................................
1-200
app.SDA.BadBits.Out.Result...................................................................................................................................
1-208
app.SDA.Bits...........................................................................................................................................................
1-208
app.SDA.Bits.Out.Result.........................................................................................................................................
1-210
app.SDA.Eye...........................................................................................................................................................
1-210
app.SDA.Eye.Out.Result.........................................................................................................................................
1-213
app.SDA.FindFreqReference..................................................................................................................................
1-213
app.SDA.FindFreqReference.Out.Result................................................................................................................
1-213
app.SDA.FindFreqStream.......................................................................................................................................
1-213
app.SDA.FindFreqStream.Out.Result.....................................................................................................................
1-214
app.SDA.FindLevelReference.................................................................................................................................
1-214
app.SDA.FindLevelReference.Out.Result...............................................................................................................
1-215
app.SDA.FindLevelStream......................................................................................................................................
1-215
app.SDA.FindLevelStream.Out.Result....................................................................................................................
1-215
app.SDA.Mask2Hits................................................................................................................................................
1-215
app.SDA.Mask2Hits.Out.Result..............................................................................................................................
1-215
app.SDA.Mask2Out.................................................................................................................................................
1-216
app.SDA.Mask2Out.Out.Result...............................................................................................................................
1-216
app.SDA.MaskHits..................................................................................................................................................
1-216
app.SDA.MaskHits.Out.Result................................................................................................................................
1-216
app.SDA.MaskOut...................................................................................................................................................
1-216
app.SDA.MaskOut.Out.Result.................................................................................................................................
1-217
app.SDA.PRBS.......................................................................................................................................................
1-217
app.SDA.PRBS.Out.Result.....................................................................................................................................
1-220
app.SDA.SDAStatus...............................................................................................................................................
1-220
app.SDA.TIE...........................................................................................................................................................
1-220
app.SDA.TIE.Out.Result.........................................................................................................................................
1-223
app.SDA.TIEF.........................................................................................................................................................
1-223
vi
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA.TIEF.Out.Result.......................................................................................................................................
1-224
app.SerialDecode....................................................................................................................................................
1-224
app.SerialDecode.Decode[n].Protocol (Protocol = "8B10B")..................................................................................
1-224
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioI2S")..............................................................................
1-225
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioLJ")................................................................................
1-228
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioRJ")...............................................................................
1-231
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioTDM")............................................................................
1-234
app.SerialDecode.Decode[n].Protocol (Protocol = "CAN").....................................................................................
1-236
app.SerialDecode.Decode[n].Protocol (Protocol = "CANHL").................................................................................
1-237
app.SerialDecode.Decode[n].Protocol (Protocol = "FLX")......................................................................................
1-238
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANHL")...........................................................................
1-240
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANLAN")........................................................................
1-240
app.SerialDecode.Decode[n].Protocol (Protocol = "I2C").......................................................................................
1-241
app.SerialDecode.Decode[n].Protocol (Protocol = "LIN").......................................................................................
1-243
app.SerialDecode.Decode[n].Protocol (Protocol = "MIL1553")...............................................................................
1-243
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE1X1")..............................................................................
1-245
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE1X2")..............................................................................
1-246
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE4X1")..............................................................................
1-247
app.SerialDecode.Decode[n].Protocol (Protocol = "RS232")..................................................................................
1-248
app.SerialDecode.Decode[n].Protocol (Protocol = "SIOP")....................................................................................
1-250
app.SerialDecode.Decode[n].Protocol (Protocol = "SPI").......................................................................................
1-253
app.SerialDecode.Decode[n].Protocol (Protocol = "SPICustom")...........................................................................
1-256
app.SerialDecode.Decode[n].Protocol (Protocol = "SPIDDR")...............................................................................
1-259
app.SerialDecode.Decode[n].Protocol (Protocol = "SSPI").....................................................................................
1-262
app.SerialDecode.Decode[n].Protocol (Protocol = "UART")...................................................................................
1-265
app.SerialDecode.Decode[n].Protocol (Protocol = "USART").................................................................................
1-266
app.SerialDecode.Decodex.....................................................................................................................................
1-269
app.SerialDecode.Decodex.Decode.......................................................................................................................
1-274
app.SerialDecode.Decodex.Out.Result...................................................................................................................
1-275
app.SerialDecode.FlexRayMeasure........................................................................................................................
1-275
app.SerialDecode.FLXEye......................................................................................................................................
1-277
app.SerialDecode.FLXEye.Out.Result....................................................................................................................
1-281
app.SerialDecode.Measure.....................................................................................................................................
1-281
app.SpecAnalyzer...................................................................................................................................................
1-287
app.SpecAnalyzer.SpecAn......................................................................................................................................
1-290
app.SpecAnalyzer.SpecAn.Out.Result....................................................................................................................
1-293
app.SpecAnalyzer.SpecAnTable.............................................................................................................................
1-293
vii
918500 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SpecAnalyzer.SpecAnTable.Out.Result...........................................................................................................
1-294
app.SystemControl..................................................................................................................................................
1-294
app.Utility.DateTimeSetup.......................................................................................................................................
1-294
app.Utility.Options...................................................................................................................................................
1-298
app.Utility.Remote...................................................................................................................................................
1-299
app.Utility.Remote.IOManager.CIOPortU3GPIB.....................................................................................................
1-300
app.Utility.Remote.IOManager.CLSIBPort..............................................................................................................
1-300
app.WaveScan........................................................................................................................................................
1-300
app.WaveScan.ScanDecode..................................................................................................................................
1-301
app.WaveScan.ScanDecode.Out.Result................................................................................................................
1-301
app.WaveScan.ScanHisto......................................................................................................................................
1-302
app.WaveScan.ScanHisto.Histogram.....................................................................................................................
1-304
app.WaveScan.ScanHisto.Out.Result....................................................................................................................
1-306
app.WaveScan.ScanHisto.Zoom............................................................................................................................
1-306
app.WaveScan.ScanOverlay..................................................................................................................................
1-307
app.WaveScan.ScanOverlay.Out.Result................................................................................................................
1-309
app.WebEditor.........................................................................................................................................................
1-309
app.XPort.................................................................................................................................................................
1-311
app.Zoom................................................................................................................................................................
1-311
app.Zoom.Zx...........................................................................................................................................................
1-313
app.Zoom.Zx.Out.Result.........................................................................................................................................
1-317
app.Zoom.Zx.Zoom.................................................................................................................................................
1-317
viii
918500 RevA
Automation Command and Query Reference Manual - Control Reference
LECROY.XSTREAMDSO
app
This is the root of the automation hierarchy, all other nodes are accessed from this point.
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Popup a dialog containing the instrument model MsgBox "Model is: " & app.InstrumentModel
Example
AutoSetup
Action
Starts an AutoSetup operation. When input channels are visible, AutoSetup operates only on those visible channels. If no channels are visible, all channels are affected by AutoSetup. With more than one channel visible, the first visible channel in numerical order, that has a detectable signal applied to it, is automatically set up for edge triggering.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Start an Auto-Setup process. app.AutoSetup
Example
AutoSetup
Action
ClearSweeps
Action
Exit
Action
FirmwareVersion
String
Height
Property
HideClock
Bool
InstrumentID
String
InstrumentModel
String
Left
Property
Maximize
Action
Minimize
Action
Quit()
Method
ResetPreferences
Action
Restore
Action
SetToDefaultSetup
Action
Shutdown
Action
Sleep([in] double timeoutMilliseconds)
Method
Top
Property
TouchScreenEnable
Bool
WaitUntilIdle([in] double timeoutSeconds)
Method
Width
Property
Windowed
Action
WindowState
Property
1-1
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
Clears all accumulated sweeps for all subsystems. These include Channel Pre-Processing, Math, Measure, and Display Persistence. Note that subsystem-specific clear sweeps controls are also available. For the details please refer to the ClearSweeps control for each subsystem.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Clear all accumulated sweeps for all subsystems. app.ClearSweeps
Example
Exit
Action
Equivalent to app.Quit() method.
Description
FirmwareVersion
String
Any number of characters
Range
Queries the firmware version of the instrument in the form - "1.0.0 (build 12345)"
Description
' Microsoft Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Query the firmware version number of the instrument. MsgBox "Firmware Version is: " + app.FirmwareVersion
Example
Height
Property
Sets/Queries the height in pixels of the instrument display on the PC screen.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the height of the instrument window to 400 pixels. app.Height = 400
Example
HideClock
Bool
Hides/Shows the clock that resides in the lower-right corner of the display of the instrument.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Hide the clock for 3 seconds. app.HideClock = True app.Sleep(3000) app.HideClock = False
Example
1-2
918500 RevA
Automation Command and Query Reference Manual - Control Reference
InstrumentID
String
Any number of characters
Range
Reads the complete ID of the instrument in the format: "LECROY,WM8500,WM000001,0.0.0", which includes the maker, the instrument model number, the serial number, and the version number.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Present the ID of the instrument. MsgBox app.InstrumentID
Example
InstrumentModel
String
Any number of characters
Range
Queries the model number of the instrument.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Present the model number of the instrument. MsgBox app.InstrumentModel
Example
Left
Property
Sets/Queries the position in pixels of the left edge of the instrument display on the PC screen. The position is measured from the left edge of the screen to the left edge of the instrument window.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the position of the left edge of the instrument window to 100 pixels. app.Left = 100
Example
Maximize
Action
Maximize the instrument window to fill the underlying desktop. Equivalent to app.WindowState = 1
Description
1-3
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Minimize
Action
Minimizes the instrument window to reveal the underlying desktop. It will display a small window in the bottom right corner of the display, which when clicked will restore the window to full-screen mode. To programmatically restore the window refer to the app.WindowState control.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Minimize the instrument display. app.Minimize
Example
Quit()
Method
Closes the instrument application. The instrument will prompt the user with an 'Are you sure?' dialog before closing down. Note that until the user responds to the dialog, control via Automation will be blocked.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Quit the instrument application with a confirmation prompt. app.Quit
Example
ResetPreferences
Action
Resets all scope preferences to their default states. The set includes the current remote communications port, the color palette settings, etc. but does not include the main DSO controls such as V/Div, T/Div, etc. These main instrument controls can be reset using the SetToDefaultSetup control.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Reset all instrument preferences. app.ResetPreferences
Example
Restore
Action
Restore the instrument display to its position and size before the last minimize request.
Description
1-4
918500 RevA
Automation Command and Query Reference Manual - Control Reference
SetToDefaultSetup
Action
Restores the instrument setup to its default state. Note that certain settings will not be restored to the default state. These are the user preferences, such as the current remote communications port, and the color settings, which may be reset, if required, using the ResetPreferences action.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Restore the instrument to its default state. app.SetToDefaultSetup
Example
Shutdown
Action
Shuts down the instrument. It will prompt the user with an 'Are you sure?' dialog before shutting down. Note that until the user responds to the dialog, control via Automation will be blocked.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Shut down the instrument with a confirmation prompt. app.Shutdown
Example
Sleep([in] double timeoutMilliseconds)
Method
Causes the main execution thread of the instrument application to sleep for the specified time period, defined in milliseconds.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
MsgBox "Sleeping for 10 seconds..." app.Sleep(10000) MsgBox "Sleep finished"
Example
Top
Property
Sets/Queries the position in pixels of the top edge of the instrument display on the PC screen. The position is measured downwards from the top of the screen to the top of the instrument window.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the position of the top edge of the instrument window to 100 pixels. app.Top = 100
Example
1-5
918500 RevA
Automation Command and Query Reference Manual - Control Reference
TouchScreenEnable
Bool
Sets/Queries the state of the touch-screen enable control. This is equivalent to the front-panel Touch Screen button.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Disable touch-screen if it is enabled. if app.TouchScreenEnable = True then app.TouchScreenEnable = False End if
Example
WaitUntilIdle([in] double timeoutSeconds)
Method
Waits until either the application is idle or the specified timeout expires, specified in seconds. This evaluates to True if the application completes before the timeout expires, and to False if a timeout occurs. When Trigger mode is Auto or Run, the application is never Idle. In this case the call to WaitUntilIdle returns after the next acquisition and any configured processing.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Wait with a timeout of five seconds. app.WaitUntilIdle(5)
Example
Width
Property
Sets/Queries the width in pixels of the instrument display on the PC screen.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the width of the instrument window to 800 pixels. app.Width = 800
Example
Windowed
Action
Places the instrument application in windowed mode (as opposed to full-screen mode). Places the application in the upper-part of the display screen with a sizable border.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument display into the windowed mode. app.Windowed
Example
1-6
918500 RevA
Automation Command and Query Reference Manual - Control Reference
WindowState
Property
Sets/Queries the state of the PC window used by the instrument display. 0 windowed 1 full screen 2 minimized Trying to set values greater than 2 or less than 0 will result in the value 0 (windowed) being set.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument window state to windowed. app.WindowState = 0
Example
ACQUISITION
app.Acquisition
This group of variables controls the input channels C1, C2, C3 and C4, the timebase, the trigger, and the Aux Output. Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in this section of
the manual. Examples of alias pairs are as follows - app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx app.Acquisition.Channels(1) is equivalent to app.Acquisition.C1 app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
Acquire([in] double timeoutSeconds, [in] long bForceTriggerOnTimeout)
Method
Action/Query. Takes a single acquisition. The first of the two arguments specifies a timeout; the second, which is optional, specifies whether or not to force a trigger when the timeout occurs. Evaluates to True if a trigger occurred, or False if a timeout occurred.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Start an acquisition, wait for up to 5 seconds for a trigger ' event, force a software trigger if a hardware trigger is not ' detected before the 5 second timeout expires. triggerDetected = app.Acquisition.Acquire(5, true)
Example
Acquire([in] double timeoutSeconds, [in] long bForceTriggerOnTimeout)
Method
Calibrate
Action
CalibrateAll
Action
CalNeeded
Integer
ClearSweeps
Action
HorOffset
Double
TriggerMode
Enum
1-7
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Calibrate
Action
Initiates a full calibration of the acquisition system of the instrument.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Start a calibration. app.Acquisition.Calibrate
Example
CalibrateAll
Action
CalNeeded
Integer
From -2147483648 to 2147483647 step 1
Range
Query: Indicates whether calibration is required or not. Based on hexadecimal bit value, it provides following information:
0x00000001: Front end calibration is required 0x00000002: Digitizers delay matching is required 0x00000004: Digitizers gain matching is required 0x00000008: Trigger level calibration is required 0xFFFFFFFF(-1): All of above calibrations are required
Description
ClearSweeps
Action
Resets any accumulated average data or persistence data for channel waveforms (C1..C4). Valid only when one or more channels have waveform averaging or persistence enabled in their pre-processing settings. Note that an average may be reset on an individual basis using app.Acquisition.Cx.ClearSweeps control.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Clear accumulated sweeps for channels C1...C4 app.Acquisition.ClearSweeps
' Clear accumulated sweeps for only C1 app.Acquisition.C1.ClearSweeps
Example
HorOffset
Double
From -2.5e-007 to 2.5e-007 step 1e-009
Range
same as "app.Acquisition.Horizontal.HorOffset.cvar"
Description
1-8
918500 RevA
Automation Command and Query Reference Manual - Control Reference
TriggerMode
Enum
Sets/Queries the trigger mode, using values from the following list ­Auto, Norm, Normal, Single, Stopped.
Auto: After a timeout, if a real hardware trigger is not received, then force a trigger so there are automatically lots of updates.
Normal: Accepts triggers as rapidly as the system permits, but likewise will wait "forever" for a trigger, without updating anything.
Single: Arm the acquisition system to acquire once, and do not rearm automatically after. Once a trigger is received and the data processed, the instrument finishes in the "Stopped" state.
Stop: Finishes the current acquisition and does not re-arm.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Place the instrument in stopped mode and take one acquisition. app.Acquisition.TriggerMode = "Stopped" app.Acquisition.Acquire(5)
Example
Values
Auto
Auto-trigger
Normal
Normal Trigger
Single
Single Trigger
Stopped
No trigger possible, Stopped
AUXOUTPUT
app.Acquisition.AuxOutput
Controls for the Auxilliary output BNC, which can be programmed as a simple square-wave signal source, or as a pulse which is asserted when various events occur, including Trigger Enabled, Trigger Out, and Pass/Fail.
' Microsoft Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Setup the Auxiliary output to be a squarewave with an amplitude ' of 500mV a frequency of 5kHz app.Acquisition.AuxOutput.Mode = "Square" app.Acquisition.AuxOutput.Amplitu
Example
Amplitude
Double
From 0.05 to 1 step 0.001
Range
Amplitude
Double
AuxInCoupling
Enum
AuxMode
Enum
CalMode
Enum
Frequency
DoubleLockstep
Mode
Enum
1-9
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Sets/Queries the amplitude of the signal on the AUX OUT connector. Note that this is the amplitude of the signal into a 1Mohm load. Into 50 ohms the output voltage will be halved (since the source impedance is nominally 50 ohms). Units are Volts.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the amplitude of the signal from the AUX OUT connector ' to 0.6 V into 1 megohm, or 0.3 V into 50 ohms. app.Acquisition.AuxOutput.Amplitude = 0.6
Example
AuxInCoupling
Enum
Sets the input coupling for the Auxiliary input path.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the coupling of the Auxiliary socket, when used as an input, to ground. ' In this condition, no input signal reaches the instrument. app.Acquisition.AuxOutput.AuxInCoupling = "GND"
Example
Values
DC50
DC, 50ohms coupling
GND
Grounded
AuxMode
Enum
Configures AUX Output type in WR and WS series of scopes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the Auxiliary output to trigger output signal. app.Acquisition.AuxOutput.AuxMode = "TriggerOut"
Example
Values
Off
No output
PassFail
Pulse on Pass fail condition
TriggerEnabled
Trigger enabled signal from trigger circuitry.
TriggerOut
Internal trigger output signal from trigger circuitry
1-10
918500 RevA
Automation Command and Query Reference Manual - Control Reference
CalMode
Enum
Configures Cal Output type in WR and WS series of scopes.
Description
' Follwoing example will set CAL output to 1 KHz, 0.5V square wave. ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set cal output to Square wave app.Acquisition.AuxOutput.CalMode = "Square"
' Set cal output amplitude to 0.5 V with 1 MOhm impedence app.Acquisition.AuxOutput.Amplitude = "0.5"
' Set cal output frequency to 1 KHz app.Acquisition.AuxOutput.Frequency = "1000"
Example
Values
DCLevel
DC Level with 1 Mohm o/p impedence
Off
Off
Square
Square wave
Frequency
DoubleLockstep
From 250 to 1e+006 step 10, locked to 1 2.5 5, fine grain allowed=false, on=false
Range
This control only has effect when the AuxOutput mode is "Square". Sets/Queries the auxiliary output frequency of the squarewave. Units are Hertz.
Note that WaveMaster models (and derivatives) have a limit of 5MHz, WavePro 7000 models (and derivatives) have a limit of 1MHz.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the frequency of the signal from the AUX OUT ' connector to 1 MHz. app.Acquisition.AuxOutput.Frequency = 1e6
Example
1-11
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Mode
Enum
Sets/Queries the output mode of the AUX OUT connector. (Applicable to WM, SDA, DDA, WP series of scopes)
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the output of the AUX OUT connector to output ' a pulse on a pre-determined Pass-Fail decision. app.Acquisition.AuxOutput.Mode = "PassFail"
Example
Values
DCLevel
Emit a DC level
Off
Output Disabled
PassFail
Pulse-out controlled by Pass/Fail system
Square
Square-wave signal generator
TriggerEnabled
Pulse-out when trigger is enabled
TriggerOut
Pulse-out when trigger occurs
CHANNELS
app.Acquisition.Channels
This group of variables controls the acquisition channels C1, C2, C3 and C4. Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Acquisition. Examples of alias pairs are as follows ­ app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx app.Acquisition.Channels(1) is equivalent to app.Acquisition.C1 app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
Set app = CreateObject("LeCroy.XStreamDSO")
For X = 1 To 4 app.Acquisition.Channels(X).VerScale = 0.2 Next
Example
CX
app.Acquisition.Cx
This group of variables controls the input channels C1, C2, C3 and C4. Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Acquisition. Examples of alias pairs are as follows ­ app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
AverageSweeps
Integer
AxisXRotation
Integer
AxisYRotation
Integer
BandwidthLimit
Enum
ClearSweeps
Action
1-12
918500 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Setup Channel C1 app.Acquisition.C1.VerScale = 0.5 app.Acquisition.C1.VerOffset = 0.0 app.Acquisition.C1.Coupling = "DC50"
' Setup Channel C2 app.Acquisition.C2.VerScale = 0.1
Example
AverageSweeps
Integer
From 1 to 1000000 step 1
Range
Sets/Queries the number of averaging sweeps for input channel Cx. This is distinct from the math function app.Math.Fx. If the number of sweeps is 1 (the default value), the data will not be averaged.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the number of sweeps for channel C1 to 25. app.Acquisition.C1.AverageSweeps = 25
Example
Coupling
Enum
Deskew
Double
EnhanceResType
Enum
FindScale
Action
InterpolateType
Enum
Invert
Bool
LabelsPosition
String
LabelsText
String
Persist3DQuality
Enum
Persisted
Bool
Persistence3d
Bool
PersistenceMonoChrome
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ProbeAttenuation
Double
ProbeName
String
ShowLastTrace
Bool
UseGrid
String
VerOffset
Double
VerScale
DoubleLockstep
VerScaleVariable
Bool
View
Bool
ViewDecode
Bool
ViewLabels
Bool
1-13
918500 RevA
Automation Command and Query Reference Manual - Control Reference
AxisXRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the state of the X Axis rotation control, used only in 3-D persistence modes to control the viewing position. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the X-axis to 35 degrees for trace C3. app.Acquisition.C3.AxisXRotation = 35
Example
AxisYRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the state of the Y Axis rotation control, used only in 3-D persistence modes to control the viewing position. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the Y-axis to 25 degrees for trace C3. app.Acquisition.C3.AxisYRotation = 25
Example
BandwidthLimit
Enum
Sets/Queries the bandwidth limit for input channel Cx, in Hz. Note that this control is an enum, and therefore requires a string value, and not a scalar value. Note that bandwidth limit choices vary between DSO models.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the bandwidth limit for C2 to 20 MHz. app.Acquisition.C2.BandwidthLimit = "20MHz"
Example
Values
200MHz
20MHz
Full
1-14
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
Clears all accumulated average data and persistence data for this channel. See app.Acquisition.ClearSweeps for a control that clears accumulated data for channels 1..4, or app.ClearSweeps for a control that clears accumulated data for all subsystems (including Math/Measure/Display, etc.)
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Reset channel C1 app.Acquisition.C1.ClearSweeps
' Reset channels C1..C4 app.Acquisition.ClearSweeps
Example
Coupling
Enum
Sets/Queries the input coupling of input channel Cx. Note that coupling choices vary between instrument models. WavePro 7000 instruments for example support AC1M and DC1M modes in addition to DC50 and GND choices.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Inspect the input coupling for channel C2 CoupleC2 = app.Acquisition.C2.Coupling
' Set the coupling to DC, 50 ohms app.Acquisition.C2.Coupling = "DC50"
Example
Values
AC1M
DC1M
DC50
Gnd
Deskew
Double
From -4.5e-007 to 4.5e-007 step 1e-012
Range
Sets/Queries the deskew of input channel Cx to produce a required alignment with another trace.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
Example
1-15
918500 RevA
Automation Command and Query Reference Manual - Control Reference
EnhanceResType
Enum
Enhance resolution setting (Noise Filter). Set to 'None' to turn off the filter.
Description
Values
0.5bits
1.5bits
1bits
2.5bits
2bits
3bits
None
FindScale
Action
Starts FindScale operation for this chanel. This operation will adjust channel's v/div and offset control such that the signal is visible on the screen with in +/- 3 div.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
'Find vertical scale of channel 1 app.Acquisition.C1.FindScale
Example
InterpolateType
Enum
Sets/Queries the type of interpolation used for input channel Cx. Note that Sinx/x interpolation increases the size of the trace by a factor of 10, beware when using this option with long records.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the interpolation for channel C3 to (sin x)/x app.Acquisition.C3.InterpolateType = "Sinxx"
Example
Values
Linear
Linear interpolation
Sinxx
Sinx/x interpolation
Invert
Bool
Sets/Queries whether input channel Cx is inverted.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set channel C2 to be inverted. app.Acquisition.C2.Invert = True
Example
1-16
918500 RevA
Automation Command and Query Reference Manual - Control Reference
LabelsPosition
String
Any number of characters
Range
Sets / Queries the horizontal position of the label attached to the acquisition trace Cx. The unit of measurement is the unit of the horizontal scale. The measurement is made from the trigger point. Note that this control is a string, not a numeric value. This allows multiple labels to be positioned, as shown in the example below.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Add a couple of labels to trace C1, one at 0ns, and one at 55ns app.SetToDefaultSetup app.Acquisition.C1.ViewLabels = True app.Acquisition.C1.LabelsPosition = "0.0,55e-9" app.Acquisition.C1.LabelsText = "Hello,World"
Example
LabelsText
String
Any number of characters
Range
Persist3DQuality
Enum
Sets/Queries the state of the 3D Persistence quality control, which controls the way that the persistence trace is rendered. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence 3-D to shaded for trace C2.
app.Acquisition.C2.Persist3DQuality = "Shaded"
Example
Values
Shaded
Solid
WireFrame
1-17
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Persisted
Bool
Sets/Queries the persisted state of the waveform. If the Display.LockPersistence control is set to 'AllLocked' then the persisted state of all displayed waveforms will be the same. If the Display.LockPersistence control is set to 'PerTrace' then the persisted state of each waveform may be independently controlled.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence on for trace C1 app.Display.LockPersistence = "PerTrace" app.Acquisition.C1.Persisted = True
Example
Persistence3d
Bool
Sets/Queries the 3D persistence state. If True, then the persistence display for this channel will be displayed as a three dimensional surface map. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence plot as 3-D for trace C1 app.Acquisition.C1.Persistence3D = True
Example
PersistenceMonoChrome
Bool
Sets/Queries the monochrome persistence state. If True, then the persistence display for this channel will be monochromatic, whether 2-D or 3-D. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set persistence monochrome on for trace C4. app.Acquisition.C4.PersistenceMonoChrome = True
Example
PersistenceSaturation
Integer
From 0 to 100 step 1
Range
Sets/Queries the saturation threshold for persisted waveforms. All information at this level or above will be recorded with the same color or intensity. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence saturation level for trace C1. app.Acquisition.C1.PersistenceSaturation = 60
Example
1-18
918500 RevA
Automation Command and Query Reference Manual - Control Reference
PersistenceTime
Enum
Sets/Queries the state of the Persistence Time control. Controls the persistence decay time for this trace. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence time for the persistence trace of channel C1 to 10 seconds. app.Acquisition.C1.PersistenceTime = "10s"
Example
Values
0.5s
10s
1s
20s
2s
5s
Infinite
ProbeAttenuation
Double
From 1e-006 to 10000 step 1e-006
Range
Sets/Queries the probe attenuation. The probe attenuation is the factor by which the signal is made
smaller, for example, 10 means that the probe divides by 10, and is referred to as a ÷10 probe. Note
that certain passive probes may be marked as 'x10', even though they actually divide the input signal by a factor of 10.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the probe attenuation for channel C1 to 100 app.Acquisition.C1.ProbeAttenuation = 100
Example
ProbeName
String
Any number of characters
Range
Queries the name of connected probe.
Description
1-19
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ShowLastTrace
Bool
Sets/Queries the state of the Show Last Trace control. If True then when this trace is displayed in persistence mode the last acquired waveform will be superimposed on the accumulating persistence map. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Makes the last acquired trace invisible for the ' persistence trace of channel C1. app.Acquisition.C1.ShowLastTrace = False
Example
UseGrid
String
Any number of characters
Range
Sets/Queries the graticule on which the trace is displayed. Typical values include: YT1..YT8: one of the YT graticules used in Single, Dual, Quad, and Octal display modes. NotOnGrid: not displayed on any graticule.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Switch to dual grid mode, place C1 on the lower graticule ' and C2 on the upper graticule. app.Display.GridMode = "Dual" app.Acquisition.C1.UseGrid = "YT2" app.Acquisition.C2.UseGrid = "YT1"
Example
VerOffset
Double
From -1 to 1 step 0.0005
Range
Sets/Queries the vertical offset of input channel Cx. The setting resolution in volts lies in the range
0.25% to 0.5%, depending on the numerical value. Note that the available offset range is dependent upon the current V/Div setting, and also the instrument model.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the vertical offset for C1 to 10 mV. app.Acquisition.C1.VerOffset = 0.01
Example
1-20
918500 RevA
Automation Command and Query Reference Manual - Control Reference
VerScale
DoubleLockstep
From 0.002 to 10 step 0.0005, locked to 1 2 5, fine grain allowed=true, on=false
Range
Sets/Queries the vertical scale (in Volts/Division) of an input channel. When variable gain (VerScaleVariable control) is disabled, the control will clip values to a 1..2..5 sequence. When variable gain is enabled, the setting resolution lies in the range 1% to 2%, depending upon the numerical value.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set C1 to a scale of 250mV/Div in Variable Scale mode app.Acquisition.C1.VerScaleVariable = True app.Acquisition.C1.VerScale = 0.25
Example
VerScaleVariable
Bool
Sets/Queries the state of the variable vertical scale control for channel Cx. When the variable scale is enabled, the setting resolution lies in the range 1% to 2%, depending on the numerical value. If a knowledge of the exact value is important, the value should be read back after a setting has been made.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the variable vertical scale for C1 to On. app.Acquisition.C1.VerScaleVariable = True
Example
View
Bool
Sets/Queries the channel's 'Viewed' state. When True the channel waveform is displayed on one of the display graticules. Note that even when a channel is not visible it may be used as a source for Math, Measure, etc.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Make channel C3 visible. app.Acquisition.C3.View = True
Example
ViewDecode
Bool
1-21
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ViewLabels
Bool
Sets/Queries whether the user-defined labels for the trace are visible. See Also: LabelsPosition and LabelsText controls.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Show the user-defined label for trace C2. app.Acquisition.C2.ViewLabels = True
Example
RESULT
app.Acquisition.Cx.Out.Result
Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other controls are changed after that acquisition was completed. This distinction between "Out.Result" properties and other controls is most important when the trigger mode is Single or Stopped. You should treat "Out.Result" properties as read-only.
Several of these properties mention the 'frame', this is the term used to describe the visible portion of the trace, which is generally smaller than the acquired waveform. The frame could be used for example to display a 500pt. window onto a 1Mpt. Trace, or vertically it could be used to show the 'center' 10mV of a 100mV pk trace.
For a full overview of the properties of waveform (or other ) results, please see Chapter 1.
HORIZONTAL
app.Acquisition.Horizontal
This group of variables controls the timebase, the sampling, and the trigger delay.
AcquiredSegments
Integer
AcquisitionDuration
Double
ActiveChannels
Enum
ExtClockFrequency
Double
ExtCoupling
Enum
HorOffset
Double
HorOffsetOrigin
Double
HorScale
DoubleLockstep
HorUnits
String
MaxSamples
DoubleLockstep
NumPoints
Integer
NumSegments
Integer
ReferenceClock
Enum
SampleClock
Enum
SampleMode
Enum
SamplingRate
Double
SequenceTimeout
Double
SequenceTimeoutEnable
Bool
SetExtClockFrequency
Bool
1-22
918500 RevA
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
ActiveChannels
Enum
Sets/Queries the number of active DSO input channels. Note that this is a string value, the allowed values are "4", "2" and "Auto", and 0, 1, and 2. Beware of using 2 as a numerical value for 2 channels: you will get Auto mode instead.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument to use two channels. app.Acquisition.Horizontal.ActiveChannels = "2"
Example
Values
2
Use all channels
4
Auto
Maximize sample rate based upon the # displayed channels
ExtClockFrequency
Double
From 0.001 to 100000 step 0.001
Range
SmartMemory
Enum
Source
Enum
TimePerPoint
Double
UseLegacyDefault
Enum
1-23
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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 -0.0005 to 2.5e-007 step 1e-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
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 5e-010, 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
1-24
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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 5e+007 step 1000, 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
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
1-25
918500 RevA
Automation Command and Query Reference Manual - Control Reference
NumSegments
Integer
From 2 to 10000 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
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
1-26
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
Sequence
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
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
1-27
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
SmartMemory
Enum
Sets the mode of memory management to one of the two modes ­SetMaximumMemory - Maximizes the memory length for the given timebase setting, limited by the maximum length that is compatible with the maximum sample rate that the DSO can achieve. FixedSampleRate - Keeps the sample rate the same when the timebase is changed, limited by the maximum sample rate that the DSO can achieve.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the Smart memory mode as fixed sample rate. app.Acquisition.Horizontal.SmartMemory = "FixedSampleRate"
Example
Values
SetMaximumMemory
Keeps the sample rate the same when the timebase is changed
Source
Enum
Values
C1
C2
C3
C4
Digital
Ext
ExtDivide10
Line
1-28
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
UseLegacyDefault
Enum
Values
Never
No
Yes
TRIGGER
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-29
918500 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
1-30
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
D0
D1
D10
D11
D12
D13
D14
D15
D16
D17
D18
D19
D2
D20
D21
D22
D23
D24
D25
D26
D27
D28
D29
D3
D30
D31
D32
D33
D34
D35
D4
1-31
918500 RevA
Automation Command and Query Reference Manual - Control Reference
D5
D6
D7
D8
D9
Ext
ExtDivide10
Line
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
CX
app.Acquisition.Trigger.Cx
This group of varables controls triggering from the input channels C1, C2, C3 and C4.
InputImpedance
Enum
1-32
918500 RevA
Automation Command and Query Reference Manual - Control Reference
InputImpedance
Enum
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
Level
Double
Level2
Double
PatternState
Enum
Slope
Enum
WindowSize
Double
1-33
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
DIGITAL
app.Acquisition.Trigger.Digital
Coupling
Enum
InputImpedance
Enum
Level
Double
Level2
Double
PatternState
Enum
Slope
Enum
WindowSize
Double
1-34
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Coupling
Enum
Values
InputImpedance
Enum
Values
50
Level
Double
From -1 to 1 step 0.001
Range
Level2
Double
From -1 to 1 step 0.001
Range
PatternState
Enum
Values
DontCare
High
Low
Slope
Enum
Values
Either
Negative
Positive
Window
WindowSize
Double
From -1 to 1 step 0.001
Range
EXT
app.Acquisition.Trigger.Ext
This group of variables controls the external trigger.
Coupling
Enum
Coupling
Enum
InputImpedance
Enum
Level
Double
Level2
Double
PatternState
Enum
Slope
Enum
WindowSize
Double
1-35
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-36
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
SERIAL
app.Acquisition.Trigger.Serial
LevelAbsolute
Double
From 0 to 5 step 0.1
Range
LevelAbsolute
Double
LevelHighAbsolute
Double
Protocol
Enum
1-37
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
Protocol
Enum
Defines the actual active trigger Serial standard (Protocol)
Description
Values
CAN
FLX
I2C
I2S
LIN
MIL1553
RS232
SPI
UART
I2C
app.Acquisition.Trigger.Serial.I2C
AckCondition
Enum
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-38
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Values
Ack
DontCare
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
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
1-39
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-40
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
Binary
Hex
CAN
app.Acquisition.Trigger.Serial.Protocol (Standard = "CAN")
AdaptedSamplingPoint
Double
From 20 to 90 step 0.01
Range
AddressFormat
Enum
Values
ALL
EXT
STD
AdaptedSamplingPoint
Double
AddressFormat
Enum
AddressOperator
Enum
AddressValue
BitPattern
AddressValue2
BitPattern
BitRate
Double
ByteOrder
Enum
DefaultLevel
Double
NeedDualLevels
Bool
NeededSources
Enum
NumSamplingPoints
Enum
PatternBitLength
Integer
PatternBitPos
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
RequestedSamplingPoint
Double
SignType
Enum
SupportsDigital
Bool
SymbolDBC
FileName
SymbolicOperator
Enum
SynchJumpWidth
Integer
TriggerCondition
Enum
Tseg1
Integer
Tseg2
Integer
ViewingMode
Enum
1-41
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-42
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
SymbolDBC
FileName
Any number of characters
Range
1-43
918500 RevA
Automation Command and Query Reference Manual - Control Reference
SymbolicOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
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
Sym
FLX
app.Acquisition.Trigger.Serial.Protocol (Standard = "FLX")
BitRate
Double
ByteBitOrder
Enum
CycleCountOperator
Enum
CycleCountValue
Integer
CycleCountValue2
Integer
DefaultLevel
Double
1-44
918500 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 2.5e+006 to 1e+007 step 500000
Range
ByteBitOrder
Enum
Values
LSB
MSB
FrameIDOperator
Enum
FrameIDValue
BitPattern
FrameIDValue2
BitPattern
NeedDualLevels
Bool
NeededSources
Enum
NullFrameInd
Enum
PatternLength
Integer
PatternOperator
Enum
PatternValue
BitPattern
PatternValue2
BitPattern
PayloadChannel
Enum
PayloadPreamble
Enum
RepetitionFactor
Enum
StartupFrameInd
Enum
SupportsDigital
Bool
SymbolCAS
Bool
SymbolCID
Bool
SymbolWakeup
Bool
SyncFrameInd
Enum
TriggerCondition
Enum
TrigOnBadBSS
Bool
TrigOnBadDTS
Bool
TrigOnBadFES
Bool
TrigOnBadFSS
Bool
TrigOnBadSymbol
Bool
TrigOnHeaderCRCError
Bool
TrigOnPayloadCRCError
Bool
ViewingMode
Enum
1-45
918500 RevA
Automation Command and Query Reference Manual - Control Reference
CycleCountOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
CycleCountValue
Integer
From 0 to 63 step 1
Range
CycleCountValue2
Integer
From 0 to 63 step 1
Range
DefaultLevel
Double
From -1.79769e+308 to 1.79769e+308 step 0.001
Range
FrameIDOperator
Enum
Values
Equal
Greater
GreaterOrEqual
InRange
NotEqual
OutRange
Smaller
SmallerOrEqual
FrameIDValue
BitPattern
MaxBits=11 NumBits=11 NumBytes=2 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
FrameIDValue2
BitPattern
MaxBits=11 NumBits=11 NumBytes=2 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitFix Format=Ehex
Range
NeedDualLevels
Bool
1-46
918500 RevA
Automation Command and Query Reference Manual - Control Reference
NeededSources
Enum
Values
DataSource
NullFrameInd
Enum
Values
One
Zero
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
PayloadChannel
Enum
Values
ChannelA
ChannelB
PayloadPreamble
Enum
Values
One
Zero
1-47
918500 RevA
Automation Command and Query Reference Manual - Control Reference
RepetitionFactor
Enum
Values
1
16
2
32
4
64
8
StartupFrameInd
Enum
Values
One
Zero
SupportsDigital
Bool
SymbolCAS
Bool
SymbolCID
Bool
SymbolWakeup
Bool
SyncFrameInd
Enum
Values
One
Zero
TriggerCondition
Enum
Values
Errors
Frame
Symbol
TSS
TrigOnBadBSS
Bool
TrigOnBadDTS
Bool
TrigOnBadFES
Bool
TrigOnBadFSS
Bool
TrigOnBadSymbol
Bool
1-48
918500 RevA
Automation Command and Query Reference Manual - Control Reference
TrigOnHeaderCRCError
Bool
TrigOnPayloadCRCError
Bool
ViewingMode
Enum
Values
Binary
Hex
I2C
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2C")
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
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-49
918500 RevA
Automation Command and Query Reference Manual - Control Reference
AddressWithRW
Bool
AtPosition
Enum
Values
Value
ByteBitOrder
Enum
Values
LSB
MSB
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
1-50
918500 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=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
I2S
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2S")
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
1-51
918500 RevA
Automation Command and Query Reference Manual - Control Reference
AudioChannel
Enum
Values
Left
Right
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
StartBitInChannel
Integer
SupportsDigital
Bool
TimeOutLenInNanoSec
Double
ViewingMode
Enum
WSFrameStart
Enum
1-52
918500 RevA
Automation Command and Query Reference Manual - Control Reference
I2SCondition
Enum
Values
Clip
Data
FallingEdge
Glitch
Mute
RisingEdge
I2SVariant
Enum
Values
I2S
LJ
RJ
NeedDualLevels
Bool
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
1-53
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
WSFrameStart
Enum
Values
Falling
Rising
LIN
app.Acquisition.Trigger.Serial.Protocol (Standard = "LIN")
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-54
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-55
918500 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=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
ViewingMode
Enum
Values
Binary
Hex
MIL1553
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
1-56
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-57
918500 RevA
Automation Command and Query Reference Manual - Control Reference
BitRate
Double
From 500000 to 4e+007 step 1000
Range
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-58
918500 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-59
918500 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-60
918500 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-61
918500 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-62
918500 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-63
918500 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-64
918500 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-65
918500 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-66
918500 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-67
918500 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-68
918500 RevA
Automation Command and Query Reference Manual - Control Reference
TypeTransfer
Enum
Values
All
BCRTRcv
Modecommand
ModecommandDataRcv
ModecommandDataXmit
RTBCXmit
RTRT
RS232
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-69
918500 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-70
918500 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-71
918500 RevA
Automation Command and Query Reference Manual - Control Reference
ViewingMode
Enum
Values
Binary
Hex
SPI
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-72
918500 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-73
918500 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
UART
app.Acquisition.Trigger.Serial.Protocol (Standard = "UART")
1-74
918500 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-75
918500 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-76
918500 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
CURSORS
app.Cursors
This set of variables controls the cursor system.
Track
Bool
Type
Enum
View
Bool
XPos1
Double
XPos2
Double
YPos1
Double
YPos2
Double
1-77
918500 RevA
Automation Command and Query Reference Manual - Control Reference
Track
Bool
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
Type
Enum
Sets/Queries the currently selected type of cursor.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the cursor type to vertical relative. app.Cursors.View = "On" app.Cursors.Type = "VertRel"
Example
Values
HorizAbs
Single cursor, position specified in time
HorizRel
Dual cursors, positions specified in time
VertAbs
Single cursor, position specified in divisions vertically
VertRel
Dual cursors, positions specified in divisions vertically
View
Bool
Sets/Queries visibility of the cursors.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Make the cursors visible. app.Cursors.View = "On"
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
1-78
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
DISPLAY
app.Display
This set of variables controls the properties of the screen display of the instrument.
AxisLabels
Bool
AxisXRotation
Integer
AxisYRotation
Integer
C1Color
Color
C1PrintColor
Color
C2Color
Color
C2PrintColor
Color
C3Color
Color
C3PrintColor
Color
C4Color
Color
1-79
918500 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")
Example
C4PrintColor
Color
ClearSweeps
Action
DisplayMode
Enum
F1Color
Color
F1PrintColor
Color
F2Color
Color
F2PrintColor
Color
F3Color
Color
F3PrintColor
Color
F4Color
Color
F4PrintColor
Color
FactoryDefault
Action
GridIntensity
Integer
GridMode
Enum
GridOnTop
Bool
LockPersistence
Enum
M1Color
Color
M1PrintColor
Color
M2Color
Color
M2PrintColor
Color
M3Color
Color
M3PrintColor
Color
M4Color
Color
M4PrintColor
Color
Persist3DQuality
Enum
Persisted
Bool
Persistence3d
Bool
PersistenceLastTrace
Bool
PersistenceMonoChrome
Bool
PersistenceSaturation
Integer
PersistenceStyle
Enum
PersistenceTime
Enum
PreviewPrintColors
Action
ResetAll
Action
SegmentMode
Enum
TraceIntensity
Double
TraceStyle
Enum
1-80
918500 RevA
Automation Command and Query Reference Manual - Control Reference
' Show the axis labels. app.Display.AxisLabels = True
AxisXRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the rotation angle, about the X-axis, of the 3-D persistence display. The X-axis runs horizontally in the plane of the screen. Positive or negative angles may be used. Positive or negative angles may be used, in the range - 90 to + 90 degrees. Zero produces a direct plan, viewed perpendicularly. Zero produces a direct plan view, if Y rotation is also zero.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the X axis to 45 degrees. app.Display.AxisXRotation = 45
Example
AxisYRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the rotation angle, about the Y-axis, of the 3-D persistence display. The Y-axis runs vertically in the plane of the screen. Positive or negative angles may be used, in the range - 90 to + 90 degrees. A positive angle makes the left side look closer than the right side. Zero produces a direct plan view, if X rotation is also zero.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the Y axis to 35 degrees. app.Display.AxisYRotation = 35
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
1-81
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-82
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
WebEdit
F1Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
F1PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
F2Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
1-83
918500 RevA
Automation Command and Query Reference Manual - Control Reference
F2PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
F3Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
F3PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
F4Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
F4PrintColor
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
1-84
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
Auto
Automatically choose grid mode, one trace per grid
Dual
Dual grid mode
Octal
Octal grid mode
Quad
Quad grid mode
Single
Single grid mode
XY
XY grid mode
XYDual
XY + Dual grid mode
XYSingle
XY + Single grid mode
GridOnTop
Bool
Sets/Queries whether the grid lines lie over the traces or vice versa.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the grid lines to be over the trace lines. app.Display.GridOnTop = True
Example
1-85
918500 RevA
Automation Command and Query Reference Manual - Control Reference
LockPersistence
Enum
Sets/Queries whether the persistence states of the visible traces are locked together or separate.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence display to per trace, not locked. app.Display.LockPersistence = "PerTrace"
Example
Values
AllLocked
PerTrace
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
M3PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
1-86
918500 RevA
Automation Command and Query Reference Manual - Control Reference
M4Color
Color
From 0 to 16777215
Range
Please see C1Color.
Description
M4PrintColor
Color
From 0 to 16777215
Range
Please see C1Printcolor.
Description
Persist3DQuality
Enum
Sets/Queries the type of 3D plot that is displayed
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the type of the 3-D persistence plot. app.Display.Persist3DQuality = "WireFrame"
Example
Values
Shaded
Solid
WireFrame
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
Persistence3d
Bool
Sets/Queries whether the persistence 3-D mode is activated.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the 3-D display to off. app.Display.Persistence3d = False
Example
1-87
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
PersistenceMonoChrome
Bool
Sets/Queries whether the persistence mode is monochrome.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the persistence mode as color. app.Display.PersistenceMonoChrome = False
Example
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
3d
Analog
ColorGraded
1-88
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
ResetAll
Action
Turns off persistence on any traces where it has been set on.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Reset all persistence traces to non-persisted mode. app.Display.ResetAll
Example
1-89
918500 RevA
Automation Command and Query Reference Manual - Control Reference
SegmentMode
Enum
Sets/Queries the display mode for segmented input channels. All visible channels are set to the same display mode by a single command.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the display mode for segments in C2 to perspective. app.Acquisition.C2.SegmentMode = "Perspective"
Example
Values
Adjacent
All segments displayed end-to-end, left to right
Mosaic
Segments displayed in a mosaic, top-left to bottom right
Overlay
Segments are overlaid, similar to persistence
Perspective
Segments are displayed in a perspecfive view
Waterfall
Successive segments are displayed with increasing vertical offset
TraceIntensity
Double
From 1 to 100 step 1
Range
Control the intensity of traces.
Description
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
ELECTRICALTELECOM
app.ElectricalTelecom
Root Automation node to control Electrical Telecom (ET-PMT) package. This package is performing Pulse Mask Test on diferent SONET/SDH standards.
ClearSweeps
Action
Polarity
Enum
Run
Action
Setup
Action
Source
Enum
1-90
918500 RevA
Automation Command and Query Reference Manual - Control Reference
' 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
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
Standard
Enum
Stop
Action
StopAfter
Integer
StopTesting
Bool
VerticalAlign
Action
1-91
918500 RevA
Automation Command and Query Reference Manual - Control Reference
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
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
1-92
918500 RevA
Loading...
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use