RIGOL is a registered trademark of RIGOL (SUZHOU) TECHNOLOGIES INC.
Publication Number
PGA27100-1110
Software Version
00.06.01
Software upgrade might change or add product features. Please acquire the latest version of the manual
from RIGOL website or contact RIGOL to upgrade the software.
Notices
RIGOL products are covered by P.R.C. and foreign patents, issued and pending.
RIGOL reserves the right to modify or change parts of or all the specifications and pricing policies at
the co mpany ’s sole decision.
Information in this publication replaces all previously released materials.
Information in this publication is subject to change without notice.
RIGOL shall not be liable for either incidental or consequential losses in connection with the furnishing,
use, or performance of this manual, as well as any information contained.
Any part of this document is forbidden to be copied, photocopied, or rearranged without prior written
approval of RIGOL.
Product Certification
RIGOL guarantees that this product conforms to the national and industrial standards in China as well as
the ISO9001:2015 standard a nd the ISO14001:2015 standard. Other international standard conformance
certifications are in progress.
Contact Us
If you have any problem or requirement when using our products or this manual, please contact RIGOL.
E-mail: service@rigol.com
Website: www.rigol.com
DS1000Z-E Programming Guide I
RIGOL
Tip
For the newest version of this manual, please download it from RIGOL official website (www.rigol.com).
Model
Analog Bandwidth
Number of Analog Channels
DS1202Z-E
200 MHz
2
Document Overview
This manual provides guidance on how to use the SC PI commands in programming to realize remote
control of RIGOL DS1000Z-E series digital oscilloscope through the remote interface. DS1000Z-E can
communicate with a PC through the USB or the LAN bus.
Main Topics in this Manual:
Chapter 1 Programming Overview
This chapter introduces how to build the remote communication between DS1000Z-E series digital
oscilloscope and the PC. It also introduce s the remote control methods as well as the syntax, symbols,
parameters and abbreviation rules of the SCPI commands.
Chapter 2 Command System
This chapter introduces the syntax, function, parameter and us ing instruction of each command.
Chapter 3 Programming Demos
This chapter lists some programming demos to illustrate how to use comm ands to realize the common
functions of the oscilloscope in the development environments of Excel, Matlab, LabVIEW, Visual Basic 6.0
and Visual C++ 6.0.
Format Conventions in this Manual:
1. Key
The function key on the front panel is denoted by the format of "Key Name (Bold) + Text Box" in the
manual. For example, Utility denotes the "Utility" key on the front panel.
2. Menu
The menu item is denoted by the format of "Menu Word (Bold) + Character Shading" in the manual.
For example, System denotes the "System" item under Utility.
3. Operation Step
The next step of the operation is denoted by an arrow "" in the manual. For example, Utility
System denotes that f irst press Utility on the front panel and then press System.
Content Conventions in this Manual:
DS1000Z-E series includes the following models. Unless otherwise noted, this manual takes DS1202Z-E as
an example to illustrate the command system of DS1000Z-E series.
II DS1000Z-E Programming Guide
Contents RIGOL
Contents
Guaranty and Declaration ......................................................................................................... I
Document Overview ................................................................................................................. II
Visual C++ Programming Demo .............................................................................................. 3-15
DS1000Z-E Programming Guide VII
Chapter 1 Programming Overview RIGOL
Chapter 1 Programming Overview
This chapter introduces how to build the remote communication between DS1000Z-E series digital
oscilloscope and the PC. It also introduces the remote control methods as well as the syntax, symbols,
parameters and abbreviation rules of the SCPI commands.
Main topics of this chapter:
To Build Remote Communication
Remote Control Methods
SCPI Command Overview
DS1000Z-E Programming Guide 1-1
RIGOL Chapter 1 Programming Overview
1
2
To Build Remote Communication
This oscilloscope can communicate with a PC through the USB or the LAN bus. This section introduces how
to control the oscilloscope remotely through the USB interface using Ultra Sigma in details.
Operation Steps:
1. Install the Ultra Sigma common PC software
Download the Ultra Sigma common PC software from RIGOL official website (www.rigol.com) and
install it according to the instructions.
2. Connect the instrument and PC and configure the interface parameters of the instrument
DS1000Z-E can communicate with a PC through the USB or the LAN bus. This manual takes the USB
interface as an example.
(1) Connect the devices
Connect the USB Device interface at the r eal pan el of the osc illoscope an d the U SB Host in terf ace
of the PC using a USB ca bl e .
(2) Install the USB driver
This oscilloscope is a USB-TMC device. After you connect the oscilloscope to the PC and turn both
on for the first time (the oscilloscope is automatically configured to the USB interface; at the same
time, make sure that Utility IO Setting USB Device is set to "Computer"), the Found New Hardware Wizard as shown in the figure below is displayed on the PC. Please install the
"USB Test and Measurement D evice (IVI)" driver following the directions in the wizard. The steps
are as follows.
1-2 DS1000Z-E Programming Guide
Chapter 1 Programming Overview RIGOL
3 4 5
6
DS1000Z-E Programming Guide 1-3
RIGOL Chapter 1 Programming Overview
7
(3) Search for device resource
Start up the Ultra Sigma and the software will automatically search for the instrument resources
currently connected to the PC. You can also click
(4) View the device resources
The resources found will appear under the "RIGOL Online Resource" directory and the model
number and USB interface information of the instrument will also be displayed.
For example, DS1202Z-E (USB0::0x1AB1::0x04CE::DS1ZD170800001::INSTR).
(5) Control the instrument remotely
Right click the resour ce n ame "DS1202Z-E (USB0::0x1AB1::0x04CE::DS1ZD170800001::INSTR)"
and select "SCPI Panel Control" to turn on the remote command control panel through which you
can send commands and read data.
to search for the resources.
Remote Control Methods
1. User-defined Programming
Users can use SCPI (Standard Commands for Programmable Instruments) commands to program and
control the oscilloscope. For details, refer to the introductions in "Chapter 3 Programming Demos".
2. Send SCPI Commands via PC Software
You can control the oscilloscope remotely by sending SCPI commands via PC software. Ultra Sigma
provided by RIGOL is recommended
.
1-4 DS1000Z-E Programming Guide
Chapter 1 Programming Overview RIGOL
SCPI Command Overview
SCPI (Standard Comm ands for Programmable Instruments) is a standardized instrument programming
language that is built upon the standard IEEE 488.1 and IEEE 488.2 and conforms to various standards
(such as the float ing point operation rule in IEEE 754 standard, ISO 646 7-bit coded character for
information intercha nge (equivalent to ASCII programming)). The SCPI commands provide a hierarchical
tree structure and consist of multiple subsystems. Each com mand subsystem consists of a root keyword
and one or more sub-keywords.
Syntax
The command string usually starts with ":"; the keywords are separated by ":" and are followed by the
parameter settings available; "?" is added at the end of the command string to indicate query; the
command keywords and the first parameter are separated by space.
For example,
:ACQuire:TYPE <type>
:ACQuire:TYPE?
ACQuire is the root keyword of the command. TYPE is the second-level keyword. The command string starts
with ":" which is also used t o separate the multiple-level keywords. <type> represents the parameters
available for setting. "?" represents query. The command keywords :ACQuire:TYPE and parameter <type>
are separated by a space.
"," is generally used for separating multiple parameters contained in the same command, for example,
[:TRACe[<n>]]:DATA:VALue volatile,<points>,<data>
Symbol Description
The following symbols will not be sent with the commands.
1.Braces {}
The parameters enclosed in the braces are optional and are usually separated by the vertical bar "|".
When using the command, one of the parameters must be selected.
2.Vertical Bar |
The vertical bar is used to separate multiple parameters and one of the parameters must be selected
when using the command.
3.Square Brackets []
The content in the square brackets can be omitted.
4.Triangle Brackets <>
The parameter enclosed in the triangle brackets must be replaced by an effective value.
Parameter Type
1. Bool
The parameter could be ON, OFF, 1, or 0. For example,
:MEASure:ADISplay <bool >
:MEASure:ADISplay?
Wherein,
<bool> can be set to {{1|ON}|{0|OFF}}.
The query returns 1 or 0.
DS1000Z-E Programming Guide 1-5
RIGOL Chapter 1 Programming Overview
2. Discrete
The parameter could be any of the values listed. For example,
:ACQuire:TYPE <type>
:ACQuire:TYPE?
Wherein,
<type> can be set to NORMal|AVERages|PEAK|HRESolution.
The query returns the abbreviations (NORM, AVER, PEAK, or HRES).
3. Integer
Unless otherwise noted, the parameter can be any integer (NR1 format) within the effective value
range. Note that do not set the parameter to a decimal, otherwise errors will occur. For example,
:DISPlay:GBRightne ss <br i ghtne ss >
:DISPlay:GBRightness?
Wherein,
<brightness> can be set to any integer between 0 and 100.
The query returns an integer between 0 and 100.
4. Real
The parameter can be any real number within the effective value range and this command accepts
decimal (NR2 format) and scientific notation (NR3 format) parameter input. For example,
:TRIGger:TIMeout:TIMe <NR3>
:TRIGger:TIMeout:TIMe?
Wherein,
<NR3> can be set to any real number between 1.6e-08 (namely 16ns) to 1e+01 (namely 10s).
The query returns a real number in scientific notation.
5. ASCII String
The parameter should be the combinations of ASCII characters.
For example,
:SYSTem:OPTion:INSTall <license>
Wherein,
<license> can be set to PDUY9N9QTS9PQSWPLAETRD3UJHYA.
Command Abb r eviation
All the commands are case-insensitive and you can use any of them. If abbreviation is used, all the capital
letters in the command must be written completely. For example,
:MEASure:ADISplay? can be abbreviated to :MEAS:ADIS?.
1-6 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
Chapter 2 Command System
This chapter introduces the syntax, function, parameter, and using instruction of each DS1000Z-E
command.
1. Unless otherwise noted, this manual takes DS1202Z-E as an example to introduce the commands.
2. For parameter setting commands (for example, the time, frequency, and amplitude), the oscilloscope
can only accept numbers and set the parameters using the default units; it cannot recognize the units
sent with the parameters. For the def ault unit of each par ameter, please refer to the descri ption in each
command in the following introductions.
DS1000Z-E Programming Guide 2-1
RIGOL Chapter 2 Command System
Syntax
:AUToscale
on the front panel.
recorded waveform, this command is invalid.
Syntax
:CLEar
panel.
Command
:STOP
front panel.
waveform, these commands are invalid.
:AUToscale
Description Enable the waveform auto setting function. The oscilloscope will automatically adjust the
vertical scale, horizontal timebase, and trigger mode according to the input signal to
realize optimum waveform display . This command is equivalent to pressing the AUTO key
Explanation Theoretically, wav eform auto setting function requires that the frequency of sine is no
lower than 41Hz; the duty cycle should be greater than 1% and the amplitude must
be at least 20mVpp for square (the probe ratio is 1X).
When the pass/fail function is enabled (see the
this command, the oscilloscope will disable the pass/fail function firstly and then
execute the waveform auto setting function.
When the waveform record function is enabled or during the playback of the
:MASK:ENABle command), if you sent
:CLEar
Description Clear all the waveforms on the screen. If the oscilloscope is in the RUN state, waveform
will still be displayed. This command is equivalent to pressing the CLEAR key on the front
Related
:DISPlay:CLEar
:RUN
:STOP
Syntax :RUN
Description The :RUN command starts the oscilloscope and the :STOP command stops the
oscilloscope. These commands are equivalent to pressing the RUN/STOP key on the
Explanation When the waveform record function is ena bled or during the playback of the recorded
2-2 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
Syntax
:SINGle
the :TRIGger:SWEep SINGle command.
recorded waveform, this command is invalid.
:STOP
Syntax
:TFORce
the FORCE key in the trigger control area on the front panel.
:SINGle
Description Set the oscilloscope to the single trigger mode. This command is equivalent to any of the
following two operations: pressing the SINGLE key on the front panel and sending
Explanation In the single trigger mode, the oscilloscope triggers once when the trigger conditions
are met and then stops.
When the waveform record function is enabled or during the playback of the
Related
Commands
:TFORce
:RUN
:TFORce
Description Generate a trigger signal forcefully. This command is only applicable to the normal and
single trigger modes (see the
:TRIGger:SWEep command) and is equivalent to pressing
DS1000Z-E Programming Guide 2-3
RIGOL Chapter 2 Command System
:ACQuire:AVERages?
Description
Set or query the number of averages under the average acquisition mode.
Name
Type
Range
Default
waveform to the waveform changes.
Format
:ACQuire:AVERages? /*The query returns 128*/
:ACQuire Commands
The :ACQuire commands are used to set and query the memory depth, acquisition mode and the number of
averages as well as query the current sample rate of the oscilloscope.
not included and you can refer to the complete introductions of the commands in the text according to the keywords.
: In the "Command List" in this manual, the parameters in the setting commands and the query commands are
:ACQuire:AVERages
Syntax :ACQuire:AVERages <c ount>
[1]
:
Parameter
<count> Integer 2n (n is an integer from 1 to 10) 2
Explanation You can se nd the :ACQuire:TYPE command to set the acquisition mode.
In the average acquisition mode, greater number of averages can lower the noise
and increase the vertical resolution, but will also slow the response of the displayed
Return
Example
The query returns an integer between 2 and 1024.
:ACQuire:AVERages 12 8 /*Set the number of averages to 128*/
2-4 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:ACQuire:MDEPth?
points that can be stored in a single trigger sample). The default unit is pts (points).
Name
Type
Range
Default
according to the current sample rate.
Format
Command
:ACQuire:TYPE?
Description
Set or query the acquisition mode of the oscilloscope.
Name
Type
Range
Default
HRESolution (High Resolution): this mode uses a kind of ultra-sample technique to
:ACQuire:MDEPth
Syntax :ACQuire:MDEPth <mdep>
Description Set or query the memory depth of the oscilloscope (namely the number of waveform
Parameter
Explanation
<mdep>
When a single channel is enabled, the range of <mdep> is {AUTO|12000|
Discrete Refer to Explanation
120000|1200000|12000000|24000000}.
When dual channels are enabled, the range of <mdep> is {AUTO|6000|60000|
600000|6000000|12000000}.
The following equation des cribes the relationship among memory depth, sample
rate, and waveform length:
Memory Depth = Sample Rate x Waveform Length
Wherein, the Waveform Length is the product of the horizontal timebase (set by
:TIMebase[:MAIN]:SCALe command) times the number of grids in the horizontal
the
direction on the screen (12 for DS1000Z-E).
When AUTO is selected, the oscilloscope will select the memory depth automatically
Return
The query returns the actual number of points (integer) or AUTO.
Example :ACQuire:MDEPth 12000 /*Set the memory depth to 12000pts*/
:ACQuire:MDEPth? /*The query returns 12000*/
Related
:ACQuire:SRATe?
:ACQuire:TYPE
AUTO
Syntax :ACQuire:TYPE <type>
Parameter
Explanation
<type>
NORMal
Discrete
: in this mode, the oscilloscope samples the signal at equa l time interval to
{NORMal|AVERages|PEAK|HRESolution}
NORMal
rebuild the waveform. For most of the waveforms, the best display effect can be
obtained using this mode.
AVERages: in
this mode, the oscilloscope averages the waveforms from multiple
samples to reduce the random noise of the input signal and improve the vertical
resolution. The number of aver ages c an be set b y the
:ACQuire:AVERages command.
Greater number of av erages can lower the noise and increase the vertical resolution,
but will also slow the response of the displayed waveform to the waveform changes.
PEAK (Peak Detect): in this mode, the oscilloscope acquires the maximum and
minimum values of the signal within the sample interval to get the envelope of the
signal or the narrow pulse of the signal that might be lost. In this mode, signal
confusion can be prevented but the noise displayed would be larger.
DS1000Z-E Programming Guide 2-5
RIGOL Chapter 2 Command System
average the neighboring points of the sample waveform to reduce the random noise
storage rate of the acquisition memory.
Format
:ACQuire:TYPE? /*The query returns AVER*/
Syntax
:ACQuire:SRATe?
Description
Query the current sample rate. The default unit is Sa/s.
on the input signal and generate much smoother waveforms on the screen. This is
generally used when the sample rate of the digital converter is higher than the
Return
Example
The query returns NORM, AVER, PEAK, or HRES.
:ACQuire:TYPE AVERages /*Select the average acquisition mode*/
:ACQuire:SRATe?
Explanation Sample rate is the sample frequency of th e oscilloscope, namely the wav eform points
sampled per second.
The foll owing equation describes the relationship among memory depth, sample
rate, and waveform length:
Memory Depth = Sample Rate x Waveform Length
:ACQuire:MDEPth command, and
Return
Wherein, the Memory Depth can be set us ing the
the Waveform Length is the product of the horizontal timebase (set by
:TIMebase[:MAIN]:SCALecommand) times the number of the horizontal scales
the
The query returns the sample rate in scientific nota tion.
2-6 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
Syntax
:CALibrate:QUIT
Description
Exit the self-calibration at any time.
Command
Syntax
:CALibrate:STARt
send the :CALibrate:QUIT command to quit the self-calibration.
:CALibrate Commands
Command List:
:CALibrate:QUIT
:CALibrate:STARt
:CALibrate:QUIT
Related
:CALibrate:STARt
:CALibrate:STARt
Description The oscilloscope starts to execute self-calibration.
Explanation The self-calibration operation can make the oscillos c ope quickly rea c h its optimum
working state to obtain the most accurate measurement values.
During the self-calibration, all the channels of the oscilloscope must be disconnected
from the inputs.
The functions of most of the keys are disabled during the self-calibration. You can
DS1000Z-E Programming Guide 2-7
RIGOL Chapter 2 Command System
:CHANnel<n>:BWLimit?
Description
Set or query the bandwidth limit p arameter of the specified channel .
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
Discrete
OFF
frequency components .
Format
:CHANnel1:BWLimit? /*The query returns 20M*/
:CHANnel<n> Commands
The :CHANnel<n> commands are used to set or query the vertical system parameters of the analog
channels, such as the bandwidth limit, coupling, vertical scale, and vertical offset.
Explanation OFF: disable the bandwidth limit and the high frequency components of the signal
under test can pass the channel.
20M: enable the bandwidth limit and the high frequency components of the signal
under test that exceed 20 MHz are attenuated.
Enabling the bandwidth li mit can reduce the noise, but can also attenuate the high
Return
Example
The query returns 20M or OFF.
:CHANnel1:BWLimit 20M /*Enable the 20MHz bandwidth limit*/
2-8 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:CHANnel<n>:COUPling?
Description
Set or query the coupling mode of the specified channel.
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
<coupling>
Discrete
{AC|DC|GND}
DC
GND:the DC and AC components of the signal under test are both blocked.
Format
:CHANnel1:COUPling? /*The query returns AC*/
:CHANnel<n>:DISPlay?
Description
Enable or disable the specified channel or query the status of the specified channel.
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
CH2: 0|OFF
Format
:CHANnel1:DISPlay? /*The query returns 1*/
:CHANnel<n>:COUPling
Syntax :CHANnel<n>:COUPling <coupling>
Parameter
Explanation AC: the DC components of the signal under test are blocked.
DC:t he DC and AC components of the signal under test can both pass the channel.
Return
Example
The query returns AC, DC, or GND.
:CHANnel1:COUPling AC /*Select the AC coupling mode*/
:CHANnel<n>:DISPlay
Syntax :CHANnel<n>:DISPlay <bool>
Parameter
<bool> Bool {{1|ON}|{0|OFF}}
Return
Example
The query returns 1 or 0.
:CHANnel1:DISPlay ON /*Enable CH1*/
CH1: 1|ON
DS1000Z-E Programming Guide 2-9
RIGOL Chapter 2 Command System
:CHANnel<n>:INVert?
waveform invert of the specified channel.
Name
Type
Range
Default
<bool>
Bool
{{1|ON}|{0|OFF}}
0|OFF
invert is turned on, the waveform voltage values are inverted.
Format
:CHANnel1:INVert? /*The query returns 1*/
:CHANnel<n>:OFFSet?
Description
Set or query the vertical offset of the specified channel. The default unit is V.
Description Enable or disable the waveform invert of the specified channe l or query the status of the
Parameter
<n> Discrete {1|2} --
Explanation When waveform invert is turned off, the waveform display is normal; when waveform
Return
Example
The query returns 1 or 0.
:CHANnel1:INVert ON /*Enable the waveform invert of CH1*/
:CHANnel<n>:OFFSet
Syntax :CHANnel<n>:OFFSet <offset>
Parameter
<offset> Real
Related to the current vertical scale and
probe ratio
When the probe ratio is 1X,
vertical scale≥500mV/div: -100V to +100V
vertical scale<500mV/div: -2V to +2V
When the probe ratio is 10X,
vertical scale≥5V/div: -1000V to +1000V
0V (the probe
ratio is 10X)
Return
Example
The query returns the vertical offset in scientific notation.
:CHANnel1:OFFSet 0.01 /*Set the vertical offset of CH1 to 10mV*/
2-10 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:CHANnel<n>:RANGe?
Description
Set or query the vertical range of the specified channel. The default unit is V.
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
When the probe ratio is 10X: 80mV to 800V
= Vertical Range/8). The vertical scale can be set by the :CHANnel<n>:SCALe command.
Description S et or query the dela y calibration time of the spec ified channel to calibrate the zero of fset
Parameter
<val> Real -100ns to 100ns 0.00s
Explanation <val> can only be set to the specific values in the specified step. If the pa rame ter you
sent is not one of the specific values, the parameter will be set to the nearest spe cific
values automatically. The step varies with the horizontal timebase (set by
:TIMebase[:MAIN]:SCALe command), as shown in the table below.
the
Return
Example
Note: When the horizontal timebase is equal to or greater than 10μs, the delay
The query returns t he delay calibration time in scientific notation.
:CHANnel1:TCAL 0.00000002 /*Set the delay calibration time to 20ns*/
2-12 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:CHANnel<n>:SCALe?
Description
Set or query the vertical scale of the specified channel. The default unit is V.
When the probe ratio is 1X: 1mV to 10V
When the probe ratio is 10X (default): 10mV to
Explanation The range of the vertical scale is related to the current probe ratio (set by
:CHANnel<n>:PROBe command).
the
1V (the probe
ratio is 10X)
You can use the
adjustment of the vertical scale. By default, the fine adjustment is off. At this point,
you can only set the vertical scale in 1-2-5 step, namely 10mV, 20mV, 50mV,
100mV, …, 100V (the probe ratio is 10X). When the fine adjustment is on, you ca n
further adjust the vertical scale within a relatively smaller range to improve the
vertical resolution. If the amplitude of the input waveform is a little bit greater than
the full scale under the current scale and the amplitude would be a little bit lower if
the next scale is used, fine adjustment can be used to improve the display amplitude
Return
Example
The query returns the vertical scale in scientific notation.
:CHANnel1:SCALe 1 /*Set the vertic al scale of CH1 to 1V*/
:CHANnel<n>:PROBe
Syntax :CHANnel<n>:PROBe <atten>
Parameter
<n> Discrete {1|2} --
:CHANnel<n>:VERNier command to enable or disable the fine
<atten> Discrete
{0.01|0.02|0.05|0.1|0.2|0.5|1|2|5|10|20|50|
Explanation Setting the probe ratio refers to multiply the signal sampled with the specified ratio
and then display the result (the actual amplitude of the signal will not be affected).
Return
Example
Related
DS1000Z-E Programming Guide 2-13
The query returns the probe ratio in scientific notation.
:CHANnel1:PROBe 10 /*Set the probe ratio of CH1 to 10X*/
:CHANnel<n>:SCALe
10
RIGOL Chapter 2 Command System
:CHANnel<n>:UNITs?
Description
Set or query the amplitude display unit of the specified channel.
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
Format
:CHANnel1:UNITs? /*The query returns VOLT*/
:CHANnel<n>:VERNier?
query the fine adjustment status of the vertical scale of the specified channel.
Name
Type
Range
Default
amplitude of the waveform to view the signal details.
Format
:CHANnel1:VERNier? /*The query returns 1*/
Command
:CHANnel<n>:UNITs
Syntax :CHA N ne l< n >: UNI Ts <un it s >
Parameter
<units> Discrete {VOLTage|WATT|AMPere|UNKNown} VOLTage
Return
Example
The query returns VOLT, WATT, AMP, or UNKN.
:CHANnel1:UNITs VOLTage /*Set the amplitude display unit of CH1 to V*/
:CHANnel<n>:VERNier
Syntax :CHANnel<n>:VERNier <bool>
Description Enable or disable the fine adjustment of the vertical scale of the specified channel, or
Explanation By default, the fine adjustment is off. At this point, you can only set the vertical scale in
1-2-5 step, namely 10mV, 20mV, 50mV, 100mV…100V (the probe ratio is 10X). When the
fine adjustment is on, you can further adjust the vertical scale within a relatively smaller
range to improve the vertical resolution. If the amplitude of the input waveform is a little
bit greater than the full scale under the current scale and the amplitude would be a little
bit lower if the next scale is used, fine adjustment can be used to improve the display
Return
Example
The query returns 1 or 0.
:CHANnel1:VERNier ON /*Enable the fine adjustment function of the vertical scale of
CH1*/
Related
:CHANnel<n>:SCALe
2-14 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:CURSor:MODE?
Description
Set or query the cursor measurement mode.
Name
Type
Range
Default
<mode>
Discrete
{OFF|MANual|TRACk|AUTO|XY}
OFF
horizontal timebase mode is XY.
Format
:CURSor:MODE? /*The query returns MAN*/
:CURSor Commands
The :CURSor commands are used to measure the X-axis value (such as time) and Y-axis value (such as
voltage) of the waveform displayed on the screen.
Explanation OFF: disable the cursor measurement function.
MANual: enable the manual cursor measurement mode.
TRACk: enable the track cursor measurement mode.
AUTO: enable the auto cursor measurement mode.
XY: enable the XY cursor measurement mode. This mode is valid only when the
Return
Example
Related
Commands
The query returns OFF, MAN, TRAC, AUTO, or XY.
:CURSor:MODE MANual /*Enable the manual cursor measurement mode*/
Set or query the h orizontal unit in the manual cursor measurement mode.
Name
Type
Range
Default
<unit>
Discrete
{S|HZ|DEGRee|PERCent}
S
PERCent: AX, BX, and BX-AX are expressed in percentage.
Format
:CURSor:MANual:TUNit? /*The query r eturns DEGR*/
:CURSor:MANual:VUNit?
Description
Set or query the vertical unit in the manual curs or measurement mode.
Name
Type
Range
Default
<unit>
Discrete
{PERCent|SOURce}
SOURce
automatically set to the unit of the current source.
Format
:CURSor:MANual:VUNit? /*The query returns PERC*/
:CURSor:MANual:SOURce
Syntax :C URS or :MA Nua l :SOURce <source >
Parameter
{CHANnel1|CHANnel2|MATH}
Return
Example
The query returns CHAN1, CHAN2, or MATH.
:CURSor:MANual:SOURce CHANnel2 /*Set the channel source to CH2*/
:CURSor:MANual:TUNit
Syntax :CURSor:MANua l:TUNit <unit>
Parameter
Explanation S: AX, BX, and BX-AX in the measurement results are in "s" and 1/|dX| is in "Hz".
HZ: AX, BX, and BX-AX in the measurement results are in "Hz" and 1/|dX| is in "s".
DEGRee: AX, BX, and BX-AX are in "degree".
Return
The query returns S, HZ, DEGR, or PERC.
Example
:CURSor:MANual:TUNit DEGRee /*Set the horizontal unit to "degree"*/
:CURSor:MANual:VUNit
Syntax :CURSor:MANua l:VUNit <unit>
Parameter
Explanation PERCent: AY, BY, and BY-AY in the measurement res ults are expressed in percentage.
SOURce: the units of AY, BY, and BY-AY in the measurement results will be
Return
Example
The query returns PERC or SOUR.
:CURSor:MANual:VUNit PERCent /*Set the system to express AY, BY, and BY-AY in the
measurement results in percentage*/
DS1000Z-E Programming Guide 2-17
RIGOL Chapter 2 Command System
:CURSor:MANual:AX?
Description
Set or query the horizontal position of cursor A in the manual cursor measurement mode.
Name
Type
Range
Default
<x>
Integer
5 to 594
100
pixel range is from 0 to 400.
Format
:CURSor:MANual:AX? /*The query returns 200*/
:CURSor:MANual:BX?
Description
Set or query the horizontal position of cursor B in the manual cursor measurement mode.
Name
Type
Range
Default
<x>
Integer
5 to 594
500
pixel range is from 0 to 400.
Format
:CURSor:MANual:BX? /*The query returns 200*/
:CURSor:MANual:AY?
Description
Set or query the vertical position of cursor A in the manual curs or measurement mode.
Name
Type
Range
Default
<y>
Integer
5 to 394
100
Explanation
The horizontal and vertical positions of the cursor are defined by the pixel coordinate of
Related
:CHANnel<n>:UNITs
Command
:CURSor:MANual:AX
Syntax :CURS o r:MANual:AX <x>
Parameter
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate of
the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400). Wher ein,
(0,0) is located at the left top corner of the screen and (600,400) is located at the right
bottom corner of the screen. The horizontal pixel range is from 0 to 600 and the vertical
Return
Example
The query returns an integer between 5 and 594.
:CURSor:MANual:AX 200 /*Set the horizontal position of cursor A to 200*/
:CURSor:MANual:BX
Syntax :CURSor:MANual:BX <x>
Parameter
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate of
the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400). Wherein,
(0,0) is located at the left top corner of the screen and (600,400) is located at the right
bottom corner of the screen. The horizontal pixel range is from 0 to 600 and the vertical
Return
Example
The query returns an integer between 5 and 594.
:CURSor:MANual:BX 200 /*Set the horizontal position of cursor B to 200*/
:CURSor:MANual:AY
Syntax :CURSor:MANual:AY <y>
Parameter
2-18 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400). Wherein,
pixel range is from 0 to 400.
Format
:CURSor:MANual:AY? /*The query returns 200*/
:CURSor:MANual:BY?
Description
Set or query the vertical position of cursor B in the manual cursor measurement mode.
(0,0) is located at the left top corner of the screen and (600,400) is located at the right
bottom corner of the screen. The horizontal pixel range is from 0 to 600 and the vertical
Return
Example
The query returns an integer between 5 and 394.
:CURSor:MANual:AY 200 /*Set the vertical position of cursor A to 200*/
:CURSor:MANual:BY
Syntax :CURSor:MANual:BY <y>
Parameter
<y> Integer 5 to 394 300
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate of
the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400). Wherein,
(0,0) is located at the left top corner of the screen and (600,400) is located at the right
bottom corner of the screen. The horizontal pixel range is from 0 to 600 and the vertical
Return
Example
The query returns an integer between 5 and 394.
:CURSor:MANual:BY 200 /*Set the vertical positio n of cursor B to 200*/
:CURSor:MANual:AXValue?
Description Query the X value of cursor A in the manual cursor measurement mode. The unit depends
Return
Related
The query returns the X value of cursor A in scientific notation.
:CURSor:MANual:AX
Commands
:CURSor:MANual:AYValue?
Description Query the Y value of cursor A in the manual cursor measurement mode. T he unit depends
Return
Related
Commands
When the signal source is CHANnel1|CHANnel2|MATH, the query returns t he Y va lue of
:CURSor:TRACk:SOURce2 CHANnel2 /*Set the channel source to CH2*/
:CURSor:TRACk:AX
Syntax :CURSor:TRACk:AX <x>
Parameter
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate of
the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400). Wherein,
(0,0) is located at the left top corner of the screen and (600,400) is located at the right
bottom corner of the screen. The horizontal pixel range is from 0 to 600 and the vertical
Return
Example
The query returns an integer between 5 and 594.
:CURSor:TRACk:AX 200 /*Set the horizontal position of cursor A to 200*/
:CURSor:TRACk:BX
Syntax :CURSor:TRACk:BX <x>
Parameter
<x> Integer 5 to 594 500
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate of
the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400). Wherein,
(0,0) is located at the left top corner of the screen and (600,400) is located at the right
bottom corner of the screen. The horizontal pixel range is from 0 to 600 and the vertical
Return
Example
2-22 DS1000Z-E Programming Guide
The query returns an integer between 5 and 594.
:CURSor:TRACk:BX 200 /*Set the horizontal position of cursor B to 200*/
Chapter 2 Command System RIGOL
Syntax
:CURSor:TRACk:AY?
Description
Query the vertical position of cursor A in the track cursor measurement mode.
Format
Example
:CURSor:TRACk:AY? /*The query retur ns 284*/
Syntax
:CURSor:TRACk:BY?
Description
Query the vertical position of cursor B in the track cursor measurement mode.
returns 4294967295.
Format
Example
:CURSor:TRACk:BY? /*The query returns 200*/
Syntax
:CURSor:TRACk:AXValue?
Description
Query the X value of cursor A in the track cursor measurement mode. The default unit is s.
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate
of the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400).
Wherein, (0,0) is located at the left top corner of the screen and (600,400) is located
at the right bottom corner of the screen. The horizontal pixel range is from 0 to 600
and the vertical pixel range is from 0 to 400.
When cursor A exceeds the vertical range of the screen display, the query always
returns 4294967295.
Return
The query returns an integer.
:CURSor:TRACk:BY?
Explanation The horizontal and vertical positions of the cursor are defined by the pixel coordinate
of the screen. The pixel coordinate of the screen ranges from (0,0) to (600,400).
Wherein, (0,0) is located at the lef t top corner of the screen and (600,400) is located
at the right bottom corner of the screen. The horizontal pixel range is from 0 to 600
and the vertical pixel range is from 0 to 400.
When cursor B exceeds the vertical range of the screen display, the query always
Return
The query returns an integer.
:CURSor:TRACk:AXValue?
Return
Related
The query returns t he X value of cursor A in s cie ntific notation.
:CURSor:TRACk:AX
:CURSor:TRACk:AYValue?
Description Query the Y value of cursor A in the track cursor measurement mode. The unit is the same
Return
DS1000Z-E Programming Guide 2-23
The query returns the Y value of cursor A in scientific notation.
The auto cursor function can measure 37 waveform parameters. Using this command,
you can select the parameters to be measured by the auto cursor from the five
parameters enabled last or query the par ameters c urren tly measu red by the auto cursor.
Name Type Range Default
<item>
Discrete
{OFF|ITEM1|ITEM2|ITEM3|ITEM4|ITEM5}
OFF
DS1000Z-E Programming Guide 2-25
RIGOL Chapter 2 Command System
Vrms, Variance.
Syntax
:CURSor:AUTO:AX?
Description
Query the horizontal position of cursor A in auto cursor measurement.
measurement items. At this point, the query returns 4294967295.
Format
Syntax
:CURSor:AUTO:BX?
Description
Query the horizontal position of cursor B in auto cursor measurement.
measurement items. At this point, the query returns 4294967295.
Format
Explanation This command is only valid when the auto cursor mode is selected. You can select
the auto cursor measurement mode using the
The 37 waveform parameters are listed below (see the detailed introduction
in
:MEASure Commands). The parameters can be enabled by the :MEASure:ITEM
command.
Period, Frequency, Rise Time, Fall Time, +Width, -Width, +Duty, -Duty, +Pulses,
Example :CURSor:AUTO:ITEM ITEM3 /*Use auto cursor to measure ITEM3*/
The query returns OFF, ITEM1, ITEM2, ITEM3, ITEM4, or ITEM5.
:CURSor:AUTO:ITEM? /*The query returns ITEM3*/
:CURSor:AUTO:AX?
Explanation The horizontal and vertical positions of the c ursor a r e defined by t he pixel
coordinate of the screen. The pixel coordinate of the screen ranges from (0,0) to
(600,400). Wherein, (0,0) is located at the left top corner of the screen and
(600,400) is located at the right bottom corner of the screen. The horizontal pixel
range is from 0 to 600 and the vertical pixel range is from 0 to 400.
In auto cursor measurement, cursor A of X type is not required for some of the
Return
The query returns a n integer between 5 and 594.
:CURSor:AUTO:BX?
Explanation The horizontal and vertical positions of the c ursor a r e defined by t he pixel
coordinate of the screen. The pixel coordinate of the screen ranges from (0,0) to
(600,400). Wherein, (0,0) is located at the left top corner of the screen and
(600,400) is located at the right bottom corner of the screen. The horizontal pixel
range is from 0 to 600 and the vertical pixel range is from 0 to 400.
In auto cursor measurement, cursor B of X type is not required for some of the
Return
2-26 DS1000Z-E Programming Guide
The query returns a n integer between 5 and 594.
Chapter 2 Command System RIGOL
Syntax
:CURSor:AUTO:AY?
Description
Query the vertical position of cursor A in auto cursor measurement.
Format
Syntax
:CURSor:AUTO:BY?
Description
Query the vertical position of cursor B in auto curs or me a sure me nt.
measurement items. At this point, the query returns 4294967295.
Format
Syntax
:CURSor:AUTO:AXValue?
horizontal unit curr ently selected .
measurement items. At this point, the query returns 9.9E37.
measurement items. At this point, the query returns 9.9E37.
Format
:CURSor:AUTO:AY?
Explanation The horizontal and vertical positions of the c ursor a r e defined by t he pixel
coordinate of the screen. The pixel coordinate of the screen ranges from (0,0) to
(600,400). Wherein, (0,0) is located at the left top corner of the screen and
(600,400) is located at the right bottom corner of the screen. The horizontal pixel
range is from 0 to 600 and the vertical pixel range is from 0 to 400.
In auto cursor measurement, cursor A of Y type is not required for some of the
measurement items. At this point, the query returns 4294967295.
Return
The query returns a n integer between 5 and 394.
:CURSor:AUTO:BY?
Explanation The horizontal and vertical positions of the c ursor a r e defined by t he pixel
coordinate of the screen. The pixel coordinate of the screen ranges from (0,0) to
(600,400). Wherein, (0,0) is located at the left top corner of the screen and
(600,400) is located at the right bottom corner of the screen. The horizontal pixel
range is from 0 to 600 and the vertical pixel range is from 0 to 400.
In auto cursor measurement, cursor B of Y type is not required for some of the
Return
The query returns a n integer between 5 and 394.
:CURSor:AUTO:AXValue?
Description Quer y the X value of cursor A in auto cursor measurement. The unit depends on the
Explanation In auto cursor measurement, cursor A of X type is not required for some of the
Return
The query returns the X value of cursor A in scientific notation.
:CURSor:AUTO:AYValue?
Description Quer y the Y value of cursor A in auto cursor measurement. The unit depends on t he
Explanation In auto cursor measurement, cursor A of Y type is not required for some of the
Return
DS1000Z-E Programming Guide 2-27
The query returns the Y value of cursor A in scientific notation.
Explanation In the XY timebase mode, the horizontal and vertical positions of the cursor are defined
by the pixel coordinate of the XY display area. The pixel coordinate of the screen ranges
from (0,0) to (400,400). Wherein, (0,0) is located at the right top corner and (400,400) is
located at the left bottom corner. The horizontal and vertical pixel ranges are both from 0
Return
Example
The query returns an integer between 5 and 394.
:CURSor:XY:AX 20 0 /*Set the horizontal position of cursor A to 200*/
:CURSor:XY:BX
Syntax :CURSor:XY:BX <x>
Description Set or query the horizontal position of cursor B in the XY cursor measurement mode.
Parameter
<x> Integer 5 to 394 300
Explanation In the XY timebase mode, the horizontal and vertical positions of the cursor are defined
by the pixel coordinate of the XY display area. The pixel coordinate of the screen ranges
from (0,0) to (400,400). Wherein, (0,0) is located at the right top corner and (400,400) is
located at the left bot tom c or ner. The horizontal and ver tic al pi x el r an ges ar e bo th fr om 0
Return
DS1000Z-E Programming Guide 2-29
The query returns an integer between 5 and 394.
RIGOL Chapter 2 Command System
:CURSor:XY:AY?
Description
Set or query the vetical position of cursor A in the XY cursor measurement mode.
Name
Type
Range
Default
<x>
Integer
5 to 394
100
left bottom corner. The horizontal and vertical pixel ranges are both from 0 to 400.
Format
:CURSor:XY:AY? /*The query returns 200*/
:CURSor:XY:BY?
Description
Set or query the vertical position of cursor B in the XY cursor measurement mode.
Example :CURSor:XY:BX 200 /*Set the horizontal position of cur sor B to 200*/
:CURSor:XY:BX? /*The query returns 200*/
:CURSor:XY:AY
Syntax :CURSor:XY:AY <y>
Parameter
Explanation In the XY timebase mode, the horizontal and vertical positions are defined by the pixel
coordinate of the XY display area. The pixel coordinate of the screen ranges from (0,0 ) to
(400,400). Wherein, (0,0) is located at the right top corner and (400,400) is located at the
Return
Example
The query returns an integer between 5 and 394.
:CURSor:XY:AY 200 /*Set the vertical position of cursor A to 200*/
:CURSor:XY:BY
Syntax :CURSor:XY:BY <y>
Parameter
Explanation In the XY timebase mode, the horizontal and vertical positions are defined by the pixel
Return
Example
Name Type Range Default
<x> Integer 5 to 394 300
coordinate of the XY display area. The pixel coordinate of the XY display area ranges from
(0,0) to (400,4 00). Wherein, (0,0) is located at the right top corner and (400,400) is
located at the left bottom corner. The horizontal and vertical pixel ranges ar e both f ro m 0
The query returns an integer between 5 and 394.
:CURSor:XY:BY 200 /*Set the vertical position of cursor B to 200*/
:CURSor:XY:AXValue?
Description Quer y the X value of cursor A in the XY cursor measurement mode. The unit depends on
Return
Related
2-30 DS1000Z-E Programming Guide
The query returns the X value of cursor A in scientific notation.
Explanation PARallel, UART, SPI, and IIC correspond to parallel decoding, RS232 decoding, SPI
decoding, and I2C decoding respectively.
Return
Example
The query returns PAR, UART, SPI, or IIC.
:DECoder1:MODE SPI /*Set the decoder type to SPI*/
2-32 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:DECoder<n>:DISPlay?
Description
Turn on or off the decoder or query the status of the decoder.
Name
Type
Range
Default
<bool>
Bool
{{1|ON}|{0|OFF}}
0|OFF
Format
:DECoder1:DISPlay? /*The query returns 1*/
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
format is the same as binary.
Format
:DECoder1:FORMat? /*The query returns HEX*/
:DECoder<n>:POSition?
Name
Type
Range
Default
Decoder 2: 300
Return
The query returns an integer between 50 and 350.
:DECoder<n>:DISPlay
Syntax :DE Cod er <n >: DISPl ay <bool>
Parameter
<n> Discrete {1|2} --
Return
Example
The query returns 1 or 0.
:DECoder1:DISPlay ON /*Turn on Decoder 1*/
:DECoder<n>:FORMat
Syntax :DECoder<n>:FORMat <fmt>
:DECoder<n>:FORMat?
Description Set or quer y the bus display format.
Parameter
<fmt> Discrete {HEX|ASCii|DEC|BIN|LINE} ASCii
Explanation HEX: hexade c imal; DEC: decimal; BIN: binary
In LINE format, the actual values of the bus are displayed in binary form and the
order is consistent with the bus transmission order. This format is only valid for
serial buses which include LSB and MSB endian. If MSB endian is selected, LINE
Return
The query returns HEX, ASC, DEC, BIN, or LINE.
Example
:DECoder1:FORMat HEX /*Set the bus display format to hexadecimal*/
:DECoder<n>:POSition
Syntax :DECod er<n>:POSit ion <pos>
Description Set or query the vertical position of the bus on the screen.
Parameter
<n> Discrete {1|2} --
<pos> Integer 50 to 350
Explanation The screen is divided into 400 parts vertically which are marked as 0 to 400 from top to
bottom respectively. The range of <pos> is from 50 to 350.
Explanation By default, the auto threshold function of the a nalog channels of the oscilloscope is
turned on. To set the threshold level manually, send this command to turn off the auto
threshold function and use the comma nds in Related Commands to set the threshold
Return
2-34 DS1000Z-E Programming Guide
The query returns 1 or 0.
Chapter 2 Command System RIGOL
:DECoder1:THREshold:AUTO? /*The query returns 0*/
:DECoder<n>:CONFig:LABel?
the bus (when the bus display is turned on).
Format
:DECoder1:CONFig:LABel? /*The query returns 1*/
:DECoder<n>:CONFig:LINE?
Description
Turn on or off the bus display function, or query the status of the bus display function.
:ETABle1:FORMat ASCii /*Set the data display format of the event table to ASCII*/
DS1000Z-E Programming Guide 2-59
RIGOL Chapter 2 Command System
:ETABle<n>:VIEW?
Description
Set or query the display mode of the event table.
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
<view>
Discrete
{PACKage|DETail|PAYLoad}
PACKage
Format
:ETABle1:VIEW? /*The query returns PAYL*/
:ETABle<n>:COLumn?
Name
Type
Range
Default
parameter.
Format
:ETABle1:COLumn? /*The query r eturns DATA*/
:ETABle<n>:VIEW
Syntax :ETABle<n>:VIEW <view>
Parameter
Explanation PACKage: the time and data are displayed in the event table.
DETail: the detailed data of the specifie d row is displayed in the event table.
PAYLoad: all data of the specified c olumn is displayed in the event table .
Return
Example
The query returns PACK, D ET, or PAYL.
:ETABle1:VIEW PAYLoad /*Set the display mode of the event table to PAYLoad*/
:ETABle<n>:COLumn
Syntax :ETABle<n>:COLumn <col>
Description Set or query the current column of the event table.
The query returns the current row in integer. If the current even table is empty, the
Example :ETABle1:ROW 2 /*Set the current row to 2*/
:ETABle<n>:SORT
Syntax :E TABle<n>:SORT <sort >
Description Set or query the display type of the decoding results in the event table.
Parameter
<sort> Discrete {ASCend|DESCend} ASCend
Explanation ASCend: the events are displayed in the order in which they occurred.
1
Return
Example
DESCend: the events are displayed in the order reverse to the order in which they
The query returns ASC or DESC.
:ETABle1:SORT DESCend /*Set the display type of the event table to descend*/
DS1000Z-E Programming Guide 2-61
RIGOL Chapter 2 Command System
Syntax
:ETABle<n>:DATA?
Description
Read the current event table data.
Name
Type
Range
Default
<n>
Discrete
{1|2}
--
Example
:ETABle1:DATA? /*The query returns the data as shown in the figure above*/
TMC Data
Event T able
:ETABle<n>:DATA?
Parameter
Return
Format
The query returns the event table data in the format as shown in the figure below.
Wherein, #9000000098 is the TMC data description header followed by the even table
data and its format is #900000dddd. dddd denotes the number of bytes of the valid
waveform data following the description header. For example, as shown in the figure
below, #9000000098 is the TMC data description header, wherein, 98 denotes that there
are 98 bytes of valid data. The content following 98 is the event table data.
Description Query the maximum number of frames can be recorded currently.
Explanation
As the capacity of the waveform memory is fixed, the more the number of points each
frame of waveform has, the less the number of waveform frames can be recor ded. Thus,
the maximum number of frames can be recorded currently is decided by the memory
depth currently selected. The less the memory depth, the more the numb er of waveform
Return
The query returns the maximum n u mber of f r ames c an be record ed c ur ren tly in in teger.
Format
:FUNCtion:WRECord:FINTerval
Syntax :FUNCtion:WRECord:FINTerval <interval>
Description Set or query the time interval between frames in wav eform rec ording. The def ault unit is
Parameter
Return
Example
Name Type Range Default
<interval> Real 100ns to 10s 100ns
The query returns the time interval currently set in scientific notation.
:FUNCtion:WRECord:FINTerval 0.001 /*Set the time interval to 1ms*/
:FUNCtion:WRECord:PROMpt
Syntax :FUNCtion:WRECord:PROMpt <bool>
Description Turn on or off the sound prompt when the recording finishes, or query the status of the
Parameter
Explanation When the sound prompt is turned on, the instrument exerts a sound promt when the
:SYSTem:BEEPer) is
Return
Example
recording finishes no matter whether the system sound (refer to
The query returns 1 or 0.
:FUNCtion:WRECord:PROMpt 1 /*Turn on the sound prompt when the recording
finishes*/
2-64 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:FUNCtion:WRECord:OPERate?
Description
Start or stop the waveform recording, or query the status of the waveform recording.
<opt>
Discrete
{RUN|STOP}
--
Format
n
already finished*/
:FUNCtion:WRECord:ENABle?
recording function.
the :FUNCtion:WRECord:OPERate command to start the recording.
Format
:FUNCtion:WRECord:ENABle? /*The query returns 1*/
:FUNCtion:WRECord:OPERate
Syntax :FUNCtion:WRECord:OPERate <opt>
Parameter
Name Type Range Default
Explanation Before sending this command, send the :FUNCtion:WRECord:ENABle command to turn
on the waveform recording function. Otherwise, this command is invalid.
Return
Example
The query returns RUN or STOP.
:FUNCtion:WRECord:OPERate RUN /*Start the waveform recording*/
:FUNCtion:WRECord:OPERate? /*The query returns RUN if the recording is i
progress and returns STOP if the recording has
:FUNCtion:WRECord:ENABle
Syntax :FUNCtion:WRECord:ENABle <bool>
Description Turn on or off the waveform recording function, or query the status of the waveform
Parameter
Name Type Range Default
<bool> Bool {{1|ON}|{0|OFF}} 0|OFF
Explanation The waveform recording function can only be enabled when the horizontal timebase
mode is "YT" and the horizontal timebase is lower than 200ms.
After turning on the waveform recording function, RUN/STOP can be used to start
or stop the waveform recording. At this point, you can se nd
Return
Example
The query returns 1 or 0.
:FUNCtion:WRECord:ENABle 1 /*Turn on the waveform recording function*/
DS1000Z-E Programming Guide 2-65
RIGOL Chapter 2 Command System
or playback process.
Format
:FUNCtion:WREPlay:FSTart? /*The query returns 5*/
:FUNCtion:WREPlay:FSTart
Syntax :FUNCtion:WREPlay:FSTart <sta>
:FUNCtion:WREPlay:FSTart?
Description Set or query the start frame of waveform playback.
Parameter
Name Type Range Default
<sta> Integer 1 to the maximum number of frames recorded 1
Explanation Use the :FUNCtion:WRECord:FEND command to set the maximum number of
frames recorded.
The start frame of waveform playback cannot be greater than the end frame of
waveform playback (
:FUNCtion:WREPlay:FEND).
You can only set the start frame of waveform playback when a waveform is currently
recorded.
You cannot set the start frame of waveform playback during the waveform recording
Return
Example
The query returns a n i nteger.
:FUNCtion:WREPlay:FSTart 5 /*Set the start frame of waveform playback to 5*/
2-66 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:FUNCtion:WREPlay:FEND?
Description
Set or query the end frame of waveform playback.
Name
Type
Range
Default
recorded
of frames recorded
end frame of w av ef orm pla yback when a wa vef orm is curr ently
Yo u canno t set the end f rame o f w avef orm pl ayback during th e wav ef orm recordi ng
or playback process.
Explanation You can only set the time interval of waveform playback when a waveform is
currently recorded.
You cannot set the time interval of waveform playback during the waveform
Return
Example
The query returns the current time interval in scientific notation.
:FUNCtion:WREPlay:FINTerval 0.001 /*Set the time interval to 1ms*/
:FUNCtion:WREPlay:MODE
Syntax :F UNC t io n: W RE P lay:M O DE <m ode >
Description Set or query the waveform playback mode.
Parameter
Explanation REPeat: cycle playback. Play from the start frame to th e end f rame an d then repeat
Name Type Range Default
<mode> Discrete {REPeat|SINGle} SINGle
until you stop it manually.
SINGle: single playback. Play from the start frame to the end frame and then stop.
You can only set the waveform playback mode when a waveform is currently
recorded.
You cannot set the w aveform playback mode during the waveform recording or
Return
Example
The query returns REP or SING.
:FUNCtion:WREPlay:MODE REPeat /*Set the waveform playback mode to cycle*/
This command is only valid when waveform has already been recorded.
Format
finishes*/
Command
:FUNCtion:WREPlay:DIRection
Syntax :FUNCtion:WREPlay:DIRection <dir>
:FUNCtion:WREPlay:DIRection?
Description Set or query the waveform playback direction.
Parameter
Name Type Range Default
<dir> Discrete {FORWard|BACKward} FORWard
Explanation FORWard: positive direction. Play from the start frame to the end frame.
BACKward: negative direction. Play from the end frame to the start frame.
You can only set the waveform playback direction w hen a waveform is currently
recorded.
You cannot set the waveform playback direction dur i ng the waveform recording or
Return
Example
The query returns FORW or BACK.
:FUNCtion:WREPlay:DIRection FORWard /*Set the waveform playback direction to
forward*/
:FUNCtion:WREPlay:OPERate
Syntax :FUNCtion:WREPlay:OPERate <opt>
Description Start, pause, or stop the waveform playback, or query the status of the waveform
Parameter
Return
Example
Related
<opt> Discrete {PLAY|PAUSe|STOP} STOP
The query returns PLAY, PAUS, or STOP.
:FUNCtion:WREPlay:OPERate PLAY /*Start the waveform playback*/
:FUNCtion:WREPlay:OPERate? /*The query returns PLAY if the playback is in
progress and returns STOP if the playback
:FUNCtion:WRECord:OPERate
DS1000Z-E Programming Guide 2-69
RIGOL Chapter 2 Command System
:FUNCtion:WREPlay:FCURrent?
Description
Set or query the current frame in waveform playback.
Explanation Use the :FUNCtion:WRECord:FEND command to set the maximum number of
frames recorded.
You can only set the current frame of waveform playback when a waveform is
currently recorded.
You cannot set the current frame of waveform playback during the waveform
Return
Example
The query returns an integer.
:FUNCtion:WREPlay:FCURrent 300 /*Set the current frame in waveform playback to
300*/
2-70 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
Syntax
*CLS
Description
Clear all the event registers and clear the error queue.
*ESE?
Description
Set or query the enable register for the standard event status register set.
Name
Type
Range
Default
<value>
Integer
Refer to Explanation
0
the binary numbers X0XXXX0X (X is 1 or 0).
Format
already been set in the register.
*ESE? /*The query returns 16*/
IEEE488.2 Common Commands
The IEEE 488.2 standard defines some common commands used for querying the basic information of the
instrument or executing the basic operations. These commands usually start with "*" and the keyword of
the command is usually 3-character long.
Explanation The bit 1 and bit 6 of the standard event status register are not used and are always
treated as 0; therefore, the range of <value> are the decimal numbers corresponding to
Return
Example *ESE 16 /*Enable the bit 4 (16 in decimal) of the sta ndard event status register*/
The query returns an integer which equals the sum of the weights of all the bits that have
DS1000Z-E Programming Guide 2-71
RIGOL Chapter 2 Command System
Syntax
*ESR?
Description
Query and clear the event register for the standard event status register.
the binary numbers X0XXXX0X (X is 1 or 0).
Format
register.
Syntax
*IDN?
Description
Query the ID string of the instrument.
<software version>: the software version of the instrument.
*OPC?
used to query whether the current operation is finished.
Format
Syntax
*RST
Description
Restore the instrument to the default state.
*ESR?
Explanation The bit 1 and bit 6 of the standard event status register are not used and are always
treated as 0. The range of the return value are the decimal numbers corresponding to
Return
The query returns an integer which eq uals the sum of the weights of all the bi ts in the
*IDN?
Return
Format
The query returns RIGOL TECHNO LOGIES,<model >,<serial number>,<software
version>.
Whererin,
<model>: the model number of the instrument.
<serial number>: the serial number of the instrument.
*OPC
Syntax *OPC
Description The *OPC command is used to set the Operation Complete bit (bit 0) in the standard
event status register to 1 after the current operation is finished. The *OPC? command is
*RST
Return
The query returns 1 if the current operation is finished; otherwise, returns 0.
2-72 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
*SRE?
Description
Set or querythe enable register for the status byte register set.
Name
Type
Range
Default
<value>
Integer
0 to 255
0
numbers XXXXXX00 (X is 1 or 0).
Format
have already been set in the register.
*SRE? /*The query returns 16*/
Syntax
*STB?
Query the event register fo r the st atus by te regi ster. The value of th e status by te register
is set to 0 after this command is executed.
(X is 1 or 0).
Format
register.
Syntax
*TST?
Description
Perform a self-test and then return the seilf-test results.
Format
Syntax
*WAI
Description
Wait for the operation to finish.
executed.
*SRE
Syntax *SRE <value>
Parameter
Explanation The bit 0 and bit 1 of the status byte register are not used and are always treated as 0;
therefore, the range of <value> are the decimal numbers corresponding to the binary
Return
Example *SRE 16 /*Enable the bit 4 (16 in decimal) of the status byte register*/
The query returns a n i nteger which equals the sum of the weights of all the bits that
*STB?
Description
Explanation The bit 0 and bit 1 of the status byte register are not used and are always treated as 0.
The query returns the decimal numbers corresponding to the binary numbers X0XXXX0X
Return
The query returns a n i nteger which equals the sum of t he weights of all the bits in the
*TST?
Return
The query returnsa decimal integer.
*WAI
Explanation The subsequent command can only be carried out after the current command has been
DS1000Z-E Programming Guide 2-73
RIGOL Chapter 2 Command System
:LAN:DHCP?
current DHCP configurati on mode.
Name
Type
Range
Default
<bool>
Bool
{{1|ON}|{0|OFF}}
1|ON
network parameters (such as the IP address) for the oscilloscope.
Description Turns on or off the DHCP configuration mode; or queries the on/off status of the
Parameter
Explanation When the three IP configuration types (DHCP, Auto IP, a nd Static IP) are all
turned on, the prio rity of the parameter configuration from high to low is
"DHCP", "Auto IP", and "Static IP". The three IP configuration types cannot be
all turned off at the same time.
When DHPC is valid, the DHCP server in the current network will assign the
Return
Example
The query returns 1 or 0.
:LAN:DHCP ON /*Enables DHCP configuration mode.*/
:LAN:AUToip
Syntax :LAN:AUToip <bool>
Description Turns on or off the Auto IP configuration mode; or queries the on/off status of the
Parameter
2-74 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
setting, refer to the :LAN:DNS command.
Format
:LAN:AUToip? /*The query returns 1.*/
:LAN:GATeway?
Description
Sets or queries the default gateway.
Name
Type
Range
Default
<string>
ASCII String
Refer to Explanation
——
command).
Format
:LAN:GATeway? /*The query returns the current gateway.*/
:LAN:DNS?
Description
Sets or queries the DNS address.
Name
Type
Range
Default
<string>
ASCII String
Refer to Explanation
——
command).
Format
Explanation When the three IP configuration types (DHCP , Auto IP, and Static IP) are all turned
on, the priority of the parameter configuration from high to low is "DHCP", "Auto
IP", and "Static IP". The three IP configuration types cannot be all turned off at
the same time.
When the auto IP mode is valid, disable DHCP manually. You can self-define the
gateway and DNS address for the oscilloscope.
:LAN:GATeway command. For the DNS
Return
Example
For the g a teway setting, refer to the
The query returns 1 or 0.
:LAN:AUToip ON /*Disables the Auto IP configuration mode.*/
:LAN:GATeway
Syntax :LAN:GATeway <st ring>
Parameter
Explanation The format of <string> is nnn,nnn,nnn,nnn. The range of the first section of
"nnn" is from 0 to 223 (except 127), and the ranges of the other three sections of
"nnn" are from 0 to 255.
When you use this command, the IP configuration mode should be Auto IP (refer
:LAN:AUToip command) or Static IP mode (refer to the :LAN:MANual
to the
Return
Example
The query returns the current gateway in strings.
:LAN:GATeway 19 2.1 68 .1. 1 /*Sets the default gateway to 192.168.1.1.*/
:LAN:DNS
Syntax :LAN:DNS <string>
Parameter
Explanation The format of <string> is nnn,nnn,nnn,nnn. The range of the firs t section of
"nnn" is from 0 to 223 (except 127), and the ranges of the other three sections of
"nnn" are from 0 to 255.
When you use this command, the IP configuration mode should be Auto IP (refer
:LAN:AUToip command) or Static IP mode (refer to the :LAN:MANual
to the
Return
The query returns the current DNS addres s in strings.
DS1000Z-E Programming Guide 2-75
RIGOL Chapter 2 Command System
Syntax
:LAN:MAC?
oscilloscope is as follows: 00-19-AF-30-00-00.
Format
:LAN:MANual?
static IP configuration mode.
Name
Type
Range
Default
<bool>
Bool
{{1|ON}|{0|OFF}}
0|OFF
e three IP configuration types (DHCP, Auto IP , and Static IP) are all tur ned
command.
Format
:LAN:MANual? /*The query returns 1. */
Syntax
:LAN:INITiate
oscilloscope has been connected to the network properly.
Example :LAN:DNS 192.168.1.1 /*Sets the DNS address to 192.168.1.1.*/
:LAN:DNS? /*The query returns the current DNS address.*/
:LAN:MAC?
Description Queries the MAC address of the instrument. The address format displayed on the
Return
The query returns the MAC address in strings. For example, 0019af300000.
:LAN:MANual
Syntax :LAN :MA Nu al <boo l >
Description Turns on or off the static IP configuration mode; or queries the on/off status of the
Parameter
Explanation When th
on, the priority of the parameter configuration from high to low is "DHCP", "Auto
IP", and "Static IP". The three IP configuration types cannot be all turned off at the
same time.
When the static IP mode is valid, disable DHCP and Auto IP manually. You can
self-define the network parameters of the oscilloscope, such as IP address, subnet
mask, gateway, and DNS address. For the setting of the IP address, refer to
:LAN:IPADdress command. For the setting of the subnet mask, refer to
the
:LAN:SMASk command. For the setting of the gateway, refer to
the
:LAN:GATeway command. For the setting of DNS, refer to the :LAN:DNS
the
Return
Example
The query returns 1 or 0.
:LAN:MANual ON /*Enables the static IP configuration mode.*/
:LAN:INITiate
Description Initiates the network parameters. Before running the command, confirm that the
2-76 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:LAN:IPADdress?
Description
Sets or queries the IP address of the instrument.
Name
Type
Range
Default
<string>
ASCII String
Refer to Explanation
——
disabled.
Format
:LAN:IPADdress? /*The query returns the current IP address . */
:LAN:SMASk?
Description
Sets or queries the subnet mask.
Name
Type
Range
Default
<string>
ASCII String
Refer to Explanation
——
to the :LAN:MANual command). The DHCP and auto IP should be disabled.
Format
:LAN:SMASk? /*The query returns the current subnet mask.*/
Syntax
:LAN:STATus?
Description
Queries the current network configuration status.
DHCPFAILED: the DHCP configuration has failed.
:LAN:IPADdress
Syntax :LAN:IPADdress <string>
Parameter
Explanation The format of <string> is nnn,nnn,nnn,nnn. The range of the first section of
"nnn" is from 0 to 223 (except 127), and the ranges of the other three sections of
"nnn" are from 0 to 255.
When you use the command, the IP configuration mode should be static IP (refer
:LAN:MANual command). Besides, the DHCP and auto IP should be
to the
Return
Example
The query returns the current IP address in strings.
:LAN:IPADdress 192.168.1.10 /*Sets the IP address to 192.168.1.10.*/
:LAN:SMASk
Syntax :LAN:SMASk <string>
Parameter
Explanation The format of <string> is nnn,nnn,nnn,nnn. The range of the section "nnn" is
from 0 to 255.
When you use the command, the IP configuration mode should be static IP (refer
Return
Example
The query returns the current subnet mask in strings.
:LAN:SMASk 255.255.255.0 /*Sets the subnet mask to 255.255.255.0*/
:LAN:STATus?
Return
Format
DS1000Z-E Programming Guide 2-77
The query returns UNLINK, INIT, IPCONFLICT, CONFIGURED, or DHCPFAILED.
UNLINK: not connected.
INIT: the instrument is acquiring an IP address.
IPCONFLICT: there is an IP address conflict.
CONFIGURED: the network configurat ion has been successfully configured.
RIGOL Chapter 2 Command System
Syntax
:LAN:VISA?
Description
Queries the VISA address of the instrument.
TCPIP::172.16.3.119::INSTR.
Syntax
:LAN:APPLy
Description
Applies the network configuration.
:LAN:VISA?
Return Format The query returns the VISA address in strings. For example,
:LAN:APPLy
2-78 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:MATH Commands
The :MATH commands are used to set the operations between the waveforms of multiple channels.
Note:
The operations include the follo wing types:
Algebraic Operations: A+B, A-B, AxB, A/B
Spectrum Operation: FFT
Logic Operations: A&&B, A||B, A^B, !A
Functional Operations: Intg, Diff, Sqrt, Lg, Ln, Exp, Abs
Filter: Low Pass Filter, High Pass Filter, Band Pass Filter, Band Stop Filter
Compound Operations: Combination of two operations (inner and out er)
For logic operations, the waveform data to be operated is compared with the preset threshold and is
converted to 0 or 1. Thus, the result will also be 0 or 1.
For a relatively complicated operation, you can split it into inner and outer layer operations (namely
compound operation) according to your need. The inn er layer operation (fx) can only be algebraic
operation and the outer layer operation can only be algebraic operation or functional operation.
When the outer lay er operation is algeriac oper ation, at least on e of sourc e A and source B of the outer
layer operation should be set to FX.
When the outer layer operation is functional operation, the source of the outer layer operation can only
be set to FX.
Note: For the inner layer operation (fx), you can send
the :MATH:OPTion:FX:SOURce1, :MATH:OPTion:FX:SOURce2, and :MATH:OPTion:FX:OPERatorcommands to set
the sources and operator of the inner layer operation. For the outer layer operation, you can send
the
:MATH:SOURce1, :MATH:SOURce2, and :MATH:OPERatorcommands to set the sources and operator of the
Example :MATH:OPERator INTG /*Set the operator of the math operation to integration*/
2-80 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
:MATH:SOURce1?
layer operation of compound operation.
Name
Type
Range
Default
<src>
Discrete
{CHANnel1|CHANnel2|FX}
CHANnel1
inner layer operation.
Format
:MATH:SOURce1? /*The query returns CHAN2*/
:MATH:SOURce2?
operation.
Name
Type
Range
Default
Discrete
CHANnel1
inner layer operation.
Format
:MATH:SOURce1
Syntax :M ATH:SOURce1 <sr c >
Description Set or query the source or source A of algebraic operation/functional operation/th e outer
Parameter
Explanation For algebraic operations, this command is used to set source A.
Fo r functional operations, only this command is used to set the source.
For compound operations, this command is used to set source A of the outer layer
operation when the outer layer operation is algeriac operation and the range of
<src> is {CHANnel1|CHANnel2|FX}; this command is used to set the source of the
outer layer operation when the outer layer operation is functional operation and
<src> can only be set to FX.
Note: When the outer layer operation of compound operation is algebraic operation, at least
one of source A and source B of the outer layer operation should be set to FX.
When "FX" is selected, you can send
:MATH:OPTion:FX:SOURce1, :MATH:OPTion:FX:SOURce2,
the
:MATH:OPTion:FX:OPERator commands to set the sources and operator of the
and
Return
Example
The query returns CHAN1, CHAN2, or FX.
:MATH:SOURce1 CHANnel2 /*Set source A of algebraic operation to CH2*/
:MATH:SOURce2
Syntax :M ATH:SOURce2 <sr c>
Description Set or query source B of algebraic operation/the outer layer operation of compound
Parameter
<src>
Explanation This command is only applicable to algebraic operations (requiring two sources) and
compound operations whose outer layer operations are algebraic operations.
When the outlayer operation of compound operation is algebraic operation, this
command is used to set source B of the outer layer operation.
Note: When the outer layer operation of compound operation is algebraic operation, at least
one of source A and source B of the outer layer operation should be set to FX.
{CHANnel1|CHANnel2|FX}
When "FX" is selected, you can send
:MATH:OPTion:FX:SOURce1, :MATH:OPTion:FX:SOURce2,
the
:MATH:OPTion:FX:OPERator commands to set the sources and operator of the
and
Return
DS1000Z-E Programming Guide 2-81
The query returns CHAN1, CHAN2, or FX.
RIGOL Chapter 2 Command System
:MATH:LSOUrce1?
Description
Set or query source A of logic operation.
Explanation
The logic operations include A&&B, A||B, A^B, and !A.
Format
:MATH:LSOUrce1? /*The query returns CHAN1*/
:MATH:LSOUrce2?
Name
Type
Range
Default
and is used to set sour c e B.
:MATH:SCALe?
currently selected and the unit of the source.
Name
Type
Range
Default
<scale>
Real
The max range is from 1p to 5T (in 1-2-5 step)
1.00V
Example :MATH:SOURce2 CHANnel2 /*Set source B of algebraic operation to CH2*/
:MATH:SOURce2? /*The query returns CHAN2*/
:MATH:LSOUrce1
Syntax :MATH:LSOUrce1 <src >
Parameter
Name Type Range Default
<src> Discrete {CHANnel1|CHANnel2} CHANnel1
Return
Example
The query returns CHAN1 or CHAN2.
:MATH:LSOUrce1 CHANnel1 /*Set source A of logic operation to CH1*/
:MATH:LSOUrce2
Syntax :MATH:LSOUrce2 <src >
Description Set or query source B of logic operation.
Parameter
<src> Discrete {CHANnel1|CHANnel2} CHANnel1
Explanation The logic operations include A&&B, A||B, A^B, and !A.
This command is only applicable to logic operations that require two signal sources
Return
The query returns CHAN1 or CHAN2.
Format
Example
:MATH:LSOUrce2 CHANnel1 /*Set source B of logic operation to CH1*/
:MATH:LSOUrce2? /*The query returns CHAN1*/
:MATH:SCALe
Syntax :MATH:SCALe <scale>
Description Set or query the vertical scale of the operation result. The unit depends on the operator
Parameter
2-82 DS1000Z-E Programming Guide
Chapter 2 Command System RIGOL
is also related to the current horizontal timebase.
Format
:MATH:SCALe? /*The query returns 2.000000e+00*/
:TIMebase[:MAIN]:SCALe
:MATH:OFFSet?
Name
Type
Range
Default
Step: MathVerticalScale/50
the :MATH:SCALe command.
Format
:MATH:OFFSet? /*The query returns 8.000000e+00*/
:CHANnel<n>:UNITs
:MATH:INVert?
display mode status of the operation result.
Name
Type
Range
Default
<bool>
Bool
{{1|ON}|{0|OFF}}
0|OFF
This command has the same function as the :MATH:OPTion:INVert command.
Format
Explanation The range of the vertical scale is related to the opera tor curren tly selected and th e vertical
scale of the source channel. For the integration (intg) and differential (diff) operations, it
Return
Example
Related
Commands
The query returns the vertical scale of the operation result in scientific notation.