Home

Digitizers User Manual

1. Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description name ViChar Pointer to user allocated string into which the model name is returned length lt 32 characters serialNbr Vilnt32 Serial number of the digitizer busNbr Vilnt32 Bus number of the digitizer location slotNbr Vilnt32 Slot number of the digitizer location logical Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Programmer s Reference Manual Page 86 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getInstrumentData ViSession instrumentID ViChar name Vilnt32 serialNbr Vilnt32 busNbr Vilnt32 slotNbr LabVIEW Representation AqDx Query Instrument ID vi Name dup Instrument ID Serial Number Bus Number error out Slot Number Instrument ID error in no error Visual Basic Representation GetInstrumentData ByVal instrumentID As Long ByVal name As String serialNbr As Long busNbr As Long slotNbr As Long As Long Visual Basic NET Representation AcqrsD1_getInstrumentData ByVal instrumentID As Int32 ByVal name As String ByRef serialNbr As Int32 ByRef busNbr As Int32 ByRef slotNbr As Int32 As Int32 MATLAB MEX Representation status name serialNbr busNbr slotNbr Agq_getInstrumentData instrumentID Programmer s Referen
2. Name Type Description returnedSamplesPerSeg Vilnt32 Total number of data samples actually returned DataArray indexFirstPoint DataArray indexFirstPoint returnedSamplesPerSeg 1 indexFirstPoint Vilnt32 Offset of the first valid data point that of the first sample in the destination array It should always be in the range 0 31 It is not an offset in bytes but rather and index in units of samples that may occupy more than one byte sampTime ViReal64 Sampling interval in seconds vGain ViReal64 Vertical gain in Volts LSB See discussion below vOffset ViReal64 Vertical offset in Volts See discussion below returnedSegments Vilnt32 Number of segments nbrAvgW forms Vilnt32 Number of averaged waveforms nominal in segment actualTriggersInAcqLo ViUInt32 Low and high part of the 64 bit count of the number of actualTriggersInAcqHi ViUInt32 triggers taken for the entire acquisition Programmer s Reference Manual Page 134 of 159 acqiris actualDataSize ViUInt32 Actual length in bytes used at dataArray This value is only returned for SSR and AdvancedTDC Analyzers reserved2 Vilnt32 Reserved for future use reserved3 ViReal64 Reserved for future use Discussion All structures used in this function can be found in the header file AcqirisDataTypes h The type of the dataArray is determined from the AqReadParameters struct entry dataType Remember
3. Discussion This function will return only after the acquisition has terminated or when the requested timeout has elapsed whichever is shorter For protection the timeout is clipped to a maximum value of 10 seconds If a larger timeout is needed call this function repeatedly While waiting for the acquisition to terminate the calling thread is put into idle permitting other threads or processes to fully use the CPU If a channel or trigger overload was detected the returned status is always ACQIRIS ERROR OVERLOAD Else if the acquisition times out the returned status is ACQIRIS ERROR _ACQ TIMEOUT in which case you should use either AcqrsD1_stopAcquisition or AcqrsD1_forceTrig to stop the acquisition Otherwise the returned status is VI SUCCESS Programmer s Reference Manual Page 156 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_waitForEndOfAcquisition ViSession instrumentID Vilnt32 timeout LabVIEW Representation AqDx Wait For End Of Acquisition vi Instrument ID dup Instrument ID Timeout error in no error error out Visual Basic Representation WaitForEndOfAcquisition ByVal instrumentID As Long ByVal timeout As Long As Long Visual Basic NET Representation AcqrsD1_waitForEndOfAcquisition ByVal instrumentID As Int32 ByVal timeout As Int32 As Int32 MATLAB MEX Representation status Aq_waitForEndOfAcquisition instrumentID timeO
4. LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l_configMemory ViSession instrumentID Vilnt32 nbrSamples Vilnt32 nbrSegments LabVIEW Representation AqDx Configure Memory Settings vi Instrument ID dup Instrument ID Number of Segments 1 Number of Samples 1000 error out error in no error Visual Basic Representation ConfigMemory ByVal instrumentID As Long ByVal nbrSamples As Long ByVal nbrSegments As Long As Long Visual Basic NET Representation AcqrsD1l_configMemory ByVal instrumentID As Int32 ByVal nbrSamples As Int32 ByVal nbrSegments As Int32 As Int32 MATLAB MEX Representation status Aq_configMemory instrumentID nbrSamples nbrSegments Programmer s Reference Manual Page 51 of 159 2 3 22 AcqrsD1_configMemoryEx acqiris Purpose Extended configuration of the memory control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier nbrSamplesHi ViUInt32 Must be set to 0 reserved for future use nbrSamplesLo ViUInt32 Nominal number of samples to record per segment nbrSegments Vilnt32 Number of segments to acquire 1 corresponds to the normal single trace acquisition mode nbrBanks Vilnt32 Must be set to 1 reserved for future use flags Vilnt32 0 default memory use 1 force use of internal memory for 10 bit FAMILY digitizers with extended
5. instrumentID As Long resourceName As String IDQuery As Boolean resetDevice As Boolean optionsString As String As Long Visual Basic NET Representation AcqrsD1_InitWithOptions ByVal ByVal ByVal ByRef ByVal resourceName As String IDQuery As Boolean resetDevice As Boolean optionsString As String instrumentID As Int32 As Int32 MATLAB MEX Representation status instrumentID Aq_initWithOptions resourceName resetDevice Programmer s Reference Manual IDQuery optionsString Page 117 of 159 acqiris 2 3 56 AcqrsD1_logicDevicelO Purpose Reads writes a number of 32 bit data values from to a user defined register in on board logic devices such as user programmable FPGAs It is useful for AC SC Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier deviceName ViChar Identifies which device to read from or write to In the AC210 240 and the SC210 240 this string must be Block1Dev1 registerID Vilnt32 Register Number can typically assume 0 to 127 nbrValues Vilnt32 Number of data values to read dataArray Vilnt32 User supplied array of data values readWrite Vilnt32 Direction 0 read from device 1 write to device flags Vilnt32 Currently unused set to 0 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function
6. ByVal trigLevell As Double ByVal trigLevel2 As Double As Int32 MATLAB MEX Representation status Ag _configTrigSource instrumentID channel trigCoupling trigSlope trighevell triglevel2 Programmer s Reference Manual Page 63 of 159 acqiris 2 3 28 AcqrsD1_configTrigTV Purpose Configures the TV trigger parameters 12 bit FAMILY only Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Number of ExtTrigSources for external sources See discussion below standard Vilnt32 0 625 50 2 1 PAL or SECAM 2 525 60 2 1 NTSC field Vilnt32 1 Field 1 odd 2 Field 2 even line Vilnt32 line number depends on the parameters above For standard 625 50 2 1 to 313 for field 1 314 to 625 for field 2 For standard 525 60 2 1 to 263 for field 1 to 262 for field 2 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The number of internal i e channel or external trigger sources of the instrument can be retrieved with the AcqrsD1_getInstrumentInfo function Programmer s Reference Manual Page 64 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configTrigTV ViSession instrumentID Vilnt32 channel Vilnt32 standard Vilnt32 field Vilnt32 line LabV
7. values in Volts Parameters Return Value Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan firstSegment Vilnt32 Requested first segment number may assume 0 to the number of segments 1 nbrSegments Vilnt32 Requested number of segments may assume to the number of segments set with the function AcqrsD1_configMemory firstSampleInSeg Vilnt32 Requested position of first sample to read typically 0 May assume 0 to the number of samples 1 as set with the function AcqrsD1_configMemory nbrSamplesInSeg Vilnt32 Requested number of samples may assume 1 to the number of samples set with the function AcqrsD1_configMemory segmentOffset Vilnt32 Requested offset in number of samples between adjacent segments in the destination buffer waveformArray Must be gt nbrSamplesInSeg arraySize Vilnt32 Number of data elements in the user allocated waveformArray Used for verification protection Output Name Type Description waveformArray ViReal64 User allocated waveform destination array of type double See discussion below for the required size horPos ViReal64 User allocated array for horizontal positions of first data point one per segment See discussion below sampTime ViReal64 Sampling interval in seconds timeStampLo Vilnt32 User allocated arrays for low and high parts of the 64 timeSta
8. ByVal parameterString As String ByRef infoValue As Int32 As Int32 or AcgqrsD1_getInstrumentInfo ByVal instrumentID As Int32 ByVal parameterString As String ByRef infoValue As Double As Int32 or AcgqrsD1_getInstrumentInfo ByVal instrumentID As Int32 ByVal parameterString As String ByVal infoValue As String As Int32 MATLAB MEX Representation status infoValue Aq_getInstrumentInfo instrumentID parameterString dataTypeString Programmer s Reference Manual Page 91 of 159 2 3 42 AcqrsD1_getMemory acqiris Purpose Returns the current memory control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description nbrSamples Vilnt32 Nominal number of samples to record per segment nbrSegments Vilnt32 Number of segments to acquire 1 corresponds to the normal single trace acquisition mode Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configMemory Programmer s Reference Manual Page 92 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getMemory ViSession instrumentID Vilnt32 nbrSamples Vilnt32 nbrSegments LabVIEW Representation AqDx Query Memory Settings vi Instrument ID dup Instrument ID l Number of Segme
9. For the DC440 and DP310 the coupling input is used to select the signal input DC 50 for the Standard input and AC 50 Q for the Direct HF input Some instruments have no bandwidth limiting capability In this case use bandwidth 0 With channel 1 this function can be used to set the Full Scale Range and the bandwidth limit of the external trigger for the DC271 FAMILY digitizers the 10 bit FAMILY the AC SC and the AP240 AP235 signal analyzer platforms For the case of a 10 bit FAMILY or DC271 FAMILY Multilnstrument using ASBus the external triggers of the additional modules are numbered 3 5 following the principles given in the Programmer s Guide section 3 15 2 Trigger Source Numbering with ASBus Programmer s Reference Manual Page 66 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsD1_configVertical ViSession instrumentID Vilnt32 channel ViReal64 fullScale ViReal64 offset Vilnt32 coupling VilInt32 bandwidth LabVIEW Representation AqDx Configure Vertical Settings vi Coupling 1 DC 1 MOhm Channel 1 Instrument ID dup Instrument ID Full Scale 5 0 Y Offset 0 error out error in no error Bandwidth 0 no limit Visual Basic Representation ConfigVertical ByVal instrumentID As Long ByVal Channel As Long ByVal fullScale As Double ByVal offset As Double ByVal coupling As Long ByVal bandwidth As Long As Long Visual Ba
10. Representation ViStatus status AcqrsD1_getMemoryEx ViSession instrumentID ViUlnt32 nbrSamplesHi ViUlnt32 nbrSamplesLo Vilnt32 nbrSegments Vilnt32 nbrBanks Vilnt32 flags LabVIEW Representation AqDx Query Extended Memory Settings vi Number of Banks dup Instrument ID Number of Samples HIGH Number of Samples LOW Number of Segments Flags error out Instrument ID error in no error Visual Basic Representation GetMemoryEx ByVal instrumentID As Long nbrSamplesHi As Long nbrSamplesLo As Long nbrSegments As Long nbrBanks As Long flags As Long As Long Visual Basic NET Representation AcqrsD1_getMemory ByVal instrumentID As Int32 ByRef nbrSamplesHi As Ulnt32 ByRef nbrSamplesLo As Ulnt32 ByRef nbrSegments As Int32 ByRef nbrBanks As Int32 ByRef flags As Int32 As Int32 MATLAB MEX Representation status nbrSamplesHi nbrSamplesLo nbrSegments nbrBanks flags Ag_getMemoryEx instrumentID Programmer s Reference Manual Page 95 of 159 2 3 44 AcqrsD1_getMode acqiris Purpose Returns the current operational mode of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description mode Vilnt32 Operational mode modifier Vilnt32 Modifier currently not used flags Vilnt32 Flags Return Value Name Type Description status ViSta
11. acqiris 2 3 4 AcqrsD1_acquire Purpose Starts an acquisition Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcgrsDl_acquire ViSession instrumentID LabVIEW Representation AqDx Start Acquisition vi Instr ument ID dup Instrument ID l Mode error out error in no error Visual Basic Representation Acquire ByVal instrumentID As Long As Long Visual Basic NET Representation AcqrsDl_acquire ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation status Aq_ acquire instrumentID Programmer s Reference Manual Page 17 of 159 acqiris 2 3 5 AcqrsD1_acquireEx Purpose Starts an acquisition Parameters Input Name Type Description instrumentID ViSession Instrument identifier acquireMode Vilnt32 0 normal 2 continue to accumulate AP Averagers only acquireFlags Vilnt32 0 normal 4 to reset the time stamp counter 10 bit Family only acquireParams Vilnt32 Parameters currently not used reserved Vilnt32 Currently not used Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcgrsDl_acquireEx ViSession
12. status Aq_stopAcquisition instrumentID Programmer s Reference Manual Page 154 of 159 acqiris 2 3 76 AcqrsD1_stopProcessing Purpose Stops on board data processing This routine is for Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function will stop the on board data processing immediately The output data is not guaranteed to be valid LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_stopProcessing ViSession instrumentID LabVIEW Representation AqDx Stop Processing vi Instrument ID dup Instrument ID error in no error error out Visual Basic Representation StopProcessing ByVal instrumentID As Long As Long Visual Basic NET Representation AcqrsD1_stopProcessing ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation status Agq_stopProcessing instrumentID Programmer s Reference Manual Page 155 of 159 acqiris 2 3 77 AcqrsD1_waitForEndOfAcquisition Purpose Waits for the end of acquisition Parameters Input Name Type Description instrumentID ViSession Instrument identifier timeout Vilnt32 Timeout in milliseconds Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes
13. Visual Basic NET Representation AcqrsD1_setSimulationOptions ByVal simOptionString As String As Int32 MATLAB MEX Representation status Aq_setSimulationOptions simOptionsString Programmer s Reference Manual Page 153 of 159 acqiris 2 3 75 AcqrsD1_stopAcquisition Purpose Stops the acquisition Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function will stop the acquisition and not return until this has been accomplished The data is not guaranteed to be valid To obtain valid data after manually stopping the acquisition e g timeout waiting for a trigger one should use the AcqrsD1_forceTrig function to generate a software or manual trigger and then continue polling for the end of the acquisition with AcqrsD1_acqDone This will ensure correct completion of the acquisition LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_stopAcquisition ViSession instrumentID LabVIEW Representation AqDx Stop Acquisition vi Instrument ID E Instrument ID error in no error error out Visual Basic Representation StopAcquisition ByVal instrumentID As Long As Long Visual Basic NET Representation AcqrsD1_stopAcquisition ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation
14. as listed under AcqrsD1_configAvgConfig and supply its address as value Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configA vgConfig Programmer s Reference Manual Page 74 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getAvgConfig ViSession instrumentID Vilnt32 channelNbr ViString parameterString ViAddr value LabVIEW Representation AqDx Query Extended Averager Settings vi This Vi returns the value as either 132 or DBL Connect the desired type Channel Number Instrument ID Parameter String Returned Type error in no error dup Instrument ID Yalue 132 Value DBL error out Visual Basic Representation GetAvgConfig ByVal instrumentID As Long ByVal channelNbr As Long ByVal parameterString As String value as Any As Long Visual Basic NET Representation AcqrsD1_getAvgConfig ByVal instrumentID As Int32 ByVal channelNbr As Int32 ByVal parameterString As String ByRef value as Int32 As Int32 or AcqrsD1l_getAvgConfig ByVal instrumentID As Int32 ByVal channelNbr As Int32 ByVal parameterString As String ByRef value as Double As Int32 MATLAB MEX Representation status value Aq_getAvgConfig instrumentID channel parameterString dataTypeString Programmer s Reference Manual Page 75
15. 1_forceTrig 1_forceTrigEx _stopAcquisition 1_waitForEndOfAcquisition _reportNbrAcquiredSegments 1_readData _accumulateData _averagedData 1_readFCounter USE FOR NEW PROGRAMS _readCharSequence 1_readRealSequenc 1_readCharWform 1_readRealWform _accumulateWform 1_averagedWform _getExtClock l_getHorizontal 1_getChannelCombination 1_getMemory 1_getMemoryEx 1_getMultilnput 1_getTrigClass 1_getTrigSource 1_getTrigTV 1_getVertical 1_getMode 1_getControll0 1_getFCounter 1_getAvgConfig 1_getInstrumentData 1_getInstrumentiInfo Page 10 of 159 acqiris Number of Channels AcgrsD1_getNbrChannels Query Array of Setup Parameters AcqrsD1_getSetupArray Control Functions Query on board Processing Status AcqrsD1_procDone Start on board Processing AcqrsD1_processData Stop on board Processing AcgrsD1_stopProcessing Wait for End of on board Processing AcgrsD1_waitForEndO0fProcessing Utility Functions Best Nominal Samples AcgrsD1_bestNominalSamples Best Sampling Interval AcqrsD1_bestSampInterval Version AcqrsD1_getVersion Error Message AcqrsD1_errorMessage Extended Error Message AcgrsD1_errorMessageEx Reset AcgqrsDl_reset Reset Digitizer Memory AcgrsD1_resetDigitizerMemory Restore Internal Registers AcqrsD1_restorelnternalRegisters Set LED Color AcqrsD1_setLEDColor Close all instruments AcqrsD1_closeA1ll Programmer
16. 2 Device Driver Function Reference All function calls require the argument instrumentID in order to identify the Acqiris Digitizer card to which the call is directed The only exceptions are the initialization termination functions e AcqrsD1_ close e AcqrsD1_init e AcqrsD1_InitWithOptions e AcqrsD1_getNbrPhysicalInstruments AcqrsD1_multilnstrAutoDefine e AcqrsD1_setSimulationOptions e AcqrsD1_multilnstrUndefineAll The functions AcqrsD1_init AcqrsD1_InitWithOptions and AcqrsD1_multilnstrDefine actually return instrument identifiers at initialization time for subsequent use in the other function calls 2 1 Status values and Error codes All function calls return a status value of type ViStatus with information about the success or failure of the call All Acqiris specific values can be found in the header file AcqirisErrorCodes h and are shown in Table 2 1 The generic ones defined by the VXIplug amp play Systems Alliance are listed in the header file vpptype h VXIplug amp play instrument driver header file which includes visatype h fundamental VISA data types and macro definitions They are reproduced in Table 2 2 for convenience The header file AcqirisD1Interface h shows the common error codes associated with each function Acqiris Error Codes Hex v
17. 2 525 60 2 1 NTSC field Vilnt32 Field 1 odd 2 Field 2 even line Vilnt32 line number depends on the parameters above For standard 625 50 2 1 to 313 for field 1 314 to 625 for field 2 For standard 525 60 2 1 to 263 for field 1 to 262 for field 2 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See discussion under AcqrsD1_configTrigTV Programmer s Reference Manual Page 108 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgqrsD1_getTrigTV ViSession instrumentID Vilnt32 channel Vilnt32 standard Vilnt32 field Vilnt32 line LabVIEW Representation AqDx Query Trigger TV vi field dup Instrument ID standard error out Instrument ID channel error in no error line Visual Basic Representation GetTrigTV ByVal instrumentID As Long ByVal Channel As Long standard As Long field As Long line AS Long As Long Visual Basic NET Representation AcgqrsD1_getTrigTV ByVal instrumentID As Int32 ByVal Channel As Int32 ByRef standard As Int32 ByRef field As Int32 ByRef line AS Int32 As Int32 MATLAB MEX Representation status standard field line Aq_getTrigTV instrumentID Programmer s Reference Manual channel Page 109 of 159 2 3 52 AcqrsD1_getVersion acqiris Purpose Returns version numbers associated with a specified di
18. As Long ByVal arraySize As Long _ waveformArray As Double horPos As Double sampTime As Double timeStampLo As Long timeStampHi As Long As Long Programmer s Reference Manual Page 142 of 159 acqiris 2 3 67 AcqrsD1_readRealWform DEPRECATED Purpose Returns a waveform as a floating point double array with the measured data values in Volts Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan segmentNumber Vilnt32 Requested segment number may assume 0 to the number of segments 1 set with the function AcqrsD1_configMemory firstSample Vilnt32 Requested position of first sample to read typically 0 May assume 0 to the number of samples 1 set with the function AcqrsD1_configMemory nbrSamples Vilnt32 Requested number of samples may assume to the number of samples set with the function AcqrsD1_configMemory Output Name Type Description waveformArray ViReal64 User allocated waveform destination array Its size MUST be at least the maximum of nbrSamples or 5 returnedSamples Vilnt32 Number of data samples actually returned horPos ViReal64 Horizontal position of first data point See discussion below sampTime ViReal64 Sampling interval in seconds timeStampLo Vilnt32 Low and high part of the 64 bit trigger timestamp See timeStampHi Vilnt32 discussion be
19. ByVal sourcePattern As Int32 ByVal validatePattern As Int32 ByVal holdType As Int32 ByVal holdValuel As Double _ ByVal holdValue2 As Double As Int32 MATLAB MEX Representation status Agq_configTrigClass instrumentID trigClass sourcePattern validatePattern holdType holdValuel holdValue2 Programmer s Reference Manual Page 61 of 159 2 3 27 AcqrsD1_configTrigSource acqiris Purpose Configures the trigger source control parameters for the specified trigger source channel or External Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Number of IntTrigSources for internal sources 1 Number of ExtTrigSources for external sources See discussion below trigCoupling Vilnt32 0 DC 1 AC 2 HF Reject if available 3 DC 50 Q ext trigger only if available 4 AC 50 Q ext trigger only if available trigSlope Vilnt32 0 Positive 1 Negative 2 out of Window 3 into Window 4 HF divide 5 Spike Stretcher trigLevell ViReal64 Trigger threshold in of the vertical Full Scale of the channel or in mV if using an External trigger source See discussion below trigLevel2 ViReal64 Trigger threshold 2 as above for use when Window trigger is selected Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The number of
20. LabVIEW Representation AqDx Instrument ID Channel Number Parameter String Yalue error in no error Extended Configure Averager vi This Vi is polymorphic the value can be either 132 or DBL dup Instrument ID error out Visual Basic Representation ConfigAvgConfig ByVal ByVal ByVal value instrumentID As Long channelNbr As Long _ parameterString As String As Any As Long Visual Basic NET Representation AcqrsD1_configAvgConfig ByVal ByVal ByRef or AcqrsD1_configAvgConfig ByVal ByVal ByRef ByVal instrumentID As Int32 channelNbr As Int32 parameterString As String value As Int32 As Int32 ByVal instrumentID As Int32 channelNbr As Int32 parameterString As String As Int32 value As Double MATLAB MEX Representation status Aq_configAvgConfig instrumentID channel parameterString value Programmer s Reference Manual Page 37 of 159 acqiris 2 3 15 AcqrsD1_configChannelCombination Purpose Configures how many converters are to be used for which channels This routine is for use with some DC271 FAMILY instruments the 10 bit FAMILY the AC SC240 and the AP240 AP235 Signal Analyzer platforms Parameters Input Name Type Description instrumentID ViSession Instrument identifier nbrConvertersPer Vilnt32 all channels use 1 converter each default Channel 2 half of the channels use 2 converters each 4 1 4 of
21. MEX Representation status version Aq_getVersion instrumentID versionltem Programmer s Reference Manual Page 111 of 159 2 3 53 AcqrsD1_getVertical acqiris Purpose Returns the vertical control parameters for a specified channel in the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan or 1 for the External Input Output Name Type Description fullScale ViReal64 in Volts offset ViReal64 in Volts coupling Vilnt32 1 DC 1 MQ 2 AC 1 MQ 3 DC 502 4 AC 50Q bandwidth Vilnt32 0 no bandwidth limit default bandwidth limit at 25 MHz 2 bandwidth limit at 700 MHz 3 bandwidth limit at 200 MHz 4 bandwidth limit at 20 MHz 5 bandwidth limit at 35 MHz Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configVertical Programmer s Reference Manual Page 112 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getVertical ViSession instrumentID Vilnt32 channel ViReal64 fullScale ViReal64 offset Vilnt32 coupling Vilnt32 bandwidth LabVIEW Representation AgqDx Query Vertical Settings vi Coupling Instrument ID dup Instrument ID Channel 1 Bandwidth error in no error Full Scale error out Offset Visual Basic Repre
22. Special attention should be paid to sections on safety packaging and product handling Before installing your product please ensure that your system configuration matches or exceeds the requirements specified Chapter 2 INSTALLATION covers all elements of installation and performance verification Before attempting to use your Acqiris product for actual measurements we strongly recommend that you read all sections of this chapter Chapter 3 PRODUCT DESCRIPTION provides a full description of all the functional elements of your product Chapter 4 RUNNING THE ACQIRIS DEMONSTRATION APPLICATION describes either the operation of AcqirisLive 2 15 an application that enables basic operation of Acqiris digitizers or averagers in a Windows 95 98 2000 NT4 XP environment the operation of AP_SSRDemo and in the following chapter APx01Demo applications that enable basic operation of Acqiris analyzers in a Windows 95 98 2000 NT4 XP environment Chapter 5 RUNNING THE GEOMAPPER APPLICATION describes the purpose and operation of the GeoMapper application which is needed for some ASBus2 Multi instrument systems The Programmer s Guide is divided into 4 separate sections Chapter 1 INTRODUCTION describes what can be found where in the documentation and how to use it Chapter 2 PROGRAMMING ENVIRONMENTS amp GETTING STARTED provides a description for programming applications using a variety of software products and development environments Chap
23. acquisition whereas in modes 3 or 7 it starts an acquisition into the next memory bank or a special memory bank as defined by flags e The functions AcqrsD1_readData In mode 0 they return the last acquired waveform from the normal acquisition memory whereas in mode 3 they return data from a memory bank opposite to what is defined by flags LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configMode ViSession instrumentID Vilnt32 mode VilInt32 modifier Vilnt32 flags LabVIEW Representation AqDx Configure Operation Mode vi Flags Modifier Instrument ID dup Instrument ID mode error in no error error out Visual Basic Representation ConfigMode ByVal instrumentID As Long ByVal mode as Long ByVal modifier As Long ByVal flags As Long As Long Visual Basic NET Representation AcgrsD1_configMode ByVal instrumentID As Int32 ByVal mode as Int32 ByVal modifier As Int32 ByVal flags As Int32 As Int32 MATLAB MEX Representation status Aq_configMode instrumentID mode modifier Programmer s Reference Manual flags Page 55 of 159 acqiris 2 3 24 AcqrsD1_configMultilnput Purpose Selects the active input when there are multiple inputs on a channel It is useful for Averagers Analyzers and some digitizer models Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan input Vilnt3
24. and 3 3 Device Configuration Programmer s Reference Manual Page 49 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsD1_configlogicDevice ViSession instrumentID ViChar deviceName ViChar filePathName Vilnt32 flags LabVIEW Representation AqDx Configure Logic Device vi Instrument ID dup Instrument ID Device Name File Path error out error in no error Visual Basic Representation ConfigLogicDevice ByVal instrumentID As Long ByVal deviceName As String _ ByVal filePathName As String ByVal modifier As Long As Long Visual Basic NET Representation AcqrsD1_configLogicDevice ByVal instrumentID As Int32 ByVal deviceName As String ByVal filePathName As String ByVal modifier As Int32 As Int32 MATLAB MEX Representation status Aq_configLogicDevice instrumentID deviceName filePathName flags Programmer s Reference Manual Page 50 of 159 acqiris 2 3 21 AcqrsD1_configMemory Purpose Configures the memory control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier nbrSamples Vilnt32 Nominal number of samples to record per segment nbrSegments Vilnt32 Number of segments to acquire 1 corresponds to the normal single trace acquisition mode Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes
25. error out Visual Basic Representation SetLEDColor ByVal instrumentID As Long ByVal color As Long As Long Visual Basic NET Representation AcqrsD1_setLEDColor ByVal instrumentID As Int32 ByVal color As Int32 As Int32 MATLAB MEX Representation status Aq_setLEDColor instrumentID color Programmer s Reference Manual Page 152 of 159 acqiris 2 3 74 AcqrsD1_setSimulationOptions Purpose Sets one or several options which will be used by the function AcqrsD1_InitWithOptions provided that the optionsString supplied to AcqrsD1_InitWithOptions contains the string simulate TRUE Parameters Input Name Type Description simOptionString ViString String listing the desired simulation options See discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See the Programmer s Guide section 3 2 9 Simulated Devices for details on simulation A string of the form M8M is used to set an 8 Mbyte simulated memory The simulation options are reset to none by setting simOptionString to an empty string LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_setSimulationOptions ViString simOptionString LabVIEW Representation Use AgDx Initialize with Options vi Visual Basic Representation SetSimulationOptions ByVal simOptionString As String As Long
26. ideni e i o E a e 86 2 3 41 AcqrsD1 getlnstrumentlnfo isisisi ioiii iei eei Eie Ei iiri tie iei 88 Programmer s Reference Manual Page 3 of 159 acqiris 23420 ACgrsD lp Men AA iio ae 92 2 343 lt AcqrsDl getMemoryEX iii A A E ii i 94 2 344 AcqrsDl getMode iii did 96 2 345 AcqrsDl getMultilnputc iii daa acaid E 98 2 346 AcqrsD1_getNbrChanmtnels e a a a a R a n e a a tane 100 2 3 47 AcqrsD1_ getNbrPhysicallnstruments cc ceceesceesceescessceeeceeceseeesecesecsaecseecaeeeseeeeeenseeneees 101 2 3 48 AcqrsD1_getSetupArray ee eeecesccesseecsseceeeeceseeesaceceeeeeaeeceseeseaaeceseeseaseceseeeeaeeceeeeseaaeceeees 102 23 49 AA a a a Yotad Saseveeg stteatas toeveceenes Gated tnedbecsatteet 104 2307 sAcqrsD1getTrigSource ninaa Ronee ie RATA one 106 235 AcgqrsDl getTrige Via ohne sea digo a a cows nite wae claras 108 23 52 cAcqrsD1 SetVersion it dinate Boho dhe an tien Reese 110 2333 AcgrsD 1 cetVertical nicatrails aladas 112 2 3 54 Acor DI A HATH tee Ege ED A AL e 114 2 3 55 AcdrsDl Int WithOptions co ek hk Be Bleed Ace Re eee RS 116 2 3 56 AcgrsD1logicDevicelO aia ta ii de 118 2 3 57 AcqrsD1_multiInstrAutoDefine seiis i iE E E E 120 2 3 58 AcqrsDl multiInsttDefine ssion iieii ia E i a 122 2 3 59 AcqrsD1 multilnstrUndefineAll 0 ee ceceeseesceseceeeceeseeeeceseceseeseceaecaeecseecaeeeseeeeeeeeeneeses 124 2 3 60 AcdrsD 1 procDOne ini rie 125 2 3 01 AcqrsDl processDatas ecceri m
27. instrumentID Vilnt32 acquireMode Vilnt32 acquireFlags Vilnt32 acquireParams Vilnt32 reserved LabVIEW Representation AqDx Start Acquisition vi Instrument ID dup Instrument ID Mode error out error in no error Visual Basic Representation AcquireEx ByVal instrumentID As Long ByVal acquireMode As Long ByVal acquireFlags As Long ByVal acquireParams As Long ByVal reserved As Long As Long Visual Basic NET Representation AcgqrsD1_acquireEx ByVal instrumentID As Int32 ByVal acquireMode As Int32 ByVal acquireFlags As Int32 ByVal acquireParams As Int32 ByVal reserved As Int32 As Int32 MATLAB MEX Representation status Aq_acquireEx instrumentID acquireMode acquireFlags acquireParams reserved Programmer s Reference Manual Page 18 of 159 2 3 6 AcqrsD1_averagedData acqiris Purpose This function is intended for single instrument single channel operation Perform a series of acquisitions and get the resulting averaged waveform Parameters Input Name Type Description InstrumentID ViSession Instrument identifier Channel Vilnt32 1 Nchan readPar AqReadParameters Requested parameters for the acquired waveform nbrAcq Vilnt32 Number of acquisitions to be performed calculateMean ViBoolean TRUE to divide the sumArray by nbrAcq to get the mean values FALSE to leave the sample by sample sums in the sumArray
28. instrumentID channel readPar Programmer s Reference Manual Page 139 of 159 acqiris 2 3 65 AcqrsD1_readFCounter Purpose Returns the result of a frequency counter measurement Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description result ViReal64 Result of measurement Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The result must be interpreted as a function of the effected measurement type Measurement Type Units 0 Frequency Hz 1 Period Sec 2 Totalize by Time Counts 3 Totalize by Gate Counts LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_readFCounter ViSession instrumentID ViReal64 result LabVIEW Representation AqDx Read FCounter vi Instrument ID dup Instrument ID error in no error result out error out Visual Basic Representation ReadFCounter ByVal instrumentID As Long result As Double As Long Visual Basic NET Representation AcqrsDl_readFCounter ByVal instrumentID As Int32 ByRef result As Double As Int32 MATLAB MEX Representation status result Aq _readFCounter instrumentID Programmer s Reference Manual Page 140 of 159 acqiris 2 3 66 AcqrsD1_readRealSequence DEPRECATED Purpose Returns a sequence of waveforms as a floating point double array with the measured data
29. memory options only Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This routine is needed to access the new features of some of the 10 bit FAMILY digitizers In an instrument equipped with external memory flags 1 will force the use of internal memory which give a lower dead time between segments of a sequence acquisition Programmer s Reference Manual Page 52 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configMemoryEx ViSession instrumentID ViUInt32 nbrSamplesHi ViUInt32 nbrSamplesLo VilInt32 nbrSegments VilInt32 nbrBanks Vilnt32 flags LabVIEW Representation AqDx Configure Extended Memory Settings vi Flags Number of Samples HIGH Instrument ID dup Instrument ID Number of Segments Number of Samples LOW error out Number of Banks error in no error Visual Basic Representation ConfigMemoryEx ByVal instrumentID As Long ByVal nbrSamplesHi As Long ByVal nbrSamplesLo As Long ByVal nbrSegments As Long ByVal nbrBanks As Long ByVal flags As Long As Long Visual Basic NET Representation AcqrsD1_configMemoryEx ByVal instrumentID As Int32 ByVal nbrSamplesHi As Ulnt32 ByVal nbrSamplesLo As Ulnt32 ByVal nbrSegments As Int32 ByVal nbrBanks As Int32 ByVal flags As Int32 As Int32 MATLAB MEX Representation status Aq_configMemoryEx instrumentID nbrSamplesHi
30. nbrChannels LabVIEW Representation AqDx Query Number of Channels vi Instrument ID dup Instrument ID Number of Channels error in no error error out Visual Basic Representation GetNbrChannels ByVal instrumentID As Long nbrChannels As Long As Long Visual Basic NET Representation AcgqrsD1_getNbrChannels ByVal instrumentID As Int32 ByRef nbrChannels As Int32 As Int32 MATLAB MEX Representation status nbrChannels Aq_getNbrChannels instrumentID Programmer s Reference Manual Page 100 of 159 acqiris 2 3 47 AcqrsD1_getNbrPhysicalInstruments Purpose Returns the number of physical Acqiris modules found on the computer Parameters Output Name Type Description nbrInstruments Vilnt32 Number of Acqiris modules found on the computer Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getNbrPhysicalInstruments Vilnt32 nbrInstruments LabVIEW Representation AqDx Query Number of Instruments vi DE Number of Instruments error in no error error out Visual Basic Representation GetNbrPhysicalInstruments nbrInstruments As Long As Long Visual Basic NET Representation AcgrsD1_getNbrPhysicalInstruments ByRef nbrInstruments As Int32 _ As Int32 MATLAB MEX Representation status nbrInstrument Aq_getNbrPhysicallInstruments Progr
31. nbrSamplesLo nbrSegments nbrBanks flags Programmer s Reference Manual Page 53 of 159 acqiris 2 3 23 AcqrsD1_configMode Purpose Configures the operational mode of Averagers and Analyzers It doesn t apply to digitizers Parameters Input Name Type Description instrumentID ViSession Instrument identifier mode Vilnt32 0 normal data acquisition 2 averaging mode only in real time averagers 3 buffered data acquisition only in AP101 AP201 analyzers 5 AdvancedTDC mode for Analyzers with this option 6 frequency counter mode 7 AP235 AP240 SSR mode modifier Vilnt32 Currently not used set to 0 flags Vilnt32 If mode 0 this variable can take these values 0 normal default value 1 Start on Trigger mode 2 Sequence Wrap mode If mode 2 this variable is not used set to 0 For AP101 AP201 units if mode 3 this variable can take these values 0 acquire into 1 memory bank 1 acquire into 2 memory bank Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes Discussion Most digitizers only permit the default mode 0 Real time averagers support the normal data acquisition mode 0 and the averager mode 2 The analyzers digitizers with buffered acquisition memory AP101 AP201 and AP235 AP240 with SSR support both the normal data acquisition mode 0 and the buffered mode 3 The no
32. of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_init ViRsrc resourceName ViBoolean IDQuery ViBoolean resetDevice ViSession instrumentID LabVIEW Representation AqDx Initialize vi Resouce Name PCI INSTRO ID Query F Skip lt Reset T Reset error in no error Instrument ID Name Serial Number error out Visual Basic Representation Init ByVal resourceName As String ByVal IDQuery As Boolean ByVal resetDevice As Boolean instrumentID As Long As Long Visual Basic NET Representation AcqrsDl_init ByVal resourceName As String ByVal IDQuery As Boolean _ ByVal resetDevice As Boolean ByRef instrumentID As Int32 As Int32 MATLAB MEX Representation status instrumentID Aq_init instrumentID IDQuery resetDevice Programmer s Reference Manual Page 115 of 159 acqiris 2 3 55 AcqrsD1_InitWithOptions Purpose Initializes an instrument with options Parameters Input Name Type Description resourceName ViRsre ASCII string which identifies the digitizer to be initialized See discussion below IDQuery ViBoolean Currently ignored resetDevice ViBoolean If set to TRUE resets the digitizer after initialization optionsString ViString ASCII string that specifies options Syntax optionName bool where bool is TRUE 1 or FALSE 0 Currently three options are supported CAL do calibration at initiali
33. present before an edge can be accepted If both I O connectors are set to this value they both must be high before the trigger edge can be accepted 6 Level Enable trigger input or Start Veto for AP100 AP200 Averagers see AcqrsD1_configAvgConfig for more 8 Prepare for Trigger signal present on this connector qualifier2 gives the desired holdoff in time 9 Gate signal for FC option totalize in gate functionality 19 Clock 10 MHz reference clock 20 Pulse Acquisition skips to next segment in sequence 21 Level Acquisition is active 22 Level Trigger is armed ready The values of qualifier and qualifier2 are not used acquisition mode input Not for AP240 AP235 Signal Analyzers Programmer s Reference Manual Page 40 of 159 acqiris Connector Type Possible Values of signal and qualifierX Front Panel Trigger Out The value of signal is interpreted as a signal offset in mV E g signal 500 offsets the output signal by 500 mV The accepted range of signal is 2500 2500 i e 2 5 V with a resolution of 20 mV The value of qualifier controls if the trigger output is resynchronized to the clock or maintains a precise timing relation to the trigger input qualifier 1 0 default Non resynchronized qualifierl 1 Resynchronized to sampling clock PXI Bus 10 MHz 0 Disable 1 Enable Replaces the internal 10 MHz reference clock with the 10 MHz clock on the PXI rear panel connector PXI Bus
34. s Reference Manual Page 11 of 159 2 3 acqiris API Function descriptions This section describes each function in the Device Driver The functions appear in alphabetical order 2 3 1 AcqrsD1_accumulateData Purpose Returns a waveform as an array and accumulates it in a client array Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan readPar AqReadParameters Requested parameters for the acquired waveform Output Name Type Description dataArray ViAddr User allocated waveform destination array of type char or byte Its size in dataType units MUST be at least nbrSamples 32 for reasons of data alignment sumArray Vilnt32 User allocated waveform accumulation array Its size MUST be at least nbrSamples It is a 32 bit integer long array with the sample by sample sum of the data values in ADC count unit LSB See discussion below dataDesc AqDataDescriptor Waveform descriptor structure segDescArray ViAddr Segment descriptor structure Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function uses the AcqrsD1_readData routine However only readPar gt nbrSegments 1 and readPar gt readMode 0 ReadModeStdW are supported readPar gt dataType 3 real and readPar gt dataType 2 long are NOT supported The
35. set with the function AcqrsD1_configMemory nbrSamples Vilnt32 Requested number of samples may assume to the number of samples set with the function AcqrsD1_configMemory Output Name Type Description waveformArray ViChar User allocated waveform destination array of type char or byte Its size MUST be at least nbrSamples 32 for reasons of data alignment returnedSamples Vilnt32 Number of data samples actually returned addrFirstPoint Vilnt32 Offset of the first valid data point that of the first sample in the destination array It should always be in the range 0 31 horPos ViReal64 Horizontal position of first data point See discussion below sampTime ViReal64 Sampling interval in seconds vGain ViReal64 Vertical gain in Volts LSB See discussion below vOffset ViReal64 Vertical offset in Volts See discussion below timeStampLo Vilnt32 Low and high part of the 64 bit trigger timestamp See timeStampHi Vilnt32 discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The returned parameter horPos is the horizontal position of the first nominal data point with respect to the origin of the nominal trigger delay in seconds Since the first data point is BEFORE the origin this number will be in the range sampTime 0 Refer to the Programmer s Guide section 3 10 Trigger Delay and Ho
36. signal slew rate is low The targetValue is a user supplied estimated of the expected result and helps in choosing the optimal measurement conditions If the supplied value is lt 1000 0 and gt 0 0 then the instrument will not use the HF trigger mode to divide the input frequency Otherwise it divides it by 4 in order to obtain a larger frequency range The Period mode type 1 is equal to the frequency mode but the function AcqrsD1_readFCounter returns the inverse of the measured frequency If the targetValue is lt 0 001 1 ms then the instrument will not use the HF trigger mode otherwise it does The Totalize by Time mode type 2 counts the number of pulses in the signal applied to the selected signalChannel during the time defined by apertureTime The targetValue is ignored The Totalize by Gate mode type 3 counts the number of pulses in the signal applied to the selected signalChannel during the time defined by signal at the I O A or I O B inputs on the front panel The gate is open while the signal is high and closed while the signal is low if no signal is connected counting will be enabled since there is an internal pull up resistor The gate may be opened closed several times during the measurement The measurement must be terminated with the function AcqrsD1_stopAcquisition Programmer s Reference Manual Page 45 of 159 acqiris LabWindowsCVI Visual C Representat
37. sumArray contains the sample by sample sums To get the average values the array elements must be divided by the number of accumulations performed The sumArray can be interpreted as an unsigned integer Alternatively negative values have to be increased by 2 32 The number of acquisitions nbrAcq can be at most 16777216 for readPar gt dataType 0 char or 65536 for readPar gt dataType 1 short This is to avoid an overflow where the summed values will wrap around 0 The value in Volts of a data point data in the returned dataArray can be computed with the formula V dataDesc vGain data dataDesc vOffset Programmer s Reference Manual Page 12 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus AcqrsD1_accumulateData ViSession instrumentID Vilnt32 channel AqReadParameters readPar void dataArray Vilnt32 sumArray AqDataDescriptor dataDesc void segDescArray LabVIEW Representation AgDx Accumulate Data vi This Vi is polymorphic the sample data is returned in an array of type 18 or 116 segDescArray in channel Instrument ID readPar sum rray in data rray in error in no error Visual Basic Representation dup Instrument ID dataDesc segDesc rray out sum rray out error out data4rray out AccumulateData ByVal instrumentID As Long ByVal channel As Long readPar As AqReadParameters dataArray As Any sumArray As Long dataDesc As AgqDataDescrip
38. the master of a Multilnstrument For the case Options the available options are returned in a separated string The options include the memory size if additional memory has been installed in the form MnM for digitizers where n is the number of megabytes available or PnMB for AP235 AP240 and AnM for AP100 AP101 AP200 AP201 Other possible options include NoASBus BtBkup FreqCntr SSR Avg and StrtOnTrig The infoValue should point to a string of at least 32 characters The case of LOGDEVHDRBLOCKmDEVavsS string is one in which several possible values of m n and string are allowed The single digit number m refers to the FPGA block in the module For the moment this must always have the value 1 The single digit number n refers to the FPGA device in the block It can have values in the range 1 2 3 4 depending on the module Among the interesting values of string are the following case sensitive strings name version versionTxt compDate model The case of SSRTimeStamp should only be used when data is readable In other words it should only be used between the moment at which the processing is done and the moment when AcqrsD1_processData is called to enable the subsequent bank switch Examples double trigLevelRange AcgqrsD1l_getInstrumentiInfo ID TrigLevelRange 1 amp trighLevelRange The acceptable trigger levels are in the range trigLevelRange trigLevelRange mV externa
39. the normal instruments with a single input per channel this function may be ignored Programmer s Reference Manual Page 98 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getMultilInput ViSession instrumentID Vilnt32 channel Vilnt32 input LabVIEW Representation AqDx Query Multiplexer Input vi Instrument ID Channel 1 error in no error dup Instrument ID Input Input False 4 error out Visual Basic Representation GetMultiInput ByVal instrumentID As Long ByVal channel As Long inputs As Long As Long Visual Basic NET Representation AcqrsD1_getMultilInput ByVal instrumentID As Int32 ByVal channel As Int32 ByRef input As Int32 As Int32 MATLAB MEX Representation status input Aq _getMultilInput instrumentID channel Programmer s Reference Manual Page 99 of 159 acqiris 2 3 46 AcqrsD1_getNbrChannels Purpose Returns the number of channels on the specified module Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description nbrChannels Vilnt32 Number of channels in the specified module Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getNbrChannels ViSession instrumentID Vilnt32
40. timeout ViReal64 Acquisition timeout in seconds The function will return an error if for each acquisition no trigger arrives within the specified timeout after the start of the acquisition The minimum value is 1 ms Output Name Type Description dataArray ViAddr User allocated waveform destination array of type char or byte Its size in dataType units MUST be at least nbrSamples 32 for reasons of data alignment sumArray Vilnt32 User allocated waveform accumulation array Its size MUST be at least nbrSamples It is a 32 bit integer long array with the sample by sample sum of the data values in ADC count unit LSB See discussion below dataDesc AqDataDescriptor Waveform descriptor structure The returned values will be those of the last acquisition segDescArray ViAddr Segment descriptor structure The returned values will be those of the last acquisition Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Programmer s Reference Manual Page 19 of 159 acqiris Discussion Because the acquisition control loop is done inside this function it is suitable only for single instrument single channel operation This function uses the AcqrsD1_readData routine However only readPar gt nbrSegments 1 and readPar gt readMode 0 ReadModeStdW are supported readPar gt dataType 3 real and readPar gt dataType 2 long are NOT supported The sumArray co
41. to Table 2 1 for error codes Discussion The function returns immediately after ordering the acquisition to stop One must therefore wait until the acquisition has terminated before reading the data by checking the status with the AcqrsD1_acqDone function If the external clock is enabled and there is no clock signal applied to the device AcqrsD1_acqDone will never return done VI_TRUE Consider using a timeout and calling AcqrsD1_stopAcquisition if it occurs In multisegment mode the current segment is acquired the acquisition is terminated and the data and timestamps of subsequent segments are invalid LabWindowsCVI Visual C Representation ViStatus status AcgqrsD1_forceTrig ViSession instrumentID LabVIEW Representation AqDx Software Trigger vi Instrument ID dup Instrument ID are error out error in no error Visual Basic Representation ForceTrig ByVal instrumentID As Long As Long Visual Basic NET Representation AcqrsD1_forceTrig ByVal instrumentID As Int32 As Int32 Programmer s Reference Manual Page 71 of 159 acqiris 2 3 33 AcqrsD1_forceTrigEx Purpose Forces a manual trigger It should not be used for Averagers or Analyzers Parameters Input Name Type Description instrumentID ViSession Instrument identifier forceTrigType Vilnt32 0 Sends a software trigger to end the full acquisition Sends a single software trigger and generates the TrigOut hardwar
42. to set all values of the AqReadParameters structure including the reserved values The following dataType and readMode combinations are supported 0 l 2 3 4 5 short 6 shifted 7 SSR 9 standard image averaged gated peaks averaged short averaged Histogram 0 Int8 8 10 8 10 APX01 X 1 Intl6 10 12 10 12 X X AdvTDC 2 Int32 X AdvTDC AdvTDC 3 Real64 X X X APX01 X X Programmer s Reference Manual In this table X means that the functionality is available depending on the option but independent of the model 8 means that the functionality is available for 8 bit Digitizers and AP units in the digitizer mode 10 means that it is available for the 10 bit Digitizers 12 means that it is available for the 12 bit Digitizers It must be remembered that 12 bit digitizers generate 12 or 13 bit data which will be transferred as 2 bytes with the data shifted so that the MSB of the data becomes the MSB of the 16 bit word thus preserving the sign information The vGain value is therefore not the gain of the ADC in volts LSB but rather the volts LSB of the 16 bit word 10 bit digitizers generate 12 bit data which can be transferred in either of 2 ways e 2 bytes with the data shifted so that the MSB of the data becomes the MSB of the 16 bit word thus preserving the sign information e 1 byte with the 8 bit data of the most significant bits of
43. waveformArray As Byte returnedSamples As Long addrFirstPoint As Long horPos As Double sampTime As Double vGain As Double vOffset As Double timeStampLo As Long timeStampHi As Long As Long Programmer s Reference Manual Page 132 of 159 2 3 64 AcqrsD1_readData acqiris Purpose Returns all waveform information The sample data is returned in an array whose type is specified in the AqReadParameters structure Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan readPar AqReadParameters Requested parameters for the acquired waveform Output Name Type Description dataArray ViAddr User allocated waveform destination array The array size restrictions are given below ViAddr resolves to void in C C dataDesc AqDataDescriptor Waveform descriptor structure containing waveform information that is common to all segments segDescArray ViAddr Segment descriptor structure array containing data that is specific for each segment The size of the array is defined by nbrSegments and the type by readMode If readMode 4 there are no segment descriptors Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Read Parameters in AqReadParameters Name Type Description dataType Vilnt32 Type representation of the waveform 0 8 bit char
44. 1 AcqrsD1_processData acqiris Purpose Starts on board data processing on acquired data in the current bank as soon as the current acquisition terminates It can also be used to allow the following acquisition to be started as soon as possible This routine is for Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier processType Vilnt32 Type of processing 0 no processing or other Analyzers and for AP101 AP201 ONLY 1 gated peak detection extrema mode 2 gated peak detection hysteresis mode 3 interpolated peaks extrema mode 4 interpolated peaks hysteresis mode And for AdvTDC Analyzers 0 respect the settings done with AcqrsD1_configAvgConfig 1 gated peak detection with hystersis 2 gated and interpolated peak detection with hysteresis 3 gated peak detection with 8 point peak region 4 gated peak detection with 16 point peak region flags Vilnt32 Autoswitch functionality 0 do re processing in same bank 1 start the next acquisition in the other bank 2 switch banks but do not start next acquisition Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Programmer s Reference Manual Page 126 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_processData ViSession instrumentID Vilnt32 processType Vilnt32 flags LabVIEW Repre
45. 1 byte 1 16 bit short 2 bytes 2 32 bit long 4 bytes 3 64 bit double 8 bytes readMode Vilnt32 readout mode of the digitizer 0 standard waveform single segment only 1 image read for sequence waveform 2 averaged waveform from an Averager ONLY 3 gated waveform from an AP101 AP201 ONLY 4 peaks from an AP101 AP201 or AdvancedTDC 5 short averaged waveform from an Averager 6 shifted short averaged waveform from an Averager 7 SSR or AdvTDCwaveform from an Analyzer 9 AdvancedTDC Histogram readout from an Analyzer 10 AdvancedTDC Peak region readout from an Analyzer firstSegment Vilnt32 Requested first segment number may assume 0 to the number of segments 1 nbrSegments Vilnt32 Requested number of segments may assume to the actual number of segments firstSampleInSeg Vilnt32 Requested position of first sample to read typically 0 Programmer s Reference Manual Page 133 of 159 acqiris May assume 0 to the actual number of samples 1 nbrSamplesInSeg Vilnt32 Requested number of samples may assume to the actual number of samples segmentOffset Vilnt32 ONLY used for readMode 1 in DIGITIZERS Requested offset in number of samples between adjacent segments in the destination buffer dataArray Must be nbrSamplesInSeg dataArraySize Vilnt32 Number of bytes in the user allocated dataArray Used for verification protection segDescArray
46. 2 0 set to input connection A set to input connection B Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function is only of use for instruments with an input multiplexer i e more than 1 input per digitizer e g DP211 On the normal instruments with a single input per channel this function may be ignored Programmer s Reference Manual Page 56 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configMultilnput ViSession instrumentID Vilnt32 channel Vilnt32 input LabVIEW Representation AqDx Configure Multiplexer Input vi Instrument ID dup Instrument 1D Channel 1 Input Selection 0 A error out error in no error Visual Basic Representation ConfigMultilnput ByVal instrumentID As Long ByVal channel As Long ByVal connection As Long As Long Visual Basic NET Representation AcgqrsD1_configMultilnput ByVal instrumentID As Int32 ByVal channel As Int32 ByVal connection As Int32 As Int32 MATLAB MEX Representation status Ag _configMultilnput instrumentID channel input Programmer s Reference Manual Page 57 of 159 2 3 25 AcqrsD1_configSetupArray acqiris Purpose Sets the configuration for an array of configuration values It is useful for Analyzers only Paramete
47. 32 as explained below The limit is StepSize 1024 1024 1 StartDeltaNegPeak Vilnt32 Negative excursion needed before searching for negative peak For AP101 AP201 Analyzers ONLY StartDeltaPosPeak Vilnt32 Positive excursion needed before searching for positive peak May assume values between and Oxff For AP101 AP201 Analyzers ONLY StartDeltaPosPeakV ViReal64 Positive excursion needed before searching for positive peak Must be positive For Advanced TDC mode Analyzers ONLY StartVetoEnable Vilnt32 For AP100 AP200 Averagers ONLY May assume 0 for trigger enable functionality and 1 use high state of I O signal to allow the average accumulation to start Must be used in conjunction with AcqrsD1_configControllO StopDelay Vilnt32 Stop delay in samples May assume values between 0 and 2097120 1048560 in steps of of 16 32 as explained below The limit is StepSize 64 1024 1 TdcHistogramDepth Vilnt32 The depth of the histogram for AdvancedTDC mode 0 means 16 bit accumulation bins 1 means 32 bit accumulation bins Programmer s Reference Manual Page 34 of 159 acqiris Parameter String Data Type Description TdcHistogramHorzRes Vilnt32 The horizontal resolution of the histogram for interpolated peaks in the AdvancedTDC mode 0 means that each bin corresponds to a sampling interval lt 4 means that each bin correspon
48. 4 etc 0x800n0000 for External Trigger 1 0x400n0000 for External Trigger 2 etc where n is 0 for single instruments or the module number for Multilnstruments ASBus operation See discussion below validatePattern Vilnt32 Currently returns 0 holdType Vilnt32 Currently returns 0 holdValuel ViReal64 Currently returns 0 holdValue2 ViReal64 Currently returns 0 Return Value ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configTrigClass Programmer s Reference Manual Page 104 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsD1_getTrigClass ViSession instrumentID Vilnt32 trigClass Vilnt32 sourcePattern Vilnt32 validatePattern Vilnt32 holdType ViReal64 holdValuel ViReal64 holdValue2 LabVIEW Representation AqDx Query Trigger Class vi Validate Pattern old Value 1 dup Instrument ID old Value 2 Trigger Clas error out Source Pattern old Type Instrument ID error in no error Visual Basic Representation GetTrigClass ByVal instrumentID As Long trigClass As Long sourcePattern As Long validatePattern As Long holdType As Long holdValuel As Double _ holdValue2 As Double As Long Visual Basic NET Representation AcgrsD1_getTrigClass ByVal instrumentID As Int32 ByRef trigClass As Int32 ByRef sourcePattern As Int32 ByRef validatePattern As Int32 ByRef h
49. 58 Programmer s Reference Manual Page 4 of 159 acqiris 1 Introduction 1 1 Message to the User Congratulations on having purchased an Acqiris data conversion product Acqiris Digitizers Averagers and Analyzers are high speed data acquisition modules designed for capturing high frequency electronic signals To get the most out of the products we recommend that you read the accompanying product User Manual the Programmer s Guide and this Programmer s Reference Manual carefully We trust that the product you have purchased as well as the accompanying software will meet with your expectations and provide you with a high quality solution to your data conversion applications 1 2 Using this Manual This guide assumes you are familiar with the operation of a personal computer PC running a Windows 95 98 2000 NT4 XP or other supported operating system In addition you ought to be familiar with the fundamentals of the programming environment that you will be using to control your Acqiris product It also assumes you have a basic understanding of the principles of data acquisition using either a waveform digitizer or a digital oscilloscope The User Manual that you also have received or have access to has important and detailed instructions concerning your Acqiris product You should consult it first You will find the following chapters there Chapter 1 OUT OF THE BOX describes what to do when you first receive your new Acgqiris product
50. A out Visual Basic Representation CloseAll As Long Visual Basic NET Representation AcgrsD1_closeAll As Int32 MATLAB MEX Representation status Aq_closeaAll Programmer s Reference Manual Page 32 of 159 2 3 14 AcqrsD1_configAvgConfig acqiris Purpose Configures a parameter for averager analyzer operation Parameters Input Name Type Description instrumentID ViSession Instrument identifier channelNbr Vilnt32 Channel number A value 0 will be treated as 1 for compatibility parameterString ViString Character string defining the requested parameter See below for the list of accepted strings value ViAddr Value to set ViAddr resolves to void in C C The user must allocate the appropriate variable type as listed below set it to the requested value and supply its address as value Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes Accepted Parameter Strings Parameter String Data Type Description DitherRange Vilnt32 Range of offset dithering in ADC LSB s May assume values v 0 1 15 The offset is dithered over the range v v in steps of 1 8 LSB For Averagers ONLY FixedSamples Vilnt32 For Threshold Gate type in AP240 AP235 Analyzers and AdvancedTDC ONLY Number of samples transmitted for each point over threshold It must be a multiple of 4 0 No limit im
51. AB MEX Representation status nbrConvertersPerChannel usedChannels Ag_getChannelCombination instrumentID Programmer s Reference Manual Page 77 of 159 acqiris 2 3 36 AcqrsD1_getControllO Purpose Returns the configuration of a ControllO connector For DC271 FAMILY 10 bit FAMILY AP FAMILY 12 bit FAMILY and AC SC Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier connector Vilnt32 Connector Number 1 Front Panel I O A MMCX connector 2 Front Panel I O B MMCX connector 9 Front Panel Trigger Out MMCX connector Output Name Type Description signal Vilnt32 Indicates the current use of the specified connector 0 Disabled 6 Enable trigger etc For a detailed list see the description of AcqrsD1_configControlIO qualifier Vilnt32 The returned values depend on the type of connector see the discussion in AcqrsD1_configControlIO qualifier2 ViReal64 The returned values depend on the module see the discussion in AcqrsD1_configControlIoO Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion ControllO connectors are front panel IO connectors for special purpose control functions of the digitizer Typical examples are user controlled acquisition control trigger enable or control output signals such as 10 MHz reference or trigger ready The connector nu
52. B MEX Representation status Aq _logicDevicelO0 instrumentID deviceName registerID nbrValues dataArray readWrite modifier Programmer s Reference Manual Page 119 of 159 2 3 57 AcqrsD1_multilnstrAutoDefine acqiris Purpose Automatically initializes all digitizers and combines as many as possible to Multilnstruments Digitizers are only combined if they are physically connected via ASBus Parameters Input Name Type Description optionsString ViString ASCII string which specifies options Currently no options are supported Output Name Type Description nbrInstruments Vilnt32 Number of user accessible instruments It also includes single instruments that don t participate on the ASBus Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This call must be followed by nbrInstruments calls to the functions AcqrsD1_init or AcqrsD1_InitWithOptions to retrieve the instrumentID of the multi digitizers You should refer to to the Programmer s Guide section 3 2 Device Initialization for a detailed explanation on the initialization procedure Programmer s Reference Manual Page 120 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_multilnstrAutoDefine ViString optionsString Vilnt32 nbrInstruments LabVIEW Representation AqDx Multilnstrument Auto Define vi D
53. E When using this method make sure to use AcqrsD1_configMemory beforehand to set the number of segments to the desired value nbrSamples may be any number AcqrsD1_bestSampInterval depends on this variable NOTE The returned recommended values for the sampling interval sampInterval and the nominal number of samples nomSamples are expected to be used for configuring the instrument with calls to AcqrsD1_configMemory and AcqrsD1_configHorizontal Make sure to use the same number of segments in this second call to AeqrsD1_configMemory as in the first one Programmer s Reference Manual Page 26 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_bestSampInterval ViSession instrumentID Vilnt32 maxSamples ViReal64 timeWindow ViReal64 sampInterval Vilnt32 nomSamples LabVIEW Representation AqDx Query Best Sampling Interval vi Instrument ID dup Instrument ID Maximum Samples 10000 Nominal Samples Time Window 1E 6 s Sampling Interval s error in no error error out Visual Basic Representation BestSampInterval ByVal instrumentID As Long ByVal maxSamples As Long ByVal timeWindow As Double sampInterval As Double nomSamples As Long As Long Visual Representation AcqrsD1_bestSampInterval ByVal instrumentID As Int32 ByVal maxSamples As Int32 ByVal timeWindow As Double ByRef sampInterval As Double ByRef nomSamples As Int32 As Int32 MATLAB MEX Representatio
54. ETER2 BFFC0002 1074003966 VI ERROR PARAMETER3 BFFC0003 1074003965 VI ERROR PARAMETER4 BFFC0004 1074003964 VI ERROR PARAMETERS BFFC0005 1074003963 VI ERROR PARAMETER6 BFFC0006 1074003962 VI ERROR PARAMETER7 BFFC0007 1074003961 Programmer s Reference Manual Page 8 of 159 acqiris VI ERROR PARAMETERS BFFC0008 1074003960 VI ERROR FAIL ID QUERY BFFCOO11 1074003951 VI ERROR INV RESPONSE BFFC0012 1074003950 Table 2 2 VXIplug amp play Error Codes If important parameters supplied by the user e g an instrumentID are found to be invalid most functions do not execute and return an error code of the type VL ERROR_PARAMETER where i 1 2 corresponds to the argument number If the user attempts with a function AcqrsD1_configXXXX to set a digitizer parameter to a value outside of its acceptable range the function typically adapts the parameter to the closest allowed value and returns ACQIRIS WARN_SETUP_ADAPTED The digitizer parameters that are actually in use can be retrieved with the query functions AcqrsD1_getXXXX Data are always returned through pointers to user allocated variables or arrays Some parameters are labeled Currently ignored It is recommended to supply the value 0 ViInt32 or 0 0 ViReal64 in order to be compatible with future products that may offer additional functionality 2 2 API Function classification Initialization Functions Number of Physical Instruments Mu
55. IEW Representation AqDx Configure Trigger TV vi channel ee e dup Instrument ID stan fiel d error out error in no error line Visual Basic Representation ConfigTrigTV ByVal instrumentID As Long ByVal Channel As Long ByVal standard As Long ByVal field As Long ByVal line AS Long As Long Visual Basic NET Representation AcgqrsD1_configTrigTV ByVal instrumentID As Int32 ByVal Channel As Int32 ByVal standard As Int32 ByVal field As Int32 ByVal line AS Int32 As Int32 MATLAB MEX Representation status Aq_configTrigTV instrumentID channel standard field line Programmer s Reference Manual Page 65 of 159 acqiris 2 3 29 AcqrsD1_configVertical Purpose Configures the vertical control parameters for a specified channel of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan or 1 for the External Input fullScale ViReal64 in Volts offset ViReal64 in Volts coupling Vilnt32 0 Ground Averagers ONLY 1DC 1 MQ 2 AC 1 MQ 3 DC 502 4 AC 50Q bandwidth Vilnt32 0 no bandwidth limit default bandwidth limit at 25 MHz 2 bandwidth limit at 700 MHz 3 bandwidth limit at 200 MHz 4 bandwidth limit at 20 MHz 5 bandwidth limit at 35 MHz Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion
56. ON FAILED BFFA48CE 1074116402 ACQIRIS ERROR MODULES NOT CONTIGUOUS BFFA48CF 1074116401 ACQIRIS ERROR INSTRUMENT ACQ LOCKED BFFA48D0 1074116400 ACQIRIS ERROR INSTRUMENT_ACQ NOT LOCKED BFFA48D1 1074116399 ACQIRIS ERROR EEPROM2 DATA INVALID BFFA48D2 1074116398 ACQIRIS ERROR INVALID GEOMAP FILE BFFA48E0 1074116384 ACQIRIS ERROR ACQ TIMEOUT BFFA4900 1074116352 Programmer s Reference Manual Page 7 of 159 acqiris Acgiris Error Codes Hex value Decimal value 1074116093 1074116092 1074116091 1074116090 1074116089 1074116088 1074116064 1074115840 1074115839 1074115838 1074115837 1074115836 1074115835 1074115834 1074115584 ACQIRIS ERROR UNKNOWN _ ERROR BFFA4CO1 1074115583 ACQIRIS ERROR OTHER _WINDOWS_ERROR BFFA4CO2 1074115582 ACQIRIS ERROR VISA DLL NOT_FOUND BFFA4C03 1074115581 ACQIRIS ERROR _OUT_ OF MEMORY BFFA4CO4 1074115580 ACQIRIS ERROR UNSUPPORTED DEVICE BFFA4CO5 1074115579 ACQIRIS ERROR PARAMETER9 BFFA4D09 1074115319 ACQIRIS ERROR PARAMETER10 BFFA4DOA 1074115318 ACQIRIS ERROR PARAMETER11 BFFA4DOB 1074115317 ACQIRIS ERROR PARAMETER12 BFFA4DOC 1074115316 ACQIRIS ERROR _PARAMETER13 BFFA4DOD 1074115315 ACQIRIS ERROR PARAMETER14 BFFA4DOE 1074115314 ACQIRIS ER
57. Page 20 of 159 acqiris Visual Basic Representation AveragedData ByVa ByVa instrumentID As Long channel As Long readPar As AqReadParameters ByVa nbrAcq As Long ByVal calculateMean As Boolean ByVa timeout As Double dataArray As Any sumArray As Long dataDesc As AgqDataDescriptor segDescArray As Any As Long Visual Basic NET Representation AcgrsD1_averagedDat ByVal ByRe ByVal ByVa ByVal ByRef ByRe ByRe ByRe a 1 ByVal instrumentID As Int32 channel As Int32 readPar As AqReadParameters nbrAcg As Int32 calculateMean As Boolean timeout As Double dataArray As Byte sumArray As Int32 dataDesc As AgqDataDescriptor segDescArray As AgSegmentDescriptor As Int32 MATLAB MEX Representation status dataDesc segDescArray dataArray sumArray Programmer s Reference Manual Ag_averagedData instrumentID channel readPar nbrAcq calculateMean timeout Page 21 of 159 acqiris 2 3 7 AcqrsD1_averagedWform DEPRECATED Purpose This function is intended for single instrument single channel operation It is for use with 8 bit Digitizers Perform a series of acquisitions and get the resulting averaged waveform Parameters Input Name Type Description InstrumentID ViSession Instrument identifier Channel Vilnt32 1 Nchan SegmentNumber Vilnt32 Requested segmen
58. ROR PARAMETERI5 BFFA4DOF 1074115313 ACQIRIS ERROR NBR SEG BFFA4D10 1074115312 ACQIRIS ERROR NBR SAMPLE BFFA4D11 1074115311 ACQIRIS ERROR DATA ARRAY BFFA4D12 1074115310 ACQIRIS ERROR SEG DESC_ARRAY BFFA4D13 1074115309 ACQIRIS ERROR FIRST SEG BFFA4D14 1074115308 ACQIRIS ERROR SEG OFF BFFA4D15 1074115307 ACQIRIS ERROR FIRST_SAMPLE BFFA4D16 1074115306 ACQIRIS ERROR DATATYPE BFFA4D17 1074115305 ACQIRIS ERROR READMODE BFFA4D18 1074115304 ACQIRIS ERROR HW_FAILURE BFFA4D80 1074115200 ACQIRIS ERROR HW_FAILURE CH1 BFFA4D81 1074115199 ACQIRIS ERROR HW FAILURE CH2 BFFA4D82 1074115198 ACQIRIS ERROR HW_ FAILURE CH3 BFFA4D83 1074115197 ACQIRIS ERROR_HW_FAILURE_CH4 BFFA4D84 1074115196 ACQIRIS ERROR HW_ FAILURE CH5 BFFA4D85 1074115195 ACQIRIS ERROR_HW _FAILURE CH6 BFFA4D86 1074115194 ACQIRIS ERROR HW_ FAILURE CH7 BFFA4D87 1074115193 ACQIRIS ERROR HW_ FAILURE CH8 BFFA4D88 1074115192 ACQIRIS ERROR _HW_FAILURE EXT1 BFFA4DAO 1074115168 ACQIRIS WARN_SETUP_ADAPTED 3FFA4E00 1073368576 ACQIRIS WARN READPARA NBRSEG ADAPTED 3FFA4E10 1073368592 ACQIRIS WARN READPARA NBRSAMP_ ADAPTED 3FFA4E11 1073368593 ACQIRIS WARN EEPROM AND DLL MISMATCH 3FFA4E12 1073368594 ACQIRIS WARN ACTUAL DATASIZE ADAPTED 3FFA4E13 1073368595 ACQIRIS WARN UNEXPECTED TRIGGER 3FFA4E14 1073368596 ACQIRIS WARN READPARA FLAGS ADAPTED 3FFA4E15 1073368597 Table 2 1 Acqiris Error Codes Error code Hex value Decimal value VI_SUCCESS 0 0 VI ERROR PARAMETER BFFC0001 1074003967 VI ERROR PARAM
59. Session instrumentID Vilnt32 channel Vilnt32 setupType Vilnt32 nbrSetupoby ViAddr setupData Vilnt32 nbrSetupObJReturned LabVIEW Representation AqDx Query Setup Array vi Channel 1 Instrument ID dup Instrument ID setupType E ssetupData out nbrSetupObj p A nbrsetupObjReturned error in no error error out Visual Basic Representation GetSetupArray ByVal instrumentID As Long _ ByVal channel As Long ByVal setupType As Long ByVal nbrSetupObj As Long setupData As Any nbrSetupObjReturned As Long As Long Visual Basic NET Representation AcqrsD1_getSetupArray ByVal instrumentID As Int32 ByVal channel As Int32 ByVal setupType As Int32 ByVal nbrSetupObj As Int32 ByRef setupData As Int32 ByRef nbrSetupObjReturned As Int32 As Int32 MATLAB MEX Representation status setupData nbrSetupObjReturned Aq_getSetupArray instrumentID channel setupType nbrSetupob3 Programmer s Reference Manual Page 103 of 159 2 3 49 AcqrsD1_getTrigClass acqiris Purpose Returns the current trigger class control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description trigClass Vilnt32 0 edge trigger 1 TV trigger sourcePattern Vilnt32 0x000n0001 for Channel 1 0x000n0002 for Channel 2 0x000n0004 for Channel 3 0x000n0008 for Channel
60. Size Vilnt32 Number of bytes in the user allocated segDescArray Used for verification protection flags Vilnt32 ONLY used for DIGITIZERS 0 First data point is before delayTime after Trigger 1 First data point is at a fixed number of points with respect to the resynchronized trigger reserved Vilnt32 Reserved for future use set to 0 reserved2 ViReal64 Reserved for future use set to 0 reserved3 ViReal64 Reserved for future use set to 0 Segment Descriptor for Normal Waveforms readMode 0 1 3 in AqSegmentDescriptor Name Type Description horPos ViReal64 Horizontal position of first data point timeStampLo ViUInt32 Low and high part of the 64 bit trigger timestamp See timeStampHi ViUInt32 discussion below Segment Descriptor for Averaged Waveforms readMode 2 5 6 in AqSegmentDescriptorAvg Name Type Description horPos ViReal64 Horizontal position of first data point timeStampLo ViUInt32 Low and high part of the 64 bit trigger timestamp See timeStampHi ViUInt32 discussion below actualTriggersInSeg ViUInt32 Number of actual triggers acquired in this segment avgOvfl Vilnt32 Acquisition overflow See discussion below avgStatus Vilnt32 Average depth and status See discussion below avgMax Vilnt32 Max value in the sequence See discussion below reserved ViReal64 Reserved for future use Data Descriptor in AqDataDescriptor
61. Star Trigger 0 Disable 1 Use PXI Bus Star Trigger as Trigger Input 2 Use PXI Bus Star Trigger for Trigger Output Note When using this connector as Trigger Input you also must set the trigger source in sourcePattern in the function AcqrsD1_configTrigClass to External Trigger2 Discussion ControllO connectors are front panel IO connectors for special purpose control functions of the digitizer Typical examples are user controlled acquisition control start stop skip or control output signals such as acquisition ready or trigger ready The connector numbers are limited to the allowed values To find out which connectors are supported by a given module use the query function AcqrsD1_getControlIO The variable signal specifies the programmable use of the specified connector In order to set I O A as a Enable Trigger input and the I O B as a 10 MHz reference output use the function calls AcqrsD1l_configControllIO instrID 1 6 Op OO AcgrsD1_configControll0 instrID 2 19 0 0 0 In order to obtain a signal offset of 1 5 V on the Trigger Output use the call AcgrsD1_configControll0 instrID 9 1500 0 0 0 Programmer s Reference Manual Page 41 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configControll0 ViSession instrumentID VilInt32 connector Vilnt32 signal Vilnt32 qualifierl ViReal64 qualifier2 LabVIEW Representation A
62. _configControllO acqiris Purpose Configures a ControllO connector For DC271 FAMILY AP FAMILY 12 bit FAMILY 10 bit FAMILY and AC SC only Parameters Input Name Type Description InstrumentID ViSession Instrument identifier Connector Vilnt32 Connector Number 1 Front Panel I O A MMCX connector 2 Front Panel I O B MMCX connector 9 Front Panel Trigger Out MMCX connector 11 PXI Bus 10 MHz DC135 DC140 DC211 DC211A DC241 DC241A DC271 DC271A DC271AR 12 PXI Bus Star Trigger same models as above Signal Vilnt32 The accepted values depend on the type of connector See the table below for details qualifier Vilnt32 The accepted values depend on the type of connector See the table below for details qualifier2 ViReal64 If trigger veto functionality is available AP101 AP201 only accepts values between 30 ns and 1 0 sec The trigger veto values given will be rounded off to steps of 33 ns A value of 0 0 means that no holdoff is required and no Prepare for Trigger signal will be needed Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes Accepted Values of signal vs Connector Type Connector Type Possible Values of signal and qualifierX Front Panel I O 0 Disable Inputs Outputs 6 Level Enable trigger input for Digitizers If one of the two I O connectors is set to this value then a high level must be
63. acqiris XZ100 ACQIRIS PROGRAMMER S REFERENCE MANUAL Programmer s Reference Manual ZM020100G Rev A acqiris January 2006 The information in this document is subject to change without notice and may not be construed as in any way as a commitment by Acqiris While Acqiris makes every effort to ensure the accuracy and contents of the document it assumes no responsibility for any errors that may appear All software described in the document is furnished under license The software may only be used and copied in accordance with the terms of license Instrumentation firmware is thoroughly tested and thought to be functional but it is supplied as is with no warranty for specified performance No responsibility is assumed for the use or the reliability of software firmware or any equipment that is not supplied by Acgiris SA or its affiliated companies Any versions of this manual which are supplied with a purchased product will be replaced at your request with the latest revision in electronic format At Acqiris we appreciate and encourage customer input If you have a suggestion related to the content of this manual or the presentation of information please contact your local Acqiris representative or Acqiris Technical Support support acqiris com or come visit our web site at http www acqiris com Trademarks product and company names listed are trademarks or trade names of their respective companies Acqiris Headquarters A
64. age 25 of 159 acqiris 2 3 9 AcqrsD1_bestSampInterval Purpose Helper function to simplify digitizer configuration It returns the best possible sampling rate for an acquisition which covers the timeWindow with no more than maxSamples The calculation takes into account the current state of the instrument in particular the requested number of segments In addition this routine returns the real nominal number of samples that can be accommodated it is computed as timeWindow samplingInterval Parameters Input Name Type Description instrumentID ViSession Instrument identifier maxSamples Vilnt32 Maximum number of samples to be used time Window ViReal64 Time window to be covered in seconds Output Name Type Description sampInterval ViReal64 Recommended sampling interval in seconds nomSamples Vilnt32 Recommended number of data samples Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The function returns the value status ACQIRIS ERROR SETUP NOT AVAILABLE when the available memory is too short and the longest available sampling interval too short The returned sampling interval is the longest one possible It returns VI_SUCCESS when a good solution has been found NOTE This function does not modify the state of the digitizer at all It simply returns a recommendation that the user is free to override NOT
65. alue Decimal value ACQIRIS ERROR FILE NOT FOUND BFFA4800 1074116608 ACQIRIS ERROR PATH NOT FOUND BFFA4801 1074116607 ACQIRIS ERROR INVALID HANDLE BFFA4803 1074116605 ACQIRIS ERROR NOT SUPPORTED BFFA4805 1074116603 ACQIRIS ERROR INVALID WINDOWS PARAM BFFA4806 1074116602 ACQIRIS ERROR NO DATA BFFA4807 1074116601 ACQIRIS ERROR NO ACCESS BFFA4808 1074116600 ACQIRIS ERROR BUFFER OVERFLOW BFFA4809 1074116599 ACQIRIS ERROR BUFFER NOT 64BITS ALIGNED BFFA480A 1074116598 ACQIRIS ERROR ALREADY OPEN BFFA4840 1074116544 ACQIRIS ERROR SETUP NOT AVAILABLE BFFA4880 1074116480 ACQIRIS ERROR IO WRITE BFFA48A0 1074116448 ACQIRIS ERROR IO READ BFFA48A1 1074116447 ACQIRIS ERROR INTERNAL DEVICENO_ INVALID BFFA48C0 1074116416 ACQIRIS ERROR TOO MANY DEVICES BFFA48C1 1074116415 ACQIRIS ERROR EEPROM DATA INVALID BFFA48C2 1074116414 ACQIRIS ERROR INIT STRING INVALID BFFA48C3 1074116413 ACQIRIS ERROR INSTRUMENT NOT FOUND BFFA48C4 1074116412 ACQIRIS ERROR INSTRUMENT RUNNING BFFA48C5 1074116411 ACQIRIS ERROR INSTRUMENT STOPPED BFFA48C6 1074116410 ACQIRIS ERROR MODULES NOT ON SAME BUS BFFA48C7 1074116409 ACQIRIS ERROR NOT ENOUGH DEVICES BFFA48C8 1074116408 ACQIRIS ERROR NO MASTER DEVICE BFFA48C9 1074116407 ACQIRIS ERROR PARAM STRING INVALID BFFA48CA 1074116406 ACQIRIS ERROR COULD NOT CALIBRATE BFFA48CB 1074116405 ACQIRIS ERROR CANNOT READ THIS CHANNEL BFFA48CC 1074116404 ACQIRIS ERROR PRETRIGGER STILL RUNNING BFFA48CD 1074116403 ACQIRIS ERROR CALIBRATI
66. ammer s Reference Manual Page 101 of 159 2 3 48 AcqrsD1_getSetupArray acqiris Purpose Returns an array of configuration parameters It is useful for Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan setupT ype Vilnt32 Type of setup 0 GateParameters nbrSetupObj Vilnt32 Maximum allowed number of setup objects in the output Output Name Type Description setupData ViAddr Pointer to an array for the setup objects ViAddr resolves to void in C C The user must allocate the appropriate array and supply its address as setupData nbrSetupObj Vilnt32 Number of setup objects returned Returned Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes AqGateParameters Name Type Description GatePos Vilnt32 Start position of the gate GateLength Vilnt32 Length of the gate Discussion For the object definition refer to AcqrsD1_configSetupArray If AcqrsD1_getSetupArray is called without having set the Parameters before the default values will be returned Note The driver contains a set of 64 default AqGateParameters defined as 0 256 256 256 512 256 768 256 Programmer s Reference Manual Page 102 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getSetupArray Vi
67. at the end of the acquisition and is therefore not of much use Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description nbrSegments Vilnt32 Number of segments already acquired Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion Can be called after an acquisition in order to obtain the number of segments triggers actually acquired until AcqrsD1_stopAcquisition was called NOTE For a digitizer calling this function while an acquisition is active in order to follow the progress of a Sequence acquisition is dangerous and must be avoided As needed the result should be interpreted as a ViUlnt32 Programmer s Reference Manual Page 145 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_reportNbrAcquiredSegments ViSession instrumentID Vilnt32 nbrSegments LabVIEW Representation AqDx Query Number of Acquired Segments vi Instrument ID dup Instrument ID Number of Segments error in no error error out Visual Basic Representation ReportNbrAcquiredSegments ByVal instrumentID As Long nbrSegments As Long As Long Visual Basic NET Representation AcqrsD1_reportNbrAcquiredSegments ByVal instrumentID As Int32 ByRef nbrSegments As Int32 As Int32 MATLAB MEX Representation status nbrSegments Aq_reportNbrAcquiredSegm
68. bWindowsCVI Visual C Representation ViStatus status AcqrsD1_forceTrigEx ViSession instrumentID Vilnt32 forceTrigType Vilnt32 modifier Vilnt32 flags LabVIEW Representation AqDx Software Trigger vi Instrument ID dup Instrument ID Type error out error in no error Visual Basic Representation ForceTrigEx ByVal instrumentID As Long ByVal forceTrigType as Long ByVal modifier As Long ByVal flags As Long As Long Visual Basic NET Representation AcqrsD1_forceTrigEx ByVal instrumentID As Int32 ByVal forceTrigType as Int32 ByVal modifier As Int32 ByVal flags As Int32 As Int32 MATLAB MEX Representation status Aq_forceTrigEx instrumentID forceTrigType modifier flags Programmer s Reference Manual Page 73 of 159 acqiris 2 3 34 AcqrsD1_getAvgConfig Purpose Returns an attribute from the analyzer averager configuration channelNbr Parameters Input Name Type Description instrumentID ViSession Instrument identifier channelNbr Vilnt32 Channel number for use with AP240 AP235 dual channel mode A value 0 will be treated as 1 for compatibility parameterString ViString Character string defining the requested parameter See AcqrsD1_configAvgConfig for the list of accepted strings Output Name Type Description value ViAddr Requested information value ViAddr resolves to void in C C The user must allocate the appropriate variable type
69. brate AcqrsD1_configLogicDevice AcqrsD1_ init Programmer s Reference Manual AcqrsD1_calibrateEx AcqrsD1_configMode AcqrsD1_InitWithOptions Page 69 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_errorMessageEx ViSession instrumentID ViStatus errorCode ViChar errorMessagel Vilnt32 errorMessageSize LabVIEW Representation AqDx Error Message vi Status Note This vi already dup Instrument ID implements the use of Error Message AcgrsD1_errorMessageEx Error Code q g a error out Instrument ID Type of Dialog 1 OK Msg error in no error Visual Basic Representation errorMessageEx ByVal instrumentID As Long ByVal errorCode As Long ByVal errorMessage As String ByVal errorMessageSize As Long As Long Visual Basic NET Representation AcqrsD1l_errorMessageEx ByVal instrumentID As Int32 ByVal errorCode As Int32 ByVal errorMessage As String ByVal errorMessageSize As Int32 As Int32 MATLAB MEX Representation status errorMessage Aq_errorMessageEx instrumentID errorCode Programmer s Reference Manual Page 70 of 159 acqiris 2 3 32 AcqrsD1_forceTrig Purpose Forces a manual trigger It should not be used for Averagers or Analyzers Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer
70. ce Manual Page 87 of 159 2 3 41 AcqrsD1_getInstrumentInfo acqiris Purpose Returns general information about a specified digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier parameterString ViString Character string defining the requested parameter See below for the list of accepted strings Output Name Type Description infoValue ViAddr Requested information value ViAddr resolves to void in C C The user must allocate the appropriate variable type as listed below and supply its address as infoValue Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Accepted Parameter Strings Parameter String Returned Description Type ASBus_m BusNb Vilnt32 Bus number of the m th module of a multi instrument m runs from 0 to nbr of modules 1 ASBus_m_lIsMaster Vilnt32 Returns 1 if the m th module of a multi instrument is the master O otherwise m runs from 0 to nbr of modules 1 ASBus_m_PosInCrate Physical slot number position in cPCI crate of the m th Vilnt32 A module of a multi instrument m runs from 0 to nbr of modules 1 ASBus_m_SerialNb Serial number of the m th module of a multi instrument m Vilnt32 runs from 0 to nbr of modules 1 ASBus_m_SlotNb A Slot number of
71. corresponds to a trigger before the beginning of the record post trigger recording A negative number corresponds to pre trigger recording It can t be less than sampInterval nbrSamples which corresponds to 100 pre trigger Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion Refer to the Programmer s Guide section 3 10 Trigger Delay and Horizontal Waveform Position for a detailed discussion of the value delayTime Programmer s Reference Manual Page 47 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configHorizontal ViSession instrumentID ViReal64 sampInterval ViReal64 delayTime LabVIEW Representation AqDx Configure Horizontal Settings vi Instrument ID dup Instrument ID Sampling Interval 10 ns Delay Time 0 s error out error in no error Visual Basic Representation ConfigHorizontal ByVal instrumentID As Long ByVal sampInterval As Double ByVal delayTime As Double As Long Visual Basic NET Representation AcqrsD1_configHorizontal ByVal instrumentID As Int32 ByVal sampInterval As Double ByVal delayTime As Double As Int32 MATLAB MEX Representation status Aq_configHorizontal instrumentID sampInterval delayTime Programmer s Reference Manual Page 48 of 159 acqiris 2 3 20 AcqrsD1_configLogicDevice Purpose Configures programs
72. cqiris USA Acqiris Asia Pacific Acqiris SA Acqiris LLC Acqiris Pty Ltd 18 chemin des Aulx 234 Cromwell Hill Rd Suite 7 Level 1 CH 1228 Plan les Ouates P O Box 2203 407 Canterbury Road Geneva Monroe NY 10950 1430 P O Box 13 Switzerland USA Surrey Hills 3127 Australia Tel 41 22 884 33 90 Fax 41 22 884 33 99 Tel 845 782 6544 Fax 845 782 4745 O Copyright January 2006 Acqiris SA All rights reserved Programmer s Reference Manual Tel 61 3 9888 4586 Fax 61 3 9849 0861 Page 2 of 159 acqiris CONTENTS 1 INTRODUCTION opeciscssssissccsscesscotectessossonsscosessessossoesscoseoteseasborsscosectsdeosbons ecdeshoseesbenss E ki 5 1 1 Message to the User ici tenidas 5 12 Using this Mali is 5 1 3 Conventions Used in This Manual 0 eee cceeceessecseeesceeceeeceaeeeceaecaeesecaeveeceaseeeeaeeeeeaecaeeaeeneeeres 6 1 4 Warning Regarding Medical Use cccccceescesseesseeseeseeeeceeeceecnseceseceaecsaeceaecaeecaeeeaeeaecaeeeeeeneeses 6 MSs WN a te ro a 6 1 6 Warranty and Repair Return Procedure Assistance and SUpPOlTb ccooncnncnncnocnnnconononcccnnocononccnnonnon 6 1 7 System Requirement 0 ccccesceseessecsceesceesecseecaeeeseceeeeeesceneenseceeecaeeeaecsaecaaecaeeeseeeaeeeeeenseerenes 6 2 DEVICE DRIVER FUNCTION REFERENCE sesessessesesesescesescesesesescesesoesesesesosoesesesessesosseseseseeseee 7 21 Status valies and Error codes lille 7 2 2 API Function classification seesssseeces
73. cy 2 Totalize by Time 3 Totalize by Gate target Value ViReal64 User supplied estimate of the expected value apertureTime ViReal64 Time in sec during which the measurement is executed reserved ViReal64 Currently ignored flags Vilnt32 Currently ignored Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Programmer s Reference Manual Page 82 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getFCounter ViSession instrumentID Vilnt32 signalChannel Vilnt32 type ViReal64 targetValue ViReal64 apertureTime ViReal64 reserved Vilnt32 flags LabVIEW Representation AqDx Query FCounter vi Instrument ID dup Instrument ID Query results error out Visual Basic Representation GetFCounter ByVal instrumentID As Long _ signalChannel As Long type As Long targetValue As Double apertureTime As Double reserved As Double flags As Long As Long Visual Basic NET Representation AcqrsD1_getFCounter ByVal instrumentID As Int32 ByRef signalChannel As Int32 ByRef type As Int32 ByRef targetValue As Double ByRef apertureTime As Double ByRef reserved As Double ByRef flags As Int32 As Int32 MATLAB MEX Representation status signalChannel typeMes targetValue apertureTime reserved flags Agq_getFCounter instrumentID Programmer s Reference Manual Page 83 of 159 2 3 39 AcqrsD1_getHorizonta
74. ds to 2 n of a sampling interval TdcHistogramIncrement Vilnt32 The desired increment to be applied for each entry 1 means increment by 1 for SimpleTDC Averager and AdvancedTDC Analyzer modes ONLY 2 means increment by the ADCvalue NoiseBase for a SimpleTDC Averager and by the ADCvalue for the AdvancedTDC Analyzer TdcHistogramMode Vilnt32 The type of histogram for AdvancedTDC mode ONLY 0 means no histogram Data only is available for each acquisition 1 for a histogram TdcHistogramVertRes Vilnt32 The vertical resolution of the histogram for interpolated peaks when the TDCHistogramIncrement is 2 in the AdvancedTDC mode 0 means that each bin corresponds to a sampling interval lt 4 means that each bin corresponds to 2 n of a sampling interval TdcMinTOT Vilnt32 The desired minimum width of a peak in the waveform It can take on a value n from to 4 A peak is accepted if there are at least n consecutive data samples above the Threshold For SimpleTDC mode ONLY TdcOverlaySegments Vilnt32 This option controls the horizontal binning of data in the AdvancedTDC histogram mode 0 means that each segment will be histogrammed independently 1 means that all segments will be histogrammed on a common time axis TdcProcessType Vilnt32 The desired processing for AdvancedTDC mode peak finding May assume 0 No processing 1 Standard peak finding no inter
75. e channel 2 on a 4 channel digitizer 0x00000004 use channel 3 on a 4 channel digitizer 0x00000008 use channel 4 on a 4 channel digitizer NOTE Digitizers which don t support channel combination always use the default nbrConvertersPerChannel 1 and the single possible value of usedChannels NOTE Changing the channel combination doesn t change the names of the channels they are always the same NOTE If digitizers are combined with ASBus the channel combination applies equally to all participating digitizers Programmer s Reference Manual Page 38 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configChannelCombination ViSession instrumentID Vilnt32 nbrConvertersPerChannel VilInt32 usedChannels LabVIEW Representation AqDx Configure Channel Combination vi IAE dup Instrument ID nbrConvertersPerChannel rra usedChannels rror ou error in no error Visual Basic Representation ConfigChannelCombination ByVal instrumentID As Long ByVal nbrConvertersPerChannel As Long ByVal usedChannels As Long As Long Visual Basic NET Representation AcgrsD1_configChannelCombination ByVal instrumentID As Int32 ByVal nbrConvertersPerChannel As Int32 ByVal usedChannels As Int32 As Int32 MATLAB MEX Representation status Aq_configChannelCombination instrumentID nbrConvertersPerChannel usedChannels Programmer s Reference Manual Page 39 of 159 2 3 16 AcqrsD1
76. e paee inves EST E ESKO Eneu SN Eee 45 23 191 AcqrsDl configHorzotad ie 47 23 20 Acqrs Dl COMME ices eee ee 49 23 2 AcqtsD 1 config Memory i 51 2 3 22 Acdts Dl confie Memory EX A REE 52 2 53 23 Acts Dl config MA Mien He enn E 54 2 3 24 lt AcqrsD1_ configMulltiInput 22 cc cccccccccescseccesccecessesiecescedcecetecccecoscecinsssdeddeceesedeesseseceecesdeeve 56 2 3 25 AcqrsDl configSetupArray 22 cccscccccceccesciseccesessecvecet ecevcesiesstcecce cossecdeseddedeecsesedeeddedecescevsecee 58 2 3 26 AcqrsD1 config TrigClass cocinas aan adici n 60 2 327 AcqrsD1 config TrigSQUICE miii seedescu ces E EEK Ra EE i 62 2 3 28 AcqrsDl configTrigTV eceecesecesecsseesseeseeeseeseceecnsecesecseceaecaaecasecseeeseeeeeeeeeeeeesrenreeeenaees 64 2329 AcqtsD1 contig ca o los ton ee ie Ghai eee 66 23 30 AcqrsDil errorMessage anien dene nadan 68 23 315 AcgrsD errorMessage AAA A RR tna odeedee vets 69 23 32 sAcgrsD force Ti Gy e conch eia kd Sh RGR A ca 71 23 33 gt AcqrsDl force TB a od es 72 23 34 AcqrsD1 gotA velo iii A ita 74 2 3 35 AcqrsD1_getChannelCombination 2 ceeceeccesccesecesecesececeseceeecseeeseeeaeeeeeeeeeeeeeeeseeeeeneeensees 76 23 36 AcqtsD 1 setControll ci A RATA IS ARORA 78 23 37 AcqtsD 1 getExtOlock it ete Bek teen E ow ea een A 80 2 3 38 AcqrsDl Beth COME cinc ie vince a stank cobane E eee A di a 82 23 39 AcqtsD 1 getHorizontal iii it AA Re ow 84 2 3 40 AcgqrsD1_getInstrumentData asseio
77. e signal modifier Vilnt32 Currently not used flags Vilnt32 Currently not used Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The function returns immediately after ordering the acquisition to stop One must therefore wait until the acquisition has terminated before reading the data by checking the status with the AcqrsD1_acqDone function If the external clock is enabled and there is no clock signal applied to the device AcqrsD1_acqDone will never return done VI_TRUE Consider using a timeout and calling AcqrsD1_stopAcquisition if it occurs For forceTrigType 0 the trigOut Control IO will NOT generate a trigger output This mode is equivalent to AcqrsD1_forceTrig In multisegment mode the current segment is acquired the acquisition is terminated and the data and timestamps of subsequent segments are invalid For forceTrigType 1 trigOut Control IO will generate a trigger output on each successful call In multisegment mode the acquisition advances to the next segment and then waits again for a trigger If no valid triggers are provided to the device the application must call AcqrsD1_forceTrigEx as many times as there are segments Every acquired segment will be valid This mode is only supported for single i e non ASBus connected digitizers not Averagers or Analyzers Programmer s Reference Manual Page 72 of 159 acqiris La
78. ed It can only be enabled if the threshold is enabled For Averagers ONLY NoiseBase ViReal64 Value in Volts of the value to be added in Noise Supressed Averaging For Averagers ONLY P1Control Vilnt32 May assume 0 not enabled For AP240 AP235 Averagers ONLY 1 addSub channel 1 2 addSub channel 2 3 addSub channel 1 2 4 average trigger enable 5 start veto enable 6 average out For AP240 AP235 SSR ONLY 1 Timestamp reset enable P2Control Vilnt32 May assume 0 not enabled For AP240 AP235 Averagers ONLY 1 addSub channel 1 2 addSub channel 2 3 addSub channel 1 2 4 average trigger enable 5 start veto enable 6 average out For AP240 AP235 SSR ONLY 1 Timestamp reset enable PostSamples Vilnt32 For AP240 AP235 SSR and AdvancedTDC Analyzers in Threshold Gate mode Used to guarantee a number of samples after the last one satisfying the threshold condition The meaningful values are 0 4 8 12 16 Other values will be rounded up or adapted appropriately PreSamples Vilnt32 For AP240 AP235 SSR and AdvancedTDC Analyzers in Threshold Gate mode Used to guarantee a number of samples before the first one satisfying the threshold condition The meaningful values are 0 4 8 12 16 Other values will be rounded up or adapted appropriately StartDelay Vilnt32 Start delay in samples May assume values between 0 and 33554400 16777216 in steps of 16
79. egDesc must always be allocated with a length that corresponds to the total number of segments requested with nbrSegments in AqReadParameters The first requested segment is therefore deposited in SegDesc 0 The segment descriptor array must also be allocated with the correct structure type that depends on the readMode If not used a Null pointer can be passed to the function There are no segment descriptors for readMode 4 7 9 and 10 The returned segment descriptor values timeStampLo and timeStampHi are respectively the low and high parts of the 64 bit trigger timestamp in units of picoseconds The timestamp is the trigger time with respect to an arbitrary time origin usually the start time of the acquisition except for the 10 bit digitizers which is intended for the computation of time differences between segments of a Sequence acquisition Please refer to the Programmer s Guide section 3 13 Timestamps for a detailed explanation The returned segment descriptor value horPos is the horizontal position for the segment of the first nominal data point with respect to the origin of the nominal trigger delay in seconds Since the first data point is BEFORE the origin this number will be in the range sampTime 0 Refer to the Programmer s Guide section 3 10 Trigger Delay and Horizontal Waveform Position for a detailed discussion of the value delayTime For Averaged Waveforms the value of horPos will always be 0 avgOvfl avgSta
80. enaren eni nin e nie e i eiei 126 2 3 62 AcqrsD1_readCharSequence DEPRECATED essesesssrsesssesersrrseesesseeresteressrsersreseeseeseese 128 2 3 63 AcqrsD1_readCharWform DEPRECATED ssseessesesssreeessesersreseesesseeressesessrsrrsreserseeseese 131 PAAS E A A 133 2 3 65 AcqrsDl read OOU E a aaa aa a Eaa r aaae aaa aaa a aa a anii ieina 140 2 3 66 AcqrsD1_readRealSequence DEPRECATED essssessssesssesersreseeresseeressesersrsresreseeseeseene 141 2 3 67 AcqrsDl readRealWform DEPRECATED ssssesssesesssreeessesersreseesessteressesessrsresreseessseene 143 2 3 68 AcqrsD1_reportNbrAcquiredSegment ss sessseseseesseeeessteeessestsesesresttstrstenesstsresreseseeseene 145 23 09 ACQtSD ORO 147 2 3 70 AcqrsD1_resetDigitizerMemMory eccrine E E A E EE a E 148 2 3 11 AcqrsD1_restoreInternalRegisters oeno E ER EER 149 23 124 AcgqtsD setAttributeS tang ia 151 2 393 AcgtsD ll seth ED Colotes cs esis feito Geet eas a 152 2 3 74 AcqrsD1_setSimulationOptions cccecceceesceesseseeeeeceseceeceeeceseeeaeceaeceeecseecaeeeaeeeeeeneeeeeeeas 153 2 3 15 AcqrsDl stopACquisition sisne reniir iieii a i a iai 154 2 3 16 AcqrsD1_ stopProcessing srrcsnnionre nrin E E E i R E ii 155 2 3 77 AcqrsD1_waitForEndOfACquisition ss seseeeseeeesseeeeseeesssesesreserstesteresstsresreserseseenessesresse 156 2 3 78 AcqrsD1_waitForEndOfProcessing ccceceesseesseescesseeseesseeeeeeeeceseceseeeseensecaecaecneeeaeeeseeees 1
81. ents instrumentID Programmer s Reference Manual Page 146 of 159 acqiris 2 3 69 AcqrsD1_reset Purpose Resets an instrument Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion There is no known situation where this action is to be recommended LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_reset ViSession instrumentID LabVIEW Representation AqDx Reset vi Instrument ID dup Instrument ID error in no error error out Visual Basic Representation Reset ByVal instrumentID As Long As Long Visual Basic NET Representation AcqrsDl_reset ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation status Aq reset instrumentID Programmer s Reference Manual Page 147 of 159 acqiris 2 3 70 AcqrsD1_resetDigitizerMemory Purpose Resets the digitizer memory to a known default state Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion Each byte of the digitizer memory is overwritten sequentially with the values Oxaa 0x55 0x00 and Oxff This functionality is mostly intended for use with battery backed up memo
82. esecesecseeerescsecesaecasesecaeeesenecaeeessnesnesaeenseaecaseesenerenes 9 23 APLFunction descriptions mi ada niin iain au a ie 12 2 3 1 AcqrsD1 accumulate Data conil Hee Chad RAPER OAR da des 12 2 3 2 AcqrsD1_accumulateWform DEPRECATED cceccecsceesesesceeecenecesecaeceeecaeesseeeseeeseeerees 14 2 3 3 AcqrsDl acd Don a Rosh ap A nese em Ra 16 2 3 4 AcqrsD 1 acque 4 ack A eh Rite es eG Ree a 17 2 3 5 AcgrsD acque EX 2 iste accel adie Stine kate RAMEE Sa he a R 18 2 3 6 AcgqtsD 1 avetagedData cod A HO en eA wee 19 2 3 7 AcqrsD1_averagedWform DEPRECATED cceeceesseesceesceeeceecesecsecneceecaeeeseeeseenneeseeees 22 2 3 8 AcqrsD1_bestNominal Samples cccccecccsseesseesceseceeeceseceseceseceaeeeecaecnaeceaecaaeeseesaeeeseeneeeneenas 24 2 3 9 AcqrsD 1 bestSamplntervall c 2 cc cevcccseceseccsicescechacucdecctceicascasesdvddedeccecessecducesceddedecdecsedesdeess 26 2 3 10 AcqgrsD1 calibrate coo idas 28 23 11 AcqrsD 1 calibrateEX iii aida 29 ZII AC DL O St N O Colton E EI to E R 31 IEM E Aci DA do li e ado 32 2 3 14 AcqrsD1_configAvgConfig ce cecccccscecssessseesceesceesceecesecesecaecsaecseecseeeseeeeeeneeeneeeeeeeeeeereerens 33 2 3 15 AcqrsD1_configChannelCombination ccceecceeccesecesecseeeeceeteceeecaeeeseeeeeeeeeeereneeenereeteenaees 38 23 16 AcqtsDI config Control s sssi a e d iat 40 2317 AcqtsD I config ExtClock odias dd 43 23 18 AcqtsD1 config h Counter eses e e
83. ference Manual Page 22 of 159 Discussion acqiris Because the acquisition control loop is done inside this function it is suitable only for single instrument single channel operation The sumArray contains the sample by sample sums To get the average values the array elements must be divided by nbrAcq The value in Volts of a data point data in the returned waveformArray can be computed with the formula V vGain data vOffset LabWindowsCVI Visual C Representation ViStatus AcgrsDl_averagedWform ViSession instrumentID VilInt32 channel Vilnt32 segmentNumber Vilnt32 firstSample Vilnt32 nbrSamples Vilnt32 nbrAcq ViReal64 timeout ViChar waveformArray Vilnt32 sumArray Vilnt32 returnedSamples ViReal64 sampTime ViReal64 vGain ViReal64 vOffset LabVIEW Representation AqDx Read Averaged Waveform vi should be considered to be obsolete Please use AqDx Averaged Data vi instead Visual Basic Representation AveragedWform ByVal ByVal ByVal ByVal ByVal ByVal ByVal wave instrumentID As Long channel As Long segmentNumber As Long firstSample As Long nbrSamples As Long nbrAcq As Long timeout As Double ormArray As Byte sumArray As Long returnedSamples As Long sampTime As Double vGain As Double vOffset As Double As Long Programmer s Reference Manual Page 23 of 159 acqiris 2 3 8 AcqrsD1_bestNominalSamples Purpose Helper function t
84. ffset in number of samples between adjacent segments in the destination buffer waveformArray Must be nbrSamplesInSeg arraySize Vilnt32 Number of data elements in the user allocated waveformArray Used for verification protection Output Name Type Description waveformArray ViChar User allocated waveform destination array of type char or byte See discussion below for the required size horPos ViReal64 User allocated array for horizontal positions of first data point one per segment See discussion below sampTime ViReal64 Sampling interval in seconds vGain ViReal64 Vertical gain in Volts LSB See discussion below vOffset ViReal64 Vertical offset in Volts See discussion below timeStampLo Vilnt32 User allocated arrays for low and high parts of the 64 timeStampHi Vilnt32 bit trigger timestamp See discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function is faster than a loop over AcqrsD1_readCharWform if many short segments lt 10 000 samples segment are read See the Programmer s Guide Appendix A Estimating Data Transfer Times for timing details The waveform destination array waveformArray must not only allocate enough space to hold the requested data but also some additional space This function achieves a higher transfer speed by simply transferring an image of the digitizer memory to the CPU memory and then reordering all circular se
85. fier channel Vilnt32 1 Nchan name ViConstString ASCII string that specifies options odITxBitRate is currently the only one used value ViConstString For odlTxBitRate can have values like 2 5G 2 125G or 1 0625G Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_setAttributeString ViSession instrumentID Vilnt32 channel ViConstString name ViConstString value LabVIEW Representation Not Yet Available Visual Basic Representation Not Yet Available Visual Basic NET Representation Not Yet Available MATLAB MEX Representation Not Yet Available Programmer s Reference Manual Page 151 of 159 acqiris 2 3 73 AcqrsD1_setLEDColor Purpose Sets the front panel LED to the desired color Parameters Input Name Type Description instrumentID ViSession Instrument identifier color Vilnt32 0 OFF return to normal acquisition status indicator 1 Green 2 Red 3 Yellow Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_setLEDColor ViSession instrumentID Vilnt32 color LabVIEW Representation AqDx Set LED Color vi Instrument ID dup Instrument ID Color 0 Off error in no error
86. gitizer or current device driver Parameters Input Name Type Description instrumentID ViSession Instrument identifier versionItem Vilnt32 1 for version of Kernel Mode Driver 2 for version of EEPROM Common Section 3 for version of EEPROM Digitizer Section 4 for version of CPLD firmware Output Name Type Description version Vilnt32 version number of the requested item Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion For drivers the version number is composed of 2 parts The upper 2 bytes represent the major version number and the lower 2 bytes represent the minor version number Programmer s Reference Manual Page 110 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getVersion ViSession instrumentID Vilnt32 versionltem Vilnt32 version LabVIEW Representation AqDx Revision Query vi Instr Driver Rev numeric dup Instrument ID Instr Driver Revision Instr Firmware Revision error out Instr Firmware Rev numeric Instrument ID Firmware Version Item 4 C error in no error Visual Basic Representation GetVersion ByVal instrumentID As Long ByVal versionltem As Long version As Long As Long Visual Basic NET Representation AcgrsD1_getVersion ByVal instrumentID As Int32 ByVal versionltem As Int32 ByRef version As Int32 As Int32 MATLAB
87. gment buffers into linear arrays Since allocating a temporary buffer for the memory image is time consuming the user allocated destination buffer is also used as a temporary storage for the memory image The rule for the minimum storage space to allocate Programmer s Reference Manual Page 128 of 159 acqiris with waveformArray is discussed in to the Programmer s Guide section 3 9 2 Reading Sequences of Waveforms The value of segmentOffset must be nbrSamplesInSeg The waveforms are thus transferred sequentially into a single linear buffer with holes of length segmentOffset nbrSamplesInSeg between them Such holes could be used for depositing additional segment specific information before storing the entire sequence as a single array to disk If you specify firstSegment gt 0 you don t have to allocate any buffer space for waveforms that are not read i e waveformArray 0 corresponds to the first sample of the segment firstSegment Example In a DC270 if you specify nbrSamplesInSeg segmentOffset 1500 Then with nbrSegments 80 and nbrSamplesNom 1000 since the currentSegmentPad 408 you would have to allocate at least 1408 80 1 114 048 bytes It is strongly recommended to allocate the waveform destination buffers permanently rather than dynamically in order to avoid system overheads for buffer allocation deallocation The arrays horPos timeStampLo and timeStampHi must always be allocated with length
88. hannel Instrument ID dup Instrument ID readPar dataDesc data rray in data rray out error in no error error out Programmer s Reference Manual Page 138 of 159 acqiris AqDx Read Histogram Data vi This Vi is polymorphic the sample data is returned in an array of type 116 or 132 It is meant for channel Instrument ID readPar data rray in error in no error the readout of an Advanced TDC analyzer with readMode 4 dup Instrument ID dataDesc dataArray out error out Visual Basic Representation ReadData ByVal ByVal readPa dataAr dataDe segDes Visual Basic NET AcgrsD1_readData ByVal ByRef ByRef ByRef ByRef Where DATATYPE c or AcgrsD1_readData ByVal ByRef ByRef ByRef ByRef instrumentID As Long channel As Long r As AgReadParameters ray As Any sc As AqDataDescriptor cArray As Any As Long Representation ByVal instrumentID As Int32 channel As Int32 readPar As AgqReadParameters dataArray As DATATYPE dataDesc As AqDataDescriptor segDescArray As AgSegmentDescriptor As Int32 an be either Int8 Int16 or Double ByVal instrumentID As Int32 channel As Int32 readPar As AqReadParameters dataArray As DATATYPEAVG dataDesc As AgqDataDescriptor segDescArray As AqSegmentDescriptorAvg As Int32 Int32 Where DATATYPEAVG can be either Int16 Int32 or Double MATLAB MEX Representation status dataDesc segDescArray dataArray Aq_readData
89. har List of options separated by installed in this instrument OverloadStatus chan Vilnt32 Returns 1 if chan is in overload 0 otherwise chan takes on the same values as channel in AcqrsD1_configTrigSource OverloadStatus ALL Vilnt32 Returns 1 if any of the signal or external trigger inputs is in overload 0 otherwise Use the OverloadStatus chan string to determine which channel is in overload PosInCrate Vilnt32 Physical slot number position in cPCI crate SSRTimeStamp ViReal64 Current value of time stamp for Analyzers in SSR mode TbSegmentPad Vilnt32 Returns the additional array space in samples per segment needed for the image read of AcqrsD1_readData AcqrsD1_readCharSequence or AcqrsD1_readRealSequence DEPRECATED Temperature m Vilnt32 Temperature in degrees Centigrade C TrigLevelRange chan ViReal64 Trigger Level Range on channel chan VersionUserDriver ViChar String containing the full driver version Discussion For the case TrigLevelRange chan the result is to be interpreted as returned value which is in of the vertical Full Scale of the channel or in mV for an external trigger source The value of chan takes is the same as the values of channel in AcqrsD1_configTrigSource For the case Temperature m m is the module number in a Multilnstrument and runs from 0 to nbr of modules 1 following the channel order It may be omitted on single digitizers or for
90. he desired Sampling Frequency for clockType 1 only Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion When clockType is set to 1 or 4 the parameters of the function AcqrsD1_configHorizontal are ignored Please refer to your product User Manual for the conditions on the clock signals and to the Programmer s Guide section 3 14 External Clock for the setup parameters and the theory of operation Programmer s Reference Manual Page 43 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configExtClock ViSession instrumentID Vilnt32 clockType Vilnt32 delayNbrSamples ViReal64 inputThreshold ViReal64 inputFrequency ViReal64 sampFrequency LabVIEW Representation AqDx Configure External Clock vi Input Frequency 0 Instrument ID ClockType 0 Internal Input Threshold 0 error in no error Delay Number of Samples 0 Sampling Frequency 0 dup Instrument ID error out Visual Basic Representation ConfigExtClock ByVal instrumentID As Long ByVal clockType As Long ByVal inputThreshold As Double ByVal delayNbrSamples As Long ByVal inputFrequency As Double ByVal sampFrequency As Double Visual Basic NET Representation AcqrsD1_configExtClock As Long ByVal instrumentID As Int32 ByVal clockType As Int32 ByVal inputThreshold As Double _ ByVal de
91. ie E Number of Instruments error in no error error out Visual Basic Representation MultilnstrAutoDefine ByVal optionsString As String nbrinstruments As Long As Long Visual Basic NET Representation AcgqrsD1_multilnstrAutoDefine ByVal optionsString As String ByRef nbrInstruments As Int32 As Int32 MATLAB MEX Representation status nbrInstruments Aq_multilnstrAutoDefine optionsString Programmer s Reference Manual Page 121 of 159 acqiris 2 3 58 AcqrsD1_multilnstrDefine Purpose This function defines the combination of a number of digitizers connected by ASBus into a single MultiInstrument It is not applicable to ASBus modules Parameters Input Name Type Description instrumentList ViSession Array of instrumentID of already initialized single digitizers nbrInstruments Vilnt32 Number of digitizers in the instrumentList masterID ViSession instrumentID of master digitizer Output Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion You should refer to to the Programmer s Guide section 3 2 Device Initialization for a detailed explanation on the initialization procedure The function returns the error code ACQIRIS ERROR MODULES NOT_ON SAME BUS if all modules in the instrumentList are not on the same bus It may als
92. internal i e channel or external trigger sources of the instrument can be retrieved with the AcqrsD1_getInstrumentInfo function The allowed range for the trigger threshold depends on the model and the channel chosen See your product User Manual NOTE Some of the possible states may be unavailable in some digitizers In particular the trigCoupling choices of DC 50 Q and AC 50 Q are only needed for modules that have both 50 Q and 1 MO external input impedance possibilities Programmer s Reference Manual Page 62 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configTrigSource ViSession instrumentID Vilnt32 channel Vilnt32 trigCoupling Vilnt32 trigSlope ViReal64 triglevell ViReal64 trighevel2 LabVIEW Representation AqDx Configure Extended Trigger Source vi Trigger Level 2 0 Channel 1 Instrument ID Trigger Coupling 0 DC Trigger Slope 0 positive error in no error Trigger Lewel 1 0 dup Instrument ID error out Visual Basic Representation ConfigTrigSource ByVal instrumentID As Long ByVal Channel As Long ByVal trigCoupling As Long ByVal trigSlope As Long ByVal trigLevell As Double ByVal trigLevel2 As Double As Long Visual Basic NET Representation AcqrsD1_configTrigSource ByVal instrumentID As Int32 ByVal Channel As Int32 ByVal trigCoupling As Int32 ByVal trigSlope As Int32
93. ion Set NbrWaveforms to 1 and NbrRoundRobins to n order to enable the round robin segment acquisition mode with n triggers for each segment The channelNbr is used to designate the channel number for those parameters whose values can be different for the two channels of an AP240 AP235 in dual channel mode These parameters are indicated in bold in the list above The granularity for NbrSamples StartDelay and StopDelay is 16 for the AP100 AP101 and the AP240 AP235 in Dual Channel mode and 32 for the AP200 AP201 and the AP240 AP235 in Single Channel mode If P1 Control and or P2Control are enabled for the Add Subtract mode then the data will be added if the signal or the or of both signals is in the high state The same rule holds if they are used for trigger enable The P1Control P2Control average out signal goes high after the first trigger is accepted for an average and drops back down when the last trigger s acquition is complete Example long channelNbr 0 dither 8 AcqrsD1l_configAvgConfig ID channelNbr DitherRange amp dither This function sets the dithering range to 8 LSB s Note that this function takes the address not the value of the parameter to be set Programmer s Reference Manual Page 36 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsD1_configAvgConfig ViSession instrumentID Vilnt32 channelNbr ViString parameterString ViAddr value
94. ion ViStatus status AcgqrsD1_configFCounter ViSession instrumentID Vilnt32 signalChannel Vilnt32 type ViReal64 targetValue ViReal64 apertureTime ViReal64 reserved Vilnt32 flags LabVIEW Representation AqDx Configure FCounter vi Instrument ID dup Configure values Instrument ID error out Visual Basic Representation ConfigFCounter ByVal ByVal ByVal ByVal ByVal ByVal ByVal instrumentID As Long signalChannel As Long type As Long targetValue As Double apertureTime As Double reserved flags As Visual Basic NET Representation AcqrsD1_configFCounter ByVal ByVal ByVal ByVal ByVal ByVal As Double Long As Long ByVal instrumentID As Int32 signalChannel As Int32 type As Int32 targetValue As Double apertureTime As Double reserved flags As MATLAB MEX Representation As Double Int32 As Int32 status Aq_configFCounter instrumentID signalChannel typeMes targetValue apertureTime reserved flags Programmer s Reference Manual Page 46 of 159 acqiris 2 3 19 AcqrsD1_configHorizontal Purpose Configures the horizontal control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier sampInterval ViReal64 Sampling interval in seconds delayTime ViReal64 Trigger delay time in seconds with respect to the beginning of the record A positive number
95. iple segments with readMode 1 Programmer s Reference Manual Page 137 of 159 acqiris channel Instrument ID readPar segDescArray in dataArray in error in no error data4rray out dup Instrument ID AqDx Read Raw Data vi This Vi is polymorphic the sample data is returned in an array of type 18 116 It is meant for the readout of a single segment with readMode 0 channel Instrument ID readPar spd RAW segDesc in segDesc out dataArray in l error in no error gt data4rray out dup Instrument ID AqDx Read Averager Data vi This Vi is polymorphic the sample data is returned in an array of type 132 or DBL It is meant for the readout of an averager with readMode 2 channel Instrument ID readPar segDescArray in dataArray in error in no error data4rray out dup Instrument ID AgDx Read Gated Data vi It is meant for the readout of an analyzer with readMode 3 channel Instrument ID readPar dataArray in error in no error dup Instrument ID dataDesc dataArray out error out AgqDx Read Peaks Data vi This Vi is polymorphic the sample data is returned in an array of type 132 or DBL It is meant for the readout of an analyzer with readMode 4 channel Instrument ID dup Instrument ID readPar dataDesc data rray in data rray out error in no error error out AqDx Read SSR Data vi It is meant for the readout of an analyzer with readMode 7 c
96. is only useful if the user programmed the on board logic device FPGA Typically nbrValues is set to 1 but it may be larger if the logic device supports internal address auto incrementation The following example reads the 32 bit contents of register 5 to reg5 Value ViStatus status AcgrsD1_logicDevicel0 ID BlocklDev1 5 1 amp reg5Value 0 0 Note that dataArray must always be supplied as an address even when writing a single value Programmer s Reference Manual Page 118 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_logicDevicel0 ViSession instrumentID ViChar deviceName Vilnt32 registerID Vilnt32 nbrValues VilInt32 dataArray Vilnt32 readWrite VilInt32 flags LabVIEW Representation AqDx Logic Device IO vi Data Array Number of Values Instrument ID Device Name Register ID error in no error Read Write Flags dup Instrument ID error out Visual Basic Representation LogicDevicelo ByVal instrumentID As Long ByVal deviceName As String ByVal registerID As Long ByVal nbrValues As Long dataArray As Long ByVal readWrite As Long ByVal modifier As Long As Long Visual Basic NET Representation AcqrsD1_logicDevicelO ByVal instrumentID As Int32 ByVal deviceName As String ByVal registerID As Int32 ByVal nbrValues As Int32 ByRef dataArray As Int32 ByVal readWrite As Int32 ByVal modifier As Int32 As Int32 MATLA
97. l acqiris Purpose Returns the current horizontal control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description sampInterval ViReal64 Sampling interval in seconds delayTime ViReal64 Trigger delay time in seconds Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configHorizontal Programmer s Reference Manual Page 84 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgqrsD1_getHorizontal ViSession instrumentID ViReal64 sampInterval ViReal64 delayTime LabVIEW Representation AqDx Query Horizontal Settings vi Instrument ID dup Instrument ID Delay Time error in no error Sample Interval error out Visual Basic Representation GetHorizontal ByVal instrumentID As Long sampInterval As Double delayTime As Double As Long Visual Basic NET Representation AcgqrsD1_getHorizontal ByVal instrumentID As Int32 ByRef samplnterval As Double ByRef delayTime As Double As Int32 MATLAB MEX Representation status sampInterval delayTime Aq_getHorizontal instrumentID Programmer s Reference Manual Page 85 of 159 2 3 40 AcqrsD1_getInstrumentData acqiris Purpose Returns some basic data about a specified digitizer
98. l trigger For modules supporting switch on overload protection Programmer s Reference Manual Page 89 of 159 acqiris long overlLoad AcgqrsDl_getInstrumentiInfo ID OverLoadStatus ALL amp o0verLoad if overLoad DO SOMETHING In order to find out which channel s caused the overload you have to loop over OverLoadStatus 1 OverlLoadStatus 1 OverLoadStatus 2 1 Programmer s Reference Manual Page 90 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getInstrumentIinfo ViSession instrumentID ViString parameterString ViAddr infoValue LabVIEW Representation AqDx Query Instrument Information vi dup Instrument ID Info Value int Info Yalue double Info value string error out Instrument ID Parameter String Returned Type error in no error NOTE The type of the returned value depends on the parameter requested In LabVIEW the correct returned type should be supplied as input to the VI and the appropriate output wire connected Any other wire will always return zero Visual Basic Representation NOTE In Visual Basic a returned type of Vi Int32 should be declared as Long while a returned type of ViReal64 should be declared as Double GetInstrumentInfo ByVal instrumentID As Long ByVal parameterString As String infoValue As Any As Long Visual Basic NET Representation AcqrsD1_getInstrumentInfo ByVal instrumentID As Int32
99. layNbrSamples As Int32 ByVal inputFrequency As Double _ ByVal sampFrequency As Double As Int32 MATLAB MEX Representation status Ag _configExtClock instrumentID clockType inputThreshold delayNbrSamples inputFrequency sampFrequency Programmer s Reference Manual Page 44 of 159 acqiris 2 3 18 AcqrsD1_configFCounter Purpose Configures a frequency counter measurement Parameters Input Name Type Description instrumentID ViSession Instrument identifier signalChannel Vilnt32 Signal input channel type Vilnt32 Type of measurement 0 Frequency default Period 1 frequency 2 Totalize by Time 3 Totalize by Gate target Value ViReal64 User supplied estimate of the expected value may be 0 0 if no estimate is available apertureTime ViReal64 Time in sec during which the measurement is executed see discussion below reserved ViReal64 Currently ignored flags Vilnt32 Currently ignored Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The Frequency mode type 0 measures the frequency of the signal applied to the selected signalChannel during the aperture time The default value of apertureTime is 0 001 sec and can be set to any value between 0 001 and 1000 0 seconds A longer aperture time may improve the measurement accuracy if the externally applied reference clock has a high accuracy and or if the
100. lnt32 channel Vilnt32 firstSegment VilInt32 nbrSegments Vilnt32 firstSamplelnSeg Vilnt32 nbrSamplesInSeg Vilnt32 segmentOffset Vilnt32 arraySize ViReal64 horPos ViReal64 vGain ViChar waveformArrayl ViReal64 sampTime ViReal64 vOffset Vilnt32 timeStampLo Vilnt32 timeStampHil LabVIEW Representation AqDx Read Sequence in ADC vi should be considered as obsolete Please use AqDx Read Digitizer Data vi instead Visual Basic Representation ReadCharSequence ByVal instrumentID As ByVal channel As Long ByVal firstSegment As Long Long ByVal nbrSegments As Long ByVal firstSampleInSeg As Long ByVal nbrSamplesInSeg As Long ByVal segmentOffset As Long ByVal arraySize As Long waveformArray As Byte horPos As Double sampTime As Double vGain As Double vOffset As Double timeStampLo As Long timeStampHi As Long As Long Programmer s Reference Manual Page 130 of 159 acqiris 2 3 63 AcqrsD1_readCharWform DEPRECATED Purpose Returns a waveform as a byte array Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan segmentNumber Vilnt32 Requested segment number may assume 0 to the number of segments 1 set with the function AcqrsD1_configMemory firstSample Vilnt32 Requested position of first sample to read typically 0 May assume 0 to the number of samples 1
101. low Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_readCharWform for details about the horPos and timeStamp parameters Programmer s Reference Manual Page 143 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsD1_readRealWform ViSession instrumentID VilInt32 channel Vilnt32 segmentNumber Vilnt32 firstSample Vilnt32 nbrSamples ViReal64 waveformArray Vilnt32 returnedSamples ViReal64 horPos ViReal64 sampTime Vilnt32 timeStampLo Vilnt32 timeStampHi LabVIEW Representation AqDx Read Waveform in Volts vi should be considered as obsolete Please use AgDx Read Digitizer Data vi instead Visual Basic Representation ReadRealWform ByVal ByVal ByVal ByVal ByVal instrumentID As Long channel As Long segmentNumber As Long firstSample As Long nbrSamples As Long waveformArray As Double returnedSamples As Long horPos As Double sampTime As Double timeStampLo As timeStampHi As Programmer s Reference Manual Long Long As Long Page 144 of 159 acqiris 2 3 68 AcqrsD1_reportNbrAcquiredSegments Purpose Returns the number of segments already acquired for a digitizer For averagers but not AP100 or AP200 it will give the number of triggers already accepted for the current acquisition In the case of analyzers it will return the value 1
102. ltiInstrument Auto Define Initialization Initialization with Options Simulation Options Calibration Functions Calibrate Instrument Calibrate for External Clock Configuration Functions Configure Vertical Settings Configure Horizontal Settings Configure Channel Combination Configure Trigger Class Configure Trigger Source Configure Trigger TV Configure Memory Settings Configure Memory Settings extended Configure External Clock Configure Digitizer Mode Configure Multiplexer Input Configure Control IO Configure Frequency Counter Configure Averager Configuration Attribute Configure program on board FPGA Configure Array of Setup Parameters Logical Device IO Programmer s Reference Manual Function Name Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs D D D D1 D1 D1 1_getNbrPhysicaliInstruments _multilnstrAutoDefine 1_init _InitWithOptions _setSimulationOptions _calibrate calibrateEx _configVertical configHorizontal configChannelCombination _configTrigClass 1_configTrigSource 1_configTrigTV _configMemory E configMemoryEx 1_configExtClock configMode _configMultilnput configControlloO configFCounter _configAvgConfig configLogicDevice configSetupArray 1_logicDevicelo Page 9 of 159 Multilnstr
103. mbers are limited to O and the supported values To find out which connectors are supported by a given module use this function with connector 0 AcqrsD1l_getControllO instrID 0 amp ctrlIOPattern NULL NULL In this case the returned value of signal is the bit coded list of the connectors that are available in the digitizer E g If the connectors 1 I O A 2 I O B and 9 TrigOut are present the bits 1 2 and 9 of signal are set where bit 0 is the LSbit and 31 is the MSbit Thus the low order 16 bits of signal or ctrllOPattern in the example above would be equal to 0x206 The DC271 FAMILY 10 bit FAMILY AP FAMILY 12 bit FAMILY and AC SC cards support the connectors 1 front panel I O A MMCX coax 2 front panel I O B MMCX coax and 9 front panel Trig Out MMCX coax Programmer s Reference Manual Page 78 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getControll0 ViSession instrumentID Vilnt32 connector Vilnt32 signal Vilnt32 qualifierl ViReal64 qualifier2 LabVIEW Representation AqDx Query Control IO Connectors vi Instrument ID Connector error in no error dup Instrument ID Signal error out Qualifier2 Qualifier 1 Visual Basic Representation GetControlIO ByVal instrumentID As Long ByVal connector As Long signal As Long qualifierl As Long qualifier2 As Double As Long Visual Basic NET Representation AcqrsD1l_getContr
104. ming examples and operating system commands Certain features are common to several different modules For increased readability we have defined the following families DC271 FAMILY DC135 DC140 DC211 DC211A DC241 DC241A DC271 DC271A DC271AR DP214 DP235 DP240 AP FAMILY AP240 AP235 AP100 AP101 AP200 AP201 12 bit FAMILY DC440 DC438 DC436 DP310 DP308 DP306 10 bit FAMILY DC122 DC152 DC222 DC252 DC282 1 4 Warning Regarding Medical Use The Digitizer cards are not designed with components and testing procedures that would ensure a level of reliability suitable for use in treatment and diagnosis of humans Applications of these cards involving medical or clinical treatment can create a potential for accidental injury caused by product failure or by errors on the part of the user These cards are not intended to be a substitute for any form of established process or equipment used to monitor or safeguard human health and safety in medical treatment WARNING The modules discussed in this manual have not been designed for making direct measurements on the human body Users who connect an Acqiris module to a human body do so at their own risk 1 5 Warranty Please refer to the appropriate User Manual 1 6 Warranty and Repair Return Procedure Assistance and Support Please refer to the appropriate User Manual 1 7 System Requirements Please refer to the appropriate User Manual Programmer s Reference Manual Page 6 of 159 acqiris
105. mpHi Vilnt32 bit trigger timestamp See discussion below Name Type Description status ViStatus Refer to Table 2 1 for error codes Programmer s Reference Manual Page 141 of 159 acqiris Discussion See remarks under AcqrsD1_readCharSequencefor details about the horPos and timeStamp parameters and the Programmer s Guide section 3 9 2 Reading Sequences of Waveforms for the allocation of the buffers The dataType 3 rule given there for the arraySize becomes arraySize segmentOffset nbrSegments 1 since the waveformArray here is ViReal64 However the other rule changes too 8 arraySize gt nbrSamplesNom currentSegmentPad nbrSegments 1 LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_readRealSequence ViSession instrumentID Vilnt32 channel Vilnt32 firstSegment VilInt32 nbrSegments Vilnt32 firstSamplelnsSeg Vilnt32 nbrSamplesInSeg Vilnt32 segmentOffset Vilnt32 arraySize ViReal64 waveformArray ViReal64 horPos ViReal64 sampTime Vilnt32 timeStampLo VilInt32 timeStampHi LabVIEW Representation AqDx Read Sequence in Volts vi should be considered as obsolete Please use AqDx Read Digitizer Data vi instead Visual Basic Representation ReadRealSequence ByVal instrumentID As Long ByVal channel As Long ByVal firstSegment As Long ByVal nbrSegments As Long ByVal firstSampleInSeg As Long ByVal nbrSamplesInSeg As Long _ ByVal segmentOffset
106. mulate Data vi instead Visual Basic Representation AccumulateWform ByVal instrumentID As Long ByVal channel As Long ByVal segmentNumber As Long ByVal firstSample As Long ByVal nbrSamples As Long waveformArray As Byte sumArray As Long returnedSamples As Long sampTime As Double vGain As Double vOffset As Double As Long Programmer s Reference Manual Page 15 of 159 acqiris 2 3 3 AcqrsD1_acqDone Purpose Checks if the acquisition has terminated Parameters Input Name Type Description InstrumentID ViSession Instrument identifier Output Name Type Description Done ViBoolean done VI_ TRUE if the acquisition is terminated VI FALSE otherwise Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l_acqDone ViSession instrumentID ViBoolean done LabVIEW Representation AqDx Query Acquisition Status vi Instrument ID dup Instrument 1D Jeeeeeeees D O ne Done error out error in no error Visual Basic Representation AcqDone ByVal instrumentID As Long done As Boolean As Long Visual Basic NET Representation AcgrsD1_acqDone ByVal instrumentID As Int32 ByRef done As Boolean As Int32 MATLAB MEX Representation status done Aq_acqDone instrumentID Programmer s Reference Manual Page 16 of 159
107. n status sampInterval nomSamples Aq_bestSampInterval instrumentID maxSamples timeWindow Programmer s Reference Manual Page 27 of 159 acqiris 2 3 10 AcqrsD1_calibrate Purpose Performs an auto calibration of the instrument Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_calibrate ViSession instrumentID LabVIEW Representation AqDx Calibrate Instrument vi Instrument ID _ Instrument ID error in no error error out Visual Basic Representation Calibrate ByVal instrumentID As Long As Long Visual Basic NET Representation AcgqrsD1_calibrate ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation status Aq_calibrate instrumentID Programmer s Reference Manual Page 28 of 159 acqiris 2 3 11 AcqrsD1_calibrateEx Purpose Performs a partial auto calibration of the instrument Parameters Input Name Type Description instrumentID ViSession Instrument identifier calType Vilnt32 0 calibrate the entire instrument calibrate only the current channel configuration 2 calibrate external clock timing Requires operation in External Clock Continuous 3 calibrate only at the current frequency 12 bit FAMILY only 4 fast calibra
108. n no error i dup Instrument ID enim error out Visual Basic Representation ConfigSetupArray ByVal instrumentID As Long ByVal channel As Long ByVal setupType As Long ByVal nbrSetupObj As Long setupData As Any As Long Visual Basic NET Representation AcgqrsD1_configSetupArray ByVal instrumentID As Int32 ByVal channel As Int32 ByVal setupType As Int32 ByVal nbrSetupObj As Int32 ByRef setupData As Int32 As Int32 MATLAB MEX Representation status Aq_configSetupArray instrumentID channel setupType nbrSetupObj setupData Programmer s Reference Manual Page 59 of 159 2 3 26 AcqrsD1_configTrigClass acqiris Purpose Configures the trigger class control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier trigClass Vilnt32 0 edge trigger 1 TV trigger 12 bit FAMILY External only sourcePattern Vilnt32 0x000n0001 for Channel 1 0x000n0002 for Channel 2 0x000n0004 for Channel 3 0x000n0008 for Channel 4 etc 0x800n0000 for External Trigger 1 0x400n0000 for External Trigger 2 etc where n is 0 for single instruments or the module number for MultiInstruments ASBus operation See discussion below validatePattern Vilnt32 Currently ignored HoldType Vilnt32 Currently ignored holdValuel ViReal64 Currently ignored holdValue2 ViReal64 Currently ig
109. nbrSamplesInSeg nbrSegments size_of dataType For analyzers O O O with readMode 0 1 2 its size must be at least nbrSamplesInSeg nbrSegments with readMode 3 the array size must be at least the sum of all gate lengths with readMode 4 in the APx01 analyszers the array size must be 4 sizeof double number of gates with readMode 4 in the AdvancedTDC analyszers the array size must be 8 number of peaks with readMode 7 in the AdvancedTDC or SSR analyszers the array size must be 8 nbrSegments nbrSamplesInSeg nbrSegments for the worst case of all the data with readMode 9 the array size must be at least e 2 HistoRes nbrSamplesInSeg nbrSegments Size_of dataType if a segmented histogram is used and where e HistoRes is the value used in the call to Acqrs_configAvgConfig with TdcHistogramRes e NbrSegments is either 1 or the number of segments if the value used in the call to Acqrs_configAvgConfig with TdcHistogramMode is 1 e Size dataType 2 1 HistoDepth where HistoDepth is the value used in the call to Acqrs_configAvgConfig with TdcHistogramDepth for all other cases its size in bytes must be at least nbrSamplesInSeg nbrSegments size of dataType Programmer s Reference Manual Page 136 of 159 acqiris For configuring gate parameters see the User Manual Family of Analyzers The value of returnedSamplesPerSeg for readMode 7 is not useable and therefore set to 0 If used the segment descriptor array s
110. nored Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes Discussion The number of internal i e channel or external trigger sources of the instrument can be retrieved with the AcqrsD1_getInstrumentInfo function For more details on the trigger source pattern in ASBus connected MultiInstruments please refer to the Programmers Guide section 3 15 2 Trigger Source Numbering with ASBus For configuring the TV trigger see AcqrsD1_configTrigTV Programmer s Reference Manual Page 60 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgqrsD1l_configTrigClass ViSession instrumentID Vilnt32 trigClass Vilnt32 sourcePattern Vilnt32 validatePattern Vilnt32 holdType ViReal64 holdValuel ViReal64 holdValue2 LabVIEW Representation AqDx Configure Trigger Class vi Validate Pattern 0 Source Pattern 1 Chan 1 Instrument ID Trigger Class 0 edge Hold Type 0 error in no error Hold Value 1 0 Hold Value 2 0 dup Instrument ID error out Visual Basic Representation ConfigTrigClass ByVal instrumentID As Long ByVal trigClass As Long ByVal sourcePattern As Long ByVal validatePattern As Long ByVal holdType As Long ByVal holdValuel As Double _ ByVal holdValue2 As Double As Long Visual Basic NET Representation AcgqrsD1_configTrigClass ByVal instrumentID As Int32 ByVal trigClass As Int32
111. ntains either the average values calculateMean TRUE or the sample by sample sums calculateMean FALSE Note that in the latter case the sumArray can be interpreted as an unsigned integer Alternatively negative values have to be increased by 2 32 The number of acquisitions nbrAcq can be at most 16777216 for readPar gt dataType 0 char or 65536 for readPar gt dataType 1 short This is to avoid an overflow where the summed values will wrap around 0 The value in Volts of a data point data in the returned waveformArray or normalized sumArray can be computed with the formula V dataDesc vGain data dataDesc vOffset The function will return ACQIRIS ERROR _ACQ TIMEOUT if there is no trigger within the specified timeout interval after the start of each acquisition LabWindowsCVI Visual C Representation ViStatus AcqrsD1l_averagedData ViSession instrumentID Vilnt32 channel AqReadParameters readPar Vilnt32 nbrAcq Vilnt8 calculateMean ViReal64 timeout void dataArray Vilnt32 sumArray AqDataDescriptor dataDesc void segDescArray LabVIEW Representation AqDx Averaged Data vi This Vi is polymorphic the sample data is returned in an array of type I8 or I16 segDescArray in channel Instrument ID readPar aygParams sum rray in dataArray in error in no error dup Instrument ID dataDesc segDesc rray out sum rray out error out data4rray out Programmer s Reference Manual
112. nts error in no error Number of Samples error out Visual Basic Representation GetMemory ByVal instrumentID As Long nbrSamples As Long nbrSegments As Long As Long Visual Basic NET Representation AcgqrsD1_getMemory ByVal instrumentID As Int32 ByRef nbrSamples As Int32 ByRef nbrSegments As Int32 As Int32 MATLAB MEX Representation status nbrSamples nbrSegments Aq_getMemory instrumentID Programmer s Reference Manual Page 93 of 159 acqiris 2 3 43 AcqrsD1_getMemoryEx Purpose Returns the current extended memory control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description nbrSamplesHi ViUInt32 Will be set to 0 reserved for future use nbrSamplesLo ViUInt32 Nominal number of samples to record per segment nbrSegments Vilnt32 Number of segments to acquire 1 corresponds to the normal single trace acquisition mode nbrBanks Vilnt32 Will be set to 1 reserved for future use flags Vilnt32 0 default memory use force use of internal memory for 10 bit FAMILY digitizers with extended memory options only Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configMemoryEx Programmer s Reference Manual Page 94 of 159 acqiris LabWindowsCVI Visual C
113. o return the error codes ACQIRIS ERROR NOT ENOUGH DEVICES or ACQIRIS ERROR NO MASTER DEVICE when nbrInstruments is lt 2 or the masterID is not one of the values in the instrumentList This function should only be used if the choices of the automatic initialization function AcqrsD1_multiInstrAutoDefine must be overridden If the function executes successfully the instrumentID presented in the instrumentList cannot be used anymore since they represent individual digitizers that have become part of the new Multilnstrument identified with newly returned instrumentID Please refer to the Programmer s Guide section 3 2 7 Manual Definition of Multilnstruments for more information Programmer s Reference Manual Page 122 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_multilnstrDefine ViSession instrumentList Vilnt32 nbrInstruments ViSession masterlD ViSession instrumentID LabView Representation AqDx Configure Multilnstrument Manual Define vi Instrument List none Multilnstrument ID Master Digitizer ID 0 error in no error error out Visual Basic Representation MultilnstrDefine ByRef instrumentList As Long ByVal nbrInstruments As Long ByVal masterID As Long instrumentID As Long As Long Visual Basic NET Representation AcgrsD1_multilnstrDefine ByRef instrumentList As Int32 ByVal nbrInstruments As Int32 ByVal masterID As Int32 ByRef instrumentID As Int32 A
114. o simplify digitizer configuration It returns the maximum nominal number of samples that fit into the available memory Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description nomSamples Vilnt32 Maximum number of data samples available Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion When using this method make sure to use AcqrsD1_configHorizontal and AcqrsD1_configMemory beforehand to set the sampling rate and the number of segments to the desired values nbrSamples in AcqrsD1_configMemory may be any number AcqrsD1_bestNominalSamples depends on these variables Programmer s Reference Manual Page 24 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgqrsD1_bestNominalSamples ViSession instrumentID Vilnt32 nomSamples LabVIEW Representation AgqDx Query Best Nominal Samples vi Instrument ID dup Instrument ID Nominal Samples error in no error error out Visual Basic Representation BestNominalSamples ByVal instrumentID As Long nomSamples As Long As Long Visual Basic NET Representation AcqrsD1_bestNominalSamples ByVal instrumentID As Int32 ByRef nomSamples As Int32 As Int32 MATLAB MEX Representation status nomSamples Aq_bestNominalSamples instrumentID Programmer s Reference Manual P
115. ockType ViReal64 inputThreshold Vilnt32 delayNbrSamples ViReal64 inputFrequency ViReal64 sampFrequency LabVIEW Representation AqDx Query Instrument ID error in no error External Clock vi ClockType Reference Frequency dup Instrument ID Sample Frequency Input Threshold error out Delay Number of Samples Visual Basic Representation GetExtClock ByVal clock instrumentID As Long Type As Long input delayNbrSamples As Long inputFrequency As Double Threshold As Double sampFrequency As Double As Long Visual Basic NET Representation AcqrsD1_get ExtClock ByVal instrumentID As Int32 ByRef ByRef ByRef ByRef ByRef clockType As Int32 inputThreshold As Double delayNbrSamples As Int32 inputFrequency As Double sampFrequency As Double As Int32 MATLAB MEX Representation status clockType inputThreshold delayNbrSamples inputFrequency sampFrequency Ag_getExtClock instrument ID Programmer s Reference Manual Page 81 of 159 2 3 38 AcqrsD1_getFCounter acqiris Purpose Returns the current frequency counter configuration Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description signalChannel Vilnt32 Signal input channel type Vilnt32 Type of measurement 0 Frequency default Period 1 frequen
116. of 159 acqiris 2 3 35 AcqrsD1_getChannelCombination Purpose Returns the current channel combination parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description nbrConvertersPer Vilnt32 1 all channels use 1 converter each default Channel 2 half of the channels use 2 converters each 4 1 4 of the channels use 4 converters each usedChannels Vilnt32 bit field indicating which channels are used See discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configChannelCombination Programmer s Reference Manual Page 76 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getChannelCombination ViSession instrumentID Vilnt32 nbrConvertersPerChannel Vilnt32 usedChannels LabVIEW Representation AqDx Query Channel Combination vi Instrument ID dup Instrument ID nbrConvertersPerChannel error in no error usedCharnels error out Visual Basic Representation GetChannelCombination ByVal instrumentID As Long nbrConvertersPerChannel As Long usedChannels As Long As Long Visual Basic NET Representation AcgrsD1_getChannelCombination ByVal instrumentID As Int32 ByRef nbrConvertersPerChannel As Int32 ByRef usedChannels As Int32 As Int32 MATL
117. olIO ByVal instrumentID As Int32 ByVal connector As Int32 ByRef signal As Int32 ByRef qualifierl As Int32 ByRef qualifier2 As Double As Int32 MATLAB MEX Representation status signal qualifierl qualifier2 Aq_getControlIO instrumentID connector Programmer s Reference Manual Page 79 of 159 acqiris 2 3 37 AcqrsD1_getExtClock Purpose Returns the current external clock control parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description clockType Vilnt32 0 Internal Clock default at start up 1 External Clock continuously running 2 External Reference 10 MHz 4 External Clock with start stop sequence inputThreshold ViReal64 Input threshold for external clock or reference in mV delayNbrSamples ViInt32 Number of samples to acquire after trigger for clockType 1 only inputFrequency ViReal64 The presumed input frequency of the external clock for clockType 4 only sampFrequency ViReal64 The desired Sampling Frequency for clockType 4 only Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configExtClock Programmer s Reference Manual Page 80 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsD1_getExtClock ViSession instrumentID Vilnt32 cl
118. oldType As Int32 ByRef holdValuel As Double _ ByRef holdValue2 As Double As Int32 MATLAB MEX Representation status trigClass sourcePattern validatePattern holdType holdValuel holdValue2 Aq_getTrigClass instrumentID Programmer s Reference Manual Page 105 of 159 2 3 50 AcqrsD1_getTrigSource acqiris Purpose Returns the current trigger source control parameters for a specified channel Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Number of IntTrigSources for internal sources 1 Number of ExtTrigSources for external sources See discussion below Output Name Type Description trigCoupling Vilnt32 0 DC 1 AC 2 HF Reject 3 DC 500 4 AC 500 trigSlope Vilnt32 0 Positive 1 Negative 2 out of Window 3 into Window 4 HF divide 5 Spike Stretcher trigLevell ViReal64 Trigger threshold in of the vertical Full Scale of the channel or in mV if using an External trigger source See discussion below trigLevel2 ViReal64 Trigger threshold 2 as above for use when Window trigger 1s selected Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configTrigSource Programmer s Reference Manual Page 106 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus stat
119. on board logic devices such as user programmable FPGA s NOTE With the exception of AC and SC Analyzers this function now needs to be used only by ETS and VxWorks users to specify the filePath for FPGA bit files Otherwise it should no longer have to be used Parameters Input Name Type Description instrumentID ViSession Instrument identifier deviceName ViChar Identifies which device to program For the AC210 AC240 and SC210 SC240 modules this string must be Block Dev1 Alternatively it can be ASBUS n Block1Dev1 with n ranging from 0 to the number of modules 1 When clearing the FPGA s the string must be Block DevAlI filePathName ViChar File path and file name flags Vilnt32 flags may be 0 program logic device with data in the file filePathName 1 clear the logic device 2 set path where FPGA bit files can be found 3 0 use normal search order with AqDrv4 ini file Return Value ViStatus Refer to Table 2 1 for error codes Discussion With flags 2 in ETS or VxWorks systems the filePathName must point to a directory containing the FPGA configuration files with extension bit With flags 0 or 3 the filePathName must point to an FPGA configuration file with extension bit e g D Averagers FPGA AP100DefaultFPGA 1 bit For more details on programming on board logic devices please refer to the Programmer s Guide sections 3 2 Device Initialization
120. or in no error error out Visual Basic Representation MultiInstrUndefineAll ByVal optionsString As String As Long Visual Basic NET Representation AcqrsD1_multiInstrUndefineAll ByVal optionsString As String As Long MATLAB MEX Representation status Aq _multilnstrUndefineAll optionsString Programmer s Reference Manual Page 124 of 159 acqiris 2 3 60 AcqrsD1_procDone Purpose Checks if the on board data processing has terminated This routine is for Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Description done ViBoolean done VI_ TRUE if the processing is terminated VI FALSE otherwise Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_procDone ViSession instrumentID ViBoolean done LabVIEW Representation AgqDx Query Process Done vi dup Instrument ID Done Done error out Instrument ID error in no error Visual Basic Representation ProcDone ByVal instrumentID As Long done As Boolean As Long Visual Basic NET Representation AcgrsD1_procDone ByVal instrumentID As Int32 ByRef done As Boolean As Int32 MATLAB MEX Representation status done Aq_procDone instrumentID Programmer s Reference Manual Page 125 of 159 2 3 6
121. polation 2 Interpolated peaks 3 8 sample peak regions for data readout 4 16 sample peak regions for data readout ThresholdEnable Vilnt32 May assume 0 no threshold and 1 threshold enabled For Averagers ONLY Threshold ViReal64 Value in Volts of the threshold for Noise Supressed Averaging or for SSR or AdvancedTDC with Threshold Gates TrigAlways Vilnt32 May assume 0 no trigger output and 1 trigger output on in the case of no acquisition TriggerTimeout Vilnt32 Trigger timeout in units of 30 ns in the range 0 2 1 A value of 0 means that no trigger will be generated and no Prepare for Trigger signal will be needed For AP101 AP201 ONLY TrigResync Vilnt32 May assume 0 no resync resync and 2 free run ValidDeltaNegPeak Vilnt32 Positive excursion needed to validate a negative peak May assume values between 1 and Oxff For AP101 AP201 ONLY ValidDeltaPosPeak Vilnt32 Negative excursion needed to validate a positive peak May assume values between 1 and Oxff For AP101 AP201 ONLY ValidDeltaPosPeakV ViReal64 Negative excursion needed to validate a positive peak Must be positive For Advanced TDC mode Analyzers ONLY Programmer s Reference Manual Page 35 of 159 acqiris Discussion The TrigResync values 0 and 1 require a valid trigger while 2 requires no trigger useful for background acquisit
122. posed GateType Vilnt32 For AP240 AP235 Analyzers and AdvancedTDC ONLY 0 No gates 1 User Gates 2 Threshold Gates For AdvancedTDC a gate mode must be chosen HistoTDCEnable Vilnt32 For AP240 AP235 Averagers ONLY May assume 0 for not enabled and 1 to enable the simple TDC mode for the channel InvertData Vilnt32 May assume 0 no inversion and 1 invert data 1 s complement NbrMaxGates Vilnt32 For Threshold Gate type in AP240 AP235 Analyzers and AdvancedTDC ONLY Maximum number of gates allowed for each segment 0 No limit imposed NbrSamples Vilnt32 Number of data samples per waveform segment May assume values between 16 or 32 and the available memory length in multiples of 16 32 as explained below NbrSegments Vilnt32 Number of waveform segments to acquire May assume values between and 8192 NbrWaveforms Vilnt32 Number of waveforms to average before going to next segment May assume values between 1 and 65535 64K 1 For Averagers ONLY NbrRoundRobins Vilnt32 Number of times to perform the full segment cycle during data accumulation For AP240 AP235 Averagers and Programmer s Reference Manual Page 33 of 159 acqiris Parameter String Data Type Description AdvancedTDC ONLY NoiseBaseEnable Vilnt32 May assume 0 no base subtraction and 1 base subtraction enabl
123. qDx Configure Control IO Connectors vi Qualifier2 Qualifier 1 Instrument ID dup Instrument ID Connector Signal error out error in no error Visual Basic Representation ConfigControlIO ByVal instrumentID As Long ByVal connector As Long ByVal signal As Long ByVal qualifierl As Long ByVal qualifier2 As Double As Long Visual Basic NET Representation AcqrsD1l_configControlIO ByVal instrumentID As Int32 ByVal connector As Int32 ByVal signal As Int32 ByVal qualifierl As Int32 ByVal qualifier2 As Double As Int32 MATLAB MEX Representation status Aq_configControlIO instrumentID connector signal qualifierl qualifier2 Programmer s Reference Manual Page 42 of 159 2 3 17 AcqrsD1_configExtClock acqiris Purpose Configures the external clock of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier clockType Vilnt32 0 Internal Clock default at start up 1 External Clock continuously running 2 External Reference 10 MHz 4 External Clock with start stop sequence inputThreshold ViReal64 Input threshold for external clock or reference in mV delayNbrSamples Vilnt32 Number of samples to acquire after trigger for digitizers using clockType 1 only inputFrequency ViReal64 The input frequency of the external clock for clockType 1 only sampFrequency ViReal64 T
124. rammer s Guide section 3 9 4 Reading an Averaged Waveform from an Averager and 3 9 5 Reading a RT Add Subtract Averaged Waveform from an Averager If read Mode is set to gated the nbrSamplesInSeg is set to the sum of the gate lengths The rules for the allocation of memory for the dataArray are as follows For digitizers or other modules used as such O with readMode 0 and dataType 0 the array size in bytes must be at least nbrSamplesInSeg 32 with readMode 0 and dataType 1 the array size in words must be at least nbrSamplesInSeg 32 with readMode 0 and dataType 3 the array size in bytes must be at least 40 for 8 bit digitizers and 88 for 10 bit and 12 bit digitizers with readMode 1 the waveform destination array dataArray must not only allocate enough space to hold the requested data but also some additional space This function achieves a higher transfer speed by simply transferring an image of the digitizer memory to the CPU memory and then reordering all circular segment buffers into linear arrays Since allocating a temporary buffer for the memory image is time consuming the user allocated destination buffer is also used as a temporary storage for the memory image The rule for the minimum storage space to allocate with waveformArray is discussed in the Programmer s Guide section 3 9 2 Reading Sequences of Waveforms For averagers readMode 2 5 or 6 are allowed and the size must be at least
125. ries LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_resetDigitizerMemory ViSession instrumentID LabVIEW Representation AqDx Reset Digitizer Memory vi Instrument ID E e Instrument ID error in no error error out Visual Basic Representation ResetDigitizerMemory ByVal instrumentID As Long As Long Visual Basic NET Representation AcqrsD1_resetDigitizerMemory ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation status Aq_resetDigitizerMemory instrumentID Programmer s Reference Manual Page 148 of 159 acqiris 2 3 71 AcqrsD1_restoreInternalRegisters Purpose Restores some internal registers of an instrument Only needed after power up of a digitizer with the battery back up option Parameters Input Name Type Description instrumentID ViSession Instrument identifier delayOffset ViReal64 Global delay offset should be retrieved with AcqrsD1_getInstrumentInfo DelayOffset before power off If not known use the value 20 0e 9 delayScale ViReal64 Global delay scale should be retrieved with AcqrsD1_getInstrumentInfo DelayScale before power off If not known use the value 5 0e 12 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The normal startup sequence destroys the contents of the Acqiris digitizer memories This function together
126. rizontal Waveform Position for a detailed discussion of the value delayTime The returned parameters timeStampLo and timeStampHi are respectively the low and high parts of the 64 bit trigger timestamp in units of picoseconds The timestamp is the trigger time with respect to an arbitrary time origin typically the start time of the acquisition which is intended for the computation of time differences between segments of a Sequence acquisition Please refer to the Programmer s Guide section 3 13 Timestamps for a detailed explanation Programmer s Reference Manual Page 131 of 159 the formula acqiris The value in Volts of a data point data in the returned waveformArray can be computed with V vGain data vOffset LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_readCharWform ViSession instrumentID VilInt32 channel VilInt32 segmentNumber Vilnt32 firstSample Vilnt32 nbrSamples ViChar waveformArray Vilnt32 returnedSamples Vilnt32 addrFirstPoint ViReal64 horPos ViReal64 sampTime ViReal64 vGain ViReal64 vOffset Vilnt32 timeStampLo Vilnt32 timeStampHi LabVIEW Representation AqDx Read Waveform in ADC vi should be considered as obsolete Please use AqDx Read RAW Data vi instead Visual Basic Representation ReadCharwform ByVal instrumentID As Long ByVal channel As Long ByVal segmentNumber As Long ByVal firstSample As Long ByVal nbrSamples As Long
127. rmal data acquisition mode 0 supports the following submodes Programmer s Reference Manual flags 0 normal digitizer mode flags 1 StartOnTrigger mode whereby data recording only begins after the receipt of a valid trigger For details see Programmer s Guide section 3 16 Special Operating Modes flags 2 Sequence Wrap mode whereby a multi segment acquisition with nbrSegments gt 1 when configured with the function AcqrsD1_configMemory does not stop after nbrSegments but wraps around to zero indefinitely Thus such acquisitions must be stopped with the function AcqrsD1_stopAcquisition at the appropriate moment The digitizer memory then contains the last nbrSegments 1 waveform segments For details see Programmer s Guide section 3 16 Special Operating Modes Page 54 of 159 acqiris The averaging mode 2 has the following differences from the default mode 0 e The function AcqrsD1_acquire In mode 0 it starts a normal waveform acquisition whereas in mode 2 it makes the instrument run as a real time averager e The function AcqrsD1_readData with dataType ReadReal64 In mode 0 it returns the last acquired waveform whereas in mode 2 it returns the averaged waveform in Volts The buffered data acquisition mode 3 and the SSR mode 7 have the following differences from the default mode 0 e The function AcqrsD1_acquire In mode 0 it starts a normal waveform
128. rs Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan setupType Vilnt32 Type of setup 0 GateParameters nbrSetupObj Vilnt32 Number of setup objects in the array setupData ViAddr Pointer to an array containing the setup objects ViAddr resolves to void in C C The user must allocate the appropriate variable type and supply its address as setupData Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes GateParameters Name Type Description GatePos Vilnt32 Start position of the gate must be multiple of 4 GateLength Vilnt32 Length of the gate must be multiple of 4 Discussion The user has to take care to allocate sufficient memory for the setupData nbrSetupObj should not be higher than what the allocated setupData holds The SSR option allows up to 4095 gate definitions The AP101 AP201 analyzers are limited to 64 gate definitions Note The driver contains a set of 4095 64 default AqGateParameters defined as 0 256 256 256 512 256 768 256 Programmer s Reference Manual Page 58 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_configSetupArray ViSession instrumentID VilInt32 channel Vilnt32 setupType Vilnt32 nbrSetupObj ViAddr setupData LabVIEW Representation AqDx Configure Setup Array vi Channel 1 Instrument ID setupType nbrSetupObj setupData error i
129. s Int32 MATLAB MEX Representation status instrumentID Aq_multilnstrDefine instrumentlist nbrinstruments masterlD Programmer s Reference Manual Page 123 of 159 acqiris 2 3 59 AcqrsD1_multilnstrUndefineAll Purpose Undefines all Multilnstruments Parameters Input Name Type Description optionsString ViString ASCII string which specifies options Currently no options are supported Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion You should refer to to the Programmers Guide section 3 2 Device Initialization for a detailed explanation on the initialization procedure This function is almost never needed except if you want to dynamically redefine Multilnstruments with the aid of the function AcqrsD1_multilnstrDefine If the function executes successfully the instrumentID of the previously defined Multilnstruments cannot be used anymore You must either have remembered the instrumentID of the single instruments that made up the MultiInstruments or you must reestablish all instrumentID of all digitizers by reinitializing with the code shown in the Programmer s Guide section 3 2 1 Identification by Order Found LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_multilnstrUndefineAll ViString optionsString LabVIEW Representation AqDx Configure Multilnstrument Undefine vi Options null in err
130. se the specified instrument Once closed this instrument is not available anymore and needs to be reenabled using InitWithOptions or init For freeing properly all resources closeAll must still be called when the application closes even if close was called for each instrument g LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_close void LabVIEW Representation AqDx Close vi Instrument ID dup InstrumentID error in no error error out Visual Basic Representation Close ByVal instrumentID As Long As Long Visual Basic NET Representation AcgqrsD1_close ByVal instrumentID As Int32 As Int32 MATLAB MEX Representation status Aq_close instrumentID Programmer s Reference Manual Page 31 of 159 2 3 13 AcqrsD1_closeAll acqiris Purpose Closes all instruments in preparation for closing the application Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes Discussion This function should be the last call to the driver before closing an application Make sure to stop all instruments beforehand If this function is not called closing the application might crash the computer in some situations particularly in multi threaded applications LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_closeAll void LabVIEW Representation AqDx Close All Instruments vi error in no error
131. sentation AqDx Process Data vi Instrument ID processType flags error in no error dup Instrument ID error out Visual Basic Representation ProcessData ByVal instrumentID As Long ByVal processType As Long ByVal flags As Long As Long Visual Basic NET Representation AcqrsD1_processData ByVal instrumentID As Int32 ByVal processType As Int32 ByVal flags As Int32 As Int32 MATLAB MEX Representation status Aq_processData instrumentID processType flags Programmer s Reference Manual Page 127 of 159 acqiris 2 3 62 AcqrsD1_readCharSequence DEPRECATED Purpose Returns a sequence of waveforms as a byte array Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan firstSegment Vilnt32 Requested first segment number may assume 0 to the number of segments 1 nbrSegments Vilnt32 Requested number of segments may assume to the number of segments set with the function AcqrsD1_configMemory firstSampleInSeg Vilnt32 Requested position of first sample to read typically 0 May assume 0 to the number of samples 1 as set with the function AcqrsD1_configMemory nbrSamplesInSeg ViInt32 Requested number of samples may assume to the number of samples set with the function AcqrsD1_configMemory segmentOffset Vilnt32 Requested o
132. sentation GetVertical ByVal instrumentID As Long ByVal Channel As Long fullScale As Double offset As Double coupling As Long bandwidth As Long As Long Visual Basic NET Representation AcqrsDl_getVertical ByVal instrumentID As Int32 ByVal Channel As Int32 ByRef fullScale As Double ByRef offset As Double ByRef coupling As Int32 ByRef bandwidth As Int32 As Int32 MATLAB MEX Representation status fullScale offset coupling bandwidth Agq_getVertical instrumentID Programmer s Reference Manual channel Page 113 of 159 2 3 54 AcqrsD1_init acqiris Purpose Initializes an instrument Parameters Input Name Type Description resourceName ViRsre ASCII string which identifies the digitizer to be initialized See discussion below IDQuery ViBoolean Currently ignored resetDevice ViBoolean If set to TRUE resets the digitizer after initialization Output Name Type Description InstrumentID ViSession Instrument identifier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion You should refer to the Programmer s Guide section 3 2 Device Initialization for a detailed explanation on the initialization procedure The function returns the error code ACQIRIS ERROR INIT STRING INVALID when the initialization string could not be interpreted Programmer s Reference Manual Page 114
133. sic NET Representation AcqrsD1_configVertical ByVal instrumentID As Int32 ByVal Channel As Int32 ByVal fullScale As Double ByVal offset As Double ByVal coupling As Int32 ByVal bandwidth As Int32 As Int32 MATLAB MEX Representation status Aq_configVertical instrumentID channel fullScale offset coupling bandwidth Programmer s Reference Manual Page 67 of 159 acqiris 2 3 30 AcqrsD1_errorMessage Purpose Translates an error code into a human readable form The new function AcqrsD1_errorMessageEx is to be preferred Parameters Input Name Type Description instrumentID ViSession Instrument identifier can be VI NULL errorCode ViStatus Error code returned by a function to be translated Output Name Type Description errorMessage ViChar Pointer to user allocated string suggested size 512 into which the error message text is returned Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion There is no Matlab MEX implementation of this function LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_errorMessage ViSession instrumentID ViStatus errorcode ViChar errorMessagel LabVIEW Representation AqDx Error Message vi Status dup Instrument ID Note This vi already Error Message implements the use of Error Code error out AcgrsD1_errorMessageEx Instr
134. st nbrSamples 32 for reasons of data alignment sumArray Vilnt32 User allocated waveform accumulation array Its size MUST be at least nbrSamples It is a 32 bit integer long array with the sample by sample sum of the data values in ADC count unit LSB See discussion below returnedSamples Vilnt32 Number of data samples actually returned sampTime ViReal64 Sampling interval in seconds vGain ViReal64 Vertical gain in Volts LSB See discussion below vOffset ViReal64 Vertical offset in Volts See discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The sumArray contains the sample by sample sums To get the average values the array elements must be divided by the number of accumulations performed The value in Volts of a data point data in the returned waveformArray can be computed with the formula V vGain data vOffset Programmer s Reference Manual Page 14 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus AcqrsD1_accumulateWform ViSession instrumentID Vilnt32 channel Vilnt32 segmentNumber Vilnt32 firstSample Vilnt32 nbrSamples ViChar waveformArray Vilnt32 sumArray Vilnt32 returnedSamples ViReal64 sampTime ViReal64 vGain ViReal64 vOffset LabVIEW Representation AqDx Read Accumulated Waveform vi should be considered as obsolete Please use AqDx Accu
135. t number may assume 0 to the number of segments 1 set with the function AcqrsD1_configMemory firstSample Vilnt32 Requested position of first sample to read typically 0 May assume 0 to the number of samples 1 set with the function AcqrsD1_configMemory nbrSamples Vilnt32 Requested number of samples may assume to the number of samples set with the function AcqrsD1_configMemory nbrAcq Vilnt32 Number of acquisitions to be performed timeout ViReal64 Acquisition timeout in seconds The function will return an error if for each acquisition no trigger arrives within the specified timeout after the start of the acquisition The minimum value is ms Output Name Type Description waveformArray ViChar User allocated waveform destination array of type char or byte Its size MUST be at least nbrSamples 32 for reasons of data alignment sumArray Vilnt32 User allocated waveform accumulation array Its size MUST be at least nbrSamples It is a 32 bit integer long array with the sample by sample sum of the data values in ADC count unit LSB See discussion below returnedSamples Vilnt32 Number of data samples actually returned sampTime ViReal64 Sampling interval in seconds vGain ViReal64 Vertical gain in Volts LSB See discussion below vOffset ViReal64 Vertical offset in Volts See discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Programmer s Re
136. ter 3 PROGRAMMING AN ACQIRIS DIGITIZER provides information on using the device driver functions to operate an Acqiris digitizer Chapter 4 ATTRIBUTES contains reference information about attributes The attribute interface to the driver can be used with the MATLAB interface and the SP201 Software Development Kit This Programmer s Reference manual is divided into 2 sections Chapter 1 INTRODUCTION describes what can be found where in the documentation and how to use it Programmer s Reference Manual Page 5 of 159 acqiris Chapter 2 DEVICE DRIVER FUNCTION REFERENCE contains a full device driver function reference This documents the traditional Application Program Interface API as it can be used in the following environments LabWindowsCVI Visual C LabVIEW Visual Basic Visual Basic NET 1 3 Conventions Used in This Manual The following conventions are used in this manual This icon to the left of text warns that an important point must be observed WARNING Denotes a warning which advises you of precautions to take to avoid being electrically shocked CAUTION Denotes a caution which advises you of precautions to take to avoid electrical mechanical or operational damages NOTE Denotes a note which alerts you to important information Italic text denotes a warning caution or note Bold Italic text is used to emphasize an important point in the text or a note mono text is used for sections of code program
137. that corresponds to the total number of segments requested with the function AcqrsD1_configMemory The timestamp of the first requested segment is therefore deposited in timeStampLo firstSegment which is not necessarily timeStampLo 0 The returned parameters horPos are the horizontal positions for each segment of the first nominal data point with respect to the origin of the nominal trigger delay in seconds Since the first data point is BEFORE the origin this number will be in the range sampTime 0 Refer to the Programmer s Guide section 3 10 Trigger Delay and Horizontal Waveform Position for a detailed discussion of the value delayTime The returned parameters timeStampLo and timeStampHi are respectively the low and high parts of the 64 bit trigger timestamp on per segment in units of picoseconds The timestamp is the trigger time with respect to an arbitrary time origin typically the start time of the acquisition which is intended for the computation of time differences between segments of a Sequence acquisition Please refer to the Programmer s Guide section 3 13 Timestamps for a detailed explanation The value in Volts of a data point data in the returned waveformArray can be computed with the formula V vGain data vOffset Programmer s Reference Manual Page 129 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_readCharSequence ViSession instrumentID Vi
138. the ADC value Here the lowest two bits will be lost truncated The advantage is that the amount of data to be transferred has been cut by a factor of 2 Real64 readout of 10 bit digitizers is based on 16 bit transfer of the data The value in Volts of any integer data point data in the returned dataArray for a digitizer can be computed with the formula V vGain data vOffset Except in the case of Analyzers the data points for dataType 3 are in Volts and no conversion is needed For Analyzers the data points are in units of the LSB of the ADC and must be converted using the formula above For readMode 0 and dataType lt 1 indexFirstPoint must be used for the correct identification of the first data point in the dataArray Page 135 of 159 acqiris The 3 averaged modes correspond to 2 24 bit data read as such into either Int32 32 bit integers or converted into volts for Real64 5 16 bit data read of the least significant 16 bits of the 24 bit sum The result is presented in either an Intl6 array or converted into volts for Real 64 The user is responsible for treating any potential overflows 6 16 bit data read of the most significant 16 bits of the 24 bit sum The result is presented in either an Intl6 array or converted into volts for Real 64 The user is responsible for treating any potential overflows It should also be noted that the interpretation of averager results was discussed in the Prog
139. the channels use 4 converters each usedChannels Vilnt32 bit field indicating which channels are used See discussion below Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The acceptable values for usedChannels depend on nbrConvertersPerChannel and on the number of available channels in the digitizer A If nbrConvertersPerChannel 1 usedChannels must reflect the fact that ALL channels are available for use It accepts a single value for a given digitizer usedChannels 0x00000001 ifthe digitizer has 1 channel 0x00000003 if the digitizer has 2 channels 0x0000000f if the digitizer has 4 channels B If nbrConvertersPerChannel 2 usedChannels must reflect the fact that only half of the channels may be used usedChannels 0x00000001 use channel 1 on a 2 channel digitizer 0x00000002 use channel 2 on a 2 channel digitizer 0x00000003 use channels 1 2 on a 4 channel digitizer 0x00000005 use channels 1 3 on a 4 channel digitizer 0x00000009 use channels 1 4 on a 4 channel digitizer 0x00000006 use channels 2 3 on a 4 channel digitizer 0x0000000a use channels 2 4 on a 4 channel digitizer 0x0000000c use channels 3 4 on a 4 channel digitizer C If nbrConvertersPerChannel 4 usedChannels must reflect the fact that only 1 of the channels may be used usedChannels 0x00000001 use channel 1 on a 4 channel digitizer 0x00000002 us
140. the m th module of a multi instrument m Vilnt32 runs from 0 to nbr of modules 1 CrateNb Vilnt32 Physical crate number perhaps from AqGeo map DelayOffset ViReal64 Calibrated Delay Offset only useful for recovery of battery backed up acquisitions DelayScale ViReal64 Calibrated Delay Scale only useful for recovery of battery backed up acquisitions ExtCkRatio ViReal64 Ratio of sFmax over external clock inputFrequency HasTrigVeto Vilnt32 Returns 1 if the functionality is available 0 otherwise IsPreTriggerRunning Vilnt32 Returns 1 if the module has an acquisition started but is not yet ready to accept a trigger LogDevDataLinks Vilnt32 Number of available data links for a streaming analyzer LOGDEVHDRBLOCKmDEVnS ViChar Returns information about FPGA firmware loaded See string comments below MaxSamplesPerChannel Vilnt32 Max Number of samples per channel available in digitizer mode NbrADCBits Vilnt32 Number of bits of data per sample from this modules ADCs NbrExternalTriggers Vilnt32 Number of external trigger sources NbrInternalTriggers Vilnt32 Number of internal trigger sources NbrModulesInInstrument Vilnt32 Number of modules in this instrument Individual modules Programmer s Reference Manual Page 88 of 159 acqiris Parameter String Returned Description Type not connected through ASBus return 1 Options ViC
141. tion for current settings only modifier Vilnt32 For calType 0 1 or 2 Currently unused set to 0 For calType 3 or 4 0 calibrate for all channels n calibrate for channel n flags Vilnt32 Currently unused set to 0 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion Calling this function with calType 0 is equivalent to calling AcqrsD1_calibrate Calibrating with calType 1 reduces the calibration time in digitizers with many possible channel combinations e g the DC271 However the user must keep track of which channel combinations were calibrated and request another such partial calibration when changing the channel configuration with the function AcqrsD1_configChannelCombination Calibrating with calType 2 can only be done if the external input frequency is appropriately high See the discussion in the Programmer s Guide section 3 14 2 External Clock Continuous If the calibration cannot be done an error code will be returned It is not applicable for AP240 Signal Analyzer Platforms Calibrating with calType 3 is for 12 bit digitizers only and is needed to support the HRes SR functionality For best results it or the longer full calibration should be called after a change of sampling rate Calibrating with calType 4 is for DC135 DC140 DC211A DC241A DC271A DC271AR and 10 bit FAMILY models A new calibration sho
142. tor segDescArray As Any As Long Visual Basic NET Representation AcqrsDl_accumulateData ByVal instrumentID As Int32 ByVal ByRef ByRef ByRef ByRef ByRef As Int32 MATLAB MEX Representation channel As Int32 readPar As AgqReadParameters dataArray As Byte sumArray As Int32 dataDesc As AgqDataDescriptor segDescArray As AqSegmentDescriptor status readPar dataDesc segDescArray dataArray sumArray Ag_accumulateData instrumentID channel Programmer s Reference Manual Page 13 of 159 acqiris 2 3 2 AcqrsD1_accumulateWform DEPRECATED Purpose Returns a waveform as a byte 8 bit integer array and accumulates it in a client array This routine is for use with 8 bit Digitizers Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan segmentNumber Vilnt32 Requested segment number may assume 0 to the number of segments 1 set with the function AcqrsD1_configMemory firstSample Vilnt32 Requested position of first sample to read typically 0 May assume 0 to the number of samples 1 set with the function AcqrsD1_configMemory nbrSamples Vilnt32 Requested number of samples may assume to the number of samples set with the function AcqrsD1_configMemory Output Name Type Description waveformArray ViChar User allocated waveform destination array of type char or byte Its size MUST be at lea
143. tus Refer to Table 2 1 for error codes Programmer s Reference Manual Page 96 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_getMode ViSession instrumentID Vilnt32 mode Vilnt32 modifier LabVIEW Representation AqDx Query Operation Mode vi Instrument ID dup Instrument ID Mode Modifier error out error in no error Flags Visual Basic Representation GetMode ByVal instrumentID As Long mode as Long modifier As Long flags As Long As Long Visual Basic NET Representation AcqrsD1_getMode ByVal instrumentID As Int32 ByRef mode as Int32 ByRef modifier As Int32 ByRef flags As Int32 As Int32 MATLAB MEX Representation status mode modifiers flags Aq_getMode instrumentID Programmer s Reference Manual Vilnt32 flags Page 97 of 159 2 3 45 AcqrsD1_getMultilnput acqiris Purpose Returns the multiple input configuration on a channel Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Nchan Output Name Type Description input Vilnt32 0 input connection A 1 input connection B Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function is only of use for instruments with an input multiplexer i e more than 1 input per digitizer e g DP211 On
144. tus and avgMax will apply to Signal Averagers only The features that they support have not yet been implemented The value of segmentOffset must be nbrSamplesInSeg The waveforms are thus transferred sequentially into a single linear buffer with holes of length segmentOffset nbrSamplesInSeg between them Such holes could be used for depositing additional segment specific information before storing the entire sequence as a single array to disk If you specify firstSegment gt 0 you don t have to allocate any buffer space for waveforms that are not read i e waveformArray 0 corresponds to the first sample of the segment firstSegment Example In a DC270 if you specify nbrSamplesInSeg segmentOffset 1500 Then with nbrSegments 80 and nbrSamplesNom 1000 since the currentSegmentPad 408 you would have to allocate at least 1408 80 1 114 048 bytes It is strongly recommended to allocate the waveform destination buffers permanently rather than dynamically in order to avoid system overheads for buffer allocation deallocation LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_readData ViSession instrumentID Vilnt32 channel AqReadParameters readPar ViAddr dataArray AqDataDescriptor descriptor ViAddr segDesc LabVIEW Representations AqDx Read Digitizer Data vi This Vi is polymorphic the sample data is returned in an array of type 18 116 or DBL It is meant for the readout of mult
145. ual Basic Representation WaitForEndOfProcessing ByVal instrumentID As Long ByVal timeout As Long As Long Visual Basic NET Representation AcqrsD1_waitForEndOfProcessing ByVal instrumentID As Int32 ByVal timeout As Int32 As Int32 MATLAB MEX Representation status Aq_waitForEndOfProcessing instrumentID timeOut Programmer s Reference Manual Page 159 of 159
146. uld be done if the AcqrsD1_ configChannelCombination parameters or any of the following AcqrsD1_configVertical parameters are changed fullScale coupling impedance bandwidth channel This calibration will be much faster than the calT ype 0 case for models with more than one impedance setting Programmer s Reference Manual Page 29 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcgrsDl_calibrateEx ViSession instrumentID Vilnt32 calType Vilnt32 modifier Vilnt32 flags LabVIEW Representation AqDx CalibrateEx Instrument vi Instrument ID calType modifier error in no error dup Instrument ID error out Visual Basic Representation CalibrateEx ByVal instrumentID As Long ByVal calType As Long ByVal modifier As Long ByVal flags As Long As Long Visual Basic NET Representation AcgqrsD1_calibrateEx ByVal instrumentID As Int32 ByVal calType As Int32 ByVal modifier As Int32 ByVal flags As Int32 As Int32 MATLAB MEX Representation status Aq_calibrateEx instrumentID calType modifier flags Programmer s Reference Manual Page 30 of 159 acqiris 2 3 12 AcqrsD1_close Purpose Closes an instrument Parameters Input Name Type Description instrumentID ViSession Instrument identifier Return Value Name Type Description Status ViStatus Refer to Table 2 1 for error codes Discussion Clo
147. ument ID Type of Dialog 1 OK Msg error in no error Visual Basic Representation errorMessage ByVal instrumentID As Long ByVal errorCode As Long ByVal errorMessage As String As Long Visual Basic NET Representation AcqrsDl_errorMessage ByVal instrumentID As Int32 ByVal errorCode As Int32 ByVal errorMessage As String As Int32 Programmer s Reference Manual Page 68 of 159 2 3 31 AcqrsD1_errorMessageEx acqiris Purpose Translates an error code into a human readable form and returns associated information Parameters Input Name Type Description instrumentID ViSession Instrument identifier can be VI NULL errorCode ViStatus Error code returned by a function to be translated errorMessageSize Vilnt32 Size of the errorMessage string in bytes suggested size 512 Output Name Type Description errorMessage ViChar Pointer to user allocated string suggested size 512 into which the error message text is returned Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function should be called immediately after the return of the error status to ensure that the additional information remains available For file errors the returned message will contain the file name and the original ansi error string This is particularly useful for calls to the following functions AcqrsD1_ cali
148. ument Manual Define Multilnstrument Undefine Setup Streaming in SC Analyzer Acquisition Control Functions Start Acquisition Start Acquisition Extended Query Acquisition Status Software Trigger Software Trigger Extended Stop Acquisition Wait for End of Acquisition Number of Acquired Segments Data Transfer Functions Universal Waveform Read Accumulate Data Averaged Data Read Frequency Counter DEPRECATED Read Sequence ADC counts Read Sequence Volts Read Waveform ADC counts Read Waveform Volts Accumulate Waveform Averaged Waveform Query Functions Query External Clock Query Horizontal Settings Query Channel Combination Query Memory Settings Query Memory Settings extended Query Multiplexer Input Query Trigger Class Query Trigger Source Query Trigger TV Query Vertical Settings Query Digitizer Mode Query Control IO Query Frequency Counter Query Averager Configuration Instrument Basic Data Instrument Information Programmer s Reference Manual Acgrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs DO NOT Acqrs Acqrs Acgrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs Acqrs D D D1 1_acquire D1 D1 D1 D1 D1 D1 D1 acqiris 1 multiInstrDefine 1 multilInstrUndefineAll _setAttributeString 1_acquire lza X 1_acqDone
149. us AcqrsD1_getTrigSource ViSession instrumentID Vilnt32 channel Vilnt32 trigCoupling Vilnt32 trigSlope ViReal64 trigLevell ViReal64 triglevel2 LabVIEW Representation AqDx Query Extended Trigger Source vi Trigger Level 1 Trigger Level 2 dup Instrument ID Trigger Coupling Trigger Slope error out Instrument ID Channel 1 error in no error Visual Basic Representation GetTrigSource ByVal instrumentID As Long ByVal Channel As Long trigCoupling As Long trigSlope As Long trigLevell As Double trigLevel2 As Double As Long Visual Basic NET Representation AcqrsD1_getTrigSource ByVal instrumentID As Int32 ByVal Channel As Int32 ByRef trigCoupling As Int32 ByRef trigSlope As Int32 ByRef trigLevell As Double ByRef trigLevel2 As Double As Int32 MATLAB MEX Representation status trigCoupling trigSlope trigLevell trigLevel2 Ag_getTrigSource instrumentID channel Programmer s Reference Manual Page 107 of 159 2 3 51 AcqrsD1_getTrigTV acqiris Purpose Returns the current TV trigger parameters 12 bit FAMILY only Parameters Input Name Type Description instrumentID ViSession Instrument identifier channel Vilnt32 1 Number of ExtTrigSources for external sources See discussion below Output Name Type Description standard Vilnt32 0 625 50 2 1 PAL or SECAM
150. ut Programmer s Reference Manual Page 157 of 159 acqiris 2 3 78 AcqrsD1_waitForEndOfProcessing Purpose Waits for the end of on board data processing This routine is for Analyzers only Parameters Input Name Type Description instrumentID ViSession Instrument identifier timeout Vilnt32 Timeout in milliseconds Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion This function will return only after the on board processing has terminated or when the requested timeout has elapsed whichever is shorter For protection the timeout is clipped to a maximum value of 10 seconds If a larger timeout is needed call this function repeatedly While waiting for the processing to terminate the calling thread is put into idle permitting other threads or processes to fully use the CPU If the processing times out the returned status is ACQIRIS ERROR PROC TIMEOUT in which case you should use AcqrsD1_stopProcessing to stop the processing Otherwise the returned status is VI SUCCESS Programmer s Reference Manual Page 158 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l_waitForEndOfProcessing ViSession instrumentID Vilnt32 timeout LabVIEW Representation AqDx Wait For End Of Processing vi Instrument ID Timeout error in no error dup Instrument ID error out Vis
151. with a specific sequence of other function calls prevents this from occurring in digitizers with battery backed up memories Please refer to the Programmers Guide section 3 17 Readout of Battery Backed up Memories for a detailed description of the required initialization sequence to read battery backed up waveforms Programmer s Reference Manual Page 149 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_restorelnternalRegisters ViSession instrumentID ViReal64 delayOffset ViReal64 delayScale LabVIEW Representation AqDx Restore Internal Registers vi Instrument ID dup Instrument ID Delay Offset Delay Scale error out error in no error Visual Basic Representation RestoreInternalRegisters ByVal instrumentID As Long ByVal delayOffset As Double ByVal delayScale As Double As Long Visual Basic NET Representation AcqrsD1_restorelnternalRegisters ByVal instrumentID As Int32 ByVal delayOffset As Double ByVal delayScale As Double As Int32 MATLAB MEX Representation status Aq _restorelnternalRegisters instrumentID delayOffset delayScale Programmer s Reference Manual Page 150 of 159 2 3 72 AcqrsD1_setAttributeString acqiris Purpose Sets an attribute with a string value for use in SC Streaming Analyzers ONLY Parameters Input Name Type Description instrumentID ViSession Instrument identi
152. zation default 1 DMA use scatter gather DMA for data transfers default 1 simulate initialize a simulated device default 0 NOTE optionsString is case insensitive Output Name Type Description instrumentID ViSession Instrument identifier Return Value ViStatus Refer to Table 2 1 for error codes Discussion You should refer to the Programmer s Guide section 3 2 Device Initialization for a detailed explanation on the initialization procedure The function returns the error code ACQIRIS ERROR INIT STRING INVALID when the initialization string could not be interpreted When setting the option simulate to 1 TRUE the function AcqrsD1_setSimulationOptions should be called first with the appropriate options Multiple options can be given Separate the option value pairs with characters Programmer s Reference Manual Page 116 of 159 acqiris LabWindowsCVI Visual C Representation ViStatus status LabVIEW Representation AcqrsD1_InitWithOptions ViRsre resourceName ViBoolean IDQuery ViString optionsString ViBoolean resetDevice ViSession instrumentID AqDx Initialize with Options vi Options String null string Resouce Name PCI INSTRO ID Query F Skip Reset T Reset error in no error Simulation Options null st Instrument ID Name Serial Number error out Visual Basic Representation InitWithOptions ByVal ByVal ByVal ByVal

Digitizers User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents