User manual

ManualsBrandsTELEDYNE LECROY ManualsLaboratory Test EquipmentDigital 1 GHz 4-channel 5 GSa/s 16 Mpts 8 Bit Digital storage (DSO)

Automation Command

Reference Manual

for

WaveSurfer Oscilloscopes

Summary of content (226 pages)

PAGE 1
Automation Command Reference M anual for WaveSurfer Oscilloscopes
PAGE 2
LeCroy Corporation 700 Chestnut Ridge Road Chestnut Ridge, NY, 10977-6499 Tel: (845) 578-6020, Fax: (845) 578 5985 Internet: www.lecroy.com © 2010 by LeCroy Corporation. All rights reserved. LeCroy and other product or brand names are trademarks or requested trademarks of their respective holders. Information in this publication supersedes all earlier versions. Specifications are subject to change without notice.
PAGE 3
AUTOMATION COMMAND REFERENCE MANUAL - INTRODUCTION Introduction This manual provides a comprehensive reference of all the commands available to a controlling application when using WaveSurfer oscilloscopes. Automation enables the controlling application to run on the instrument itself. PLEASE NOTE THE FOLLOWING:  Available commands include ones for purchased options you may or may not have on your oscilloscope.
PAGE 4
Automation Command and Query Reference Manual - Control Reference Table of Contents app........................................................................................................................................................................... 1-1 app.Acquisition........................................................................................................................................................ 1-7 app.Acquisition.AuxOutput................................................
PAGE 5
Automation Command and Query Reference Manual - Control Reference Table of Contents app.Math.XY............................................................................................................................................................ 1-116 app.Math.XY.Out.Result.......................................................................................................................................... 1-119 app.Measure........................................................................
PAGE 6
Automation Command and Query Reference Manual - Control Reference Table of Contents app.Preferences.EMail............................................................................................................................................ 1-137 app.RecallSetupLock.............................................................................................................................................. 1-138 app.SaveRecall..........................................................................
PAGE 7
Automation Command and Query Reference Manual - Control Reference Table of Contents app.WaveScan.ScanDecode.Out.Result................................................................................................................ 1-197 app.Zoom................................................................................................................................................................ 1-197 app.Zoom.Zx.....................................................................................
PAGE 8
Automation Command and Query Reference Manual - Control Reference app LECROY.XSTREAMDSO This is the root of the automation hierarchy, all other nodes are accessed from this point.
PAGE 9
Automation Command and Query Reference Manual - Control Reference Action ClearSweeps Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Clear all accumulated sweeps for all subsystems. app.
PAGE 10
Automation Command and Query Reference Manual - Control Reference String InstrumentID Range Any number of characters Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Present the ID of the instrument. MsgBox app.
PAGE 11
Automation Command and Query Reference Manual - Control Reference Action Minimize Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Minimize the instrument display. app.
PAGE 12
Automation Command and Query Reference Manual - Control Reference Action SetToDefaultSetup Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 13
Automation Command and Query Reference Manual - Control Reference Bool TouchScreenEnable Description Sets/Queries the state of the touch-screen enable control. This is equivalent to the front-panel Touch Screen button. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Disable touch-screen if it is enabled. if app.TouchScreenEnable = True then app.
PAGE 14
Automation Command and Query Reference Manual - Control Reference Property WindowState Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the instrument window state to windowed. app.WindowState = 0 app.
PAGE 15
Automation Command and Query Reference Manual - Control Reference Action Calibrate Description Initiates a full calibration of the acquisition system of the instrument. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Start a calibration. app.Acquisition.Calibrate Integer CalNeeded Range From -2147483648 to 2147483647 step 1 Description Query: Indicates whether calibration is required or not.
PAGE 16
Automation Command and Query Reference Manual - Control Reference Enum TriggerMode Description 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.
PAGE 17
Automation Command and Query Reference Manual - Control Reference Example ' 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" Values DC50 DC, 50ohms coupling GND Grounded Enum AuxMode Description Configures AUX Output type in WR and WS series of scopes.
PAGE 18
Automation Command and Query Reference Manual - Control Reference Enum Mode Description Sets/Queries the output mode of the AUX OUT connector. (Applicable to WM, SDA, DDA, WP series of scopes) Example ' 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.
PAGE 19
Automation Command and Query Reference Manual - Control Reference EnhanceResType Enum FindScale Action InterpolateType Enum Invert Bool LabelsPosition String LabelsText String Persisted Bool PersistenceSaturation Integer PersistenceTime Enum ProbeAttenuation Double ProbeName String ShowLastTrace Bool UseGrid String VerOffset Double VerScale DoubleLockstep VerScaleVariable Bool View Bool ViewDecode Bool ViewLabels Bool Example ' Visual Basic Script Set app = CreateObject
PAGE 20
Automation Command and Query Reference Manual - Control Reference Enum BandwidthLimit Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the bandwidth limit for C2 to 20 MHz. app.Acquisition.C2.
PAGE 21
Automation Command and Query Reference Manual - Control Reference Enum Coupling Description 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. Example ' 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.
PAGE 22
Automation Command and Query Reference Manual - Control Reference Action FindScale Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") 'Find vertical scale of channel 1 app.Acquisition.C1.FindScale Enum InterpolateType Description Sets/Queries the type of interpolation used for input channel Cx.
PAGE 23
Automation Command and Query Reference Manual - Control Reference String LabelsPosition Range Any number of characters Description 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.
PAGE 24
Automation Command and Query Reference Manual - Control Reference Enum PersistenceTime Description 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. Example ' 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.
PAGE 25
Automation Command and Query Reference Manual - Control Reference Bool ShowLastTrace Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 26
Automation Command and Query Reference Manual - Control Reference DoubleLockstep VerScale Range From 0.002 to 10 step 0.0005, locked to 1 2 5, fine grain allowed=true, on=false Description 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.
PAGE 27
Automation Command and Query Reference Manual - Control Reference Bool ViewLabels Description Sets/Queries whether the user-defined labels for the trace are visible. See Also: LabelsPosition and LabelsText controls. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Show the user-defined label for trace C2. app.Acquisition.C2.ViewLabels = True app.Acquisition.Cx.Out.Result RESULT Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition.
PAGE 28
Automation Command and Query Reference Manual - Control Reference TimePerPoint Double UseLegacyDefault Enum Integer AcquiredSegments Range From 0 to 100000 step 1 Double AcquisitionDuration Range From 1e-012 to 1e+012 step 1e-015 Description 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.
PAGE 29
Automation Command and Query Reference Manual - Control Reference Double HorOffsetOrigin Range From 0 to 10 step 1 Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 30
Automation Command and Query Reference Manual - Control Reference Integer NumPoints Range From 2 to 100000000 step 1 Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 31
Automation Command and Query Reference Manual - Control Reference Enum SampleClock Description Sets/Queries the source for the sample clock. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the sample clock to expect an external source. app.Acquisition.Horizontal.SampleClock = "External" Values INT Enum SampleMode Description Sets/Queries the mode of acquisition as real-time or sequence or random interleaved sampling.
PAGE 32
Automation Command and Query Reference Manual - Control Reference Double SequenceTimeout Range From 0.01 to 100 step 0.01 Description Sets/Queries the timeout in segment mode of acquisition if insufficient triggers are received. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the sequence mode timeout to 10 seconds app.Acquisition.Horizontal.SequenceTimeout = 10.0 Bool SequenceTimeoutEnable Description Sets/Queries the enabling of the sequence mode timeout.
PAGE 33
Automation Command and Query Reference Manual - Control Reference Enum UseLegacyDefault Values Never No Yes app.Acquisition.Trigger 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.
PAGE 34
Automation Command and Query Reference Manual - Control Reference Enum PatternType Description Sets/Queries the pattern (Logic) trigger type. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the pattern trigger type to Nand. app.Acquisition.Trigger.Type = "Logic" app.Acquisition.Trigger.
PAGE 35
Automation Command and Query Reference Manual - Control Reference Enum Type Description Sets/Queries the trigger type (mode). Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the trigger type to glitch. app.Acquisition.Trigger.Type = "Glitch" Values Dropout Edge Glitch Interval Logic Qualify Runt Serial SlewRate State TV Width Action ZeroLevel Description Sets the trigger level to zero volts. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 36
Automation Command and Query Reference Manual - Control Reference Description Reads the input impedance of channel C1, in Ohms Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Read the input impedance of C1 trigger. ZinC1 = app.Acquisition.Trigger.C1.InputImpedance MsgBox ZinC1 Values 50 Double Level Range From -0.205 to 0.205 step 0.0005 Description Sets/Queries the trigger level for the internal trigger from channel Cx. The setting resolution ranges from about 1.
PAGE 37
Automation Command and Query Reference Manual - Control Reference Enum Slope Description Sets/Queries the direction of the transition to be used for internal triggering from channel Cx. Example ' 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" Values Either Negative Positive Window Double WindowSize Range From 0.02 to 0.205 step 0.0005 app.Acquisition.
PAGE 38
Automation Command and Query Reference Manual - Control Reference LFREJ Enum InputImpedance Description Reads the input impedance of the external trigger. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Read the input impedance of external trigger input. ZinExt = app.Acquisition.Trigger.Ext.InputImpedance MsgBox ZinExt Values 50 Double Level Range From -0.41 to 0.41 step 0.001 Description Sets/Queries the trigger level for the external trigger.
PAGE 39
Automation Command and Query Reference Manual - Control Reference Enum Slope Description Sets/Queries the direction of the transition used for the external trigger. Example ' 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" Values Either Negative Positive Window Double WindowSize Range From 0.04 to 0.41 step 0.001 app.Acquisition.Trigger.
PAGE 40
Automation Command and Query Reference Manual - Control Reference Enum CSSource Description Defines channel with the chip select signal (if applies to protocol) to trigger on serial data Values C1 C2 C3 C4 Ext ExtDivide10 Enum DataSource Description Defines channel with the Data signal (mandatory) to trigger on serial data Values C1 C2 C3 C4 Ext ExtDivide10 Double LevelAbsolute Range From 0 to 5 step 0.
PAGE 41
Automation Command and Query Reference Manual - Control Reference Enum Protocol Description Defines the actual active trigger Serial standard (Protocol) Values CAN I2C I2S LIN MIL1553 RS232 SPI UART app.Acquisition.Trigger.Serial.
PAGE 42
Automation Command and Query Reference Manual - Control Reference Enum AddressLength Values 10Bits 7Bits BitPattern AddressValue Range MaxBits=10 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex Bool AddressWithRW Enum AtPosition Values DontCare Value Enum ByteBitOrder Values LSB MSB Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 43
Automation Command and Query Reference Manual - Control Reference Enum NeededSources Values ClockSource DataSource Integer PatternLength Range From 0 to 12 step 1 Enum PatternOperator Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual BitPattern PatternValue Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=ByteVar Format=Ehex BitPattern PatternValue2 Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 Pa
PAGE 44
Automation Command and Query Reference Manual - Control Reference DefaultLevel Double NeedDualLevels Bool NeededSources Enum NumSamplingPoints Enum PatternBitLength Integer PatternBitPos Integer PatternOperator Enum PatternValue BitPattern PatternValue2 BitPattern RequestedSamplingPoint Double SignType Enum SupportsDigital Bool SynchJumpWidth Integer TriggerCondition Enum Tseg1 Integer Tseg2 Integer ViewingMode Enum Double AdaptedSamplingPoint Range From 20 to 90 step 0.
PAGE 45
Automation Command and Query Reference Manual - Control Reference BitPattern AddressValue2 Range MaxBits=29 NumBits=11 NumBytes=2 AllowedBitValues=01 PaddingChar=1 PadAlign=Left SizeAlign=BitFix Format=Ehex Double BitRate Range From 10000 to 1e+006 step 1 Enum ByteOrder Values Intel Motorola Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 46
Automation Command and Query Reference Manual - Control Reference BitPattern PatternValue Range MaxBits=64 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex BitPattern PatternValue2 Range MaxBits=64 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitFix Format=Ehex Double RequestedSamplingPoint Range From 20 to 90 step 0.
PAGE 47
Automation Command and Query Reference Manual - Control Reference 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 Enum AckCondition Values Ack NoAck Enum AddressLength Values 10Bits 7Bits BitPattern Addr
PAGE 48
Automation Command and Query Reference Manual - Control Reference Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 49
Automation Command and Query Reference Manual - Control Reference BitPattern PatternValue Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=ByteVar Format=Ehex BitPattern PatternValue2 Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=ByteVar Format=Ehex Bool SupportsDigital Enum ViewingMode Values Binary Hex app.Acquisition.Trigger.Serial.
PAGE 50
Automation Command and Query Reference Manual - Control Reference Integer BitsInChannel Range From 1 to 32 step 1 Enum ByteBitOrder Values LSB MSB Enum ChipSelCondition Values Auto Manual None Enum ClockPol Values Negative Positive Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 51
Automation Command and Query Reference Manual - Control Reference Enum NeededSources Values ClockSource CSSource DataSource Integer PatternBitsLen Range From 1 to 32 step 1 Integer PatternLength Range From 0 to 8 step 1 Enum PatternOperator Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual BitPattern PatternValue Range MaxBits=32 NumBits=32 NumBytes=4 AllowedBitValues=01X PaddingChar=X PadAlign=Right SizeAlign=BitVar Format=Ehex BitPattern PatternValue2 R
PAGE 52
Automation Command and Query Reference Manual - Control Reference Enum WSFrameStart Values Falling Rising app.Acquisition.Trigger.Serial.
PAGE 53
Automation Command and Query Reference Manual - Control Reference Double BitRate Range From 300 to 20000 step 1 Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 54
Automation Command and Query Reference Manual - Control Reference Enum ViewingMode Values Binary Hex app.Acquisition.Trigger.Serial.
PAGE 55
Automation Command and Query Reference Manual - Control Reference S1_BusyBit Enum S1_DynBusCtrlBit Enum S1_InstrBit Enum S1_MsgErrorBit Enum S1_RTAddress BitPattern S1_RTAddress2 BitPattern S1_RTAddressOP Enum S1_SRQBit Enum S1_SubSystFlagBit Enum S1_TermFlagBit Enum S2_BcastRcvdBit Enum S2_BusyBit Enum S2_DynBusCtrlBit Enum S2_InstrBit Enum S2_MsgErrorBit Enum S2_RTAddress BitPattern S2_RTAddress2 BitPattern S2_RTAddressOP Enum S2_SRQBit Enum S2_SubSystFlagBit Enum S
PAGE 56
Automation Command and Query Reference Manual - Control Reference Enum C1_ModeCode 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 6I
PAGE 57
Automation Command and Query Reference Manual - Control Reference BitPattern C1_RTAddress Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex BitPattern C1_RTAddress2 Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitFix Format=Ehex Enum C1_RTAddressOP Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual BitPattern C1_RTSubAddress Range MaxBits=5 NumBits=
PAGE 58
Automation Command and Query Reference Manual - Control Reference Enum C1_XmitRcv Values 0 1 X Enum C2_ModeCode 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 4TransmitterShut
PAGE 59
Automation Command and Query Reference Manual - Control Reference Enum C2_ModeCodeOP Values Equal Greater GreaterOrEqual NotEqual Smaller SmallerOrEqual BitPattern C2_RTAddress Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex BitPattern C2_RTAddress2 Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitFix Format=Ehex Enum C2_RTAddressOP Values Equal Greater GreaterOrEqual InRange NotEqu
PAGE 60
Automation Command and Query Reference Manual - Control Reference Enum C2_RTSubAddressOP Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual Integer C2_WordCount Range From 0 to 31 step 1 Enum C2_XmitRcv Values 0 1 X Integer D_PatternBitLength Range From 0 to 16 step 1 Integer D_PatternBitPos Range From 0 to 511 step 1 Enum D_PatternOperator Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual BitPattern D_PatternValue Ra
PAGE 61
Automation Command and Query Reference Manual - Control Reference BitPattern D_PatternValue2 Range MaxBits=16 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=ByteVar Format=Ehex Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.001 Double IMGTimeFrom Range From 0 to 3.2752e-005 step 8e-009 Enum IMGTimeOperator Values Greater InRange OutRange Smaller Double IMGTimeTo Range From 0 to 3.
PAGE 62
Automation Command and Query Reference Manual - Control Reference Enum S1_BcastRcvdBit Values 0 1 X Enum S1_BusyBit Values 0 1 X Enum S1_DynBusCtrlBit Values 0 1 X Enum S1_InstrBit Values 0 1 X Enum S1_MsgErrorBit Values 0 1 X BitPattern S1_RTAddress Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex BitPattern S1_RTAddress2 Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitFix
PAGE 63
Automation Command and Query Reference Manual - Control Reference Enum S1_RTAddressOP Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual Enum S1_SRQBit Values 0 1 X Enum S1_SubSystFlagBit Values 0 1 X Enum S1_TermFlagBit Values 0 1 X Enum S2_BcastRcvdBit Values 0 1 X Enum S2_BusyBit Values 0 1 X 918499 RevA 1-56
PAGE 64
Automation Command and Query Reference Manual - Control Reference Enum S2_DynBusCtrlBit Values 0 1 X Enum S2_InstrBit Values 0 1 X Enum S2_MsgErrorBit Values 0 1 X BitPattern S2_RTAddress Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitFix Format=Ehex BitPattern S2_RTAddress2 Range MaxBits=5 NumBits=5 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitFix Format=Ehex Enum S2_RTAddressOP Values Equal Greater GreaterOrEqua
PAGE 65
Automation Command and Query Reference Manual - Control Reference Enum S2_SubSystFlagBit Values 0 1 X Enum S2_TermFlagBit Values 0 1 X SupportsDigital Bool TrigOnBadManchesterEncoding Bool TrigOnBadWordCount Bool TrigOnIdleError Bool TrigOnInvalidSync Bool TrigOnNonContiguousData Bool TrigOnParityError Bool TrigOnStatusAddressMismatch Bool TrigOnSyncError Bool Enum Type Values Error Timing Transfer Word 918499 RevA 1-58
PAGE 66
Automation Command and Query Reference Manual - Control Reference Enum TypeTransfer Values All BCRTRcv Modecommand ModecommandDataRcv ModecommandDataXmit RTBCXmit RTRT app.Acquisition.Trigger.Serial.
PAGE 67
Automation Command and Query Reference Manual - Control Reference Enum ByteBitOrder Values LSB Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 68
Automation Command and Query Reference Manual - Control Reference Enum PatternOperator Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual Integer PatternPosition Range From -1 to 2047 step 1 BitPattern PatternValue Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=ByteVar Format=Ehex BitPattern PatternValue2 Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=ByteVar Form
PAGE 69
Automation Command and Query Reference Manual - Control Reference Enum ViewingMode Values Binary Hex app.Acquisition.Trigger.Serial.
PAGE 70
Automation Command and Query Reference Manual - Control Reference Enum ClockPhase Values 0 1 Enum ClockPolarity Values 0 1 Enum CSPolarity Values ActiveHigh ActiveLow Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 71
Automation Command and Query Reference Manual - Control Reference Enum PatternOperator Values Equal Greater GreaterOrEqual InRange NotEqual OutRange Smaller SmallerOrEqual BitPattern PatternValue Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=BitVar Format=Ehex BitPattern PatternValue2 Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=BitVar Format=Ehex Enum SignType Values SignedInt UnsignedInt Enu
PAGE 72
Automation Command and Query Reference Manual - Control Reference 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 UARTCondit
PAGE 73
Automation Command and Query Reference Manual - Control Reference Double DefaultLevel Range From -1.79769e+308 to 1.79769e+308 step 0.
PAGE 74
Automation Command and Query Reference Manual - Control Reference BitPattern PatternValue Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01X PaddingChar=X PadAlign=Left SizeAlign=ByteVar Format=Ehex BitPattern PatternValue2 Range MaxBits=96 NumBits=8 NumBytes=1 AllowedBitValues=01 PaddingChar=0 PadAlign=Left SizeAlign=ByteVar Format=Ehex Enum Polarity Values IdleHigh IdleLow Enum StopBitLength Values 1.
PAGE 75
Automation Command and Query Reference Manual - Control Reference Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set cursors tracking on. app.Cursors.Track = True Double XPos1 Range From -1.79769e+308 to 1.
PAGE 76
Automation Command and Query Reference Manual - Control Reference Double YPos2 Range From -3.99 to 3.99 step 0.01 Description Sets/Queries the vertical position of the second cursor, in graticule divisions. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the vertical position of the second cursor. app.Cursors.YPos2 = 2.1 app.Display DISPLAY This set of variables controls the properties of the screen display of the instrument.
PAGE 77
Automation Command and Query Reference Manual - Control Reference Bool AxisLabels Description Sets/Queries the visibility of the labels that show the horizontal and vertical limits of each grid. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Show the axis labels. app.Display.AxisLabels = True Color C1Color Range From 0 to 16777215 Description Sets/Queries the color of trace C1, using a number in the range 0 to FFFFFF in hexadecimal.
PAGE 78
Automation Command and Query Reference Manual - Control Reference Color C2PrintColor Range From 0 to 16777215 Description Please see C1Printcolor. Color C3Color Range From 0 to 16777215 Description Please see C1Color. Color C3PrintColor Range From 0 to 16777215 Description Please see C1Printcolor. Color C4Color Range From 0 to 16777215 Description Please see C1Color. Color C4PrintColor Range From 0 to 16777215 Description Please see C1Printcolor.
PAGE 79
Automation Command and Query Reference Manual - Control Reference Enum DisplayMode Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Switch to WebEdit mode app.Display.
PAGE 80
Automation Command and Query Reference Manual - Control Reference Enum GridMode Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Enter Octal grid mode app.Display.
PAGE 81
Automation Command and Query Reference Manual - Control Reference Color M3PrintColor Range From 0 to 16777215 Description Please see C1Printcolor. Color M4Color Range From 0 to 16777215 Description Please see C1Color. Color M4PrintColor Range From 0 to 16777215 Description Please see C1Printcolor. Bool Persisted Description Sets/Queries whether persistence mode is in use.
PAGE 82
Automation Command and Query Reference Manual - Control Reference Integer PersistenceSaturation Range From 0 to 100 step 1 Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the persistence saturation level to 60%. app.Display.
PAGE 83
Automation Command and Query Reference Manual - Control Reference Action PreviewPrintColors Description Show the instrument display in the current color scheme selected for printing. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Show the current color scheme selected for printing. app.Display.PreviewPrintColors Enum TraceStyle Description Sets/Queries the style in which traces are drawn. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 84
Automation Command and Query Reference Manual - Control Reference Action ClearSweeps Description The ClearSweeps allows you to reset the sweep count and start testing over again. Example ' 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.
PAGE 85
Automation Command and Query Reference Manual - Control Reference Action Run Description 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.
PAGE 86
Automation Command and Query Reference Manual - Control Reference Enum Source Description Specify on which channel (C1 to C4) the electrical signal to be tested is connected. Example ' Visual Basic Script Set app = CreateObject("LeCroy.WaveMasterApplication.1") 'Select an stadard and the source app.ElectricalTelecom.Standard = "E1Coax" app.ElectricalTelecom.Source = "C4" app.ElectricalTelecom.
PAGE 87
Automation Command and Query Reference Manual - Control Reference Action Stop Description Stop the test and reset counters. After this command, a new 'Setup' must be made. This is one of the action to control the state machine of Mask Testing : Setup, ReAlign, Stop, Pause, Run and VerticalAlign. Example ' Visual Basic Script Set app = CreateObject("LeCroy.WaveMasterApplication.1") 'Select an stadard and run the test app.ElectricalTelecom.Standard = "E1Coax" app.ElectricalTelecom.Setup app.
PAGE 88
Automation Command and Query Reference Manual - Control Reference String LabelsPosition Range Any number of characters Description 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.
PAGE 89
Automation Command and Query Reference Manual - Control Reference Bool ShowLastTrace Description 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.
PAGE 90
Automation Command and Query Reference Manual - Control Reference UseColor Enum Enum Destination Description Sets/Queries the destination for hard copy. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the destination for hard copy to e-mail. app.Hardcopy.
PAGE 91
Automation Command and Query Reference Manual - Control Reference Bool GridAreaOnly Description Sets/Queries whether hard copy is of grid area only. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Read the status of Grid Area Only. GridArea = app.Hardcopy.GridAreaOnly Enum HardcopyArea Description Sets/Queries the area of the screen to be included in a hard copy. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 92
Automation Command and Query Reference Manual - Control Reference String PreferredFilename Range Any number of characters Description Sets/Queries the preferred file name to use for hard copy. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the preferred filename to PrintFile. app.Hardcopy.PreferredFilename = "PrintFile" Action Print Description Initiates a hard copy. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Initiate a hard copy.
PAGE 93
Automation Command and Query Reference Manual - Control Reference CreateReport Action DeleteAll Action DeleteRecord Action EMailRecord Action FilterRecords Action FlashBackToRecord Action Format Enum HardcopyArea Enum InternalView Action MyLabNotebookMD FileName NextRecord Action PreviousRecord Action PrintRecord Action PromptBeforeSaving Bool RecordList Enum ReportLogo FileName ReportsDirectory FileName Save Action ScribbleBeforeSaving Bool StartNew Action UseDefault
PAGE 94
Automation Command and Query Reference Manual - Control Reference Action BackupDatabase Description Backup the current LabNotebook database. Note that this control will present a modal dialog, prompting for the backup filename and folder. Use the BackupToFolder control to skip the dialog. String BackupFilename Range Any number of characters Description Contains the filename into which the LabNotebook is stored, when the BackupDatabase request is made.
PAGE 95
Automation Command and Query Reference Manual - Control Reference Action DeleteAll Description Delete all LabNotebook entries. Note that this action will popup a modal dialog, requesting confirmation. Action DeleteRecord Description Delete the currently selected LabNotebook record. Note that this will popup a modal dialog requesting confirmation.
PAGE 96
Automation Command and Query Reference Manual - Control Reference Action InternalView Description View the selected Lab Notebook entry within the DSO's graticule area. Contrast with the 'ViewRecord' control, which presents the selected Lab Notebook entry in an external HTML browser. FileName MyLabNotebookMD Range Any number of characters Description Filename of the currently active Lab Notebook database. Action NextRecord Description Move to (select) the next entry in the notebook.
PAGE 97
Automation Command and Query Reference Manual - Control Reference Action Save Description Initiate the creation of a new Lab Notebook entry. Bool ScribbleBeforeSaving Description If True, the DSO will allow the interactive user to 'scribble' (annotate) the report page before it is saved. Action StartNew Description Start a new Lab Notebook. This action will prompt the interactive user for the filename of the new Lab Notebook database file.
PAGE 98
Automation Command and Query Reference Manual - Control Reference SkewAnalogTrigger Double Enum LALogicFamilyA Values CMOS2.5V CMOS3.3V CMOS5V ECL PECL TTL UserDefined Enum LALogicFamilyB Values CMOS2.5V CMOS3.3V CMOS5V ECL PECL TTL UserDefined Double LAThresholdA Range From -4.9 to 5.27 step 0.01 Double LAThresholdB Range From -4.9 to 5.27 step 0.
PAGE 99
Automation Command and Query Reference Manual - Control Reference Digital3 Bool Digital4 Bool Digital5 Bool Digital6 Bool Digital7 Bool DisplayMode Enum LineHeight Double LineNames String UseGrid String VerPosition Double View Bool String BusName Range Any number of characters Digital0 Bool Digital1 Bool Digital2 Bool Digital3 Bool Digital4 Bool Digital5 Bool Digital6 Bool Digital7 Bool Enum DisplayMode Values Collapse Expand Double LineHeight Range From 0.
PAGE 100
Automation Command and Query Reference Manual - Control Reference Double VerPosition Range From -3.8 to 10 step 0.05 Bool View Description Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure, etc. app.LogicAnalyzer.Digitalx.Out.Result RESULT app.LogicAnalyzer.
PAGE 101
Automation Command and Query Reference Manual - Control Reference DigitalPatternArrayLogic8 Enum DigitalPatternArrayLogic9 Enum DigitalTriggerByteHex0 String DigitalTriggerByteHexA0 String DigitalTriggerSet Enum DigitalTriggerType Enum I2CAccessType Enum I2CAddressCompare Enum I2CAddressValue String I2CAddressValueLast String I2CDataCompare Enum I2CDataValue String I2CDataValueLast String I2CTriggerType Enum Interval Enum IntervalHigh Double LAConnectWarn String LATriggerWa
PAGE 102
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic1 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic10 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic11 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic12 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-95
PAGE 103
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic13 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic14 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic15 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic16 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-96
PAGE 104
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic17 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic18 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic19 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic2 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-97
PAGE 105
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic20 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic21 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic22 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic23 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-98
PAGE 106
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic24 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic25 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic26 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic27 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-99
PAGE 107
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic28 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic29 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic3 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic30 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-100
PAGE 108
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic31 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic4 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic5 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic6 Values DontCare EitherEdge FallingEdge One RisingEdge Zero 918499 RevA 1-101
PAGE 109
Automation Command and Query Reference Manual - Control Reference Enum DigitalPatternArrayLogic7 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic8 Values DontCare EitherEdge FallingEdge One RisingEdge Zero Enum DigitalPatternArrayLogic9 Values DontCare EitherEdge FallingEdge One RisingEdge Zero String DigitalTriggerByteHex0 Range Any number of characters String DigitalTriggerByteHexA0 Range Any number of characters Enum DigitalTriggerSet Values Dont
PAGE 110
Automation Command and Query Reference Manual - Control Reference Enum DigitalTriggerType Values Interval Logic LogicBus Enum I2CAccessType Values AcknowledgedRead AcknowledgedReadWrite AcknowledgedWrite NotAcknowledgedRead NotAcknowledgedRead NotAcknowledgedWrite Read ReadWrite Write Enum I2CAddressCompare Values Matching NotMatching String I2CAddressValue Range Any number of characters String I2CAddressValueLast Range Any number of characters Enum I2CDataCompare Values Matching NotMatch
PAGE 111
Automation Command and Query Reference Manual - Control Reference Enum I2CTriggerType Values Address AnyCycle DataAndAddress Enum Interval Values GreaterThan InRange LessThan OutOfRange Double IntervalHigh Range From 8e-009 to 0.00837 step 8e-009 String LAConnectWarn Range Any number of characters String LATriggerWarn Range Any number of characters Enum LogicBusSource Description Allows to select the Digital Source of Logic Bus trigger.
PAGE 112
Automation Command and Query Reference Manual - Control Reference Enum Source Values A0 A1 A10 A11 A12 A13 A14 A15 A2 A3 A4 A5 A6 A7 A8 A9 B0 B1 B10 B11 B12 B13 B14 B15 B2 B3 B4 B5 B6 B7 B8 B9 Integer SPIBitsPerPacket Range From 2 to 32 step 1 Bool SPIInactivePeriodBetweenPacketEnabled Double SPIInactivePeriodBetweenPacketValue Range From 8e-009 to 0.
PAGE 113
Automation Command and Query Reference Manual - Control Reference Enum SPITriggerFormat Values ASCII Binary Hexadecimal Enum SPITriggerMode Values CPHAS0CPOL0 CPHAS0CPOL1 CPHAS1CPOL0 CPHAS1CPOL1 Enum SPITriggerSource Values MISO MOSI String SPITriggerValue Range Any number of characters String SPITriggerValueLast Range Any number of characters Enum SPIWhichBitArrivesFirst Values LSB MSB Enum TrigSlope Values Negative Positive Enum Type Values I2C Interval Logic 918499 RevA 1-106
PAGE 114
Automation Command and Query Reference Manual - Control Reference app.Math MATH Variables of the form app.Math.xxxx control the mathematical functions F1 through F8. Names of the form app.Math.Functions("Fx").xxxx are aliases of simpler names which are described in this section of the manual. Examples of alias pairs are as follows app.Math.Functions("Fx") is equivalent to app.Math.Fx app.Math.Functions("Fx").Out.Result is equivalent to app.Math.Fx.Out.Result app.Math.Functions("Fx").
PAGE 115
Automation Command and Query Reference Manual - Control Reference LabelsPosition String LabelsText String MathMode Enum Operator1 Enum Persisted Bool PersistenceSaturation Integer PersistenceTime Enum ShowLastTrace Bool Source1 Enum UseGrid String View Bool ViewLabels Bool Action ClearSweeps Description Clears accumulated data for a single function trace. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Reset accumulation for trace F1 app.Math.F1.
PAGE 116
Automation Command and Query Reference Manual - Control Reference String Equation Range Any number of characters Description Queries the equation which defines the math function Fx. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Read the definition of math function F3. EquationF3 = app.Math.F3.Equation MsgBox EquationF3 String LabelsPosition Range Any number of characters Description Sets / Queries the horizontal position of the label attached to the trace Fx.
PAGE 117
Automation Command and Query Reference Manual - Control Reference Enum MathMode Description Sets/Queries the math mode. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the mode of the math function F1 app.Math.F1.
PAGE 118
Automation Command and Query Reference Manual - Control Reference Enum Operator1 Description Sets/Queries the first operator of math function Fx. When MathMode = "OneOperator, this is the only math operator, when MathMode = "TwoOperator", this is the first of two operators. Note that when MathMode = "Graph", this control has no effect. Note also that the list of available math operators varies depending upon the instrument model number, and the list of installed software options.
PAGE 119
Automation Command and Query Reference Manual - Control Reference Bool Persisted Description Sets/Queries the persisted state of the function waveform. If the Display.LockPersistence control is set to 'AllLocked' then the persisted state of all displayed waveforms will be the same. If the Display.LockPersistence control is set to 'PerTrace' then the persisted state of each waveform may be independently controlled. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 120
Automation Command and Query Reference Manual - Control Reference Bool ShowLastTrace Description 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. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 121
Automation Command and Query Reference Manual - Control Reference String UseGrid Range Any number of characters Description Sets/Queries the grid in use for the math trace Fx. See also app.Acquisition.Cx.UseGrid. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Place math trace F3 on grid YT4. app.Math.F3.UseGrid = "YT4" Bool View Description Sets/Queries whether the trace of math function Fx is visible.
PAGE 122
Automation Command and Query Reference Manual - Control Reference app.Math.Fx.Zoom ZOOM This set of variables controls the zoom functions for math trace Fx. HorPos Double HorZoom Double ResetZoom Action VariableHorZoom Bool VariableVerZoom Bool VerPos Double VerZoom Double Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Turn on trace F1, will default to Zoom-Only app.Math.F1.View = True app.Math.F1.
PAGE 123
Automation Command and Query Reference Manual - Control Reference Bool VariableVerZoom Description Sets/Queries the ability to zoom vertically by a continuously variable factor. Note that if a vertical zoom of 0.9 is set, while variable zoom is off, the vertical zoom will be set to 1.0. If the variable zoom is then enabled, the factor of 0.9 will have been remembered, and it will be used. Note that the previous value will not be remembered during a power-cycle. Double VerPos Range From -1.5 to 1.
PAGE 124
Automation Command and Query Reference Manual - Control Reference Enum InputX Description Sets/Queries the name of the input channel for the X axis of the X-Y plot.
PAGE 125
Automation Command and Query Reference Manual - Control Reference Enum InputY Description Sets/Queries the name of the input channel for the Y axis of the X-Y plot. Values C1 C2 C3 C4 Digital1 Digital2 Digital3 Digital4 ET F1 M1 M2 M3 M4 Z1 Z2 Z3 Z4 Bool Persisted Description Sets/Queries the persisted state of the X-Y plot. If the Display.LockPersistence control is set to 'AllLocked' then the persisted state of all displayed waveforms will be the same. If the Display.
PAGE 126
Automation Command and Query Reference Manual - Control Reference Enum PersistenceTime Description Sets/Queries the state of the Persistence Time control. Controls the persistence decay time for the Xy persistence. See the general description above for a discussion of the locked and unlocked persistence modes. Values 0.5s 10s 1s 20s 2s 5s Infinite Bool ShowLastTrace Description Sets/Queries the state of the Show Last Trace control.
PAGE 127
Automation Command and Query Reference Manual - Control Reference StatsOn Bool StdGateStart Double StdGateStop Double Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' get into the custom parameter mode app.Measure.MeasureMode = "MyMeasure" app.Measure.ClearAll app.Measure.StatsOn = True app.Measure.
PAGE 128
Automation Command and Query Reference Manual - Control Reference Double StdGateStop Range From 0 to 10 step 0.01 Description Sets/Queries the position of the right hand limit of the measure gate (in divisions). Valid only when in either Std. Vertical or Std. Horizontal measurement modes. For MyMeasure see the equivalent controls under Px. app.Measure.Measure MEASURE Names of the forms app.Measure.Measure("Premote").xxxx and app.Measure.Measure("Px").
PAGE 129
Automation Command and Query Reference Manual - Control Reference Enum WformSource Values C1 C2 C3 C4 DigitalA0 DigitalA1 DigitalA10 DigitalA11 DigitalA12 DigitalA13 DigitalA14 DigitalA15 DigitalA2 DigitalA3 DigitalA4 DigitalA5 DigitalA6 DigitalA7 DigitalA8 DigitalA9 DigitalB0 DigitalB1 DigitalB10 DigitalB11 DigitalB12 DigitalB13 DigitalB14 DigitalB15 DigitalB2 DigitalB3 DigitalB4 DigitalB5 DigitalB6 DigitalB7 DigitalB8 DigitalB9 ET F1 M1 M2 M3 M4 Z1 918499 RevA 1-122
PAGE 130
Automation Command and Query Reference Manual - Control Reference Z2 Z3 Z4 RESULT app.Measure.PRemote.histo.Result RESULT app.Measure.PRemote.last.Result RESULT app.Measure.PRemote.max.Result RESULT app.Measure.PRemote.mean.Result RESULT app.Measure.PRemote.min.Result RESULT app.Measure.PRemote.num.Result RESULT app.Measure.PRemote.sdev.Result app.Measure.PRemote.Statistics STATISTICS app.Measure.
PAGE 131
Automation Command and Query Reference Manual - Control Reference GateByRange Bool GateByWform Bool GateStart Double GateStop Double MeasurementType Enum ParamEngine Enum Source1 Enum Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") app.Measure.MeasureMode = "MyMeasure" ' Set parameter P1 to math on parameters. App.Measure.P1.
PAGE 132
Automation Command and Query Reference Manual - Control Reference Enum ParamEngine Description Sets/Queries the parameter (measurement on a trace) for Px. This setting applies only if the MeasurementType control is set to "measure".
PAGE 133
Automation Command and Query Reference Manual - Control Reference Enum Source1 Description Sets/Queries the first trace source of the parameter Px. Used only when MeasurementType = "measure", for MeasurementType = "math", refer to PSource1.
PAGE 134
Automation Command and Query Reference Manual - Control Reference M3 M4 Z1 Z2 Z3 Z4 RESULT app.Measure.Px.histo.Result RESULT app.Measure.Px.last.Result RESULT app.Measure.Px.max.Result RESULT app.Measure.Px.mean.Result RESULT app.Measure.Px.min.Result RESULT app.Measure.Px.num.Result app.Measure.Px.Operator OPERATOR This path specifies that the selected ParamEngine or ArithEngine control variables are "here" app.Measure.Px.Out.Result RESULT Properties of the type xxxx.Out.Result.
PAGE 135
Automation Command and Query Reference Manual - Control Reference app.Measure.Px.sdev.Result RESULT app.Measure.Px.Statistics STATISTICS This set of variables controls the statistical summaries that are provided for all the parameters. app.Memory MEMORY Variables of the form app.Memory.xxxx control the memories M1 through M4. Names of the form app.Memory.Memories("Mx").xxxx are aliases of simpler names which are described in this section of the manual. Examples of alias pairs are as follows app.
PAGE 136
Automation Command and Query Reference Manual - Control Reference Action Copy Action LabelsPosition String LabelsText String Source1 Enum UseGrid String UserText String View Bool ViewLabels Bool Action ClearMem Description Initiates a clear memory operation for memory Mx. Action Copy Description Copy the trace specified by the Source1 control into this memory.
PAGE 137
Automation Command and Query Reference Manual - Control Reference Enum Source1 Description Source trace for Copy operations (see 'Copy' control) Values C1 C2 C3 C4 Digital1 Digital2 Digital3 Digital4 ET F1 M2 M3 M4 Z1 Z2 Z3 Z4 String UseGrid Range Any number of characters Description Sets/Queries the grid used for memory trace Mx. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set memory trace M2 to use grid YT3. app.Memory.M2.
PAGE 138
Automation Command and Query Reference Manual - Control Reference Bool ViewLabels Description Sets/Queries whether labels are visible for trace Mx. app.Memory.Mx.Out.Result RESULT See app.Acquisition.Cx.Out.Result for a definition of methods and properties used to access the Mx waveform result. app.Memory.Mx.Zoom ZOOM This set of variables controls zooming of the memory traces M1 through M4.
PAGE 139
Automation Command and Query Reference Manual - Control Reference Bool VariableHorZoom Description Sets/Queries the ability to zoom horizontally by a continuously variable factor as opposed to a factor that follows a 1, 2, 5 sequence. Bool VariableVerZoom Description Sets/Queries the ability to zoom vertically by a continuously variable factor as opposed to a factor that follows a 1, 2, 5 sequence. Double VerPos Range From -1.5 to 1.
PAGE 140
Automation Command and Query Reference Manual - Control Reference Enum ActionOn Description Sets/Queries whether a Pass condition or a Fail condition will initiate the pre-selected actions. Values Fail Pass Bool Alarm Description Sets/Queries whether Alarm is included in the PassFail actions. Enum PredefinedConditions Description Sets/Queries the logical criteria that must be met in a pass-fail test.
PAGE 141
Automation Command and Query Reference Manual - Control Reference app.PassFail.NumPassed.Result RESULT app.PassFail.Qx QX This set of variables controls the tests Q1 through Q8 in the pass fail system. ClearSweeps Action ConditionEngine Enum Equation String ShortDescription String View Bool WSource1 Enum Action ClearSweeps Description ClearSweeps Enum ConditionEngine Description Sets/Queries whether pass-fail test Qx uses mask testing or parameter comparison.
PAGE 142
Automation Command and Query Reference Manual - Control Reference Enum WSource1 Description WSource1 Values C1 C2 C3 C4 ET F1 M1 M2 M3 M4 XY Z1 Z2 Z3 Z4 app.PassFail.Qx.Out.Result RESULT Properties of the type xxxx.Out.Result.yyyy are those of the last completed acquisition. They are not affected if other cvars are changed after that acquisition was completed. This distinction between "Out.Result" properties and other cvars is most important when the trigger mode is Single or Stopped.
PAGE 143
Automation Command and Query Reference Manual - Control Reference OffsetControl Enum Bool AudibleFeedback Description Sets/Queries whether audible feedback is enabled, to sound when a control is touched. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Turn on the audible feedback function. app.Preferences.AudibleFeedback = True Bool EnhancedPrecisionMode Description EnhancedPrecisionMode Enum HorOffsetControl Description HorOffsetControl.
PAGE 144
Automation Command and Query Reference Manual - Control Reference app.Preferences.EMail EMAIL This set of variables controls user preferences for the instrument e-mail system. E-Mail may be sent when the hardcopy button is pressed when the hardcopy system is appropriately configured. Two standards are supported, SMTP (Simple Mail Transport Protocol), and MAPI (Messaging Application Programming Interface).
PAGE 145
Automation Command and Query Reference Manual - Control Reference Action SendTestMail Description Sends a message by e-mail to test the system. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Send an e-Mail message to test the system. app.Preferences.EMail.SendTestMail String SMTPServer Range Any number of characters Description Sets/Queries the name of the SMTP Server for e-mail. Ask your system administrator if you are unsure of what value to set this to. app.
PAGE 146
Automation Command and Query Reference Manual - Control Reference PanelDir FileName PanelFilename FileName RecallInternal1 Action RecallInternal2 Action RecallInternal3 Action RecallInternal4 Action RecallInternal5 Action RecallInternal6 Action SaveInternal1 Action SaveInternal2 Action SaveInternal3 Action SaveInternal4 Action SaveInternal5 Action SaveInternal6 Action Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Reset to default setup app.
PAGE 147
Automation Command and Query Reference Manual - Control Reference Action DoRecallPanel Description Recall the panel file named in the PanelFilename control. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Create the filename for the next panel setup to be recalled. app.SaveRecall.Setup.PanelFilename = "Setup89" ' Recall the panel setup from the named file. app.SaveRecall.Setup.
PAGE 148
Automation Command and Query Reference Manual - Control Reference String InternalName5 Range Any number of characters Description Please see InternalName1. String InternalName6 Range Any number of characters Description Please see InternalName1. FileName PanelDir Range Any number of characters Description Directory in which setups are stored/recalled. FileName PanelFilename Range Any number of characters Description Sets/Queries the current filename for saving a panel setup. Note that a '.
PAGE 149
Automation Command and Query Reference Manual - Control Reference Action RecallInternal5 Description Please see RecallInternal1. Action RecallInternal6 Description Please see RecallInternal1. Action SaveInternal1 Description Saves the current instrument settings into internal panel memory 1. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Save the current settings into internal panel memory 1. app.SaveRecall.Setup.
PAGE 150
Automation Command and Query Reference Manual - Control Reference Enum Delimiter Values Comma Semicolon Space Tab DoSave Action SaveSource Enum Values AllDisplayed FileName TableDir Range Any number of characters Enum TableFormat Values ASCII Excel String TableTitle Range Any number of characters app.SaveRecall.Utilities UTILITIES Controls used to manage files and folders, including the ability to create and delete folders, and the ability to delete files.
PAGE 151
Automation Command and Query Reference Manual - Control Reference app.SaveRecall.Utilities.CreateDir Action DeleteAll Description Deletes all files in the directory specified by the Directory control without a cautionary prompt. Use with care! Files cannot be recovered if deleted accidentally. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Delete all files without showing a yes/no prompt. app.SaveRecall.Utilities.Directory = "C:\MyDir" app.SaveRecall.Utilities.
PAGE 152
Automation Command and Query Reference Manual - Control Reference ' Save C1 into M1 app.SaveRecall.Waveform.SaveTo = "Memory" app.SaveRecall.Waveform.SaveSource = "C1" app.SaveRecall.Waveform.SaveDestination = "M1" app.SaveRecall.Waveform.DoSave Enum Delimiter Description Sets/Queries the delimiter to use when saving data in ASCII text mode. Values Comma Semicolon Space Tab Action DoRecall Description Recall waveform data into a trace memory. Source may be either an internal memory (M1..
PAGE 153
Automation Command and Query Reference Manual - Control Reference Enum RecallSource Description Sets/Queries the source for recalling waveform data. Used only when recalling from an internal memory with RecallSource = "Memory". Values M1 M2 M3 M4 Enum SaveDestination Description Sets/Queries the destination to which waveform data will be saved. Used only when the SaveTo = "Memory". Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 154
Automation Command and Query Reference Manual - Control Reference Enum SaveSource Description Sets/Queries the source from which waveform data will be saved. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the destination to memory for waveform save. app.SaveRecall.Waveform.SaveTo = "Memory" ' Set the source to C2, for saving a waveform. app.SaveRecall.Waveform.SaveSource = "C2" ' Set the destination to memory M4, for saving a waveform. app.SaveRecall.Waveform.
PAGE 155
Automation Command and Query Reference Manual - Control Reference Enum SaveTo Description Sets/Queries type of destination for waveform save. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the destination to Memory for waveform save. app.SaveRecall.Waveform.SaveTo = "Memory" Values File Save into file on a mass-storage device Memory Save into an internal memory (M1..
PAGE 156
Automation Command and Query Reference Manual - Control Reference Enum AnnotationPositionPreference Values OnNoisyTrace OnTrace LinkedToTrigger1 Bool LinkedToTrigger2 Bool LinkedToTrigger3 Bool LinkedToTrigger4 Bool Enum SelectDecoder Values Decode1 Decode2 Decode3 Decode4 app.SerialDecode.Decode[n].
PAGE 157
Automation Command and Query Reference Manual - Control Reference Enum Annotate Values All Left Right Enum BitOrder Values LSB MSB Integer BitsInChannel Range From 1 to 32 step 1 Integer BitsPerByte Range From 2 to 32 step 1 Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.
PAGE 158
Automation Command and Query Reference Manual - Control Reference Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.1 Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Falling Rising Integer CSOffset Range From 0 to 31 step 1 Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.
PAGE 159
Automation Command and Query Reference Manual - Control Reference Enum ViewingMode Values Binary dB Dec Hex app.SerialDecode.Decode[n].
PAGE 160
Automation Command and Query Reference Manual - Control Reference Integer BitsInChannel Range From 1 to 32 step 1 Integer BitsPerByte Range From 2 to 32 step 1 Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.
PAGE 161
Automation Command and Query Reference Manual - Control Reference Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Falling Rising Integer CSOffset Range From 0 to 31 step 1 Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.1 Enum DataLevelType Values Absolute Percent Bool IgnoreCS Integer MinSamplesPerBit Range From 4 to 100 step 1 Enum ViewingMode Values Binary dB Dec Hex app.SerialDecode.Decode[n].
PAGE 162
Automation Command and Query Reference Manual - Control Reference BitOrder Enum BitsInChannel Integer BitsPerByte Integer ByteSlicer Enum ClockLevelPercent Double ClockLevelType Enum ClockPhase Enum ColumnState String Conversion Enum CSLevelPercent Double CSLevelType Enum CSLockMode Enum CSOffset Integer CSPolarity Enum DataLevelPercent Double DataLevelType Enum IgnoreCS Bool MinSamplesPerBit Integer ViewingMode Enum Enum Annotate Values All Left Right Enum BitOrder
PAGE 163
Automation Command and Query Reference Manual - Control Reference Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.1 Enum ClockLevelType Values Absolute Percent Enum ClockPhase Values Negative Positive String ColumnState Range Any number of characters Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.
PAGE 164
Automation Command and Query Reference Manual - Control Reference Enum CSLockMode Values Falling Rising Integer CSOffset Range From 0 to 31 step 1 Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.1 Enum DataLevelType Values Absolute Percent Bool IgnoreCS Integer MinSamplesPerBit Range From 4 to 100 step 1 Enum ViewingMode Values Binary dB Dec Hex AUDIOTDM app.SerialDecode.Decode[n].
PAGE 165
Automation Command and Query Reference Manual - Control Reference ClockPhase Enum ColumnState String Conversion Enum CSLevelPercent Double CSLevelType Enum CSLockMode Enum CSOffset Integer CSPolarity Enum DataLevelPercent Double DataLevelType Enum IgnoreCS Bool MinSamplesPerBit Integer ViewingMode Enum Enum Annotate Values All Audio1 Audio2 Audio3 Audio4 Audio5 Audio6 Audio7 Audio8 Enum BitOrder Values LSB MSB Integer BitsInChannel Range From 1 to 32 step 1 Integer BitsP
PAGE 166
Automation Command and Query Reference Manual - Control Reference Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.1 Enum ClockLevelType Values Absolute Percent Enum ClockPhase Values Negative Positive String ColumnState Range Any number of characters Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.
PAGE 167
Automation Command and Query Reference Manual - Control Reference Enum CSLockMode Values Falling Rising Integer CSOffset Range From 0 to 31 step 1 Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.1 Enum DataLevelType Values Absolute Percent Bool IgnoreCS Integer MinSamplesPerBit Range From 4 to 100 step 1 Enum ViewingMode Values Binary dB Dec Hex app.SerialDecode.Decode[n].
PAGE 168
Automation Command and Query Reference Manual - Control Reference ViewingMode Enum Double BitRate Range From 10 to 2e+007 step 1 String ColumnState Range Any number of characters Bool GMLAN Double LevelPercent Range From 0 to 100 step 0.1 Enum LevelType Values Absolute Percent Bool ShowStuffBits Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values Hexadecimal app.SerialDecode.Decode[n].
PAGE 169
Automation Command and Query Reference Manual - Control Reference String ColumnState Range Any number of characters Bool GMLAN Double LevelPercent Range From 0 to 100 step 0.1 Enum LevelType Values Absolute Percent Bool ShowStuffBits Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values Hexadecimal GMCANHL app.SerialDecode.Decode[n].
PAGE 170
Automation Command and Query Reference Manual - Control Reference Double LevelPercent Range From 0 to 100 step 0.1 Enum LevelType Values Absolute Percent Bool ShowStuffBits Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values Hexadecimal GMCANLAN app.SerialDecode.Decode[n].
PAGE 171
Automation Command and Query Reference Manual - Control Reference Enum LevelType Values Absolute Percent Bool ShowStuffBits Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values Hexadecimal app.SerialDecode.Decode[n].
PAGE 172
Automation Command and Query Reference Manual - Control Reference Double DataLevelPercent Range From 0 to 100 step 0.1 Enum DataLevelType Values Absolute Percent Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values ASCII Binary Dec Hex app.SerialDecode.Decode[n].
PAGE 173
Automation Command and Query Reference Manual - Control Reference Enum LINVersion Values ALL J2602 Rev1.3 Rev2.x Double Tolerance Range From 0.01 to 10 step 0.01 app.SerialDecode.Decode[n].
PAGE 174
Automation Command and Query Reference Manual - Control Reference Enum LevelHType Values Absolute Percent Double LevelLAbsolute Range From -10 to 10 step 0.05 Enum LevelLType Values Absolute Percent Integer MinSamplesPerBit Range From 4 to 100 step 1 Double NPproximity Range From 1e-009 to 0.005 step 1e-009 Enum TableMode Values Transfer Word Enum ViewingMode Values Binary Hex app.SerialDecode.Decode[n].
PAGE 175
Automation Command and Query Reference Manual - Control Reference ViewingMode Enum Double BitRate Range From 30 to 5e+008 step 1 Enum ByteOrderUI Values LSB MSB String ColumnState Range Any number of characters Integer DataBitsUI Range From 5 to 16 step 1 Double LevelPercent Range From 0 to 100 step 0.
PAGE 176
Automation Command and Query Reference Manual - Control Reference Enum PolarityUI Values IdleHigh IdleLow Enum StopBitsUI Values 1 2 Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values ASCII Binary Hex app.SerialDecode.Decode[n].
PAGE 177
Automation Command and Query Reference Manual - Control Reference Enum BitOrder Values LSB MSB Integer BitsPerByte Range From 2 to 32 step 1 Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.
PAGE 178
Automation Command and Query Reference Manual - Control Reference Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.1 Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Both Falling Rising Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.
PAGE 179
Automation Command and Query Reference Manual - Control Reference Double InterFrameTime Range From 1e-009 to 10 step 1e-009 Integer MinSamplesPerBit Range From 4 to 100 step 1 Integer TDMChannel Range From 1 to 8 step 1 Enum ViewingMode Values ASCII Binary Dec Hex app.SerialDecode.Decode[n].
PAGE 180
Automation Command and Query Reference Manual - Control Reference Values LSB MSB Integer BitsPerByte Range From 2 to 32 step 1 Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.
PAGE 181
Automation Command and Query Reference Manual - Control Reference Double CSLevelPercent Range From 0 to 100 step 0.1 Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Both Falling Rising Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.
PAGE 182
Automation Command and Query Reference Manual - Control Reference Integer TDMChannel Range From 1 to 8 step 1 Enum ViewingMode Values ASCII Binary Dec Hex SPICUSTOM app.SerialDecode.Decode[n].
PAGE 183
Automation Command and Query Reference Manual - Control Reference Integer BitsPerByte Range From 2 to 32 step 1 Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.1 Enum ClockLevelType Values Absolute Percent Enum ClockPhase Values 0 1 Enum ClockPolarity Values 0 1 String ColumnState Range Any number of characters Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.
PAGE 184
Automation Command and Query Reference Manual - Control Reference Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Both Falling Rising Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.
PAGE 185
Automation Command and Query Reference Manual - Control Reference Enum ViewingMode Values ASCII Binary Dec Hex app.SerialDecode.Decode[n].
PAGE 186
Automation Command and Query Reference Manual - Control Reference Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.1 Enum ClockLevelType Values Absolute Percent Enum ClockPhase Values 0 1 Enum ClockPolarity Values 0 1 String ColumnState Range Any number of characters Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.
PAGE 187
Automation Command and Query Reference Manual - Control Reference Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Both Falling Rising Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.
PAGE 188
Automation Command and Query Reference Manual - Control Reference Enum ViewingMode Values ASCII Binary Dec Hex app.SerialDecode.Decode[n].
PAGE 189
Automation Command and Query Reference Manual - Control Reference Enum ByteSlicer Values CSbased CSbasedMulti HolebasedMulti NoHole Std UserCol Double ClockLevelPercent Range From 0 to 100 step 0.1 Enum ClockLevelType Values Absolute Percent Enum ClockPhase Values 0 1 Enum ClockPolarity Values 0 1 String ColumnState Range Any number of characters Enum Conversion Values Binary Binary2Cpl Double CSLevelPercent Range From 0 to 100 step 0.
PAGE 190
Automation Command and Query Reference Manual - Control Reference Enum CSLevelType Values Absolute Percent Enum CSLockMode Values Both Falling Rising Enum CSPolarity Values ActiveHigh ActiveLow Double DataLevelPercent Range From 0 to 100 step 0.
PAGE 191
Automation Command and Query Reference Manual - Control Reference Enum ViewingMode Values ASCII Binary Dec Hex app.SerialDecode.Decode[n].
PAGE 192
Automation Command and Query Reference Manual - Control Reference Enum LevelType Values Absolute Percent Enum Parity Values Even Mark None Odd Space Enum ParityUI Values Even None Odd Enum PolarityUI Values IdleHigh IdleLow Enum StopBitsUI Values 1 2 Double Tolerance Range From 0.01 to 10 step 0.01 Enum ViewingMode Values ASCII Binary Hex app.SerialDecode.
PAGE 193
Automation Command and Query Reference Manual - Control Reference DataSource Enum OutputFile FileName Protocol Enum View Bool ViewDecode Bool Enum AnnotationPosition Values Bottom Centered OnNoisyTrace OnTrace Top 918499 RevA 1-186
PAGE 194
Automation Command and Query Reference Manual - Control Reference Enum DataSource Description The Data Source has to be entered here. The source can be any channel, function or memory.
PAGE 195
Automation Command and Query Reference Manual - Control Reference M3 M4 Z2 Z3 Z4 FileName OutputFile Range Any number of characters Description The name and path of the File used to export the Decoded Table Enum Protocol Description The protocol currently decoded by this Decoder. At the time of this writing (July of 2007) we support 7 protocols:8b10, CAN, FlexRay, I2C, LIN, UART, SPI. The options purchased govern the list of visible protocol in this field.
PAGE 196
Automation Command and Query Reference Manual - Control Reference BitRate Double ColumnState String LevelPercent Double LevelType Enum ViewingMode Enum Double BitRate Range From 10 to 2e+007 step 1 Description The Bitrate of the data stream to be decoded String ColumnState Range Any number of characters Description This variable lists the visibility state of the columns in the decoded table Each column is named, followed by an equal sign and the state on or off.
PAGE 197
Automation Command and Query Reference Manual - Control Reference app.SystemControl SYSTEMCONTROL FrontPanelEventTimestamp String ModalDialogTimeout Integer PersistentMessage String String FrontPanelEventTimestamp Range Any number of characters Integer ModalDialogTimeout Range From 0 to 120 step 1 Description Set a timeout, in units of seconds, used to auto-dismiss modal dialogs, with their default responses. String PersistentMessage Range Any number of characters app.Utility.
PAGE 198
Automation Command and Query Reference Manual - Control Reference Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Read the current date and time from the real-time calendar and clock. app.Utility.DateTimeSetup.CurrentDateAndTime Integer Day Range From 1 to 31 step 1 Description Sets/Queries the day of the month setting of the real-time clock as a number. The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate is sent.
PAGE 199
Automation Command and Query Reference Manual - Control Reference Integer Month Range From 1 to 12 step 1 Description Sets/Queries the month setting of the real-time clock as a number. The value will not be accepted by the clock until app.Utility.DateTimeSetup.Validate is sent. All time/date controls are validated at the same time. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the month as August. app.Utility.DateTimeSetup.Month = 8 app.Utility.DateTimeSetup.
PAGE 200
Automation Command and Query Reference Manual - Control Reference Action Validate Description Validates any new settings. This action is equivalent to clicking 'Validate Changes' on the Date/Time page. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the day, hour, and minute, and validate. app.Utility.DateTimeSetup.Day = 3 app.Utility.DateTimeSetup.Hour = 5 app.Utility.DateTimeSetup.Minute = 8 app.Utility.DateTimeSetup.
PAGE 201
Automation Command and Query Reference Manual - Control Reference String InstalledSWOptions Range Any number of characters Description Shows list of installed software options. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Read the list of installed software options and display ' in a popup dialog MsgBox app.Utility.Options.InstalledSWOPtions String ScopeID Range Any number of characters Description Queries the ID of the instrument.
PAGE 202
Automation Command and Query Reference Manual - Control Reference Enum Interface Description Sets/Queries the currently selected type of currently selected remote control interface. Values LXI Off TCPIP Enum RestrictControl Description Sets/Queries whether remote control is restricted to certain hosts, where the host name is defined either by IP address, or dns name.
PAGE 203
Automation Command and Query Reference Manual - Control Reference FindRare1Sigma Action FindRare3Sigma Action FindRare5Sigma Action FindUseMean Action ShowTimes Bool Bool Enable Description Sets/Queries the WaveScan enabled state. Action FindRare1Sigma Description Preset the filter limit and delta to find rare events. Uses the history of measurements since the last Clear Sweeps, or control change, to set the limit and delta to capture +/- 1 sigma events.
PAGE 204
Automation Command and Query Reference Manual - Control Reference Bool View Description Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure, etc. app.WaveScan.ScanDecode.Out.Result RESULT app.Zoom ZOOM QuickZoom Action ResetAll Action Action QuickZoom Description Zoom all Cx that are on at an horizontal factor of 10.
PAGE 205
Automation Command and Query Reference Manual - Control Reference Action DoStoreToMemoryTrace Description Store the content of Zx into the corresponding Memory Slot (Mx). String Equation Range Any number of characters Description Same as app.Math.Fx.Equation. String LabelsPosition Range Any number of characters Description 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.
PAGE 206
Automation Command and Query Reference Manual - Control Reference Enum PersistenceTime Description 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. Values 0.5s 10s 1s 20s 2s 5s Infinite Bool ShowLastTrace Description Sets/Queries the state of the Show Last Trace control.
PAGE 207
Automation Command and Query Reference Manual - Control Reference String UseGrid Range Any number of characters Description Sets/Queries the grid in use for the zoom trace Zx. See also app.Acquisition.Cx.UseGrid. Bool View Description Sets/Queries the trace's 'Viewed' state. When true, the trace is displayed on one of the display graticules. Note that even when a trace is not visible, it may be used as a source for Math, Measure, etc.
PAGE 208
Automation Command and Query Reference Manual - Control Reference Action ResetZoom Description Resets the zoom settings to their default values. Bool VariableHorZoom Description Enable/Disable the variable Horizontal Zoom control. If enabled, the HorZoom control may be set to a value other than the standard 1, 2, 5 sequence. Bool VariableVerZoom Description Enable/Disable the variable Vertical Zoom control. If enabled, the VerZoom control may be set to a value other than the standard 1, 2, 5 sequence.
PAGE 209
Automation Command and Query Reference Manual - Processor Reference Table of Contents Average....................................................................................................................................................................... 2-1 Derivative.................................................................................................................................................................... 2-2 EnhancedResolution..............................................
PAGE 210
Automation Command and Query Reference Manual - Processor Reference AVERAGE app.Math.Fx.OperatorYSetup (Operator = "Average") Waveform Averaging. AverageType Enum ClearSweeps Action InvalidInputPolicy Bool Sweeps Integer Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Turn trace F1 on and setup to average the data from C1 ' Average mode is set to Continuous app.Math.F1.View = True app.Math.F1.Operator1 = "Average" app.Math.F1.
PAGE 211
Automation Command and Query Reference Manual - Processor Reference Integer Sweeps Range From 1 to 1000000 step 1 Description Sets / Queries the number of sweeps to be averaged when trace Fx is set to averaging - continuous or summed. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set number of sweeps to be averaged in trace F1 as 20. app.Math.F1.Operator1Setup.Sweeps = 20 DERIVATIVE app.Math.Fx.
PAGE 212
Automation Command and Query Reference Manual - Processor Reference DoubleLockstep VerScale Range From 1e-012 to 1e+013 step 10000, locked to 1 2 5, fine grain allowed=false, on=false Description Sets/Queries the vertical scale of the derivative function Fx. ENHANCEDRESOLUTION app.Math.Fx.OperatorYSetup (Operator = "EnhancedResolution") Bits Enum Enum Bits Description Number of bits of enhanced resolution. ERES is a FIR filter with a gaussian frequency response. Values 0.5 Enhance by 0.
PAGE 213
Automation Command and Query Reference Manual - Processor Reference Bool LimitNumSweeps Integer Sweeps Range From 1 to 1000000 step 1 Description Sets/Queries the maximum number of sweeps to be used by the envelope function trace Fx. FFT app.Math.Fx.OperatorYSetup (Operator = "FFT") Fast Fourier Transform of waveform data. SuppressDC Bool Type Enum Window Enum Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Configure F3 to perform an FFT of C1 app.Math.F3.
PAGE 214
Automation Command and Query Reference Manual - Processor Reference Enum Window Description Sets/Queries the type of window for the FFT function trace Fx. Values BlackmanHarris FlatTop Hamming Rectangular VonHann FLOOR app.Math.Fx.OperatorYSetup (Operator = "Floor") Most negative or minimum values for an ensemble of sweeps, or "Floor" ClearSweeps Action LimitNumSweeps Bool Sweeps Integer Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 215
Automation Command and Query Reference Manual - Processor Reference FindScale Action Multiplier Double VerOffset Double VerScale DoubleLockstep Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Configure F1 to integrate C1 app.Math.F1.View = True app.Math.F1.Source1 = "C1" app.Math.F1.MathMode = "OneOperator" app.Math.F1.Operator1 = "Integral" app.Math.F1.
PAGE 216
Automation Command and Query Reference Manual - Processor Reference Linearly transform the vertical values of a waveform. Adder Double CustomUnit Bool Multiplier Double Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Configure F1 app.Math.F1.View = True app.Math.F1.Source1 = "C1" app.Math.F1.MathMode = "OneOperator" app.Math.F1.Operator1 = "Rescale" app.Math.F1.Operator1Setup.Adder = 2.
PAGE 217
Automation Command and Query Reference Manual - Processor Reference Description Initiates a clear sweeps action for the roof function trace Fx. Bool LimitNumSweeps Integer Sweeps Range From 1 to 1000000 step 1 Description Sets/Queries the maximum number of sweeps for the Roof function trace Fx. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set function trace F2 to roof. app.Math.F2.Operator1 = "Roof" ' Set the maximum number of sweeps to 150. app.Math.F2.
PAGE 218
Automation Command and Query Reference Manual - Processor Reference BASE app.Measure.Px.Operator (ParamEngine = "Base") MAXIMUM app.Measure.Px.Operator (ParamEngine = "Maximum") Calculates the maximum vertical value of the waveform Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") app.Measure.P1.ParamEngine = "Maximum" MEAN app.Measure.Px.Operator (ParamEngine = "Mean") Calculates the mean value of the input waveform's vertical values.
PAGE 219
Automation Command and Query Reference Manual - Processor Reference Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") app.Measure.P1.ParamEngine = "Minimum" OVERSHOOTNEGATIVE app.Measure.Px.Operator (ParamEngine = "OvershootNegative") OVERSHOOTPOSITIVE app.Measure.Px.Operator (ParamEngine = "OvershootPositive") PEAKTOPEAK app.Measure.Px.Operator (ParamEngine = "PeakToPeak") PHASE app.Measure.Px.
PAGE 220
Automation Command and Query Reference Manual - Processor Reference Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set parameter P1 to phase difference. app.Measure.P1.ParamEngine = "Phase" ' Set the output unit as radians. app.Measure.P1.Operator.OutputType = "Radians" Values Degrees DEGREES360 Percent Radians RADIANSTWOPI Action RefFindLevel Description Find the test level for the reference trace. Example ' Visual Basic Script Set app = CreateObject("LeCroy.
PAGE 221
Automation Command and Query Reference Manual - Processor Reference Enum RefLevelType Description Sets/Queries the unit of measurement for the test level of the reference trace. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set parameter P1 to phase difference. app.Measure.P1.ParamEngine = "Phase" ' Set the reference level to be measured in absolute units. app.Measure.P1.Operator.
PAGE 222
Automation Command and Query Reference Manual - Processor Reference Action SigFindLevel Description Causes the engine to find a suitable level for either SigLevelType ("Absolute"or "Percent") Double SigHysteresis Range From 0 to 10 step 0.1 Description Sets/Queries the hysteresis range for the signal. Example ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set parameter P3 to phase difference. app.Measure.P3.ParamEngine = "Phase" ' Set the signal hysteresis in graticule divisions.
PAGE 223
Automation Command and Query Reference Manual - Processor Reference Description If true, the calculation is limited to a whole number of cycles detected in the input. SKEW app.Measure.Px.
PAGE 224
Automation Command and Query Reference Manual - Processor Reference Double Clock1PctLevel Range From 0 to 100 step 1 Description Sets/Queries the "Percent" of the amplitude of Clock1 to use for a transition level, if Clock1LevelIs = "Percent" Enum Clock1Slope Description Sets/Queries the polarity of transitions detected on Clock1 Values Both Neg Pos Action Clock2FindLevel Description Using ParamEngine = "Skew", please refer to the corresponding variable for the Hold Time parameter.
PAGE 225
Automation Command and Query Reference Manual - Processor Reference Enum Clock2Slope Description Sets/Queries the polarity of transitions detected on Clock2 Values Both Neg Pos Double Deskew Range From -1e-008 to 1e-008 step 1e-012 Integer UpSamplingFactor Range From 1 to 20 step 1 STANDARDDEVIATION app.Measure.Px.Operator (ParamEngine = "StandardDeviation") Cyclic Bool Bool Cyclic Description If true, the calculation is limited to a whole number of cycles detected in the input. TOP app.
PAGE 226
Thank you for using Remote Control and Automation on your WaveSurfer Oscilloscope.