Teledyne Lecroy WaveAce 1000 Installation manual

WaveAce 1000/2000
Remote Control
Command Reference

700 Chestnut Ridge Road
Chestnut Ridge, NY, 10977-6499
Tel: [phone], Fax: [phone]
teledynelecroy.com
WaveAce 1000/2000 Remote Control Operator's Manual
© 2013 Teledyne LeCroy, Inc. All rights reserved.
WaveAce is a registered trademark of Teledyne LeCroy, Inc.
Teledyne LeCroy and other product or brand names are trademarks or requested trademarks of their respective
holders. Information in this publication supersedes all earlier versions. Specifications are subject to change
without notice.
920836 Rev B
September 2013

Operator's Manual
TABLE OF CONTENTS
Part I: Introduction to Remote Control........................................................................................................ 3
About This Manual ...................................................................................................................................3
About Remote Control .............................................................................................................................3
Remote Control Through USB ..................................................................................................................4
Remote Control Through LAN ..................................................................................................................5
Program Messages ...................................................................................................................................6
Response Messages..................................................................................................................................9
Using Status Registers ............................................................................................................................10
Commands and Queries by Subsystem..................................................................................................12
Commands and Queries by Name (Alphabetical) ..................................................................................15
Part II: Command Reference...................................................................................................................... 17
Command Notation................................................................................................................................17
ACQUISITION - *TRG...............................................................................................................................18
ACQUISITION - ARM_ACQUISITION, ARM ..............................................................................................18
ACQUISITION - AUTO_SETUP, ASET........................................................................................................18
ACQUISITION – ACQUIRE_WAY, ACQW .................................................................................................19
ACQUISITION - ATTENUATION, ATTN.....................................................................................................20
ACQUISITION - BANDWIDTH_LIMIT, BWL ..............................................................................................21
ACQUISITION - COUPLING, CPL ..............................................................................................................22
ACQUISITION - FORCE_TRIGGER, FRTR ..................................................................................................22
ACQUISITION - INTERLEAVED, ILVD........................................................................................................23
ACQUISITION - OFFSET, OFST .................................................................................................................24
ACQUISITION – PEAK DETECT, PDET.......................................................................................................25
ACQUISITION - STOP...............................................................................................................................25
ACQUISITION - TIME_DIV, TDIV..............................................................................................................26
ACQUISITION - TRIG_COUPLING, TRCP ..................................................................................................27
ACQUISITION - TRIG_DELAY, TRDL .........................................................................................................28
ACQUISITION - TRIG_LEVEL, TRLV ..........................................................................................................29
ACQUISITION - TRIG_MODE, TRMD .......................................................................................................30
ACQUISITION - TRIG_SELECT, TRSE ........................................................................................................31
ACQUISITION - TRIG_SLOPE, TRSL ..........................................................................................................32
ACQUISITION - VOLT_DIV, VDIV .............................................................................................................33
ACQUISITION - WAIT ..............................................................................................................................34
CURSOR - CURSOR_MEASURE, CRMS ....................................................................................................35
CURSOR - CURSOR_SET, CRST ................................................................................................................36
CURSOR - CURSOR_VALUE?, CRVA?.......................................................................................................37
CURSOR - PARAMETER_CUSTOM, PACU................................................................................................38
CURSOR - PARAMETER_VALUE?, PAVA? ................................................................................................40
DISPLAY - DOT_JOIN, DTJN .....................................................................................................................42
920836 Rev B i

WaveAce Remote Control
DISPLAY - HOR_MAGNIFY, HMAG ..........................................................................................................43
DISPLAY - HOR_POSITION, HPOS............................................................................................................44
DISPLAY - INTENSITY, INTS......................................................................................................................45
DISPLAY - PERSIST, PERS .........................................................................................................................45
DISPLAY - PERSIST_SETUP, PESU ............................................................................................................46
DISPLAY – SCREEN SAVE, SCSV ...............................................................................................................47
DISPLAY - TRACE, TRA.............................................................................................................................48
MISCELLANEOUS - *CAL? .......................................................................................................................49
MISCELLANEOUS - *IDN? .......................................................................................................................49
MISCELLANEOUS – AUTO-CALIBRATE, ACAL ..........................................................................................50
MISCELLANEOUS - BUZZER, BUZZ ..........................................................................................................50
MISCELLANEOUS - COMM_HEADER, CHDR ...........................................................................................51
MISCELLANEOUS - DEFINE, DEF .............................................................................................................52
MISCELLANEOUS - DELETE_FILE, DELF ...................................................................................................53
MISCELLANEOUS - DIRECTORY, DIR .......................................................................................................53
MISCELLANEOUS – FILENAME, FLNM.....................................................................................................54
SAVE/RECALL SETUP - *RCL....................................................................................................................55
SAVE/RECALL SETUP - *RST....................................................................................................................55
SAVE/RECALL SETUP - *SAV ...................................................................................................................56
SAVE/RECALL SETUP - RECALL_PANEL, RCPN.........................................................................................56
STATUS - *CLS.........................................................................................................................................57
STATUS - *ESE.........................................................................................................................................57
STATUS - *ESR?.......................................................................................................................................58
STATUS - *OPC........................................................................................................................................59
STATUS - ALL_STATUS?, ALST? ...............................................................................................................60
STATUS - CMR?.......................................................................................................................................61
STATUS - DDR? .......................................................................................................................................62
STATUS - EXR? ........................................................................................................................................63
STATUS - INR?.........................................................................................................................................65
WAVEFORM TRANSFER - STORE, STO ....................................................................................................66
WAVEFORM TRANSFER - WAVEFORM, WF............................................................................................66
WAVEFORM TRANSFER – WAVEFORM SETUP, WFSU ...........................................................................68
Appendix: Waveform Template ................................................................................................................ 69
Wave Descriptor Block WAVEDESC; Explanation ...................................................................................69
Oscilloscope's TMPL? Query Response ..................................................................................................85
Decoding Floating Point Numbers..........................................................................................................88
ii 920836 Rev B

Operator's Manual
Part I: Introduction to Remote Control
About This Manual
This manual includes a complete list of the command you’ll need to perform most WaveAce® 1000 and
2000 operations remotely.
Part I is an introduction to remote control and remote command syntax.
Part II lists all supported command headers with valid data parameters and values.
About Remote Control
WaveAce 1000 and 2000 series oscilloscopes can be controlled remotely through a USBTMC or TCP/IP
(LAN) interface. USB control is a standard feature on all WaveAce devices; TCP/IP control is standard on
WaveAce 2000 devices only.
Remote control is accomplished through the exchange of program messages between the oscilloscope
and a controller computer using the selected interface. The USBTMC interface utilizes standard IEEE
488.1 and IEEE 488.2 (GPIB) messages. The TCP/IP interface utilizes Teledyne LeCroy's VICP protocol,
which emulates IEEE 488.2 and includes standard operation bits in a header defined by the VICP
protocol.
All program messages exchanged between the scope and the controller must be formatted according
to these protocols.
See Program Messages (on page 6) for more information about constructing commands and queries
for control programs. The supported commands are listed in Commands and Queries by Subsystem
(on page 12) and Command and Queries by Name (Alphabetical) (on page 15), and are detailed in the
Command Reference section of this manual.
920836 Rev B 3

WaveAce Remote Control
Remote Control Through USB
The USB interface is standard on every WaveAce oscilloscope. The rear panel USB port is the remote
control interface.
1. Attach a USB A/B cable from the USB-B port on the rear panel of the scope to a USB-A port on the
controller computer.
2. Install NI-VISA on the controller machine. NI-VISA contains the USB drivers needed to form the
interface between the oscilloscope and the controller. NI-VISA can be downloaded free from
www.ni.com/visa. You may use either the NI-VISA run-time or the full download. The run-time
download is significantly smaller.
You can send remote commands to the oscilloscope directly from the WaveStudio® terminal.
WaveStudio can be downloaded free at teledynelecroy.com/support/softwaredownload, under
Oscilloscope Downloads -> Oscilloscope Software Utilities.
4 920836 Rev B

Operator's Manual
Remote Control Through LAN
WaveAce 2000 series oscilloscopes have a standard LAN connection port for remote control that
utilizes Teledyne LeCroy's VICP protocol for transmitting messages. This protocol emulates IEEE 488.2
(GPIB) and includes operation bits corresponding to SRQ, EOI, Clear, and others in a header that is
defined by the VICP protocol.
The WaveAce must be assigned a static IPv4 address for remote control; do not use an address from
the DHCP pool.
You can send remote commands to the oscilloscope directly from the WaveStudio® terminal.
WaveStudio can be downloaded free at teledynelecroy.com/support/softwaredownload, under
Oscilloscope Software Utilities.
On the Controller
For communication using the VICP (LAN) interface, no additional driver software is required when
using WaveStudio. For VICP communication with other applications that use the VISA standard, NI-VISA
must be installed, along with Teledyne LeCroy's 'VICP Passport'. The Passport extends VISA to support
Teledyne LeCroy's VICP protocol. The VICP passport may be downloaded from teledynelecroy.com.
Also see the application brief LAB_WM827 Understanding VICP and the VICP Passport on Teledyne
LeCroy's website for more information.
On the Instrument
1. Attach an Ethernet cable from the LAN port on the rear of the scope to an Ethernet port on the
controller machine or a connection device on the same network as the controller.
920836 Rev B 5

WaveAce Remote Control
2. From the WaveAce menu, choose Utility > IP Settings (on the third page of settings).
3. Enter an IP Address, Subnet Mask, and Gate Way. Enter values by selecting each segment and
turning the Adjust knob until the desired number is reached. Press the top soft key to jump to the
next field or press the Adjust knob to tab to the next segment of the current field. Leave DHCP
disabled.
Program Messages
Program messages are composed of commands or queries separated by semicolons and ending with a
terminator:
<command/query>; . . . . . ;<command/query> <terminator>
Command/Query Syntax
The general form of a command or a query is an optional header path, followed by a command header,
optionally followed by one or several parameters (shown as <data> in the following construct):
[header_path:]<header>[?] [<data>,...,<data>]
NOTE:
There is a space between the header and the first parameter.
Commas separate parameters.
The question mark [?] is optional and turns the command into a query.
The oscilloscope does not distinguish between upper- and lowercase characters. Commands/queries are shown
mixed-case in this manual to call out the short form within the long form.
6 920836 Rev B

Operator's Manual
Header path
Commands or queries that apply to a subsection of the oscilloscope, such as a single input channel,
must have their headers prefixed with a path name indicating the channel or trace recipient of the
command. It's recommended to always use header paths to minimize the risk of error if the command
order changes.
The header path normally consists of an abbreviated path name followed by a colon ( : ) immediately
preceding the command header.
C1:OFST -300 MV
The target waveform trace is specified using the following header path names:
Header Path Name Oscilloscope Reference
C1, C2
Channels 1 and 2
C3, C4
Channels 3 and 4 (on four-channel models)
M1,M2,M3,M4,M5,M6,M7,M8,M9,M10
Memory Units 1 through 10
TA, TB, TC, TD FFT of the corresponding Channel 1-4; in some commands
also used to refer to zooms.
EX, EX5 External trigger
LINE
LINE source for trigger
NOTE: Header paths TA-TD are used only to refer to the FFT of the channel, or in some cases to expanded traces
(zooms).
Header paths need only be specified once until the path changes. Subsequent commands without
header paths are assumed to refer to the most recently defined path:
C2:VDIV?;C2:OFST? is equivalent to C2:VDIV?;OFST?
Header
The header is the mnemonic form of the operation to be performed by the oscilloscope. Most headers
have a more easily recognized long form and a short form for better transfer and decoding speed. The
two can be used interchangeably:
TRIG_MODE AUTO is equivalent to TRMD AUTO
Some command or query mnemonics are imposed by the IEEE 488.2 standard. All these mnemonics
begin with an asterisk *.
920836 Rev B 7

WaveAce Remote Control
Data Parameters
When a command uses additional data values, they are expressed as ASCII data that can take the form
of character, numeric, string, or block data. Macro parameters are not implemented.
An exception is the transfer of waveforms with the WAVEFORM command/query, where the waveform
is expressed as a sequence of binary data values.
Character Data
These are simple alphanumeric words or abbreviations indicating a specific action.
In commands where you can specify many parameters, or where not all parameters are applicable at
the same time, the format requires pairs of character data values. The first value names the parameter
to be modified, while the second gives its value.
HARDCOPY_SETUP DEST,PRINTER,PRINTER,EPSON
Here, two pairs are shown: the first specifies the DESTination is a PRINTER, while the second specifies
the PRINTER is EPSON. Any HARDCOPY_SETUP parameters that are not relevant for printers, or are left
unchanged, are omitted from the command.
Numeric Data
The numeric data type is used to enter quantitative information. Numbers can be entered as integers,
fractions, or exponents:
C1:VPOS -5
C2:OFST 3.56
TDIV 5.0E-6
Numeric values can be followed with multipliers and units modifying the value of the numeric
expression. The following table of mnemonics is recognized:
Multiplier Exponential Notation Suffix
EX
1E18
Exa-
T
1E12
Tera-
MA
1E6
Mega-
M
1E-3
milli-
N
1E-9
nano-
F
1E-15
femto-
PE
1E15
Peta-
G
1E9
Giga-
K
1E3
kilo-
U
1E-6
micro-
8 920836 Rev B