LabVIEW Programmers Reference

Agilent U2701A/U2702A USB Modular Oscilloscopes
IVI-COM Programmers Reference for NI LabVIEW
Agilent Technologies
Notices
Agilent Technologies, Inc., 2009 No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Agilent Technologies, Inc. as governed by United States and international copyright laws.
Warranty
The material contained in this document is provided as is, and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by applicable law, Agilent disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Agilent shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Agilent and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control.
Safety Notices
CAUTION
A CAUTION notice denotes a hazard. It calls attention to an operating procedure, practice, or the like that, if not correctly performed or adhered to, could result in damage to the product or loss of important data. Do not proceed beyond a CAUTION notice until the indicated conditions are fully understood and met.
Manual Part Number

U2702-90040
Edition
First Edition, June 22, 2009 Agilent Technologies, Inc. 5301 Stevens Creek Blvd. Santa Clara, CA 95052 USA
WA R N I N G
A WARNING notice denotes a hazard. It calls attention to an operating procedure, practice, or the like that, if not correctly performed or adhered to, could result in personal injury or death. Do not proceed beyond a WARNING notice until the indicated conditions are fully understood and met.
Technology Licenses
The hardware and or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license.
Restricted Rights Legend

U.S. Government Restricted Rights. Software and technical data rights granted to the federal government include only those rights customarily provided to end user customers. Agilent provides this customary commercial license in Software and technical data pursuant to FAR 12.211 (Technical Data) and 12.212 (Computer Software) and, for the Department of Defense, DFARS 252.227-7015 (Technical Data - Commercial Items) and DFARS 227.7202-3 (Rights in Commercial Computer Software or Computer Software Documentation).
II
U2701A/U2702A IVI-COM Programmers Reference
Contents
1 Introduction to IVI-COM
Getting Started Installation Guide 2 3 5
General Guidelines for Oscilloscope Programming
Side-by-Side SCPI and IVI-COM Comparison of the U2701A/U2702A Commands 6
Configuration
Count 12
Item 14 BandwidthLimit 14 Configure 16 Coupling 19 Enabled 21 Offset 23 ProbeAttenuation 25 Range 27 Name Close Initialize Initialized Configure Coupling 30 32 34 37 39 41
Edge 43 Configure 43 Slope 46
III
Glitch 48 Condition 48 Configure 50 Polarity 52 Width 54 Holdoff Modifier Level Source Status TV 60 61 63 56 58
66 Configure 66 Event 69 LineNumber 71 SignalFormat 72 Type 75
Width 77 Condition 77 Configure 79 Polarity 82 ThresholdHigh 84 ThresholdLow 85 Clear 88 90
ConfigureServiceRequest Preset Register SerialPoll 92 94 96 98
TimeoutMilliseconds
IV
WaitForOperationComplete Disable ErrorQuery LockObject Reset 108 110 102 104 106
100
ResetWithDefaults SelfTest 112 114
UnlockObject
Enumeration Members 116 AgilentU2701AGlitchConditionEnum 116 AgilentU2701AGlitchPolarityEnum 117 AgilentU2701ASRQReasonEnum 117 AgilentU2701AStatusRegisterEnum 119 AgilentU2701AStatusSubRegisterEnum 120 AgilentU2701ATriggerCouplingEnum 121 AgilentU2701ATriggerModifierEnum 121 AgilentU2701ATriggerSlopeEnum 122 AgilentU2701ATriggerTypeEnum 123 AgilentU2701ATVSignalFormatEnum 124 AgilentU2701ATVTriggerEventEnum 125 AgilentU2701AVerticalCouplingEnum 126 AgilentU2701AWidthConditionEnum 127 AgilentU2701AWidthPolarityEnum 127
Acquisition
ConfigureRecord Interpolation 132 134 130
NumberOfAverages RecordLength 135
SampleMode SampleRate StartTime
137 140
142 144
TimePerRecord Type 147
Enumeration Members 149 AgilentU2701AAcquisitionStatusEnum 149 AgilentU2701AAcquisitionTypeEnum 150 AgilentU2701AInterpolationEnum 151 AgilentU2701ASampleModeEnum 151
Waveform Display
Abort 154 156
AutoSetup Count Initiate 158 160
IsWaveformElementInvalid Item 164 FetchWaveform ReadWaveform 164 167
162
Post Analysis
Abort 172 174
AutoSetup Count Initiate 176 178
IsWaveformElementInvalid
180
VI
Item 182 FetchWaveform 182 FetchWaveformMeasurement ReadWaveform 187 ReadWaveformMeasurement MathFunction Name Status 195 196 193
185 190
Enumeration Members 199 AgilentU2701AMathOperationEnum 199 AgilentU2701AMeasurementEnum 200 AgilentU2701ATimeOutEnum 203
Others
Calibrate Date Label Time Cache 208 210 212 214 216 206
ClearInterchangeWarnings DriverSetup 218
GetNextCoercionRecord
220 221
GetNextInterchangeWarning InterchangeCheck 223 225 227
InvalidateAllAttributes IoResourceDescriptor LogicalName 229
VII
QueryInstrumentStatus RangeCheck 233 235
231
RecordCoercions
ResetInterchangeCheck Simulate Description 239 241 243
237
GroupCapabilities Identifier 245
InstrumentFirmwareRevision InstrumentManufacturer InstrumentModel Revision 253 251 249
247
SpecificationMajorVersion SpecificationMinorVersion SupportedInstrumentModels Vendor 261 263
255 257 259
SerialNumber
Application Example
Introduction 266 Creating Connectivity to the IVI-COM Driver Using the Driver 268 Complete Example 276 266
VIII
U2701A/U2702A USB Modular Oscilloscope IVI-COM Programmers Reference for NI LabVIEW
1 Introduction to IVI-COM
Getting Started 2 Installation Guide 3 General Guidelines for Oscilloscope Programming 5 Side-by-Side SCPI and IVI-COM Comparison of the U2701A/U2702A Commands 6
This chapter introduces the remote programming basics of the U2701A/U2702A USB modular oscilloscopes. The IVI- COM programming commands provide the means to control this instrument remotely via a PC.
Introduction to IVI-COM
Getting Started
The IVI Foundation is an open consortium founded in year 1998 to promote specifications for programming test instruments. For complete information on the IVI Foundation and for the most up- to- date versions of all IVI specifications and components, you can visit the IVI Foundation web site at www.ivifoundation.org.
Installation Guide
1 To download the AgilentU2701A IVI Driver, go to the Agilent Technical Support web site at: http://www.home.agilent.com/agilent/techSupport.jspx?pid=1369621&cc= US&lc=eng&t=80029.k.0&guid=181735 2 Click Drivers & Software > IVI-COM and IVI-C for U2701A/U2702A to download the AgilentU2701A IVI Driver package. 3 Save the file to any location on your hard disk. 4 Disconnect any instrument that is connected to your PC and close all other applications on your PC. 5 Double- click the saved installation file to begin installation. 6 The latest version of the IVI Shared Components should be downloaded from www.ivifoundation.org prior to installing the AgilentU2701A IVI Driver package. It is recommended that you periodically check for newer versions of the IVI Shared Components and update as available from the IVI Foundation. 7 If the latest version of the IVI Shared Components is detected, installation of the AgilentU2701A IVI Driver will proceed as normal.
8 The AgilentU2701A IVI Driver 1.0.0.0 Setup Wizard dialog will appear. Click Next to begin. 9 Read the License Agreement and select I accept the terms in the License Agreement to proceed. You may click Print to print a hardcopy of the Agilent License Terms for your reference. Click Next to proceed. 10 Fill in the Customer Information Form accordingly, and click Next. 11 Select the Typical or Full option in the Setup Type to install the AgilentU2701A IVI Driver package. Advanced users may select the Custom option to customize the program features to be installed and where they will be installed. Click Next to proceed. 12 Click Next to install to the specified folder or click Change to install to a different folder. 13 Click Install to begin the installation of the AgilentU2701A IVI Driver package. 14 Click Finish when the installation has completed.
General Guidelines for Oscilloscope Programming

The block diagram below illustrates the general flow of steps required to program an oscilloscope. The necessary IVI- COM driver commands are arranged to reflect this block diagram.
START
Configuration
You can use the commands in this section to configure the oscilloscope channels for waveform acquisition, set the type of event that triggers the oscilloscope, modify the registry status, and perform various utility operations. You can use the commands in this section to configure the acquisition type, the size of the waveform record, the length of time that corresponds to overall waveform record, and the position of the first point in the waveform record relative to the trigger event. The statements in this section is used to acquire waveform data from the oscilloscope. You can use the commands in this section to initiate, acquire, and abort measurements.
Acquisition
Waveform Display
Post Analysis
The statements in this section is used to analyze the waveform data acquired from the oscilloscope. You can also use the commands in this section to initiate, acquire, and abort measurements.
END
Side-by-Side SCPI and IVI-COM Comparison of the U2701A/U2702A Commands

Table 1-1 SCPI, IAgilentU2701A IVI, and IIviScope command comparison
SCPI command IAgilentU2701A IVI command IIviScope command
IEEE 488.2 Common commands *CLS *IDN *OPC? *RST Root level commands AUTO ACQuire commands AVERages MODE SRATe? TYPE IAgilentU2701AAcquisition.NumberOf Averages IAgilentU2701AAcquisition.SampleMode IAgilentU2701AAcquisition.SampleRate IAgilentU2701AAcquisition.Type IIviScopeAcquisition.NumberOfAverages IIviScopeAcquisition.SampleMode IIviScopeAcquisition.SampleRate IIviScopeAcquisition.Type IAgilentU2701AMeasurements.AutoSetup IIviScopeMeasurements.AutoSetup IAgilentU2701AStatus.Clear IIviDriver.Identity IAgilentU2701ASystem.WaitForOperation Complete() IIviDriverUtility.Reset() IIviDriver.Identity IIviDriverUtility.Reset()
CHANnel<n> commands BWLimit COUPling DISPlay INVert OFFSet PROBe SCALe IAgilentU2701AChannel.BandwidthLimit IAgilentU2701AChannel.Coupling IAgilentU2701AChannel.Enabled IAgilentU2701AChannel.Offset IAgilentU2701AChannel.ProbeAttenuation IAgilentU2701AChannel.Range IIviScopeChannel.Coupling IIviScopeChannel.Enabled IIviScopeChannel.Offset IIviScopeChannel.ProbeAttenuation IIviScopeChannel.Range
Table 1-1 SCPI, IAgilentU2701A IVI, and IIviScope command comparison (continued)
SCPI command KEY commands AUTO_SCALE CH1 CH1_POS_DEC CH1_POS_INC CH1_SCALE_DEC CH1_SCALE_INC CH2 CH2_POS_DEC CH2_POS_INC CH2_SCALE_DEC CH2_SCALE_INC MAIN_DELAYED MATH MEASURE MODE_COUPLING SINGLE TIME_POS_DEC TIME_POS_INC TIME_SCALE_DEC TIME_SCALE_INC TRIG_LVL_DEC TRIG_LVL_INC IAgilentU2701AMeasurements.AutoSetup IAgilentU2701AChannel.Enabled IAgilentU2701AChannel.Offset IAgilentU2701AChannel.Offset IAgilentU2701AChannel.Range IAgilentU2701AChannel.Range IAgilentU2701AChannel.Enabled IAgilentU2701AChannel.Offset IAgilentU2701AChannel.Offset IAgilentU2701AChannel.Range IAgilentU2701AChannel.Range IAgilentU2701AAcquisition.StartTime IAgilentU2701AMeasurementsMathFunction IAgilentU2701AMeasurement IAgilentU2701AChannel.Coupling IAgilentU2701AMeasurements.Initiate IAgilentU2701AAcquisition.StartTime IAgilentU2701AAcquisition.StartTime IAgilentU2701AAcquisition.TimePerRecord IAgilentU2701AAcquisition.TimePerRecord IAgilentU2701ATrigger.Level Property IAgilentU2701ATrigger.Level Property IIviScopeMeasurements.AutoSetup IIviScopeChannel.Enabled IIviScopeChannel.Offset IIviScopeChannel.Offset IIviScopeChannel.Range IIviScopeChannel.Range IIviScopeChannel.Enabled IIviScopeChannel.Offset IIviScopeChannel.Offset IIviScopeChannel.Range IIviScopeChannel.Range IIviScopeAcquisition.StartTime IIviScope.Measurement IIviScopeChannel.Coupling IIviScopeMeasurements.Initiate IIviScopeAcquisition.StartTime IIviScopeAcquisition.StartTime IIviScopeAcquisition.TimePerRecord IIviScopeAcquisition.TimePerRecord IIviScopeTrigger.Level IIviScopeTrigger.Level IAgilentU2701A IVI command IIviScope command
SCPI command MEASure commands FALLtime FREQuency NDUTycycle NWIDth OVERshoot PDUTycycle PERiod PREShoot PWIDth RISetime VAMPlitude VAVerage VBASe VMAX VMIN AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IAgilentU2701A IVI command IIviScope command
SCPI command MEASure commands VPP VRMS VTOP TIMebase commands DELayed HOLDoff POSition SCALe TRIGger commands [EDGE]:COUPling [EDGE]:LEVel [EDGE]:SLOPe [EDGE]:SOURe [EDGE]:SWEep MODE PULSe:MODE PULSEe:WIDTh STATus IAgilentU2701ATrigger.Coupling Property IAgilentU2701ATrigger.Level Property IAgilentU2701ATriggerEdge.Slope Property IAgilentU2701ATrigger.Source Property IAgilentU2701ATrigger.Modifier Property IAgilentU2701ATrigger.Type Property AgilentU2701ATriggerTypeEnum Enumeration AgilentU2701ATriggerTypeEnum Enumeration IAgilentU2701ATrigger.Status IIviScopeChannel.Coupling IIviScopeTrigger.Level IIviScopeTriggerEdge.Slope IIviScopeTrigger.Source IIviScopeTrigger.Modifier IIviScopeTrigger.Type IIviScopeTriggerTypeEnum Enumeration IIviScopeTriggerTypeEnum Enumeration IAgilentU2701AAcquisition.StartTime IAgilentU2701ATrigger.Holdoff IAgilentU2701AAcquisition.StartTime IAgilentU2701AAcquisition.TimePerRecord IIviScopeAcquisition.StartTime IIviScopeTrigger.Holdoff IIviScopeAcquisition.StartTime IIviScopeAcquisition.TimePerRecord AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration AgilentU2701AMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IviScopeMeasurementEnum Enumeration IAgilentU2701A IVI command IIviScope command
WAVeform commands DATA? XINCrement? XORigin? IAgilentU2701AMeasurement.ReadWaveform IAgilentU2701AMeasurement.ReadWaveform IAgilentU2701AMeasurement.ReadWaveform IIviScopeMeasurement.ReadWaveform IIviScopeMeasurement.ReadWaveform IIviScopeMeasurement.ReadWaveform
10
2 Configuration
Channels Interface commands starting on page 12 Close 32 Initialize 34 Initialized 37 Trigger Interface commands starting on page 41 Status Interface commands starting on page 88 System Interface commands starting on page 98 Utility Interface commands starting on page 102 Enumeration Members 116
This chapter describes the configuration commands used to program the U2701A/U2702A USB modular oscilloscopes over the remote interface. You can use the commands in this chapter to configure the oscilloscope channels for waveform acquisition, set the type of event that triggers the oscilloscope, modify the registry status, and perform various utility operations.
11
Configuration
Count
Type
Property
Function
Get
Description
This command returns the number of channels available.
Hierarchy
IAgilentU2701A ; Channels ; Count
Parameters
Long/Int32
Example
12
Configuration
13
Configuration
Item
This is an interface reference pointer to the IAgilentU2701AChannel interface which is selected by the channel name.
BandwidthLimit
Type
Property
Function
Get and Set
Description
This command returns/sets the bandwidth limit status for the selected channel. If True, the bandwidth limit for the selected channel is enabled. If False, the bandwidth limit for the selected channel is disabled.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; BandwidthLimit
Parameters
Item Name Type String Description The name of a channel. It may be either a name returned by the Name property or a name mapped to a particular repeated capability in the session in the configuration store.
14
Configuration
Return Format
Boolean
Example
15
Configuration
Configure
Type
Method
Function
Set
Description
This command configures the most commonly used properties of the oscilloscope channel sub- system. Use this command to enable or disable the channel and to set the range, offset, coupling, and probe attenuation values.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; Configure(Range, Offset, Coupling, ProbeAttenuation, Enabled)
16
Configuration
Parameters
Item Name Type String Description The name of a channel. It may be either a name returned by the Name property or a name mapped to a particular repeated capability in the session in the configuration store. Specifies the vertical range. This value sets the Vertical Range property. Specifies the vertical offset. This value sets the Vertical Offset property. Specifies how to couple the input signal. This value sets the Vertical Coupling property. Specifies the probe attenuation. This value sets the ProbeAttenuation property. Specifies if the channel is enabled for acquisition. This value sets the Channels.Enabled property.
Range Offset Coupling
Double Double AgilentU2701A VerticalCoupling Enum Double Boolean
ProbeAttenuation Enabled
Return Format
Boolean
17
Configuration
Example
18
Configuration
Coupling
Type
Property
Function
Get and Set
Description
This command returns/sets how the oscilloscope couples the input signal.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; Coupling
Parameters
Return Format
Item AgilentU2701A VerticalCoupling Enum Type Enum Description See AgilentU2701AVerticalCouplingEnum on page 126.
19
Configuration
Example
20
Configuration
Enabled
Type
Property
Function
Get and Set
Description
If this command is set to True, the oscilloscope acquires a waveform for this channel when the IAgilentU2701AMeasurement.Initiate, IAgilentU2701AMeasurement.ReadWaveform, IAgilentU2701AMeasurement.ReadWaveformMeasurement, or IIviScopeMeasurement.ReadWaveformMinMax methods are called.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; Enabled
Parameters
Return Format
Boolean
21
Configuration
Example
22
Configuration
Offset
Type
Property
Function
Get and Set
Description
This command returns/sets the location of the center of the range that was specified with the Range property. The units are expressed in volts, with respect to ground. For example, to acquire a sine wave spanning from 0.0 V to 10.0 V, set Offset to 5.0 V.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; Offset
Parameters
Return Format
Double
23
Configuration
Example
24
Configuration
ProbeAttenuation
Type
Property
Function
Get and Set
Description
This command returns/sets the scaling factor by which the probe attenuates the input signal. For example, with a 10:1 probe, the value is 10.0.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; ProbeAttenuation
Parameters
Return Format
Double
25
Configuration
Example
26
Configuration
Range
Type
Property
Function
Get and Set
Description
This command returns/sets the absolute value of the input range that the oscilloscope can acquire for the channel. The units are expressed in volts. For example, to acquire a sine wave spanning from 5.0 V to 5.0 V, set Range to 10.0 V.
Hierarchy
IAgilentU2701A ; Channels ; Item(Name) ; Range
Parameters
27
Configuration
Remarks
The absolute value of the input range that the oscilloscope can acquire is equivalent to the Volt/Div value multiplied by eight at the scope setting.
Volt/Div (Attenuation = 1x) 2 mV 5 mV 10 mV 20 mV 50 mV 100 mV 200 mV 500 mV 1V 2V 5V
Voltage range 16 mV 40 mV 80 mV 160 mV 400 mV 800 mV 1.6 V 4V 8V 16 V 40 V
Return Format
Double
28
Configuration
Example
29
Configuration
Name
Type
Property
Function
Get
Description
This command returns the channel name for a given index.
Hierarchy
IAgilentU2701A ; Channels ; Name(Index)
Parameters
Item Index Type Long/Int32 Description One based index into the collection of channels.
Return Format
String
30
Configuration
Example
31
Configuration
Close
Type
Method
Function
Set
Description
This command closes the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called.
Hierarchy
IAgilentU2701A ; Close()
Example
32
Configuration
33
Configuration
Initialize
Type
Method
Function
Set
Description
This command opens the I/O session to the instrument. Driver methods and properties that access the instrument are only accessible after Initialize is called. Initialize optionally performs a Reset and queries the instrument to validate the instrument model.
Hierarchy
IAgilentU2701A ; Initialize(ResourceName, IdQuery, Reset, OptionString)
34
Configuration
Parameters
Item ResourceName Type String/BSTR Description An IVI logical name or an instrument specific string that identifies the address of the instrument, such as a VISA resource descriptor string. Specifies whether to verify the ID of the instrument. Specifies whether to reset the instrument. The user can use the OptionString parameter to specify the initial values of certain IVI inherent attributes for the session. The format of an assignment in the OptionString parameter is Name=Value, where Name is one of: RangeCheck, QueryInstrumentStatus, Cache, Simulate, RecordCoercions, InterchangeCheck, or DriverSetup. Value is either True or False except for DriverSetup. If the OptionString parameter contains an assignment for the Driver Setup attribute, the Initialize function assumes that everything following DriverSetup= is part of the assignment.
IdQuery Reset OptionString
Boolean Boolean String/BSTR
Example
35
Configuration
36
Configuration
Initialized
Type
Property
Function
Get
Description
This command returns True between a successful call to the Initialize method and a successful call to the Close method, and False at all other times.
Hierarchy
IAgilentU2701A ; Initialized
Return Format
Boolean
Example
37
Configuration
38
Configuration
Configure
Type
Method
Function
Set
Description
This command configures the trigger Type and Holdoff. Holdoff units are expressed in seconds.
Hierarchy
IAgilentU2701A ; Trigger ; Configure(Type, Holdoff)
Parameters
Item Type Type AgilentU2701A TriggerTypeEnum Double Description Specifies the trigger type. This value sets the Trigger.Type property. See AgilentU2701ATriggerTypeEnum on page 123 for more information. Specifies the trigger hold-off. This value sets the Trigger. Holdoff property.
Holdoff
39
Configuration
Example
40
Configuration
Coupling
Type
Property
Function
Get and Set
Description
This command returns/sets how the oscilloscope couples the trigger source.
Hierarchy
IAgilentU2701A ; Trigger ; Coupling
Return Format
Item AgilentU2701A TriggerCoupling Enum Type Enum Description See AgilentU2701ATriggerCouplingEnum on page 121 for more information.
41
Configuration
Example
42
Configuration
Edge
This interface configures slope of edge trigger.
Configure
Type
Method
Function
Set
Description
This command configures the conditions for edge trigger. An edge trigger occurs when the trigger source signal passes through the trigger level with the specified slope.
Hierarchy
IAgilentU2701A ; Trigger ; Edge ; Configure(Source, Level, Slope)
43
Configuration
Parameters
Item Source Level Slope Type String Double Description Specifies the trigger source. This value sets the Trigger.Source property. Specifies the trigger level. This value sets the Trigger.Level property.
AgilentU2701A Specifies the trigger slope. This value sets the TriggerSlopeEnum Trigger.Slope property. See AgilentU2701ATriggerSlopeEnum on page 122 for more information.
Example
44
Configuration
45
Configuration
Slope
Type
Property
Function
Get and Set
Description
This command returns/sets the slope, a rising or a falling edge, that triggers the oscilloscope.
Hierarchy
IAgilentU2701A ; Trigger ; Edge ; Slope
Parameters
Item Type Description See AgilentU2701ATriggerSlopeEnum on page 122 for more information.
AgilentU2701A Enum TriggerSlopeEnum
46
Configuration
Example
47
Configuration
Glitch
This interface configures the condition, polarity, and width of the glitch trigger.
Condition
Type
Property
Function
Get and Set
Description
This command returns/sets the glitch condition that determines whether the oscilloscope triggers on a pulse with a width less than or greater than the glitch width value.
Hierarchy
IAgilentU2701A ; Trigger ; Glitch ; Condition
Parameters
Item AgilentU2701A GlitchCondition Enum Type Enum Description See AgilentU2701AGlitchConditionEnum on page 116 for more information.
48
Configuration
Example
49
Configuration
Configure
Type
Method
Function
Set
Description
This command configures the glitch trigger Source, Level, Width, Polarity, and Condition. A glitch trigger occurs when the edge of a pulse that matches the Width and Polarity crosses the specified Level (expressed in volts).
Hierarchy
IAgilentU2701A ; Trigger ; Glitch ; Configure(Source, Level, Width, Polarity, Condition)
Parameters
Item Source Level Width Polarity Type String Double Double AgilentU2701A GlitchPolarity Enum AgilentU2701A GlitchCondition Enum Description Specifies the trigger source. This value sets the Trigger.Source property. Specifies the trigger level. This value sets the Trigger.Level property. Specifies the glitch triggering glitch width in seconds. This value sets the Glitch.Width property. Specifies the glitch polarity. This value sets the Glitch. Polarity property. Specifies the glitch condition. This value sets the Glitch.Condition property.
Condition
50
Configuration
Example
51
Configuration
Polarity
Type
Property
Function
Get and Set
Description
This command returns/sets the polarity of the glitch that triggers the oscilloscope.
Hierarchy
IAgilentU2701A ; Trigger ; Glitch ; Polarity
Return Format
Item AgilentU2701A GlitchPolarity Enum Type Enum Description Specifies the glitch polarity. This value sets the Glitch.Polarity property.
52
Configuration
Example
53
Configuration
Width
Type
Property
Function
Get and Set
Description
This command returns/sets the glitch width. The units are expressed in seconds.
Hierarchy
IAgilentU2701A ; Trigger ; Glitch ; Width
Return Format
Double
54
Configuration
Example
55
Configuration
Holdoff
Type
Property
Function
Get and Set
Description
This command returns/sets the length of time the oscilloscope waits after it fills the acquisition buffer until the oscilloscope enables the trigger interface to detect another trigger. The units are expressed in seconds.
Hierarchy
IAgilentU2701A ; Trigger ; Holdoff
Return Format
Double
56
Configuration
Example
57
Configuration
Modifier
Type
Property
Function
Get and Set
Description
This command determines the oscilloscope behavior in the absence of a trigger.
Hierarchy
IAgilentU2701A ; Trigger ; Modifier
Return Format
Item AgilentU2701A TriggerModifier Enum Type Enum Description See AgilentU2701ATriggerModifierEnum on page 121 for more information.
58
Configuration
Example
59
Configuration
Level
Type
Property
Function
Get and Set
Description
This command returns/sets the voltage threshold for the trigger interface. The units are expressed in volts.
Hierarchy
IAgilentU2701A ; Trigger ; Level
Return Format
Double
60
Configuration
Example
Source
Type
Property
Function
Get and Set
61
Configuration
Description
This command returns/sets the signal that the oscilloscope monitors for a trigger. It can be a channel or one of many other values.
Hierarchy
IAgilentU2701A ; Trigger ; Source
Return Format
String/BSTR
62
Configuration
Example
Status
Type
Property
Function
Get
63
Configuration
Description
If this command is set to True, the waveform starts directly after the trigger condition is met. If this command is set to False, the instrument has to send a force trigger to get a waveform.
Hierarchy
IAgilentU2701A ; Trigger ; Status
Return Format
Boolean
Example
64
Configuration
65
Configuration
TV
This interface configures the signal format, number of lines, and events of the TV trigger.
Configure
Type
Method
Function
Set
Description
This command configures the TV trigger source, signal format, event, and polarity.
Hierarchy
IAgilentU2701A ; Trigger ; TV ; Configure(Source, SignalFormat, Event)
66
Configuration
Parameters
Item Source SignalFormat Type String AgilentU2701ATV SignalFormat Enum Description Specifies the trigger source. This value sets the Trigger.Source property. Specifies the TV trigger signal format. This value sets the TV.SignalFormat property. See AgilentU2701ATVSignalFormatEnum on page 124 for more information.
Event
AgilentU2701ATV Specifies the TV trigger event. This value sets the TriggerEventEnum TV.Event property. See AgilentU2701ATVTriggerEventEnum on page 125 for more information.
Example
67
Configuration
68
Configuration
Event
Type
Property
Function
Get and Set
Description
This command returns/sets the event on which the oscilloscope triggers.
Hierarchy
IAgilentU2701A ; Trigger ; TV ; Event
Return Format
Item Type Description See AgilentU2701ATVTriggerEventEnum on page 125 for more information.
AgilentU2701ATV Enum TriggerEventEnum
69
Configuration
Example
70
Configuration
LineNumber
Type
Property
Function
Get and Set
Description
This command returns/sets the line on which the oscilloscope triggers. The line number is absolute and not relative to the field of the TV signal.
Hierarchy
IAgilentU2701A ; Trigger ; TV ; LineNumber
Return Format
Long/Int32
71
Configuration
Example
SignalFormat
Type
Property
Function
Get and Set
72
Configuration
Description
This command returns/sets the format of the TV signal on which the oscilloscope triggers.
Hierarchy
IAgilentU2701A ; Trigger ; TV ; SignalFormat
Return Format
Item AgilentU2701ATV SignalFormat Enum Type Enum Description See AgilentU2701ATVSignalFormatEnum on page 124 for more information.
73
Configuration
Example
74
Configuration
Type
Type
Property
Function
Get and Set
Description
This command returns/sets the kind of event that triggers the oscilloscope.
Hierarchy
IAgilentU2701A ; Trigger ; TV ; Type
Return Format
Item AgilentU2701A TriggerTypeEnum Type Enum Description See AgilentU2701ATriggerTypeEnum on page 123 for more information.
75
Configuration
Example
76
Configuration
Width
This interface configures condition, polarity, and threshold level of width trigger.
Condition
Type
Property
Function
Get and Set
Description
This command returns/sets whether a pulse within or outside the high and low thresholds triggers the oscilloscope.
Hierarchy
IAgilentU2701A ; Trigger ; Width ; Condition
Return Format
Item AgilentU2701A WidthCondition Enum Type Enum Description See AgilentU2701AWidthConditionEnum on page 127 for more information.
77
Configuration
Example
78
Configuration
Configure
Type
Method
Function
Set
Description
This command configures the width trigger Source, Level, ThresholdLow, ThresholdHigh, Polarity, and Condition. A width trigger occurs when a pulse, which passes through Level, with a width between or outside, the width threshold is detected.
Hierarchy
IAgilentU2701A ; Trigger ; Width ; Configure(Source, Level, ThresholdLow, ThresholdHigh, Polarity, Condition)
Parameters
Item Source Level ThresholdLow ThresholdHigh Type String Double Double Double Description Specifies the trigger source. This value sets the Trigger.Source property. Specifies the trigger level. This value sets the Trigger.Level property. Sets the width triggering low threshold in seconds. This value sets the Width.ThresholdLow property. Sets the width triggering high threshold in seconds. This value sets the Width.ThresholdHigh property.
79
Configuration
Item Polarity
Type AgilentU2701A WidthPolarity Enum AgilentU2701A WidthCondition Enum
Description Specifies the width polarity. This value sets the Width.Polarity property. See AgilentU2701AWidthPolarityEnum on page 127 for more information. Specifies the width condition. This value sets the Width.Condition property. See AgilentU2701AWidthConditionEnum on page 127 for more information.
Condition
80
Configuration
Example
81
Configuration
Polarity
Type
Property
Function
Get and Set
Description
This command returns/sets the polarity of the pulse that triggers the oscilloscope.
Hierarchy
IAgilentU2701A ; Trigger ; Width ; Polarity
Return Format
Item AgilentU2701A WidthPolarity Enum Type Enum Description See AgilentU2701AWidthPolarityEnum on page 127 for more information.
82
Configuration
Example
83
Configuration
ThresholdHigh
Type
Property
Function
Get and Set
Description
This command returns/sets the high width threshold time, expressed in seconds.
Hierarchy
IAgilentU2701A ; Trigger ; Width ; ThresholdHigh
Return Format
Double
84
Configuration
Example
ThresholdLow
Type
Property
Function
Get and Set
85
Configuration
Description
This command returns/sets the low width threshold time, expressed in seconds.
Hierarchy
IAgilentU2701A ; Trigger ; Width ; ThresholdLow
Return Format
Double
Example
86
Configuration
87
Configuration
Clear
Type
Method
Function
Set
Description
This command clears all event registers and error queues. The enable registers are unaffected.
Hierarchy
IAgilentU2701A ; Status ; Clear()
Example
88
Configuration
89
Configuration
ConfigureServiceRequest
Type
Method
Function
Set
Description
This command clears all the enable registers. It then sets the appropriate transition filters and enable registers so when the specified event(s) occur(s) the instrument requests service. All other events are disabled from generating a service request. To detect a service request the client application must poll the status byte using the SerialPoll method or Register property and test the request service bit.
Hierarchy
IAgilentU2701A ; Status ; ConfigureServiceRequest(Reason)
Parameters
Item Reason Type AgilentU2701A SRQReasonEnum Description The defined values are expressed in the powers of two: 1, 2, 4, and so on. You can OR several reasons together so multiple events can generate a service request. See AgilentU2701ASRQReasonEnum on page 117 for more information.
90
Configuration
Example
91
Configuration
Preset
Type
Method
Function
Set
Description
This command sets the SCPI defined enable registers and transition filters.
Hierarchy
IAgilentU2701A ; Status ; Preset()
Example
92
Configuration
93
Configuration
Register
Type
Property
Function
Get and Set
Description
This command returns/sets the instrument status registers.
Hierarchy
IAgilentU2701A ; Status ; Register(Register, SubRegister, val)
Parameters
Item Register
Type AgilentU2701A StatusRegister Enum
Description The status register to access. See AgilentU2701AStatusRegisterEnum on page 119 for available registers.
SubRegister
AgilentU2701A The status sub register to access. See StatusSubRegister AgilentU2701AStatusSubRegisterEnum on page 120 for Enum available sub registers. Long/Int32 Instrument Status Register value
val
94
Configuration
Return Format
Item val Type Long/Int32 Description Instrument Status Register value
Example
95
Configuration
SerialPoll
Type
Property
Function
Get
Description
This command returns the serial poll of the instrument status byte.
Hierarchy
IAgilentU2701A ; Status ; SerialPoll
Return Format
Long/Int32
Example
96
Configuration
97
Configuration
TimeoutMilliseconds
Type
Property
Function
Set
Description
This command sets the value, in milliseconds, of the default timeout used by I/O operations. This property provides access to the driver Visa Session Timeout. Only in rare, unusual circumstances should you set this property. Driver methods and properties with operations which take a significant time to perform are responsible for adjusting the I/O timeout to an appropriate value. Some methods provide a MaxTimeMilliseconds parameter which gives you direct control over the timeout value for that method. Sometimes, however, increasing the timeout value can work around an obscure driver defect.
Hierarchy
IAgilentU2701A ; System ; TimeoutMilliseconds
Return Format
Long/Int32
98
Configuration
Example
99
Configuration
WaitForOperationComplete
Type
Method
Function
Set
Description
This command sets the instrument not to return until previously started operations are completed or the MaxTimeMilliseconds time have expired.
Hierarchy
IAgilentU2701A ; System ; WaitForOperationComplete (MaxTimeMilliseconds)
Return Format
String/BTSR
Example
100
Configuration
101
Configuration
Disable
Type
Method
Function
Set
Description
This command quickly places the instrument in a state where it has no, or minimal, effect on the external system to which it is connected. This state is not necessarily a known state.
Hierarchy
IAgilentU2701A ; Utility ; Disable()
Example
102
Configuration
103
Configuration
ErrorQuery
Type
Method
Function
Get
Description
This commad queries the instrument and returns the instrument specific error information. This function can be used when QueryInstrumentStatus is True to retrieve error details when the driver detects an instrument error.
Hierarchy
IAgilentU2701A ; Utility ; ErrorQuery(ErrorCode, ErrorMessage)
Return Format
Item ErrorCode ErrorMessage Type Long/Int32 String/BSTR Description Instrument error code. Instrument error message.
104
Configuration
Example
105
Configuration
LockObject
Type
Method
Function
Set
Description
Obtains a multithread lock on the driver after waiting until all other execution threads have released their locks on the instrument session.
Hierarchy
IAgilentU2701A ; Utility ; LockObject()
Example
106
Configuration
107
Configuration
Reset
Type
Method
Function
Set
Description
This command places the instrument in a known state and configures instrument options on which the IVI specific driver depends (for example, enabling/disabling headers). For an IEEE- 488.2 instrument, Reset sends the command string *RST to the instrument.
Hierarchy
IAgilentU2701A ; Utility ; Reset()
Example
108
Configuration
109
Configuration
ResetWithDefaults
Type
Method
Function
Set
Description
This command does the equivalent of Reset and then, disables class extension capability groups, sets attributes to initial values defined by class specs, and configures the driver to option string settings used when Initialize was last executed.
Hierarchy
IAgilentU2701A ; Utility ; ResetWithDefaults()
Example
110
Configuration
111
Configuration
SelfTest
Type
Method
Function
Get
Description
This command performs an instrument selftest, waits for the instrument to complete the test, and queries the instrument for the results. If the instrument passes the test, TestResult is 0 and TestMessage is Self test passed.
Hierarchy
IAgilentU2701A ; Utility ; SelfTest(TestResult, TestMessage)
Return Format
Item TestResult TestMessage Type Long/Int32 String/BSTR Description Numeric result from the self-test operation. 0 = no error (test passed). Self-test status message.
112
Configuration
Example
113
Configuration
UnlockObject
Type
Method
Function
Set
Description
This command releases a previously obtained multithread lock.
Hierarchy
IAgilentU2701A ; Utility ; UnlockObject()
Example
114
Configuration
115
Configuration
Enumeration Members
This section describes the members of each enumeration used in this specific IVI- COM driver.
AgilentU2701AGlitchConditionEnum
Description
IVI scope class- compliant values for glitch trigger condition.
Members
Member name AgilentU2701A GlitchCondition LessThan AgilentU2701A GlitchCondition GreaterThan Value 1 Description The oscilloscope triggers when the pulse width is less than the value you specify with the Glitch.Width property. The oscilloscope triggers when the pulse width is greater than the value you specify with the Glitch.Width property.
116
Configuration
AgilentU2701AGlitchPolarityEnum
Description
IVI scope class- compliant values for glitch trigger polarity.
Members
Member name AgilentU2701A GlitchPolarity Positive AgilentU2701A GlitchPolarity Negative Value 1 Description The oscilloscope triggers on a positive glitch.
The oscilloscope triggers on a negative glitch.
AgilentU2701ASRQReasonEnum
Description
Enumeration for the Reason parameter of the ConfigureServiceRequest method.
Members
Member name AgilentU2701A SRQReasonStb MAV AgilentU2701A SRQReasonStb Msg AgilentU2701A SRQReasonEsr OPC Value 1 Description Message Available. Bit 4 in the status byte.
Error/Event Queue Message Available. Bit 2 in the status byte. The Error/Event queue may be read by the ErrorQuery method. Operation Complete. Bit 0 of the standard event status register.
117
Configuration
Member name AgilentU2701A SRQReasonEsr QueryError AgilentU2701A SRQReasonEsr DeviceError AgilentU2701A SRQReasonEsr ExecutionError AgilentU2701A SRQReasonEsr CommandError AgilentU2701A SRQReasonEsr UserRequest AgilentU2701A SRQReasonEsr PowerOn
Value 8
Description Query Error. Bit 2 of the standard event status register.
16
Device Dependent Error. Bit 3 of the standard event status register.
32
Execution Error. Bit 4 of the standard event status register.
64
Command Error. Bit 5 of the standard event status register.
128
User Request. Bit 6 of the standard event status register.
256
Power On. Bit 7 of the standard event status register.
AgilentU2701A 512 SRQReasonStbTrg AgilentU2701A SRQReasonStb User 1024
Trigger Event has occurred. Bit 0 in the status byte register. User Event has occurred. Bit 1 in the status byte register.
118
Configuration
AgilentU2701AStatusRegisterEnum
Description
Enumeration for the Register parameter of the Register property.
Members
Member name AgilentU2701A StatusRegister StatusByte AgilentU2701A StatusRegister StandardEvent AgilentU2701A StatusRegister Operation AgilentU2701A StatusRegister OverloadEvent AgilentU2701A StatusRegister TriggerEvent AgilentU2701A StatusRegister ArmEvent Value 0 Description Status Byte register. Conditions defined by IEEE 488.2.
Standard Event Status register. Conditions defined by IEEE 488.2.
Operation. Conditions which are part of the instrument's normal operation. The Overload Status Register captures overload events and probe faults that occur on the input channels. This register does not support the Conditions subregister. The Trigger Event Register captures the trigger event. This register does not support the Conditions or Enable subregisters. The Armed Event Register captures the arm event. An arm event occurs when the oscilloscope has fulfilled all its pre-trigger requirements and is waiting for a trigger event. This register does not support the Conditions or Enable subregisters.
119
Configuration
AgilentU2701AStatusSubRegisterEnum
Description
Enumeration for the SubRegister parameter of the Register property in the Status interface.
Members
Member name Value Description Conditions Register. Read only and not available with the Standard Event Status register. Condition bits represent the current instrument state. Reading a condition register does not change the value of the bits. Event Register. Read only and not available with the Status Byte register. Event bits capture changes in condition bits. Reading an event register clears it. Enable Register. Can be read or written and is available for all registers. Enable bits select whether an event bit causes a register summary bit, a kind of condition bit, to become True. Thus, an event can propagated to the status byte and finally to request service. Though the bits in the status byte are not technically event bits, the status byte enable register selects which bits in the status byte cause a service request.
AgilentU2701A 0 StatusSubRegister Condition AgilentU2701A 3 StatusSubRegister Event AgilentU2701A 4 StatusSubRegister Enable
120
Configuration
AgilentU2701ATriggerCouplingEnum
Description
IVI Scope class- compliant values for trigger Coupling.
Members
Member name Value Description The oscilloscope AC couples the trigger signal. The oscilloscope DC couples the trigger signal. The oscilloscope filters out the low frequencies from the trigger signal. The oscilloscope filters out the high frequencies from the trigger signal.
AgilentU2701A 1 TriggerCouplingAC AgilentU2701A 2 TriggerCouplingDC AgilentU2701A TriggerCouplingLF Reject 3
AgilentU2701A 4 TriggerCouplingHF Reject
AgilentU2701ATriggerModifierEnum
Description
IVI Scope class- compliant values for trigger Modifier.
Members
Member name AgilentU2701A TriggerModifier None AgilentU2701A TriggerModifier Auto Value 1 Description The oscilloscope waits until the trigger the end-user specifies occurs. The oscilloscope automatically triggers if the configured trigger does not occur within the oscilloscope's timeout period.
121
Configuration
AgilentU2701ATriggerSlopeEnum
Description
IVI Scope class- compliant values for edge trigger Slope.
Members
Member name AgilentU2701A TriggerSlope Negative AgilentU2701A TriggerSlope Positive Value 0 Description Triggers will occur on the falling edge.
Triggers will occur on the rising edge.
AgilentU2701A 2 TriggerSlopeEither AgilentU2701A TriggerSlope Alternate 3
Triggers will occur on either the rising or falling edge. Triggers will occur alternately on the rising and falling edges.
122
Configuration
AgilentU2701ATriggerTypeEnum
Description
IVI Scope class- compliant values for trigger Type.
Members
Member name AgilentU2701A TriggerEdge Value 1 Description Configures the oscilloscope for edge triggering. An edge trigger occurs when the trigger signal specified with the Trigger.Source property passes the voltage threshold specified with the Trigger.Level property and has the slope specified with the Trigger.Slope property. Configures the oscilloscope for glitch triggering. Use the IviScopeGlitchTrigger extension properties and methods to configure the trigger. Configures the oscilloscope for triggering on TV signals. Use the IviScopeTVTrigger extension properties and methods to configure the trigger. Configures the oscilloscope for width triggering. Use the IviScopeWidthTrigger extension properties and methods to configure the trigger.
AgilentU2701A TriggerGlitch AgilentU2701A TriggerTV AgilentU2701A TriggerWidth
123
Configuration
AgilentU2701ATVSignalFormatEnum
Description
IVI Scope class- compliant values for TV trigger SignalFormat.
Members
Member name AgilentU2701ATV SignalFormat NTSC AgilentU2701ATV SignalFormatPAL AgilentU2701ATV SignalFormat SECAM Value 1 Description Configures the oscilloscope to trigger on the NTSC signal format.
2 3
Configures the oscilloscope to trigger on the PAL signal format. Configures the oscilloscope to trigger on the SECAM signal format.
124
Configuration
AgilentU2701ATVTriggerEventEnum
Description
IVI Scope class- compliant values for TV trigger Event.
Members
Member name Value Description Sets the oscilloscope to trigger on field 1 of the video signal. Sets the oscilloscope to trigger on field 2 of the video signal. Sets the oscilloscope to trigger on any field.
AgilentU2701ATV 1 TriggerEventField1 AgilentU2701ATV 2 TriggerEventField2 AgilentU2701ATV TriggerEventAny Field AgilentU2701ATV TriggerEventAny Line 3
Sets the oscilloscope to trigger on any line.
AgilentU2701ATV 5 TriggerEventField1 LineNumber AgilentU2701ATV 6 TriggerEventField2 LineNumber
Sets the oscilloscope to trigger on a specific line number in Field 1 you specify with the TV.LineNumber property. Sets the oscilloscope to trigger on a specific line number in Field 2 you specify with the TV.LineNumber property.
125
Configuration
AgilentU2701AVerticalCouplingEnum
Description
IVI Scope class- compliant values for channel Coupling.
Members
Member name AgilentU2701A VerticalCoupling AC AgilentU2701A VerticalCoupling DC AgilentU2701A VerticalCoupling LFReject AgilentU2701A VerticalCoupling HFReject Value 0 Description The oscilloscope AC couples the input signal.
The oscilloscope DC couples the input signal.
The oscilloscope rejects low frequency.
The oscilloscope rejects high frequency.
126
Configuration
AgilentU2701AWidthConditionEnum
Description
IAgilentU2701A instrument- specific values for the polarity of the pulse that triggers the oscilloscope.
Members
Member name AgilentU2701A WidthPolarity Positive AgilentU2701A WidthPolarity Negative Value 1 Description Configures the oscilloscope to trigger on positive pulses that have a width that meets the condition the user specifies with the Width.Condition property. Configures the oscilloscope to trigger on negative pulses that have a width that meets the condition the user specifies with the Width.Condition property.
AgilentU2701AWidthPolarityEnum
Description
IAgilentU2701A instrument- specific values for the polarity of the pulse that triggers the oscilloscope.
Members
Member name AgilentU2701A WidthPolarity Positive AgilentU2701A WidthPolarity Negative Value 1 Description Configures the oscilloscope to trigger on positive pulses that have a width that meets the condition the user specifies with the Width.Condition property. Configures the oscilloscope to trigger on negative pulses that have a width that meets the condition the user specifies with the Width.Condition property.
127
Configuration
128
3 Acquisition
ConfigureRecord 130 Interpolation 132 NumberOfAverages 134 RecordLength 135 SampleMode 137 SampleRate 140 StartTime 142 TimePerRecord 144 Type 147 Enumeration Members 149
This chapter describes the acquisition commands used to program the U2701A/U2702A USB modular oscilloscopes over the remote interface. You can use the commands in this chapter to configure the acquisition type, the size of the waveform record, the length of time that corresponds to overall waveform record, and the position of the first point in the waveform record relative to the trigger event.
129
Acquisition
ConfigureRecord
Type
Method
Function
Set
Description
This command configures the most commonly used properties of the oscilloscope channel sub- system. Use this command to enable or disable the channel and to set the range, offset, coupling, and probe attenuation values.
Hierarchy
IAgilentU2701A ; Acquisition ; ConfigureRecord(TimePerRecord, AcquisitionStartTime)
Parameters
Item TimePerRecord AcquisitionStart Time Type Double Double Description Specifies the time per record. This value sets the Horizontal TimePerRecord property. Specifies the position of the first point in the waveform record relative to the trigger event. This value sets the Acquisition.StartTime property.
130
Acquisition
Example
131
Acquisition
Interpolation
Type
Property
Function
Get and Set
Description
This command returns/sets the interpolation method the oscilloscope uses when it cannot sample a voltage for every point in the waveform record.
Hierarchy
IAgilentU2701A ; Acquisition ; Interpolation
Return Format
Item Type Description See AgilentU2701AInterpolationEnum on page 151.
AgilentU2701A Enum InterpolationEnum
132
Acquisition
Example
133
Acquisition
NumberOfAverages
Type
Property
Function
Get and Set
Description
This command returns/sets the number of waveforms the oscilloscope acquires and averages before returning to idle state.
Hierarchy
IAgilentU2701A ; Acquisition ; NumberOfAverages
Return Format
Long/Int32
134
Acquisition
Example
RecordLength
Type
Property
Function
Get
135
Acquisition
Description
This command returns the actual number of points the oscilloscope acquires for each channel. It is equal to or greater than the minimum number of points specified with the IviScopeAcquisition.NumberOfPointsMin command.
Hierarchy
IAgilentU2701A ; Acquisition ; RecordLength
Return Format
Long/Int32
136
Acquisition
Example
SampleMode
Type
Property
Function
Get
137
Acquisition
Description
This command returns the sample mode that the oscilloscope is currently using.
Hierarchy
IAgilentU2701A ; Acquisition ; SampleMode
138
Acquisition
Return Format
Item AgilentU2701A SampleMode Enum Type Enum Description See AgilentU2701ASampleModeEnum on page 151.
Example
139
Acquisition
SampleRate
Type
Property
Function
Get
Description
This command returns the effective digitizing rate using the current configuration. The units are expressed in samples per second.
Hierarchy
IAgilentU2701A ; Acquisition ; SampleRate
Return Format
Double
140
Acquisition
Example
141
Acquisition
StartTime
Type
Property
Function
Get and Set
Description
This command returns/sets the length of time from the trigger event to the first point in the waveform record. The units are expressed in seconds. If positive, the first point in the waveform occurs after the trigger. If negative, the first point in the waveform occurs before the trigger.
Hierarchy
IAgilentU2701A ; Acquisition ; StartTime
Return Format
Double
142
Acquisition
Example
143
Acquisition
TimePerRecord
Type
Property
Function
Get and Set
Description
This command returns/sets the time in seconds that corresponds to the record length.
Hierarchy
IAgilentU2701A ; Acquisition ; TimePerRecord
Return Format
Double
144
Acquisition
Remarks
The time per record length is equivalent to the Time/Div multiplied by 10 at the scope setting. The Maximum data point per second you can achieve is 1250, except when in interleave mode (only available with the Agilent Measurement Manager), you can achieve 2000 data points.
Time/Div 1 ns 2 ns 5 ns 10 ns 20 ns 50 ns 100 ns 200 ns 500 ns 1 s 2 s 5 s 10 s 20 s 50 s 100 s 200 s 500 s
TimePer Record 10 ns 20 ns 50 ns 100 ns 200 ns 500 ns 1 s 2 s 5 s 10 s 20 s 50 s 100 s 200 s 500 s 1 ms 2 ms 5 ms
Maximum Data Point 5 10 25 50 100 250 500 100 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250
Time/Div 1 ms 2 ms 5 ms 10 ms 20 ms 50 ms 100 ms 200 ms 500 ms 1s 2s 5s 10 s 20 s 50 s
TimePer Record 10 ms 20 ms 50 ms 100 ms 200 ms 500 ms 1s 2s 5s 10 s 20 s 50 s 100 s 200 s 500 s
Maximum Data Point 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250 1250
145
Acquisition
Example
146
Acquisition
Type
Type
Property
Function
Get and Set
Description
This commands returns/sets how the oscilloscope acquires data and fills the waveform record. When set to Envelope or Peak Detect, the oscilloscope acquires minimum and maximum waveforms.
Hierarchy
IAgilentU2701A ; Acquisition ; Type
Return Format
Item AgilentU2701A AcquisitionType Enum Type Enum Description See AgilentU2701AAcquisitionTypeEnum on page 150.
147
Acquisition
Example
148
Acquisition
Enumeration Members
AgilentU2701AAcquisitionStatusEnum
Description
IVI scope class- compliant values for the Status parameter of the acquisition status method.
Members
Member name AgilentU2701A AcqInProgress AgilentU2701A AcqComplete AgilentU2701A AcqStatus Unknown Value 0 1 1 Description The oscilloscope is still acquiring data. The oscilloscope has completed the acquisition. The oscilloscope cannot determine the status of the acquisition.
149
Acquisition
AgilentU2701AAcquisitionTypeEnum
Description
IVI scope class- compliant values for acquisition type.
Members
Member name AgilentU2701A AcquisitionType Normal AgilentU2701A AcquisitionType PeakDetect AgilentU2701A AcquisitionType Average Value 0 Description Configures the oscilloscope to acquire one sample for each point in the waveform record. The oscilloscope uses real-time or equivalent time sampling. Sets the oscilloscope to the peak-detect acquisition mode. The oscilloscope oversamples the input signal and keeps the minimum and maximum values that correspond to each position in the waveform record. The oscilloscope uses only real-time sampling. Configures the oscilloscope to acquire multiple waveforms and calculates the average value for each point in the waveform record. The end-user specifies the number of waveforms to acquire with the NumberOfAverages property. The oscilloscope uses real-time or equivalent time sampling.
150
Acquisition
AgilentU2701AInterpolationEnum
Description
IVI scope class- compliant values for acquisition interpolation.
Members
Member name Value Description The oscilloscope does not interpolate points in the waveform. Instead, the driver sets every element in the waveform record for which the oscilloscope cannot receive a value to an IEEE-defined NaN (Not-a-Number) value. Use the IsWaveformElementInvalid method to determine if the waveform record element is invalid. The oscilloscope uses a sin(x)/x calculation to interpolate a value when it cannot resolve a voltage in the waveform record.
AgilentU2701A 1 InterpolationNone
AgilentU2701A 2 InterpolationSineX
AgilentU2701ASampleModeEnum
Description
IVI Scope class- compliant values for acquisition SampleMode.
Members
Member name AgilentU2701A SampleModeReal Time Value 0 Description Indicates that the oscilloscope is using real-time sampling.
151
Acquisition
152
4 Waveform Display
Abort 154 AutoSetup 156 Count 158 Initiate 160 IsWaveformElementInvalid 162 Item 164
This chapter describes the waveform display commands used to program the U2701A/U2702A USB modular oscilloscopes over the remote interface. The statements in this section is used to acquire waveform data from the oscilloscope. You can use the commands in this section to initiate, acquire, and abort measurements.
153
Waveform Display
Abort
Type
Method
Function
Set
Description
This command aborts an acquisition and returns the oscilloscope to the Idle state.
Hierarchy
IAgilentU2701A ; Measurements ; Abort()
Example
154
Waveform Display
155
Waveform Display
AutoSetup
Type
Method
Function
Set
Description
This command automatically configures all the oscilloscopes settings based on the input signals.
Hierarchy
IAgilentU2701A ; Measurements ; AutoSetup()
Example
156
Waveform Display
157
Waveform Display
Count
Type
Property
Function
Get
Description
This command returns the number of measurements.
Hierarchy
IAgilentU2701A ; Measurements ; Count
Return Format
Long/Int32
Example
158
Waveform Display
159
Waveform Display
Initiate
Type
Method
Function
Set
Description
This command initiates a waveform acquisition. The oscilloscope leaves the Idle state and waits for a trigger. The oscilloscope acquires a waveform for each enabled channel.
Hierarchy
IAgilentU2701A ; Measurements ; Initiate()
Example
160
Waveform Display
161
Waveform Display
Type
Method
Function
Get
Description
This command returns False if an element in a waveform array returned by the driver contains a valid voltage. This command returns True if an element in a waveform array returned by the driver contains a value indicating that the oscilloscope could not sample a voltage.
Hierarchy
IAgilentU2701A ; Measurements ; IsWaveformElementInvalid(Element)
Parameters
Item Element Type Double Description Pass one of the values from the waveform array returned by the read and fetch waveform methods.
Return Format
Boolean
162
Waveform Display
Example
163
Waveform Display
Item
This is an interface reference pointer to the IAgilentU2701AMeasurement interface which is selected by the measurement name.
FetchWaveform
Type
Method
Function
Get
Description
This command returns a previously acquired waveform for this channel. The acquisition must be made prior to calling this method. Call this method separately for each channel.
Hierarchy
IAgilentU2701A ; Measurements ; Item(Name) ; FetchWaveform(WaveformArray, InitialX, XIncrement)
Parameters
Item Name Type String Description The name of a measurement. It may be either a name returned by the Name property or a name mapped to a particular repeated capability in the session in the configuration store.
164
Waveform Display
Return Format
Item WaveformArray InitialX Type Double Double Description The array contains the acquired waveform. Units for the individual array elements are expressed in volts. The time in relation to the trigger event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event. The effective time between points in the acquired waveform in seconds.
XIncrement
Double
Example
165
Waveform Display
166
Waveform Display
ReadWaveform
Type
Method
Function
Get
Description
This command initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the waveform for this channel. Call FetchWaveform to obtain the waveforms for other channels.
Hierarchy
IAgilentU2701A ; Measurements ; Item(Name) ; ReadWaveform(MaxTimeMilliseconds, WaveformArray, InitialX, XIncrement)
Parameters
167
Waveform Display
Return Format
Item MaxTime Milliseconds WaveformArray InitialX Type Long/Int32 Double Double Description Specifies the maximum time the end-user allows for this method to complete in milliseconds. The array contains the acquired waveform. Units for the individual array elements are expressed in volts. The time in relation to the trigger event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event. The effective time between points in the acquired waveform in seconds.
XIncrement
Double
168
Waveform Display
Example
169
Waveform Display
170
5 Post Analysis
Abort 172 AutoSetup 174 Count 176 Initiate 178 IsWaveformElementInvalid 180 Item 182 MathFunction 193 Name 195 Status 196 Enumeration Members 199
This chapter describes the post analysis commands used to program the U2701A/U2702A USB modular oscilloscopes over the remote interface. The statements in this section is used to analyze the waveform data acquired from the oscilloscope. You can also use the commands in this section to initiate, acquire, and abort measurements.
171
Post Analysis
Abort
Type
Method
Function
Set
Description
This command aborts an acquisition and returns the oscilloscope to the Idle state.
Hierarchy
IAgilentU2701A ; Measurements ; Abort()
Example
172
Post Analysis
173
Post Analysis
AutoSetup
Type
Method
Function
Set
Description
This command automatically configures all the oscilloscopes settings based on the input signals.
Hierarchy
IAgilentU2701A ; Measurements ; AutoSetup()
Example
174
Post Analysis
175
Post Analysis
Count
Type
Property
Function
Get
Description
This command returns the number of measurements.
Hierarchy
IAgilentU2701A ; Measurements ; Count
Return Format
Long/Int32
Example
176
Post Analysis
177
Post Analysis
Initiate
Type
Method
Function
Set
Description
This command initiates a waveform acquisition. The oscilloscope leaves the Idle state and waits for a trigger. The oscilloscope acquires a waveform for each enabled channel.
Hierarchy
IAgilentU2701A ; Measurements ; Initiate()
Example
178
Post Analysis
179
Post Analysis
Type
Method
Function
Get
Description
This command returns False if an element in a waveform array returned by the driver contains a valid voltage. This command returns True if an element in a waveform array returned by the driver contains a value indicating that the oscilloscope could not sample a voltage.
Hierarchy
IAgilentU2701A ; Measurements ; IsWaveformElementInvalid(Element)
Parameters
Item Element Type Double Description Pass one of the values from the waveform array returned by the read and fetch waveform methods.
Return Format
Boolean
180
Post Analysis
Example
181
Post Analysis
Item
This is an interface reference pointer to the IAgilentU2701AMeasurement interface which is selected by the measurement name.
FetchWaveform
Type
Method
Function
Get
Description
Hierarchy
IAgilentU2701A ; Measurements ; Item(Name) ; FetchWaveform(WaveformArray, InitialX, XIncrement)
Parameters
182
Post Analysis
Return Format
Item WaveformArray InitialX Type Double Double Description The array contains the acquired waveform. Units for the individual array elements are expressed in volts. The time in relation to the trigger event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event. The effective time between points in the acquired waveform in seconds.
XIncrement
Double
183
Post Analysis
Example
184
Post Analysis
FetchWaveformMeasurement
Type
Method
Function
Get
Description
This command returns a previously acquired waveform measurement for this channel. The acquisition must be made prior to calling this method. Call this method separately for each measurement.
Hierarchy
IAgilentU2701A ; Measurements ; Item(Name) ; FetchWaveformMeasurement (MeasFunction, Measurement)
Parameters
185
Post Analysis
Return Format
Item MeasFunction Type AgilentU2701A Measurement Enum Double Description Characteristic of the acquired waveform to be measured. See AgilentU2701AMeasurementEnum on page 200 for more information. The measured value. The units depend on the measurement that the user specifies with the MeasFunction parameter.
Measurement
Example
186
Post Analysis
ReadWaveform
Type
Method
Function
Get
Description
This command initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the waveform for this channel. Call FetchWaveform to obtain the waveforms for other channels.
Hierarchy
IAgilentU2701A ; Measurements ; Item(Name) ; ReadWaveform(MaxTimeMilliseconds, WaveformArray, InitialX, XIncrement)
Parameters
187
Post Analysis
Return Format
Item MaxTime Milliseconds WaveformArray InitialX Type Long/Int32 Double Double Description Specifies the maximum time the end-user allows for this method to complete in milliseconds. The array contains the acquired waveform. Units for the individual array elements are expressed in volts. The time in relation to the trigger event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event. The effective time between points in the acquired waveform in seconds.
XIncrement
Double
188
Post Analysis
Example
189
Post Analysis
ReadWaveformMeasurement
Type
Method
Function
Get
Description
Hierarchy
IAgilentU2701A ; Measurements ; Item(Name) ; ReadWaveformMeasurement (MeasFunction, MaxTimeMilliseconds, Measurement)
Parameters
190
Post Analysis
Return Format
Item MeasFunction Type AgilentU2701A Measurement Enum Long/Int32 Double Description Characteristic of the acquired waveform to be measured. See AgilentU2701AMeasurementEnum on page 200 for more information. Specifies the maximum time the end-user allows for this method to complete in milliseconds. The measured value. The units depend on the measurement that the user specifies with the MeasFunction parameter.
MaxTime Milliseconds Measurement
Example
191
Post Analysis
192
Post Analysis
MathFunction
Type
Method
Function
Set
Description
This command configures a mathematical operation for Channel 1 and 2. The operation and reverse will be set to ADD and False by default.
Hierarchy
IAgilentU2701A ; Measurements ; MathFunction(Operation, Reverse)
Parameters
Item Operation Type AgilentU2701A Measurement Enum Boolean Description Channel 1 and Channel 2 math operation.
Reverse
The operation order of Channel 1 and Channel 2. If True, Channel 2 <operation> Channel 1. If False ,Channel 1 <operation> Channel 2
193
Post Analysis
Example
194
Post Analysis
Name
Type
Property
Function
Get
Description
This command returns the measurement name for a given index.
Hierarchy
IAgilentU2701A ; Measurements ; Name(Index)
Parameters
Item Index Type Long/Int32 Description One based index into the collection of measurements.
Return Format
String/BSTR
195
Post Analysis
Example
Status
Type
Method
Function
Get
196
Post Analysis
Description
This command returns whether an acquisition is in progress, complete, or if the status is unknown.
Hierarchy
IAgilentU2701A ; Measurements ; Status()
197
Post Analysis
Return Format
Item AgilentU2701A AcquisitionStatus Enum Type Enum Description See AgilentU2701AAcquisitionStatusEnum on page 149.
Example
198
Post Analysis
Enumeration Members
AgilentU2701AMathOperationEnum
Description
IAgilentU2701A instrument- specific values for channels mathematical operations.
199
Post Analysis
Members
Member name AgilentU2701A MathOperation Add AgilentU2701A MathOperation Subtract AgilentU2701A MathOperation Multiply AgilentU2701A MathOperation Divide Value 0 Description Add operation between two channels.
Subtract operation between two channels.
Multiply operation between two channels.
Divide operation between two channels.
AgilentU2701AMeasurementEnum
Description
IVI scope class- compliant values for the MeasFunction parameter read and fetch methods.
Members
Member name Value Description The length of time for a rising edge of the signal to rise from the low reference level to the high reference level. The units are expressed in seconds. The length of time for a falling edge of the signal to fall from the high reference level to the low reference level. The units are expressed in seconds. The frequency of one complete cycle in the waveform. The units are expressed in hertz.
AgilentU2701A 0 MeasurementRise Time AgilentU2701A MeasurementFall Time AgilentU2701A Measurement Frequency 1
200
Post Analysis
Member name AgilentU2701A Measurement Period AgilentU2701A Measurement VoltageRMS AgilentU2701A Measurement VoltageRMSAC AgilentU2701A Measurement VoltagePeakTo Peak AgilentU2701A Measurement VoltageMax AgilentU2701A Measurement VoltageMin AgilentU2701A Measurement VoltageHigh
Value 3
Description The length of time of one complete cycle in the waveform. The units are expressed in seconds. The true Root Mean Square voltage of the entire waveform. The units are expressed in volts. The true Root Mean Square voltage(AC) of the entire waveform. The units are expressed in volts. The absolute difference between the Voltage Max and the Voltage Min. The units are expressed in volts.
The maximum amplitude found in the entire waveform. The units are expressed in volts. The minimum amplitude found in the entire waveform. The units are expressed in volts. The voltage that corresponds to 100% when using the reference levels. The oscilloscope calculates this value using either the min/max or histogram methods. The min/max method uses the maximum value found. The histogram method uses a common value found above the middle of the waveform. The units are expressed in volts. The voltage that corresponds to 0% when using the reference levels. The oscilloscope calculates this value using either the min/max or histogram methods. The min/max method uses the minimum value found. The histogram method uses a common value found below the middle of the waveform. The units are expressed in volts. The arithmetic average in volts measured over the entire waveform. The units are expressed in volts. The length of time between the mid reference level points of a negative pulse in the waveform. The units are expressed in seconds.
AgilentU2701A Measurement VoltageLow
10
AgilentU2701A Measurement VoltageAverage AgilentU2701A Measurement WidthNeg
11
12
201
Post Analysis
Member name AgilentU2701A Measurement WidthPos
Value 13
Description The length of time between the mid reference level points of a positive pulse in the waveform. The units are expressed in seconds. The ratio of the WidthNeg to the Period of an integer number of cycles in the waveform expressed as a percentage. The ratio of the WidthPos width to the Period of an integer number of cycles in the waveform expressed as a percentage. The VoltageHigh less the VoltageLow expressed in volts over the entire waveform. The true root mean square voltage over an integer number of cycles in the waveform. The units are expressed in volts. The relative waveform distortion that follows an edge transition.
AgilentU2701A 14 MeasurementDuty CycleNeg AgilentU2701A 15 MeasurementDuty CyclePos AgilentU2701A Measurement Amplitude AgilentU2701A Measurement VoltageCycleRMS 16
17
AgilentU2701A 18 MeasurementOver Shoot AgilentU2701A Measurement Preshoot AgilentU2701A Measurement Phase AgilentU2701A Measurement Delay AgilentU2701A Measurement CrestFactor 19
The relative waveform distortion that precedes an edge transition.
20
Phase.
21
Delay.
22
Crest factor.
AgilentU2701A 23 Measurement StandardDeviation
Standard deviation.
202
Post Analysis
Member name AgilentU2701A Measurement TimeAtMax AgilentU2701A Measurement TimeAtMin
Value 24
Description Time at maximum voltage.
25
Time at minimum voltage.
AgilentU2701ATimeOutEnum
Description
IVI Scope class- compliant values for maxTime parameter of the measurement Read and Fetch methods.
Members
Member name AgilentU2701A TimeOut Immediate AgilentU2701A TimeOutInfinite Value 0 Description This method returns immediately. If no measurement value exists, an error is returned. The method waits indefinitely for the measurement to complete.
203
Post Analysis
204
6 Others
Calibration Interface commands starting on page 206 DriverOperation Interface commands starting on page 214 Identity Interface commands starting on page 241 SerialNumber 263
This chapter describes the other commands used to program the U2701A/U2702A USB modular oscilloscopes over the remote interface. You can use the commands in this chapter to get and set some of the oscilloscope properties. You can also calibrate the instrument and perform various driver operations.
205
Others
Calibrate
Type
Method
Function
Set
Description
This command calibrates the instrument. This method might take several minutes to complete.
Hierarchy
IAgilentU2701A ; Calibration ; Calibrate()
Example
206
Others
207
Others
Date
Type
Property
Function
Get
Description
This command returns the date the instrument was last calibrated.
Hierarchy
IAgilentU2701A ; Calibration ; Date
Return Format
String/BSTR
Example
208
Others
209
Others
Label
Type
Property
Function
Get
Description
This command returns the label set during the last calibration.
Hierarchy
IAgilentU2701A ; Calibration ; Label
Return Format
String/BSTR
Example
210
Others
211
Others
Time
Type
Property
Function
Get
Description
This command returns the time the instrument was last calibrated.
Hierarchy
IAgilentU2701A ; Calibration ; Time
Return Format
String/BSTR
Example
212
Others
213
Others
Cache
Type
Property
Function
Get and Set
Description
Drivers may choose to always cache some instrument settings, never cache others, or optionally cache others to avoid unnecessary I/O activities to the instrument. If this command is set to True, the driver caches optionally cache instrument settings.
Hierarchy
IAgilentU2701A ; DriverOperation ; Cache
Return Format
Boolean
214
Others
Example
215
Others
ClearInterchangeWarnings
Type
Method
Function
Set
Description
This command clears the list of interchangeability warnings that the IVI specific driver maintains.
Hierarchy
IAgilentU2701A ; DriverOperation ; ClearInterchangeWarnings
Return Format
Boolean
Example
216
Others
217
Others
DriverSetup
Type
Property
Function
Get
Description
This command returns the driver setup string. It is either specified in the configuration store or passed in the OptionString parameter of the function. Driver setup is empty if the driver is not initialized.
Hierarchy
IAgilentU2701A ; DriverOperation ; DriverSetup
Return Format
String/BTSR
218
Others
Example
219
Others
GetNextCoercionRecord
Type
Method
Function
Get
Description
This command returns the oldest record from the coercion record list. Records are only added to the list if RecordCoercions is set to True.
Hierarchy
IAgilentU2701A ; DriverOperation ; GetNextCoercionRecord()
Return Format
String/BTSR
Example
220
Others
GetNextInterchangeWarning
Type
Method
Function
Get
Description
This command returns the oldest warning from the interchange warning list. Records are only added to the list if InterchangeCheck is set to True.
Hierarchy
IAgilentU2701A ; DriverOperation ; GetNextInterchangeWarning()
Return Format
String/BTSR
Example
221
Others
222
Others
InterchangeCheck
Type
Property
Function
Get and Set
Description
If this command is set to True, the driver maintains a record of interchangeability warnings. If the driver does not support interchangeability checking, attempts to set InterchangeCheck to True returns an error.
Hierarchy
IAgilentU2701A ; DriverOperation ; InterchangeCheck
Return Format
Boolean
223
Others
Example
224
Others
InvalidateAllAttributes
Type
Method
Function
Set
Description
This command invalidates all of the driver cached values.
Hierarchy
IAgilentU2701A ; DriverOperation ; InvalidateAllAttributes()
Return Format
Boolean
Example
225
Others
226
Others
IoResourceDescriptor
Type
Property
Function
Get
Description
This command returns the instrument resource descriptor. The resource descriptor specifies the connection to a physical device. It is either specified in the configuration store or passed in the ResourceName parameter of the Initialize function. It is empty if the driver is not initialized.
Hierarchy
IAgilentU2701A ; DriverOperation ; IoResourceDescriptor
Return Format
String/BSTR
227
Others
Example
228
Others
LogicalName
Type
Property
Function
Get
Description
This command returns the instrument logical name. The logical name identifies a driver session in the configuration store. If logical name is not empty, the driver was initialized from the information in the driver session. If it is empty, the driver was initialized without using the configuration store.
Hierarchy
IAgilentU2701A ; DriverOperation ; LogicalName
Return Format
String/BSTR
229
Others
Example
230
Others
QueryInstrumentStatus
Type
Property
Function
Get and Set
Description
If this command is set to True, the driver queries the instrument status at the end of each method or property that performs I/O to the instrument. If an error is reported, use ErrorQuery to retrieve error messages one at a time from the instrument.
Hierarchy
IAgilentU2701A ; DriverOperation ; QueryInstrumentStatus
Return Format
Boolean
231
Others
Example
232
Others
RangeCheck
Type
Property
Function
Get and Set
Description
Drivers may choose to always validate some property or parameter values, never validate others, and optionally validate others, to avoid sending invalid commands to the instrument. If this command is set to True, the driver performs optional validations.
Hierarchy
IAgilentU2701A ; DriverOperation ; RangeCheck
Return Format
Boolean
233
Others
Example
234
Others
RecordCoercions
Type
Property
Function
Get and Set
Description
If this command is set to True, the driver keeps a list of the value coercions it makes for ViInt32 and ViReal64 attributes. If the driver does not support coercion recording, attempts to set RecordCoercions to True will return an error.
Hierarchy
IAgilentU2701A ; DriverOperation ; RecordCoercions
Return Format
Boolean
235
Others
Example
236
Others
ResetInterchangeCheck
Type
Method
Function
Set
Description
This command resets the interchangeability checking algorithms of the driver so that methods and properties that were executed prior to calling this function have no affect on whether future calls to the driver will generate interchangeability warnings or not.
Hierarchy
IAgilentU2701A ; DriverOperation ; ResetInterchangeCheck()
Example
237
Others
238
Others
Simulate
Type
Property
Function
Get and Set
Description
If this command is set to True, the driver does not perform I/O to the instrument, and returns simulated values for output parameters instead.
Hierarchy
IAgilentU2701A ; DriverOperation ; Simulate
Return Format
Boolean
239
Others
Example
240
Others
Description
Type
Property
Function
Get
Description
This command returns a brief description of the implementing component. Description is limited to 256 bytes.
Hierarchy
IAgilentU2701A ; Identity ; Description
Return Format
String/BSTR
Example
241
Others
242
Others
GroupCapabilities
Type
Property
Function
Get
Description
This command returns a comma- separated list of the class capability groups implemented by the driver. Capability group names are documented in the IVI class specifications. If the driver is not class compliant, the driver returns an empty string.
Hierarchy
IAgilentU2701A ; Identity ; GroupCapabilities
Return Format
String/BSTR
243
Others
Example
244
Others
Identifier
Type
Property
Function
Get
Description
This command returns the case- sensitive unique identifier of the implementing IVI- COM instrument driver.
Hierarchy
AgilentU2701A ; Identity ; Identifier
Return Format
String/BSTR
Example
245
Others
246
Others
InstrumentFirmwareRevision
Type
Property
Function
Get
Description
This command returns the firmware revision reported by the physical instrument. If Simulate is enabled or the instrument is not capable of reporting the firmware revision, a string is returned that explains the condition.
Hierarchy
IAgilentU2701A ; Identity ; InstrumentFirmwareRevision
Return Format
String/BSTR
247
Others
Example
248
Others
InstrumentManufacturer
Type
Property
Function
Get
Description
This command returns the name of the manufacturer reported by the physical instrument. If Simulate is enabled or the instrument is not capable of reporting the name of the manufacturer, a string is returned that explains the condition. InstrumentManufacturer is limited to 256 bytes.
Hierarchy
IAgilentU2701A ; Identity ; InstrumentManufacturer
Return Format
String/BSTR
249
Others
Example
250
Others
InstrumentModel
Type
Property
Function
Get
Description
This command returns the model number or name reported by the physical instrument. If Simulate is enabled or the instrument is not capable of reporting the model number or name, a string is returned that explains the condition. InstrumentModel is limited to 256 bytes.
Hierarchy
IAgilentU2701A ; Identity ; InstrumentModel
Return Format
String/BSTR
251
Others
Example
252
Others
Revision
Type
Property
Function
Get
Description
This command returns the revision of the implementing component. Revision is limited to 256 bytes.
Hierarchy
IAgilentU2701A ; Identity ; Revision
Return Format
String/BSTR
Example
253
Others
254
Others
SpecificationMajorVersion
Type
Property
Function
Get
Description
For IVI class- compliant drivers, this command returns the major version number of the instrument class specification. If the driver is not class compliant, the driver returns zero.
Hierarchy
IAgilentU2701A ; Identity ; SpecificationMajorVersion
Return Format
Long/Int32
255
Others
Example
256
Others
SpecificationMinorVersion
Type
Property
Function
Get
Description
For IVI class- compliant drivers, this command returns the minor version number of the instrument class specification. If the driver is not class compliant, the driver returns zero.
Hierarchy
IAgilentU2701A ; Identity ; SpecificationMinorVersion
Return Format
Long/Int32
257
Others
Example
258
Others
SupportedInstrumentModels
Type
Property
Function
Get
Description
This command returns a comma- separated list of instrument models that the IVI specific driver can control. The string does not include an abbreviation for the manufacturer if it is the same for all models.
Hierarchy
AgilentU2701A ; Identity ; SupportedInstrumentModels
Return Format
String/BSTR
259
Others
Example
260
Others
Vendor
Type
Property
Function
Get
Description
This command returns the name of the vendor that supplies the implementing component. Vendor is limited to 256 bytes.
Hierarchy
IAgilentU2701A ; Identity ; Vendor
Return Format
String/BSTR
Example
261
Others
262
Others
SerialNumber
Type
Property
Function
Get
Description
This command returns the instrument serial number.
Hierarchy
IAgilentU2701A ; System ; SerialNumber
Return Format
String
263
Others
Example
264
7 Application Example
Introduction 266 Complete Example 276
This chapter contains an example program for the U2701A/U2702A USB modular oscilloscopes. The following program uses Microsoft Windows and Microsoft Visual C# .Net (2003 and later). Refer to the instruction manual of Visual C# .Net for further details about Visual C# .Net.
265
Application Example
Introduction
This section, we explain how to use access Agilent U2701A/U2702A IVI- COM driver for NI LabVIEW. At the end of each sub- section, we also provide complete example for reference.
Creating Connectivity to the IVI-COM Driver

Follow the steps below in order to use the IVI- COM driver in LabVIEW: 1 Launch LabVIEW and open up a Blank VI. You should see 2 windows, the Block Diagram Window and the Front Panel Window. 2 Search for the Automation Open icon under Connectivity >> ActiveX of the Functions Palette and drag it onto the Block Diagram Window. The function of this icon is to return an automation refnum, which points to a specific ActiveX object.
266
Application Example
3 Right- click the first terminal to the left of the Automation Open icon (Automation Refnum) and choose Select ActiveX Class >> Browse. 4 Select the Type Library for IVI AgilentU2701A Type Library Version 1.0 from the drop down list.
5 Select IAgilentU2701A Object from the Objects hierarchy tree.
267
Application Example
6 Click OK to return to the Block Diagram Window. You can now see the Automation Refnum terminal connected to the AgilentU2701ALib.IAgilentU2701A object.
7 Right- click the last terminal to the left of the Automation Open icon (error in - (no error)) and choose Create >> Control.
Using the Driver

Calling Initialize will establish a connection to Agilent U2701A/U2702A and calling Close will terminate the connection. Please follow the steps below in order to initialize the instrument for use and also closing the connection after use: 1 Search for the Invoke Method (ActiveX) icon under Connectivity >> ActiveX of the Functions Palette and drag it onto the Block Diagram
268
Application Example
Window. The function of this icon is to invoke a method or action on a reference.
2 Right- click the Invoke Method icon can select Select Class >> ActiveX >> AgilentU2761ALib.IAgilentU2761A. 3 Connect the terminals as shown below:
269
Application Example
4 Click on the Method icon and select Initialize. You should see the display below:
5 Create the appropriate controls to all the input terminals on the left by right- clicking each terminal and selecting Create >> Control. The ResourceName for the instrument can be obtained using Agilent Connection Expert. Find the Agilent U2701A/U2702A under the USB interface and the resource name is shown under the VISA address as highlighted in the red circle (i.e : USB0::2391::10520::MY48151002::0::INSTR)
270
Application Example
6 Alternatively, the VISA address can be obtained from National Instrument Measurement and Automation Explorer as highlighted in the red circle.
7 After creating all the controls, the front panel and block diagram should look something as shown below:
271
Application Example
8 Please refer to the Initialize method covered under IVI- COM Statement Reference in this manual for a more detailed explanation. 9 To continue with the program development, right- click the Initialize bar of the icon and choose Create. Select the items needed to construct the program by referring to the explanation set forth in this manual.
10 To complete the program, right- click the last icon and choose Create. Select the Close method and connect the terminal accordingly.
272
Application Example
11 The block diagram should appear as shown below:
12 Search for the Close Reference icon under Connectivity >> ActiveX of the Functions Palette, drag it onto the Block Diagram Window and connect the terminals accordingly.
273
Application Example
13 Create the error out indicator for the Close Reference icon by right clicking on the terminal and select Create >> Indicator. The Front Panel and Block diagram should appear as below:
274
Application Example
14 To make viewing easier or as a personal preference, you can choose to uncheck the View As Icon menu item by right- clicking each control and indicator.
15 The Block Diagram should appear as below:
275
Application Example
Complete Example
This section illustrates a complete example covering steps needed to get the instrument's identity, reset the instrument; automatically scale the instrument, conducting a simple measurement, and finally acquiring and saving the waveform data.
276
Application Example
277
Application Example
278
Command Quick Reference

Root keyword IAgilentU2701A Second-level Acquisition Third-level ConfigureRecord Interpolation NumberOfAverages RecordLength SampleMode SampleRate StartTime TimePerRecord Type Calibration Calibrate Date Label Time Channels Count Item BandwidthLimit Configure Coupling Enabled Offset ProbeAttenuation Range Name Close Fourth-level Page See page 130 See page 132 See page 134 See page 135 See page 137 See page 140 See page 142 See page 144 See page 147 See page 206 See page 208 See page 210 See page 212 See page 12 See page 14 See page 16 See page 19 See page 21 See page 23 See page 25 See page 27 See page 30 See page 32
279
Root keyword IAgilentU2701A
Second-level DriverOperation
Third-level Cache ClearInterchange Warnings DriverSetup GetNextCoercion Record GetNextInterchange Warning InterchangeCheck InvalidateAllAttributes IoResourceDescriptor LogicalName QueryInstrumentStatus RangeCheck RecordCoercions ResetInterchange Check Simulate
Fourth-level
Page See page 214 See page 216 See page 218 See page 220 See page 221 See page 223 See page 225 See page 227 See page 229 See page 231 See page 233 See page 235 See page 237 See page 239 See page 241 See page 243 See page 245 See page 247 See page 249 See page 251 See page 253 See page 255
Identity
Description GroupCapabilities Identifier InstrumentFirmware Revision Instrument Manufacturer InstrumentModel Revision SpecificationMajor Version
280
U2701A/U2702A IVI-COM Programmers Refer-
Second-level Identity
Third-level SpecificationMinor Version SupportedInstrument Models Vendor
Fourth-level
Page See page 257 See page 259 See page 261 See page 34 See page 37
Initialize Initialized Measurements Abort AutoSetup Count Initiate IsWaveformElement Invalid Item FetchWaveform FetchWaveform Measurement ReadWaveform ReadWaveform Measurement MathFunction Name Status Status Clear ConfigureService Request Preset Register SerialPoll
See page 154/172 See page 156/174 See page 158/176 See page 160/178 See page 162/180 See page 164/182 See page 185 See page 167/187 See page 190 See page 193 See page 195 See page 196 See page 88 See page 90 See page 92 See page 94 See page 96
281
Second-level System
Third-level SerialNumber TimeoutMilliseconds WaitForOperation Complete
Fourth-level
Page See page 98/263 See page 98 See page 100 See page 39 See page 41
Trigger
Configure Coupling Edge Configure Slope Glitch Condition Configure Polarity Width Holdoff Modifier Level Source Status TV Configure Event LineNumber SignalFormat Type Width Condition Configure Polarity ThresholdHigh
See page 43 See page 46 See page 48 See page 50 See page 52 See page 54 See page 56 See page 58 See page 60 See page 61 See page 63 See page 66 See page 69 See page 71 See page 72 See page 75 See page 77 See page 79 See page 82 See page 84
282
Second-level Trigger Utility
Third-level Width Disable ErrorQuery LockObject Reset ResetWithDefaults SelfTest UnlockObject
Fourth-level ThresholdLow
Page See page 85 See page 102 See page 104 See page 106 See page 108 See page 110 See page 112 See page 114
283
Enumeration Quick Reference

Enumeration members AgilentU2701AAcquisitionStatusEnum AgilentU2701AAcquisitionTypeEnum AgilentU2701AGlitchConditionEnum AgilentU2701AGlitchPolarityEnum AgilentU2701AInterpolationEnum AgilentU2701AMathOperationEnum AgilentU2701AMeasurementEnum AgilentU2701ASampleModeEnum AgilentU2701ASRQReasonEnum AgilentU2701AStatusRegisterEnum AgilentU2701AStatusSubRegisterEnum AgilentU2701ATimeOutEnum AgilentU2701ATriggerCouplingEnum AgilentU2701ATriggerModifierEnum AgilentU2701ATriggerSlopeEnum AgilentU2701ATriggerTypeEnum AgilentU2701ATVSignalFormatEnum AgilentU2701ATVTriggerEventEnum AgilentU2701AVerticalCouplingEnum AgilentU2701AWidthConditionEnum AgilentU2701AWidthPolarityEnum Page See page 149 See page 150 See page 116 See page 117 See page 151 See page 199 See page 200 See page 151 See page 117 See page 119 See page 120 See page 203 See page 121 See page 121 See page 122 See page 123 See page 124 See page 125 See page 126 See page 127 See page 127
284
Appendix
Property IAgilentU2701AAcquisition.NumberOfAverages Time/Div 1 ns 2 ns 5 ns 10 ns 20 ns 50 ns 100 ns 200 ns 500 ns 1 s 2 s IAgilentU2701AAcquisition.StartTime IAgilentU2701AAcquisition.TimePerRecord 5 s 10 s 20 s 50 s 100 s 200 s 500 s 1 ms 2 ms 5 ms 10 ms 20 ms 50 ms 100 ms Possible values Values (Int32) 1 - 999 TimePerRecord 10 ns 20 ns 50 ns 100 ns 200 ns 500 ns 1 s 2 s 5 s 10 s 20 s 50 s 100 s 200 s 500 s 1 ms 2 ms 5 ms 10 ms 20 ms 50 ms 100 ms 200 ms 500 ms 1s StartTime 5 ns - 5 ns 10 ns - 10 ns 25 ns - 25 ns 50 ns - 50 ns 100 ns - 100 ns 250 ns - 250 ns 500 ns - 500 ns 1 s - 1 s 2.5 s - 2.5 s 5 s - 5 s 10 s - 10 s 25 s - 25 s 50 s - 50 s 100 s - 100 s 250 s - 250 s 500 s - 500 s 1 ms - 1 ms 2.5 ms - 2.5 ms 5 ms - 5 ms 10 ms - 10 ms 25 ms - 25 ms 50 ms - 50 ms 100 ms - 100 ms 250 ms - 250 ms 500 ms - 500 ms
285
Time/Div 200 ms 500 ms 1s IAgilentU2701AAcquisition.StartTime IAgilentU2701AAcquisition.TimePerRecord 2s 5s 10 s 20 s 50 s
TimePerRecord 2s 5s 10 s 20 s 50 s 100 s 200 s 500 s Name (String) Channel1 Channel2 MathChannel Value (double) 1 10 100
StartTime 1 s - 1 s 2.5 s - 2.5 s 5 s - 5 s 10 s - 10 s 25 s - 25 s 50 s - 50 s 100 s - 100 s 250 s - 250 s
IAgilentU2701AChannels.Item
IAgilentU2701AChannel.ProbeAttenuation
Volt/Div 2 mV 5 mV 10 mV 20 mV IAgilentU2701AChannel.Offset IAgilentU2701AChannel.Range 50 mV 100 mV 200 mV 500 mV 1V 2V 5V IAgilentU2701ATriggerGlitch.Width Condition LessThan (Value) > 7 ns
Voltage Range (Attenuation = 1x) 16 mV 40 mV 80 mV 160 mV 400 mV 800 mV 1.6 V 4V 8V 16 V 40 V
Offset 8 mV - 8 mV 20 mV - 20 mV 40 mvV - 40 mV 80 mV - 80 mV 200 mV - 200 mV 400 mV - 400 mV 800 mV - 800 mV 2 V - 2 V 4 V - 4 V 8 V - 8 V 20 V - 20 V
Condition GreaterThan (Value) > 15 ns
286
IAgilentU2701ATrigger.Holdoff
Value (Double) > 59 ns Value (String) Channel1 Chan1 CHANNEL1
IAgilentU2701ATrigger.Source
Channel2 Chan2 CHANNEL2 Ext EXT Value (Int) 1 - 263 Value (Double) > 15 ns Value (Double) > 7 ns
IAgilentU2701ATriggerTv.LineNumber IAgilentU2701ATriggerWidth.ThresholdHigh IAgilentU2701ATriggerWidth.ThresholdLow
287
288
www.agilent.com
Contact us To obtain service, warranty or technical assistance, contact us at the following phone or fax numbers: United States: (tel) 800 829 4444 (fax) 800 829 4433 Canada: (tel) 877 894 4414 (fax) 800 746 4866 China: (tel) 800 810 0189 (fax) 800 820 2816 Europe: (tel) 31 20 547 2111 Japan: (tel) (81) 426 56 7832 (fax) (81) 426 56 7840 Korea: (tel) (080) 769 0800 (fax) (080) 769 0900 Latin America: (tel) (305) 269 7500 Taiwan: (tel) 0800 047 866 (fax) 0800 286 331 Other Asia Pacific Countries: (tel) (65) 6375 8100 (fax) (65) 6755 0042 Or visit Agilent World Wide Web at: www.agilent.com/find/assist Product specifications and descriptions in this document are subject to change without notice. Always refer to Agilent Web site for the latest revision.
Agilent Technologies, Inc., 2009 First Edition, June 22, 2009 U2702-90040

LabVIEW Programmers Reference

Uploaded by

LabVIEW Programmers Reference

Uploaded by

Agilent U2701A/U2702A USB Modular Oscilloscopes

IVI-COM Programmers Reference for NI LabVIEW

Manual Part Number

Restricted Rights Legend

U2701A/U2702A IVI-COM Programmers Reference

General Guidelines for Oscilloscope Programming

Side-by-Side SCPI and IVI-COM Comparison of the U2701A/U2702A Commands 6

Edge 43 Configure 43 Slope 46

U2701A/U2702A IVI-COM Programmers Reference

66 Configure 66 Event 69 LineNumber 71 SignalFormat 72 Type 75

Width 77 Condition 77 Configure 79 Polarity 82 ThresholdHigh 84 ThresholdLow 85 Clear 88 90

ConfigureServiceRequest Preset Register SerialPoll 92 94 96 98

U2701A/U2702A IVI-COM Programmers Reference

ResetWithDefaults SelfTest 112 114

NumberOfAverages RecordLength 135

U2701A/U2702A IVI-COM Programmers Reference

SampleMode SampleRate StartTime

TimePerRecord Type 147

AutoSetup Count Initiate 158 160

IsWaveformElementInvalid Item 164 FetchWaveform ReadWaveform 164 167

AutoSetup Count Initiate 176 178

U2701A/U2702A IVI-COM Programmers Reference

Enumeration Members 199 AgilentU2701AMathOperationEnum 199 AgilentU2701AMeasurementEnum 200 AgilentU2701ATimeOutEnum 203

ClearInterchangeWarnings DriverSetup 218

GetNextInterchangeWarning InterchangeCheck 223 225 227

InvalidateAllAttributes IoResourceDescriptor LogicalName 229

U2701A/U2702A IVI-COM Programmers Reference

QueryInstrumentStatus RangeCheck 233 235

ResetInterchangeCheck Simulate Description 239 241 243

GroupCapabilities Identifier 245

InstrumentFirmwareRevision InstrumentManufacturer InstrumentModel Revision 253 251 249

SpecificationMajorVersion SpecificationMinorVersion SupportedInstrumentModels Vendor 261 263

255 257 259

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A USB Modular Oscilloscope IVI-COM Programmers Reference for NI LabVIEW

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

General Guidelines for Oscilloscope Programming

U2701A/U2702A IVI-COM Programmers Reference

Side-by-Side SCPI and IVI-COM Comparison of the U2701A/U2702A Commands

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A USB Modular Oscilloscope IVI-COM Programmers Reference for NI LabVIEW

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

Range Offset Coupling

Double Double AgilentU2701A VerticalCoupling Enum Double Boolean

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

Volt/Div (Attenuation = 1x) 2 mV 5 mV 10 mV 20 mV 50 mV 100 mV 200 mV 500 mV 1V 2V 5V

Voltage range 16 mV 40 mV 80 mV 160 mV 400 mV 800 mV 1.6 V 4V 8V 16 V 40 V

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

U2701A/U2702A IVI-COM Programmers Reference

IdQuery Reset OptionString

Boolean Boolean String/BSTR