Home

Digitizers User Manual

1. 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 Vilnt32 Requested number of samples may assume 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 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 pa
2. 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 StartDelay Vilnt32 Start delay in samples May assume values between 0 and 33554400 16777216 in steps of 16 32 as explained below The limit is StepSize 1024 1024 1 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 TrigAlways Vilnt32 May assume 0 no trigger output and trigger output on in the case of no acquisition TrigResync Vilnt32 May assume 0 no resync resync and 2 free run 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 Threshold Gates NoiseBaseEnable Vilnt32 May assume 0 no base subtraction and 1 base subtraction enabled 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 StartDeltaNegPeak Vilnt32 Negative excursion needed before searching for negative peak May assume
3. 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 timeStampHi 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 115 of 130 acqiris Discussion See remarks under AcqrsD1_readCharSequencefor details about the horPos and timeStamp parameters and the Programmer s Guide section 3 8 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 AcqrsDl_ readRealSequence ViSession instrumentID VilInt32 channel Vilnt32 firstSegment VilInt32 nbrSegments VilInt32 firstSampleInSeg VilInt32 nbrSamplesInSeg VilInt32 segmentOffset Vilnt32 arraySize ViReal64 waveformArray ViReal64 horPos ViReal64 sampTime Vilnt32 timeStampLo ViInt32 timeStampHi LabVIEW Representation AqDx Read Sequence in Volts vi should be considered as obsolete Please use AqDx Read Digitizer Data vi instead Visu
4. Programmer s Reference Manual Page 62 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 forceTrigEx ViSession instrumentID Vilnt32 forceTrigType VilInt32 modifier VilInt32 flags LabVIEW Representation AgDx 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 Programmer s Reference Manual Page 63 of 130 acqiris 2 3 31 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 as listed under AcqrsD1_config
5. ByRef result As Double As Int32 Programmer s Reference Manual Page 114 of 130 acqiris 2 3 61 AcqrsD1_readRealSequence DEPRECATED Purpose Returns a sequence of waveforms as a floating point double array with the measured data 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 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 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
6. ByRef trigLevell As Double _ ByRef trigLevel2 As Double As Int32 Programmer s Reference Manual Page 88 of 130 2 3 47 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 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 89 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getTrigTV ViSession instrumentID VilInt32 channel VilInt32 standard VilInt32 field VilInt32 line LabVIEW Representation AgDx Query Trigger TV vi Field dup Instrument ID standard error out line Instrument ID channel error in no error Visual Basic Representation GetTrigTV ByVa
7. Representation ViStatus status AcqrsD1l readCharWform ViSession instrumentID Vilnt32 channel VilInt32 segmentNumber Vilnt32 firstSample VilInt32 nbrSamples ViChar waveformArray ViInt32 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 AgDx Read RAW Data vi instead Visual Basic Representation ReadCharWform ByVal ByVal ByVal ByVal ByVal instrumentID As Long channel As Long segmentNumber As Long firstSample As Long nbrSamples As Long 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 Programmer s Reference Manual Long Page 107 of 130 2 3 59 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 Return Value 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 Us
8. Visual Basic NET Representation AcqrsD1_ configHorizontal ByVal instrumentID As Int32 ByVal sampInterval As Double _ ByVal delayTime As Double As Int32 Programmer s Reference Manual Page 43 of 130 2 3 19 AcqrsD1_configLogicDevice acqiris Purpose NOTE 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 Configures programs on board logic devices such as user programmable FPGA s Parameters Input Name Type Description instrumentID ViSession Instrument identifier deviceName ViChar Identifies which device to program In the AP100 AP101 AP235 AP240 and the 12 bit modules this string must be Block Devx with x 1 or 2 In the AP200 AP201 it must be Block1Devx with x 1 2 3 or 4 When clearing the FPGA s the string must be Block DevAll filePathName ViChar File path and file name modifier Vilnt32 Modifier 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 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion With modifier 1 in VxWorks systems the filePathName must point to a directory containing the FPGA configuration files with extension bit With modifier 0 the filePathName m
9. acqiris 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 LabVIEW Representation AgDx 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 AcqrsD1 reset ByVal instrumentID As Int32 Programmer s Reference Manual AcqrsD1_reset ViSession instrumentID As Int32 Page 120 of 130 2 3 65 AcqrsD1_resetDigitizerMemory acqiris 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 memories LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 resetDigitizerMemory ViSession instrumentID LabVIEW Represe
10. 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 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 apertureTim
11. 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 AcqrsD1l_ averagedWform ViSession instrumentID VilInt32 channel VilInt32 segmentNumber Vilnt32 firstSample VilInt32 nbrSamples Vilnt32 nbrAcg ViReal64 timeout ViChar waveformArray VilInt32 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 instrumentID As Long ByVal channel As Long ByVal segmentNumber As Long ByVal firstSample As Long ByVal nbrSamples As Long ByVal nbrAcq As Long _ ByVal timeout As Double 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 22 of 130 acqiris 2 3 8 AcqrsD1_bestNominalSamples Purpose Helper function to 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 sampl
12. functions do not execute and return an error code of the type VI ERROR_PARAMETERi 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 Programmer s Reference Manual Page 8 of 130 acqiris 2 2 API Function classification Initialization Functions Function Name Number of Physical Instruments AcqgrsD1_getNbrPhysicalInstruments MultiInstrument Auto Define AcgrsD1_multilInstrAutoDefine Initialization AcgrsD1_ init Initialization with Options AcgrsD1_InitWithOptions Simulation Options AcqrsD1_setSimulationOptions Calibration Functions Calibrate Instrument AcgrsD1_ calibrate Calibrate for External Clock AcgrsD1_calibrateEx Configuration Functions Configure Vertical Settings AcgrsD1_configVertical Configure Horizontal Settings AcgrsD1_configHorizontal Configure Channel Combination AcgrsD1_c
13. A O E 29 2 3 13 AcqrsD1 configAvgConfig es ceeeeseeseseeeecesececesecseeseesecseeeaecesssesseessesasscessesesseenaeenseneces 30 2 3 14 AcgqrsD1_configChannelCombination cceeeceeeecsseeeceseceteeceaeceeesecaeeeeceeeeeeaeeeeeaeeaeeeeeneees 34 2 315 AcqgrsD1 Config Control issiron sits hapsisdevesaateinadeysousds ent Epi se dened nE ERSE skrita SPESSE 36 2 3 16 AcqrsD1l_configExtClock eeseseeseeseeeeeseeessseseessssessseeeesstsesseseestsseesesseseessesresteseesesseseessesees 39 2 3 17 AcqrsD1_ configFCounter cccecccsccessessseeseeesceeccesecesecseceaeceaecaaecseecaeeeaeeeeeseeeseeeneeeeeeneenaees 41 2 3 18 AcqrsD1_configHorizontal eccecccccccseesseeeceescesecesecesecesecaecaecseecaeeeaeeeeeseeeseresreereneeensees 43 2 3 19 AcqrsD1_ configLogicDevice eccecccececssessseeeeeesceeeceseceseceseceaecsaecseecaeeeaeeeeeeeeeeeeeeereeeeeteenaees 44 2 3 20 AcqrsD 1 confisMemory sisene oi atecaplwanini el bite cis REEERE ARESE 46 232 AcqrsD1 conhigMode csccccsecsei eis edi ees ee ee 47 23 22 AcqrsD1 configMultiInput 2 cscicccieck antes ciaeeseaaeiceied nie ESN REEE kuaa aake ar 49 23 23 AcqrsD1_confieSetipArray sessirnir ena bison eE EEEN Ea EEE 50 2 3 24 AcqtsD1 config TigClasS s siirsin siii ri ciei rokne Ee Ea eara Ee iK Ea E Eira riea 52 2 3 25 AcqtsD1 config Tr gSources ccccccc ccccceesccsccassccscsaseceadccstecedeskecsadeccaensdecdecetdecesenadeddacsadecdacneteces 54 23 26 AcqtsD1 config Trig lV v
14. Acqiris 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 Copyright December 2004 Acqiris SA All rights reserved Programmer s Reference Manual Tel 61 3 9888 4586 Fax 61 3 9849 0861 Page 2 of 130 acqiris CONTENTS 1 TINTRODUCTION cic sssss ose cassccescies sects sate extasesessisenseesss esested steeedaecasesbaseabestsisesessabstdoceddosssbcesesuoivabseteate 5 Il Message to the User enen E aes ladesabeaeessdecddehsesedeetesccbinsenizee 5 1 2 Using this Manual ninne nrenn ei EA REA E NRS 5 1 3 Conventions Used in This Manual 0 ee eeeessessessecseesecseveeeneceeceaeceeesecsevaecnaveenaeeeeeaecaeeeeeneeates 6 1 4 Warning Regarding Medical Use cccccccesecsseesseesesseeesceecceecneceseceseceaecaecaaecaeeaeceecaeeeaeeeneeass 6 ES WAY osasse E sieges sbeasnsssdedbavsteatagase E 6 1 6 Warranty and Repair Return Procedure Assistance and Support ccecesesceeseceeeeeetecereeeeneeeees 6 L7 System Requirements ssis ann ee i aaea oa ainan aa eei aaraa ai Saaai RSs 6 2 DEVICE DRIVER FUNCTION REFERENCE ccssssssssssesscsessesecsesseseesessesecseseesesseseesesseseeners 7 2 1 Status values
15. 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 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 Chapter 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 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 Programmer s Reference Manual Page 5 of 130 acqiris 1 3 Conventions Used in This Manual The following conventions are used in this
16. 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 12 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 and DC271A models A new calibration should 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 calType 0 case for models with more than one impedance setting Programmer s Reference Manual Page 27 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1_ calibrateEx ViSession instrumentID VilInt32 calType VilInt32 modifier VilInt32 flags LabVIEW Representation AgDx CalibrateEx Instrument vi ical a dup Instrument ID calType modifier error out error in
17. 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 MQ external input impedance possibilities Programmer s Reference Manual Page 54 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configTrigSource ViSession instrumentID VilInt32 channel VilInt32 trigCoupling Vilnt32 trigSlope ViReal64 trigLevell ViReal64 trighevel2 LabVIEW Representation AgDx Configure Trigger Source vi Trigger Level 2 0 Channel 1 Instrument ID dup Instrument ID Trigger Coupling 0 DC Trigger Slope 0 positive error out error in no error Trigger Level 1 0 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 _ ByVal trigLevell As Double _ ByVal t
18. discussion below Output Name Type Description trigCoupling Vilnt32 0 DC 1 AC 2 HF Reject 3 DC 50Q 4 AC 5090 trigSlope Vilnt32 0 Positive 1 Negative 2 out of Window 3 into Window 4 HF divide 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 See remarks under AcqrsD1_configTrigSource Programmer s Reference Manual Page 87 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getTrigSource ViSession instrumentID VilInt32 channel VilInt32 trigCoupling VilInt32 trigSlope ViReal64 trighLevell ViReal64 trighevel2 LabVIEW Representation AgDx Query 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 _
19. for a detailed description of the required initialization sequence to read battery backed up waveforms Programmer s Reference Manual Page 122 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 restoreInternalRegisters 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_ restoreInternalRegisters ByVal instrumentID As Int32 ByVal delayOffset As Double ByVal delayScale As Double As Int32 Programmer s Reference Manual Page 123 of 130 acqiris 2 3 67 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 VilInt32 color LabVIEW Representation AgDx Set LED Color
20. 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 NOTE 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
21. 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 programming 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 DP214 DP235 DP240 AP FAMILY AP240 AP235 AP100 AP101 AP200 AP201 12 bit FAMILY DC440 DC438 DC436 DP3 10 DP308 DP306 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 treatmen
22. s Reference Manual Page 77 of 130 acqiris 2 3 39 AcqrsD1_getMemory 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_ getMemory ViSession instrumentID VilInt32 nbrSamples VilInt32 nbrSegments LabVIEW Representation AqDx Query Memory Settings vi Instrument ID dup Instrument ID f Number of Segments 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 AcqrsD1 getMemory ByVal instrumentID As Int32 ByRef nbrSamples As Int32 _ ByRef nbrSegments As Int32 As Int32 Programmer s Reference Manual Page 78 of 130 acqiris 2 3 40 AcqrsD1_getMode Purpose Returns the current operational mode of the digitizer Parameters Input Name Type Descripti
23. 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 34 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configChannelCombination ViSession instrumentID VilInt32 nbrConvertersPerChannel VilInt32 usedChannels LabVIEW Representation AqDx Configure Channel Combination vi tater dup Instrument ID nbrConyvertersPerChannel saeia 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 AcqrsD1 configChannelCombination ByVal instrumentID As Int32 ByVal nbrConvertersPerChannel As Int32 ByVal usedChannels As Int32 As Int32 Programmer s Reference Manual Page 35 of 130 2 3 15 AcqrsD1_configControllO acqiris Purpose Configures a ControllO connector For DC271 FAMILY AP FAMILY 12 bit FAMILY 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 DC24
24. 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 1 gated peak detection extrema mode 2 gated peak detection hysteresis mode 3 interpolated peaks extrema mode 4 interpolated peaks hysteresis mode 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsDl processData ViSession instrumentID Vilnt32 processType VilInt32 flags LabVIEW Representation Not yet supported 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 Programmer s Reference Manual Page 102 of 130 acqiris 2 3 57 AcqrsD1_readCharSequence DEPRECATED Purpose Returns a sequence of waveforms as a byte array
25. 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 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 9 Trigger Delay and Horizontal Waveform Position for a detailed discussion of the value delayTime The returned parameters timeStampLo and timeStampHij are respectively the low and high parts of th
26. values between 1 and Oxff For Analyzers ONLY StartDeltaPosPeak Vilnt32 Positive excursion needed before searching for positive peak May assume values between 1 and Oxff For Analyzers ONLY ValidDeltaNegPeak Vilnt32 Positive excursion needed to validate a negative peak May assume values between and Oxff For ONLY ValidDeltaPosPeak Vilnt32 Negative excursion needed to validate a positive peak May assume values between and Oxff For AP101 AP201 ONLY TriggerTimeout Vilnt32 Trigger timeout in units of 30 ns in the range 0 27 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 Programmer s Reference Manual Page 31 of 130 acqiris Parameter String Data Description Type The desired minimum width of a peak in the waveform i 7 It can take on a value n from 1 to 4 A peak is accepted if etc Vilnt32 there are at least n ee data ae above the Threshold For Simple TDC mode ONLY The desired increment to be applied for each entry TdcHistogramIncre 1 means increment by 1 ment Vilnt32 2 means increment by the ADCvalue NoiseBase For SimpleTDC mode ONLY Discussion The TrigResync values 0 and 1 require a valid trigger while 2 requires no trigger useful for background acquisition Set NbrWaveforms to 1 and NbrRoundRobins to n order to enable the rou
27. vi Instrument ID dup Instrument ID Color 0 Off error in no error 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 Programmer s Reference Manual Page 124 of 130 acqiris 2 3 68 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 8 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 Vis
28. 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_getTrigClass ViSession instrumentID Vilnt32 trigClass VilInt32 sourcePattern Vilnt32 validatePattern VilInt32 holdType ViReal64 holdValuel ViReal64 holdValue2 LabVIEW Representation AgDx Query Trigger Class vi Validate Pattern Hold Value 1 dup Instrument ID Hold Yalue 2 Trigger Class error out Source Pattern Hold Type Q 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 AcqrsD1_ getTrigClass ByVal instrumentID As Int32 ByRef trigClass As Int32 ByRef sourcePattern As Int32 _ ByRef validatePattern As Int32 ByRef holdType As Int32 _ ByRef holdValuel As Double _ ByRef holdValue2 As Double As Int32 Programmer s Reference Manual Page 86 of 130 2 3 46 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 Number of IntTrigSources for internal sources 1 Number of ExtTrigSources for external sources See
29. 1A DC271 DC271A 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 1 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 6 Connector Type Possible Values of signal and qualifierX Front Panel I O 0 Disable Inputs 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 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 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 Outputs 19 Clock 10 MHz reference clock 20 Pulse Acquisition ski
30. 3 28 AcqrsD1_errorMessage Purpose Translates an error code into a human readable form 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 minimum size 256 into which the error message text is returned Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_ errorMessage ViSession instrumentID ViStatus errorcode ViChar errorMessage LabVIEW Representation AqDx Error Message vi Status dup Instrument ID Error Message Error Code error out Instrument 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 AcqrsD1_errorMessage ByVal instrumentID As Int32 ByVal errorCode As Int32 ByVal errorMessage As String As Int32 Programmer s Reference Manual Page 60 of 130 acqiris 2 3 29 AcqrsD1_forceTrig Purpose Forces a manual trigger It should not be used for Averagers or Analyzers Parameters Input Name Type Description instrumentID ViSession Instrument identif
31. AqGateParameters defined as 0 256 256 256 512 256 768 256 Programmer s Reference Manual Page 50 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configSetupArray ViSession instrumentID ViInt32 channel Vilnt32 setupType Vilnt32 nbrSetupObj ViAddr setupData LabVIEW Representation Not yet supported 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 AcqrsD1_ configSetupArray ByVal instrumentID As Int32 ByVal channel As Int32 _ ByVal setupType As Int32 _ ByVal nbrSetupObj As Int32 _ ByRef setupData As Int32 As Int32 Programmer s Reference Manual Page 51 of 130 2 3 24 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 f
32. AvgConfig 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_configAvgConfig Programmer s Reference Manual Page 64 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getAvgConfig ViSession instrumentID Vilnt32 channelNbr ViString parameterString ViAddr value LabVIEW Representation AqDx Query Averager Settings vi Configuration Number Instrument ID dup Instrument ID Parameter String Value error in no error 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 AcqrsD1_ getAvgConfig ByVal instrumentID As Int32 ByVal channelNbr As Int32 ByVal parameterString As String ByRef value as Double As Int32 Programmer s Reference Manual Page 65 of 130 acqiris 2 3 32 AcqrsD1_getChannelCombination Purpose Returns the current channel combination parameters of the digitizer Parameters Input Name Type Description instrumentID ViSession Instrument identifier Output Name Type Des
33. ByVal holdValuel As Double _ ByVal holdValue2 As Double As Long Visual Basic NET Representation AcqrsD1_ configTrigClass ByVal instrumentID As Int32 ByVal trigClass As Int32 ByVal sourcePattern As Int32 _ ByVal validatePattern As Int32 ByVal holdType As Int32 _ ByVal holdValuel As Double _ ByVal holdValue2 As Double As Int32 Programmer s Reference Manual Page 53 of 130 2 3 25 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 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 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 internal i e
34. Currently three options are supported CAL do calibration at initialization 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 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 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 95 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 InitWithOptions ViRsrce resourceName ViBoolean IDQuery ViBoolean resetDevice ViString optionsString ViSession instrumentID LabVIEW Representation AgDx Initialize with Options vi Options String null string Resouce Name PCI INSTRO Instrument ID ID Query F Skip Name Reset T Reset Serial Number eror in no error toms error out Simu
35. ID VilInt32 channel ViRealo64 fullScale ViReal64 offset VilInt32 coupling VilInt32 bandwidth LabVIEW Representation AqDx Query Vertical Settings vi Coupling Instrument ID dup Instrument ID Channel 1 Bandwidth error in no error Full Scale error out Offset Visual Basic Representation 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 AcqrsD1_ 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 Programmer s Reference Manual Page 93 of 130 acqiris 2 3 50 AcqrsD1_init Purpose Initializes an instrument Parameters Input Name Type Description resourceName ViRsrc 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 proce
36. Make sure to use the same number of segments in this second call to AcqrsD1_configMemory as in the first one Programmer s Reference Manual Page 24 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 bestSampInterval ViSession instrumentID VilInt32 maxSamples ViReal64 timeWindow ViReal64 sampInterval VilInt32 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 sampiInterval 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 Programmer s Reference Manual Page 25 of 130 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 instrum
37. 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 LOGDEVHDRBLOCKmDEVnS 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 n versionTxt compDate model Examples double trigLevelRange AcqrsD1_ getInstrumentInfo ID TrighevelRange 1 amp trigLevelRange The acceptable trigger levels are in the range trigLevelRange trigLevelRange mV external trigger For modules supporting switch on overload protection long overLoad AcqrsD1_ getInstrumentInfo 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 OverLoadStat
38. OR PARAMETER14 BFFA4D0E 1074115314 ACQIRIS ERROR 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 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 Table 2 1 Acqiris Error Codes Error code Hex value Decimal value VI SUCCESS 0 VI ERROR PARAMETERI BFFCOOO1 1074003967 VI ERROR PARAMETER2 BFFCO0002 1074003966 VI ERROR PARAMETER3 BFFCO003 1074003965 VI ERROR PARAMETER4 BFFC0004 1074003964 VI ERROR PARAMETERS BFFC0005 1074003963 VI ERROR PARAMETER6 BFFCO006 1074003962 VI ERROR PARAMETER7 BFFCO007 1074003961 VI ERROR PARAMETERS BFFC0008 1074003960 VI ERROR FAIL ID QUERY BFFC0011 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
39. Programmer s Guide section 3 14 Special Operating Modes The averaging mode 2 has the following differences from the default mode 0 Programmer s Reference Manual Page 47 of 130 acqiris 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 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 Q 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 VilInt32 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 m
40. RROR_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 CALIBRATION 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 INVALID GEOMAP FILE BFFA48E0 1074116384 ACQIRIS ERROR _ ACQ TIMEOUT BFFA4900 1074116352 Programmer s Reference Manual Page 7 of 130 acqiris Acqiris Error Codes Hex value Decimal value 1074116088 1074115840 1074115839 1074115838 1074115837 1074115836 1074115835 1074115834 1074115584 ACQIRIS ERROR UNKNOWN ERROR BFFA4CO1 1074115583 ACQIRIS ERROR PARAMETER9 BFFA4D09 1074115319 ACQIRIS ERROR PARAMETER10 BFFA4D0A 1074115318 ACQIRIS ERROR PARAMETERI1 BFFA4D0B 1074115317 ACQIRIS_ERROR PARAMETER12 BFFA4D0C 1074115316 ACQIRIS ERROR PARAMETER13 BFFA4D0D 1074115315 ACQIRIS_ERR
41. T Representation AcqrsD1_ getHorizontal ByVal instrumentID As Int32 ByRef sampInterval As Double _ ByRef delayTime As Double As Int32 Programmer s Reference Manual Page 73 of 130 acqiris 2 3 37 AcqrsD1_getInstrumentData Purpose Returns some basic data about a specified digitizer 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getInstrumentData ViSession instrumentID ViChar name VilInt32 serialNbr VilInt32 busNbr VilInt32 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 A
42. TED DO NOT USE FOR NEW PROGRAMS Read Sequence ADC counts AcqrsD1_readCharSequence Read Sequence Volts AcqrsD1_ readRealSequenc Read Waveform ADC counts AcqrsD1_ readCharWform Read Waveform Volts AcqrsD1 readRealWform Accumulate Waveform AcgrsD1_accumulateWform Averaged Waveform AcgrsD1_averagedWform Query Functions Query External Clock AcgrsD1_getExtClock Query Horizontal Settings AcgrsD1_getHorizontal Query Channel Combination AcgrsD1_getChannelCombination Query Memory Settings AcqrsD1_getMemory Query Multiplexer Input AcgrsD1_getMultiInput Query Trigger Class AcqrsD1_getTrigClass Query Trigger Source AcqrsD1_getTrigSource Query Trigger TV AcgrsD1_getTrigTV Query Vertical Settings AcqrsD1_getVertical Query Digitizer Mode AcgrsD1_getMode Query Control IO AcgrsD1_getControlIo Query Frequency Counter AcgrsD1_getFCounter Query Averager Configuration AcgrsD1_getAvgConfig Instrument Basic Data AcqrsD1_ getInstrumentData Instrument Information AcgrsD1_getInstrumentInfo Number of Channels AcgrsD1_getNbrChannels Query Array of Setup Parameters AcgrsD1_getSetupArray Control Functions Query on board Processing Status AcqrsD1_ procDone Start on board Processing AcgrsD1_ processData Stop on board Processing AcqrsD1_stopProcessing Wait for End of on board Processing AcgrsD1_waitForEndOfProcessing Utility Functions Best Nominal Samples AcgrsD1_bestNominalSamples Best Sampling Interval AcgrsD1_be
43. TYPE can be either Int8 Intl6 or Double or AcqrsD1 readData ByVal instrumentID As Int32 ByVal channel As Int32 ByRef readPar As AqReadParameters ByRef dataArray As DATATYPEAVG _ ByRef dataDesc As AqDataDescriptor ByRef segDescArray As AqSegmentDescriptorAvg As Int32 Int32 Where DATATYPEAVG can be either Int16 Int32 or Double Programmer s Reference Manual Page 113 of 130 acqiris 2 3 60 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 AcqrsDl_ 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 AcqrsD1 readFCounter ByVal instrumentID As Int32
44. 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 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 11 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus AcqrsD1l_accumulateData ViSession instrumentID VilInt32 channel AqReadParameters readPar void dataArray VilInt32 sumArray AqDataDescriptor dataDesc void segDescArray LabVIEW Representation AqDx Accumulate Data vi This Vi is polymorphic the sample data is returned in an array of type I8 or I16 segDescArray in AAAA channe Instrument ID readPar sum rray in dataArr
45. V 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 AcqrsD1_ configTrigTV ByVal instrumentID As Int32 ByVal Channel As Int32 _ ByVal standard As Int32 ByVal field As Int32 _ ByVal line AS Int32 As Int32 Programmer s Reference Manual Page 57 of 130 acqiris 2 3 27 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 For the DC440 and DP310 the coupling input is used to select the signal input DC 50 Q 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
46. 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 9 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 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 11 Sequence Timestamps for a detailed explanation Programmer s Reference Manual Page 106 of 130 acqiris 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
47. _ ByVal qualifierl As Int32 _ ByVal qualifier2 As Double As Int32 Programmer s Reference Manual Page 38 of 130 2 3 16 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 The 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 12 External Clock for the setup parameters and the theory of operation Programmer s Reference Manual Page 39 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configExtClock ViSession
48. acqiris XZ100 ACQIRIS PROGRAMMER S REFERENCE MANUAL Programmer s Reference Manual ZMO020100E Rev A acqiris December 2004 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
49. al 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 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 116 of 130 acqiris 2 3 62 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 actua
50. al 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 Programmer s Reference Manual Page 84 of 130 acqiris 2 3 45 AcqrsD1_getTrigClass 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 al TV trigger 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 returns 0 holdType Vilnt32 Currently returns 0 holdValuel ViReal64 Currently returns 0 holdValue2 ViReal64 Currently returns 0 Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion See remarks under AcqrsD1_configTrigClass Programmer s Reference Manual Page 85 of
51. amples 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 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 13 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus AcqrsD1l_accumulateWform ViSession instrumentID ViInt32 channel VilInt32 segmentNumber VilInt32 firstSample VilInt32 nbrSamples V
52. and Error CodeS 0 0 ceeeceeceesceseseesseeseesecaeeecseesevseceaeeeceaeceessecaeeseceaveeesaeeeeaecateeesaeeated 7 2 2 API Function classification ccccccecccssessceeseeesceeseeseceeeeseceeecaecaecsaecseeaecaeceecaeecseseneeeseeeseeereees 9 2 3 API Function descriptions ccccccesccesecsceeseeeseeeseeseceseceseceseceaeceaeceaecaeecaeeeaeeseeseeeserenereeeeeneenaees 11 2 3 1 AcarsD1 accumulate Data ec cecccceceseceeceseceecseeeaeeseeeeeeseeneecneecaecnaecaaecaeecaeeeaeseneeneeennenas 11 2 3 2 AcqrsD1_accumulateWform DEPRECATED ccccecsceeseeesceeeceeceseceseceecaeeeseeeneeseeeerenes 13 2 3 3 PROG IS Wi ACG I OI esse ca ney cececsectczccecscacevacsestesitestes sheet nsasatuctas ceantves ince E E E 15 2 3 4 AN CGESID A ACQUIS a5 cose E ascents ews aerdicke x scalsc E E 16 2 3 5 ANCQESD 1 acquire EX sers cece cae eE E EAE EE isan tees 17 2 3 6 AcgrsDI averaged Data ccc o A E A A las 18 2 3 7 AcqrsD1_averagedWform DEPRECATED cccececsesceeseeeeeeeeeeseeesecseecaeecaeeseeseneeeneeneees 21 2 3 8 AcqrsD1_bestNominal Samples ccccecccsseesseeeeseeeeeceeeceseceaecnaeceaenaecaecaecaaecseesseseneeneeeneeeas 23 2 3 9 AcqrsD1_ bestSamplntervall sisisi ieissa ienr ee asiaa 24 2 3 10 AcqrsD1 calibrate sssini ireisisseires sastite ie tes KEET EE REEERE intimin its 26 23 11 AcarsDI calibrate EX cscs ccisc cccee cesctectnet asiecs cesceeveccati dak vaceteea EEEE EE EESE EA EEEE eant 27 2 12 ACS DI closeAll a O a
53. and dataType 1 the array size in words must be at least nbrSamplesInSeg 32 o with readMode 0 and dataType 3 the array size in bytes must be at least 40 o with readMode 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 Page 110 of 130 acqiris 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 8 2 Reading Sequences of Waveforms For averagers readMode 2 5 or 6 are allowed and the size must be at least nbrSamplesInSeg nbrSegments size_of_dataType For analyzers o with readMode 0 1 2 its size must be at least nbrSamplesInSeg nbrSegments o with readMode 3 the array size must be at least the sum of all gate lengths o with readMode 4 the array size must be 4 sizeof double number of gates o forall other cases its size in bytes must be at least nbrSamplesInSeg nbrSegments size_of_dataType For configuring gate parameters see the User Manual Family of Analyzers The value of returnedSamplesPerSeg fo
54. ard 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 AcqrsDl_ stopProcessing ViSession instrumentID LabVIEW Representation Not yet supported Visual Basic Representation StopProcessing ByVal instrumentID As Long As Long Visual Basic NET Representation AcgrsD1_ stopProcessing ByVal instrumentID As Int32 As Int32 Programmer s Reference Manual Page 127 of 130 acqiris 2 3 71 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 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 waitin
55. ay 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 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 Programmer s Guide section 3 8 4 Reading an Averaged Waveform from an Averager and 3 8 5 Reading a RT Add Subtract Averaged Waveform from an Averager If readMode 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 o with readMode 0
56. ay in error in no error i n dup Instrument ID dataDesc segDesc rray out sum rray out error out Visual Basic Representation dataArray out AccumulateData ByVal instrumentID As Long ByVal channel As Long readPar As AqReadParameters dataArray As Any sumArray As Long dataDesc As AqDataDescriptor segDescArray As Any As Long Visual Basic NET Representation AcqrsD1_ accumulateData By By By By By As Int32 Programmer s Reference Manual Ref Ref Ref Ref Ref ByVal instrumentID As Int32 ByVal channel As Int32 _ readPar As AqReadParameters dataArray As Byte sumArray As Int32 dataDesc As AqDataDescriptor segDescArray As AqSegmentDescriptor Page 12 of 130 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 s
57. cqrsD1 multilInstrDefine ByRef instrumentList As Int32 ByVal nbriInstruments As Int32 ByVal masterID As Int32 _ ByRef instrumentID As Int32 As Int32 Programmer s Reference Manual Page 99 of 130 acqiris 2 3 54 AcqrsD1_multilnstrUndefineAll Purpose Undefines all Multilnstruments Parameters Input Name Type Description optionsS tring 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 Programmer s 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 MultiInstruments 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 AcqrsDl_ multilInstrUndefineAll ViString optionsString LabVIEW Representation AqDx Configure MultilInstr
58. cription nbrConvertersPer VilInt32 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_ getChannelCombination ViSession instrumentID Vilnt32 nbrConvertersPerChannel ViiInt32 usedChannels LabVIEW Representation AqDx Query Channel Combination vi Instrument ID dup Instrument ID nbrConvertersPerChannel error in no error oadche ne error out Visual Basic Representation GetChannelCombination ByVal instrumentID As Long nbrConvertersPerChannel As Long usedChannels As Long As Long Visual Basic NET Representation AcqrsD1_ getChannelCombination ByVal instrumentID As Int32 ByRef nbrConvertersPerChannel As Int32 ByRef usedChannels As Int32 As Int32 Programmer s Reference Manual Page 66 of 130 acqiris 2 3 33 AcqrsD1_getControllO Purpose Returns the configuration of a ControlIO connector For DC271 FAMILY AP FAMILY 12 bit FAMILY only Parameters Input Name Type Description instrumentID ViSession Instrument identifier connector Vilnt32 Connector Number 1 Front Pan
59. dure The function returns the error code ACQIRIS ERROR INIT STRING INVALID when the initialization string could not be interpreted LabWindowsCVI Visual C Representation ViStatus status AcgqrsDl_ init ViRsrce resourceName ViBoolean IDQuery ViBoolean resetDevice ViSession instrumentID LabVIEW Representation AgDx Initialize vi Resouce Name PCI INSTRO ID Query F Skip Name Reset T Reset 3 Serial Number error in no eror error out Instrument ID 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 AcqrsD1 init ByVal resourceName As String ByVal IDQuery As Boolean _ ByVal resetDevice As Boolean ByRef instrumentID As Int32 As Int32 Programmer s Reference Manual Page 94 of 130 2 3 51 AcqrsD1_InitWithOptions acqiris Purpose Initializes an instrument with options Parameters Input Name Type Description resourceName ViRsrc 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
60. e 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 41 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configFCounter ViSession instrumentID VilInt32 signalChannel VilInt32 type ViReal64 targetValue ViReal64 apertureTime ViReal64 reserved VilInt32 flags LabVIEW Representation AgDx Configure FCounter vi iaia ID dup Instrument ID Configure values error out Visual Basic Representation ConfigFCounter ByVal instrumentID As Long ByVal signalChannel As Long ByVal type As Long ByVal targetValue As Double ByVal apertureTime As Double ByVal reserved As Double ByVal flags As Long As Long Visual Basic NET Representation AcqrsD1_ configFCounter ByVal instrumentID As Int32 ByVal signalChannel As Int32 ByVal type As Int32 ByVal targetValue As Double ByVal apertureTime As Double ByVal reserved As Double _ ByVal flag
61. e 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 11 Sequence 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 104 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l readCharSequence ViSession instrumentID Vilnt32 channel Vilnt32 firstSegment Vilnt32 nbrSegments Vilnt32 firstSampleInSeg VilInt32 nbrSamplesInSeg VilInt32 segmentOffset VilInt32 arraySize ViChar waveformArray ViReal64 horPos ViReal64 sampTime ViReal64 vGain ViReal64 vOffset Vilnt32 timeStampLo ViInt32 timeStampHi 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 Long ByVal channel As Long ByVal firstSegment As Long ByVal nbrSegments As Long ByVal firstSampleInSeg As Long ByVal nbrSamplesInSeg As Long ByVal segmentOffset As Long ByVal arraySize As Long waveformArray As Byte ho
62. edData ByVal instrumentID As Long ByVal channel As Long readPar As AqReadParameters ByVal nbrAcq As Long ByVal calculateMean As Boolean ByVal timeout As Double dataArray As Any sumArray As Long dataDesc As AqDataDescriptor segDescArray As Any As Long Visual Basic NET Representation AcqrsD1l_ averagedData ByVal instrumentID As Int32 ByVal channel As Int32 ByRef readPar As AqReadParameters ByVal nbrAcg As Int32 ByVal calculateMean As Boolean ByVal timeout As Double ByRef dataArray As Byte ByRef sumArray As Int32 _ ByRef dataDesc As AqDataDescriptor ByRef segDescArray As AqSegmentDescriptor As Int32 Programmer s Reference Manual Page 20 of 130 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 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 Viln
63. eecisebssebecescassbessnbsbassocdenhesevestasessusansseneunveess 78 2340 AcgrsD1 getModes sssrinin eni niece doen EE Nasa EE EEEE 79 23 41 AcqgrsDI getMullttlnpute cs cicc ccccccccceicccssceecsees cosceesscesekces coseeteacssecses E EEEE RE EE 80 Programmer s Reference Manual Page 3 of 130 acqiris 2342 AcqrsD1 getNbrChantiels 0 2 25 c sciscesssessceidaceseeveceati inea Eea a e Es EENE EEEE Eeit 81 2 3 43 AcqrsD1_getNbrPhysicallnstruments sssseseseesseeeesseseesesersessreesseesesseseesseseeseesresessesressesees 82 2344 AcgrsD1 petSet pAtrAy neir nnnnnn ann a a Ea aaki 83 2 345 AcqtsD1 getTrigClaSS a icscce ccccticeesscecesteassegnesaccevscsaescdnessdetueasadscdeessesccecceesdeaesege RKE EEE Eei 85 2 3 46 AcqrsDI getTrigSOurce ee eeesecesesecseeeseseseecesecacesecsesseesecseeuaeceseesseessesasenesaeeaseaeceseeeeneees 87 2347 AcgrsDI petli TV rpasis aea e adie Site eiaeia ai 89 2 3 48 AcqrsDl_getVersion ccecccesccesecsseccecseeeseeeseesecesecsecaeceaeceaecaueceeecaeeeaeeeaeseeeeseseneeeeeeerseatees 91 2 349 AcgrsDI getVerticabl s eskeiniriko akio Srednia 92 23 930 AcCgrsD 1 Init eiiie yeoten Gives tensions e Ea EEEE R ENEE E s 94 2 3 51 AcqrsD1_InitWithOptions seeseeseeseeeesseeeesseseessessestrseeeesstsesseserstsseesesseseesseseestesetsessesressesees 95 2 3 52 AcqrsD1_ multilnstrAutoDefine ssseenseesenseeseeeesseeeessesesersesseserstsseererseseesseseestesresessesressesees 97 2 3 53 Acqr
64. el 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 Programmer s Reference Manual Page 72 of 130 acqiris 2 3 36 AcqrsD1_getHorizontal 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 LabWindowsCVI Visual C Representation viStatus status AcqrsD1_getHorizontal ViSession instrumentID ViReal64 sampInterval ViReal64 delayTime LabVIEW Representation AgDx Query Horizontal Settings vi Instrument ID dup Instrument ID l 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 NE
65. el I O A MMCX connector 2 Front Panel I O B MMCX connector 9 Front Panel Trigger Out MMCX connector 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_configControlIo Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion ControlIO 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 numbers are limited to 0 and the supported values To find out which connectors are supported by a given module use this function with connector 0 AcqrsD1 getControllIO 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 si
66. entID 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 AcqrsD1 calibrate ByVal instrumentID As Int32 As Int32 Programmer s Reference Manual Page 26 of 130 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 calibration 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
67. epresentation AcqrsD1 acqDone ByVal instrumentID As Int32 ByRef done As Boolean As Int32 Programmer s Reference Manual Page 15 of 130 2 3 4 AcqrsD1_acquire acqiris 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 AcgqrsD1_acquire ViSession instrumentID LabVIEW Representation AgDx Start Acquisition vi Instrument ID dup Instrument ID Mode error out error in no error Visual Basic Representation Acquire ByVal instrumentID As Long As Long Visual Basic NET Representation AcgrsD1l_ acquire ByVal instrumentID As Int32 Programmer s Reference Manual As Int32 Page 16 of 130 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 Flags currently not used 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 viStatu
68. er Instrument ID dup Instrument ID Parameter String Yalue error out error in no error Visual Basic Representation ConfigAvgConfig ByVal instrumentID As Long ByVal channelNbr As Long ByVal parameterString As String value As Any As Long Visual Basic NET Representation AcqrsD1_ configAvgConfig ByVal instrumentID As Int32 ByVal channelNbr As Int32 ByVal parameterString As String ByRef value As Int32 As Int32 or AcqrsD1 ConfigAvgConfig ByVal instrumentID As Int32 ByVal channelNbr As Int32 _ ByVal parameterString As String ByRef value As Double As Int32 Programmer s Reference Manual Page 33 of 130 acqiris 2 3 14 AcqrsD1_configChannelCombination Purpose Configures how many converters are to be used for which channels This routine is for use with some DC271 FAMILY instruments 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 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 o
69. er 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 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 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 ONLY 5 short averaged waveform from an averager 6 shifted short averaged waveform from an averager 7 SSR waveform 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 V
70. er of actualTriggersInAcqHi ViUInt32 triggers taken for the entire acquisition actualDataSize ViUInt32 Actual length in bytes used at dataArray missing Value ViReal64 Reserved for future use reserved3 ViReal64 Reserved for future use Programmer s Reference Manual Page 109 of 130 Discussion acqiris 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 The following dataType and readMode combinations are supported 0 2 3 4 5 short 6 shifted 7 SSR standard image averaged gated peaks averaged short averaged 0 Int8 8 8 X X 1 Intl6 12 12 X X 2 Int32 X 3 Real64 X X X X X X Programmer s Reference Manual In this table 8 means that the functionality is available for 8 bit Digitizers and AP units in the digitizer mode while 12 means that it is available for 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 The value in Volts of any integer data point data in the returned dataArr
71. es 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_ bestNominalSamples ViSession instrumentID ViiInt32 nomSamples LabVIEW Representation AqDx Query Best Nominal Samples vi Instrument ID dup Instrument ID l 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 Programmer s Reference Manual Page 23 of 130 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
72. ese 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 normal data acquisition mode 0 supports the following submodes e flags 0 normal digitizer mode e flags 1 StartOnTrigger mode whereby data recording only begins after the receipt of a valid trigger For details see Programmer s Guide section 3 14 Special Operating Modes e 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
73. explanation on the initialization procedure LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l multilInstrAutoDefine ViString optionsString VilInt32 nbrinstruments LabVIEW Representation AgDx MultiInstrument Auto Define vi Die E Number of Instruments error in no error error out Visual Basic Representation MultiInstrAutoDefine ByVal optionsString As String nbrInstruments As Long As Long Visual Basic NET Representation AcqrsD1 multiInstrAutoDefine ByVal optionsString As String _ ByRef nbrInstruments As Int32 As Int32 Programmer s Reference Manual Page 97 of 130 acqiris 2 3 53 AcqrsD1_multilInstrDefine Purpose This function defines the combination of a number of digitizers connected by ASBus into a single MultiInstrument 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
74. g 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 128 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 waitForEndOfAcquisition ViSession instrumentID ViInt32 timeout LabVIEW Representation AgDx 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 Programmer s Reference Manual Page 129 of 130 acqiris 2 3 72 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 Descripti
75. gnal or ctrlJOPattern in the example above would be equal to 0x206 The DC271 FAMILY AP FAMILY and 12 bit FAMILY 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 MMCXxX coax Programmer s Reference Manual Page 67 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getControlIO ViSession instrumentID VilInt32 connector VilInt32 signal VilInt32 qualifierl ViReal64 qualifier2 LabVIEW Representation AqDx Query Control IO Connectors vi dup Instrument ID Signal error out Qualifier2 Qualifier 1 Instrument ID Connector error in no error 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 AcqrsD1_ getControlIO ByVal instrumentID As Int32 ByVal connector As Int32 ByRef signal As Int32 ByRef qualifierl As Int32 _ ByRef qualifier2 As Double As Int32 Programmer s Reference Manual Page 68 of 130 acqiris 2 3 34 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 a
76. iChar waveformArray VilInt32 sumArray Vilnt32 returnedSamples ViReal64 sampTime ViReal64 vGain ViReal64 vOffset LabVIEW Representation AqDx Read Accumulated Waveform vi should be considered as obsolete Please use AqDx Accumulate 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 14 of 130 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 AcqrsDl_acqDone ViSession instrumentID ViBoolean done LabVIEW Representation AqDx Query Acquisition Status vi Instrument ID dup Instrument ID eeseseneny Done i Done error out error in no error Visual Basic Representation AcqDone ByVal instrumentID As Long done As Boolean As Long Visual Basic NET R
77. ier Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes Discussion The function returns immediately after initiating an acquisition 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 AcqrsDl forceTrig ViSession instrumentID LabVIEW Representation AgDx Software Trigger vi Instrument ID dup Instrument ID Type 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 61 of 130 acqiris 2 3 30 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 acqui
78. iisiin E ar ERE a EE R EEr iait 56 23 27 AcqrtsD1 config Vertical ssnin E E A EEE KERS E a Ee 58 23 28 Ac rsDI errorMessage yitiren a a en ea AEE AE EAE EEEE REEERE EEE 60 23 29 ACs DI force Pits sti vscetiscssssscecnessiete a aa EE A aE e EEE EEE 61 2330 AcqrsDI force TrigExX cesssciesseieccisiesls sakenssendsnui oath tbsasesstsadasbesastatee ossdiqiesbsiensinetagdessitetseeetis 62 2 3 31 AcqrsD1_ getAvgConfig ce eeeseeeseeecesececesecsereeesecenesaecasesesseessssesecesaeeaseaecaseaceaecaseeeeneees 64 2 3 32 AcqrsD1_getChannelCombination 0 cccceesceecceseceseceseccecseceeecseecaeeeseeeeeeeeeeeeeeeeenereneeenaees 66 2 3 33 AcqrsD1_ getComntrollO ooo cece eccceeccesecesecesecaeecseeeseeeeeeeenseeeseeneecaecaaecaecaeecaeeeaeeeeeseeeeereerens 67 2 3 34 AcqrsD1_ getExtClock ce ececccesccesecsceeseeeseeeeeeseceecesecesecaeceaeceaecaeecaeeeaeeeeeseeesereneeesreneenaees 69 23 39 Acqgis Beth COUMER saccade o oviccdsvcuvuas costcucscodeaass isoine ieoanc suadaves cobyaeds iiaae 71 2 3 36 AcgrsD1 Set Ori Zonta os eescs csicicsscssebss undsavsstuse dae onteieue sees hc disuns coachesnebewieeqcastsstsdleusedsessnst 73 23 37 AcgrsD 1 sethnstrumentlD ata cisccssccvceces coscudsicdscecssetectantcvsceces shvczessatsenevsdeatesdubacensecnlbsesseneosaee 74 2 3 38 AcqrsD1l_getInstrumentlnfo g 1 0 ccccececes an tes eees tees esse ese hence snesb ees cee esscasteceestesbesereeeen ed 75 2 3 39 AcgrsD1_petMeMory sii ciscsdeiescsaseiceccesssesscevens
79. ilnt32 Requested position of first sample to read typically 0 May assume 0 to the actual number of samples 1 nbrSamplesInSeg Vilnt32 Requested number of samples may assume to the actual number of samples Programmer s Reference Manual Page 108 of 130 acqiris 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 gt nbrSamplesInSeg dataArraySize Vilnt32 Number of bytes in the user allocated dataArray Used for verification protection segDescArraySize 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 reserved2 ViReal64 Reserved for future use reserved3 ViReal64 Reserved for future use 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 in AqSegmentDe
80. instrumentID VilInt32 clockType ViReal64 inputThreshold VilInt32 delayNbrSamples ViReal64 inputFrequency ViReal64 sampFrequency LabVIEW Representation AgDx 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 As Long Visual Basic NET Representation ea X AcqrsD1 configExtClock ByVal instrumentID As Int32 ByVal clockType As Int32 _ ByVal inputThreshold As Double ByVal delayNbrSamples As Int32 ByVal inputFrequency As Double ByVal sampFrequency As Double As Int32 Programmer s Reference Manual Page 40 of 130 acqiris 2 3 17 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 targetValue ViReal64 User supplied estimate of the expected value may be 0 0 if no estimate is available
81. isted 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 value 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 ALREADY OPEN BFFA48 40 1074116544 ACQIRIS ERROR SETUP NOT AVAILABLE BFFA48 80 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_E
82. l instrumentID As Long ByVal Channel As Long standard As Long field As Long line AS Long As Long Visual Basic NET Representation AcqrsD1_ getTrigTV ByVal instrumentID As Int32 ByVal Channel As Int32 _ ByRef standard As Int32 ByRef field As Int32 _ ByRef line AS Int32 As Int32 Programmer s Reference Manual Page 90 of 130 acqiris 2 3 48 AcqrsD1_getVersion Purpose Returns version numbers associated with a specified digitizer 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_ getVersion ViSession instrumentID Vilnt32 versionItem VilInt32 version LabVIEW Representation AqDx Revision Query vi Instr Driver Rev numeric dup Instrument ID Instr Driver Revision Instr Firmware Revision er
83. lNb Serial number of the m th module of a multi instrument m Vilnt32 runs from 0 to nbr of modules 1 ASBus m SlotNb Slot number of the m th module of a multi instrument m a 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 if the functionality is available 0 otherwise TsPreTriggerRunning Vilnt32 Returns 1 if the module has an acquisition started but is not yet ready to accept a trigger 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 NbriInternalTriggers Vilnt32 Number of internal trigger sources NbrModulesInInstrument Vilnt32 Number of modules in this instrument Individual modules Programmer s Reference Manual Page 75 of 130 acqiris Parameter String Returned Description Type not connected through ASBus retur
84. lation Options null st Visual Basic Representation InitWithOptions ByVal resourceName As String ByVal IDQuery As Boolean ByVal resetDevice As Boolean ByVal optionsString As String instrumentID As Long As Long Visual Basic NET Representation AcqrsD1 InitWithOptions ByVal resourceName As String ByVal IDQuery As Boolean ByVal resetDevice As Boolean ByVal optionsString As String _ ByRef instrumentID As Int32 As Int32 Programmer s Reference Manual Page 96 of 130 acqiris 2 3 52 AcqrsD1_multiInstrAutoDefine 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
85. lly 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 below 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 117 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status LabVIEW Representation AqDx Read Waveform in Volts vi AcqrsD1_ readRealWform ViSession instrumentID Vilnt32 channel ViInt32 firstSample ViReal64 waveformArray ViReal64 horPos Vilnt32 timeStampLo VilInt32 segmentNumber VilInt32 nbrSamples Vilnt32 returnedSamples ViReal64 sampTime Vilnt32 timeStampHi should be considered as obsolete Please use AqDx 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 118 of 130 acqiris 2 3 63 AcqrsD1_reportNbrAcquiredSegments Pur
86. mple 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 VilInt32 channel AqReadParameters readPar VilInt32 nbrAcg VilInt8 calculateMean ViReal64 timeout void dataArray VilInt32 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 dup Instrument ID readPar dataDesc aygParams segDescArray out sumA rray in dataArray in error in no error sumA rray out error out dataArray out Programmer s Reference Manual Page 19 of 130 acqiris Visual Basic Representation Averag
87. n 1 Options ViChar 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 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 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 MultiInstrument and runs from 0 to nbr of modules 1 following the channel order It may be omitted on single digitizers or for the master of a
88. n 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 use 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
89. nd 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 AcqrsD1_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 32 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configAvgConfig ViSession instrumentID VilInt32 channelNbr ViString parameterString ViAddr value LabVIEW Representation AgDx Configure Averager Settings vi Configuration Numb
90. nnection As Long As Long Visual Basic NET Representation AcqrsD1 configMultilInput ByVal instrumentID As Int32 ByVal channel As Int32 ByVal connection As Int32 As Int32 Programmer s Reference Manual Page 49 of 130 2 3 23 AcqrsD1_configSetupArray acqiris Purpose Sets the configuration for an array of configuration values 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 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
91. no error 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 AcqrsD1 calibrateEx ByVal instrumentID As Int32 ByVal calType As Int32 _ ByVal modifier As Int32 _ ByVal flags As Int32 As Int32 Programmer s Reference Manual Page 28 of 130 acqiris 2 3 12 AcqrsD1_closeAll 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 Ed out Visual Basic Representation CloseAll As Long Visual Basic NET Representation AcqrsD1 closeAll As Int32 Programmer s Reference Manual Page 29 of 130 acqiris 2 3 13 AcqrsD1_configAvgConfig Purpose Configures a parameter for averager analyzer operation Parameters Input Name Type Descri
92. nt32 ByRef clockType As Int32 _ ByRef inputThreshold As Double ByRef delayNbrSamples As Int32 ByRef inputFrequency As Double ByRef sampFrequency As Double As Int32 Programmer s Reference Manual Page 70 of 130 2 3 35 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 frequency 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 71 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getFCounter ViSession instrumentID Vilnt32 signalChannel VilInt32 type ViReal64 targetValue ViReal64 apertureTime ViReal64 reserved Vilnt32 flags LabVIEW Representation AgDx Query FCounter vi Instrument ID dup Instrument ID Query results error out Visual Basic Representation GetFCounter ByVal instrumentID As Long SsignalChann
93. ntation AqDx Reset Digitizer Memory vi Instrument ID E a 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 Programmer s Reference Manual Page 121 of 130 acqiris 2 3 66 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_getInstrumentIinfo 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 with a specific sequence of other function calls prevents this from occurring in digitizers with battery backed up memories Please refer to the Programmer s Guide section 3 15 Readout of Battery Backed up Memories
94. o the normal single trace acquisition mode Return Value Name Type Description status ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l_ configMemory ViSession instrumentID VilInt32 nbrSamples ViInt32 nbrSegments LabVIEW Representation AqDx Configure Memory Settings vi Instrument ID Number of Segments 1 Number of Samples 1000 error in no error Visual Basic Representation dup Instrument ID error out ConfigMemory ByVal instrumentID As Long Visual Basic NET Representation ByVal nbrSamples As Long ByVal nbrSegments As Long As Long AcgrsD1_ configMemory ByVal instrumentID As Int32 ByVal nbrSamples As Int32 ByVal nbrSegments As Int32 As Int32 Programmer s Reference Manual Page 46 of 130 acqiris 2 3 21 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 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 th
95. ode as Long ByVal modifier As Long ByVal flags As Long As Long Visual Basic NET Representation AcqrsD1 configMode ByVal instrumentID As Int32 ByVal mode as Int32 ByVal modifier As Int32 _ ByVal flags As Int32 As Int32 Programmer s Reference Manual Page 48 of 130 acqiris 2 3 22 AcqrsD1_configMultiInput 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 L Nchan input Vilnt32 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configMultilInput ViSession instrumentID Vilnt32 channel VilInt32 input LabVIEW Representation AgDx Configure Multiplexer Input vi Instrument ID dup Instrument ID Channel 1 Input Selection 0 A error out eror in no error Visual Basic Representation ConfigMultiInput ByVal instrumentID As Long ByVal channel As Long ByVal co
96. oing 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 ONLY P1Control Vilnt32 May assume 0 not enabled For AP240 AP235 Averagers ONLY 1 addSub channel 1 2 addSub channel 2 3 addSub channel 2 4 average trigger enable 5 start veto enable 6 average out For AP240 AP235 SSR ONLY 1 Timestamp reset enable Programmer s Reference Manual Page 30 of 130 acqiris Parameter String Data Type Description 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 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 PreSamples Vilnt32 For AP240 AP235 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
97. on 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 ViStatus Refer to Table 2 1 for error codes LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getMode ViSession instrumentID VilInt32 mode Vilnt32 modifier VilInt32 flags LabVIEW Representation AgDx Query Operation Mode vi Instrument ID dup Instrument ID Mode error in no error Modifier error out 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 Programmer s Reference Manual Page 79 of 130 acqiris 2 3 41 AcqrsD1_getMultiInput 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 fo
98. on 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_ waitForEndOfProcessing ViSession instrumentID ViInt32 timeout LabVIEW Representation Not yet supported Visual 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 Programmer s Reference Manual Page 130 of 130
99. onfigChannelCombination Configure Trigger Class AcgrsD1_configTrigClass Configure Trigger Source AcqrsD1_configTrigSource Configure Trigger TV AcgrsD1_configTrigTIV Configure Memory Settings AcgrsD1_configMemory Configure External Clock AcqrsD1_configExtClock Configure Digitizer Mode AcgrsD1_configMode Configure Multiplexer Input AcgrsD1_configMultiInput Configure Control IO AcqrsD1_configControllIo Configure Frequency Counter AcqrsD1_configFCounter Configure Averager Configuration Attribute AcqrsD1_ configAvgConfig Configure program on board FPGA AcqrsD1_configLogicDevice Configure Array of Setup Parameters AcqrsD1_configSetupArray MultiInstrument Manual Define AcqrsD1_multilInstrDefine MultiInstrument Undefine AcqrsD1_multiInstrUndefineAll Acquisition Control Functions Start Acquisition AcqrsD1_ acquire Start Acquisition Extended AcgrsD1l_acquireEx Query Acquisition Status AcqrsD1_acqDone Software Trigger AcqrsD1 forceTrig Software Trigger Extended AcqrsD1 forceTrigEx Stop Acquisition AcqrsD1_stopAcquisition Wait for End of Acquisition AcqrsD1_waitForEndOfAcquisition Number of Acquired Segments AcgqrsD1l_reportNbrAcquiredSegments Data Transfer Functions Universal Waveform Read AcqrsD1_readData Accumulate Data AcqrsD1_accumulateData Averaged Data AcqrsD1_averagedData Programmer s Reference Manual Page 9 of 130 acqiris Read Frequency Counter AcqrsD1_readFCounter DEPRECA
100. or Multilnstruments ASBus operation See discussion below validatePattern Vilnt32 Currently ignored HoldType Vilnt32 Currently ignored holdValuel ViReal64 Currently ignored holdValue2 ViReal64 Currently ignored 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 Multilnstruments please refer to the Programmer s Guide section 3 13 2 Trigger Source Numbering with ASBus For configuring the TV trigger see AcqrsD1_configTrigTV Programmer s Reference Manual Page 52 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_configTrigClass ViSession instrumentID Vilnt32 trigClass VilInt32 sourcePattern VilInt32 validatePattern VilInt32 holdType ViReal64 holdValuel ViReal64 holdValue2 LabVIEW Representation AgDx 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 _
101. pose Returns the number of segments already acquired For averagers but not AP100 or AP200 it will give the number of triggers already accepted for the current acquisition 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 while an acquisition is active in order to follow the progress of a Sequence and or Averaging acquisition As needed the result should be interpreted as a ViUInt32 Can be called after an acquisition in order to obtain the number of segments triggers actually acquired until AcqrsD1_stopAcquisition was called LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 reportNbrAcquiredsSegments ViSession instrumentID ViInt32 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 Programmer s Reference Manual Page 119 of 130 2 3 64 AcqrsD1_reset
102. ps to next segment in sequence acquisition mode input Not for AP240 AP235 Signal Analyzers 21 Level Acquisition is active 22 Level Trigger is armed ready The values of qualifier and qualifier2 are not used Programmer s Reference Manual Page 36 of 130 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 qualifier 1 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 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 s
103. ption 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 Description Type 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 GateType Vilnt32 For AP240 AP235 Analyzers ONLY 0 No gates 1 User Gates 2 Threshold Gates HistoTDCEnable Vilnt32 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 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 1 and 8192 NbrWaveforms Vilnt32 Number of waveforms to average before g
104. put 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 ViAddr 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 83 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getSetupArray ViSession instrumentID ViInt32 channel Vilnt32 setupType VilInt32 nbrSetupObj ViAddr setupData VilInt32 nbrSetupObjReturned LabVIEW Representation Not yet supported Visual Basic Representation GetSetupArray ByVal instrumentID As Long ByVal channel As Long _ ByV
105. r 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 LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getMultiInput ViSession instrumentID Vilnt32 channel VilInt32 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_ getMultiInput ByVal instrumentID As Int32 ByVal channel As Int32 _ ByRef input As Int32 As Int32 Programmer s Reference Manual Page 80 of 130 acqiris 2 3 42 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 VilInt32 nbrChannels LabVIEW Representation AqDx Query Number of Channels vi Inst
106. r readMode 7 is not useable and therefore set to 0 The segment descriptor array segDesc 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 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 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 11 Sequence 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 9 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 avgStatus and avgMax will apply to Signal Averagers only The featu
107. rPos As Double sampTime As Double vGain As Double _ vOffset As Double timeStampLo As Long timeStampHi As Long As Long Programmer s Reference Manual Page 105 of 130 acqiris 2 3 58 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 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
108. res that they support have not yet been implemented The value of segmentOffset must be gt 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 Programmer s Reference Manual Page 111 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 readData ViSession instrumentID VilInt32 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 I8 116 or DBL It is meant for the readout of mul
109. 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 also 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 MultiInstrument identified with newly returned instrumentID Please refer to the Programmer s Guide section 3 2 6 Manual Definition of Multilnstruments for more information Programmer s Reference Manual Page 98 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 multiInstrDefine ViSession instrumentList Vilnt32 nbrinstruments ViSession masterID ViSession instrumentID LabView Representation AgDx Configure MultilInstrument Manual Define vi Instrument List none Multilnstrument ID Master Digitizer ID 0 error in no error error out Visual Basic Representation MultiInstrDefine ByRef instrumentList As Long ByVal nbriInstruments As Long ByVal masterID As Long instrumentID As Long As Long Visual Basic NET Representation A
110. rigLevel2 As Double As Int32 Programmer s Reference Manual Page 55 of 130 acqiris 2 3 26 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 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 56 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configTrigTV ViSession instrumentID VilInt32 channel VilInt32 standard VilInt32 field VilInt32 line LabVIEW Representation AgDx Configure Trigger TV vi channel i 1 dup Instrument ID stan Fil d error out error in no error line Visual Basic Representation ConfigTrigT
111. ror 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 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 18 of 130 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 contains either the average values calculateMean TRUE or the sample by sa
112. ror out Instr Firmware Rey numeric Instrument ID Firmware Yersion Item 4 C error in no error Visual Basic Representation GetVersion ByVal instrumentID As Long ByVal versionItem As Long version As Long As Long Visual Basic NET Representation AcqrsD1_ getVersion ByVal instrumentID As Int32 _ ByVal versionItem As Int32 ByRef version As Int32 As Int32 Programmer s Reference Manual Page 91 of 130 2 3 49 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 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 See remarks under AcqrsD1_configVertical Programmer s Reference Manual Page 92 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getVertical ViSession instrument
113. rts 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 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 Programmer s Reference Manual Page 103 of 130 acqiris with waveformArray is discussed in to the Programmer s Guide section 3 8 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
114. rument 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 AcqrsD1 getNbrChannels ByVal instrumentID As Int32 ByRef nbrChannels As Int32 As Int32 Programmer s Reference Manual Page 81 of 130 acqiris 2 3 43 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 getNbrPhysicaliInstruments ViInt32 nbriInstruments LabVIEW Representation AqDx Query Number of Instruments vi ei Number of Instruments error in no error error out Visual Basic Representation GetNbrPhysicalInstruments nbriInstruments As Long As Long Visual Basic NET Representation AcqrsD1_ getNbrPhysicalInstruments ByRef nbrInstruments As Int32 _ As Int32 Programmer s Reference Manual Page 82 of 130 2 3 44 AcqrsD1_getSetupArray acqiris Purpose Returns an array of configuration parameters Parameters In
115. s As Int32 As Int32 Programmer s Reference Manual Page 42 of 130 acqiris 2 3 18 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 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 9 Trigger Delay and Horizontal Waveform Position for a detailed discussion of the value delayTime LabWindowsCVI Visual C Representation ViStatus status AcqrsDl configHorizontal ViSession instrumentID ViReal64 sampInterval ViReal64 delayTime LabVIEW Representation AgDx 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
116. s Int32 ByVal name As String _ ByRef serialNbr As Int32 ByRef busNbr As Int32 _ ByRef slotNbr As Int32 As Int32 Programmer s Reference Manual Page 74 of 130 2 3 38 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_IsMaster Vilnt32 Physical crate number of the m th module of a multi instrument perhaps from AqGeo map m runs from 0 to nbr of modules 1 ASBus m PosInCrate Physical slot number position in cPCI crate of the m th Vilnt32 ne module of a multi instrument m runs from 0 to nbr of modules 1 ASBus m Seria
117. s status AcqrsD1_ acquireEx ViSession instrumentID Vilnt32 acquireMode VilInt32 acquireFlags Vilnt32 acquireParams VilInt32 reserved LabVIEW Representation AgDx 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 AcqrsD1 acquireEx ByVal instrumentID As Int32 ByVal acquireMode As Int32 ByVal acquireFlags As Int32 _ ByVal acquireParams As Int32 ByVal reserved As Int32 As Int32 Programmer s Reference Manual Page 17 of 130 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 timeout ViReal64 Acquisition timeout in seconds The function will return an er
118. sD1l_multilnstrDefine essseeeseeeenseesesseeeesesseesteseeeesstereseeseesteseesessesesseseesteseesesseeressesees 98 2 3 54 AcqgrsD1 m ltilnstrUndefineAll ssssseiirissrssisessriiinsiniisocrenseeriinissna serieei insisi 100 23 99 AcdisDI procDone eessen eeatt Enen ERS ETE EE EEO EE eE a STENENE EEEE EEEE RENERT Ni 101 23 96 AcdrisDl process Data sccccssis ccsscevecesscesscavssscdavs cous tosbanesiassebsa KEENE EEE EREKE EE EESE EEEa Aa 102 2 3 57 AcqrsD1_readCharSequence DEPRECATED eseseseeerereesersrreisreerrsisiersesrrrsrrerereerersrsee 103 2 3 58 AcqrsD1_readCharWform DEPRECATED ssseessseessssseessessrsresesresseeressesesrsresresresesseeee 106 2 399 AcgrsDI readData sssi sieer eesis eiss E EEE EE SKER EEEE EE 108 2 3 60 lt AcgrsD1 readF Counter seci sicreta irai seir sis Ese e ES CAE O EERTE EVE ioi K EESTE RoK 114 2 3 61 AcqrsD1_readRealSequence DEPRECATED essseessssssessesersreseesesseeresseressrsresressesesseeee 115 2 3 62 AcqrsD1_readRealWform DEPRECATED cccecceessessceseceseceseceseceecaeecaecauecseecaeenseeees 117 2 3 63 AcqrsD1_reportNbrAcquiredSegment ccccccsecsseesceesceeeceeeceseeeeceseeeaeesseesaecseecseeseeeneeees 119 PIGA ACIDI TOSS T cass co cese ds och AEE E ites EERE 120 2 3 65 AcqrsD1_resetDigitizerMemory ccccceesseesceesceeeceecesececesecseceaecaeceeecaeecaeeeaeeeneeeeeeeeees 121 2 3 66 AcqrsD1_restoreInternalRegisters cccccceccesseesseeeceesceseceece
119. scriptorAvg 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 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 numb
120. secesecaecaeceecseecaeceaeeeeeneeeneeees 122 2 3 67 AcqrsD1_ setLEDColotr cceeceecescceseesseesceeseeeneesecesceeseesccesecaecnaecsaecaaecaeecaeeeaeseneenseeerenes 124 2 3 68 AcqrsD1_setSimulationOptions 2 0 0 0 ccceccceceesseesceeeceeeceseceeceseceaecaeceaecseecseecaeeeseeeeeenseeereeas 125 2 3 69 AcqrsD1_ stopACquisition cceccccesccesecsseesseeseeeseeeeeeecesecesecesecaecaeceaecaeecaeecaeeeseeeeeensenereeas 126 23 10 AcgtsD1 stopProcessing seno E E E E I 127 2 3 71 AcqrsDl_waitForEndOfAcquisition ssessesesseeeeseeestersrereresssrstrttrrststestsrstrrretnsssrsrserereeseese 128 2 3 72 AcqrsDl_waitForEndOfProcessing esseeeseeeeseeeseesresesrsrsrserresrssssrsestetersresesesttresensrsesesee 130 Programmer s Reference Manual Page 4 of 130 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
121. sition Sends a single software trigger and generates the TrigOut hardware 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 initiating an acquisition 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
122. stSampInterval Version AcqgrsD1_getVersion Error Message AcqrsD1_ errorMessage Reset AcgrsD1_ reset Reset Digitizer Memory AcgrsD1_resetDigitizerMemory Restore Internal Registers AcgrsD1l_restoreInternalRegisters Set LED Color AcgrsD1_setLEDColor Close all instruments AcgrsD1_closeAll Programmer s Reference Manual Page 10 of 130 acqiris 2 3 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
123. t WARNING The modules discussed in this manual have not been designed for making direct measurements on the human body Users who connect an Acgqiris 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 130 acqiris 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_closeAll e AcqrsD1_init e AcqrsD1_InitWithOptions e AcqrsDl_getNbrPhysicalinstruments AcqrsD1_multilnstrAutoDefine e AcqrsD1_setSimulationOptions e AcqrsD1l_multiInstrUndefineAll The functions AcqrsD1_init AcqrsD1_InitWithOptions and AcqrsD1_multiInstrDefine 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 l
124. t 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 VilInt32 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 69 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsDl_getExtClock ViSession instrumentID VilInt32 clockType ViReal64 inputThreshold VilInt32 delayNbrSamples ViReal64 inputFrequency ViReal64 sampFrequency LabVIEW Representation AgDx Query External Clock vi ClockT ype Reference Frequency dup Instrument ID Sample Frequency Input Threshold error out Delay Number of Samples Instrument ID error in no error Visual Basic Representation GetExtClock ByVal instrumentID As Long clockType As Long inputThreshold As Double delayNbrSamples As Long inputFrequency As Double sampFrequency As Double As Long Visual Basic NET Representation AcqrsD1_ getExtClock ByVal instrumentID As I
125. t32 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 Reference Manual Page 21 of 130 acqiris Discussion 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
126. tiple segments with readMode 1 channel Instrument ID readPar segDescArray in dataArray in error in no error data4rray out dup Instrument ID amp dataDesc segDescArray out error out AqDx Read Raw Data vi This Vi is polymorphic the sample data is returned in an array of type I8 116 It is meant for the readout of a single segment with readMode 0 channel Instrument ID readPar Bs dataDesc segDesc in j segDesc out dataArray in aiai error out error in no error 3 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 3 data4rray out dup Instrument ID dataDesc segDescArray out error out Programmer s Reference Manual Page 112 of 130 acqiris Visual Basic Representation ReadData ByVal instrumentID As Long ByVal channel As Long readPar As AqReadParameters dataArray As Any dataDesc As AqDataDescriptor segDescArray As Any As Long Visual Basic NET Representation AcqrsD1 readData ByVal instrumentID As Int32 ByVal channel As Int32 ByRef readPar As AqReadParameters ByRef dataArray As DATATYPE _ ByRef dataDesc As AqDataDescriptor ByRef segDescArray As AqSegmentDescriptor As Int32 Where DATA
127. top 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_getControllO 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 AcqrsD1_configControllO instrID 1 6 O 0 0 AcqrsD1_configControllO instrID 2 19 0 0 0 In order to obtain a signal offset of 1 5 V on the Trigger Output use the call AcqrsD1_configControllO instrID 9 1500 0 0 0 Programmer s Reference Manual Page 37 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 configControllIO ViSession instrumentID VilInt32 connector VilInt32 signal Vilnt32 qualifierl ViReal64 qualifier2 LabVIEW Representation AqDx 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 AcqrsD1_ configControllIO ByVal instrumentID As Int32 ByVal connector As Int32 ByVal signal As Int32
128. ual Basic NET Representation AcgrsD1_ setSimulationOptions ByVal simOptionString As String As Int32 Programmer s Reference Manual Page 125 of 130 acqiris 2 3 69 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 AgDx 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 Programmer s Reference Manual Page 126 of 130 acqiris 2 3 70 AcqrsD1_stopProcessing Purpose Stops on bo
129. ument Undefine vi Options null ing Fe error 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 Programmer s Reference Manual Page 100 of 130 acqiris 2 3 55 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 Not yet supported Visual Basic Representation ProcDone ByVal instrumentID As Long done As Boolean As Long Visual Basic NET Representation AcqrsD1l_ procDone ByVal instrumentID As Int32 ByRef done As Boolean As Int32 Programmer s Reference Manual Page 101 of 130 acqiris 2 3 56 AcqrsD1_processData Purpose Starts on board data processing on acquired data in the current bank as soon as the current acquistion terminates It can also be used
130. us 1 OverLoadStatus 1 OverLoadStatus 2 Programmer s Reference Manual Page 76 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1 getInstrumentInfo ViSession instrumentID ViString parameterString ViAddr infoValue LabVIEW Representation AgDx Query Instrument Information vi Instrument ID Parameter String Returned Type error in no error dup Instrument ID Info value int Info value double Info value string error out 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 GetInstrumentiInfo ByVal instrumentID As Long _ ByVal parameterString As String infoValue As Any As Long Visual Basic NET Representation AcqrsD1_ getInstrumentInfo ByVal instrumentID As Int32 ByVal parameterString As String _ ByRef infoValue As Int32 As Int32 or AcqrsD1 getInstrumentInfo ByVal instrumentID As Int32 ByVal parameterString As String _ ByRef infoValue As Double As Int32 Or AcqrsD1 getInstrumentInfo ByVal instrumentID As Int32 ByVal parameterString As String _ ByVal infoValue As String As Int32 Programmer
131. used to set the Full Scale Range and the bandwidth limit of the external trigger for the DC271 FAMILY digitizers and the AP240 AP235 signal analyzer platforms For the case of a 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 13 2 Trigger Source Numbering with ASBus Programmer s Reference Manual Page 58 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l_ configVertical ViSession instrumentID Vilnt32 channel ViReal64 fullScale ViReal64 offset VilInt32 coupling Vilnt32 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 Basic 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 Programmer s Reference Manual Page 59 of 130 acqiris 2
132. ust 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 and 3 3 Device Configuration Programmer s Reference Manual Page 44 of 130 acqiris LabWindowsCVI Visual C Representation ViStatus status AcqrsD1l_ configLogicDevice ViSession instrumentID ViChar deviceName ViChar filePathName VilInt32 modifier LabVIEW Representation AqDx Configure Logic Device vi Flag PENETER ORTER i 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_ confighLogicDevice ByVal instrumentID As Int32 _ ByVal deviceName As String ByVal filePathName As String ByVal modifier As Int32 As Int32 Programmer s Reference Manual Page 45 of 130 2 3 20 AcqrsD1_configMemory acqiris 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 t
133. 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 Acqgiris product 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 13 an application that enables basic operation of Acqiris digitizers or averagers in a

Digitizers User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents