background image

3 Keysight SD1 Command Reference

Keysight M3100A/M3102A PXIe Digitizer User's Guide

69

M3601A

Available: No

3. 3. 2. 30 DAQbufferGet

Gets a filled buffer from the channel buffer pool. User has to call DAQbufferAdd with
this buffer to tell the pool that the buffer can be used again.

Parameters

Name

Description

Inputs

moduleID

(Non-object oriented languages only) Module identifier, returned by function

open

nDAQ

DAQ from where get the buffer

errorIn

(LabVIEW only) If it contains an error, the function will not be executed and errorIn will be
passed to errorOut

Outputs

moduleID

(Non-object-oriented languages only) Module identifier, or a negative number for errors
(see

Error Codes

)

errorOut

See

Error Codes

buffer

Buffer obtained

readPointsOut Number of points of the returned buffer

C

short* SD_AIN_DAQbufferGet(int moduleID, int nDAQ, int &readPointsOut, int
&errorOut);

C++

short* SD_AIN:: DAQbufferGet(int nDAQ, int &readPointsOut, int &errorOut);

Visual Studio .NET, MATLAB

short[] SD_AIN::DAQbufferGet(int nDAQ, out int readPointsOut, out int errorOut);

Python

[short[], int} SD_AIN::DAQbufferGet(int nDAQ);

*Returned data array is a NumPY array

Summary of Contents for M3100A PXIe

Page 1: ...User s Guide Keysight M3100A M3102A PXIe Digitizers M3300A M3302A AWG Digitizer Combos...

Page 2: ...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 U...

Page 3: ...ith local AC mains connections Assume all measurement control and data I O connections are for connection to Category I sources unless otherwise marked or described in the user documentation Exercise...

Page 4: ...pliance as a registered supplier This symbol indicates product compliance with the Canadian Interference Causing Equipment Standard ICES 001 It also identifies the product is an Industrial Scientific...

Page 5: ...s 22 3 Keysight SD1 Command Reference 23 3 1 Keysight Supplied Native Programming Libraries 23 3 2 Support for Other Programming Languages 24 3 3 Functions in SD1 Programming Libraries 25 3 3 1 SD_Mod...

Page 6: ...ockSetFrequency 62 3 3 2 25 clockGetFrequency 63 3 3 2 26 clockGetSyncFrequency 64 3 3 2 27 clockResetPhase 65 3 3 2 28 DAQbufferPoolConfig 66 3 3 2 29 DAQbufferAdd 68 3 3 2 30 DAQbufferGet 69 3 3 2 3...

Page 7: ...Design Environment Software on page 4 Keysight M3602A FPGA Design Environment Software on page 8 1 1 Keysight SD1 SFP Software 1 1 1 Overview of Keysight SD1 SFP Software Keysight M3201A M3202A PXIe...

Page 8: ...ght M3100A M3102A PXIe Digitizers M3201A M3202A PXIe AWGs and M3300A M3302A PXIe AWG Digitizer Combinations Keysight SD1 Programming Libraries on page 3 Keysight M3601A Hard Virtual Instrument HVI Des...

Page 9: ...s for a comprehensive set of programming languages such as C C Visual Studio VC C VB MATLAB National Instruments LabVIEW Python etc ensuring full software compatibility and seamless multivendor integr...

Page 10: ...modules in hard real time not by the embeded controller or desktop computer Virtual Instrumentation is the use of customizable software and modular hardware to create user defined measurement systems...

Page 11: ...allel and with perfect intermodule synchronization HVIs provide the same programming instructions available in the Keysight SD1 Programming Libraries HVIs are programmed with Keysight M3601A Hard Virt...

Page 12: ...ming extremely fast and easy Using M3601A and its set of built in instructions the same instructions available for VIs the user can program the hardware modules without any knowledge in FPGA technolog...

Page 13: ...ired This task can be performed seamlessly with Keysight programming tools for example the user can have many HVIs and can control them from a VI using instructions like start stop pause etc Tip New h...

Page 14: ...ustom on board real time processing which might not be covered by the comprehensive off the shelf functionalities of standard hardware products For these applications Keysight supplies Option FP1 Enab...

Page 15: ...ompile and program the FPGA of the module 5x faster project development Graphical environment without performance penalty FPGA know how requirement minimized The graphical environment provides a tool...

Page 16: ...shelf functionalities of the standard products and therefore the development time is dramatically reduced The user can focus exclusively on expanding the functionality of the standard instrument inste...

Page 17: ...he user software using the Keysight SD1 Programming Libraries Parameters Name Description Outputs AngleModCtrl Angle modulation control frequency or phase AmpModCtrl Amplitude modulation control WaveS...

Page 18: ...Name Description Inputs Control AWG operation control QueueCtrl AWG queue control Outputs Data_A Waveform A output for dual waveforms main waveform for single waveforms Data_B Waveform B output for d...

Page 19: ...hape Selects the output waveform between Sine Triangular or Square AWGsignal Arbitrary waveform coming from the AWG It is used as the modulating signal Frequency Signal frequency value Phase Signal ph...

Page 20: ...t indicates when the AWGsignal starts a waveform Amplitude Signal amplitude value OffsetDC offset value Sine Sinusoidal waveform coming from the Function Generator Triangular Triangular waveform comin...

Page 21: ...ogramming Tools Keysight M3100A M3102A PXIe Digitizer User s Guide 15 M3602A DOut Block This block sends the data directly to the hardware analog output Parameters Name Description Inputs data data to...

Page 22: ...16 Keysight M3100A M3102A PXIe Digitizer User s Guide...

Page 23: ...age 22 Keysight M3201A M3202A PXIe AWGs M3100A M3102A PXIe Digitizers and M3300A M3302A PXIe AWG Digitizer Combos can be operated as classical bench top instruments using Keysight SD1 SFP software no...

Page 24: ...chassis If there are no modules available SD1 SFP will launch Demo Offline modules When SD1 SFP is launched the soft front panel appears populated with all available channels waiting for the user to...

Page 25: ...oftware Keysight M3100A M3102A PXIe Digitizer User s Guide 19 2 2 Input Setting Controls Workflow to Use the Digitizer 1 Select a scale value 2 Set a prescaler value 3 Set a coupling and impedance val...

Page 26: ...Scope 1 Select channels 2 Define acquisition type single or run 3 Set coupling and impedance 4 Define triggering a channel any of the channels b edge positive negative both c threshold within full sc...

Page 27: ...4 Frequency Domain Controls Spectrum Analyzer Functionality Workflow to Use the Digitizer as a Spectrum Analyzer 1 Select channel 2 Define number of FFT points set resolution 3 Set windowing option s...

Page 28: ...WINDOW_BARTLETT 1 Hanning Side lobes roll off about 18 dB per octave WINDOW_HANNING 2 Hamming Optimized to minimize the maximum nearest side lobe WINDOW_HAMMING 3 Blackman Higher order generalized cos...

Page 29: ...surement systems is commonly referred as Virtual Instrumentation In Keysight documentation the concept of a Virtual Instrument or VI describes user software that uses programming libraries and is exec...

Page 30: ...heir counterparts of the static libraries Function Parameters Some of the parameters of the library functions are language dependent The table of input and output parameters for each function is a con...

Page 31: ...gital value of a PXI trigger in the PXI backplane Only available in PXI PXI Express form factors SD_AIN Functions on page 38 Function Name Comments channelInputConfig on page 38 Configures the input f...

Page 32: ...the real hardware clock frequency clockGetSyncFrequency on page 64 Returns the frequency of the synchronization clock clockResetPhase on page 65 Sets the module in a synchronized state waiting for th...

Page 33: ...in an HVI register of a hardware module Option HV1 required readRegister on page 76 Reads a value from an HVI register of a hardware module Option HV1 required SD_Module Functions M3602A FPGA related...

Page 34: ...t Slot number in the chassis where the module is located The slot number can be found on the chassis or can be retrieved with getSlot on page 35 compatibility Forces the channel numbers to be compatib...

Page 35: ...int SD_Module open string productName string serialNumber int SD_Module open string productName int chassis int slot int SD_Module open string productName string serialNumber int compatibility int SD...

Page 36: ...ed languages only Module identifier returned by open on page 28 errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs errorOut S...

Page 37: ...cription Inputs errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs nModules Number of Keysight SD1 modules installed in the s...

Page 38: ...f it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs productName Product name of the specified module This product name can be used in open on page 2...

Page 39: ...with getSlot on page 35 errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs serialNumber Serial number of the specified module...

Page 40: ...it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs chassis Chassis number of where a module is located Negative numbers indicate an error see Error...

Page 41: ...returned by moduleCount on page 31 errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs slot Slot number of where the module i...

Page 42: ...lects between trigger lines on the backplaneor thePXI chassis TRIG_PXI Trigger No 4000 Trigger No See also table after AWG External Trigger Source value Digital value with negated logic 0 ON or 1 OFF...

Page 43: ...ternal trigger is a PXI trigger lineand is syn chronized to CLK10 TRIG_PXI Trigger No 4000 Trigger No See also table after AWG External Trigger Source errorIn LabVIEW only If it contains an error the...

Page 44: ...oupling errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleIDout LabVIEW only A copy of moduleID errorOut Keysight SD1...

Page 45: ...value errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleIDout LabVIEW only A copy of moduleID errorOut Keysight SD1 Co...

Page 46: ...or the function will not be executed and errorIn will be passed to errorOut Outputs moduleIDout LabVIEW only A copy of moduleID errorOut Keysight SD1 Command Reference on page 23 C int SD_AIN_channelT...

Page 47: ...er condition there may be words available but less than the amount specified in DAQpoints Parameters Name Description Inputs moduleID Non object oriented languages only Module identifier returned by f...

Page 48: ...igitalTriggerConfig Configures the digital hardware triggers for the selected DAQ Trigger Parameters Name Description Inputs moduleID Non object oriented languages only Module identifier returned by f...

Page 49: ...int triggerBehaviour Visual Studio NET MATLAB int SD_AIN DAQdigitalTriggerConfig int nDAQ int triggerSource int triggerBehaviour Python int SD_AIN DAQdigitalTriggerConfig int nDAQ int triggerSource i...

Page 50: ..._AIN DAQanalogTriggerConfig int nDAQ int triggerNumber Python int SD_AIN DAQanalogTriggerConfig int nDAQ int triggerNumber LabVIEW DAQanalogTriggerConfig vi M3601A Available No 3 3 2 7 DAQread This fu...

Page 51: ...will be passed to errorOut Outputs moduleIDout LabVIEW only A copy of moduleID DAQdata Array with acquired words DAQpoints Number of acquired words status 1 if DAQpoints is equal to the amount of word...

Page 52: ...8 nDAQ DAQ to be started or resumed DAQ n is connected to channel n errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs module...

Page 53: ...elect which DAQs are started or resumed LSB is 0 bit 1 and so forth DAQ n is connected to channel n nDAQ DAQ to be started or resumed DAQ n is connected to channel n errorIn LabVIEW only If it contain...

Page 54: ...n on page 28 nDAQ DAQ to be paused DAQ n is connected to channel n errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleI...

Page 55: ...DAQs are paused LSB is 0 bit 1 and so forth DAQ n is con nected to channel n nDAQ DAQ is paused DAQ n is connected to channel n errorIn LabVIEW only If it contains an error the function will not be e...

Page 56: ...ned by function open nDAQ DAQ to be stopped errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleIDOut Non object oriente...

Page 57: ...k to select which DAQs are paused LSB is 0 bit 1 and so forth DAQ n is connected to channel n DAQ DAQ is paused DAQ n is connected to channel n errorIn LabVIEW only If it contains an error the functio...

Page 58: ...resumed errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleID Non object oriented languages only Module identifier or a...

Page 59: ...rted or resumed LSB is 0 bit 1 and so forth DAQ n is connected to channel n nDAQ DAQ is started or resumed DAQ n is connected to channel n errorIn LabVIEW only If it contains an error the function wil...

Page 60: ...open on page 28 nDAQ DAQ to be reset errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleIDOut Non object oriented langu...

Page 61: ...AQmask Mask to select which DAQs are reset LSB is DAQ 0 bit 1 is DAQ 1 and so forth DAQ n is connected to channel n DAQ DAQ to be reset DAQ n is connected to channel n errorIn LabVIEW only If it conta...

Page 62: ...ction open on page 28 nDAQ DAQ to be triggered DAQ n is connected to channel n erronIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Out...

Page 63: ...turned by function open DAQmask Mask to select which DAQs are triggered LSB is 0 bit 1 and so forth DAQ n is con nected to channel n DAQ DAQ to be triggered DAQ n is connected to channel n errorIn Lab...

Page 64: ...fier returned by function open on page 28 DAQ DAQ whose counter is read errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs mo...

Page 65: ...languages only Module identifier returned by function open on page 28 direction Input or output syncMode Sampling synchronization mode errorIn LabVIEW only If it contains an error the function will no...

Page 66: ...Description Inputs moduleID Non object oriented languages only Module identifier returned by function open on page 28 value Trigger output value 0 OFF 1 ON errorIn LabVIEW only If it contains an error...

Page 67: ...Triggers Parameters Name Description Inputs moduleID Non object oriented languages only Module identifier returned by functionopen on page 28 errorIn LabVIEW only If it contains an error the function...

Page 68: ...object oriented languages only Module identifier returned by func tion open on page 28 frequency Frequency in Hz mode Operation mode of the variable Clock System errorIn LabVIEW only If it contains an...

Page 69: ...ual Studio NET MATLAB double SD_AIN clockSetFrequency double frequency int mode Python double SD_AIN clockSetFrequency double frequency int mode LabVIEW clockSetFrequency vi M3601A Available No 3 3 2...

Page 70: ...ce on page 23 C double SD_AIN_clockGetFrequency int moduleID C double SD_AIN clockGetFrequency Visual Studio NET MATLAB double SD_AIN clockGetFrequency Python double SD_AIN clockGetFrequency LabVIEW c...

Page 71: ...ive numbers for Keysight SD1 Command Reference on page 23 errorOut LabVIEW only Keysight SD1 Command Reference on page 23 C int SD_AIN_clockGetSyncFrequency int moduleID C int SD_AIN clockGetSyncFrequ...

Page 72: ...of moduleID errorOut Keysight SD1 Command Reference on page 23 C int SD_AIN_clockResetPhase int moduleID int triggerBehavior int PXItrigger double skew C int SD_AIN clockResetPhase int triggerBehavior...

Page 73: ...ed in the callback as parameter called user Object It can be null errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleID...

Page 74: ...r errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleID Non object oriented languages only Module identifier or a negat...

Page 75: ...nly If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleID Non object oriented languages only Module identifier or a negative number for erro...

Page 76: ...by function open nDAQ DAQ from where use take out the buffer errorIn LabVIEW only If it contains an error the function will not be executed and errorIn will be passed to errorOut Outputs moduleID Non...

Page 77: ...cription Inputs moduleID Non object oriented languages only Module identifier returned by function open nDAQ DAQ from where use take out the buffer errorIn LabVIEW only If it contains an error the fun...

Page 78: ...ize of the output buffers module and phase dB Scale dB or linear windowType Windowing option section 2 1 5 errorIn LabVIEW only If it contains an error the function will not be executed and errorIn wi...

Page 79: ...bool dB int windowType Visual Studio NET MATLAB int SD_AIN FFT int channel short data out double result bool dB int windowType int SD_AIN FFT int channel short data out double result out double resul...

Page 80: ...not be executed and errorIn will be passed to errorOut Outputs moduleIDout LabVIEW only A copy of moduleID errorOut See Error Codes on page 83 C int SD_Module_writeRegister int moduleID int regNumber...

Page 81: ...umber double regValue string unit int SD_Module writeRegister string regName double regValue string unit Python SD_Module writeRegisterByNumber regNumber regValue SD_Module writeRegisterWithName regNa...

Page 82: ...eadRegisterWithName int moduleID const char regName int regValue double SD_Module_readDoubleRegister int moduleID int regNumber const char unit int errorOut double SD_Module_readDoubleRegisterWithName...

Page 83: ...egisterByNumber regNumber regValue SD_Module readRegisterWithName regName regValue SD_Module readDoubleRegisterByNumber regNumber unit SD_Module readDoubleRegisterWithName regName unit LabVIEW readReg...

Page 84: ...RESSING_AUTOINCREMENT 0 Fixed Initial address is used for thewholeaccess ADDRESSING_FIXED 1 accessMode Selects between the two memory access modes shown below accessMode Description Name Value Non DMA...

Page 85: ...eysight SD1 Command Reference Keysight M3100A M3102A PXIe Digitizer User s Guide 79 Python SD_Module FPGAwritePCport nPCport data address addressMode accessMode LabVIEW writePCport vi M3601A Available...

Page 86: ...s shown below accessMode Description Name Value Non DMA Memory access is splitinto multipleaccesses NONDMA 0 DMA Memory access is donewith a DMA transaction DMA 1 errorIn LabVIEW only If it contains a...

Page 87: ...3 Keysight SD1 Command Reference Keysight M3100A M3102A PXIe Digitizer User s Guide 81 LabVIEW readPCport vi M3601A Available No...

Page 88: ...82 Keysight M3100A M3102A PXIe Digitizer User s Guide...

Page 89: ...15 Keysight Error Any input assigned to the bitMap does not exist SD_ERROR_BUS_INVALID_SIZE 8016 Keysight Error Input size does not fit on this bus SD_ERROR_BUS_INVALID_DATA 8017 Keysight Error Input...

Page 90: ...ERROR_INVALID_PRESCALER 8048 Keysight Error Invalid prescaler SD_ERROR_INVALID_PORT 8049 Keysight Error Invalid port SD_ERROR_INVALID_DIRECTION 8050 Keysight Error Invalid direction SD_ERROR_INVALID_M...

Page 91: ...eform Generator 500 MSa s 16 bit 200 MHz 6 Keysight M3202A PXIe Arbitrary Waveform Generator 1 GSa s 14 bit 400 MHz 7 Keysight M3100A PXIe Digitizer 100 MSa s 14 bit 100 MHz 8 Keysight M3102A PXIe Dig...

Page 92: ...This information is subject to change without notice Keysight Technologies 2013 2018 Edition 1 October 2018 Printed In USA M3100 90002 www keysight com...

Reviews: