Teledyne WavePro User Manual

Automation Command
Reference Manual
for
WaveMaster and WavePro
Oscilloscopes
LeCroy Corporation
700 Chestnut Ridge Road Chestnut Ridge, NY, 10977-6499 Tel: (845) 578-6020, Fax: (845) 578 5985
Internet: www.lecroy.com © 2010 by LeCroy Corporation. All rights reserved.
LeCroy and other product or brand names are trademarks or requested trademarks of their respective holders. Information in this publication supersedes all earlier versions. Specifications are subject to change without notice.
918501 RevA
AUTOMATION COMMAND REFERENCE MANUAL - INTRODUCTION
Introduction
This manual provides a comprehensive reference of all the commands available to a controlling application when using
WaveMaster and WavePro oscilloscopes. Automation enables the controlling application to run on the instrument itself.
PLEASE NOTE THE FOLLOWING:
Available commands include ones for purchased options you may or may not have on your oscilloscope. For more
information, contact your local LeCroy sales office for more information about options available for your instrument.
While we encourage the use of our code examples provided in our manuals, cutting and pasting code samples
directly from this .pdf manual into scripts cause syntax errors (typically illegal ASCII quotation characters). Carefully review code sample formatting during reuse.
The information in this manual is split into Control and Processor sections, each with their own table of contents.
918501 Rev A
iii
Automation Command and Query Reference Manual - Control Reference Table of Contents
app...........................................................................................................................................................................
1-1
app.Acquisition........................................................................................................................................................
1-7
app.Acquisition.AuxIn..............................................................................................................................................
1-9
app.Acquisition.AuxOutput......................................................................................................................................
1-10
app.Acquisition.Channels........................................................................................................................................
1-13
app.Acquisition.Cx...................................................................................................................................................
1-13
app.Acquisition.Cx.Out.Result.................................................................................................................................
1-24
app.Acquisition.Horizontal.......................................................................................................................................
1-24
app.Acquisition.Trigger............................................................................................................................................
1-29
app.Acquisition.Trigger.Edge..................................................................................................................................
1-33
app.Acquisition.Trigger.Serial.Protocol (Standard = "CAN")...................................................................................
1-36
app.Acquisition.Trigger.Serial.Protocol (Standard = "FLX")....................................................................................
1-39
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2C").....................................................................................
1-43
app.Acquisition.Trigger.Serial.Protocol (Standard = "I2S").....................................................................................
1-46
app.Acquisition.Trigger.Serial.Protocol (Standard = "LIN").....................................................................................
1-48
app.Acquisition.Trigger.Serial.Protocol (Standard = "MIL1553").............................................................................
1-50
app.Acquisition.Trigger.Serial.Protocol (Standard = "RS232")................................................................................
1-63
app.Acquisition.Trigger.Serial.Protocol (Standard = "SPI").....................................................................................
1-66
app.Acquisition.Trigger.Serial.Protocol (Standard = "UART").................................................................................
1-68
app.Acquisition.Trigger.Type (Type = "Cascaded")................................................................................................
1-71
app.Acquisition.Trigger.Type (Type = "Cascaded").AEdge.....................................................................................
1-73
app.Acquisition.Trigger.Type (Type = "Edge")........................................................................................................
1-74
app.Acquisition.Trigger.Type (Type = "Pattern").....................................................................................................
1-75
app.Acquisition.Trigger.Type (Type = "Qualified")..................................................................................................
1-75
app.Acquisition.Trigger.Type (Type = "Qualified").AEdge.......................................................................................
1-76
app.Acquisition.Trigger.Type (Type = "Qualified").BEdge.......................................................................................
1-77
app.Acquisition.Trigger.Type (Type = "Serial").......................................................................................................
1-78
app.Acquisition.Trigger.Type (Type = "Serial").I2C.................................................................................................
1-79
app.Acquisition.Trigger.Type (Type = "Smart").......................................................................................................
1-81
app.Acquisition.Trigger.Type (Type = "TV")............................................................................................................
1-82
app.Acquisition.Trigger.Type (Type = "Width").......................................................................................................
1-85
app.Cursors.............................................................................................................................................................
1-86
app.Display..............................................................................................................................................................
1-88
app.ElectricalTelecom.............................................................................................................................................
1-102
app.ElectricalTelecom.ET.......................................................................................................................................
1-107
app.ElectricalTelecom.ET.Out.Result.....................................................................................................................
1-110
app.HardCopy.........................................................................................................................................................
1-111
iv
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.LabNotebook....................................................................................................................................................
1-114
app.LogicAnalyzer...................................................................................................................................................
1-119
app.LogicAnalyzer.Digitalx......................................................................................................................................
1-122
app.LogicAnalyzer.Digitalx.Out.Result....................................................................................................................
1-124
app.LogicAnalyzer.Pattern......................................................................................................................................
1-124
app.Math..................................................................................................................................................................
1-135
app.Math.Functions.................................................................................................................................................
1-136
app.Math.Fx............................................................................................................................................................
1-136
app.Math.Fx.Operator1Setup..................................................................................................................................
1-149
app.Math.Fx.Out.Result..........................................................................................................................................
1-149
app.Math.Fx.Zoom..................................................................................................................................................
1-149
app.Math.XY............................................................................................................................................................
1-150
app.Math.XY.Out.Result..........................................................................................................................................
1-157
app.Measure...........................................................................................................................................................
1-157
app.Measure.Measure............................................................................................................................................
1-163
app.Measure.Px......................................................................................................................................................
1-163
app.Measure.Px.histo.Result..................................................................................................................................
1-173
app.Measure.Px.last.Result....................................................................................................................................
1-173
app.Measure.Px.max.Result...................................................................................................................................
1-173
app.Measure.Px.mean.Result.................................................................................................................................
1-174
app.Measure.Px.min.Result....................................................................................................................................
1-174
app.Measure.Px.num.Result...................................................................................................................................
1-174
app.Measure.Px.Operator.......................................................................................................................................
1-174
app.Measure.Px.Out.Result....................................................................................................................................
1-174
app.Measure.Px.sdev.Result..................................................................................................................................
1-174
app.Measure.Px.Statistics.......................................................................................................................................
1-174
app.Memory.............................................................................................................................................................
1-174
app.Memory.Memories............................................................................................................................................
1-175
app.Memory.Mx.......................................................................................................................................................
1-175
app.Memory.Mx.Out.Result.....................................................................................................................................
1-179
app.Memory.Mx.Zoom............................................................................................................................................
1-179
app.PassFail............................................................................................................................................................
1-180
app.PassFail.LastPass.Result.................................................................................................................................
1-183
app.PassFail.NumPassed.Result............................................................................................................................
1-183
app.PassFail.Qx......................................................................................................................................................
1-183
app.PassFail.Qx.Out.Result....................................................................................................................................
1-188
app.PassFail.Rate.Result........................................................................................................................................
1-188
v
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.PassFail.Tests.Result.......................................................................................................................................
1-189
app.Preferences......................................................................................................................................................
1-189
app.Preferences.EMail............................................................................................................................................
1-190
app.ProbesCal.........................................................................................................................................................
1-191
app.RecallSetupLock..............................................................................................................................................
1-198
app.SaveRecall.......................................................................................................................................................
1-198
app.SaveRecall.Setup.............................................................................................................................................
1-198
app.SaveRecall.Table.............................................................................................................................................
1-202
app.SaveRecall.Utilities...........................................................................................................................................
1-203
app.SaveRecall.Waveform......................................................................................................................................
1-204
app.SDA2................................................................................................................................................................
1-209
app.SDA2.CDR.......................................................................................................................................................
1-210
app.SDA2.EyeMeasure...........................................................................................................................................
1-213
app.SDA2.EyeMeasure.Eye....................................................................................................................................
1-216
app.SDA2.EyeMeasure.Eye.Out.Result..................................................................................................................
1-219
app.SDA2.EyeMeasure.Eye2Fail............................................................................................................................
1-219
app.SDA2.EyeMeasure.Eye2Fail.Out.Result..........................................................................................................
1-222
app.SDA2.EyeMeasure.EyeFail..............................................................................................................................
1-223
app.SDA2.EyeMeasure.EyeFail.Out.Result............................................................................................................
1-225
app.SDA2.EyeMeasure.IsoBER..............................................................................................................................
1-226
app.SDA2.EyeMeasure.IsoBER.Out.Result............................................................................................................
1-229
app.SDA2.EyeMeasure.Mask.................................................................................................................................
1-229
app.SDA2.EyeMeasure.Mask.Out.Result...............................................................................................................
1-229
app.SDA2.EyeMeasure.Mask2Failures..................................................................................................................
1-230
app.SDA2.EyeMeasure.Mask2Failures.Out.Result................................................................................................
1-230
app.SDA2.EyeMeasure.MaskFailures....................................................................................................................
1-230
app.SDA2.EyeMeasure.MaskFailures.Out.Result..................................................................................................
1-231
app.SDA2.EyeMeasure.Parameters.......................................................................................................................
1-231
app.SDA2.EyeMeasure.Parameters.Eye2Ampl......................................................................................................
1-233
app.SDA2.EyeMeasure.Parameters.Eye2Ampl.Out.Result....................................................................................
1-234
app.SDA2.EyeMeasure.Parameters.Eye2AvgPwr..................................................................................................
1-234
app.SDA2.EyeMeasure.Parameters.Eye2AvgPwr.Out.Result................................................................................
1-234
app.SDA2.EyeMeasure.Parameters.Eye2BER.......................................................................................................
1-234
app.SDA2.EyeMeasure.Parameters.Eye2BER.Out.Result.....................................................................................
1-235
app.SDA2.EyeMeasure.Parameters.Eye2Cross.....................................................................................................
1-235
app.SDA2.EyeMeasure.Parameters.Eye2Cross.Out.Result...................................................................................
1-235
app.SDA2.EyeMeasure.Parameters.Eye2ER.........................................................................................................
1-235
vi
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA2.EyeMeasure.Parameters.Eye2ER.Out.Result.......................................................................................
1-236
app.SDA2.EyeMeasure.Parameters.Eye2Height....................................................................................................
1-236
app.SDA2.EyeMeasure.Parameters.Eye2Height.Out.Result..................................................................................
1-236
app.SDA2.EyeMeasure.Parameters.Eye2One.......................................................................................................
1-236
app.SDA2.EyeMeasure.Parameters.Eye2One.Out.Result.....................................................................................
1-237
app.SDA2.EyeMeasure.Parameters.Eye2Width.....................................................................................................
1-237
app.SDA2.EyeMeasure.Parameters.Eye2Width.Out.Result...................................................................................
1-237
app.SDA2.EyeMeasure.Parameters.Eye2Zero.......................................................................................................
1-237
app.SDA2.EyeMeasure.Parameters.Eye2Zero.Out.Result.....................................................................................
1-238
app.SDA2.EyeMeasure.Parameters.EyeAmpl........................................................................................................
1-238
app.SDA2.EyeMeasure.Parameters.EyeAmpl.Out.Result......................................................................................
1-238
app.SDA2.EyeMeasure.Parameters.EyeAvgPwr....................................................................................................
1-238
app.SDA2.EyeMeasure.Parameters.EyeAvgPwr.Out.Result..................................................................................
1-239
app.SDA2.EyeMeasure.Parameters.EyeBER.........................................................................................................
1-239
app.SDA2.EyeMeasure.Parameters.EyeBER.Out.Result.......................................................................................
1-239
app.SDA2.EyeMeasure.Parameters.EyeCross.......................................................................................................
1-239
app.SDA2.EyeMeasure.Parameters.EyeCross.Out.Result.....................................................................................
1-240
app.SDA2.EyeMeasure.Parameters.EyeER...........................................................................................................
1-240
app.SDA2.EyeMeasure.Parameters.EyeER.Out.Result.........................................................................................
1-240
app.SDA2.EyeMeasure.Parameters.EyeHeight......................................................................................................
1-240
app.SDA2.EyeMeasure.Parameters.EyeHeight.Out.Result....................................................................................
1-241
app.SDA2.EyeMeasure.Parameters.EyeOne.........................................................................................................
1-241
app.SDA2.EyeMeasure.Parameters.EyeOne.Out.Result.......................................................................................
1-241
app.SDA2.EyeMeasure.Parameters.EyeWidth.......................................................................................................
1-241
app.SDA2.EyeMeasure.Parameters.EyeWidth.Out.Result.....................................................................................
1-242
app.SDA2.EyeMeasure.Parameters.EyeZero.........................................................................................................
1-242
app.SDA2.EyeMeasure.Parameters.EyeZero.Out.Result.......................................................................................
1-242
app.SDA2.EyeMeasure.Parameters.Mask2Hits.....................................................................................................
1-242
app.SDA2.EyeMeasure.Parameters.Mask2Hits.Out.Result...................................................................................
1-243
app.SDA2.EyeMeasure.Parameters.Mask2Out......................................................................................................
1-243
app.SDA2.EyeMeasure.Parameters.Mask2Out.Out.Result....................................................................................
1-243
app.SDA2.EyeMeasure.Parameters.MaskHits.......................................................................................................
1-243
app.SDA2.EyeMeasure.Parameters.MaskHits.Out.Result.....................................................................................
1-244
app.SDA2.EyeMeasure.Parameters.MaskOut........................................................................................................
1-244
app.SDA2.EyeMeasure.Parameters.MaskOut.Out.Result......................................................................................
1-244
app.SDA2.EyeMeasure.ThisSweepMask2Failures.................................................................................................
1-244
app.SDA2.EyeMeasure.ThisSweepMask2Failures.Out.Result..............................................................................
1-245
vii
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA2.EyeMeasure.ThisSweepMaskFailures...................................................................................................
1-245
app.SDA2.EyeMeasure.ThisSweepMaskFailures.Out.Result................................................................................
1-245
app.SDA2.FSBACGate...........................................................................................................................................
1-245
app.SDA2.FSBACGate.Out.Result.........................................................................................................................
1-248
app.SDA2.FSBTcoGate..........................................................................................................................................
1-248
app.SDA2.FSBTcoGate.Out.Result........................................................................................................................
1-251
app.SDA2.JitterMeasure.........................................................................................................................................
1-252
app.SDA2.JitterMeasure.Filter................................................................................................................................
1-252
app.SDA2.JitterMeasure.Histogram........................................................................................................................
1-253
app.SDA2.JitterMeasure.Histogram.BathTub.........................................................................................................
1-254
app.SDA2.JitterMeasure.Histogram.BathTub.Out.Result.......................................................................................
1-257
app.SDA2.JitterMeasure.Histogram.CDFdd...........................................................................................................
1-257
app.SDA2.JitterMeasure.Histogram.CDFdd.Out.Result.........................................................................................
1-260
app.SDA2.JitterMeasure.Histogram.CDFnq...........................................................................................................
1-261
app.SDA2.JitterMeasure.Histogram.CDFnq.Out.Result.........................................................................................
1-264
app.SDA2.JitterMeasure.Histogram.CDFsp...........................................................................................................
1-264
app.SDA2.JitterMeasure.Histogram.CDFsp.Out.Result.........................................................................................
1-267
app.SDA2.JitterMeasure.Histogram.CDFtotal........................................................................................................
1-267
app.SDA2.JitterMeasure.Histogram.CDFtotal.Out.Result......................................................................................
1-270
app.SDA2.JitterMeasure.Histogram.CDFtotal.Zoom..............................................................................................
1-271
app.SDA2.JitterMeasure.Histogram.NQFit.............................................................................................................
1-272
app.SDA2.JitterMeasure.Histogram.NQFit.Out.Result...........................................................................................
1-275
app.SDA2.JitterMeasure.Histogram.RjBUjHist.......................................................................................................
1-275
app.SDA2.JitterMeasure.Histogram.RjBUjHist.Out.Result.....................................................................................
1-278
app.SDA2.JitterMeasure.Histogram.RjBUjHist.Zoom.............................................................................................
1-278
app.SDA2.JitterMeasure.Histogram.TIEHist...........................................................................................................
1-279
app.SDA2.JitterMeasure.Histogram.TIEHist.Out.Result.........................................................................................
1-282
app.SDA2.JitterMeasure.Histogram.TIEHist.Zoom................................................................................................
1-283
app.SDA2.JitterMeasure.Parameters.....................................................................................................................
1-284
app.SDA2.JitterMeasure.Parameters.BitRate.........................................................................................................
1-286
app.SDA2.JitterMeasure.Parameters.BitRate.Out.Result.......................................................................................
1-286
app.SDA2.JitterMeasure.Parameters.DCD.............................................................................................................
1-286
app.SDA2.JitterMeasure.Parameters.DCD.Out.Result...........................................................................................
1-286
app.SDA2.JitterMeasure.Parameters.DDj..............................................................................................................
1-287
app.SDA2.JitterMeasure.Parameters.DDj.Out.Result............................................................................................
1-287
app.SDA2.JitterMeasure.Parameters.Dj.................................................................................................................
1-287
app.SDA2.JitterMeasure.Parameters.Dj.Out.Result...............................................................................................
1-287
viii
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA2.JitterMeasure.Parameters.DjDD............................................................................................................
1-287
app.SDA2.JitterMeasure.Parameters.DjDD.Out.Result..........................................................................................
1-288
app.SDA2.JitterMeasure.Parameters.DjNQ............................................................................................................
1-288
app.SDA2.JitterMeasure.Parameters.DjNQ.Out.Result.........................................................................................
1-288
app.SDA2.JitterMeasure.Parameters.Djsp.............................................................................................................
1-289
app.SDA2.JitterMeasure.Parameters.Djsp.Out.Result...........................................................................................
1-289
app.SDA2.JitterMeasure.Parameters.ISI................................................................................................................
1-289
app.SDA2.JitterMeasure.Parameters.ISI.Out.Result..............................................................................................
1-289
app.SDA2.JitterMeasure.Parameters.PattLen........................................................................................................
1-290
app.SDA2.JitterMeasure.Parameters.Pj.................................................................................................................
1-290
app.SDA2.JitterMeasure.Parameters.Pj.Out.Result...............................................................................................
1-290
app.SDA2.JitterMeasure.Parameters.Rj.................................................................................................................
1-290
app.SDA2.JitterMeasure.Parameters.Rj.Out.Result...............................................................................................
1-291
app.SDA2.JitterMeasure.Parameters.RjBUj...........................................................................................................
1-291
app.SDA2.JitterMeasure.Parameters.RjBUj.Out.Result.........................................................................................
1-291
app.SDA2.JitterMeasure.Parameters.RjDD............................................................................................................
1-291
app.SDA2.JitterMeasure.Parameters.RjDD.Out.Result..........................................................................................
1-292
app.SDA2.JitterMeasure.Parameters.RjNQ............................................................................................................
1-292
app.SDA2.JitterMeasure.Parameters.RjNQ.Out.Result.........................................................................................
1-292
app.SDA2.JitterMeasure.Parameters.Rjsp.............................................................................................................
1-292
app.SDA2.JitterMeasure.Parameters.Rjsp.Out.Result...........................................................................................
1-293
app.SDA2.JitterMeasure.Parameters.RjspRaw......................................................................................................
1-293
app.SDA2.JitterMeasure.Parameters.RjspRaw.Out.Result....................................................................................
1-293
app.SDA2.JitterMeasure.Parameters.TIE...............................................................................................................
1-293
app.SDA2.JitterMeasure.Parameters.TIE.Out.Result.............................................................................................
1-294
app.SDA2.JitterMeasure.Parameters.TIEbar..........................................................................................................
1-294
app.SDA2.JitterMeasure.Parameters.TIEbar.Out.Result........................................................................................
1-294
app.SDA2.JitterMeasure.Parameters.TIEeye.........................................................................................................
1-294
app.SDA2.JitterMeasure.Parameters.TIEeye.Out.Result.......................................................................................
1-295
app.SDA2.JitterMeasure.Parameters.TIEraw.........................................................................................................
1-295
app.SDA2.JitterMeasure.Parameters.TIEraw.Out.Result.......................................................................................
1-295
app.SDA2.JitterMeasure.Parameters.Tj.................................................................................................................
1-295
app.SDA2.JitterMeasure.Parameters.Tj.Out.Result...............................................................................................
1-296
app.SDA2.JitterMeasure.Parameters.TjDD............................................................................................................
1-296
app.SDA2.JitterMeasure.Parameters.TjDD.Out.Result..........................................................................................
1-296
app.SDA2.JitterMeasure.Parameters.TjNQ............................................................................................................
1-296
app.SDA2.JitterMeasure.Parameters.TjNQ.Out.Result..........................................................................................
1-297
ix
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA2.JitterMeasure.Parameters.Tjsp..............................................................................................................
1-297
app.SDA2.JitterMeasure.Parameters.Tjsp.Out.Result...........................................................................................
1-297
app.SDA2.JitterMeasure.Pattern.............................................................................................................................
1-297
app.SDA2.JitterMeasure.Pattern.DDjHist...............................................................................................................
1-302
app.SDA2.JitterMeasure.Pattern.DDjHist.Out.Result.............................................................................................
1-305
app.SDA2.JitterMeasure.Pattern.DDjHist.Zoom.....................................................................................................
1-305
app.SDA2.JitterMeasure.Pattern.DDjPlot...............................................................................................................
1-306
app.SDA2.JitterMeasure.Pattern.DDjPlot.Out.Result.............................................................................................
1-309
app.SDA2.JitterMeasure.Pattern.DDjPlot.Zoom.....................................................................................................
1-309
app.SDA2.JitterMeasure.Pattern.DigPat.................................................................................................................
1-310
app.SDA2.JitterMeasure.Pattern.DigPat.Out.Result...............................................................................................
1-313
app.SDA2.JitterMeasure.Pattern.DigPat.Zoom.......................................................................................................
1-314
app.SDA2.JitterMeasure.Pattern.ISIPattern............................................................................................................
1-315
app.SDA2.JitterMeasure.Pattern.ISIPattern.Out.Result..........................................................................................
1-315
app.SDA2.JitterMeasure.Pattern.ISIPlot.................................................................................................................
1-315
app.SDA2.JitterMeasure.Pattern.ISIPlot.Out.Result...............................................................................................
1-318
app.SDA2.JitterMeasure.Spectrum.........................................................................................................................
1-318
app.SDA2.JitterMeasure.Spectrum.PjInvFFT.........................................................................................................
1-320
app.SDA2.JitterMeasure.Spectrum.PjInvFFT.Out.Result.......................................................................................
1-323
app.SDA2.JitterMeasure.Spectrum.PjInvFFT.Zoom...............................................................................................
1-323
app.SDA2.JitterMeasure.Spectrum.PkThresh........................................................................................................
1-324
app.SDA2.JitterMeasure.Spectrum.PkThresh.Out.Result......................................................................................
1-327
app.SDA2.JitterMeasure.Spectrum.PkThresh.Zoom..............................................................................................
1-327
app.SDA2.JitterMeasure.Spectrum.RjBUjSpect.....................................................................................................
1-328
app.SDA2.JitterMeasure.Spectrum.RjBUjSpect.Out.Result...................................................................................
1-332
app.SDA2.JitterMeasure.Spectrum.RjBUjSpect.Zoom...........................................................................................
1-332
app.SDA2.JitterMeasure.Spectrum.SSCTrkx.........................................................................................................
1-333
app.SDA2.JitterMeasure.Spectrum.SSCTrkx.Out.Result.......................................................................................
1-336
app.SDA2.JitterMeasure.Track...............................................................................................................................
1-336
app.SDA2.JitterMeasure.Track.PLLTrack..............................................................................................................
1-337
app.SDA2.JitterMeasure.Track.PLLTrack.Out.Result............................................................................................
1-340
app.SDA2.JitterMeasure.Track.PLLTrack.Zoom....................................................................................................
1-340
app.SDA2.JitterMeasure.Track.RjBUjTrack............................................................................................................
1-341
app.SDA2.JitterMeasure.Track.RjBUjTrack.Out.Result.........................................................................................
1-344
app.SDA2.JitterMeasure.Track.RjBUjTrack.Zoom.................................................................................................
1-344
app.SDA2.JitterMeasure.Track.TIETrack...............................................................................................................
1-345
app.SDA2.JitterMeasure.Track.TIETrack.Out.Result.............................................................................................
1-348
x
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA2.JitterMeasure.Track.TIETrack.Zoom.....................................................................................................
1-349
app.SDA2.PCIe.......................................................................................................................................................
1-350
app.SDA2.PCIe.Parameters...................................................................................................................................
1-351
app.SDA2.PCIe.Parameters.SD2Skew..................................................................................................................
1-351
app.SDA2.PCIe.Parameters.SD2Skew.Out.Result................................................................................................
1-351
app.SDA2.PCIe.Parameters.SSC1Freq..................................................................................................................
1-352
app.SDA2.PCIe.Parameters.SSC1Freq.Out.Result...............................................................................................
1-352
app.SDA2.PCIe.Parameters.SSC1Max..................................................................................................................
1-352
app.SDA2.PCIe.Parameters.SSC1Max.Out.Result................................................................................................
1-352
app.SDA2.PCIe.Parameters.SSC1Min...................................................................................................................
1-352
app.SDA2.PCIe.Parameters.SSC1Min.Out.Result.................................................................................................
1-353
app.SDA2.PCIe.Parameters.SSC2Freq..................................................................................................................
1-353
app.SDA2.PCIe.Parameters.SSC2Freq.Out.Result...............................................................................................
1-353
app.SDA2.PCIe.Parameters.SSC2Max..................................................................................................................
1-353
app.SDA2.PCIe.Parameters.SSC2Max.Out.Result................................................................................................
1-354
app.SDA2.PCIe.Parameters.SSC2Min...................................................................................................................
1-354
app.SDA2.PCIe.Parameters.SSC2Min.Out.Result.................................................................................................
1-354
app.SDA2.PCIe.Parameters.SSCDiff.....................................................................................................................
1-354
app.SDA2.PCIe.Parameters.SSCDiff.Out.Result...................................................................................................
1-355
app.SDA2.PCIe.Parameters.TxFallDm...................................................................................................................
1-355
app.SDA2.PCIe.Parameters.TxFallDm.Out.Result.................................................................................................
1-355
app.SDA2.PCIe.Parameters.TxFallDp....................................................................................................................
1-355
app.SDA2.PCIe.Parameters.TxFallDp.Out.Result..................................................................................................
1-356
app.SDA2.PCIe.Parameters.TxRiseDm.................................................................................................................
1-356
app.SDA2.PCIe.Parameters.TxRiseDm.Out.Result...............................................................................................
1-356
app.SDA2.PCIe.Parameters.TxRiseDp..................................................................................................................
1-356
app.SDA2.PCIe.Parameters.TxRiseDp.Out.Result................................................................................................
1-357
app.SDA2.PCIe.Parameters.Vdiff...........................................................................................................................
1-357
app.SDA2.PCIe.Parameters.Vdiff.Out.Result.........................................................................................................
1-357
app.SDA2.PCIe.Parameters.VdiffPP......................................................................................................................
1-357
app.SDA2.PCIe.Parameters.VdiffPP.Out.Result....................................................................................................
1-358
app.SDA2.PCIe.Parameters.VTxCm......................................................................................................................
1-358
app.SDA2.PCIe.Parameters.VTxCm.Out.Result....................................................................................................
1-358
app.SDA2.PCIe.Parameters.VTxDe.......................................................................................................................
1-358
app.SDA2.PCIe.Parameters.VTxDe.Out.Result.....................................................................................................
1-359
app.SDA2.PCIeComp.............................................................................................................................................
1-359
app.SDA2.PCIeComp.PCIeEye..............................................................................................................................
1-362
xi
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SDA2.PCIeComp.PCIeEye.Out.Result............................................................................................................
1-363
app.SDA2.PCIeComp.PCIeEyeNT.........................................................................................................................
1-363
app.SDA2.PCIeComp.PCIeEyeNT.Out.Result.......................................................................................................
1-363
app.SDA2.PCIeParameters....................................................................................................................................
1-363
app.SDA2.PCIeParameters.PCIeParameter1........................................................................................................
1-363
app.SDA2.PCIeParameters.PCIeParameter1.histo.Result.....................................................................................
1-363
app.SDA2.PCIeParameters.PCIeParameter1.last.Result.......................................................................................
1-363
app.SDA2.PCIeParameters.PCIeParameter1.max.Result.....................................................................................
1-363
app.SDA2.PCIeParameters.PCIeParameter1.mean.Result...................................................................................
1-364
app.SDA2.PCIeParameters.PCIeParameter1.min.Result......................................................................................
1-364
app.SDA2.PCIeParameters.PCIeParameter1.num.Result.....................................................................................
1-364
app.SDA2.PCIeParameters.PCIeParameter1.PCIeParmetersStatistics................................................................
1-364
app.SDA2.PCIeParameters.PCIeParameter1.sdev.Result.....................................................................................
1-364
app.SDA2.RefClkInput............................................................................................................................................
1-364
app.SDA2.RefClkInput.SDARefClk.........................................................................................................................
1-368
app.SDA2.RefClkInput.SDARefClk.Out.Result.......................................................................................................
1-371
app.SDA2.SDAStatus.............................................................................................................................................
1-371
app.SDA2.SignalInput.............................................................................................................................................
1-372
app.SDA2.SignalInput.SDAInput.............................................................................................................................
1-377
app.SDA2.SignalInput.SDAInput.Out.Result...........................................................................................................
1-380
app.SerialDecode....................................................................................................................................................
1-380
app.SerialDecode.Decode[n].Protocol (Protocol = "8B10B")..................................................................................
1-381
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioI2S")..............................................................................
1-382
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioLJ")................................................................................
1-385
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioRJ")...............................................................................
1-388
app.SerialDecode.Decode[n].Protocol (Protocol = "AudioTDM")............................................................................
1-390
app.SerialDecode.Decode[n].Protocol (Protocol = "CAN").....................................................................................
1-393
app.SerialDecode.Decode[n].Protocol (Protocol = "CANHL").................................................................................
1-394
app.SerialDecode.Decode[n].Protocol (Protocol = "FLX")......................................................................................
1-395
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANHL")...........................................................................
1-396
app.SerialDecode.Decode[n].Protocol (Protocol = "GMCANLAN")........................................................................
1-397
app.SerialDecode.Decode[n].Protocol (Protocol = "I2C").......................................................................................
1-398
app.SerialDecode.Decode[n].Protocol (Protocol = "LIN").......................................................................................
1-399
app.SerialDecode.Decode[n].Protocol (Protocol = "MIL1553")...............................................................................
1-400
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE1X1")..............................................................................
1-401
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE1X2")..............................................................................
1-402
app.SerialDecode.Decode[n].Protocol (Protocol = "PCIE4X1")..............................................................................
1-403
xii
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.SerialDecode.Decode[n].Protocol (Protocol = "RS232")..................................................................................
1-404
app.SerialDecode.Decode[n].Protocol (Protocol = "SIOP")....................................................................................
1-406
app.SerialDecode.Decode[n].Protocol (Protocol = "SPI").......................................................................................
1-409
app.SerialDecode.Decode[n].Protocol (Protocol = "SPICustom")...........................................................................
1-412
app.SerialDecode.Decode[n].Protocol (Protocol = "SPIDDR")...............................................................................
1-415
app.SerialDecode.Decode[n].Protocol (Protocol = "SSPI").....................................................................................
1-418
app.SerialDecode.Decode[n].Protocol (Protocol = "UART")...................................................................................
1-421
app.SerialDecode.Decode[n].Protocol (Protocol = "USART").................................................................................
1-422
app.SerialDecode.Decodex.....................................................................................................................................
1-425
app.SerialDecode.Decodex.Decode.......................................................................................................................
1-430
app.SerialDecode.Decodex.Out.Result...................................................................................................................
1-432
app.SerialDecode.FlexRayMeasure........................................................................................................................
1-432
app.SerialDecode.FLXEye......................................................................................................................................
1-434
app.SerialDecode.FLXEye.Out.Result....................................................................................................................
1-439
app.SerialDecode.Measure.....................................................................................................................................
1-439
app.SpecAnalyzer...................................................................................................................................................
1-445
app.SpecAnalyzer.SpecAn......................................................................................................................................
1-448
app.SpecAnalyzer.SpecAn.Out.Result....................................................................................................................
1-451
app.SpecAnalyzer.SpecAnTable.............................................................................................................................
1-452
app.SpecAnalyzer.SpecAnTable.Out.Result...........................................................................................................
1-452
app.SystemControl..................................................................................................................................................
1-452
app.TriggerScan......................................................................................................................................................
1-452
app.Utility.DateTimeSetup.......................................................................................................................................
1-455
app.Utility.Options...................................................................................................................................................
1-458
app.Utility.Remote...................................................................................................................................................
1-459
app.Utility.Remote.IOManager.CIOPortU3GPIB.....................................................................................................
1-460
app.Utility.Remote.IOManager.CLSIBPort..............................................................................................................
1-460
app.WaveScan........................................................................................................................................................
1-460
app.WaveScan.ScanDecode..................................................................................................................................
1-461
app.WaveScan.ScanDecode.Out.Result................................................................................................................
1-462
app.WaveScan.ScanHisto......................................................................................................................................
1-462
app.WaveScan.ScanHisto.Histogram.....................................................................................................................
1-465
app.WaveScan.ScanHisto.Out.Result....................................................................................................................
1-466
app.WaveScan.ScanHisto.Zoom............................................................................................................................
1-466
app.WaveScan.ScanOverlay..................................................................................................................................
1-468
app.WaveScan.ScanOverlay.Out.Result................................................................................................................
1-470
app.WebEditor.........................................................................................................................................................
1-470
xiii
918501 RevA
Automation Command and Query Reference Manual - Control Reference Table of Contents
app.XPort.................................................................................................................................................................
1-472
app.Zoom................................................................................................................................................................
1-472
app.Zoom.Zx...........................................................................................................................................................
1-474
app.Zoom.Zx.Out.Result.........................................................................................................................................
1-479
app.Zoom.Zx.Zoom.................................................................................................................................................
1-479
xiv
918501 RevA
Automation Command and Query Reference Manual - Control Reference
LECROY.XSTREAMDSO
app
This is the root of the automation hierarchy, all other nodes are accessed from this point.
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Popup a dialog containing the instrument model MsgBox "Model is: " & app.InstrumentModel
Example
AutoSetup
Action
Starts an AutoSetup operation. When input channels are visible, AutoSetup operates only on those visible channels. If no channels are visible, all channels are affected by AutoSetup. With more than one channel visible, the first visible channel in numerical order, that has a detectable signal applied to it, is automatically set up for edge triggering.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Start an Auto-Setup process. app.AutoSetup
Example
AutoSetup
Action
ClearSweeps
Action
Exit
Action
FirmwareVersion
String
Height
Property
HideClock
Bool
InstrumentID
String
InstrumentModel
String
Left
Property
Maximize
Action
Minimize
Action
Quit()
Method
ResetPreferences
Action
Restore
Action
SetToDefaultSetup
Action
Shutdown
Action
Sleep([in] double timeoutMilliseconds)
Method
Top
Property
TouchScreenEnable
Bool
WaitUntilIdle([in] double timeoutSeconds)
Method
Width
Property
Windowed
Action
WindowState
Property
1-1
918501 RevA
Automation Command and Query Reference Manual - Control Reference
ClearSweeps
Action
Clears all accumulated sweeps for all subsystems. These include Channel Pre-Processing, Math, Measure, and Display Persistence. Note that subsystem-specific clear sweeps controls are also available. For the details please refer to the ClearSweeps control for each subsystem.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Clear all accumulated sweeps for all subsystems. app.ClearSweeps
Example
Exit
Action
Equivalent to app.Quit() method.
Description
FirmwareVersion
String
Any number of characters
Range
Queries the firmware version of the instrument in the form - "1.0.0 (build 12345)"
Description
' Microsoft Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Query the firmware version number of the instrument. MsgBox "Firmware Version is: " + app.FirmwareVersion
Example
Height
Property
Sets/Queries the height in pixels of the instrument display on the PC screen.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the height of the instrument window to 400 pixels. app.Height = 400
Example
HideClock
Bool
Hides/Shows the clock that resides in the lower-right corner of the display of the instrument.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Hide the clock for 3 seconds. app.HideClock = True app.Sleep(3000) app.HideClock = False
Example
1-2
918501 RevA
Automation Command and Query Reference Manual - Control Reference
InstrumentID
String
Any number of characters
Range
Reads the complete ID of the instrument in the format: "LECROY,WM8500,WM000001,0.0.0", which includes the maker, the instrument model number, the serial number, and the version number.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Present the ID of the instrument. MsgBox app.InstrumentID
Example
InstrumentModel
String
Any number of characters
Range
Queries the model number of the instrument.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Present the model number of the instrument. MsgBox app.InstrumentModel
Example
Left
Property
Sets/Queries the position in pixels of the left edge of the instrument display on the PC screen. The position is measured from the left edge of the screen to the left edge of the instrument window.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Set the position of the left edge of the instrument window to 100 pixels. app.Left = 100
Example
Maximize
Action
Maximize the instrument window to fill the underlying desktop. Equivalent to app.WindowState = 1
Description
1-3
918501 RevA
Automation Command and Query Reference Manual - Control Reference
Minimize
Action
Minimizes the instrument window to reveal the underlying desktop. It will display a small window in the bottom right corner of the display, which when clicked will restore the window to full-screen mode. To programmatically restore the window refer to the app.WindowState control.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Minimize the instrument display. app.Minimize
Example
Quit()
Method
Closes the instrument application. The instrument will prompt the user with an 'Are you sure?' dialog before closing down. Note that until the user responds to the dialog, control via Automation will be blocked.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Quit the instrument application with a confirmation prompt. app.Quit
Example
ResetPreferences
Action
Resets all scope preferences to their default states. The set includes the current remote communications port, the color palette settings, etc. but does not include the main DSO controls such as V/Div, T/Div, etc. These main instrument controls can be reset using the SetToDefaultSetup control.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Reset all instrument preferences. app.ResetPreferences
Example
Restore
Action
Restore the instrument display to its position and size before the last minimize request.
Description
1-4
918501 RevA
Automation Command and Query Reference Manual - Control Reference
SetToDefaultSetup
Action
Restores the instrument setup to its default state. Note that certain settings will not be restored to the default state. These are the user preferences, such as the current remote communications port, and the color settings, which may be reset, if required, using the ResetPreferences action.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Restore the instrument to its default state. app.SetToDefaultSetup
Example
Shutdown
Action
Shuts down the instrument. It will prompt the user with an 'Are you sure?' dialog before shutting down. Note that until the user responds to the dialog, control via Automation will be blocked.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Shut down the instrument with a confirmation prompt. app.Shutdown
Example
Sleep([in] double timeoutMilliseconds)
Method
Causes the main execution thread of the instrument application to sleep for the specified time period, defined in milliseconds.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
MsgBox "Sleeping for 10 seconds..." app.Sleep(10000) MsgBox "Sleep finished"
Example
Top
Property
Sets/Queries the position in pixels of the top edge of the instrument display on the PC screen. The position is measured downwards from the top of the screen to the top of the instrument window.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the position of the top edge of the instrument window to 100 pixels. app.Top = 100
Example
1-5
918501 RevA
Automation Command and Query Reference Manual - Control Reference
TouchScreenEnable
Bool
Sets/Queries the state of the touch-screen enable control. This is equivalent to the front-panel Touch Screen button.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Disable touch-screen if it is enabled. if app.TouchScreenEnable = True then app.TouchScreenEnable = False End if
Example
WaitUntilIdle([in] double timeoutSeconds)
Method
Waits until either the application is idle or the specified timeout expires, specified in seconds. This evaluates to True if the application completes before the timeout expires, and to False if a timeout occurs. When Trigger mode is Auto or Run, the application is never Idle. In this case the call to WaitUntilIdle returns after the next acquisition and any configured processing.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Wait with a timeout of five seconds. app.WaitUntilIdle(5)
Example
Width
Property
Sets/Queries the width in pixels of the instrument display on the PC screen.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the width of the instrument window to 800 pixels. app.Width = 800
Example
Windowed
Action
Places the instrument application in windowed mode (as opposed to full-screen mode). Places the application in the upper-part of the display screen with a sizable border.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument display into the windowed mode. app.Windowed
Example
1-6
918501 RevA
Automation Command and Query Reference Manual - Control Reference
WindowState
Property
Sets/Queries the state of the PC window used by the instrument display. 0 windowed 1 full screen 2 minimized Trying to set values greater than 2 or less than 0 will result in the value 0 (windowed) being set.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the instrument window state to windowed. app.WindowState = 0
Example
ACQUISITION
app.Acquisition
This group of variables controls the input channels C1, C2, C3 and C4, the timebase, the trigger, and the Aux Output. Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in this section of
the manual. Examples of alias pairs are as follows - app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx app.Acquisition.Channels(1) is equivalent to app.Acquisition.C1 app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
Acquire([in] double timeoutSeconds, [in] long bForceTriggerOnTimeout)
Method
Action/Query. Takes a single acquisition. The first of the two arguments specifies a timeout; the second, which is optional, specifies whether or not to force a trigger when the timeout occurs. Evaluates to True if a trigger occurred, or False if a timeout occurred.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO") ' Start an acquisition, wait for up to 5 seconds for a trigger ' event, force a software trigger if a hardware trigger is not ' detected before the 5 second timeout expires. triggerDetected = app.Acquisition.Acquire(5, true)
Example
Acquire([in] double timeoutSeconds, [in] long bForceTriggerOnTimeout)
Method
Calibrate
Action
CalNeeded
Integer
ClearSweeps
Action
ShowChannelSetup
Action
TriggerMode
Enum
1-7
918501 RevA
Automation Command and Query Reference Manual - Control Reference
Calibrate
Action
Initiates a full calibration of the acquisition system of the instrument.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Start a calibration. app.Acquisition.Calibrate
Example
CalNeeded
Integer
From -2147483648 to 2147483647 step 1
Range
Query: Indicates whether calibration is required or not. Based on hexadecimal bit value, it provides following information:
0x00000001: Front end calibration is required 0x00000002: Digitizers delay matching is required 0x00000004: Digitizers gain matching is required 0x00000008: Trigger level calibration is required 0xFFFFFFFF(-1): All of above calibrations are required
Description
ClearSweeps
Action
Resets any accumulated average data or persistence data for channel waveforms (C1..C4). Valid only when one or more channels have waveform averaging or persistence enabled in their pre-processing settings. Note that an average may be reset on an individual basis using app.Acquisition.Cx.ClearSweeps control.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Clear accumulated sweeps for channels C1...C4 app.Acquisition.ClearSweeps
' Clear accumulated sweeps for only C1 app.Acquisition.C1.ClearSweeps
Example
ShowChannelSetup
Action
1-8
918501 RevA
Automation Command and Query Reference Manual - Control Reference
TriggerMode
Enum
Sets/Queries the trigger mode, using values from the following list ­Auto, Norm, Normal, Single, Stopped.
Auto: After a timeout, if a real hardware trigger is not received, then force a trigger so there are automatically lots of updates.
Normal: Accepts triggers as rapidly as the system permits, but likewise will wait "forever" for a trigger, without updating anything.
Single: Arm the acquisition system to acquire once, and do not rearm automatically after. Once a trigger is received and the data processed, the instrument finishes in the "Stopped" state.
Stop: Finishes the current acquisition and does not re-arm.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Place the instrument in stopped mode and take one acquisition. app.Acquisition.TriggerMode = "Stopped" app.Acquisition.Acquire(5)
Example
Values
Auto
Auto-trigger
Normal
Normal Trigger
Single
Single Trigger
Stopped
No trigger possible, Stopped
AUXIN
app.Acquisition.AuxIn
Auxiliary trigger input properties.
Attenuation
Enum
Attenuation factor for the auxiliary input connector.
Description
Values
Div10
x1
Attenuation
Enum
Coupling
Enum
ProbeAttenuation
Double
ProbeName
String
1-9
918501 RevA
Automation Command and Query Reference Manual - Control Reference
Coupling
Enum
Auxiliary trigger input connector coupling.
Description
Values
DC1M
DC50
Gnd
ProbeAttenuation
Double
From 1e-006 to 10000 step 1e-006
Range
Probe attenuation for the probe on the Auxiliary Input connector.
Description
ProbeName
String
Any number of characters
Range
Name of the probe on the Auxiliary Input connector.
Description
AUXOUTPUT
app.Acquisition.AuxOutput
Controls for the Auxilliary output BNC, which can be programmed as a simple square-wave signal source, or as a pulse which is asserted when various events occur, including Trigger Enabled, Trigger Out, and Pass/Fail.
' Microsoft Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Setup the Auxiliary output to be a squarewave with an amplitude ' of 500mV a frequency of 5kHz app.Acquisition.AuxOutput.Mode = "Square" app.Acquisition.AuxOutput.Amplitu
Example
Amplitude
Double
From 0.005 to 1 step 0.001
Range
Sets/Queries the amplitude of the signal on the AUX OUT connector. Note that this is the amplitude of the signal into a 1Mohm load. Into 50 ohms the output voltage will be halved (since the source impedance is nominally 50 ohms). Units are Volts.
Description
Amplitude
Double
AuxInCoupling
Enum
AuxMode
Enum
CalMode
Enum
Frequency
DoubleLockstep
Mode
Enum
SetToDefault
Action
1-10
918501 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the amplitude of the signal from the AUX OUT connector ' to 0.6 V into 1 megohm, or 0.3 V into 50 ohms. app.Acquisition.AuxOutput.Amplitude = 0.6
Example
AuxInCoupling
Enum
Sets the input coupling for the Auxiliary input path.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the coupling of the Auxiliary socket, when used as an input, to ground. ' In this condition, no input signal reaches the instrument. app.Acquisition.AuxOutput.AuxInCoupling = "GND"
Example
Values
DC50
DC, 50ohms coupling
GND
Grounded
AuxMode
Enum
Configures AUX Output type in WR and WS series of scopes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the Auxiliary output to trigger output signal. app.Acquisition.AuxOutput.AuxMode = "TriggerOut"
Example
Values
DCLevel
Off
No output
PassFail
Pulse on Pass fail condition
Square
TriggerEnabled
Trigger enabled signal from trigger circuitry.
TriggerOut
Internal trigger output signal from trigger circuitry
1-11
918501 RevA
Automation Command and Query Reference Manual - Control Reference
CalMode
Enum
Configures Cal Output type in WR and WS series of scopes.
Description
' Follwoing example will set CAL output to 1 KHz, 0.5V square wave. ' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set cal output to Square wave app.Acquisition.AuxOutput.CalMode = "Square"
' Set cal output amplitude to 0.5 V with 1 MOhm impedence app.Acquisition.AuxOutput.Amplitude = "0.5"
' Set cal output frequency to 1 KHz app.Acquisition.AuxOutput.Frequency = "1000"
Example
Values
DCLevel
DC Level with 1 Mohm o/p impedence
Off
Off
Square
Square wave
Frequency
DoubleLockstep
From 500 to 5e+006 step 10, locked to 1 2.5 5, fine grain allowed=false, on=false
Range
This control only has effect when the AuxOutput mode is "Square". Sets/Queries the auxiliary output frequency of the squarewave. Units are Hertz.
Note that WaveMaster models (and derivatives) have a limit of 5MHz, WavePro 7000 models (and derivatives) have a limit of 1MHz.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the frequency of the signal from the AUX OUT ' connector to 1 MHz. app.Acquisition.AuxOutput.Frequency = 1e6
Example
1-12
918501 RevA
Automation Command and Query Reference Manual - Control Reference
Mode
Enum
Sets/Queries the output mode of the AUX OUT connector. (Applicable to WM, SDA, DDA, WP series of scopes)
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the output of the AUX OUT connector to output ' a pulse on a pre-determined Pass-Fail decision. app.Acquisition.AuxOutput.Mode = "PassFail"
Example
Values
DCLevel
Emit a DC level
Off
Output Disabled
PassFail
Pulse-out controlled by Pass/Fail system
Square
Square-wave signal generator
TriggerEnabled
Pulse-out when trigger is enabled
TriggerOut
Pulse-out when trigger occurs
SetToDefault
Action
Set the Aux Output controls to their default values.
Description
CHANNELS
app.Acquisition.Channels
This group of variables controls the acquisition channels C1, C2, C3 and C4. Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Acquisition. Examples of alias pairs are as follows ­ app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx app.Acquisition.Channels(1) is equivalent to app.Acquisition.C1 app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
Set app = CreateObject("LeCroy.XStreamDSO")
For X = 1 To 4 app.Acquisition.Channels(X).VerScale = 0.2 Next
Example
CX
app.Acquisition.Cx
This group of variables controls the input channels C1, C2, C3 and C4. Names of the form app.Acquisition.Channels.xxxx are aliases of simpler names which are described in the section of
the manual which is devoted to app.Acquisition. Examples of alias pairs are as follows ­ app.Acquisition.Channels("Cx") is equivalent to app.Acquisition.Cx app.Acquisition.Channels("Cx").Out.Result is equivalent to app.Acquisition.Cx.Out.Result
ActiveInput
Enum
1-13
918501 RevA
Automation Command and Query Reference Manual - Control Reference
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Setup Channel C1 app.Acquisition.C1.VerScale = 0.5 app.Acquisition.C1.VerOffset = 0.0 app.Acquisition.C1.Coupling = "DC50"
' Setup Channel C2 app.Acquisition.C2.VerScale = 0.1
Example
ActiveInput
Enum
Control the input switch, used on Input A/B scopes to select the active input.
Description
Values
InputA
AverageSweeps
Integer
AxisXRotation
Integer
AxisYRotation
Integer
BandwidthLimit
Enum
ClearSweeps
Action
Coupling
Enum
Deskew
Double
EnhanceResType
Enum
FindScale
Action
InterpolateType
Enum
Invert
Bool
LabelsPosition
String
LabelsText
String
Overload
Bool
OverloadInputA
Bool
Persist3DQuality
Enum
PersistDotJoined
Bool
Persisted
Bool
Persistence3d
Bool
PersistenceMonoChrome
Bool
PersistenceSaturation
Integer
PersistenceTime
Enum
ProbeAttenuation
Double
ShowLastTrace
Bool
UseGrid
String
VerOffset
Double
VerScale
DoubleLockstep
VerScaleVariable
Bool
View
Bool
ViewLabels
Bool
1-14
918501 RevA
Automation Command and Query Reference Manual - Control Reference
InputB
AverageSweeps
Integer
From 1 to 1000000 step 1
Range
Sets/Queries the number of averaging sweeps for input channel Cx. This is distinct from the math function app.Math.Fx. If the number of sweeps is 1 (the default value), the data will not be averaged.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the number of sweeps for channel C1 to 25. app.Acquisition.C1.AverageSweeps = 25
Example
AxisXRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the state of the X Axis rotation control, used only in 3-D persistence modes to control the viewing position. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the X-axis to 35 degrees for trace C3. app.Acquisition.C3.AxisXRotation = 35
Example
AxisYRotation
Integer
From -90 to 90 step 1
Range
Sets/Queries the state of the Y Axis rotation control, used only in 3-D persistence modes to control the viewing position. See the general description above for a discussion of the locked and unlocked persistence modes.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the rotation about the Y-axis to 25 degrees for trace C3. app.Acquisition.C3.AxisYRotation = 25
Example
1-15
918501 RevA
Automation Command and Query Reference Manual - Control Reference
BandwidthLimit
Enum
Sets/Queries the bandwidth limit for input channel Cx, in Hz. Note that this control is an enum, and therefore requires a string value, and not a scalar value. Note that bandwidth limit choices vary between DSO models.
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Set the bandwidth limit for C2 to 20 MHz. app.Acquisition.C2.BandwidthLimit = "20MHz"
Example
Values
13GHz
1GHz
200MHz
20MHz
3GHz
4GHz
6GHz
8GHz
Full
ClearSweeps
Action
Clears all accumulated average data and persistence data for this channel. See app.Acquisition.ClearSweeps for a control that clears accumulated data for channels 1..4, or app.ClearSweeps for a control that clears accumulated data for all subsystems (including Math/Measure/Display, etc.)
Description
' Visual Basic Script Set app = CreateObject("LeCroy.XStreamDSO")
' Reset channel C1 app.Acquisition.C1.ClearSweeps
' Reset channels C1..C4 app.Acquisition.ClearSweeps
Example
1-16
918501 RevA
Loading...
+ 637 hidden pages