MAUI Oscilloscopes Remote Control and Automation Manual
Total Page：16
File Type：pdf, Size：1020Kb
Oscilloscopes Remote Control and Automation Manual © 2020 Teledyne LeCroy, Inc. All rights reserved. Unauthorized duplication of Teledyne LeCroy documentation materials is strictly prohibited. Customers are permitted to duplicate and distribute Teledyne LeCroy documentation for their own internal educational purposes. Teledyne LeCroy is a trademark of Teledyne LeCroy, Inc. Other product or brand names are trademarks or requested trademarks of their respective holders. Information in this publication supersedes all earlier versions. Specifications are subject to change without notice. maui-remote-control-automation_10mar20.pdf March 2020 Introduction Introduction This manual documents the requirements for remote control of Teledyne LeCroy's MAUI™ oscilloscopes using either traditional IEEE 488.2 (GPIB) commands or Windows® Component Object Model (COM) Automation commands. The manual is divided into the following sections: Part 1: Making the Remote Connection describes all the methods for gaining access to a MAUI oscilloscope (device) from a remote computer (controller). It details the software and hardware requirements for each method. Part 2: Automation Programming Reference describes the MAUI COM architecture and explains how to use Automation to control the oscilloscope remotely using manual methods or remote control programs. Part 3: Automation Control Variable Reference details the MAUI COM architecture for configuring and controlling the oscilloscope. It is most useful for developers of remote control applications. Part 4: Automation Result Interface Reference details the MAUI COM architecture for reading back data from the oscilloscope. It is most useful for developers of remote control applications. Part 5: IEEE 488.2 Programming Reference describes the LeCroy legacy remote control implementation and provides an overview of GPIB programming conventions. It also provides information for understanding MAUI waveform transfer and the waveform template. Part 6: IEEE 488.2 Command Reference details the legacy remote control commands supported by MAUI oscilloscopes. i MAUI Oscilloscopes Remote Control and Automation Manual Resources Teledyne LeCroy provides many free resources to help you receive the greatest value from your instrument. Most of the software and documentation mentioned in this manual can be downloaded from our website; links are provided to other sites where relevant. In addition, many manuals and code examples for further reference are installed when you install our software. Software Download software from: teledynelecroy.com/ support/ softwaredownload. Under Oscilloscope Downloads, click the link to Software Utilities and browse the list of tools. Manuals Download manuals, application notes, and lab briefs from: teledynelecroy.com/ support/ techlib. Use the sidebar at the left of the page to select the document category, then browse the list of links. Technical Support Registered users can contact their local Teledyne LeCroy service center at the number listed on our website. You can also submit Technical Support requests via the website at: teledynelecroy.com/ support/ techhelp Select the oscilloscope model you are using and the category into which your question falls. ii Notational Conventions Notational Conventions Notational Symbols Commands shown in this reference make use of the following notational symbols: Symbol Function Example < > Encloses header paths or placeholders <channel>:VOLT_DIV <v_gain> := Separates a placeholder from a description of the type <v_gain> := 5.0 mV to 2.5 V and range of values that may replace it { } Encloses required values, one of which must be used TRMD {SINGLE, AUTO, NORM, STOP} in the command [ ] Encloses optional values … Indicates the items to its left or right can be repeated any number of times Sources The character n is used to denote the greatest number of an oscilloscope object, such as input channels or math function traces, supported by your instrument. On a two-channel oscilloscope, C1 through Cn should be taken to mean C1 and C2, whereas on an eight-channel oscilloscope, C1 through C8, and so forth. The following mnemonics may be used where <source> is indicated in commands. Note: These are the sources supported by legacy commands. Other sources may be available with the addition of software options (Views, Streams, Histograms, etc.), depending on the operation. Use XStreamBrowser to check the application Automation object hierarchy. Object Mnemonic Note Analog Channels C1, C2, C3, C4,....Cn Sensor Channels SE1,....SEn Digital Groups Digital1,....Digital4 Math Functions F1,....Fn, Math trace names TA, TB, TC, and TD used on legacy LeCroy TA, TB, TC, TD instruments have been replaced by F1, F2, F3 and F4, respectively. Existing programs that utilize the old trace names will work with MAUI oscilloscopes, but these mne- monics are not returned in query responses. Instead, the query will return the corresponding F1, F2, F3, and F4. User-Defined Parameters P1,....Pn Parameter names CUST1 through CUST5 used on legacy CUST1,...CUST5 LeCroy instruments have been replaced by P1, etc. As with math traces, these mnemonics may be used in programs but are not returned by queries. Memories M1,...Mn Zooms Z1,....Zn iii MAUI Oscilloscopes Remote Control and Automation Manual Units Numeric values can be expressed in code as numeric fixed point or exponential. However, only the fixed point value is displayed in tables and on descriptor boxes. Note: This manual reflects the units supported in MAUI XStreamDSO software v.8.5.0.0 and later. Many, but not all, of the units listed here are supported in earlier versions of XStreamDSO. Table of Mnemonics Units may be expressed using the following mnemonics. Note: Specify only the base unit in code, do not add prefixes. Units are automatically scaled up or down within the list of standard, SI prefixes (atto to Exa) based on the relative size of the source signal(s). For example a 1000 V reading is shown as 1 kV, while a .1 V reading is shown as 100 mV. When the multiplication factor is 1 V = 1 Pascal, a 1 millivolt (mV) reading is displayed as 1 mPa rather than .001 Pa or 100e-3 Pa. Note: Time and Dimensionless units are available only for certain measurements and acquisition commands. Category Unit Mnemonic Mass gram G slug SLUG Volume liter L cubic meter M3 cubic inch IN3 cubic foot FT3 cubic yard YARD3 Angle radian RAD arcdegree DEG arcminute MNT arcsecond SEC cycle CYCLE revolution REV turn TURN iv Notational Conventions Category Unit Mnemonic Force/ Weight Newton N grain GR ounce OZ pound LB Velocity meter/ second M/ S inch/ second IN/ S foot/ second FT/ S yard/ second YARD/ S mile/ second MILE/S Acceleration meter/ second2 M/S2 inch/ second2 IN/ S2 foot/ second2 FT/ S2 standard gravity GN Pressure Pascal PAL bar BAR atmosphere, technical AT atmosphere, standard ATM Torr TORR pound/square inch PSI Temperature degree Kelvin K degree Celsius CEL degree Fahrenheit FAR Energy Joule J British Thermal Unit BTU calorie CAL v MAUI Oscilloscopes Remote Control and Automation Manual Category Unit Mnemonic Rotating Machine radian/ second RADPS frequency (Hertz) HZ revolution/ second RPS revolution/minute RPM torque N•m NM torque in•oz INOZ torque in•lb INLB torque ft•lb FTLB power, mechanical (Watt) W horsepower HP Magnetic Weber WB Tesla T inductance (Henry) H magnetic field strength A/M permeability HENRYPM Electrical Ampere A Volt V Watt W power, apparent VA power, reactive VAR power factor PF capacitance (Farad) F Coulomb C Ohm OHM Siemen SIE electrical field strength V/M electrical displacement field CPM2 permittivity FARADPM conductivity SIEPM Time second S minute MIN hour HOUR day DAY week WEEK vi Notational Conventions Category Unit Mnemonic Dimensionless percent PCT percent min-max PCTMNMX decibel DB decibel milliwatt DBM decibel Volt DBV decibel millivolt DBMV decibel microvolt DBUV decibel microampere DBUA decibel referred to carrier DBC decade DECADE unit interval UI Q-scale Q bit BIT byte BYTE baud BAUD least significant bit LSB poise POISE parts per million PPM pixel PIXEL division DIV event EVENT sample SAMPLE segment SEG sweep SWEEP Combining Units SI units may be combined following these rules: l For the quotient of two units, use the character " / " l For the product of two units, use the character " . " l For exponents, append the digit to the unit with no space (e.g., " S2 " for seconds squared). Note: Some units are converted to simple units (e.g., " V.A " becomes " W "). vii MAUI Oscilloscopes Remote Control and Automation Manual viii Part 1: Making the Remote Connection Part 1: Making the Remote Connection You can fully control your instrument remotely using either: l COM Automation commands l IEEE 488.2 General Purpose Interface Bus (GPIB) commands The remote connection can be made over a variety of physical interfaces such as ENET, GPIB, LSIB, or USBTMC, using several interface drivers and protocols. This section describes the software tools for remote control and procedures for making the remote connection from a controller to an oscilloscope. Understanding Remote Control Layers 1-2 Software Tools for Remote Control 1-3 Connecting via ENET 1-5 Connecting via USBTMC 1-10 Connecting via GPIB 1-11 Connecting via LSIB 1-12 Configuring DCOM Connections 1-13 Testing the Remote Connection 1-31 Remote Control Assistant 1-32 ActiveDSO 1-33 VISA 1-36 WaveStudio 1-39 1-1 MAUI Oscilloscopes Remote Control and Automation Manual Understanding Remote Control Layers It is helpful to understand some high-level concepts regarding how the oscilloscope is operated through remote control and the terminology employed throughout this section. From bottom to top, the components interact in the following manner: The cable is the physical conduit between the controller (usually a PC) and the oscilloscope, connected on either end to the hardware interface. Interfaces vary based on oscilloscope model and include ENET (often labeled LAN on the oscilloscope), USBTMC, GPIB, and LSIB. Depending on the interface selected, you may require a PC adapter in order to connect the cable. This is particularly true for LSIB and GPIB.