Keysight M8131A User Manual

Keysight M8131A 16/32 GSa/s Digitizer
User's Guide
CAUTION
WARNING
Notices
© Keysight Technologies 2018
No part of this manua in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Keysight Technologies as governed by United States and international copyright laws.
l may be reproduced
Trademarks
PCI Express® and PCIe® are registered trademarks of PCI-SIG.
Manual Part Number
M8131-91010
Edition
Edition 4.0, December 2018
Keysight Technologies Deutschland GmbH Herrenberger Strasse 130, 71034 Böblingen, Germany
Technology Licenses
The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license.
U.S. Government Rights
The Software is “commercial computer software,” as defined by Federal Acquisition Regulation (“FAR”) 2.101. Pursuant to FAR
12.212 and 27.405-3 and Department of Defense FAR Supplement
(“DFARS”) 227.7202, the U.S. government acquires commercial computer software under the same terms by which the software is customarily provided to the public. Accordingly, Keysight provides the Software to U.S. government customers under its standard commercial license, which is embodied in its End User License
Agr
eement (EULA), a copy of which can be found at http://www.key-
sight.com/find/sweula. The license set
forth in the EULA represents the exclusive authority by which the U.S. government may use, modify, distribute, or disclose the Software. The EULA and the license set forth therein, does not require or permit, among other things, that Keysight: (1) Furnish technical information related to commercial computer software or commercial computer software documentation that is not customarily provided to the public; or (2) Relinquish to, or otherwise provide, the government rights in excess of these rights customarily provided to the public to use, modify, reproduce, release, perform, display, or disclose commercial computer software or commercial computer software documentation. No additional government requirements beyond those set forth in the EULA shall apply, except to the extent that those terms, rights, or licenses are explicitly required from all providers of commercial computer software pursuant to the FAR and the DFARS and are set forth specifically in writing elsewhere in the EULA. Keysight shall be under no obligation to update, revise or otherwise modify the Software. With respect to any technical data as defined by FAR 2.101, pursuant to FAR 12.211 and 27.404.2 and DFARS
227.7102, the U.S. government acquires no greater than Limited Rights as defined in FAR 27.401 or DFAR 227.7103-5 (c), as applicable in any technical data.
Warranty
THE MATERIAL CONTAINED IN THIS DOCUMENT IS PROVIDED "AS IS," AND IS SUBJECT TO BEING CHANGED, WITHOUT NOTICE, IN FUTURE EDITIONS. FURTHER, TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, KEYSIGHT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED WITH REGARD TO THIS MANUAL
AND ANY INFORMATION CONTAINED HEREIN, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. KEYSIGHT SHALL NOT BE LIABLE FOR ERRORS OR FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING, USE, OR PERFORMANCE OF THIS DOCUMENT OR ANY INFORMATION CONTAINED HEREIN. SHOULD KEYSIGHT AND THE USER HAVE A SEPARATE WRITTEN AGREEMENT WITH WARRANTY TERMS COVERING THE MATERIAL IN THIS DOCUMENT THAT CONFLICT WITH THESE TERMS, THE WARRANTY TERMS IN THE SEPARATE AGREEMENT WILL CONTROL.
Safety Notices
A CAUTION notice denotes a hazard. It calls attention to an operating procedure, practice, or the like that, if not correctly performed or adhered to, could result in damage to the product or loss of important data. Do not proceed beyond a CAUTION notice until the indicated conditions are fully understood and met.
A WARNING notice denotes a hazard. It calls attention to an operating procedure, practice, or the like that, if not correctly performed or adhered to, could result in personal injury or death. Do not proceed beyond a WARNING notice until the indicated conditions are fully understood and met.
2
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Safety Summary

Initial Inspection Inspect the shipping container for damage. If there is damage to the container or
General This product is a Safety Class 3 instrument (provided with a protective earth terminal).
The following general safety precautions must be observed during all phases of operation of this instrument. Failure to comply with these precautions or with specific warnings or operating instructions in the product manuals violates safety standards of design, manufacture, and intended use of the instrument. Keysight Technologies assumes no liability for the customer's failure to comply with these requirements. Product manuals are provided with your instrument on CD-ROM and/or in printed form. Printed manuals are an option for many products. Manuals may also be available on the Web. Go to
www.keysight.com and type in your product number in the Search field at the top of the
page. Safe operation and the general safety precautions for the M9502A and M9505A AXIe chassis, must be followed. See: http://www.keysight.com/find/M9505A.
cushioning, keep them until you have checked the contents of the shipment for completeness and verified the instrument both mechanically and electrically. The Performance Tests give procedures for checking the operation of the instrument. If the contents are incomplete, mechanical damage or defect is apparent, or if an instrument does not pass the operator’s checks, notify the nearest Keysight Technologies Sales/Service Office.
WARNING To avoid hazardous electrical shock, do not perform electrical tests when there are signs of shipping damage to any portion of the outer enclosure (covers, panels, etc.).
The protective features of this product may be impaired if it is used in a manner not specified in the operation instructions.
Laser Safety Information Class 1 Laser product according IEC60825-1 (2007).
Environment Conditions
Before Applying Power
This instrument is intended for indoor use in an installation category II, pollution degree 2 environment. It is designed to operate within a temperature range of 0 °C – 40 °C (32 °F – 105 °F) at a maximum relative humidity of 80% and at altitudes of up to 2000 meters.
This module can be stored or shipped at temperatures between -40 °C and +70 °C. Protect the module from temperature extremes that may cause condensation within it.
Verify that all safety precautions are taken. The power cable inlet of the instrument serves as a device to disconnect from the mains in case of hazard. The instrument must be positioned so that the operator can easily access the power cable inlet. When the instrument is rack mounted the rack must be provided with an easily accessible mains switch.
Line Power Requirements The Keysight M8131A operates when installed in an Keysight AXIe mainframe.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 3
Do Not Operate in an
Explosive Atmosphere
Do not operate the instrument in the presence of flammable gases or fumes.
Do Not Remove the
Instrument Cover
Ground the Instrument
Operating personnel must not remove instrument covers. Component replacement and internal adjustments must be made only by qualified personnel.
Instruments that appear damaged or defective should be made inoperative and secured against unintended operation until they can be repaired by qualified service personnel.
To minimize shock hazard, the instrument chassis and cover must be connected to an electrical protective earth ground. The instrument must be connected to the ac power mains through a grounded power cable, with the ground wire firmly connected to an electrical ground (safety ground) at the power outlet. Any interruption of the protective (grounding) conductor or disconnection of the protective earth terminal will cause a potential shock hazard that could result in personal injury.
4 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Instrument Markings

The Tab le 1 lists the definitions of markings that may be on or with the product.
Table 1 Instrument Markings
Marking Description
The instruction documentation symbol. The product is marked with this symbol when it is necessary for the user to refer to the instruction in the documentation.
Frame or chassis ground terminal. Typically connects to the equipment’s metal frame.
KC is the Korean certification mark to demonstrate that the equipment is Class A suitable for professional use and is for use in electromagnetic environments outside of the home.
Indicates that anti-static precautions should be taken.
China Restricted Substance Product Label. The EPUP (environmental protection use period) number in the center indicates the time period during which no hazardous or toxic substances or elements are expected to leak or deteriorate during normal use and generally reflects the expected useful life of the product.
The RCM mark is a registered trademark of the Australian Communications and Media Authority.
The CSA mark is a registered trademark of the CSA International.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 5
Marking Description
The CE mark is a registered trademark of the European Community (if accompanied by a year, it is the year when the design was proven). This product complies with all relevant directives.
Universal recycling symbol. This symbol indicates compliance with the China standard GB 18455-2001 as required by the China RoHS regulations for paper/fiberboard packaging.
The Keysight email address is required by EU directives applicable to our product.
6 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Compliance and Environmental Information

Table 2 Compliance and Environmental Information
Safety Symbol Description
This product complies with WEEE Directive (2002/96/EC) marking requirements. The affixed label indicates that you must not discard this electrical/electronic product in domestic household waste.
Product Category: With reference to the equipment types in WEEE Directive Annex I, this product is classed as a “Monitoring and Control instrumentation” product.
Do not dispose in domestic household waste.
To return unwanted products, contact your local Keysight office, or see
http://about.keysight.com/en/companyinfo/environment/takeback.shtml for more
information.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 7

Contents

1 Introduction
2 M8131A Software Installation
Safety Summary 3
Instrument Markings 5
Compliance and Environmental Information 7
M8131A Overview 17 Key Features 17 Feature Options 18 Instrument Options 18 Front Panel 19 Related Documents 22 Additional Documents 22
Pre-Requisites 24
Installation Process 25
Post Installation Steps 35
How to use M8131A Instrument 37
M8131A Maintenance 38
ESD Protection 38 Power and Ventilation Requirements 40 Thermal Protection 40 Battery 40 Operating Environment 40
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 9
Contents
3 M8131A Soft Front Panel
Launching the M8131A Soft Front Panel 42
M8131A Soft Front Panel 45
Title Bar 46 Menu Bar 46 Tool Bar 51 Lower Pane 52 Errors List Window 52 Status Bar 53 Parameters Window 53 Trace Window 55
Acquisition Tab 58
Clock Tab 61
Configurations Tab 62
IOs Tab 64
System Monitor Tab 65
Working with M8131A Front Panel 66
Numeric Control Usage 66 Window Controls Usage 67
Calibration Dialog 68
Exporting Waveforms 72
Integrating 89600 VSA with M8131A 73
10 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
4 Remote Programming
Remote Programming Overview 78
Instructions 78 Instruction Header 78 White Space (Separator) 78 Braces 79 Ellipsis 79 Square Brackets 79 Program Data 79
Status Commands 80
STATus:PRESet 82 Status Byte Register 82 Questionable Data Register Command Subsystem 83 Operation Status Subsystem 84 Reference Clock Status Subsystem 85 Connection Status Subsystem 85 ADC Calibration Status Subsystem 86 Calibration Run Status Subsystem 87
Contents
Acquire Commands 88
:ACQuire: SRATe[?] 88 :ACQuire:POINts[?] 88
Calibration Commands 90
:CALibrate:ADC[:STARt] 90 :CALibrate:ADC:ABORt 90 :CALibrate:ADC:INFormation 90 :CALibrate:ADC:SAVE 91 :CALibrate:ADC:LOAD 91
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 11
Contents
Channel Commands 92
:CHANnel<N>:DISPlay 92 :CHANnel<N>:OFFSet 92 :CHANnel<N>:RANGe 92 :CHANnel<N>:DPRocessing:DDC:CFRequency 93
Data Processing Commands 94
:DPRocessing[:MODE] 94 :DPRocessing:DDC:DECimation 94 :DPRocessing:DIRect:DECimation 95
Common Commands 96
*IDN? 96 *CLS 96 *ESE 96 ESR? 96 *OPC 96 *OPC? 97 *OPT? 97 *RST 97 *SRE[?] 97 *STB? 97 *TST? 97 *LRN? 98 *WAI? 98
Mass Memory Commands 99
:MMEMory:CATalog? 99 :MMEMory:CDIRectory 100 :MMEMory:COPY 100 :MMEMory:DELete 101 :MMEMory:DATA 101 :MMEMory:DATA? 101
12 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
:MMEMory:MDIRectory 102 :MMEMory:MOVE 102 :MMEMory:RDIRectory 102 :MMEMory:LOAD:CSTate 103 :MMEMory:STORe:CSTate 103 :MMEMory:STORe:WAVeform CHANnel 103
Root Level Commands 106
:DIGitize 106 :STOP 106 :STReam 106 :SSTReam 106
System Commands 107
:SYSTem:ERRor[:NEXT]? 107 :SYSTem:HELP:HEADers? 107 :SYSTem:LICense:EXTended:LIST? 108 :SYSTem:SET[?] 108 :SYSTem:VERSion? 109 :SYSTem:COMMunicate:*? 109 :SYSTem:COMMunicate:INSTr[:NUMBer]? 109 :SYSTem:COMMunicate:HISLip[:NUMBer]? 110 :SYSTem:COMMunicate:SOCKet[:PORT]? 110 :SYSTem:COMMunicate:TELNet[:PORT]? 110 :SYSTem:COMMunicate:TCPip:CONTrol? 110 :SYSTem:ERRor:COUNT? 111 :SYSTem:LICense:LIST? 111 :SYSTem:LICense:SUBScription:DATE? 111
Contents
Time Base Commands 112
:TIMebase:REFClock 112
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 13
Contents
Waveform Commands 113
:WAVeform:BYTeorder 113 :WAVeform:DATA? 113 :WAVeform:DATA:BLOCk? 114 :WAVeform:SOURce 115 :WAVeform:YINCrement? 115 :WAVeform:YORigin? 115
Instrument Commands 116
:INSTrument:SLOT[:NUMBer]? 116 :INSTrument:IDENtify 116 :INSTrument:IDENtify:STOP 116 :INSTrument:HWRevision? 116 :INSTrument:FPGA:MODE 117 :INSTrument:FPGA:UPDate 117 :INSTrument:FPGA:RESet 117 :INSTrument:FPGA:DIRect:DWORd 118 :INSTrument:ACHannels? 118 :INSTrument:MONitor:CURRent[:TOTal]? 118
Optical Data Interface Commands 119
:ODI:ACHannels? 119 :ODI:PORT:COUNt? 119 :ODI:PORT<N>:CAPability:DIRection? 119 :ODI:PORT[N]:CAPability:FCONtrols? 120 :ODI:PORT[N]:CAPability:LANes? 120 :ODI:PORT[N]:CAPability:NAME? 120 :ODI:PORT[N]:CAPability:RATes? 121 :ODI:PORT[N]:CAPability:RBMax? 121 :ODI:PORT[N]:CAPability:TBMax? 121 :ODI:PORT[N]:CAPability:TRMatch? 122 :ODI:PORT[N]:NAME? 122
14 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
:ODI:PORT<N>:ACTivate 122 :ODI:PORT<N>:DEACtivate 123 :ODI:PORT<N>:CSTatus? 123 :ODI:PORT[N]:PSTatistics:BBURsts? 124 :ODI:PORT[N]:PSTatistics:RBYTes? 125 :ODI:PORT[N]:PSTatistics:TBYTes? 125 :ODI:PORT[N]:PSTatistics:THOFfs? 125 :ODI:PRODucer:COUNt? 125 :ODI:PRODucer[N]:CAPability:CLIDs? 126 :ODI:PRODucer<N>:CAPability:CCIDs? 126 :ODI:PRODucer<N>:CAPability:NAME? 126 :ODI:PRODucer<N>:CAPability:PFORmats? 126 :ODI:PRODucer<N>:NAME? 127 :ODI:PRODucer<N>:IFSupported 127 :ODI:PRODucer<N>:ACTivate 127 :ODI:PRODucer<N>:DEACtivate 128
:TEST Commands 129
:TEST:PON? 129 :TEST:TST? 129
Contents
5 Characteristics
Performance Specification 131 Operating Environment 131 General 132
Index
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 15
Keysight M8131A 16/32 GSa/s Digitizer
User’s Guide

1 Introduction

M8131A Overview / 17 Key Features / 17 Feature Options / 18 Front Panel / 19 Related Documents / 22 Additional Documents / 22
This chapter provides an overview of M8131A digitizer module.

M8131A Overview

The Keysight M8131A is a 16/32 GSa/s digitizer with high bandwidth and channel density. It offers up to 1.6 GSa waveform memory. The M8131A is ideally suited to address following key applications:
• Wideband RF/μW – analyses extremely wideband RF signals with an instantaneous bandwidth of DC to 12.5 GHz for aerospace/defense and communication applications.
• Physics, chemistry, and electronics research – analyses any mathematically defined arbitrary waveforms, ultra-short yet precise pulses and extremely wideband chirps.
• Gapless streaming of 10 bit digitized data to DSP module, AWG or storage system for radar, electronic warfare, satellite or 5G.

Key Features

The M8131A is a digitizer with high sample rate, bandwidth, and channel density:
• Wide bandwidth
4 channels 6.5GHz, sample rate 16 GSa/s on each channel or
2 channels 12.5GHz, sample rate 32 GSa/s on each channel
1 Introduction
• Vertical resolution: 10 bits
• Outstanding signal fidelity with respect to SFDR, ENOB, harmonic distortion
• Full speed 4 x 16 GSa/s or 2 x 32 GSa/s gapless optical streaming via ODI (standardized Optical Data Interface), e.g. to an external storage system or customer‘s device or DSP module
• Total ODI streaming throughput: 4 x 160 GBit/s equals 640 GBit/s
• Real-time DDC and decimation
• On board memory 1.6 GSa per module
• Form factor: 2-slot AXIe module controlled via external PC or embedded AXIe system controller M9536A

Feature Options

The following feature options are available for M8131A:
Table 3 M8131A feature options
Option Functionality
STR Streaming: access to ODI interfaces
DDC Digital Down Conversion
FP1 FPGA Programming: User can load his own FPGA(s)

Instrument Options

The following instrument options are available for M8131A:
Table 4 M8131A instrument options
Option Frontends/Bandwidth Maximum Sample Rate
011, 012, 014 2x 6.5Ghz 4 GSa/s
061, 062, 064 2x 6.5Ghz 16 GSa/s
131, 132 1x 13 GHz 32 GSa/s
FD1, FD2, FD4 None 32 GSa/s
18 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Front Panel

Inputs/Outputs

Introduction 1
Figure 1 on page 19 illustrates the front panel of the M8131A instrument.
Figure 1 M8131A front panel
The M8131A front panel include the following input/output ports:
Input - The four analog input ports (In 1/2/3/4) can be used to receive the analog data from signal generator.
ODI - The four Optical Data Interface ports (ODI 1/2/3/4) can be used for optical data streaming.
Trig In - The Trigger Input can be used for external triggering. Triggering source can be an external pulse generator connected. This will be used only when the trigger source is “Trigger Input”. The Trigger Input functionality is for future use and is currently not available.
Trig Out - The Trigger Output can be used to trigger external instruments or DUTs. Trigger Output functionality is for future use and is currently not available.
Sync In - The Sync Input can be used to synchronize two or more modules to a common system clock. It is connected to the Sync Out of the other module. The Sync Input functionality is for future use and is currently not available.
Sync Out - The Sync Output can be used to synchronize two or more modules to a common system clock. It is connected to the Sync In of the other module. The Sync Output functionality is for future use and is currently not available.
Sample Clk In - The Sample Clock Input can be used, if an external clock source shall be used to clock the analog to digital to converters.
Sample Clk Out - The Sample Clock Output can be used to output the clock signal from the internal sample clock or the sample clock input.
When an internally generated sample clock of the M8131A’s is used, the Sample CLK Out must be connected with Sample Clk In with a
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 19
1 Introduction
Semi-rigid cable
semi-rigid cable as shown in the Figure 2 on page 20. However, if an external 8 GHz sample clock is used, the semi-rigid cable is not required.
20 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Figure 2 Sample Clk Out/In connection
Ref Clk In - The Reference Clock Input can be used to synchronize to an external clock.
Ref Clk Out - The Reference Clock Output can be used to synchronize a DUT to the M8131A.
FPGA Config - If option FP1 is installed, the FPGA Configuration can be used to load and debug the open FPGA externally.
Control In/Out - The Control Input/Output offers a 10-bit parallel interface. It can be configured in two independent groups of five bits as an input or output bus. If option FP1 is installed, the Control In/Out is routed to the ‘open FPGA’. The Control In/Out functionality is for future use and is currently not supported.

LEDs

Introduction 1
The M8131A front panel include the following LEDs:
•Status LEDs
The “Fail” and “Access” LEDs are available at the front panel to indicate the status of the M8131A module:
The green ‘Access’ LED indicates that the controlling PC exchanges
data with the M8131A module.
The red ‘Fail’ LED has following functionality:
It is ‘ON’ for about 30 seconds after powering the AXIe chassis.
After about 30 seconds the LED is switched ‘OFF’. If an external
PC is used to control the AXIe chassis, this PC can be powered after this LED has switched OFF.
During normal operation of the module this LED is ‘OFF’. In
case of an error condition such as e.g. a self-test error, the LED is switch ‘ON’.
In case the output relay has shut-off because of an external
overload condition, this LED flashes.
Trig In LED - This LED indicates that an externally applied signal matches the adjusted threshold to be used as a Trigger. The LED turns on for ~100 ms for each detected edge of the correct polarity. I.e. a rising edge turns the LED on for 100 ms if the polarity is adjusted to rising. If the polarity is adjusted to rising and a falling edge is externally applied, the LED remains OFF. The functionality of this LED is for future use and is currently not supported.
Sample Clk In LED - This LED is green whenever the clock is provided to M8131A when an external Sample Clock Source is used. The functionality of this LED is for future use and is currently not supported.
Ref Clk In LED - This LED is green when a valid signal at Ref CLK IN is detected. In case of invalid signals, it is RED. The functionality of this LED is for future use and is currently not supported.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 21
1 Introduction

Related Documents

To access documentation related to the Keysight M8131A digitizer, use one of the following methods:
CD - Browse the product CD for M8131A documentation.
Start > All Programs > Keysight M8131 > Keysight M8131 Documentation - Provides links to all product documentation except for the IVI driver documentation.
Start > All Programs > Keysight Instrument Drivers > KtM8131 Digitizer - Provides link to the product IVI driver help system.
• Go to the product web site (www.keysight.com/find/M8131A) and browse the manuals under Document Library tab.

Additional Documents

Additional documentation can be found at:
http://www.keysight.com/find/M9502A for 2-slot chassis related documentation.
http://www.keysight.com/find/M9505A for 5-slot chassis related documentation.
http://www.keysight.com/find/M9514A for 14-slot chassis related documentation.
http://www.keysight.com/find/M9537A for embedded AXIe controller related documentation
22 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Keysight M8131A 16/32 GSa/s Digitizer
User’s Guide
2 M8131A Software
Installation
Pre-Requisites / 24 Installation Process / 25 Post Installation Steps / 35 How to use M8131A Instrument / 37 M8131A Maintenance / 38
This chapter explains the steps required to install M8131A software package.
2 M8131A Software Installation
NOTE

Pre-Requisites

The following are the pre-requisites for installing Keysight M8131A software:
The supported operating systems are:
Windows 10 (32 bit or 64 bit)
Windows 8.1 (32 bit or 64 bit)
Windows 8 (32 bit or 64 bit)
Windows 7 (32 bit or 64 bit)
Ensure that you have Keysight IO Libraries Suite 2017 Update 1 or higher installed on your system. The Keysight IO Libraries Suite can be found on the CD that is part of shipment content or at
http://www.keysight.com/find/iosuite
Even if a non-Keysight I/O library is already installed on your PC, it is still necessary to install the Keysight I/O library. The Keysight I/O library will install as “secondary” I/O library in this case.
24 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Installation Process

NOTE
M8131A Software Installation 2
Follow the given steps to install Keysight M8131A software on your system:
1 Double-click the executable (M8131_Setup.exe). This executable file is
available either on CD or Web.
The installer will first check and list some pre-requisites. Click Install to install them. It is possible that your PC requests a reboot during this step. Reboot your PC, if requested.
2 The Keysight M8131A Setup will prepare the InstallShield Wizard for
the installation process. The following window will appear.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 25
2 M8131A Software Installation
26 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
3 Follow the on-screen instructions to begin the installation process.
Click Next.
M8131A Software Installation 2
4 We recommend you to read the document to check if your hardware
configuration is supported. Click Next to proceed to the license agreements.
5 Accept the terms of Keysight software end-user license agreement and
click Next.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 27
2 M8131A Software Installation
28 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
6 Select Yes if you want to read the post-installation instructions when
finished. Click Next to select setup type.
M8131A Software Installation 2
7 Select a setup type either Complete or Custom. Click Next.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 29
2 M8131A Software Installation
8 If you select Custom and click Next, you can specify which optional
features will be installed:
9Click Next to begin installation.
30 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A Software Installation 2
10 The Setup Wizard will now install M8131 beginning with the kernel
driver installation. If you have clicked “Always trust Keysight” before you won’t get this dialog anymore.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 31
2 M8131A Software Installation
11 The Keysight M8131A will configure the new software installation.
32 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A Software Installation 2
The following screen will appear once the Keysight M8131A software is successfully installed on your system.
Click Finish to restart your system. Do not connect the AXIe chassis to your system using the PCIe or USB cable during this reboot.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 33
2 M8131A Software Installation
12 This completes the Keysight M8131A software installation.
34 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Post Installation Steps

NOTE
NOTE
NOTE
M8131A Software Installation 2
Follow the post installation steps as shown below:
If M8131A is already powered up and connected to PC using the PCIe, just reboot the PC and start with step 5. No such reboot step is required in case of USB connection.
1 Shut down PC and instrument. 2 Connect the instrument to the PC using the PCIe or USB cable. 3 Switch on the instrument. Wait until the ‘Access’ LED of the M8131A
has switched from red to green. 4Switch on the PC. 5 The PC should automatically recognize the instrument.
Check this in the device manager; e.g. via Start > Control Panel > Device Manager, or right-click Computer > Manage > Device Manager:
In case of PCIe:
The instrument should be visible in the device tree as Keysight
Technologies Modular Devices > M8131A
•In case of USB:
The instrument should be visible in the device tree as Keysight Modular
Platform (AMP/AXIe) > Keysight Technologies USB AMP/AXIe Chassis.
In case of PCIe, post installation steps must be followed strictly in the same order as mentioned for successful connection of the PC with M8131A. However, in case of USB no such restriction is applicable i.e. the PC can be powered before the M8131A is turned ON.
Your PC might request a reboot. Reboot your PC, if requested.
6 (PCIe only) Check if the M8131 is also visible in the Connection Expert.
The connection expert can be opened by clicking its icon in the system
tray.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 35
2 M8131A Software Installation
If something went wrong and the instrument is not showing in the PXI section, it may be necessary to reboot the PC once more.
36 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

How to use M8131A Instrument

In order to use the instrument: 1 If you use a PCIe link to control the M8131A, the AXIe chassis must be
2 Start the M8131A Soft Front Panel (Start > All Programs > Keysight
3 Using the appropriate VISA resource string you can:
You must start the M8131A Soft Front Panel in order to send SCPI commands to the instrument.
M8131A Software Installation 2
switched on before you start the PC. If you use an USB link to control
the M8131A, it’s not mandatory that the AXIe chassis is powered and
has booted prior to turn-on the PC.
M8131 > Keysight M8131 Soft Front Panel). The user interface will
display the VISA resource strings for different kinds of connection.
Please note that the hardware resource strings will be not shown if the
Simulation Mode” check box is selected.
Start the Soft Front Panel (Start > All Programs > Keysight M8131
> Keysight M8131 Soft Front Panel).
Control the instrument with your own application by adding it as a
LAN instrument in the Keysight Connection Expert (TCPIP0::localhost::…) and control it using SCPI (with e.g. the Interactive IO or your own application).
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 37
2 M8131A Software Installation
WARNING
CAUTION
CAUTION

M8131A Maintenance

ESD Protection

This system should be serviced only by authorized personnel.
Using controls or adjustments or performing procedures other than those specified in the documentation supplied with your equipment can result in hazardous radiation exposure.
All the connectors are very sensitive to electrostatic discharge (ESD). There are also several exposed components on the PCAs, on both sides of M8121A, which can be touched accidentally while handling the unit and can risk damage to the instrument, due to ESD. When you connect a device or cable that is not fully discharged to these connectors, you risk damage to the instrument and expensive instrument repairs.
38 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Electrostatic discharge (ESD) can damage the circuits of the M8121A. Avoid applying static discharges to the front-panel connectors. Avoid touching the front-panel connectors without first touching the frame of the instrument. Be sure the instrument and all connected devices (DUT, etc.) are properly earth-grounded (to a common ground) to prevent buildup of static charge and electrical over-stress.
Electrostatic discharge (ESD) can damage or destroy electronic components. All work on electronic assemblies should be performed at a static-safe work station. The following list and figure shows an example of a static-safe work station using two types of ESD protection. Purchase acceptable ESD accessories from your local supplier.
Conductive table-mat and wrist-strap combination.
Conductive floor-mat and heel-strap combination.
M8131A Software Installation 2
WARNING
Figure 3 ESD protection
Both types, when used together, provide a significant level of ESD protection. Of the two, only the table-mat and wrist-strap combination provides adequate ESD protection when used alone. To ensure user safety, the static-safe accessories must provide at least 1 MW of isolation from ground.
These techniques for a static-safe work station should not be used when working on circuitry with a voltage potential greater than 500 volts.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 39
2 M8131A Software Installation

Power and Ventilation Requirements

Thermal Protection

For power and ventilation requirements, refer to:
http://www.keysight.com/find/M9514A for 14-slot chassis related documentation.
http://www.keysight.com/find/M9505A for 5-slot chassis related documentation.
http://www.keysight.com/find/M9502A for 2-slot chassis related documentation.
Overheating Detection
The instrument monitors its internal temperature. If the temperature exceeds approximately 80°C the power supply is switched off. The instrument will not turn on automatically if the temperature is decreasing again.
Fan Failure
If a fan is broken or prevented from operating by a blockage the temperature will increase. When the temperature exceeds approximately 80°C the overheating detection switches off the instrument for safety reasons. For reliability it is recommended to send instruments with broken or defective fans immediately to Keysight Service for repair.

Battery

The M8131A does not have a battery.

Operating Environment

For details on operative environment for M8131A, refer to the section
Operating Environment on page 131.
40 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Keysight M8131A 16/32 GSa/s Digitizer
User’s Guide
3 M8131A Soft Front
Panel

Launching the M8131A Soft Front Panel / 42 M8131A Soft Front Panel / 45 Acquisition Tab / 58 Clock Tab / 61 Configurations Tab / 62 IOs Tab / 64 System Monitor Tab / 65 Working with M8131A Front Panel / 66 Calibration Dialog / 68 Exporting Waveforms / 72 Integrating 89600 VSA with M8131A / 73

This chapter describes the M8131A Soft Front Panel.
3 M8131A User Interface

Launching the M8131A Soft Front Panel

There are two ways to launch the M8131A Soft Front Panel: 1 Select Start > All Programs > Keysight M8131 > Keysight M8131 Soft
Front Panel from the Start menu.
2From the Keysight Connection Expert select the discovered M8131
module, select the “Installed Software” tab and press the “Soft Front Panel” icon. Please note that only instruments connected via PCIe are shown in the Keysight Connection Expert.
The following Connect to Instrument dialog will appear:
Figure 4 M8131A connected to PC
This dialog shows the addresses of the discovered M8131A modules. Select a module from the list and press “Connect”.
If no M8131A module is connected to your PC, you can select “Simulation Mode” to simulate an M8131A module.
42 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3
Figure 5 M8131A in simulation mode
Next, a M8131A software startup screen will be displayed as shown in
Figure 6 on page 44.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 43
3 M8131A User Interface
Figure 6 M8131A startup screen
44 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

M8131A Soft Front Panel

M8131A User Interface 3
The M8131A Soft Front Panel and its GUI elements are illustrated in
Figure 7 on page 45.
Figure 7 M8131A user interface
The M8131A Soft Front Panel includes the following GUI elements: 1Title Bar 2 Menu Bar 3Tool Bar 4 Trace Window 5 Parameters Window 6Lower Pane 7 Status Bar
The detailed information on these GUI elements are described in the sections that follow.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 45
3 M8131A User Interface

Title Bar

Menu Bar

The title bar contains the standard Microsoft Windows elements such as the window title and the icons for minimizing, maximizing, or closing the window.
The menu bar consists of various pull down menus that provide access to the different functions and launch interactive GUI tools.
The menu bar includes the following pull down menu:
•File
•View
• Utilities
•Trace
•Tools
•Windows
•Help
Each menu and its options are described in the following sections.
File Menu
The File menu includes the following selections:
File > Connect… Opens the “Connect to Instrument” dialog. See Launching the
File > Save Configuration As… Saves configuration as a text file. Not implemented in the current version of
File > Load Configuration… Loads the previously saved configuration file. Not implemented in the current
File > Export Waveform Exports the data of each channel in to a text file.
File > Exit Exits the M8131A application.
46 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A Soft Front Panel
the software.
version of the software.
on page 42.
View Menu
M8131A User Interface 3
The View menu includes the following selections:
View > Refresh Reads the instrument state and updates all fields. Not functional in the
View > Hide Minimizes the GUI to notify icon.
current software release.
Utilities Menu
The Utility menu includes the following selections:
Utility > Calibration Opens the Calibration dialog to calibrate the instrument. See Calibration
Utility > Identify Identifies the instrument by flashing the green “Access” LED on the front
Utility > Reset Resets the instrument, reads the state and updates all fields.
Utility > Self Test… Opens a window to start the self-test and display the result after completion.
Dialog
on page 68.
panel for a certain time.
Not functional in the current software release.
Trace Menu
The Trace menu includes the following selections:
Trace > Time Window Opens a new instance of time window.
Trace > Frequency Window Opens a new instance of frequency window.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 47
3 M8131A User Interface
Tools Menu
The Tools menu includes the following selections:
Tools > Clock Switch to the “Clock” tab on Parameters window if it is already open. If not, it
Tools > IOs Switch to the “IOs” tab on Parameters window if it is already open. If not, it
Tools > Configurations Switch to the “Configurations” tab on Parameters window if it is already open.
Tools > System Monitor Switch to the “System Monitor” tab on Parameters window if it is already
Tools > Acquisition Switch to the “Acquisition” tab on Parameters window if it is already open. If
adds “Clock” tab first. For details, see Clock Tab on page 61.
adds “IOs” tab first. For details, see IOs Tab on page 64.
If not, it adds “Configurations” tab first. For details, see Configurations
Tab
on page 62.
open. If not, it adds “System Monitor” tab first. For details, see System
Monitor Tab
not, it adds “Acquisition” tab first. For details, see Acquisition Tab on page 58.
on page 65.
48 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3
Windows Menu
The Windows menu allows you to change the layout/arrangement of various open trace and frequency windows. It provides the following selections:
Windows > Close All Windows Closes all currently open time and /frequency windows.
Windows > Cascade Arranges the currently open trace windows as cascaded tabs, so that the
content of one tab at a time is visible.
Windows > Tile Horizontally Aligns the multiple opened windows in a horizontal sequence. The following
figure shows the horizontal sequence of two different windows.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 49
3 M8131A User Interface
Windows > Tile Vertically Aligns open windows in a vertical sequence. The following figure shows the
vertical sequence of two different windows.
Help Menu
Help > User Guide Opens the M8131A User’s Guide.
Help > Online Support Opens the instrument’s product support web page.
The Help menu includes the following selections:
Help > About Displays product information including version number, build date, build
50 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
info, installed licenses, available options and web links for M8131A information and support.

Tool Bar

M8131A User Interface 3
The tool bar provides the following convenient functions:
Capturing mode This is an icon to mark the buttons to its right to be related to capturing. It
works in conjunction with single/continuous button. Its functionality expects at least one selected channel (a channel can be selected from Acquisition Tab > Channel Parameters > Display On check-box). The default state is “start”
which means by clicking, the current data buffer is cleared and a new
measurement, i.e. data capturing, is started. The measurement is performed:
Once only: if single measurement was selected.
Continuously: if continuous measurement was selected. Here the measurement can be terminated by pressing stop button At the end of each measurement, the corresponding time and frequency signals of selected channel(s) are plotted in trace windows.
Use mouse to control marker If selected, a marker is added to the selected trace. Using the mouse, the
marker can be moved on the trace in order to read the value of desirable points. To set the marker to a different channel, right click on graph panel (the black area) and select the desirable channel number from Marker > Set to Channel X. Set to Channel X is disabled if its corresponding channel number from Acquisition Tab > Channel Parameters > Display On check-box is not selected.
Use mouse to zoom Use this tool to select a rectangular area of a trace for closer examination.
Auto scale once Auto Scale adjusts All open windows’ scaling so that the whole traces are
visible. An auto-scale for one window can be done via Auto Scale inside graph panel’s context menu (i.e. right-click and use context menu).
Use mouse to pan Use the pan/hand tool to move the area of viewing in the desired direction.
Streaming mode This is an icon that marks the buttons to its right to be related to streaming.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 51
Click the start button to start the streaming process. Once the process has started, it can be terminated by pressing the stop button .
3 M8131A User Interface

Lower Pane

The lower pane provides the following options:
Show Status Window Opens the Status Window. This feature is currently not implemented.
Show Error List Window Opens the window that shows the list of errors and warnings. For details, see

Errors List Window

Use this window to view errors, warnings, and information.
Errors List Window on page 52
Figure 8 Error list window
For each error, it shows error details i.e. notification type, time stamp and description. It has the following controls, signs, and columns:
52 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3

Status Bar

(Clear All) Click this button to clear all the errors from the errors list
window.
Open On Error Click this toggle button to automatically open the errors list
window whenever an error occurs (default) or not.
Copy Click this button to copy the selected message(s).
Select All Click this button to select all messages inside the list.
The status bar contains the following fields from left to right:
• Connection state:
“Not Connected” – No instrument is connected.
“Connected: <Instrument resource string>” – An instrument is
connected. The resource string, for example PXI36::0::0::INSTR is displayed.
“Simulation Mode” – No real instrument is connected. The user
interface is in simulation mode. Click this field to open the Instrument Selection Dialog.
• Instrument status - Displays the instrument status, for example “Reset
complete” after issuing a reset command.

Parameters Window

The Parameters Window provides various tabs which are used to configure the parameters of the M8131A instrument. These tabs include: Acquisition, System Monitor, Clock, Configurations and IOs.
Figure 9 on page 54 illustrates an example of the Parameter Window.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 53
3 M8131A User Interface
NOTE
Figure 9 Parameters window
The details of the parameters provided by these tabs are described in the sections, that follow.
You can use the numeric controls to adjust the values and units. For details on how to use numeric control, refer to the section
Control Usage
54 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
on page 66.
Numeric

Trace Window

M8131A User Interface 3
The trace window contains time and frequency graph panels. A graph panel is an area on which the plotted graphs for a signal is shown.
Figure 10 Frequency graph
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 55
3 M8131A User Interface
Figure 11 Time graph
56 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
The context-menu of a graph panel provides features (i.e., effective on the current graph panel and not on the other open panels):
Figure 12 Context menu of a graph
M8131A User Interface 3
Channel Selection: Turns on/off the display of relevant channel. If
"Display On" check-box for one Channel is deselected (Acquisitions > CHX > Display On), its corresponding field inside context-menu is not accessible (grayed-out).
Markers: It sets a marker on desirable trace. Refer to toolbar menu >
control marker for more information.
Auto Scale: It scales the current graph panel. Refer to toolbar menu >
Auto-scale once, for more information.
Show Grid: Use this check-box to show/hide grids from the graph.
Clear Marker: It clears the selected marker from the graph panel. It is
only enabled when a marker is selected.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 57
3 M8131A User Interface

Acquisition Tab

The Acquisition tab manages acquisition and its associated parameters. It includes the General Parameters and Channel Parameters.
Figure 13 Acquisition tab
58 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3
General parameters
• Sample Rate - Based on available options, a sample rate of 16 GSa/s or
32 GSa/s can be selected.
• Mode - The following two modes are available:
Direct Mode - The direct mode is available for both 16 GSa/s or
32 GSa/s sample rates.
DDC Mode - The DDC (Digital Down Conversion) mode is available
for only 16 GSa/s sample rate.
• Decimation Factor - The decimation factor depends upon the sample
rate and mode. The following decimation factors are available:
Sample Rate Mode Decimation Factor
16 GSa/s Direct 1 & 2
16 GSa/s DDC 32, 64, 128 & 256
32 GSa/s Direct 1
• Capture Settings
Acquisition Mode - This defines how the acquisition of samples
should be done. The only possible choice is Not-Segmented, which means that the length of output sampled vector is defined by:
Full Memory Size - Sets the length of waveform to the
maximum available memory. Available when the operating mode is selected as Capturing.
Record Time - The captured waveform has a length of
sample-rate (GSa/s) * record-length (sec).
As an example, 1 usec is equivalent to 16000 samples.
• Streaming Settings
Currently, the streaming process can be started/stopped with
default settings with the run/stop button which is available on the tool bar. For details, refer to section To o l B a r on page 51.
• Channel Parameters
Channel 1/2/3/4 - Selects the channel. The availability of channels
depends upon the sample rate. For the 16 GSa/s sample rate, all four channels are available. However, for the 32 GSa/s sample rate, only two channels (Channel 1 & 2) are available.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 59
3 M8131A User Interface
Display On: Turns on or off the waveform memories for
corresponding channel number and display its content in trace panel(s). The “Run” capture button is functional only when at least one channel is selected.
DDC IF - Sets the digital down conversion intermediate frequency.
This option is only available when the mode is selected as “DDC”. Please note that you are only allowed to enter the following DDC IF values; 0 MHz, 250 MHz, 500 MHz, 750 MHz, 1 GHz & 1.25 GHz.
Frontend Settings - The forntend settings are available, depending
upon the installed options (see Instrument Options on page 18). These settings allow you to set the signal offset and range.
60 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Clock Tab

M8131A User Interface 3
The Clock tab provides the clock settings to M8131A module.
Figure 14 Clock tab
Input Clock Settings
• Ref. Clock Source - A clock reference input is provided on the front panel of the M8131A module. It is used as the clock reference for all four analog channels of that M8131A. The options are:
Internal
External 10MHz
External 100MHz
• Sample Clock Source - A source to sample clock input, on the front panel of M8131A module, can be selected from:
Internal: In this case, sample clock output port should be connected
to sample clock input. The Sample CLK Out must be connected with Sample Clk In with a semi-rigid cable when an internally generated sample clock of the M8131A’s is used. For details, refer to section
Inputs/Outputs on page 19.
External: In this case, sample clock input port should be connected
to analog to digital converters.
Synchronization Settings
• Sync. In Threshold: Not implemented
• Sync. Output: Not implemented
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 61
3 M8131A User Interface

Configurations Tab

The Configuration tab allows to configure FPGA settings.
Figure 15 Configuration tab
To configure FPGA setting: 1 Select the FPGA operating mode. The choices are “Normal” and “Open
FPGA”.
Normal: The default DPU FPGA image contained in the software
installation is used.
Open FPGA: The default DPU FPGA image or a customer-provided
image can be used.
2 Click on the button. A standard Open dialog box will appear.
62 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3
3 Select a FGPA setting files in the module (*.bit) and then click Open. 4Click on the Configure button to load the selected file. 5Click on the Default button to set the FPGA setting back to the default
state.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 63
3 M8131A User Interface

IOs Tab

The IOs tab provides input and output settings for analogue and optical data interfaces.
Figure 16 IOs tab
64 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
• Optical Data Interfaces (ODI) - The respective ODI ports can be activated/deactivated by selecting the corresponding check-boxes. If these check-boxes are selected without making any physical connections, an error for loss of signal will be shown.

System Monitor Tab

M8131A User Interface 3
The System Monitor tab display the total current of the module. If the total module current crosses the threshold current, then the module will turn off automatically.
Figure 17 System Monitor tab
• Module Total Current: The measured current can be updated by pressing the Refresh button.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 65
3 M8131A User Interface

Working with M8131A Front Panel

Numeric Control Usage

The numeric control is used to adjust the value and units. Whenever you bring the mouse pointer over the numeric control, a tool tip appears which shows the possible values in that range.
Figure 18 Tool tip showing possible values in the range
The numeric controls can be used in the following ways:
Use the up/down arrows to change the value. The control automatically stops at the maximum/minimum allowed value.
66 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
You can increase or decrease the value starting at a specific portion of the value. To do this, place the cursor to the right of the targeted digit and use the up/down arrows. This is especially useful when changing a signal characteristic that is immediately implemented, and observing the result in another instrument. For example, you can change the signal generator’s frequency by increments of 10 MHz and observe the measured result in a signal analyzer:
Figure 19 Typing directly into the field
Type directly into the field and press the Enter key. If you enter a value outside the allowed range, the control automatically limits the entered value to the maximum or minimum allowed value.
When you type the value, you can type the first letter of the allowed unit of measure to set the units. For example, in the Frequency control you can use "H", "K", "M", or "G" to specify Hz, KHz, MHz or GHz , respectively. (The control is not case sensitive.)
The controls allow scientific notation if it is appropriate to the allowed range. Type the first decimal number, enter an "E", and omit any trailing zeroes. For example, in the Frequency control you can type 2.5e+9 and press [Enter] to set the frequency to 2.5 GHz. (The plus sign is automatically inserted if it is omitted.)

Window Controls Usage

The window options allow you to float or dock anywhere in the application window. It provides quick access to logically grouped features from one location. For example, you can select and generate various layouts from the single window.
M8131A User Interface 3
You can move a window anywhere on the screen or to a different monitor. You can also close the floating windows.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 67
3 M8131A User Interface

Calibration Dialog

Calibration is required to compensate some hardware distortions and to have a proper symmetric signal leveled at zero volt. The calibration process might take up to five hours. After a successful calibration, the system stores the results and reloads them upon a power cycle.
Figure 20 Calibrated zero volts on all channels with 50-ohm resistor caps installed
The calibration dialog is used to calibrate M8131A module. You can also save and load the calibration for future use.
68 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Figure 21 Calibration dialog
M8131A User Interface 3

Starting Calibration Process

To start the calibration: 1Click on the Start Calibration button. The Process Result will display
the message “Calibration has been started”. At any point of time, you can quit the calibration process by clicking on the Abort button.

Saving and Loading Calibration

The calibration can be saved under the defined file name and location and can be later used for testing purpose.
To save the calibration; 1Click on the Save button. A standard Windows Save As dialog box will
appear.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 69
3 M8131A User Interface
Figure 22 Saving calibration
2 Specify the name (.TXT) and location 3Click Save.
70 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3
To load the calibration; 1Click on the Load button. A standard Windows Open dialog box will
appear.
Figure 23 Loading calibration
2 Locate the calibration file (.TXT). 3Click Open.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 71
3 M8131A User Interface

Exporting Waveforms

Waveforms can be exported to the available channels (channel 1/2/3/4).
To save a waveform; 1Go to File > Export Waveform and then select a channel. A standard
Windows Save Waveform to File dialog box will appear.
Figure 24 Exporting waveforms
2 Specify the name (.TXT) and location 3Click Save.
72 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Integrating 89600 VSA with M8131A

Follow the given steps to configure M8131A with 89600 VSA: 1 Get the HiSLIP information
a Start the M8131A Soft Front Panel. b On the menu bar, click Help > About. c Copy the HiSLIP information from the dialog.
M8131A User Interface 3
2 Run Connection Expert
a Run the Keysight IO Libraries Suite Connection Expert tool. a Click the Keysight IO Libraries Suite icon in the Windows
application task bar, then click Connection Expert.
a Auto-scan/Rescan will automatically detect many (but not all) LAN
instruments on your local LAN subnet. If an instrument is not automatically discovered, you must manually add the instrument:
a Click Add, select LAN Instrument from the context list. This opens
the list of discovered LAN instruments.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 73
3 M8131A User Interface
b Click the Enter Address tab. c Enter the LAN address or hostname, select the protocol used to
communicate with the instrument.
d Click OK.
3 Integrate 89600 VSA with M8131A
a Start the 89600 VSA application. b From the menu bar, click Utilities > Hardware > Configuration. The
Hardware dialog box will appear.
c Click the Refresh button in the Discovered Instruments tab.
The M8131A should be now available.
d Click the Configurations tab and click the green plus sign . The
New Hardware Configuration dialog box will appear:
e Select M8131 and click [>] f Rename the configuration as per your choice and click OK.
74 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
M8131A User Interface 3
g Select the new Analyzer Configuration (M8131A(1)) as shown in the
following figure:
h The 89600 VSA will now acquire the M8131A. i Close the Hardware dialog and start the measurement.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 75
Keysight M8131A 16/32 GSa/s Digitizer
User’s Guide

4 Remote Programming

Remote Programming Overview / 78 Status Commands / 80 Acquire Commands / 88 Calibration Commands / 90 Channel Commands / 92 Data Processing Commands / 94 Common Commands / 96 Mass Memory Commands / 99 Root Level Commands / 106 System Commands / 107 Time Base Commands / 112 Waveform Commands / 113 Instrument Commands / 116 Optical Data Interface Commands / 119 :TEST Commands / 129
4 Remote Programming

Remote Programming Overview

This chapter introduces the basics for remote programming of an M8131A instrument using SCPI commands.

Instructions

Instructions, both commands and queries, normally appear as strings embedded in a statement of your host language, such as Visual Basic for Applications (VBA), Visual Basic .NET, C#, C, etc.
The only time a parameter is not meant to be expressed as a string is when the instruction's syntax definition specifies <binary_block _data>, such as with the :SYSTem:SET command. There are only a few instructions that use block data.
Instructions are composed of two main parts:
• The header, which specifies the command or query to be sent.
• The program data, which provides additional information to clarify the meaning of the instruction.

Instruction Header

The instruction header is one or more command mnemonics separated by colons (:). They represent the operation to be performed by the oscilloscope. Queries are formed by adding a question mark (?) to the end of the header. Many instructions can be used as either commands or queries, depending on whether or not you include the question mark. The command and query forms of an instruction usually have different program data. Many queries do not use any program data.

White Space (Separator)

White space is used to separate the instruction header from the program data. If the instruction does not require any program data parameters, you do not need to include any white space. In this manual, white space is defined as one or more spaces. ASCII defines a space to be character 32 in decimal.
78 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Braces

Ellipsis

Square Brackets

Program Data

Remote Programming 4
When several items are enclosed by braces, { }, only one of these elements may be selected. Vertical line ( | ) indicates "or". For example, {ON | OFF} indicates that only ON or OFF may be selected, not both.
... An ellipsis (trailing dots) indicates that the preceding element may be repeated one or more times.
Items enclosed in square brackets, [ ], are optional.
Program data is used to clarify the meaning of the command or query. It provides necessary information, such as whether a function should be on or off, or which waveform is to be displayed. Each instruction's syntax definition shows the program data and the values they accept.
When there is more than one data parameter, they are separated by commas (,). You can add spaces around the commas to improve readability.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 79
4 Remote Programming

Status Commands

This section describes the structure of the SCPI status system used by the M8131A. The status system records various conditions and states of the instrument in several register groups as shown on the following pages. Each of the register groups is made up of several low level registers called Condition registers, Event registers, and Enable registers which control the action of specific bits within the register group.
These groups are explained below:
A condition register continuously monitors the state of the instrument. The bits in the condition register are updated in real time and the bits are not latched or buffered. This is a read-only register and bits are not cleared when you read the register. A query of a condition register returns a decimal value which corresponds to the binary-weighted sum of all bits set in that register.
An event register latches the various events from changes in the condition register. There is no buffering in this register; while an event bit is set, subsequent events corresponding to that bit are ignored. This is a read only register. Once a bit is set, it remains set until cleared by query command (such as STAT:QUES:EVEN?) or a *CLS (clear status) command. A query of this register returns a decimal value which corresponds to the binary-weighted sum of all bits set in that register.
An enable register defines which bits in the event register will be reported to the Status Byte register group. You can write to or read from an enable register. A *CLS (clear status) command will not clear the enable register but it does clear all bits in the event register. A STAT:PRES command clears all bits in the enable register. To enable bits in the enable register to be reported to the Status Byte register, you must write a decimal value which corresponds to the binary weighted sum of the corresponding bits.
Transition Filters are used to detect changes of the state in the condition register and set the corresponding bit in the event register. You can set transition filter bits to detect positive transitions (PTR), negative transitions (NTR) or both. Transition filters are read/write registers. They are not affected by *CLS.
80 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
0 1 2
USB Module Connection State
0 1 2 3 4
ADC Calibration Status
ADC Calibration Run Status
0
Operation Complete
Device Dependent Error
Query Error
Execution Error
Command Error
Power On
Summary of IEEE 488.2 Status Structure Registers
QUEStionable Status
Reference Clock
0
Standard Event Status Register
0 1 2 3 4 5 6 7
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
OPERation Status
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Remote Programming 4
Error/Event Queue
Status Byte
0 1 2
MAV
RQS
3 4 5 6 7
Figure 25 Status register structure
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 81
4 Remote Programming

STATus:PRESet

Status Byte Register

Clears all status group event registers. Presets the status group enables PTR and NTR registers as follows:
ENABle = 0x0000, PTR = 0xffff, NTR = 0x0000
The Status Byte summary register reports conditions from the other status registers. Data that is waiting in the instrument’s output buffer is immediately reported on the “Message Available” bit (bit 4) for example. Clearing an event register from one of the other register groups will clear the corresponding bits in the Status Byte condition register. Reading all messages from the output buffer, including any pending queries, will clear the “Message Available” bit. To set the enable register mask and generate an SRQ (service request), you must write a decimal value to the register using the *SRE command.
Table 5 Status byte register
82 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Bit Number Decimal Value Definition
0 Not used 1 Not Used. Returns “0”
1 Not used 2 Not Used. Returns “0”
2 Error Queue 4 One or more errors are stored in the Error Queue
3 Questionable Data 8 One or more bits are set in the Questionable Data
Register (bits must be enabled)
4 Message Available 16 Data is available in the instrument’s output buffer
5 Standard Event 32 One or more bits are set in the Standard Event Register
6 Master Summary 64 One or more bits are set in the Status Byte Register
7 Operational Data 128 One or more bits set in the Operation Data Register (bits
must be enabled)

Questionable Data Register Command Subsystem

The Questionable Data register group provides information about the quality or integrity of the instrument. Any or all of these conditions can be reported to the Questionable Data summary bit through the enable register.
Table 6 Questionable data register
Bit Number Decimal Value Definition
0 Not used 1 Returns “0”
1 Not used 2 Returns “0”
2 Not used 4 Returns “0”
3 Not used 8 Returns “0”
4 Not used 16 Returns “0”
5 Reference Clock Status 32 Instable or missing external reference clock.
6 Not used 64 Returns “0”
Remote Programming 4
7 USB disconnected 128 USB module connection state
8 Not used 256 Returns “0”
9 Not used 512 Returns “0”
10 ADC Calibration Status 1024 ADC re-calibration recommended.
11 Not used 2048 Returns “0”
12 Not used 4096 Returns “0”
13 Not used 8192 Returns “0”
14 Not used 16384 Returns “0”
15 Not used 32768 Returns “0”
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 83
4 Remote Programming

Operation Status Subsystem

The Operation Status register contains conditions which are part of the instrument’s normal operation.
Table 7 Operation status register
Bit Number Decimal Value Definition
0 Not used 1 Returns “0”
1 Not used 2 Returns “0”
2 Not used 4 Returns “0”
3 Not used 8 Returns “0”
4 Not used 16 Returns “0”
5 Not used 32 Returns “0”
6 Not used 64 Returns “0”
7 Not used 128 Returns “0”
8 Not used 256 Returns “0”
9 Not used 512 Returns “0”
10 ADC Calibration Run Status 1024 ADC calibration is running.
11 Not used 2048 Returns “0”
12 Not used 4096 Returns “0”
13 Not used 8192 Returns “0”
14 Not used 16384 Returns “0”
15 Not used 32768 Returns “0”
84 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Reference Clock Status Subsystem

The Reference Clock Status register contains the reference clock of the module.
The following SCPI commands and queries are supported:
:STATus:QUEStionable:REFClock[:EVENt]?
:STATus:QUEStionable:REFClock:CONDition?
:STATus:QUEStionable:REFClock:ENABle[?]
:STATus:QUEStionable:REFClock:NTRansition[?]
:STATus:QUEStionable:REFClock:PTRansition[?]
Table 8 Reference clock status register
Bit Number Decimal Value Definition
0 Amplitude too small 1 Amplitude of external reference signal too small.
1 Amplitude too big 2 Amplitude of external reference signal too big.
2 Frequency out-of-range 4 Frequency of external reference signal out-of-range.
Remote Programming 4

Connection Status Subsystem

The Connection Status register contains the state of the USB connection to the M8131A module.
The following SCPI commands and queries are supported:
:STATus:QUEStionable:CONNection[:EVENt]?
:STATus:QUEStionable:CONNection:CONDition?
:STATus:QUEStionable:CONNection:ENABle[?]
:STATus:QUEStionable:CONNection:NTRansition[?]
:STATus:QUEStionable:CONNection:PTRansition[?]
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 85
4 Remote Programming

ADC Calibration Status Subsystem

Table 9 Connection status register
Bit Number Decimal Value Definition
0 USB disconnected 1 USB module connection state
The following SCPI commands and queries are supported:
:STATus:QUEStionable:CALibration:ADC[:EVENt]?
:STATus:QUEStionable:CALibration:ADC:CONDition?
:STATus:QUEStionable:CALibration:ADC:ENABle[?]
:STATus:QUEStionable:CALibration:ADC:NTRansition[?]
:STATus:QUEStionable:CALibration:ADC:PTRansition[?]
Bit Number Decimal Value Definition
0 Calibration data invalid 1 ADC calibration data is invalid.
1 Calibration necessary 2 ADC re-calibration is necessary.
2 Calibration not executed 4 No ADC calibration executed so far.
3 Calibration aborted 8 ADC calibration was aborted by the user.
4 Calibration failed 16 ADC calibration failed.
86 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Table 10 ADC calibration status register

Calibration Run Status Subsystem

The following SCPI commands and queries are supported:
:STATus:OPERation:CALibration:ADC[:EVENt]?
:STATus:OPERation:CALibration:ADC:CONDition?
:STATus:OPERation:CALibration:ADC:ENABle[?]
:STATus:OPERation:CALibration:ADC:NTRansition[?]
:STATus:OPERation:CALibration:ADC:PTRansition[?]
Table 11 Run status register
Bit Number Decimal Value Definition
0 Calibration Run Status 1 Indicates if an ADC calibration is running
Remote Programming 4
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 87
4 Remote Programming

Acquire Commands

:ACQuire: SRATe[?]

The ACQuire subsystem commands set up conditions for executing a :DIGitize root level command to acquire waveform data into capture memory or a :STReam root level command to stream waveform data out of the ODI links. The commands in this subsystem select the sampling frequency and the number of data points.
Command :ACQuire:SRATe {S16G | S32G}
The command sets the acquisition sampling rate.
S16G 16GSa/s
S32G 32GSa/s
Query :ACQuire:SRATe?
The query returns the acquisition sampling rate.
Example Command
:ACQuire:SRATe S16G

:ACQuire:POINts[?]

Command :ACQuire:POINts <points_value>
The command sets the requested memory depth for an acquisition into capture memory.
<points_value> An integer representing the memory depth per channel. When raw data is captured, the value denotes the number of samples. When IQ data is captured, the value denotes the number of IQ sample pairs.
The minimum and maximum values and the granularity of the points available for a channel depend on the sampling rate, the data processing mode (Direct/DDC) and the decimation factor. If the passed parameter does not fulfill the granularity the value is adjusted to the nearest supported value.
88 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Sample Rate 16 GSa/s Minimum Maximum Granularity
Direct, No Decimation 40 1310720 40
Direct, Decimation by 2 32 1048576 32
DDC 16 524288 16
Sample Rate 32 GSa/s Minimum Maximum Granularity
Direct, No Decimation 80 2621440 40
Query :ACQuire:POINts?
The query returns the value of the memory depth.
Returned Format [:ACQuire:POINts] <points_value><NL>
Remote Programming 4
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 89
4 Remote Programming

Calibration Commands

:CALibrate:ADC[:STARt]

Description The command starts the self-calibration of the ADC module.

:CALibrate:ADC:ABORt

Description The command aborts a running self-calibration of the ADC module.

:CALibrate:ADC:INFormation

Description The query returns information about the last calibration of the ADC
The CALibration subsystem commands allow to re-calibrate the ADC of the digitizer, to query the calibration status and to save and load calibration data.
Command :CALibrate:ADC[:STARt]
Command :CALibrate:ADC:ABORt
Query :CALibrate:ADC:INFormation?
module.
Returned Format [:CALibrate:ADC:INFormation] <information_string><NL>
<information_string> Contains information about type (“User” or “Factory”) and date of last calibration.
Example Query
:CALibrate:ADC:INFormation?
“M8131A Setup:
Mode: 16GHz on 4 channels
Calibration Loaded:
1(User): 2018-03-09 17:33:44”
90 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
Remote Programming 4

:CALibrate:ADC:SAVE

Command :CALibrate:ADC:SAVE <file_name>
Description The command saves the calibration data of the ADC module to a file.
<file_name> A quoted ASCII string with a maximum of 254 characters including the entire path name, if used. The filename assumes the present working directory, if a path does not precede the file name.

:CALibrate:ADC:LOAD

Command :CALibrate:ADC:LOAD <file_name>
Description The command loads the calibration data of the ADC module from a file.
<file_name> A quoted ASCII string with a maximum of 254 characters including the entire path name, if used. The filename assumes the present working directory, if a path does not precede the file name.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 91
4 Remote Programming

Channel Commands

:CHANnel<N>:DISPlay

Description The command selects or deselects a channel for waveform data capture to
Returned Format [:CHANnel<N>:DISPlay] {1 | 0}<NL>
The CHANnel subsystem commands control the selection of channels for memory capture. Additionally, if the option -DDC is installed, commands to configure the Digital-Down-Conversion (DDC) are available.
Command :CHANnel<N>:DISPlay {{ON | 1} | {OFF | 0}}
memory. Additionally, it turns the data display of the specified channel on or off.
<N> An integer, 1-4 in a single digitizer system.
Query :CHANnel<N>:DISPlay?
The query returns the current display condition for the specified channel.
92 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

:CHANnel<N>:OFFSet

Command :CHANnel<N>:OFFSet <offset>
Description The command sets the vertical value that is represented at the center of
the display for the selected channel.
Range -400 mV to 400 mV
Example :CHAN1:OFFS 2.00000000000000E-01

:CHANnel<N>:RANGe

Command :CHANnel<N>:RANGe <range>
Description The command defines the full-scale vertical axis of the selected channel.
The values represent the full-scale deflection factor of the vertical axis in volts.
Range 40 mV to 400 mV
Example :CHAN1:RANG 2.00000000000000E-01
Remote Programming 4

:CHANnel<N>:DPRocessing:DDC:CFRequency

Command :CHANnel<N>:DPRocessing:DDC:CFRequency
{<frequency_value>}
Description The command sets the center frequency of the DDC for the specified
channel.
<N> An integer, 1-4 in a single digitizer system.
<frequency_value> A floating point value representing the center
frequency of the input signal. The valid range is from 0 to 1250 MHz in steps of 250 MHz.
Query :CHANnel<N>:DPRocessing:DDC:CFRequency?
The query returns the current center frequency of the DDC for the specified channel.
Returned Format [:CHANnel<N>:DPRocessing:DDC:CFRequency]
<frequency_value><NL>
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 93
4 Remote Programming

Data Processing Commands

:DPRocessing[:MODE]

Command :DPRocessing[:MODE] {DIRect|DDC}
Description The command selects the data processing mode for the specified channel.
Query :DPRocessing[:MODE]?
Returned Format :DPRocessing[:MODE]] {DIRect | DDC}<NL>
The selected mode determines, which type of data is forwarded to the capture memory and the ODI port.
DIRect: No data processing, the raw ADC samples are forwarded to the capture memory and the ODI port.
DDC: Digital-down conversion, the ADC samples are down-converted from the center frequency to baseband followed by a decimation and then forwarded to the capture memory and the ODI port.
<N> An integer, 1-4 in a single digitizer system.
The query returns the current data processing mode for the specified channel.

:DPRocessing:DDC:DECimation

Command :CHANnel<N>:DPRocessing:DDC: DECimation {POW5 | POW6
| POW7 | POW8}
Description The command sets the decimation factor of the DDC for the specified
channel. All decimation factors are powers of 2.
<N> An integer, 1-4 in a single digitizer system.
5
POW5 2
6
POW6 2
POW7 27
POW8 2
Query :CHANnel<N>:DPRocessing:DDC:DECimation?
The query returns the current decimation factor of the DDC for the specified channel.
94 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide
8
Remote Programming 4
Returned Format [:CHANnel<N>:DPRocessing:DDC: DECimation] {POW5 |
POW6 | POW7 | POW8} <NL>

:DPRocessing:DIRect:DECimation

Command DPRocessing:DIRect:DECimation {POW0 | POW1}
Description The command sets the decimation factor of the Direct mode for the
specified channel. All decimation factors are powers of 2.
Parameters POW0 2
Example Command
0
1
POW1 2
:DPR:DIR:DEC POW1
Query
:DPR:DIR:DEC? -> POW1
The query returns the current decimation factor of the Direct mode for the specified channel.
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 95
4 Remote Programming

Common Commands

*IDN?

*CLS

Read the instrument’s identification string which contains four fields separated by commas. The first field is the manufacturer’s name, the second field is the model number, the third field is the serial number, and the fourth field is a revision code which contains four numbers separated by dots and a fifth number separated by a dash:
Keysight Technologies, M8131A,<serial number>, x.x.x.x-h
x.x.x.x= Soft Front Panel revision number, e.g. 2.0.0.0
h= Hardware revision number
Clear the event register in all register groups. This command also clears the error queue and cancels a *OPC operation. It doesn’t clear the enable register.
96 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

*ESE

Enable bits in the Standard Event Status Register to be reported in the Status Byte. The selected bits are summarized in the “Standard Event” bit (bit 5) of the Status Byte Register. The *ESE? query returns a value which corresponds to the binary-weighted sum of all bits enabled decimal by the *ESE command. These bits are not cleared by a *CLS command. Value Range: 0–255.

ESR?

Query the Standard Event Status Register. Once a bit is set, it remains set until cleared by a *CLS (clear status) command or queried by this command. A query of this register returns a decimal value which corresponds to the binary-weighted sum of all bits set in the register.

*OPC

Set the “Operation Complete” bit (bit 0) in the Standard Event register after the previous commands have been completed.

*OPC?

*OPT?

*RST

*SRE[?]

Remote Programming 4
Return “1” to the output buffer after the previous commands have been completed. Other commands cannot be executed until this command completes.
Read the installed options. The response consists of any number of fields separated by commas.
Reset instrument to its factory default state.
Enable bits in the Status Byte to generate a Service Request. To enable specific bits, you must write a decimal value which corresponds to the binary-weighted sum of the bits in the register. The selected bits are summarized in the “Master Summary” bit (bit 6) of the Status Byte Register. If any of the selected bits change from “0” to “1”, a Service Request signal is generated. The *SRE? query returns a decimal value which corresponds to the binary-weighted sum of all bits enabled by the *SRE command.

*STB?

Query the summary (status byte condition) register in this register group. This command is similar to a Serial Poll but it is processed like any other instrument command. This command returns the same result as a Serial Poll but the “Master Summary” bit (bit 6) is not cleared by the *STB? command.

*TST?

Execute Self Tests. If self-tests pass, a 0 is returned. A number lager than 0 indicates the number of failed tests.
To get actual messages, use :TEST:TST?
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 97
4 Remote Programming

*LRN?

*WAI?

Query the instrument and return a binary block of data containing the current settings (learn string). You can then send the string back to the instrument to restore this state later. For proper operation, do not modify the returned string before sending it to the instrument. Use :SYST:SET to send the learn string. See :SYSTem:SET[?] on page 108.
Prevents the instrument from executing any further commands until the current command has finished executing.
98 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

Mass Memory Commands

NOTE

:MMEMory:CATalog?

Query :MMEMory:CATalog? [<directory_name>]
Description Query disk usage information (drive capacity, free space available) and
Remote Programming 4
The MMEMory subsystem allows to access files on the host executing the M8131A firmware.
MMEM commands requiring <directory_name> assume the current directory if a relative path or no path is provided. If an absolute path is provided, then it is ignored.
obtain a list of files and directories in a specified directory in the following format:
<numeric_value>,<numeric_value>,{<file_entry>}
The command returns two numeric parameters and as many strings as there are files and directories. The first parameter indicates the total amount of storage currently used in bytes. The second parameter indicates the total amount of storage available, also in bytes. The <file_entry> is a string. Each <file_entry> indicates the name, type, and size of one file in the directory list:
<file_name>,<file_type>,<file_size>
As the Windows file system has an extension that indicates file type, <file_type> is always empty. <file_size> provides the size of the file in bytes. In case of directories, <file_entry> is surrounded by square brackets and both <file_type> and <file_size> are empty.
Example Query
:MMEM:CAT?
Keysight M8131A 16/32 GSa/s Digitizer User’s Guide 99
4 Remote Programming

:MMEMory:CDIRectory

Command :MMEMory:CDIRectory [<directory_name>]
Description The command changes the default directory for a mass memory file
system. The <directory_name> parameter is a string. If no parameter is specified, the directory is set to the *RST value. At *RST, this value is set to the default user data storage area, that is defined as System.Environment.SpecialFolder.Personal
e.g. C:\Users\Name\Documents
MMEMory:CDIRectory? — Query returns full path of the default directory.
Parameter <directory_name>
Example Command
:MMEM:CDIR “C:\Users\Name\Documents”
Query
:MMEM:CDIR?
100 Keysight M8131A 16/32 GSa/s Digitizer User’s Guide

:MMEMory:COPY

Command :MMEMory:COPY <string>,<string>[,<string>,<string>]
Description The command copies an existing file to a new file or an existing directory to
a new directory. Two forms of parameters are allowed. The first form has two parameters. In this form, the first parameter specifies the source, and the second parameter specifies the destination.
The second form has four parameters. In this form, the first and third parameters specify the file names. The second and fourth parameters specify the directories. The first pair of parameters specifies the source. The second pair specifies the destination. An error is generated if the source doesn't exist or the destination file already exists.
Parameters <string>,<string>
Example Command
:MMEM:COPY "C:\data.txt", "C:\data_new.txt"
Loading...