Home
ProDAQ 3416 User Manual
Contents
1. Page 18 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 2 4 3 Removing a ProDAQ Function Card If you need to remove an installed function card remove the three M3x6mm screws mounting them to the base board six M3x6mm screws for a double wide function card Remove the function card by pulling it straight and evenly upward or downward for a function card mounted on the bottom of the main PCB Do not tilt the function card when doing so as it might damage the connectors connecting it to the ProDAQ 6100 PCB Copyright 2014 Bustec Production Ltd Page 19 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual 2 4 4 Closing the ProDAQ 6100 Enclosure To close the enclosure after installing or removing a ProDAQ function card first slide back on the function card cover and attach it with a M8x6mm Torx screw to the enclosure Page 20 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Make sure that the cutouts for the function card connectors in the front bezel are properly opened or covered by filler panels to match the installed function cards Slide the front bezel back on and attach it to the enclosure by two M3x6 Torx screws Copyright 2014 Bustec Production Ltd Page 21 of 171 341
2. Error Register Access amp Default Description CLR CMD Clear Command Clear command clears errors Write 0 No effect 1 clear errors command DE Direct Error Select sources for the error line DE Write 00 DE output disabled 01 OUTRANGE_ERR asserts DE line 10 any error asserts DE line 11 Software assertion forced to active state Read Returns previously written value Reserved FIFO UNF ERR FIFO Underflow Error This bit indicates that there was an attempt to read from an empty FIFO 1 FIFO underflow error occurred FIFO_OVF ERR FIFO Overflow Error The bit when reading returns the status of the FIFO overload event occurs when trying to write to a full FIFO This bit is cleared on the clearing command Read 1 FIFO overload error occurred SCAN ERR Scan Error The bit is read only and is set by hardware after scan error happens This bit is cleared on the clearing command 1 Scan error occurred Copyright 2014 Bustec Production Ltd Page 57 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual ADCRANGE ERR ADC Clock Frequency Out of Range Error The bit is read only and is set by hardware after the frequency of the ADC signal goes out of range lower than 512kHz or higher than 5 12MHz This bit will be set after a first arming with the synchronization This bit is cleared on the clearing command and after arming with synchronization 1 ADC
3. 35 uV RMS typ 0 3 uV RMS typ 1 kHz bandwidth gain 1 1 kHz bandwidth gain 2000 Copyright 2014 Bustec Production Ltd Page 27 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Crosstalk 116 GB typ 4 2 Sampling Resolution 24 bit ADC Type Sigma Delta Output Data Rates 1 S s to 1 kS s Ax versions 1 S s to 10 kS s Bx versions 5 kS s to 52 kS s Cx versions Rate Selection Resolution 0 01 S s Oversampling 128 x FIFO 10 kSamples 4 3 Triggering Trigger Input Motherboard or Front Panel Connector Signal Type TTL Active Level Low Minimum Pulse Width 100 ns 4 4 Synchronization Clock and Sync UO Motherboard or Front Panel Connector Signal Type TTL Active Level Low Clock Input Frequency 2 MHz Reference Clock for DDS or ADC clock 4 5 Environmental Specifications Power Consumption 9 7 W max Dimensions 230 x 52 6mm Weight TBD Temperature 0 C to 50 C operational 40 C to 70 C storage only Humidity 10 90 non condensing Altitude n a Shock and Vibration n a Warm up Time 30 Min Page 28 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 5 The VXI p ug amp play Driver 5 1 Installation The ProDAQ 3416 16 Ch Sigma Delta ADC function card is supplied with a
4. User Manual ProDAQ 3416 16 Channel 24 bit Sigma Delta ADC Function Card PUBLICATION NUMBER 3416 XX UM 1010 Copyright 2014 Bustec Production Ltd Bustec Production Ltd Bustec House Shannon Business Park Shannon Co Clare Ireland Tel 353 0 61 707100 FAX 353 0 61 707106 PROPRIETARY NOTICE This document and the technical data herein disclosed are proprietary to Bustec Production Ltd and shall not without express written permission of Bustec Production Ltd be used in whole or in part to solicit quotations from a competitive source or used for manufacture by anyone other than Bustec Production Ltd The information herein has been developed at private expense and may only be used for operation and maintenance reference purposes or for purposes of engineering evaluation and incorporation into technical specifications and other documents which specify procurement of products from Bustec Production Ltd This document is subject to change without further notification Bustec Production Ltd reserves the right to change both the hardware and software described herein ProDAQ 3416 Function Card User Manual 3416 XX UM Table of Contents 1 INTRODUCTION issiscscidacidsciscddascncasunscecctsananencuaacuendaancneaansncaccssssdcenetdactendseusuensseteuonanesads 9 2 INSTALLATION swiscscscvciscsscsctencsvescectiscscecussanssaceeccdeauetcuvessueacessuveddectveascscutedrsssseessbeantes 11 21 Elle Te and Inspection EE 11
5. 2014 Bustec Production Ltd Page 99 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 27 bu3416_getITRIState viStatus bu3416 getITRIState ViSession instrumentHandle ViInt16 state ViInt16 cclkState Purpose Gets input triggers lines state Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them state Variable Type ViInt16 passed by reference This parameter returns bit OR mask with states of input trigger lines Possible mask values are bu3416 TRIG MBA 0x0001 bit0O if set MB Trigger A is active bu3416 TRIG MBB 0x0002 bitl if set MB Trigger B is active bu3416 TRIG FP1 0x0004 bit2 if set FP Trigger 1 is active bu3416 TRIG FP2 0x0008 bit3 if set FP Trigger 2 is active bu3416 TRIG FP3 0x0010 bit4 if set FP Trigger 3 is active cclkState Variable Type ViInt16 passed by reference This parameter returns a status of Commmon Clock CCLK input line Possible values bu3416 CCLK_TOGG_OMHZ bu3416 CCLK TOGG 2MHZ bu3416 CCLK_TOGG 5MHZ bu3416 CCLK_TOGG_10MHZ bu3416 CCLK_TOGG XMHZ CCLK at low level for at least 10 us CCLK toggles at 2MHz CCLK toggles at 5MHz CCLK toggles at 10MHz CCLK toggles at another frequency WG LAM OO Return Value Displays
6. 2A 2 2 2 2 CHN15CFG_ _ RW___ Channel 15 configuration register CHN16CFG_ Du Channel 16 configuration register 30 FB reserved LI FC i _ FCSUB_ DO ___ Function Card sub type register EE _ 3F8 __ FCSERH______ RO___ FC Serial Number High register FF _ 3FC___ FCSERL DO JEC Serial Number Low register __ ooo 20000 FIFO RO Access to FIFO memory _ Page 44 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM B 1 FCID 0x0 Function Card ID Register The FCID register contains function card identification number Readout should always give a value of 3416H Access amp 15 0 RO FCID Function Card ID i 0x3416 FC identification number 0x3416 for 16 channel 24 bit Delta Sigma ADC B 2 FCVER 0x1 Function Card Version Register This is the FC version register Readout from this register gives information about the PCB revision and the FPGA design revision Access amp Default Description FPGA REV FPGA Revision Number PCB REV PCB Revision Number B 3 FCCSR 0x2 Function Card Control and Status Register This is control and status register of the function card Access amp Default Description MASTER Master When the card is a Master it generates all control signals needed for the DA internally If the boards work in standalone configuration then all boards have to be set to Master If th
7. VI_SUCCESS CO connect to a ProDAQ motherboard in a VXIbus system viStatusDesc rm_session status descr printf Error bu3416 init failed due to s n descr return 1 use function card in position slot 1 status bu3416 fcSelect session 1 VI_TRUE VI_SUCCESS viStatusDesc instr session status descr printf Error bu3416 fcSelect failed due to s n descr return 1 OR connect to a 3416 in position 1 in a LXI function card carrier status bu3416 paramInit TCPIP 192 168 168 63 INSTR 1 VI_TRUE VI_TRUE amp session VI_SUCCESS viStatusDesc rm_session status descr printf Error bu3416 paramInit failed due to s n descr return 1 SE Figure 11 Opening a Session Page 34 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM For your convenience the driver contains a new function called bu3416 paramInit which combines the functionality of the bu3416_ init and bu3416_fcSelect functions by extending the argument list of the standard initialization function with a parameter specifying the function card number see Figure 11 0 For the driver functions to work properly you will either have to use the function bu3416 paramInit to open a session with the device or you will have to call the function bu3416 fcSelect after calling the function bu3416_init and before any other driver f
8. dataWrite Variable Type viChar This buffer contains the data to be written to the I2C device nRead Variable Type VilInt32 This control specifies the number of bytes to read from the I2C device This number should not exceed bu3416_PCA_COUNT MAX dataRead Variable Type viChar On successfull call this buffer will contain the data read from the I2C device The buffer should be allocated prior to the function call with appropriate size to hold all read data Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 168 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 75 bu3416_writeTEDS EEPROM ViStatus bu3416 writeTEDS EEPROM ViSession vi ViBuf buf ViUInt16 addr ViUInt16 cnt Purpose Write cnt bytes into TEDS 256 bit EEPROM starting at addr address Parameter List vi Variable Ty
9. zero bu3416 HIGH 1 active state for FP trigger 1 is high one polFPT2 Variable Type ViiInt16 This parameter specifies level of active state of Front Panel Trigger 2 Possible values are bu3416 LOW 0 active state for FP trigger 2 is low zero bu3416 HIGH 1 active state for FP trigger 2 is high one polFPT3 Variable Type VilInt16 This parameter specifies level of active state of Front Panel Trigger 3 Possible values are bu3416 LOW 0 active state for FP trigger 3 is low zero bu3416 HIGH 1 active state for FP trigger 3 is high one Page 146 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 147 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 59 bu3416_setITRIConfig viStatus bu3
10. 0x07 Variable Type ViUInt16 Number of bytes to read from TEDS ROM Valid values 0 8 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error_message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 126 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 43 bu3416_readTEDS_ROM ViStatus bu3416 readTEDS ROM ViSession instrumentHandle ViChar buf ViUInt16 cnt Purpose Function reads cnt bytes from TEDS 1 Wire ROM Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them buf Variable Type ViChar passed by reference Buffer for result cnt Variable Type ViUInt16 Number of bytes to read from TEDS 1 Wire R
11. 1 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 145 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 58 bu3416_setFPTrigPolarity viStatus bu3416 setFPTrigPolarity ViSession instrumentHandle ViInt16 polFPT1 ViInt16 polFPT2 ViInt16 polFPT3 Purpose This function sets active state levels for Front Panel Triggers Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them polFPT1 Variable Type ViiInt16 This parameter specifies level of active state of Front Panel Trigger 1 Possible values are bu3416 LOW 0 active state for FP trigger 1 is low
12. 10 20 50 100 200 500 1000 and 2000 User programmable any sampling rate in a range from 1SPS to 10kSPS e On board FIFO memory e Synchronization of multiple cards e DC master controller for an external signal conditioning unit e IEEE 1451 4 TEDS Smart Transducer Interface support Copyright 2014 Bustec Production Ltd Page 9 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual This page was intentionally left blank Page 10 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 2 Installation ProDAQ function cards can be installed in ProDAQ VXlbus Motherboards and ProDAQ LXI Function Card Carriers If you ordered your ProDAQ function card together with the ProDAQ motherboard or carrier the function cards will be pre installed to your specification If you want to install additional cards or exchange installed cards use the following disassembling assembling procedure 2 1 Unpacking and Inspection The ProDAQ instrument is shipped in an antistatic package to prevent any damage from electrostatic discharge ESD Proper ESD handling procedures must always be used when packing unpacking or installing any ProDAQ module ProDAQ plug in module or ProDAQ function card e Ground yourself via a grounding strap or similar e g by holding to a grounded object e Discharge the package by touching it to a grounded object e g a metal part of your VXlbus chassis before rem
13. 353 0 61 707106 Bustec Inc 34428 Yucaipa Blvd Yucaipa CA 92399 U S A Tel 1 909 797 0484 Fax 1 760 751 1284
14. 5 Data Acquisition The 3416 function card allows continuous digitizing of up to 16 input channels The acquired data is streamed into onboard FIFO memory As each input channel uses its own ADC all channels are sampled simultaneously The acquisition process can be started instantly by a host application or by a trigger event after prior arming the acquisition process The same applies to the end of the acquisition it can be stopped on a host request or after another trigger event Alternatively the acquisition may end after collecting a programmed number of samples A single measurement is possible for externally triggered measurements in such configuration a trigger event requests a measurement of all enabled input channels on one or more cards A DA data acquisition trigger event can start the acquisition and a following trigger event can stop the acquisition Acquisition start amp stop by a trigger event rising edge SCAN1 SCAN2 SCAN3 SCAN4 SCANS TRG fi Ek ch Fi START i stop START 1 stop ACQUISITION SAMPLE CH1 SAMPLE CH2 Note after stopping an acquisition a current scan will finish Note the active trigger edge on the above picture is a rising edge it can be configured according to an application needs Alternatively the DA trigger can act as a gate and the acquisition can take place as long as the DA trigger is active Acquisition gated
15. Cards used for Multiple Card Initialization The array must contain the number of elements corresponding to the number of Function Cards initialized in the Group Each element in this array is a bitmask of 16 channels bit 0 corresponds to the Channel 1 bit 15 corresponds to the Channel 16 Page 112 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 1 written in the appropriate bit means that the channel will be included in the data acquisition sampleRateHz Variable Type ViReal64 This parameter specifies the sample rate in Hertz for data acquisition process Possible values are from 1 0 1Hz to 10000 0 10kHz startMode Variable Type ViInt16 This Parameter specifies the Start Mode of Data Acquisition Possible values are bu3416 DA_START_IMM 0 Data Acquisition starts immediately after synchronization is done Default bu3416 DA START TRIG 1 Data Acquisition starts when Input Trigger goes active scansToCollect Variable Type VilInt32 This parameter specifies total number of scans to collect by data acquisition including pre triggered scans If this parameter contains 0 the data acquisition will run in unlimited continuous mode If the trigger is enabled then the number of scans should not be less than the number of pre triggered scans BPTrigClock Variable Type ViiInt16 This control allows to select the VXI Backplane TTL Trigger line if one should be used for Mul
16. FP trigger 2 is high one polFPT3 Variable Type ViInt16 passed by reference This parameter returns level of active state of Front Panel Trigger 3 Possible values are bu3416 LOW 0 active state for FP trigger 3 is low zero bu3416 HIGH 1 active state for FP trigger 3 is high one Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error Copyright 2014 Bustec Production Ltd Page 97 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 98 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 26 bu3416_getITRIConfig viStatus bu3416 getITRIConfig ViSession instrumentHandle ViInt16 daTrigSource ViInt16 syncSource Purpose This function returns the configuration of the Input Trigger Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify t
17. Function Tree Layout ProDAQ 3416 16 ch 24 bit Sigma Delta ADC Initialization bu3416_ init Select Function Card bu3416_fcSelect Initialization with Parameters bu3416_paramInit Hardware Configuration Single Card Acquisition Single shot Acquisition Continuous Acquisition Multi Card Acquisition Low Level Access Utility Functions Get Serial Number bu3416_getSerNum Reset bu3416_ reset Self Test bu3416_self_test Error Query bu3416_error_query Error Message bu3416_error_message Revision Query bu3416_revision_query Close bu3416_close Figure 10 VXI plug amp play Driver Organization The section Hardware Configuration contains high level functions to configure the card e g gain settings The different sections Single Card Acquisition with the sub sections for Single shot Acquisition and Continuous Acquisition and Multi Card Acquisition contain functions or sets of functions to quickly program the card for different acquisition tasks The functions from the different sections should be used together per section and not be mixed Copyright 2014 Bustec Production Ltd Page 33 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual The section Low level Access contains functions that directly change settings on a register level and are used by the higher level functions to implement their functionality Using them directly in combination with the higher level functions might interfere with the functionality implemented
18. Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit functionCardIndex Variable Type ViiInt16 Specifies the index of the Function Card in the Group for which the Instrument Handle is required FCInstrumentHandle Variable Type ViSession passed by reference Returns the Instrument Handle for individual Function Card included into the Group This Handle can be used to customize some Function Card settings individually using Instrument Driver Functions not included into the Multi Card Acquisition sub class However those function should be used carefully as they can change Function Card settings important for synchronous operation mode Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of t
19. ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 47 bu3416_resetl2C viStatus bu3416 resetI2C ViSession instrumentHandle Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 131 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 48 bu3416_resizeMultBuf viStatus bu3416 resizeMultBuf ViSession instrumentHandle ViInt32 newSize Purpose This function re allocates new buffer in 3150 Motherboard on board DRAM memory for each Function Card in the Group Parameter List instrumentHandle Variable Ty
20. Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 141 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 55 bu3416_setDAQMode viStatus bu3416 setDAQMode ViSession instrumentHandle ViInt16 boardMode ViInt16 startMode ViInt16 stopMode ViInt16 stopOnError Purpose This function sets the Data Acquisition operational mode Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them boardMode Variable Type ViInt16 This parameter specifies the Function Card operational mode Possible values are bu3416_FC_STALONE 0 The Board operates in a Stand Alone mode Defaul
21. UM samples Variable Type VilInt32 This parameter sets the number of samples to collect waveform Variable Type ViReal64 The output buffer containing the samples from the specified channel This buffer should be allocated by application before the function call with appropriate size to hold all data Values of the waveform are expressed in Volts errors Variable Type ViInt16 passed by reference This parameter contains information about any error happened during Data Acquisition process The value is a bitmask of the following values bu3416 DA_OUTRANGE ERR 0x0001 Cumulative Out Of Range error bu3416 DA _DECIM ERR 0x0002 Decimation error bu3416 DA _ARITH ERR 0x0004 Arithmetic error bu3416 DA _DDSUD_ERR 0x0008 DDS Update Signal error bu3416 DA MCLK_ ERR 0x0010 MCLK Clock Frequency error bu3416 DA_SCAN_ERR 0x0020 Scan Error bu3416 DA FIFO OV_ERR 0x0040 FIFO Overflow error bu3416 DA FIFO Up ERR 0x0080 FIFO Underflow error NOTE For error bu3416 DA OUTRANGE ERR please use function bu3416 getDAQStatus to get more details about error happened on channel Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of th
22. UM ProDAQ 3416 Function Card User Manual C 5 37 bu3416_paramlinit viStatus bu3416 paramInit ViRsrc instrumentDescriptor ViInt16 functionCard ViBoolean IDQuery ViBoolean resetDevice ViSession instrumentHandle Purpose Initializes the specified Function Card on the specified ProDAQ module and returns an instrument handle The instrument handle must be used with all of the other functions of this driver The Initialize With Parameters call allows the VXI module to be queried to ensure that it is a Bustec Data Acquisition System and the selected Function Card is one of the appropriate type bu3416 Function Card It also resets the Module to the power up state if the Reset parameter is True ON Parameter List instrumentDescriptor Variable Type ViRsrc Specifies which remote instrument to establish a communication session with Based on the syntax of the Instr Descriptor the Initialize function configures the I O interface and generates an Instr Handle functionCard Variable Type ViInt16 The function card to which the instrument handler will be bound IDQuery Variable Type ViBoolean Specifies if an ID Query is sent to the instrument during the initialization procedure Valid Range 1 Yes 0 No Default Value Yes NOTE Under normal circumstances the ID Query ensures that the instrument initialized over the bus is the type supported by this driver However circumstances may arise where it is undesirable to send an
23. VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 151 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 61 bu3416_setMultTrigConfig viStatus bu3416 setMultTrigConfig ViSession instrumentHandle ViInt16 source Purpose This function configures the Trigger for Data Acquisition Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit source Variable Type ViInt16 This parameter specifies the source for the Data Acquisition DA Trigger signal The Trigger can be applied only to the Master Function Card All Slave Function Cards will be triggered by Master Function Card Possible values are bu3416_DA_TRIG_OFF 0x0000 bu3416_DA TRIG MBA 0x0001 bu3416_DA_TRIG_MBB 0x0002 bu3416_DA TRIG FP3 0x0004 bu3416 DA TRIG FP3 LOW 0x0008 use this setting with bu3
24. VXIplug amp play driver To install the driver run the Setup exe application coming with it and follow the instructions presented Make sure that no other ProDAQ software is running when you start the setup The installation program will by default perform a complete installation It will install the driver files in the directory tree defined by the VXIPNPPATH environment variable and shortcuts into the VXIPNP program group of the start menu To choose a different path and or custom installation options is not recommended and may result in malfunctioning of the soft front panel and any application trying to use the driver 5 2 The Soft Front Panel The purpose of soft front panel application is to demonstrate the instrument s abilities After the start of the soft front panel application the user has the choice to either enter the address information VISA resource specification and function card number of the function card the soft front panel application shall connect to or use the build in auto find functionality to discover accessible ProDAQ 3416 function cards ADVANCED VXI DATA ACQUISITION SYSTEMS Hl ProDAQ 3416 SFP Select Functionmue 4 d How to connect to 3416 function card Auto Find Enter Address Cancel ProDAQ 3416 16 Channel 24 bit Sigma Delta ADC Function Card VXiplug amp play Driver Copyright 1996 2010 Bustec Production Ltd Figure 5 Selecting the Connection Method Please note tha
25. Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 136 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 52 bu3416_setADCMode ViStatus bu3416 setADCMode ViSession instrumentHandle ViInt16 ADCClockSource ViInt16 PLLClockSource ViInt16 decimation Purpose This function sets the ADC operational mode Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them ADCClockSource Variable Type ViInt16 This parameter specifies the source for the ADC Clock Possible values are bu3416_ADC_CLK_DDS 0 Clock from DDS Default bu3416 ADC CLK _CCLK 1 Clock from CCLK Commo
26. Writing to FIFO is allowed in IDLE_ST only Two writes to FIFO_WR register a first is 16 bit a second uses only lower 8 bits of data cause one 24bit word stored in the onboard FIFO memory which can be later read out using FIFO register Access amp a o Default 15 0 wo FIFO DATA FIFO Data Input i Writes a word to a FIFO memory for test purposes B 18 SIG_ERR 0x13 Signal Error Register This is signal out of range error register Access amp Default Description SIG_ERR Signal Out of Range Error Indicates that signal out of range condition detected on bit number 1 channel 1 signal out of range 0 signal in range Page 56 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM B 19 GAIN _COMP 0x14 Gain Compensation Register This is the gain compensation register Access amp Default Description GAIN COMP 15 0 Gain compensation coefficient lower part Write Allows overwriting the GAIN _COMP_COEFF loaded automatically from EEPROM Value 0x0 written to this register disables the frequency dependant gain compensation mechanism Read Returns lower 16 bits of a gain compensation coefficient upper 8 bits have a value of 0x7F or 0x80 if read value is 0x0000 The coefficient is sampling clock dependant and is scaled automatically with the actual ADC clock frequency according to programmed in EEPROM value B 20 ERROR 0x15
27. XX UM ProDAQ 6100 User Manual 6100 XX UM El ee Bd Glossary ADC CRD DA DAC DDS DTC ECL FIR FPGA H ICP LED LVDS LXI PCB PGA PLL RO R W R WSC TEDS VREF Va WO Analog to Digital Converter Current Regulator Diode Data Acquisition Digital to Analog Converter Direct Digital Synthesis Discharge Time Constant Emitter Coupled Logic Finite Impulse Response digital filter Field Programmable Gate Array State of the bit s defined by hardware in register description Integrated Circuit Piezoelectric Light Emitting Diode Low Voltage Differential Signal ing LAN eXtensions for Instrumentation Printed Circuit Board Programmable Gain Amplifier Phase Locked Loop Read only access to register Read Write access to register Read Write access to register Self Clear after operation finished Transducer Electronic Data Sheet Voltage Reference VME eXtensions for Instrumentation Write only access to register Page 8 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 1 Introduction The ProDAQ 3416 function card is a 16 channel 24 bit Sigma Delta Analog to Digital converter function card It is an add on card to use together with ProDAQ motherboards and function card carriers It provides the following features 16 analog channels with 24 bit resolution Simultaneous sampling Max Input Range 10V with overvoltage protection Programmable gains of 1 2 5
28. be received from either the ProDAQ function card bus bu3416_DA_TRIG MBA and bu3416 DA TRIG MBB or the front panel connector signal FP_TRG_IO_3 see 0 If the front panel connector input is used the trigger used can be low or high active bu3416 DA _TRIG FP3 LOW Or bu3416 DA TRIG FP3 The type of the parameter is integer and might be specified again either directly as a value or by using the predefined macros from the include file bu3416 h The driver help file bu3476 hip lists also both forms Please note that the usage of the function card bus trigger lines will require you to configure their routing in the ProDAQ motherboard or function card carrier in addition 6 4 Single Card Acquisition 6 4 1 Single shot Acquisition To acquire a consecutive number of samples from a single channel or several channels the functions bu3416_acquireWaveform see Figure 12 and bu3416 acquireWaveforms see Figure 12 can be used These functions implement the complete functionality of configuring the card starting the acquisition waiting for the end of the acquisition and transferring the data back to your application Copyright 2014 Bustec Production Ltd Page 35 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual The functions take either a channel number or a channel mask as an argument to specify which channel or group of channels to acquire data from In addition the sample rate in samples sec channel a number of samples
29. between 0xBFFC0900 and OxBFFCOFFF Page 138 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 53 bu3416_setBufferSize viStatus bu3416 setBufferSize ViSession instrumentHandle ViInt32 newSize Purpose This function re allocates new buffer in ProDAQ Motherboard on board DRAM memory Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them newSize Variable Type VilInt32 Specifies the new size of the DRAM buffer allocated for the Function Card Default size of the DRAM buffer depends on the type of the Function Card Carrier Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2
30. by reference This Parameter returns the Stop Mode of Data Acquisition Possible values are bu3416 DA_STOP_COUNT 0 Data Acquisition stops when the specified number of samples has been collected Default bu3416 DA _STOP_TRIG 1 Data Acquisition stops when Input Trigger Stop Event happened bu3416 DA _STOP_GATE 2 DA stops when Trigger goes inactive bu3416 DA_STOP_UNLIM 3 Data Acquisition stops only when DAQ STOP command issued Page 90 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM stopOnError Variable Type ViInt16 passed by reference This parameter returns what kind of error will break data acquisition DA Possible values are bu3416 DA_STOP_ERR_OFF 0 Errors don t stop DA bu3416 DA _STOP_ERR_EXOFR 1 Any error excluding OUTRANGE stops DA bu3416 DA_STOP_ERR_ ANY 2 Any error stop DA Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers
31. channel The channel should be configured using the bu3416_setChanConfig function prior to this function call For the triggered waveform acquisition the trigger must be configured using bu3416 setTrigConfig function prior to this function call Parameter List instrumentHandle Variable Type vViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them channel Variable Type ViInt16 This parameter specifies from which channel the waveform will be acquired Possible values are bu3416_CHAN 1 bu3416_ CHAN 2 bu3416 CHAN 3 bu3416 CHAN 4 bu3416_CHAN_5 bu3416 CHAN 6 bu3416_CHAN 7 bu3416_CHAN 8 bu3416_CHAN 9 bu3416 CHAN 10 bu3416 CHAN 11 bu3416 CHAN 12 bu3416_ CHAN 13 bu3416 CHAN 14 bu3416_ CHAN 15 bu3416_ CHAN 16 sampleRateHz Variable Type 1 Channel 2 Channel 3 Channel 4 Channel 5 Channel 6 Channel 7 Channel 8 Channel 9 Channel 10 Channel 11 Channel 12 Channel 13 Channel 14 Channel 15 Channel 16 Channel ViReal6 4 OD JO DG OM PRPPRPHPHPR OuUBWNHHO This parameter specifies the sample rate in Hertz for data Possible values are from 1 0 1Hz to 10000 0 acquisition process 10KHz Page 64 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX
32. data acquisition All selected channels must be configured using bu3416_setChanConfig function prior to this function call scanRateHz Variable Type ViReal64 This parameter specifies the sample rate in Hertz for data acquisition process Possible values are from 1 0 1Hz to 10000 0 10kHz scans Variable Type ViInt32 This parameter sets the number of scans to collect fillMode Variable Type ViInt16 The parameter specifies whether the Waveform array will be grouped by channels or grouped by scans Page 66 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Possible values are bu3416 GROUP_BY CHANNEL 0 Group data by channel bu3416 GROUP_BY SCAN 1 Group data by scans For example If you scan channels A through C and Number of Scans is 5 then the possible fill modes are Grouped by channel Al A2 A3 A4 A5 B1 B2 B3 B4 B5 C1 C2 C3 C4 C5 or Grouped by scan Al B1 Cl A2 B2 C2 A3 B3 C3 A4 B4 C4 Ab B5 C5 Vol Woll el el kel If you are to pass the array to a graph you should acquire the data grouped by channel If you are to pass the array to a strip chart you should acquire the data grouped by scan waveforms Variable Type ViReal64 The output buffer containing the samples in Volts from the specified channels This buffer should be allocated by application before the function call with appropriate size to hold all data Samples in this buffer are arranged a
33. disabled bu3416 MBA FPOT1 1 MB Trigger input A is routed to FPOT1 bu3416 CCLK_FPOT1 2 Common Clock CCLK is routed to FPOT1 bu3416 RCLK_FPOT1 3 Ref clock 2MHz is routed to FPOT1 bu3416 ADCC_FPOT1 4 ADC clock is routed to FPOT1 bu3416 DA_ST FPOT1 6 DA progress signal is routed to FPOT1 bu3416 SWA_FPOT1 7 Software assertion mode sourceFPOT2 Variable Type ViInt16 passed by reference This parameter returns what source is chosen for Front Panel Output Trigger 2 FPOT2 Possible values are bu3416 OFF 0 Output disabled bu3416 MBB FPOT2 1 MB Trigger input B is routed to FPOT2 bu3416 SYNC_FPOT2 2 SYNC is routed to FPOT2 bu3416 OUTRANGE FPOT2 5 Out of range signal is routed to FPOT2 bu3416 SCANP_ FPOT2 6 Pulse per Scan sig is routed to FPOT2 bu3416 SWA_FPOT2 7 Software assertion mode sourceFPOT3 Variable Type ViInt16 passed by reference This parameter returns what source is chosen for Front Panel Output Trigger 3 FPOT3 Possible values are bu3416 OFF 0 Output disabled bu3416 MBA FPOT3 1 MB Trigger input A is routed to FPOT3 bu3416 MBB FPOT3 2 MB Trigger input B is routed to FPOT3 bu3416 SWA_FPOT3 7 Software assertion mode sourceDE Variable Type ViInt16 passed by reference This parameter returns what source will be chosen for Direct Error DE Possible values are bu3416 OFF 0 Output disabled bu3416 OUTRANGE DE 1 Out of range signal is routed to DE bu3416 ANY DE 2 Any error asserts DE line
34. document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Copyright 2014 Bustec Production Ltd Page 139 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 54 bu3416_setChanConfig viStatus bu3416 setChanConfig ViSession instrumentHandle ViInt16 channel ViInt16 source ViInt16 gain Purpose This function configures the specified channel or all 16 channels Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them channel Variable Type ViInt16 This parameter specifies which ch
35. it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error_message will return a string describing the error Page 148 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 149 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 60 bu3416_setMultChanConfig viStatus bu3416 setMultChanConfig ViSession instrumentHandle ViInt16 channel ViInt16 source ViInt16 gain Purpose This function configures the specified channel or all channels for the Function Card Group Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit channel Variabl
36. of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 143 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 56 bu3416_setDDSFreq ViStatus bu3416 setDDSFreq ViSession instrumentHandle ViReal64 frequencyHz Purpose This function sets the frequency in Hz of the DDS generator Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them frequencyHz Variable Type ViReal64 This parameter specifies the frequency in Hz of the DDS generator Possible values are 512000 0 5120000 0 512kHz 5 12MHz Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing
37. of the same model type is used this Handle will be used to differentiate between them channelMask Variable Type VilInt16 Selects the channels from which the data will be taken bit 0 corresponds to the Channel 1 bit 15 corresponds to the Channel 16 1 written in the appropriate bit means that the channel will be included in the data acquisition sampleRateHz Variable Type ViReal64 This parameter specifies the sample rate in Hertz for data acquisition process Possible values are from 1 0 1Hz to 10000 0 10kHz scansToCollect Variable Type ViInt32 This parameter specifies total number of scans to collect by data acquisition If this parameter contains 0 the data acquisition will run in unlimited continuous mode startMode Variable Type ViInt16 This Parameter specifies the Start Mode of Data Acquisition Possible values are bu3416 DA START_IMM 0 Data Acquisition starts immediately after synchronization is done Default bu3416 DA START TRIG 1 Data Acquisition starts when Input Trigger goes active Copyright 2014 Bustec Production Ltd Page 135 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual stopOnError Variable Type ViInt16 This parameter specifies what kind of error will break data acquisition DA Possible values are bu3416 DA_STOP_ERR_OFF 0 Errors don t stop DA bu3416 DA _STOP_ERR_EXOFR 1 Any error excluding OUTRANGE stops DA bu3416 DA_STOP_ERR_ANY 2 Any error stop DA Return
38. or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them scans Variable Type VilInt32 passed by reference This parameter returns the configured post trigger number of scans to collect Possible values are from 0 to Oxffffff Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Page 106 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 31 bu3416_getSampFreq ViStatus bu3416 getSampFreq ViSession instrumentHandle ViReal64 frequencyHz Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used
39. status bit that indicates when the current state of the trigger line Read 0 trigger not active 1 trigger active asserted TRIGI B MB Trigger Input B This is a status bit that indicates when the current state of the trigger line Read 0 trigger not active 1 trigger active asserted TRIGI A MB Trigger Input A This is a status bit that indicates when the current state of the trigger line Read 0 trigger not active Copyright 2014 Bustec Production Ltd Page 51 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual B 8 DDS WX 0x8 DDS Control Register This is DDS control register It is used to set up words written to DDS during DDS update phase if DDS is to be used Access amp Default Description Reserved WX_ADDR Word X Address The address of the word WX_ADDR is in the range from 0 to 12 DDS WX DDS Word X The content of the DDS word to be stored B 9 OCOEFL 0x9 Offset Coefficient Write Low Register OCOEFL register together with OCOEFH register can be used to overwrite offset coefficients loaded during card initialisation from EEPROM Access amp Description Default i GCOEFL Offset coefficient bits 15 0 15 0 WO Write Stores bits 15 0 of the offset coefficient in an internal temporary register B 10 OCOEFH 0xA Offset Coefficient Write High Register OCOEFH register together with OCOEFL register ca
40. the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 68 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 3 bu3416_armDAQ ViStatus bu3416 armDAQ ViSession instrumentHandle ViInt16 syncNeed Purpose This function issues the arming command which launches the Data Acquisition process Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them syncNeed Variable Type VilInt16 This parameter specifies whether DAQ Arming process will go through the Synchronization procedure or not Possible values are bu3416 OFF 0 Synchronization procedure will not be performed bu3416 ON 1 Synchronization procedure will be performed bu3416 SYNC_IF NEED 2 Synchronization procedure will be performed only if necessary i e if the function card was reconfigured before so it must be re synchronized Default Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4
41. the error code into the function bu3416_error_message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 144 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 57 bu3416_setFlFOConfig viStatus bu3416 setFIFOConfig ViSession instrumentHandle ViInt16 affThreshold Purpose This function sets FIFO configuration Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them affThreshold Variable Type ViInt16 This parameter specifies the threshold level for Programmable Almost Full Flag PAFF Possible values are 2 to FIFO_SIZE 1 where FIFO SIZE is 8192 or 16384 depending on card version NOTE The following table shows configuration for FIFO flags Number of samples in FIFO Empty Almost Full Full 0 1 0 0 1 to aftThreshold 1 0 0 0 aftThreshold to FIFO SIZE 1 0 1 0 FIFO_ SIZE 0 0
42. their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO0900 to OxBFFCOFFF They are defined in the include file bu3416 h Copyright 2014 Bustec Production Ltd Page 87 of 171 3416 XX UM C 5 19 bu3416_getCalibData ProDAQ 3416 Function Card User Manual viStatus bu3416 getCalibData ViSession instrumentHandle ViInt16 channel ViUInt32 Purpose offset ViUInt32 gain This function retrieves the calibration data from on board EEPROM Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them channel Variable Type ViInt16 This parameter specifies for which be acquired Possible val
43. to specify the consecutive number of samples that will be acquired per channel and an output array used to store the waveform s ViSession session VilInt1l6 mask ViReal64 waveform 10240 PPR ae RY configuring all channels for gain 10 front panel connector input status bu3416_ setChanConf session bu3416 CHAN ALL bu3416 GAIN _10 bu3416 CH_FP lt VI_SUCCESS bu3416_error_ message rm_session status descr printf Error bu3416 acquireWaveform failed due to s n descr return 1 acquire a waveform of 1024 samples from channel 3 at 1 kSa s status bu3416 acquireWaveform session 3 1000 0 1024 waveform lt VI_SUCCESS bu3416 error message rm_session status descr printf Error bu3416 acquireWaveform failed due to San descr return 1 acquire waveforms from channels 1 8 12 and 13 mask 0x18FF if status bu3416 acquireWaveforms session mask 1000 0 1024 bu3416 GROUP_BY CHANNEL waveform VI_SUCCESS bu3416 error message rm_session status descr printf Error bu3416 acquireWaveforms failed due to s n descr return 1 ey RY Figure 12 Acquiring a Waveform The function bu3416_acquireWaveforms has an additional argument specifying the arrangement of the data in the output array The function card is storing the data interleaved in the on board FIFO So the arrangement of the data as read from the on board FIFO is
44. version register 2 08 FCCSR_ SS RW_ Function card Control and Status register 3 oc MODE JRW TI Ef 4 ho _ MODE2 JRW fE 6e 18 ITRI RW _ Inputtrigger control register z JIG reseve J f Offset coefficient register lower part 28 OCOEFH RW Offset coefficient register upper part 2C GCOEFL RW Gain coefficient register lower part GCOEFH RW Gain coefficient register upper part 30 34 reserved 38 l2C_CTRL RW 12C control register F 10 11 12 S 13 SIG ER DO Signal error register _ RE E ME Teas i Masar eech 1A _f68_ POSTT_NOSH__ RW___ Number of samples for DA upper part ABAR Messa N E 20 J80 CHN1CFG_ __ RWw___ Channel 1 configuration register 24 J90 CHNSCFG __ RW___ Channel 5 configuration register 26 JI CHN7CFG_ DW Channel 7 configuration register Copyright 2014 Bustec Production Ltd Page 43 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual FC VX ADDR ADDR 28 CH 9 Register Name Access Function AO CHN9CFG_ RW_ Channel 9 configuration regele A4 CHN1OCFG_ _ RW___ Channel 10 configuration register A8 CHN11CFG__ RW___ Channel 11 configuration register GR LAG ICHN12CFG_ RW___ Channel 12 configuration register 2C BO CHN13CFG_ DW Channel 13 configuration register GD B4 CHN14CFG_ DW TChennel 14 configuration register GE B8 R iguration regi GE Jon iguration regi Weg ES ty 28 2
45. will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 91 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 21 bu3416_getDAQStatus viStatus bu3416 getDAQStatus ViSession instrumentHandle ViInt1l6 state VilInt16 errors ViInt32 chErrors Purpose This function returns status of the Data Acquisition process Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them state Variable Type ViInt16 passed by reference This parameter returns the DAQ State Machine state Possible values are bu3416 SM IDLE 0 DAQ in IDLE state All needed settings FE config Clock and Trigger Config etc must be done in this state bu3416 SM DDSUD 1 DAQ in DDS UPDATE state In this state the card performs the update of the DDS settings bu3416 SM SYNC 2 DAQ in SYNC state After DDS UPDATE the card performs reset and re synchronization of ADCs and FIR filters This stage takes approximately 1 second bu3416 SM READY 3 DAQ in READY state The synchronization is done and card is ready to start DAQ bu3416 SM POST 5 DAQ in POST TRIGGER state Post trigger samples are stored in FIFO as long as the End Event of DAQ is not happened bu3416 SM END 6 DAQ proces
46. 0 of the post trigger number of scans to collect B 22 POSTT_NOSH 0x1A Post Trigger Number of Scans High Register The POSTT_NOSL H registers define the number of scans to be acquired during DA if the mode with number of scans has been selected DA_STOPSEL 00 The number of post trigger scans is in the range from 0 to 16777215 0 means unlimited number of scans Access amp Reserved POSTT NOS Post Trigger Number Of Scans Upper 8 bits POSTT_NOS 23 16 of the post trigger number of scans to collect Page 58 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM B 23 CHNxCFG 0x20 0x2F Channel x Configuration Register These are the registers used to configure the settings for all channels Access amp Default Description Reserved GAIN2 SEL Gain of the Second Stage Selection These bits select the second PGA gain of the analog front end 00 x1 gain 01 x2 gain 10 x5 gain 11 x10 gain GAIN1 SEL Gain of the First Stage Selection These bits select the first PGA gain of the analog front end 00 x1 gain 01 x10 gain 10 x100 gain 11 x1000 gain VREF EN VREF Input Enabled This bit connects the channel to the voltage reference option fitted on the MB 0 channel input switched to the FP input connector 1 channel input switched to VREF voltage CHN EN Channel Enable This bit is used to include the channel in the DA 0 chan
47. 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 69 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 4 bu3416_burnTEDS_OTP_ROM ViStatus bu3416 burnTEDS OTP_ROM ViSession instrumentHandle ViBuf buf Purpose ViBoolean burn Burns TEDS 64 bit OTP ROM if not programmed yet ATTENTION This memory can be programmed only once OTP Please make sure that data is correct and byte s order is right Parameter List instrumentHandle buf Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Variable Type ViBuf Buffer with bytes to write NOTE size of this buffer must be 8 bytes 64 bits Function will copy bytes in following order buf 0 into ROM address 0x00 buf 1 into ROM address 0x01 buf 2 into ROM address 0x02 buf 3 into ROM address 0x03 buf 4 into ROM address 0x04 buf 5 into ROM address 0x05 buf 6 into ROM address 0x06 buf 7 into ROM address 0x07 burn Variable Type ViBool
48. 278 clock divider line set to 1 default Read Returns previously written value ADC MODE ADS1278 ADC mode selection Write 00 High speed mode 01 High resolution mode default 10 Low Power mode 11 Low Speed mode Read Returns previously written value Reserved DECIM SEL Decimation Stage Selection These bits select the decimation factor of the chain of FIR filters 00 decimation switched off 01 decimation by 10 selected 10 decimation by 100 selected 11 decimation by 1000 selected ADC CLK SEL Clock Selection These bits select the source of the clock signal for the A D converters Write 00 clock from on board DDS selected 01 common clock input from the MB CCLk 10 MB input trigger A MB_TRIGI_A 11 FP input Trigger FP_TRG1 Read Returns previously written value PLL EN PLL Enable This bit enables disables on board PLL PLL must be enabled if onboard DDS is engaged 0 PLL disabled 1 PLL enabled PLL RSEL PLL Reference Clock Selection These bits select the source of the PLL reference clock Write 00 local oscillator 40MHz divided down to 2MHz 01 common clock input from the MB CCLk 10 MB input trigger A MB_TRIGI_A 11 FP input Trigger FP_TRG1 Page 48 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM B 6 OTRI 0x5 Output Trigger Configuration Register This r
49. 3 Cover Hooks Figure 1 Removing the ProDAQ module cover To remove the top cover remove the one countersunk screw in the back and the two panhead screws towards the front panel that hold the cover in place Remove the cover by sliding it out of its position towards the VXlbus connectors and up Take special care about the hooks OG holding it in place Try not to lift the cover straight up See Figure 1 for the location of the screws To re install the cover slide it back into its position by placing the small hooks over their holes and moving the cover down and forward Secure the top cover using two panhead screws and one countersunk screw Page 12 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 2 3 2 Installing a ProDAQ Function Card The single width ProDAQ function cards are arranged inside the ProDAQ module in four stacks of two cards each The double width ProDAQ function cards are arranged inside the ProDAQ module in two stacks of two cards each The function cards are mounted face down e g the front panel connectors as well as the motherboard connectors are underneath the PCB Single width and double width ProDAQ function cards can be mixed in the ProDAQ module The ProDAQ 3416 function card is a single width card To install a single width ProDAQ function card in any of the possible positions use the following procedure See Figure 2 for reference e Re
50. 416 DA TRIG FP3 to set trigger active state to low Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 152 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 62 bu3416_setOTRIConfig ViStatus bu3416 setOTRIConfig ViSession instrumentHandle ViInt16 sourceMBA ViInt16 sourceMBB ViInt16 sourceFPOT1 ViInt16 sourceFPOT2 ViInt16 sourceFPOT3 ViInt16 sourceDE ViInt16 sourceDI Purpose This function configures the Output Trigger Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them sourceMBA Variable Type ViiInt16 This parameter specifies what source will b
51. 416 Function Card User Manual Calibration Functions Calibrate All Channels Store Calibration Data Get Calibration Data LIST Processor Support Set Buffer Size Get Buffer Size Enable LIST TEDS Read 1 Wire ROM Burn 64 bit OTP ROM Read 64 bit OTP ROM Write 256 Bit EEPROM Read 256 Bit EEPROM I2C Communicate with I2C device Reset I2C Controller JTAG Generate Sequence Get Status Utility Functions Get Serial Number Reset Self Test Error Query Error Message Revision Query Close 3416 XX UM bu3416_calibrateAllChannels bu3416_storeCalibData bu3416_getCalibData bu3416_setBufferSize bu3416_getBufferSize bu3416_enableLIST bu3416_readTEDS_ROM bu3416_burnTEDS_OTP_ROM bu3416_readTEDS_OTP_ROM bu3416 writeTEDS EEPROM bu3416 readTEDS EEPROM bu3416 writeReadI2C bu3416 resetI2C bu3416 JTAG generateSeq bu3416 JTAG getStatus bu3416 getSerNum bu3416 reset bu3416 self _test bu3416 error query bu3416 error message bu3416 revision query bu3416 close Copyright 2014 Bustec Production Ltd Page 63 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 VXIplug amp play Driver Function Details The following functions are in alphabetical order C 5 1 bu3416_acquireWaveform ViStatus bu3416 acquireWaveform ViSession instrumentHandle ViInt16 channel ViReal64 sampleRateHz ViInt32 samples ViReal64 waveform ViInt16 errors Purpose This function acquires the waveform from the specified
52. 416 SM READY 3 bu3416 SM POST 5 bu3416 SM END 6 error Variable Type This parameter cont Data Acquisition pr values quisition ViSession instrumentHandle ViInt16 acquisitionState ViInt16 error ViInt32 scanBacklog e last or current Data Acquisition vViSession le is used to identify the unique session or el between the driver and the instrument strument of the same model type is used this to differentiate between them ViInt16 passed by reference of the Data Acquisition process Possible values DAQ in IDLE state All needed settings FE config Clock and Trigger Config etc must be done in this state DAQ in DDS UPDATE state In this state the card performs the update of the DDS settings DAQ in SYNC state After DDS UPDATE the card performs reset and re synchronization of ADCs and FIR filters This stage takes approximately 1 second DAQ in READY state The synchronization is done and card is ready to start DAQ DAQ in POST TRIGGER state Post trigger samples are stored in FIFO as long as the End Event of DAQ is not happened DAQ process terminated successfully ViInt16 passed by reference ains information about any error happened during ocess The value is a bitmask of the following bu3416 DA_OUTRANGE ERR 0x0001 Cumulative Out Of Range error bu3416 DA _DECIM ERR bu3416 DA ARITH ERR bu3416 DA _DDSUD_ERR bu3416 DA _MCLK_ERR bu3416_DA_SCAN ERR 0x0002 Decimation error 0x0004
53. 416 paramInit acquisitionState Variable Type ViInt16 passed by reference Returns the status of the Data Acquisition process Possible values are Possible values are bu3416 SM IDLE 0 DAQ in IDLE state All needed settings FE config Clock and Trigger Config etc must be done in this state bu3416 SM DDSUD 1 DAQ in DDS UPDATE state In this state the card performs the update of the DDS settings bu3416 SM SYNC 2 DAQ in SYNC state After DDS UPDATE the card performs reset and re synchronization of ADCs and FIR filters This stage takes approximately 1 second bu3416 SM READY 3 DAQ in READY state The synchronization is done and card is ready to start DAQ bu3416 SM POST 5 DAQ in POST TRIGGER state Post trigger samples are stored in FIFO as long as the End Event of DAQ is not happened bu3416 SM END 6 DAQ process terminated successfully error Variable Type ViInt16 passed by reference This parameter contains information about any error happened during Data Acquisition process The value is a bitmask of the following values bu3416 DA_OUTRANGE ERR 0x0001 Cumulative Out Of Range error bu3416 DA _DECIM ERR 0x0002 Decimation error bu3416 DA _ARITH ERR 0x0004 Arithmetic error bu3416 DA _DDSUD_ERR 0x0008 DDS Update Signal error bu3416 DA MCLK_ERR 0x0010 MCLK Clock Frequency error bu3416 DA_SCAN_ERR 0x0020 Scan Error Copyright 2014 Bustec Production Ltd Page 75 of 171 3416 XX UM ProDAQ 3416 Function Ca
54. 416 setITRIConfig ViSession instrumentHandle ViInt16 daTrigSource ViInt16 syncSource Purpose This function configures the Input Trigger Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them daTrigSource Variable Type ViInt16 This parameter specifies what sources will be chosen for Data Acquisition DA Trigger The parameter is a bit mask so more than one source can be used at the same time using bitwise OR of the following values bu3416_DA_TRIG_OFF 0x0000 bu3416_DA_TRIG MBA 0x0001 bu3416_DA_TRIG_MBB 0x0002 bu3416_DA_TRIG_FP3 0x0004 Note This configuration is used if a board is configured as a STANDALONE or MASTER otherwise are don t care syncSource Variable Type ViInt16 This parameter specifies the source for the SYNC signal Possible values are bu3416_SYNC_MBB 0 Motherboard Input Trigger Stack B bu3416_SYNC_FP 1 Front Panel SYNC signal NOTE This configuration is don t care when the board is a MASTER or STANDALONE it is only required for the SLAVES Setting this parameter to bu3416_SYNC_FP will atomatically change FP Trigger intut 2 polarity to low level as active state Return Value Displays the return status of the function call If the function was successful
55. 6 XX UM ProDAQ 3416 Function Card User Manual This page was intentionally left blank Page 22 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 3 Theory of Operation 3 1 Block Diagram Front End Circuit ADC Data FIR Filter and Channel 1 m AS ADC Register gt Decimation Stage 1 gt A Front End Circuit em AS ADC eet ga FIR Filter and p PILT TR A Decimation Stage 2 N N MUX Front End Circuit gt p FIFO Channel 3 AZ ADC A Se gt FIR Filter and p Front End Circuit Decimation Stage 3 Channel 4 Fi AS ADC gt A a Front End Circuit em AY ADC Channel 5 S a DA Control ra ei g j Oo i oO ma 0 Lei az abc Internal d gt A Registers Front End Circuit A Channel 16 AX ADC A Clock Generation kB al Re PLL and DDS Synchronization System External SYNC I O A y Front Panel 12C Master 12C connection Controller Figure 3 Simplified Block Diagram 3 2 Analog Front End Circuitry The ProDAQ 3416 features sixteen fully differential overvoltage protected high impedance analog input channels numbered from 1 to 16 Analog front end circuitry condition the input signal which is later digitized b
56. Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 71 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 6 bu3416_calibrateBoard ViStatus bu3416 calibrateBoard ViSession instrumentHandle ViInt16 gain Purpose This function performs the calibration of all 16 channels of the ProDAQ 3416 module The calibration will be performed only for the selected gain setting If any other gain will be selected for the data acquision process the board should be calibrated for this gain setting as well The calibration coefficients will be applied to the hardware of the 3416 module immediately but they will not be stored in any non volatile memory on the board So after power down or function card reset the bord should be calibrated again Please note that calibration process require Voltage Reference module fitted on the Motherboard Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them gain Variable Type VilInt16 This parameter specifies the gain for which all cha
57. Arithmetic error 0x0008 DDS Update Signal error 0x0010 MCLK Clock Frequency error 0x0020 Scan Error bu3416 DA FIFO OV_ERR 0x0040 FIFO Overflow error bu3416 DA FIFO Up ERR 0x0080 FIFO Underflow error bu3416 DA_CB OV_ERR 0x0100 Circular Buffer Overflow error Copyright 2014 Bustec Production Ltd Page 73 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual NOTE For error bu3416 DA OUTRANGE ERR please use function bu3416 getDAQStatus to get more details about error happened on channel scanBacklog Variable Type VilInt32 passed by reference Returns the backlog of scans that have been acquired into the buffer but have not been read using bu3416 readAcquisition Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions a
58. Ch hann ls RE 31 D23 TACQUSIUON Een ee 32 6 PROGRAMMING THE PRODAQ 3416 cccsseeeeeeeeeeeeeeeeeeeeeeeeeeeeeseeeeseneeeeeeeeeeeenneees 33 6 1 VXlplug amp play Driver Organization ccccecceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeneaees 33 6 2 Connecting to the Function Card 34 ge eut ele DEE 35 6 4 SINGIE Cald ACGUISMON EE 35 6 4 1 Single shot ACQUISITION DE 35 6 4 2 Continous ACQUISIION EE 37 Copyright 2014 Bustec Production Ltd Page 3 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual 6 5 e e le EE 39 APPENDIX A FRONT PANEL CONNECTOR 0ccccccssseccceeeeseeeeeeeseeeeeeeeeeeeeeeeeeseeeeeeeeees 41 APPENDIX B REGISTER DESCRIPTION ccccssseeeeeeeeeseeeeeeeseeeeeeeeeeeeeeeeeeseeeeeeeeees 43 B 1 FCD 0x0 Function Card ID Register 45 B 2 FCVER 0x1 Function Card Version Register essssssseennnneeseeerernnrnnesseerrene 45 B 3 FCCSR 0x2 Function Card Control and Status Register 00000000000000eaeeaaa 45 B 4 MODE1 0x3 Mode We EE 47 Bb MODE2 0x4 Mode 2 Register un 48 DG OTRI 0x5 Output Trigger Configuration Register ccccceeeeeeeeeeeeeeeeeeeeeeees 49 B 7 ITRI 0x6 Input Trigger Status Hegister ee 50 Do DDS_WX 0x8 DDS Control Register 0 0 0 0 cceececeeeeeeeeeeeeeeeeeeeeeneeeeeeeeeeeeeeee 52 DO OCOEFL 0x9 Offset Coefficient Write Low Heosier 52 B 10 OQCOEFH 0xA Offset Coeffi
59. EN le E r 11 2 3 ProDAQ VXlbus Module Installapon 12 2 3 1 Preparing the ProDAQ Module EE 12 2 3 2 Installing a ProDAQ Function Ca 13 2 3 3 Removing a ProDAQ Function Ee 15 2 4 ProDAQ LXI Function Card Carrier Installation cccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeaeees 15 2 4 1 Opening the ProDAQ 6100 Enclosure ooaoaaaaaaaanannnnnnnnnnnnnnnnnnnnnnnnnnnnnenennnne 15 2 4 2 Installing a ProDAQ Function Card EEN 17 2 4 3 Removing a ProDAQ Function Card EE 19 2 4 4 Closing the ProDAQ 6100 Encosure 20 3 THEORY OF OPERATION e vcs cccisasencucncwcaccecevanduenswendvinsvenduenauecdwantsendciuauencwancwiadedcevans 23 e E Ee RE a gt EE 23 3 2 Analog Ett 23 3 3 eelere 24 GAs JG EE EE 24 S57 Data DEES 25 3 6 Sampling SCUNGS 2ccs2titc tet ccnttectimsletit eta steals atc tasted ee settee state 26 3 7 Multiple Cards Synchronization AEN 26 42 gt SPECIFICATIONS E 27 4 1 Input Ee El 27 42 Sampling EE 28 Ee le lee DE 28 4 4 Synchronization Sata i Bates Sa arkedebearteln beta ls depend iaubstadsh cede lieabeba ld cantelpauebebsteadahi be 28 4 5 Environmental Specifications lt ccciscetetsseecechs peecteeiperieutt raibeeiaceiev di aeasaciadesGebuplectenies 28 5 THE VXIPLUG amp PLAY DRIVER oisiscissccsceciiccesessasncsecseecaserteansescaaccersenensesuseurcenctaavenaiane 29 Beli Installationen a a A E 29 5 2 The Soft Front Ee sitesinde ee ree cet hrer ee ceedetreeereieeete heen 29 5 2 1 Waveforms EE 31 5 2 2
60. Handle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 161 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 69 bu3416_startMultAcquisitionEx ViStatus bu3416 startMultAcquisitionEx ViSession instrumentHandle ViInt32 threshold bu3100_ irqHandler t callback ViAddr parameter Purpose This function starts the Data Acquisition Process on the Group of the Function Cards operating synchronously It uses Int
61. ID Query to the instrument In those cases set this control to Skip Query and this function will initialize the bus and the Command arrays in the driver without doing an ID Query resetDevice Variable Type ViBoolean Specifies if the instrument is to be reset to its power on settings during the initialization procedure Valid Range 1 Yes 0 No Default Value Yes Page 118 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM NOTE If you do not want the instrument reset set this control to No while initializing the instrument instrumentHandle Variable Type ViSession passed by reference The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them NOTE A new unique handle will be returned EACH time the Initialize function is called The bu3416 close call should be used for EVERY handle returned by the bu3416 init function Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WI
62. ISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 162 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 70 bu3416_stopAcquisition viStatus bu3416 stopAcquisition ViSession instrumentHandle Purpose Stops the Data Acquisition process Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned
63. N E 103 DBA 16 CLP OST SOAS EE 106 DUIS 10 GEIS AMID EE 107 DUBATGO OCIS CTINIIN E 108 TOOT EE 109 ele Ee E 111 ee EE 112 USA TEE 115 UGA 1G EE 118 DUS4 16 TEADACQUISINON EE 120 ele FEGO FIFO EH 122 bu3416_readMultAcquisition E 123 bu3416_readTEDS_EEPROM EE 125 bu3416_readTEDS_OTP_ROM EE 126 u3416 rea d TEDS OM EE 127 PUGET s fOSCI EE 128 ee 16 SOSEIO AO E 129 bu3416 POS OIF E 130 ele EE 131 eier eg sfOSIZEMUN BUN EE 132 DU S41 ONOVISION QUCIV EE 133 DUBS1G Self EE EE EE 134 ele Eed CR 135 bu3416 SCIAD CMOGE E 137 ee EE 139 DUS4 16 Ee ie EE 140 DUIATO SETOA OMG GE EE 142 DUBS 16 SCID SPVGG E 144 bu3416_setFIFOConfig EE 145 DUB4 716 e TE 146 DUDA TC SCUT AICONHG EE 148 DuUS416 ee ere ssn a a a E 150 Copyright 2014 Bustec Production Ltd Page 5 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 61 C 5 62 C 5 63 C 5 64 C 5 65 C 5 66 C 5 67 C 5 68 C 5 69 C 5 70 C 5 71 C 5 72 C 5 73 C 5 74 C 5 75 DUIS TE leren GE 152 ee Ree E 153 ee 16 SETP OSISCAIIS Soistecductadvadontadeadenieaeaduetacvasentencadesdacctduonennaseotedratscedy 156 BUS4 16 SEIS AIND FICO EE 157 DU ISI GETINOCONNG EE 158 DUB4 16 STAMACGUISINON EE 159 DU S41 ee E 160 bU34 16 ee Een ME 161 bu3416_startMultAcquisitionEXx EE 162 DUB4 1B SIODACQUISINON EE 163 PUG TO lt SIOD AQ E 164 DUB41 6 Ee Ee EE 165 DUBATG SlOlE CAND EE 166 DUG4IG WilERCaAGleG E 168 DUBSTG WhIETEDS EE 169 Page 6 of 171 Copyrigh
64. N Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 119 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 38 bu3416_readAcquisition viStatus bu3416 readAcquisition ViSession instrumentHandle ViInt32 scanstoRead ViInt16 fi11Mode ViInt32 scanBacklog ViInt32 actualScansRead ViReal64 waveforms Purpose Fetches the specified amount of data from the function card Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them scanstoRead Variable Type ViInt32 Specifies the number of scans to be fetched from Function Card Each scan contains one sample per selected channel For instance if 3 channels were selected for Data Acquisition and number of scans is 1000 then 3000 samples will be stored in the output buffer i11Mode Variable Type VilInt16 The parameter specifies whether the Waveform array will be grouped by channels or grouped by scans Possible values are bu3416 GROUP_BY CHANNEL 0 Group data by channel b
65. OM Valid values 0 8 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error_message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 127 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 44 bu3416_reset viStatus bu3416 reset ViSession instrumentHandle Purpose This function resets the function card to its power on state Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will ret
66. ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Page 76 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 9 bu3416_clearErrors viStatus bu3416 clearErrors ViSession instrumentHandle Purpose This function issues the Clear command which clears Error Status information Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descript
67. Source Variable Type ViInt16 passed by reference This parameter returns the source for the PLL circuitry Possible values are bu3416 PLL _CLK_OSC 0 Clock from on board oscillator bu3416 PLL CLK _CCLK 1 Clock from CCLK Common clock bu3416 PLL _CLK_MBA 2 Clock from MB Input Trigger A bu3416 PLL CLK_FP 3 Clock from FP Input Trigger 1 decimation Variable Type ViInt16 passed by reference This parameter returns the decimation factor applied at ADC output data Possible values are bu3416_DECIM OFF bu3416 DECIM 10 bu3416_DECIM_100 bu3416 DECIM 1000 Decimation is off Decimation is 10 Decimation is 100 Decimation is 1000 LA M OO Copyright 2014 Bustec Production Ltd Page 85 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 86 of 171 Copyright 2014 Buste
68. a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 129 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 46 bu3416_resetFIFO ViStatus bu3416 resetFIFO ViSession instrumentHandle Purpose This function resets the FIFO pointers All configuration remains unchanged Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 130 of 171 Copyright 2014 Bustec Production Ltd
69. ach of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Page 124 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 41 bu3416_readTEDS_EEPROM ViStatus bu3416 readTEDS EEPROM ViSession instrumentHandle ViChar buf ViUInt16 addr ViUInt16 cnt Purpose Reads cnt bytes from TEDS 256 bit EEPROM starting at addr address Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them buf Variable Type ViChar passed by reference Buffer for result addr Variable Type viUInt16 TEDS EEPROM memory address offset Valid values 0x00 0x1F ent Variable Type viUInt16 Number of bytes to read from TEDS EEPROM Va
70. acquires a block of data as specified by the settings in the Acquisition tab see 5 2 3 Acquisition Tab and displays it If the run button gt gt is clicked the soft front panel application continuously acquires blocks of data until the stop button E is clicked With the Autoscale On Off button the user can select whether the graph display is automatically scaled to the acquired signal or whether a constant scaling should be used Clicking on the graph display with the right mouse key and dragging the mouse to select an area will allow the user to zoom in on the data 5 2 2 Channels Tab The Channels tab contains a set of tabs one for each channel Each channel tab allows the user to select the input source for the channel as well as the gain and to choose whether the channel should be included when data is acquired ProDAQ 3416 24 bit Sigma Delta ADC Channels Waveforms Acquisition Chant Chan2 Chana Chand Chan5 Chan amp Chan Gei gt r Front End Circuitry Channel 1 Enabled Input Source Front Panel e Enabled 1 3 Gain D Ty Input Signal Out of Range Apply to all Figure 8 Channel Configuration The Input Source for each channel can be selected to be either the front panel connector or the voltage reference bus from the ProDAQ motherboard or carrier If no
71. and should be avoided In general the usage of the low level functions will require an intimate knowledge of the ProDAQ 3416 hardware as well as the hardware of the ProDAQ motherboards and function card carriers Before you attempt to implement your data acquisition or test application using them it is recommended to study their usage in the higher level functions in the driver sources and or contact Bustec for support The following paragraphs will explain the usage of the high level functions 6 2 Connecting to the Function Card To initialize the driver and connect to the ProDAQ motherboard or function card carrier the standard VXI plug amp play initialization function bu3416_init is used see Figure 11 Please refer to the VXIplug amp play standard VPP 4 3 section 4 3 for a detailed description of the address string used After initializing the driver and connecting to the motherboard or carrier the driver must be told which one of the function cards to work with This is done by the function bu3416_fcSelect It takes as an argument the session established via the function bu3416_init the function card number and a boolean value specifying whether to reset the selected function card see Figure 11 include lt visa h gt include lt bu3416 h gt main int argc char argv ViStatus status ViSession session ViChar descr 256 if status bu3416 init VXI0 2 INSTR VI_TRUE VI TRUE amp session
72. annel will be configured Possible values are bu3416_CHAN_ALL 0 All 16 channels will be configured bu3416 CHAN 1 1 Channel 1 bu3416 CHAN 2 2 Channel 2 bu3416 CHAN 3 3 Channel 3 bu3416 CHAN 4 4 Channel 4 bu3416 CHAN 5 5 Channel 5 bu3416 CHAN 6 6 Channel 6 bu3416 CHAN 7 7 Channel 7 bu3416 CHAN 8 8 Channel 8 bu3416 CHAN 9 9 Channel 9 bu3416 CHAN 10 10 Channel 10 bu3416 CHAN 11 11 Channel 11 bu3416 CHAN 12 12 Channel 12 bu3416 CHAN 13 13 Channel 13 bu3416 CHAN 14 14 Channel 14 bu3416 CHAN 15 15 Channel 15 bu3416 CHAN 16 16 Channel 16 source Variable Type VilInt16 This parameter specifies the source of the input signal The possible values are bu3416 CH FP 0 Channel is connected to FP SCSI connector bu3416 CH_VREF 1 Channel is connected to Voltage Reference NOTE Only one channel can be conneted to VREF in the same time Please do not use Channel bu3416 CHAN ALL with Source bu3416 CH VREF Page 140 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM gain Variable Type ViInt16 This parameter specifies the gain for the input channel Possible values are bu3416_GAIN_1 1 Gain 1 Default bu3416 GAIN 2 2 Gain 2 bu3416 GAIN_5 5 Gain 5 bu3416 GAIN_10 10 Gain 10 bu3416 GAIN 20 20 Gain 20 bu3416 GAIN_50 50 Gain 50 bu3416 GAIN 100 100 Gain 100 bu3416 GAIN 200 200 Gain 200 bu3416 GAIN 500 500 Gain 500 bu3416 GAIN _1000 1000 Gain 1000 bu3416 GAIN 2000 2000 Gain 2000
73. be transferred to the DC controller during WRITE operation or data read from the 12C controller after previous READ operation Write Stores written data to be transmitted to the DC controller after WRITE command is issued using the 12C_CTRL register Read Returns the data read from the I2C controller after last READ command issued through l2C_CTRL register B 14 TEDS_ ACC 0xF TEDS Access Register This register gives the possibility to access the TEDS enabled sensor s memory Access amp Default Description Reserved TEDS READY TEDS Ready This bit indicates if the execution of an operation specified on the OP bits is finished Read 0 TEDS memory not ready operation in progress 1 TEDS memory ready and able to react on further actions TEDS PRESENT TEDS Present This bit indicates if the execution of a RESET operation finished successfully Read 0 TEDS not present 1 TEDS present and able to react on further actions OP Operation Selection The Operation bits specify the action the TEDS interface logic shall do Write 00 Has no effect 01 READ Requests a read of one data byte from TEDS sensor memor Page 54 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM operation is completed bit TEDS_READY set to 1 software can read this data from the CMD_DATA bits WRITE Requests a write of byte specified in the CMD_DATA field t
74. by a trigger SCAN1 SCAN2 SCAN3 _ SCAN4 SCANS ACQUISITION i i WA SAMPLE CH1 i svete SAMPLE CH2 j l l l KAS j Note after stopping an acquisition a current scan will finish Note the active trigger level on the above picture is a logical high level it can be configured A DA trigger event can also start an acquisition configured to collect a programmed number of scans In a default configuration it is infinity and a second DA trigger event stops the acquisition If a number of samples to be collected is limited than a second DA trigger does not stop the acquisition but instead can retrigger a collection of new scans if a previous set of scans have already been collected Programmed number of scans N 3 started by a trigger event SCAN1 SCAN2 SCAN3 SCAN4 SCANS SCAN6 START i i i START fe 3 SCANS 3SCAN ACQUISITION SAMPLE CH1 Pas SAMPLE CH2 Wad f Copyright 2014 Bustec Production Ltd Page 25 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual If a number of scans to be collected is limited and a new DA trigger event happens too early before previous programmed number of samples has been collected an error flag will be set The error will not appear if a new DA trigger event comes during the last scan of the programmed set of sampl
75. by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFC0900 to OxBFFCOFFF They are defined in the include file bu3416 h Page 132 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 49 bu3416_revision_query viStatus bu3416 revision query ViSession instrumentHandle ViChar driverRevision ViChar instrumentFirmwareRevision Purpose This function returns the driver revision However because the instrument revision query function is not supported this function always returns the VI_WARN_NSUP_REV_ QUERY warning Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them driverRevision Variable Type ViChar Returns the Instrument Driver revision instrumentFirmwareRe
76. by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Copyright 2014 Bustec Production Ltd Page 163 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 71 bu3416_stopDAQ ViStatus bu3416 stopDAQ ViSession instrumentHandle Purpose This function issues the DAQ Stop command which will terminate the Data Acquisition process Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describ
77. c Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 18 bu3416_getBufferSize viStatus bu3416 getBufferSize ViSession instrumentHandle ViInt32 bufferSize Purpose This function returns the size of the buffer in ProDAQ Motherboard on board DRAM memory Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them bufferSize Variable Type VilInt32 passed by reference Returns the size of the DRAM buffer allocated for the Function Card Default size of the DRAM buffer depends on the type of the Function Card Carrier Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and
78. cH1 cH2 cH3 eee CHnICHI CH2 CH3 eee cHn eee CHI CH2 CH3 eee cHn Scan 1 Scan 2 Scan n The number of values per scan depends on the number of channels enabled in the channel mask If for example channels 1 8 12 and 13 as in the above example are enabled each scan delivers 10 values This is also the arrangement of the data in the output array when the parameter fillMode is specified aS bu3416_GROUP_BY_SCAN But most of the time it is more convenient to have the data arranged on a per channel basis Therefore the function bu3416 _acquireWaveforms will re arrange the data while transferring it to the output array when the parameter fillMode is specified as bu3416_GROUP_BY_CHANNEL The result is an arrangement like Channel 1 Channel 2 Scan n Page 36 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM The complete number of samples as specified by the parameter scans for the first enabled channel is placed into the output array then the complete number of samples for the second enabled channel and so on 6 4 2 Continuous Acquisition To acquire data continuously the ProDAQ 3416 needs to be configured for scanning the input channels and moving the data into the on board FIFO The FIFO memory stores the data until the host computer is ready to read out the data The timing for this asynchronous read out depends on the amount of data in the FIFO The driver function bu3416_setAcq
79. ccording to Fill Mode parameter errors Variable Type ViInt16 passed by reference This parameter contains information about any error happened during Data Acquisition process The value is a bitmask of the following values bu3416 DA_OUTRANGE ERR 0x0001 Cumulative Out Of Range error bu3416 DA_DECIM ERR 0x0002 Decimation error bu3416 DA _ARITH ERR 0x0004 Arithmetic error bu3416 DA _DDSUD_ERR 0x0008 DDS Update Signal error bu3416 DA _MCLK_ERR 0x0010 MCLK Clock Frequency error bu3416 DA_SCAN_ERR 0x0020 Scan Error bu3416 DA FIFO OV_ERR 0x0040 FIFO Overflow error bu3416 DA FIFO Up ERR 0x0080 FIFO Underflow error NOTE For error bu3416 DA OUTRANGE ERR please use function bu3416 getDAQStatus to get more details about error happened on channel Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error Copyright 2014 Bustec Production Ltd Page 67 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from
80. cient Write High Heoisier 52 B 11 GCOEFL 0xB Gain Coefficient Write Low Register sseesessssererneeeseerene 53 B 12 GCOEFH 0xC Gain Coefficient Write High Register seeseessseeenneeeseeene 53 B 13 DC CIR OxE DC Control Register 54 B 14 TEDS_ACC 0xF TEDS Access Register ssseesesessnnennreeseerrernnnnreeeerrrnne 54 B 15 FIFO_CTRL 0x10 FIFO Control Register 55 B 16 FIFO_AFT 0x11 FIFO Almost Full Flag Threshold Register e 56 B 17 FIFO_WR 0x12 FIFO Write Register 56 B 18 Glo ERR 0x13 Signal Error Register 56 B 19 GAIN_COMP 0x14 Gain Compensation Register c eeeeeeeeeeeeeeeeeees 57 B20 ERROR 0X15 ege EE 57 B 21 POSTT_NOSL 0x19 Post Trigger Number of Scans Low Register 58 B 22 POSTT_NOSH 0x1A Post Trigger Number of Scans High Register 58 B 23 CHNxCFG 0x20 0x2F Channel x Configuration Heoisier 59 B 24 FCSSUB OxFC Function Card Sub Type Register nessseeseeeseeeernneeeeeeenne 59 B 25 FCSERH 0xFE Function Card Serial Number High Register 068 59 B 26 FCSERL OxFF Function Card Serial Number Low Register nsseessssnn 60 B 27 FIFO 0x8000 FIFO Memory ET 60 APPENDIX C VXIPLUG amp PLAY DRIVER FUNCTIONS ccccsssseeeeeeeeseeeeeeeeseeeeeeeees 61 CA JEE EE 61 G2 PASSUMIDUONS EE 61 E Error and Status In
81. coefficient write channel selection Write Specifies the channel the gain coefficient is being written for 0000 Channel 1 0001 Channel 2 0010 Channel 3 0011 Channel 4 0100 Channel 5 0101 Channel 6 0110 Channel 7 0111 Channel 8 1000 Channel 9 1001 Channel 10 1010 Channel 11 1011 Channel 12 1100 Channel 13 1101 Channel 14 1110 Channel 15 1111 Channel 16 Reserved GCOEFH Gain coefficient bits 23 16 Write Stores gain coefficient into internal gain coefficient memory at location specified by GCOEF_CHN field Copyright 2014 Bustec Production Ltd Page 53 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual B 13 l2C_CTRL 0xE I2C Control Register This is the 12C control register used to communicate with the 12C controller Access amp Default Description Reserved I2C_ RD nWR 12C Read Write This bit is used to select desired operation for the 12C controller Write 0 WRITE to the I2C controller 1 READ from the 12C controller I2C_INT status of the interrupt line This bit reflects the actual status of the 12C interrupt line from the controller Read 0 interrupt line not active 1 interrupt line active asserted by the controller Reserved DC ADDR 12C Controller Address Write Selects the DC controller register for which command is issued range 0 3 Read Returns previously written value GC DATA This the data byte that will
82. cond access uses only bits FIFO 7 0 for higher 8 bits 23 to 16 of the 24bit ADC sample FIFO 15 8 bits contain repeated sign bit so a result is extended to signed 32bit Page 60 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Appendix C VXIplug amp play Driver Functions C 1 Introduction This instrument driver provides programming support for the ProDAQ 3416 16 channel 24 bit Sigma Delta ADC Function card It contains functions for opening configuring acquiring data with and closing the instrument C 2 Assumptions To successfully use this function card it must be installed onto a ProDAQ VXIbus motherboard or a ProDAQ LXI function card carrier The ProDAQ motherboard must in turn be installed in a VXlbus system which is connected via a suitable slot 0 controller to your computer The LXI function card carrier must be connected via network to your computer A suitable VISA library must be installed on your computer C 3 Error and Status Information Each function in this instrument driver returns a status code that either indicates success or describes an error or warning condition Your program should examine the status code from each call to an instrument driver function to determine if an error occurred The general meaning of the status code is as follows Value Meaning 0 Success Positive Values Warnings Negative Values Errors The de
83. ction Cards positions numbered from 1 to 8 Instrument Descriptor and Function Cards parameters describe the list of function cards which should be initialized for synchronous operation For example there are three Function Cards two are fitted to the same motherboard with logical address 3 as FC1 and FC5 and the third one is fitted to another motherboard with logical address 5 as FC2 To initialize them the comma separated list of instrument descriptors for all three function cards should be passed to the Instrument Descriptor parameter and array of appropriate function card positions should be passed to Function Cards control ViInt16 fcs 3 1 5 2 bu3416 multInit VXI0 3 INSTR VXI0 5 INSTR fcs IDQuery Variable Type ViBoolean Specifies if an ID Query is sent to the instrument during the initialization procedure Valid Range 1 Yes 0 No Default Value Yes NOTE Under normal circumstances the ID Query ensures that the instrument initialized over the bus is the type supported by this driver However circumstances may arise where it is undesirable to send an ID Query to the instrument In those cases set this control to Skip Query and this function will initialize the bus and the Command arrays in the driver without doing an ID Query resetDevice Variable Type ViBoolean Specifies if the instrument is to be reset to its power on settings during the initialization procedure Valid Ran
84. e bu3416 OFF 0 Output disabled bu3416 FIFO PAFF DI 1 FIFO PAFF flag is routed to DI bu3416 OUTRANGE DI 2 OUTRANGE signal is routed to DI Page 154 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 155 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 63 bu3416_setPostScans viStatus bu3416 setPostScans ViSession instrumentHandle ViInt32 scans Purpose This function sets the post trigger number of scans to collect Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiat
85. e Variable Type viChar Upon return from the function holds a text error message which corresponds to the error code Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 81 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 14 bu3416_fcSelect viStatus bu3416 fcSelect ViSession instrumentHandle ViInt16 functionCard ViBoolean resetFC Purpose Selects the Function Card to be accessed further by the driver s functions Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them functionCard Variable Type ViInt16 The function card to which the instrum
86. e WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 65 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 2 bu3416_acquireWaveforms ViStatus bu3416 acquireWaveforms ViSession instrumentHandle ViInt16 channelMask ViReal64 scanRateHz ViInt32 scans ViInt16 fillMode ViReal64 waveforms ViInt16 errors Purpose This function acquires the waveforms from the specified channels All channels should be configured using the bu3416 setChanConfig function prior to this function call For the triggered waveform acquisition the trigger must be configured using bu3416 setTrigConfig function prior to this function call Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them channelMask Variable Type ViInt16 Selects the channels from which the data will be taken bit 0 corresponds to the Channel 1 bit 15 corresponds to the Channel 16 1 written in the appropriate bit means that the channel will be included in the
87. e Type ViInt16 This parameter specifies which channel will be configured Possible values are bu3416 CHAN ALL 0 All channels for all Function Card will be configured 1 Channel 1 of Function Card 1 2 Channel 2 of Function Card 1 16 Channel 16 of Function Card 1 17 Channel 1 of Function Card 2 18 Channel 2 of Function Card 2 32 Channel 16 of Function Card 2 source Variable Type VilInt16 This parameter specifies the source of the input signal The possible values are bu3416 CH FP 0 Channel is connected to FP SCSI connector bu3416 CH_VREF 1 Channel is connected to Voltage Reference gain Variable Type ViiInt16 This parameter specifies the gain for the input channel Possible values are bu3416 GAIN 1 1 Gain 1 Default bu3416 GAIN 2 2 Gain 2 bu3416 GAIN_5 5 Gain 5 Page 150 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM bu3416 GAIN 10 10 Gain 10 bu3416 GAIN 20 20 Gain 20 bu3416 GAIN 50 50 Gain 50 bu3416 GAIN 100 100 Gain 100 bu3416 GAIN 200 200 Gain 200 bu3416 GAIN 500 500 Gain 500 bu3416 GAIN 1000 1000 Gain 1000 bu3416 GAIN 1000 2000 Gain 2000 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the
88. e VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 96 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 25 bu3416_getFPTrigPolarity viStatus bu3416 getFPTrigPolarity ViSession instrumentHandle ViInt16 polFPT1 ViInt16 polFPT2 ViInt16 polFPT3 Purpose This function gets active state levels for Front Panel Triggers Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them polFPT1 Variable Type ViInt16 passed by reference This parameter returns level of active state of Front Panel Trigger 1 Possible values are bu3416 LOW 0 active state for FP trigger 1 is low zero bu3416 HIGH 1 active state for FP trigger 1 is high one polFPT2 Variable Type ViInt16 passed by reference This parameter returns level of active state of Front Panel Trigger 2 Possible values are bu3416 LOW 0 active state for FP trigger 2 is low zero bu3416 HIGH 1 active state for
89. e between them scans Variable Type VilInt32 This parameter sets the post trigger number of scans to collect Possible values are from 0 to Oxffffff Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 156 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 64 bu3416_setSampFreq ViStatus bu3416 setSampFreq ViSession instrumentHandle ViReal64 frequencyHz Purpose Sets sampling frequency Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them frequencyHz Variable Type ViReal6 4 This parameter specifies the sampling frequency in Hz Possible val
90. e between them threshold Variable Type VilInt32 The interrupt service routine will be called every time when the number of scans specified by this parameter is collected in Function Card FIFO or Motherboard Circular Buffer on 3180 callback Variable Type bu3100 irqHandler t This interrupt service routine should readout data from function card parameter Variable Type ViAddr Pointer to a parameter which will be transferred to the interrupt service routine Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 160 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 68 bu3416_startMultAcquisition viStatus bu3416 startMultAcquisition ViSession instrumentHandle Purpose This function starts the Data Acquisition on the Group of Function Cards operating synchronously Parameter List instrument
91. e boards are configured for the synchronous sampling then only one board can be switched to be a Master 1 the board is a Slave 1 the board is a Master DC DET I2C device detected The bit is used to detect a cable supporting communication with 12C devices is connected to the card The bit does not change its status during normal operation 0 the cable supporting 12C is not present 1 the cable supporting DC communication is connected DA END Data Acquisition End The bit is set by hardware after the normal end of data acquisition or when the DA_SKIP has been performed It is not set if DA ends with the error This bit is cleared on arming command 1 DA ended MAINSM_ST Main State Machine States The bits indicate the states of the main state machine Read 000 IDLE_ST idle state 001 DDSUD_ST frequency synchronization 010 ADCSYNC_ST ADC synchronization 011 READY4DA_ST armed 100 PRET_ST armed ready for trigger 101 POSTT_ST acquisition in progress Copyright 2014 Bustec Production Ltd Page 45 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Others reserved FIFO _PAFF FIFO Programmable Almost Full Flag The Almost Full Flag indicates that FIFO memory is almost full Read 0 FIFO not almost full 1 FIFO almost full Note the same flag is present in the FIFO_CTRL register ERR a Common Error Flag The bit informs that an error condition happened The error sourc
92. e can be found by reading the ERROR register Read 0 normal operation 1 error condition happened MODE PINS Mode Pins Status The bits are read only and return the status of the Mode pins DA SKIP DA Skip Writing this bit causes the end of DA Write 1 current DA skipped SYNC SEL SYNC Source Selection This bit selects the source of the SYNC signal If the board is a Master then it generates the SYNC signal internally otherwise it takes the SYNC from the external source selected by the SYNC_SEL bit Write 0 MB trigger input B MB_TRIGI_B 1 FP trigger input 2 FP_TRG2 SYNC NEED Synchronisation Need Defines if the DA has to be launched together with the synchronisation Write 0 DA launched without a synchronisation 1 DA launched with a synchronisation LONG SYNC Long Synchronisation If set when the board is a Master then a long P2 part of the SYNC pulses will be generated Write 0 synchronization takes about 950ms 1 synchronization takes about 8200ms ARM _ CMD Arming Command Arming command launches the data acquisition process the main SM leaves the IDLE_ST Write 0 No effect 1 Generates arming command SW_RST Software Reset This bit is used to reset a part of the FPGA logic which is related to the Data Acquisition The reset doesn t change the contents of the registers Reset is started by writing 1 to that bit After the reset
93. e chosen for Motherboard Output Trigger Stack A MBA Possible values are bu3416 OFF 0 Output disabled bu3416 FPIT3 MBA 1 FP trigger input 3 is routed to MBA bu3416 RCLK_MBA 2 Ref clock 2MHz is routed to MBA bu3416 ADCC_MBA 3 ADC clock is is routed to MBA bu3416 DA Gm MBA 4 DA progress signal is routed to MBA bu3416 OUTRANGE MBA 5 Out of range signal is routed to MBA bu3416 FIFO PAFF MBA 6 FIFO PAF flag is routed to MBA sourceMBB Variable Type ViiInt16 This parameter specifies what source will be chosen for Motherboard Output Trigger Stack B MBB Possible values are bu3416 OFF 0 Output disabled bu3416 FPIT2_ MBB 1 FP trigger input 2 is routed to MBB bu3416 SYNC_MBB 2 SYNC is routed to MBB bu3416 SCANP_ MBB 4 Pulse per Scan sig is routed to MBB bu3416 OUTRANGE MBB 5 Out of range signal is routed to MBB bu3416 FIFO PAFF MBB 6 FIFO PAF flag is routed to MBB sourceFPOT1 Variable Type VilInt16 This parameter specifies what source will be chosen for Front Panel Output Trigger 1 FPOT1 Possible values are bu3416 OFF 0 Output disabled bu3416 MBA FPOT1 1 MB Trigger input A is routed to FPOT1 bu3416 CCLK_FPOT1 2 Common Clock CCLK is routed to FPOT1 Copyright 2014 Bustec Production Ltd Page 153 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual bu3416 RCLK_FPOT1 3 Ref clock 2MHz is routed to FPOT1 bu3416 ADCC_FPOT1 4 ADC clock is routed to FPOT1 bu3416 DA_ST FPOT1 6 DA prog
94. e front panel connector used on the ProDAQ 3416 is a high density 50 pin female SCSI connector with the following pin out soa 8 Sorat TEDS 4 29 GND e fefe e me ofe vwe zl mnm In 10 In 10 20 45 top 1 26 25 50 Figure 15 Front panel connector as seen when the card is fitted in the module Copyright 2014 Bustec Production Ltd Page 41 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Signal Description FP_TRG_IO_N Front panel trigger inputs TEDS TEDS Interface This signal needs to be multiplexed into the inputs signal paths for sensor readout GC D I DC Detection Signal l2C_SCL DC Clock Signal l2C_SDA I C Data Signal VRef VRef Buffered voltage reference bus output In N In N Differential channel inputs Page 42 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Appendix B Register Description All addresses are given in hexadecimal notation FC_ADR is address in the function cards address space VXI_ADR is address in VXI address space refer to the motherboard manual for more details WARNING Writing directly to the registers of the function card can cause unexpected behavior and or may render the card unusable e g by overwriting calibration values Please use the function card driver to access the card FC VXI o o0 FCID_______ RO FC ID register o O 1 04 _ FCVER RO FC
95. e function bu3416_checkAcquisition The function returns the acquisition state errors that may occur during the acquisition e g over range error and the number of scans available for readout Due to the hardware synchronisation support for multi card configurations and the requirements of the Sigma Delta ADC the state machine on the function card uses number of states before the card is ready for sampling These states bu38416 SM DDSUD bu3416 SM _SYNC will only be returned in case an error happened and must not be used in the application to follow the progress of the state machine Copyright 2014 Bustec Production Ltd Page 37 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual If no error occurs the state machine will either go to the state bu3416_SM_READY if the acquisition is configured to wait for a trigger or directly to the state bu3416_sm_PostT In this state the ProDAQ 3416 is acquiring data and storing it in the FIFO ViSession session ViStatus status VilInt16 state error Vilnt32 backlog nread remaining VilInt32 waveforms En Fa wait for the ProDAQ 3416 to acquire data do status bu3416 checkAcquisition session amp state amp error amp backlog if error 0 handle error break loop while state lt bu3416 SM POST read out the data Acquisition will stop automatically when total number of samples is reached Sa do status bu3416 checkAcqu
96. e to Copyright 2014 Bustec Production Ltd Page 109 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual send an ID Query to the instrument In those cases set this control to Skip Query and this function will initialize the bus and the Command arrays in the driver without doing an ID Query resetDevice Variable Type ViBoolean Specifies if the instrument is to be reset to its power on settings during the initialization procedure Valid Range 1 Yes 0 No Default Value Yes NOTE If you do not want the instrument reset set this control to No while initializing the instrument instrumentHandle Variable Type ViSession passed by reference The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them NOTE A new unique handle will be returned EACH time the Initialize function is called The bu3416 close call should be used for EVERY handle returned by the bu3416 init function Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete l
97. e using bitwise OR of the following values bu3416_DA_TRIG_OFF 0x0000 bu3416_DA TRIG MBA 0x0001 bu3416_DA_TRIG MBB 0x0002 bu3416_DA TRIG FP3 0x0004 bu3416 DA TRIG FP3_ LOW 0x0008 use this setting with bu3416 DA TRIG FP3 to set trigger active state to low Note This configuration is used if a board is configured as a STANDALONE or MASTER otherwise don t care Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 158 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 66 bu3416_startAcquisition viStatus bu3416 startAcquisition ViSession instrumentHandle Purpose This function starts the continuous acquisition Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument I
98. ean if burn is VI_TRUE function will program ROM if not function will write data into scratchpad for testing ATTENTION Be careful programming ROM can be done only once Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 70 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 5 bu3416_calibrateAllChannels ViStatus bu3416 calibrateAllChannels ViSession instrumentHandle VilInt16 gain ViInt32 offsets ViInt32 gains Purpose This function performs the calibration of all channels for the selected gain Please note that calibration process requires Voltage Reference module fitted on Motherboard Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than
99. ed to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them frequencyHz Variable Type ViReal64 passed by reference This parameter returns the actual frequency what DDS generator was set up for Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 94 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 23 bu3416_getFlFOConfig viStatus bu3416 getFIFOConfig ViSession instrumentHandle ViInt16 affThreshold Purpose This function gets FIFO configuration Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more t
100. egister allows selection of a source for a particular trigger output Access amp Default Description TRIGO A Output trigger A to the MB Select a source for the trigger Write 000 Output disabled inactive 001 Front Panel Trigger input 3 010 Reference clock 2MHz 011 ADC clock 100 Acquisition in progress 101 OUTRANGE_ERR asserts trigger line 110 FIFO trigger flag programmable almost full PAF 111 Software assertion forced to active state Read Returns previously written value TRIGO B Output trigger B to the MB Select a source for the trigger Write 000 Output disabled inactive 001 Front Panel Trigger input 2 010 SYNC pulses 011 reserved 100 Pulse per Scan 101 OUTRANGE_ERR asserts the trigger line 110 FIFO trigger flag programmable almost full PAF 111 Software assertion forced to active state Read Returns previously written value FPTRIGO 1 Front Panel Output trigger 1 Select a source for the trigger Write 000 Output disabled high impedance 001 MB Trigger input A 010 Common Clock input from the MB CCLk 011 Reference clock 2MHz 100 ADC clock 101 reserved 110 Acquisition in progress 111 Software assertion forced to active state Read Returns previously written value Copyright 2014 Bustec Production Ltd Page 49 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual FPTRIGO 2 Front Panel Output
101. election This bit selects the edge transition for the stop trigger event 0 DA trigger reacts on the active to inactive transition 1 DA trigger reacts on the inactive to active transition STOP ON ERR Stop On Error Mode When set the bit enables stopping the data acquisition if an error happens 00 errors dont stop DA 01 any error excluding OUTRANGE_ERR stops DA 10 any error including OUTRANGE_ERR stops DA 11 reserved DA STARTSEL DA Start Mode Selection This bit selects the way the Data Acquisition is started 0 DA starts immediately after synchronisation is done 1 DA starts when DA Trigger goes active DA STOPSEL DA Stop Mode Selection This bit selects the way the Data Acquisition is stopped 00 DA stops when a programmed number of samples has been collected 01 DA stops when DA Trigger stop event happens Start Stop mode 10 DA stops when DA Trigger goes inactive Gate mode 11 reserved Copyright 2014 Bustec Production Ltd Page 47 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Bb MODE2 0x4 Mode 2 Register This register is used to configure parameters of the function card Access amp Default Description ADC PWRDOWN ADS1278 ADC power down Write 0 ADS1278 powered up default 1 ADS1278 in power down state Read Returns previously written value ADC CLK DIV ADS1278 ADC clock divider Write 0 ADS1278 clock divider line set to 0 1 ADS1
102. en the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them sourceMBA Variable Type VilInt16 passed by reference This parameter returns what source is chosen for Motherboard Output Trigger Stack A MBA Possible values are bu3416 OFF 0 Output disabled bu3416 FPIT3 MBA 1 FP trigger input 3 is routed to MBA bu3416 RCLK_MBA 2 Ref clock 2MHz is routed to MBA bu3416 ADCC_MBA 3 ADC clock is is routed to MBA bu3416 DA Gm MBA 4 DA progress signal is routed to MBA bu3416 OUTRANGE MBA 5 Out of range signal is routed to MBA bu3416 FIFO PAFF MBA 6 FIFO PAF flag is routed to MBA sourceMBB Variable Type ViInt16 passed by reference This parameter returns what source is chosen for Motherboard Output Trigger Stack B MBB Possible values are bu3416 OFF 0 Output disabled bu3416 FPIT2 MBB 1 FP trigger input 2 is routed to MBB bu3416 SYNC_MBB 2 SYNC is routed to MBB bu3416 SCANP MBB 4 Pulse per Scan sig is routed to MBB bu3416 OUTRANGE MBB 5 Out of range signal is routed to MBB bu3416 FIFO PAFF MBB 6 FIFO PAF flag is routed to MBB sourceFPOT1 Variable Type ViInt16 passed by reference This parameter returns what source is chosen for Front Panel Output Trigger 1 FPOT1 Possible values are Copyright 2014 Bustec Production Ltd Page 103 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual bu3416 OFF 0 Output
103. enclosure Page 16 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Slide the function card cover off as shown below 2 4 2 Installing a ProDAQ Function Card To install a ProDAQ Function Card into the ProDAQ 6100 LXI Function Card Carrier you must first remove the front bezel and the function card cover as shown previously see paragraph 2 4 1 Opening the ProDAQ 6100 Enclosure The ProDAQ Function Cards are mounted inside the ProDAQ 6100 directly on the main PCB The function cards positions two and four are located on top of the PCB and the positions one and three below The function cards are mounted face down e g the front panel connectors as well as the motherboard connectors are underneath the PCB when mounted Make sure that the M3x6mm screws and washers are removed from the PCB standoffs Copyright 2014 Bustec Production Ltd Page 17 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Position the function card over the function card slot you want to install it to carefully aligning the connectors connecting it to the ProDAQ 6100 PCB and push it down until it seats fully onto the standoffs of the ProDAQ 6100 PCB Use three M3x6mm panhead screws and washers OG to attach the function card to the ProDAQ 6100 PCB six screws and washers for a double wide function card EI EI
104. ent handler will be bound resetFC Variable Type ViBoolean Specifies if the Function Card is to be reset to its power on settings during the initialization procedure Valid Range 1 Yes 0 No Default Value Yes NOTE If you do not want the instrument reset set this control to No while initializing the instrument Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error_message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 82 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 15 bu3416_generatelTRI ViStatus bu3416 generateITRI ViSession instrumentHandle ViInt16 function Purpose This function asserts deasserts DA Trigger signal line Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrume
105. er Manual C 5 39 bu3416_readFIFO viStatus bu3416 readFIFO ViSession instrumentHandle ViInt32 count VilInt32 data Purpose This function reads the specified amount of data from FIFO The required amount of data should not be bigger than actual number of samples stored in FIFO Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them count Variable Type VilInt32 This parameter specifies how many 32 bit samples should be read from FIFO The required amount of samples should not be bigger than actual number of samples stored in FIFO data Variable Type Vilnt32 This parameter contains the pointer to the user buffer which will hold the requested data upon successful function call The buffer should be allocated prior to function call with size big enough to hold all requested data Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their va
106. eration The group of function cards should be initialized prior to this function call by using bu3416 multInit function If the group will be configured in Triggered mode the input trigger for this group should be configured prior to this function call by using bu3416 setMultTrigConfig function Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit synchMode Variable Type ViInt16 This parameter specifies how the Function Cards will be synchronized Possible values are bu3416_MB_SYNC_MODE 0 Synchronization will be done using ProDAQ Motherboard triggering system If the Function Cards are located in different ProDAQ Motherboards then two VXI Backplane TTL trigger lines will be used as well bu3416 FP SYNC MODE 1 Synchronization will be done using Clock and Sync Front Panel connectors which should be connected appropriately using the external cables channelMask Variable Type ViInt16 Selects the channels from which the data will be taken This is an array of 16 bit values each element corresponds to the appropriate Function Card from the list of Function
107. errupt Callback Routine to read out periodically the acquired data Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit threshold Variable Type VilInt32 The interrupt service routine will be called every time when the number of scans specified by this parameter is collected in Function Card FIFO or Motherboard Circular Buffer on 3180 callback Variable Type bu3100 irqHandler t This interrupt service routine should readout data from function card parameter Variable Type ViAddr Pointer to a parameter which will be transferred to the interrupt service routine Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the V
108. es so a new acquisition can be triggered at any time after the last scan begun no matter if it has finished yet or is still in progress A DA trigger input which can start and stop the acquisition has implemented a hold off feature which protects against false trigger events glitches occurring near the functional trigger event The hold off time is fixed and equals to ips False trigger events happening in the hold off zone will not generate an error condition and will be safely ignored _ SCAN1 SCAN2 SCAN3 SCAN4 SCANN SCAN Hai tHold Off ie i f i i i dree off HOLD OFF re i i a rH TRG filtered g Sas SAMPLE CH1 B M i Sen M M i SAMPLE CH2 7 i i i i i HOLD OFF starts after first activity of the trigger During HOLD OFF time any activity of the trigger is ignored A data acquisition trigger can be generated internally by a software command or accepted from an external source via the input trigger line on the front panel connector or the motherboard trigger line on the function card interface 3 6 Sampling Settings The output data rate of the acquisition is common for all input channels and can be set up to 10 kSamples sec Bx versions or 1 kSample sec Ax versions The acquisition clock can be generated onboard or can be accepted from an external source via various trigger lines If it is generated locally it is generated using the Direct Digital Synth
109. es returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 78 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 11 bu3416_enableLIST viStatus bu3416 enableLIST ViSession instrumentHandle ViBoolean enable Purpose This function forces the usage of the ProDAQ 3150 Motherboard s LIST processor By default the LIST processor is enabled when the ProDAQ 3416 module is running on 3150 equipped with LIST processor LIST processor cannot be used while the ProDAQ 3416 module is running on ProDAQ 3120 Motherboard Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them enable Variable Type ViBoolean This parameter enables disables the ProDAQ 3150 Motherboard s LIST processor Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framew
110. escriptor SRE PRICE Rea ei Function Card Number Select FC Number ProDAQ 3416 16 Channel 24 bit Sigma Delta ADC Function Card VXI plug amp play Driver Copyright 1996 2010 Bustec Production Ltd The resource string and range of function card numbers differ depending on the ProDAQ Motherboard or Carrier the ProDAQ 3416 is installed on Please refer to the motherboard carrier user manual for more information Note In some systems it might be necessary to register the network instrument via the Configuration Utility coming with the Bustec VISA before the function card can be found via Auto Find or accessed using a TCPIP resource descriptor After initializing the ProDAQ 3416 function card during which a splash screen is displayed the soft front panel window will appear see Figure 7 ProDAQ 3416 Soft Front Panel Application Figure 7 ProDAQ 3416 Soft Front Panel Application ProDAQ 3416 Soft Front Panel 192 168 168 63 ProDAQ 3416 bustec 24 bit Sigma Delta ADC Waveforms 1000 800 600 400 200 0 400 600 800 Seconds Page 30 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 5 2 1 Waveforms Tab The Waveforms tab which is shown by default allows the user to acquire and display data from enabled channels see 5 2 2 Channels Tab Each time the start button ris clicked the soft front panel application
111. esis DDS technique and can be programmed by the user with a very fine resolution much lower than 1Hz The locally generated clocks on multiple 3416 or other ProDAQ function cards using the same scheme can be synchronized to each other As the sigma delta ADCs together with a fixed low pass filter in the input stage can only sample the input data with a rate down to TBD samples sec additional FIR filter stages implemented in the on board programmable logic devices provide additional decimation to allow output data rates down to 1 Sample sec 3 7 Multiple Cards Synchronization The 3416 function card samples all 16 channels simultaneously If more than 16 channels need to be sampled in a synchronous way and the acquisition started at the same time on all channels than multiple cards can be synchronized together The ProDAQ 3416 can be set as a master or a slave If the 3416 works in stand alone mode it need always to be configured as master If a number of the 3416 cards should work in a multiple card synchronization mode then card is configured as master and all other as slaves For the synchronous acquisition the master card generates two signals which have to be distributed to all slaves a clock signal and a sync signal Page 26 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 4 Specifications 4 1 Input Characteristics 3416 XX UM Number of Channels 16 Input Type Differen
112. f Range error bu3416 CH10 OUTRANGE 0x00000200 Channel 10 Out Of Range error bu3416 CH11 OUTRANGE 0x00000400 Channel 11 Out Of Range error bu3416 CH12 OUTRANGE 0x00000800 Channel 12 Out Of Range error bu3416 CH13_ OUTRANGE 0x00001000 Channel 13 Out Of Range error bu3416 CH14 OUTRANGE 0x00002000 Channel 14 Out Of Range error bu3416 CH15 OUTRANGE 0x00004000 Channel 15 Out Of Range error bu3416 CH16 OUTRANGE 0x00008000 Channel 16 Out Of Range error Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 93 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 22 bu3416_getDDSFreq ViStatus bu3416 getDDSFreq ViSession instrumentHandle ViReal64 frequencyHz Purpose This function returns the frequency in Hz of the DDS generator Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is us
113. f more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 159 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 67 bu3416_startAcquisitionEx viStatus bu3416 startAcquisitionEx ViSession instrumentHandle ViInt32 threshold bu3100 irqHandler t callback ViAddr parameter Purpose This function starts the continuous acquisition It uses Interrupt Callback Routine to read out periodically the 3416 FIFO contents Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiat
114. formation eieiei eege eege 61 CA Function ke 62 C 5 VX iplug amp play Driver Function Details een 64 C 5 1 DUST IG SACO UMOW AVEIONIN EE 64 C 5 2 bu3416_acquireWaveformS tege EEN 66 e DUB TIO armDAQ A eene feed 69 C 5 4 bu3416_burnTEDS_OTP_ROM eege 70 C 5 5 bu3416_calibrateAllChannelS fic2 ccsseonedcadecnsconcenedvndeenecensecdscunduwescendesnedwadeosness 71 E Ee DEE 72 C 5 7 DUSTIC CHECKACQUISIION scsesseuseacesenesussaancrenceentiaseuusaieoesanteantueveianesescrserenasd 73 C 5 8 bu3416_checkMultAcquisition EE 75 6 5 9 p u341 6 elea ee 77 C 5 10 E EE EE 78 Page 4 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 11 C 5 12 C 5 13 C 5 14 C 5 15 C 5 16 CAT C 5 18 C 5 19 C 5 20 C 5 21 C 5 22 C 5 23 C 5 24 C 5 25 C 5 26 C 5 27 C 5 28 C 5 29 C 5 30 C 5 31 C 5 32 C 5 33 C 5 34 C 5 35 C 5 36 C 5 37 C 5 38 C 5 39 C 5 40 C 5 41 C 5 42 C 5 43 C 5 44 C 5 45 C 5 46 C 5 47 C 5 48 C 5 49 C 5 50 C 5 51 C 5 52 C 5 53 C 5 54 C 5 55 C 5 56 C 5 57 C 5 58 C 5 59 C 5 60 ee LO ON ADICENS RE 79 DUB41C CNOl MCSSAGC sieis a e a ase 80 DUBS TO NOTION E EE 81 ele gel 82 DISA eg 83 DUBATO SO CTICTAICO E 84 DUSZTO OCIA Ree 85 ele 87 DUBGA TB GET CANDID EE 88 DUBATG SOCTOAG MOOG EE 90 DUST ee 92 BUS416 GEIDD EE 94 DUIS 10 gt OEIRIF OCONNG EE 95 ale 96 ele EE 97 b 3416 RR EE 99 ele RR TEE 100 bu3416_getMultFCsession EE 101 DUGS TO GEO TI COG
115. frequency out of range error occurred DDSUD ERR DDS External Update Signal Error The bit is read only and is set by hardware after DDS external update signal error happens This bit is cleared on the clearing command 1 external update signal not in phase ARITH_ ERR Arithmetic Overflow Error Indicates that during offset and gain correction calculations overflow condition happened on any channel This bit is cleared on the clearing command 1 out of range error occurred DEC ERR Decimation error detected Bit indicates that during writing data to decimation stage collision happen which is related to decimation module fatal error 1 decimation error 0 normal operation OUTRANGE ERR Input Signal Out of Range Error The bit is read only and is set by hardware after input signal out of range error happens This bit is cleared on the clearing command 1 out of range error occurred This is common signal for all channels Read SIG_ERR register to detect which channel caused this error B 21 POSTT_NOSL 0x19 Post Trigger Number of Scans Low Register The POSTT_NOSL H registers define the number of scans to be acquired during DA if the mode with number of scans has been selected DA_STOPSEL 00 The number of post trigger scans is in the range from 0 to 16777215 0 means unlimited number of scans Access amp 15 0 R W POSTT NOS Post Trigger Number Of Scans i 0x0 Lower 16 bits POSTT_NOS 15
116. function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Copyright 2014 Bustec Production Ltd Page 121 of 171 3416 XX UM ProDAQ 3416 Function Card Us
117. ge 1 Yes 0 No Default Value Yes NOTE If you do not want the instrument reset set this control to No while initializing the instrument instrumentHandle Variable Type ViSession passed by reference The Instrument Handle is used to identify the unique session or communication channel between the driver and the selected group of the function cards IMPORTANT NOTE The instrument handle must be used with all of the Page 116 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM other functions of Multi Card Acquisition sub class and it cannot be used with any other function of the Instrument driver A bu3416 multClose function should be called to close this instrument handle Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 117 of 171 3416 XX
118. ght 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 36 bu3416_multinit viStatus bu3416 multInit ViRsre instrumentDescriptor ViInt16 functionCards ViBoolean IDQuery ViBoolean resetDevice vViSession instrumentHandle Purpose Initializes the group of specified Function Cards for synchronous operations and returns the instrument handle associated with this group of Function Cards IMPORTANT NOTE The instrument handle must be used with all of the other functions of Multi Card Acquisition sub class and it cannot be used with any other function of the Instrument driver The function cards can be fitted in the same or in different ProDAQ motherboard modules but they must be located in the same VXI crate First function card in the list will operate as a Master while all others will operate as Slaves If the function cards are located on the same ProDAQ motherboard module the will be synchronized over ProDAQ motherboard internal trigger system If the function cards are located on different ProDAQ motherboard modules two VXI backplane TTL trigger lines will be used for synchronization Instrument Descriptor and Function Cards parameters describe the list of function cards which should be initialized for synchronous operation For example there are three Function Cards two are fitted to the same motherboard with logical address 3 as FC1 and FC5 and the third one is fitted to another
119. han one instrument of the same model type is used this Handle will be used to differentiate between them affThreshold Variable Type VilInt16 passed by reference This parameter returns the threshold level for Programmable Almost Full Flag PAFF Possible values are 2 to FIFO _SIZE 1 where FIFO SIZE is 8192 or 16384 depending on card version NOTE The following table shows configuration for FIFO flags Number of samples in FIFO Empty Almost Full Full 0 1 0 0 1 to aftThreshold 1 0 0 0 aftThreshold to FIFO SIZE 1 0 1 0 FIFO_SIZE 0 0 1 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 95 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 24 bu3416_getFIFOStatus viStatus bu3416 getFIFOStatus ViSession instrumentHandle ViInt16 FIFOFlags ViInt16 FIFOCounter Purpose This fu
120. hannels were selected for Data Acquisition and number of scans is 1000 then 3000 samples will be stored in the output buffer waveforms Variable Type ViReal6 4 The output buffer containing the samples fetched from Function Cards This buffer should be allocated by application before the function call with appropriate size to hold all data Samples in this buffer are grouped by channel for example If you scan channels A through C and Number of Scans is 5 then data is grouped in the following way Al A2 A3 A4 A5 B1 B2 B3 B4 B5 C1 C2 C3 C4 C5 Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate Copyright 2014 Bustec Production Ltd Page 123 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by e
121. he VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them Copyright 2014 Bustec Production Ltd Page 101 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Page 102 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 29 bu3416_getOTRIConfig viStatus bu3416 getOTRIConfig ViSession instrumentHandle ViInt16 sourceMBA ViInt16 sourceMBB ViInt16 sourceFPOT1 ViInt16 sourceFPOT2 ViInt16 sourceFPOT3 ViInt16 sourceDE ViInt16 sourceDTI Purpose This function returns the configuration of the Output Trigger Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel betwe
122. he unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them daTrigSource Variable Type ViInt16 passed by reference This parameter returns what sources will be chosen for Data Acquisition DA Trigger The parameter is a bit mask so more than one source can be used at the same time using bitwise OR of the following values bu3416 DA TRIG OFF 0x0000 bu3416 DA TRIG MBA 0x0001 bu3416 DA TRIG MBB 0x0002 bu3416 DA TRIG FP3 0x0004 syncSource Variable Type ViInt16 passed by reference This parameter returns the source for the SYNC signal Possible values are bu3416 SYNC_MBB 0 Motherboard Input Trigger Stack B bu3416 SYNC_FP 1 Front Panel SYNC signal Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright
123. ing one of the trigger sources the user can specify the acquisition to wait for a start trigger Please note that if one of the motherboard input triggers is chosen the motherboard or carrier must be configured separately to route a trigger to the function card in addition For convenience the optional voltage reference of the motherboard or carrier can be directly controlled from the ProDAQ 3416 soft front panel application Selecting one of the voltages or ground via the Voltage Reference drop down selector will allow to sample this voltage on all channels which are configured for this input source Page 32 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 6 Programming the ProDAQ 3416 This chapter shows how to program the ProDAQ 3416 function card using the VX p ug amp play driver Complete examples can be found in the Examples subdirectory of the driver All functions are explained in detail in the help file coming with the driver 6 1 VXlplug amp play Driver Organization The VXlplug amp play driver is organized in a hierarchical manner to allow the user to quickly choose the function calls to solve the task at hand without being confronted with unnecessary details Besides the standard connection disconnection and utility functions it contains different levels of functionality which provide single functions or sets of functions to solve a particular data acquisition task
124. ing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 164 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 72 bu3416_stopMultAcquisition viStatus bu3416 stopMultAcquisition ViSession instrumentHandle Purpose Stops the Data Acquisition process running on the Group of the Function Cards operating synchronously Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The fu
125. ions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 77 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 10 bu3416_close ViStatus bu3416 close ViSession instrumentHandle Purpose This function closes the instrument and reclaims the resources allocated by the call to the initialization function bu3416 init or bu3416 paramInit This should be called once for every instrument handle returned by the initialize functions prior to terminating the application program Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error cod
126. is done the hardware clears the bit Software should poll the bit until it is cleared Write 0 No effect 1 Starts reset of the FPGA logic Read 0 Card ready reset finished if previously started 1 Card not ready reset in progress Page 46 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM BA MODE1 0x3 Mode 1 Register This register is used to configure parameters of the function card Access amp Default Description Reserved Reserved SHORT SYNC This bit should be always set to 0 DA TRG SEL 5 0 Source for Data Acquisition Trigger These bits enable trigger sources for starting and stopping the data acquisition process Multiple sources can be selected at a time Write 1 enables a source DA_TRG 5 enables MB_TRIGI_A trigger input DA_TRG 4 enables MB_TRIGI_B trigger input DA_TRG 3 reserved DA_TRG 2 reserved DA_TRG 1 enables FP_TRG3 trigger input DA_TRGJ 0 forces DA trigger to active state software trigger DA TRG STS DA Trigger Status Current state of the DA Trigger The status shows OR function of all enabled sources of the DA Trigger 0 DA Trigger inactive 1 DA Trigger active DA TRG LEVEL DA Trigger Edge Level Selection This bit selects between edge or level of the DA trigger 0 DA trigger reacts on the edge 1 DA trigger follows level DA TRG ESEL Stop Trigger Edge S
127. isition session amp state amp error amp backlog if error 0 handle error break loop if backlog gt 1024 status bu3416 readAcquisition session 1024 bu3416 GROUP_BY CHANNEL amp remaining amp nread waveforms while state bu3416 SM POST LES ese Teh Figure 14 Checking the Status of the Acquisition and Data Read out When data is available the function bu3410_readAcquisition can be used to read out the data acquired It takes as parameters the number of scans to read the fill mode as described above for the function bu3410_acquireWaveforms and a pointer to the data buffer It also returns the actual number of scans read and the number of scans still in the on board FIFO Depending on the timing it may be necessary to continue reading data after the ProDAQ 3416 has stopped acquiring data to read the data remaining in the FIFO If you want to use an asynchronous callback instead of polling you will need to use the function bu3416_ startAcquisitionEx to specify a callback function and a threshold The driver will then configure the card to generate an asynchronous event that will activate the callback function whenever the amount of data available reaches the specified threshold The callback function must be of the type bu3100_ irqHandler_t see bu3100 h As this is a generic handler function used for all ProDAQ functions cards you still need to use the function bu3416_checkAcquisi
128. ist of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 110 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 34 bu3416_multClose viStatus bu3416 multClose ViSession instrumentHandle Purpose This function closes all Function Cards included in the Group and reclaims the resources allocated by the call to the Function Card Group initialization function bu3416 multInit Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message wi
129. les at 5MHz 011 Input toggles at 10MHz 100 Input toggles at another frequency 101 reserved 110 reserved 111 Input at a high level for at least last 10us Page 50 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM GC INT status of the interrupt line This bit reflects the actual status of the I2C interrupt line from the PCA9665 controller Read 0 interrupt line not active 1 interrupt line active asserted by the PCA9665 controller FPTRG 3 LOW FP trigger 3 active low The bit negates the front panel trigger both directions so the active level is LOW Write 0 trigger high active 1 trigger low active FPTRG 2 LOW FP trigger 2 active low The bit negates the front panel trigger both directions so the active level is LOW Write 0 trigger high active 1 trigger low active FPTRG 1 LOW FP trigger 1 active low The bit negates the front panel trigger both directions so the active level is LOW Write 0 trigger high active 1 trigger low active FPTRIGI 3 FP Trigger Input 3 This is a status bit that indicates when the current state of the trigger line Read 0 trigger not active 1 trigger active asserted FPTRIGI 2 FP Trigger Input 2 This is a status bit that indicates when the current state of the trigger line Read 0 trigger not active 1 trigger active asserted FPTRIGI 1 FP Trigger Input 1 This is a
130. lid values 0 32 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 125 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 42 bu3416_readTEDS_OTP_ROM viStatus bu3416 readTEDS OTP_ROM ViSession instrumentHandle ViChar buf Purpose ViUInt16 addr ViUInt16 cnt Function reads cnt bytes from TEDS OTP ROM starting at addr address Parameter List instrumentHandle buf Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Variable Type ViChar passed by reference Buffer for result addr ent Variable Type viUInt16 TEDS ROM memory address offset Valid values 0x00
131. ll handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Copyright 2014 Bustec Production Ltd Page 111 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 35 bu3416_multConfig viStatus bu3416 multConfig ViSession instrumentHandle ViInt16 synchMode ViInt16 channelMask ViReal64 sampleRateHz ViInt16 startMode ViInt32 scansToCollect ViInt16 BPTrigClock ViInt16 BPTrigSynch Purpose This function configures the group of ProDAQ 3416 function cards for synchronous op
132. lt Variable Type ViInt16 passed by reference Returns the result of the self test Valid Range 0 no error test passed 1 test failed testMessage Variable Type viChar Returns description of result of self test Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 134 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 51 bu3416_setAcquisitionMode viStatus bu3416 setAcquisitionMode ViSession instrumentHandle ViInt16 channelMask ViReal64 sampleRateHz ViInt32 scansToCollect ViInt16 startMode VilInt16 stopOnError Purpose This function sets the Data Acquisition operational mode Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument
133. lues Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 122 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 40 bu3416_readMultAcquisition ViStatus bu3416 readMultAcquisition ViSession instrumentHandle ViInt32 scanstoRead ViReal64 waveforms Purpose Fetches the specified amount of data from all Function Cards operating synchronously in the Group The amount of data available for reading should be obtained by using bu3416 checkMultAcquisition prior to this function call Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit scanstoRead Variable Type VilInt32 Specifies the number of scans to be fetched from Function Card The amount of scans available for reading should be obtained by using bu3416 checkMultAcquisition prior to this function call Each scan contains one sample per selected channel For instance if 3 c
134. motherboard with logical address 5 as FC2 To initialize them the comma separated list of instrument descriptors for all three function cards should be passed to the Instrument Descriptor parameter and array of appropriate function card positions should be passed to Function Cards control ViInt16 fces 3 1 5 2 bu3416 multinit VXI0 3 INSTR VXI0 5 INSTR fes oh Parameter List instrumentDescriptor Variable Type ViRsrc Comma separated instrument descriptors list for each 3416 function card which should be initialized for synchronous operation Instrument Descriptor and Function Cards parameters describe the list of function cards which should be initialized for synchronous operation For example there are three Function Cards two are fitted to the same motherboard with logical address 3 as FC1 and FC5 and the third one is fitted to another motherboard with logical address 5 as FC2 To initialize them the comma separated list of instrument descriptors for all three function cards should be passed to the Instrument Descriptor parameter and array of appropriate function card positions should be passed to Function Cards control ViInt16 fcs 3 1 5 2 bu3416_multInit VXI0 3 INSTR VXI0 5 INSTR fcs Copyright 2014 Bustec Production Ltd Page 115 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual functionCards Variable Type ViInt16 This control should contain an array of the Fun
135. move the top cover of the module as described earlier in this chapter Fig 2 Pos 1 e Remove all screws on the front panel holding installed function cards or double filler panels in place Fig 2 Pos 2 Screws holding single filler panels don t need to be removed e Remove the two panhead screws that mount the front panel to the modules bottom cover Fig 2 Pos 6 e Please take special care of the module handles and the rings Fig 2 Pos 3 and 4 which are also fixed by those screws The mounting angle Fig 2 Pos 5 stays fixed to the front panel e Remove the front panel by moving it forward carefully so as to avoid bending the installed function cards e Choose the stack and position lower or upper where you want to mount the function card If the stack in which the function card should be installed is covered by a double filler panel you have to remove it before installing the function card e Remove the three 2 5mm panhead screws and the crinkle washers from the stack s standoffs Fig 2 Pos 9 and 10 for example e H you want to install a function card in the upper position of a stack without having a function card in the lower position you need to mount both spacers Fig 3 Pos 11 on each standoff If the stack is already populated with a function card in the lower position mount only the bigger spacer Fig 2 Pos 8 onto each standoff e Place a bayonet supplied on each standoff Align the function ca
136. n Clock bu3416 ADC _CLK MBA 2 Clock from MB Input Trigger A bu3416 ADC _CLK_FP 3 Clock from FP Input Trigger 1 PLLClockSource Variable Type VilInt16 This parameter specifies the source for the PLL circuitry Possible values are bu3416 PLL _CLK_OSC 0 Clock from on board oscillator bu3416 PLL CLK _CCLK 1 Clock from CCLK Common clock bu3416 PLL _CLK_MBA 2 Clock from MB Input Trigger A bu3416 PLL CLK_FP 3 Clock from FP Input Trigger 1 decimation Variable Type VilInt16 This parameter specifies the decimation factor applied at ADC output data Possible values are bu3416 DECIM OFF 0 Decimation is off bu3416 DECIM 10 1 Decimation is 10 bu3416 DECIM 100 2 Decimation is 100 bu3416 DECIM 1000 3 Decimation is 1000 Copyright 2014 Bustec Production Ltd Page 137 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be
137. n Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 167 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 74 bu3416_writeReadI2C viStatus bu3416 writeReadI2C ViSession instrumentHandle ViInt32 address ViInt32 nWrite ViChar dataWrite ViInt32 nRead ViChar dataRead Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them address Variable Type VilInt32 This control contains the address of the I2C device nWrite Variable Type VilInt32 This control specifies the number of bytes to be written to the I2C device This number should not exceed bu3416 PCA_COUNT_MAX 1
138. n an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 84 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 17 bu3416_getADCMode viStatus bu3416 getADCMode ViSession instrumentHandle ViInt16 ADCClockSource ViInt16 PLLClockSource ViInt16 decimation Purpose This function returns the ADC operational mode Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them ADCClockSource Variable Type ViInt16 passed by reference This parameter returns the source for the ADC Clock Possible values are bu3416 ADC CLK _DDS 0 Clock from DDS Default bu3416 ADC CLK CCLK 1 Clock from CCLK Common Clock bu3416 ADC _CLK MBA 2 Clock from MB Input Trigger A bu3416 ADC _CLK_FP 3 Clock from FP Input Trigger 1 PLLClock
139. n be used to overwrite offset coefficients loaded during card initialisation from EEPROM Access amp Default Description OCOEF CHN Gain coefficient write channel selection Write Specifies the channel the offset coefficient is being written for 0000 Channel 1 0001 Channel 2 0010 Channel 3 0011 Channel 4 0100 Channel 5 0101 Channel 6 0110 Channel 7 0111 Channel 8 1000 Channel 9 1001 Channel 10 1010 Channel 11 1011 Channel 12 1100 Channel 13 1101 Channel 14 1110 Channel 15 1111 Channel 16 Reserved Page 52 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM OCOEFH Offset coefficient bits 23 16 Stores the offset coefficient into the internal gain coefficient memory at a location specified by OCOEF_CHN field B 11 GCOEFL 0xB Gain Coefficient Write Low Register GCOEFL register together with GCOEFH register can be used to overwrite gain coefficients loaded during card initialisation from EEPROM Access amp Description Default H GCOEFL Gain coefficient bits 15 0 15 0 WO Write Stores bits 15 0 of the gain coefficient in an internal temporary register B 12 GCOEFH 0xC Gain Coefficient Write High Register GCOEFH register together with GCOEFL register can be used to overwrite gain coefficients loaded during card initialisation from EEPROM Access amp Default Description GCOEF CHN Gain
140. nction bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFCO900 to OxBFFCOFFF They are defined in the include file bu3416 h Copyright 2014 Bustec Production Ltd Page 165 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 73 bu3416_storeCalibData viStatus bu3416 storeCalibData ViSession instrumentHandle ViInt16 channel Purpose ViUInt32 offset ViUInt32 gain This function stores the calibration data into on board EEPROM The data should be acquired before using bu3416 calibrate function Once da
141. nction returns the information about current load of FIFO Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them FIFOFlags Variable Type VilInt16 passed by reference This parameter returns the status of the FIFO Flags Possible values are bu3416 FIFO EMPTY 0 No Samples stored in FIFO bu3416 FIFO NEMPTY 1 FIFO contains 1 to FIFO AFT 1 samples bu3416 FIFO AFULL 2 FIFO contains FIFO AFT to FIFO SIZE 1 samples bu3416 FIFO FULL 3 FIFO contains FIFO SIZE samples bu3416 FIFO OV 4 Overflow write request was rejected because the FIFO is full bu3416 FIFO UF 5 Underflow read request was rejected becuase the FIFO is empty where FIFO AFT is Almost Full Threshold register See bu3416 setFIFOConfig function FIFOCounter Variable Type ViInt16 passed by reference This parameter returns a lower 8 bit part of a counter for a number of samples stored in the FIFO memory Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of th
142. nd the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a ProDAQ motherboard Warnings returned by the library will be in the range 0x3FFC0800 to 0x3FFC0900 and errors in the range OxBFFCO800 to OxBFFC0900 They are defined in the include file bu3100 h BU3416 Warnings Errors Warning codes returned by the 3416 driver functions will be in the range 0x3FFC900 to Ox3FFCOFFF and errors codes in the range OxBFFC0900 to OxBFFCOFFF They are defined in the include file bu3416 h Page 74 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 8 bu3416_checkMultAcquisition viStatus bu3416 checkMultAcquisition ViSession instrumentHandle ViInt16 acquisitionState ViInt16 error ViInt32 scanBacklog Purpose Returns the state of the last or current Data Acquisition process running on the Group of Function Cards operating synchronously Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3
143. ndoffs Take special care when removing the function card s not to bend the motherboard connectors After removing the function card s install the correct combination of spacers on the standoffs If a stack is populated with only one function card each of the standoffs needs to be mounted with both spacers to cover the distance between the cards as well as the PCB thickness of the missing card If a stack is populated with two function cards only the bigger spacer must be mounted Fix any remaining function cards again by mounting the three panhead screws on the standoffs re mount the front panel and the modules cover 2 4 ProDAQ LXI Function Card Carrier Installation WARNING Disconnect the ProDAQ 6100 from the mains before opening the enclosure 2 4 1 Opening the ProDAQ 6100 Enclosure Remove the up to eight M2 5x6mm Pozidrive Panhead screws attaching the front bezel to the function cards If there is no function card installed in a slot and a blanking panel is used to cover the front bezel opening do not remove it screws before detaching the front bezel Then remove the two M3x6mm Torx Countersunk screws attaching the front bezel to the enclosure Copyright 2014 Bustec Production Ltd Page 15 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Slide the front bezel off as shown below Remove the M3x6mm Torx Countersunk screw attaching the function card cover to the
144. nel disabled 1 channel enabled B 24 FCSSUB 0xFC Function Card Sub Type Register This is function card sub type register useful for software to distinguish between versions of the board Access amp Default Description FCSUB_ 2CH Sub Type Second Character Second ASCII character of the function card sub type FCSUB ICH Sub Type First Character First ASCII character of the function card sub type B 25 FCSERH 0xFE Function Card Serial Number High Register This register contains the upper 16 bits of the FC serial number Serial numbers are coded as BCD digits Access amp 15 0 RO FCSERH Function Card Serial Number upper part h Upper 16 bits FCSER 31 16 of the function card serial number Copyright 2014 Bustec Production Ltd Page 59 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual B 26 FCSERL 0xFF Function Card Serial Number Low Register This register contains the lower 16 bits of the FC serial number Access amp 15 0 RO FCSERL Function Card Serial Number lower part i h Lower 16 bits FCSER 15 0 of the function card serial number B 27 FIFO 0x8000 FIFO memory Allows the readout of the FIFO memory Access amp Default Description FIFO FIFO memory readout The measured 24bit data is stored in the FIFO memory and can be read using this register A first access is for lower 16 bits of the 24bit ADC sample a se
145. nnels will be calibrated Possible values are bu3416_GAIN_1 1 Gain 1 Default bu3416_GAIN_2 2 Gain 2 bu3416_GAIN_5 5 Gain 5 bu3416_GAIN_10 10 Gain 10 bu3416_GAIN_20 20 Gain 20 bu3416_GAIN_50 50 Gain 50 bu3416_GAIN_100 100 Gain 100 bu3416_GAIN_200 200 Gain 200 bu3416_GAIN_500 500 Gain 500 bu3416_GAIN_1000 1000 Gain 1000 bu3416_GAIN_2000 2000 Gain 2000 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 72 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 7 bu3416_checkAcquisition ViStatus bu3416 checkAc Purpose Returns the state of th Parameter List instrumentHandle Variable Type The Instrument Hand communication chann If more than one in Handle will be used acquisitionState Variable Type Returns the status are bu3416 SM IDLE 0 bu3416 SM DDSUD 1 bu3416 SM SYNC 2 bu3
146. nt of the same model type is used this Handle will be used to differentiate between them function Variable Type VilInt16 This parameter specifies what function will be performed on Input Trigger line Possible values are bu3416 OFF 0 The Trigger Line will be switched to inactive state if all selected Output Trigger sources are in inactive state bu3416 ON 1 The Trigger Line will be switched to active state bu3416 PULSE 2 The Trigger Line will be switched subsequently to inactive active inactive states if all selected Output Trigger sources are in inactive state Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 83 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 16 bu3416_generateOTRI viStatus bu3416 generateOTRI ViSession instrumentHandle ViInt16 trigger ViInt16 function Pu
147. o the TEDS sensor memory Transmission of the next byte can be initiated after operation is completed bit TEDS_READY set to 1 RESET Initiates TEDS sensor memory Reset operation which is necessary before first access to TEDS memory and after some commands issued to it Next operation can be initiated after operation is completed successfully bit TEDS_ READY set to 1 and bit TEDS_ PRESENT set to MI CMD DATA Command Data This is the command address data byte that will be transferred to the TEDS sensor memory during WRITE operation or data read from memory after READ operation Write Specifies the byte that has to be transferred to the TEDS memory during a Write operation Read Gives the last data read from the TEDS sensor memor B 15 FIFO_CTRL 0x10 FIFO Control Register This register is a control status register of the FIFO memory Access amp Default Description FIFO RST FIFO Reset e This is FIFO reset Reset is done by writing 1 to that bit and waiting for 0 Reset of the FIFO means clearing read write pointers and internal registers Write 0 no effect 1 starts reset of FIFO Read 0 resetting finished if previously started 1 resetting in progress FIFO UNF ERR FIFO Underflow Error Flag This signal indicates that a read request was rejected because the FIFO is empty Underflowing to the FIFO is non destructive to the FIFO 0 FIFO not underflow 1 FIFO unde
148. one instrument of the same model type is used this Handle will be used to differentiate between them gain Variable Type VilInt16 This parameter specifies the gain for which all channels will be calibrated Possible values are bu3416_GAIN_1 1 Gain 1 Default bu3416_GAIN_ 2 2 Gain 2 bu3416_GAIN_5 5 Gain 5 bu3416_GAIN_10 10 Gain 10 bu3416_GAIN_20 20 Gain 20 bu3416_GAIN_50 50 Gain 50 bu3416_GAIN_100 100 Gain 100 bu3416_ GAIN 200 200 Gain 200 bu3416 GAIN 500 500 Gain 500 bu3416 _GAIN_1000 1000 Gain 1000 bu3416 GAIN 2000 2000 Gain 2000 offsets Variable Type VilInt32 This parameter returns the calibration coefficients Offsets acquired during calibration process It is array of 16 values for all 16 channels The program should allocate this buffer with appropriate size prior to the function call gains Variable Type VilInt32 This parameter returns the calibration coefficients Gains It is array of 16 values for all 16 channels The program should allocate this buffer with appropriate size prior to the function call Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error_message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values
149. op DAQ Get DAQ Status FIFO Readout Control Set FIFO Configuration Get FIFO Configuration Get FIFO Status Read FIFO Reset FIFO ProDAQ 3416 Function Card User Manual Function Name bu3416 init bu3416 fcSelect bu3416 paramInit bu3416 setChanConfig bu3416 setTrigConfig bu3416 calibrateBoard bu3416 acquireWaveform bu3416 acquireWaveforms bu3416 setAcquisitionMode bu3416 startAcquisition bu3416 startAcquisitionEx bu3416 checkAcquisition bu3416 readAcquisition bu3416 stopAcquisition bu3416 multInit bu3416 multConfig bu3416 setMultChanConfig bu3416 setMultTrigConfig bu3416 startMultAcquisition bu3416 startMultAcquisitionEx bu3416 checkMultAcquisition bu3416 readMultAcquisition bu3416 stopMultAcquisition bu3416 resizeMultBuf bu3416 getMultFCsession bu3416 multClose bu3416 setITRIConfig bu3416 getITRIConfig bu3416 setOTRIConfig bu3416 getOTRIConfig bu3416 setFPTrigPolarity bu3416 getFPTrigPolarity bu3416 setDAQMode bu3416 getDAQMode bu3416 setADCMode bu3416 getADCMode bu3416 setPostScans bu3416_ getPostScans bu3416_ setDDSFreq bu3416_ getDDSFreq bu3416 setSampFreq bu3416 getSampFreq bu3416 generateITRI bu3416 generateOTRI bu3416 getITRIState bu3416 resetDAQ bu3416 armDAQ bu3416 clearErrors bu3416 stopDAQ bu3416 getDAQStatus bu3416 setFIFOConfig bu3416 getFIFOConfig bu3416 getFIFOStatus bu3416 readFIFO bu3416 resetFIFO Page 62 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3
150. ork error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 79 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 12 bu3416_error_message viStatus bu3416 error_message ViSession instrumentHandle ViStatus errorReturnValue ViChar errorMessage Purpose This function converts a numeric error code returned by one of the functions of this driver into a descriptive error message string Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them errorReturnValue Variable Type viStatus Accepts the error code returned by one of the functions in this instrument driver See bu3416 h for Error Codes errorMessage Variable Type viChar Upon return from the function holds a text error message which corresponds to the error code The VISA Warnings and VISA Errors are described in section 3 3 of the VPP 4 2 2 document and Appendix B of VPP 4 2 Return Value Displays the return status of the function call If the function was successf
151. oving the module from the package e Remove the ProDAQ instrument from its carton preserving the factory packaging as much as possible e Inspect the ProDAQ instrument for any defect or damage Immediately notify the carrier if any damage is apparent 2 2 Reshipment Instructions Use the original packing material when returning a ProDAQ instrument to Bustec Production Ltd for calibration or servicing The original shipping carton and the instrument s plastic foam will provide the necessary support for safe reshipment If the original anti static packing material is unavailable wrap the ProDAQ instrument in anti static plastic sheeting and use plastic spray foam to surround and protect the instrument Reship in either the original or new shipping carton WARNING Proper ESD handling procedures must always be used when packing unpacking or installing any ProDAQ device or ProDAQ function card Ground yourself via a grounding strap or similar e g by holding to a grounded object and discharge the package by touching it to a grounded object before removing the module from the package Copyright 2014 Bustec Production Ltd Page 11 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual 2 3 ProDAQ VXibus Module Installation 2 3 1 Preparing the ProDAQ Module To install a ProDAQ function card into one of the ProDAQ motherboards you need to remove the module s top cover 1 Module Cover 2 Cover Screws
152. pe ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the Group of the Function Cards operating synchronously This Handle can be obtained only from initialization of Function Card Group by using bu3416 multInit function not from initialization of individual Function Cards bu3416 init or bu3416 paramInit newSize Variable Type VilInt32 Specifies the new size of the DRAM buffer allocated for each Function Card in the Group The maximum size depends on the amount of DRAM available and number 3416 Function Cards fitted to each 3180 module Default size of the DRAM buffer is 0x20000 samples Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned
153. pe ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them buf Variable Type ViBuf Buffer with data to write addr Variable Type viUInt16 TEDS EEPROM memory address offset Valid values 0x00 0x1F ent Variable Type viUInt16 Number of bytes to write into TEDS EEPROM Valid values 0 32 Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 169 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual This page was intentionally left blank Page 170 of 171 Copyright 2014 Bustec Production Ltd Bustec Production Ltd Bustec House Shannon Business Park Shannon Co Clare Ireland Tel 353 0 61 707100 FAX
154. r of the 3416 function card Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 108 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 33 bu3416_init viStatus bu3416 init ViRsrce instrumentDescriptor ViBoolean IDQuery ViBoolean resetDevice ViSession instrumentHandle Purpose Initializes the instrument and returns an instrument handle The instrument handle must be used with all of the other functions of this driver The initialize call allows the instrument to be queried to ensure that it is a Bustec Data Acquisition System It also resets the Module to the power up state if the Reset parameter is True ON This function interrogates the motherboard registers to ascertain in which locations there are function cards fitted and then checks those locations to identify the type of function ca
155. rd User Manual bu3416 DA _FIFO OV_ERR 0x0040 FIFO Overflow error bu3416 DA _FIFO Up ERR 0x0080 FIFO Underflow error bu3416 DA_CB OV_ERR 0x0100 Circular Buffer Overflow error NOTE For error bu3416 DA OUTRANGE ERR please use function bu3416 getDAQStatus to get more details about error happened on channel scanBacklog Variable Type VilInt32 passed by reference Returns the backlog of scans that have been acquired into the buffer but have not been read using bu3416 readAcquisition Return Value If the function was successful it will return a status of VI_SUCCESS otherwise it will return a warning or error code Passing the status code to the function bu3416 error message will return a string describing the warning or error A driver function can return three different types of warnings or errors The function bu3416 error message will handle all three types of warning error codes by passing them to the appropriate function if necessary bu3100 error message or viStatusDesc to return the correct warning error message VISA Warnings Errors See section 3 3 of the VPP 4 3 2 document for a complete list of VISA status codes and their values The VPP 4 3 document contains detailed descriptions of all VISA functions and the status codes returned by each of them BU3100 Warnings Errors These are warning or error codes returned by the common motherboard interface library which is used by the 3416 driver to access a
156. rd fitted NOTE that for each bu3416 init call a new unique instrument handle is returned Thus if four calls are made to the initialize call in succession four unique instrument handles will be returned After call of bu3416_init the function bu3416 fcSelect must be called to bind the acquired instrument handler to the specific Function Card For each instrument handle returned by the bu3416 init function the bu3416 close function should be called to free up the resources allocated by bu3416 init The call s to bu3416_ close should be made before the application program terminates Parameter List instrumentDescriptor Variable Type ViRsrc Specifies which remote instrument to establish a communication session with Based on the syntax of the Instr Descriptor the Initialize function configures the I O interface and generates an Instr Handle The default value is for a VXI interface for logical address 7 Default Value VXI 7 INSTR Based on the Instrument Descriptor this operation establishes a communication session with a device IDQuery Variable Type ViBoolean Specifies if an ID Query is sent to the instrument during the initialization procedure Valid Range 1 Yes 0 No Default Value Yes NOTE Under normal circumstances the ID Query ensures that the instrument initialized over the bus is the type supported by this driver However circumstances may arise where it is undesirabl
157. rd over these and slide carefully down The function card should be held parallel to the modules bottom cover all the time during its way down e Fix the function card by mounting the three 2 5mm panhead screws and the crinkle washers onto each standoff If you install a function card in the lower position of a stack you need first to mount both spacers Fig 2 Pos 11 onto each standoff e Re mount the modules front panel If there is only one function card mounted in a stack cover the remaining opening in the front panel by a single filler panel e Re mount the modules top cover Adjust the procedure respectively for a double width ProDAQ function card Copyright 2014 Bustec Production Ltd Page 13 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual 1 2 5mm Panhead Screws 2 2 5mm Panhead Screws 3 Module Handle 4 Ring 5 Mounting Angle 6 2 5mm Panhead Screws 7 Standoff 8 Spacer 9 Crinkle Washer 10 2 5mm Panhead Screw 11 2mm Spacer Figure 2 The ProDAQ module assembly Page 14 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 2 3 3 Removing a ProDAQ Function Card Removing a ProDAQ function card is exactly the reverse operation then installing it After removing the top cover and the front panel as described previously remove the three roundhead screws that fix the function card s on the sta
158. ress signal is routed to FPOT1 bu3416 SWA_FPOT1 7 Software assertion mode used to generate trigger by bu3416_ generateOTRI function sourceFPOT2 Variable Type VilInt16 This parameter specifies what source will be chosen for Front Panel Output Trigger 2 FPOT2 Possible values are bu3416 OFF 0 Output disabled bu3416 MBB FPOT2 1 MB Trigger input B is routed to FPOT2 bu3416 SYNC_FPOT2 2 SYNC is routed to FPOT2 bu3416 OUTRANGE FPOT2 5 Out of range signal is routed to FPOT2 bu3416 SCANP_FPOT2 6 Pulse per Scan sig is routed to FPOT2 bu3416 SWA_FPOT2 7 Software assertion mode used to generate trigger by bu3416_generateOTRI function sourceFPOT3 Variable Type ViInt16 This parameter specifies what source will be chosen for Front Panel Output Trigger 3 FPOT3 Possible values are bu3416 OFF 0 Output disabled bu3416 MBA FPOT3 1 MB Trigger input A is routed to FPOT3 bu3416 MBB FPOT3 2 MB Trigger input B is routed to FPOT3 bu3416 SWA_FPOT3 7 Software assertion mode used to generate trigger by bu3416_ generateOTRI function sourceDE Variable Type VilInt16 This parameter specifies what source will be chosen for Direct Error DE Possible values are bu3416 OFF 0 Output disabled bu3416 OUTRANGE DE 1 Out of range signal is routed to DE bu3416 ANY DE 2 Any error asserts DE line sourceDI Variable Type VilInt16 This parameter specifies what source will be chosen for Direct Interrupt DI Possible values ar
159. rflow FIFO ONE ERR FIFO Overflow Error Flag This signal indicates that a write request was rejected because the FIFO is full Overflowing to the FIFO is non destructive to the FIFO 0 FIFO not overflow 1 FIFO overflow FIFO FF FIFO Full Flag The Full Flag indicates that FIFO memory is full 0 FIFO not full 1 FIFO full FIFO PAFF FIFO Programmable Almost Full Flag The Almost Full Flag indicates that FIFO memory is almost full 0 FIFO not almost full 1 FIFO almost full Copyright 2014 Bustec Production Ltd Page 55 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual FIFO EF FIFO Empty Flag The Empty Flag indicates that FIFO memory is empty 0 FIFO not empty 1 FIFO empty Reserved FIFO COUNT 7 0 FIFO Count This is a lower part of a counter for a number of samples stored in the FIFO The most significant bits are not available B 16 FIFO_AFT 0x11 FIFO Almost Full Flag Threshold Register This register is used to write the configuration data for programmable Almost Full FIFO flag FIFO Reset has to be asserted for reconfiguration Access amp Default Description Reserved FIFO AFL FIFO Almost Full Assert Level Value is used to set the threshold level for programmable almost full flag which define when the signal is asserted B 17 FIFO_WR 0x12 FIFO Write Register This register is used to write the data to FIFO
160. rpose This function asserts deasserts selected Output Trigger Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them trigger Variable Type VilInt16 This parameter specifies trigger which will be used The parameter is a bit mask so more than one trigger can be used at the same time using bitwise OR of the following values bu3416 TRIG MBA 0x0001 Motherboard Trigger Stack A bu3416 TRIG MBB 0x0002 Motherboard Trigger Stack B bu3416 TRIG PPI 0x0004 Front Panel Trigger 1 bu3416 TRIG FP2 0x0008 Front Panel Trigger 2 bu3416 TRIG FP3 0x0010 Front Panel Trigger 3 function Variable Type VilInt16 This parameter specifies what function will be performed on choosen Trigger Possible values are bu3416 OFF 0 The Trigger Line will be switched to inactive state if all selected Output Trigger sources are in inactive state bu3416 ON 1 The Trigger Line will be switched to active state bu3416 PULSE 2 The Trigger Line will be switched subsequently to inactive active inactive states if all selected Output Trigger sources are in inactive state Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will retur
161. rs Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 89 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 20 bu3416_getDAQMode viStatus bu3416 getDAQMode ViSession instrumentHandle ViInt16 boardMode ViInt16 startMode ViInt16 stopMode VilInt16 stopOnError Purpose This function returns the Data Acquisition operational mode Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them boardMode Variable Type ViInt16 passed by reference This parameter returns the Function Card operational mode Possible values are bu3416 FC _STALONE 0 The Board operates in a Stand Alone mode Default bu3416 FC MASTER 1 The Board operates as a Master in Multi Card operational mode bu3416 PC SLAVE 2 The Board operates as a Slave in Multi Card operational mode startMode Variable Type ViInt16 passed by reference This Parameter returns the Start Mode of Data Acquisition Possible values are bu3416 DA _START_IMM 0 Data Acquisition starts immediately after synchronization is done Default bu3416 DA START TRIG 1 Data Acquisition starts when Input Trigger goes active stopMode Variable Type ViInt16 passed
162. s terminated successfully errors Variable Type ViInt16 passed by reference This parameter contains information about any error happened during Data Acquisition process The value is a bitmask of the following values bu3416 DA_OUTRANGE ERR 0x0001 Cumulative Out Of Range error bu3416 DA_DECIM ERR 0x0002 Decimation error bu3416 DA ARITH ERR 0x0004 Arithmetic error bu3416 DA _DDSUD_ERR 0x0008 DDS Update Signal error bu3416 DA _MCLK_ ERR 0x0010 MCLK Clock Frequency error bu3416 DA_SCAN_ERR 0x0020 Scan Error bu3416 DA _FIFO OV_ERR 0x0040 FIFO Overflow error bu3416 DA FIFO Up ERR 0x0080 FIFO Underflow error Page 92 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM chErrors Variable Type ViInt32 passed by reference This parameter contains information error happened on channel during Data Acquisition process The value is a bitmask of the following values bu3416 CHL OUTRANGE 0x00000001 Channel 1 Out Of Range error bu3416 CH2 OUTRANGE 0x00000002 Channel 2 Out Of Range error bu3416 CH3 OUTRANGE 0x00000004 Channel 3 Out Of Range error bu3416 CH4 OUTRANGE 0x00000008 Channel 4 Out Of Range error bu3416 CH5 OUTRANGE 0x00000010 Channel 5 Out Of Range error bu3416 CH6 OUTRANGE 0x00000020 Channel 6 Out Of Range error bu3416 CH7_OUTRANGE 0x00000040 Channel 7 Out Of Range error bu3416 CH8 OUTRANGE 0x00000080 Channel 8 Out Of Range error bu3416 CH9 OUTRANGE 0x00000100 Channel 9 Out O
163. scription of each instrument driver function lists possible error codes and their meanings Copyright 2014 Bustec Production Ltd Page 61 of 171 3416 XX UM C 4 Function Tree Layout ProDAQ 3416 16 ch 24 bit Sigma Delta ADC Initialization Select Function Card Initialization With Parameters Hardware Configuration Set Channel Configuration Set Trigger Configuration Calibrate Board Single Card Acquisition Single shot Acquisition Acquire Waveform Acquire Waveforms Continuous Acquisition Set Acquisition Mode Start Acquisition Start Acquisition Ex Check Acquisition Read Acquisition Stop Acquisition Multi Card Acquisition Multi Card Initialization Multi Card Configuration Multi Card Channel Config Multi Card Trigger Config Multi Card Start Acquisition Multi Card Start Acquisition Ex Multi Card Check Acquisition Multi Card Read Acquisition Multi Card Stop Acquisition Multi Card Set DRAM Buffer Size Multi Card Get FC Handle Multi Card Close Low Level Access Set Input Trigger Config Get Input Trigger Config Set Output Trigger Config Get Output Trigger Config Set FP Triggers Polarity Get FP Triggers Polarity Set DAQ Mode Get DAQ Mode Set ADC Mode Get ADC Mode Set Post Trigger Scans Get Post Trigger Scans Set DDS Frequency Get DDS Frequency Set Sampling Frequency Get Sampling Frequency Control Status Functions Generate Input Trigger Generate Output Trigger Get Input Triggers State Reset DAQ Arm DAQ Clear Errors St
164. sourceDI Variable Type ViInt16 passed by reference This parameter returns what source is chosen for Direct Interrupt DI Possible values are bu3416 OFF 0 Output disabled bu3416 FIFO PAFF DI 1 FIFO PAFF flag is routed to DI bu3416 OUTRANGE DI 2 OUTRANGE signal is routed to DI Page 104 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 105 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 30 bu3416_getPostScans viStatus bu3416 getPostScans ViSession instrumentHandle ViInt32 scans Purpose This function returns the configured post trigger number of scans to collect Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session
165. t 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Table of Figures Figure 1 Removing the ProDAQ module Cover s sssssssssssssssrerrresserrrrrrnrnrenserrrrrrnnnnneeent 12 Figure 2 The ProDAQ module assembly AEN 14 Figure 3 Simplified Block Diagram eieiei geee re haa alan ala Nadia vaiainadtawalces 23 Figure 4 Analog front end circuitry Single Channel ccccceeeeeeeeeeeeneeeeeeeeeeeeteeeeeaeees 24 Figure 5 Selecting the Connection Method Ae 29 Figure 6 Specifying the Function Card Address AAA 30 Figure 7 ProDAQ 3416 Soft Front Panel Application ccccccceeeeeeeeeeeeeeeeeeeeeeeeeeeeenaeees 30 Figure 8 ChannehConliguralOni 4s icanasd vas AN CASAL anal AAA ena ae ages 31 Figure 9 Acquisition CONMMGUAUCM E 32 Figure 10 VXIplug amp play Driver Organization cceeeeeceeeceeeeeeeeeeeeeeeeenaeeeeeeeeeeeeeeeeeaaees 33 elt Opening a Sessio EE 34 Figure 12 Acquiring a Waveform ENEE 36 Figure 13 Starting the Asynchronous Acquisition ccceceeeeeeeeeeeeneeeeeeeeeeeeeeeeeeaeees 37 Figure 14 Checking the Status of the Acquisition and Data Head out 38 Figure 15 Front panel connector as seen when the card is fitted in the module 41 Copyright 2014 Bustec Production Ltd Page 7 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual Reference Documents Le RL Number O ProDAQ 3180 User Manual 3180
166. t bu3416_FC_MASTER 1 The Board operates as a Master in Multi Card operational mode bu3416_FC_SLAVE 2 The Board operates as a Slave in Multi Card operational mode startMode Variable Type ViInt16 This Parameter specifies the Start Mode of Data Acquisition DA Possible values are bu3416 DA START_IMM 0 Data Acquisition starts immediately after synchronization is done Default bu3416 DA START TRIG 1 Data Acquisition starts when Input Trigger goes active stopMode Variable Type ViInt16 This Parameter specifies the Stop Mode of Data Acquisition DA Possible values are bu3416 DA_STOP_COUNT 0 Data Acquisition stops when the specified number of samples has been collected Default bu3416 DA _STOP_TRIG 1 Data Acquisition stops when Input Trigger Stop Event happened bu3416 DA _STOP_GATE 2 DA stops when Trigger goes inactive bu3416 DA_STOP_UNLIM 3 Data Acquisition stops only when DAQ STOP command issued Page 142 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM stopOnError Variable Type VilInt16 This parameter specifies what kind of error will break data acquisition DA Possible values are bu3416 DA_STOP_ERR_OFF 0 Errors don t stop DA bu3416 DA _STOP_ERR_EXOFR 1 Any error excluding OUTRANGE stops DA bu3416 DA_STOP_ERR_ ANY 2 Any error stop DA Return Value Displays the return status of the function call If the function was successful it will return a status
167. t the auto find functionality will only inspect network resources that are known to the VISA library to avoid unwanted accesses of network resources that might be unintentionally reachable via the local network For VXlbus resources running the VISA resource manager prior to running the soft front panel application is necessary for both the auto find functionality to work and in general the access to the function card to be possible If Auto Find is selected the user will be presented with a dialog box showing all available ProDAQ 3416 function cards allowing the selection of one function card to connect to The soft front panel is not designed to handle more than one function card at a time If there is only one function card available the dialog box will not appear and the soft front panel application will automatically establish the communication to this instrument If no ProDAQ 3416 is available in your system the soft front panel application can be run in demo mode allowing to operate all controls as if connected to a 3416 Copyright 2014 Bustec Production Ltd Page 29 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual If Enter Address is selected the user is presented with a dialog box that allows entering the VISA resource string and the function card number directly Figure 6 Specifying the Function Card Address reg ADVANCED VXI DATA ACQUISITION SYSTEMS W ProDAQ 3416 SFP Enter Functi d Ad Instrument D
168. ta is stored into EEPROM it will be downloaded at every power up automatically to perform analog data correction Parameter List instrumentHandle Variable Type vViSessio n The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them channel Variable Type This parameter specifies for which be stored ViInt16 Possible values are bu3416_CHAN_1 bu3416 CHAN 2 bu3416_CHAN_3 bu3416 CHAN 4 bu3416_CHAN_5 bu3416 CHAN 6 bu3416_CHAN 7 bu3416_CHAN 8 bu3416_ CHAN 9 bu3416_ CHAN 10 bu3416_ CHAN 11 bu3416 CHAN 12 bu3416_ CHAN 13 bu3416 CHAN 14 bu3416_ CHAN 15 bu3416 CHAN 16 offset Variable Type This parameter will be stored gain Variable Type This parameter will be stored channel the calibration data will 1 Channel 1 2 Channel 2 3 Channel 3 4 Channel 4 5 Channel 5 6 Channel 6 7 Channel 7 8 Channel 8 9 Channel 9 10 Channel 10 11 Channel 11 12 Channel 12 13 Channel 13 14 Channel 14 15 Channel 15 16 Channel 16 ViUInt32 specifies the into on board viUInt32 specifies the into on board calibration coefficient Offset which EEPROM calibration coefficient Gain which EEPROM Page 166 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Retur
169. the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 100 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 28 bu3416_getMultFCsession viStatus bu3416 getMultFCsession ViSession instrumentHandle ViInt16 functionCardIndex ViSession FCInstrumentHandle Purpose This function returns the Instrument Handle for individual Function Card included into the Group This Handle can be used to customize some Function Card settings individually using Instrument Driver Functions not included into the Multi Card Acquisition sub class However those function should be used carefully as they can change Function Card settings important for synchronous operation mode Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the
170. this Handle will be used to differentiate between them frequencyHz Variable Type ViReal64 This parameter returns the actual sampling frequency what was set up for Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 107 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 32 bu3416_getSerNum ViStatus bu3416 getSerNum ViSession instrumentHandle ViInt32 serialNumber Purpose This function returns card s serial number Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them serialNumber Variable Type VilInt32 passed by reference Contains the serial numbe
171. tial Coupling DC Full Scale Signal Ranges 5 mV 10 mV 20 mV 50 mV 100 mV 200 mV 500 mV 1 V 2 V 5 V and 10 V plus 5 for hardware calibration and over range capability Gain Settings 1 2 5 10 20 50 100 200 500 1000 2000 Analog Input Filter Type 2 pole Butterworth Input Impedance gt 10 MQ 25 pF Input Protection 25 V Input Offset Voltage 30 uV typ gain 1 typical 6 uV typ gain 2000 80 uV typ Cx versions gain 1 gt 25 kS s Gain Error typ 0 002 gain 1 typical typ 0 05 gain 2000 typ 0 004 Cx versions gain 1 gt 25 kS s typ 0 1 Cx versions gain 2000 gt 25 kS s INL Best Fit Method 0 0003 FSR typ 0 0012 FSR max DC Accuracy 8 225 gain uV typ 20 600 gain uV max 25 800 gain uV max Cx gt 25 kS s Common mode Rejection Ratio 87 GB typ gain 1 106 GB typ gain 2000 0 1dB Analog Passband DC to 450 Hz Ax versions DC to4 5kHz Bx versions DC to 23 7 kHz Cx versions 3dB Analog Bandwidth fc DC to 490 Hz Ax versions DC to 4 9kHz Bx versions DC to 25 8 kHz Cx versions Pass Band Ripple 0 005 dB Stop Band Attenuation 95 dB min Signal to Noise Ratio 105 dB typ 97 7 Hz 1 dBrs Signal Noise And Distortion SINAD 100 GB typ Total Harmonic Distortion THD 102 dB typ 1 kHz 1 dBrs Spurious free Dynamic Range gt 103 dB Noise
172. tilized for storing information about that sensor The manufacturer of the sensor deposits into this memory initial information such as manufacturer name sensor type model number serial number and calibration data Memory space allocation permits the user to add additional information such as channel ID location position direction tag number etc The protocols and formats of the data are defined by IEEE P1451 4 standard The sensor operates in a mixed mode i e analog or digital fashion In the digital mode the information stored in memory is downloaded In the analog mode the sensor functions normally as a measurement device A suitable TEDS signal conditioner is used to access the memory digitally over the same wires ordinarily used for analog measurement signal transmission The 3416 card has a common TEDS reader interface circuitry for all sixteen channels It is brought to the front panel connector on a separate pin To provide a class 1 TEDS interface the TEDS line needs to be externally multiplexed onto any of analog input lines 3 4 C Master Interface The card contains an UC master which may be used to program an external signal conditioning unit via the two wire bus For this purpose the bus signals of the master controller are amplified and made available on separate pins on the front panel connector Page 24 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 3
173. tion inside the callback function to check for errors and bu3416_readAcquisition to read the data See the example AsynchAcquisition coming with the driver for a complete example how to use these functions Page 38 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM 6 5 Calibration The ProDAQ 3416 comes factory calibrated Yet to achieve the highest accuracy possible it is recommended to calibrate the ProDAQ 3416 before starting an acquisition by using the optional voltage reference which can be installed on ProDAQ motherboards and function card carriers To perform the calibration the driver provides the function bu3416_calibrateBoard The results of the run time calibration are stored on the card and used for further acquisitions by the gain and offset correction stage in the hardware but get lost again when the card is powered off If the motherboard or carrier housing the ProDAQ 3416 function card is not equipped with a voltage reference the function returns an error Please note that the calibrationyou will need to configure first the gain for the channels before calibrating Copyright 2014 Bustec Production Ltd Page 39 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual This page was intentionally left blank Page 40 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Appendix A Front panel Connector Th
174. tiple Function Card synchronization See description of Synch Mode control for more information This line will propagate common Clock signal Possible values are VI_TRIG_TTLO to VI_TRIG_TTL7 VI_TRIG ALL VXI Backplane TTL Trigger line will be selected automatically BPTrigSynch Variable Type VilInt16 This control allows to select the VXI Backplane TTL Trigger line if one should be used for Multiple Function Card synchronization See description of Synch Mode control for more information This line will propagate common Synch signal Possible values are VI_TRIG_TTLO to VI_TRIG_TTL7 Copyright 2014 Bustec Production Ltd Page 113 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual VI_TRIG ALL VXI Backplane TTL Trigger line will be selected automatically Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 114 of 171 Copyri
175. trigger 2 Select a source for the trigger Write 000 Output disabled high impedance 001 MB Trigger input B 010 SYNC pulses 011 reserved 100 reserved 101 OUTRANGE_ERR asserts trigger line 110 Pulse per Scan 111 Software assertion forced to active state Read Returns previously written value Note If FP trigger output 2 is selected as the SYNC source then FPTRG_2_LOW should be set for compatibility with other FCs FPTRIGO 3 Front Panel Output trigger 3 Select a source for the trigger Write 00 Output disabled high impedance 01 MB Trigger input A 10 MB Trigger input B 11 Software assertion forced to active state Read Returns previously written value DI Direct Interrupt Select a source for the interrupt line Write 00 Output disabled inactive 01 FIFO trigger flag programmable almost full PAF 10 OUTRANGE_ERR asserts DI line 11 Software assertion forced to active state Read Returns previously written value B 7 ITRI 0x6 Input Trigger Status Register This is the FC version register Readout from this register gives information about the PCB revision and the FPGA design revision Access amp Default Description Reserved CCLK Common clock input status This is a status of common clock input line Read 000 Input at a low level for at least last 10us 001 Input toggles at 2MHz 010 Input togg
176. u3416 GROUP_BY SCAN 1 Group data by scans For example If you scan channels A through C and Number of Scans is 5 then the possible fill modes are Grouped by channel Al A2 A3 A4 A5 B1 B2 B3 B4 B5 C1 C2 C3 C4 C5 or Grouped by scan Al B1 Cl A2 B2 C2 A3 B3 C3 A4 B4 C4 Ab B5 C5 Vol Kol el el kel If you are to pass the array to a graph you should acquire the data grouped by channel If you are to pass the array to a strip chart you should acquire the data grouped by scan Page 120 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM scanBacklog Variable Type VilInt32 passed by reference Returns the backlog of scans that have been acquired into the buffer but have not been read using bu3416 readAcquisition actualScansRead Variable Type ViInt32 passed by reference Returns the number of scans fetched from the function card and stored in the output buffer Each scan contains one sample per selected channel For instance if 3 channels were selected for Data Acquisition and number of scans is 1000 then 3000 samples will be stored in the output buffer waveforms Variable Type ViReal64 The output buffer containing the samples fetched from Function Card FIFO This buffer should be allocated by application before the function call with appropriate size to hold all data Samples in this buffer are arranged according to Fill Mode parameter Return Value If the
177. ues are 1 0 10000 0 1Hz 10 kHz Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 157 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 65 bu3416_setTrigConfig viStatus bu3416 setTrigConfig ViSession instrumentHandle ViInt16 source Purpose This function configures the Trigger for Data Acquisition Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them source Variable Type ViInt16 This parameter specifies what sources will be chosen for Data Acquisition DA Trigger The parameter is a bit mask so more than one source can be used at the same tim
178. ues are channel the calibration data will bu3416 CHAN 1 1 Channel 1 bu3416 CHAN 2 2 Channel 2 bu3416 CHAN 3 3 Channel 3 bu3416 CHAN 4 4 Channel 4 bu3416 CHAN 5 5 Channel 5 bu3416 CHAN 6 6 Channel 6 bu3416 CHAN 7 7 Channel 7 bu3416 CHAN 8 8 Channel 8 bu3416 CHAN 9 9 Channel 9 bu3416 CHAN 10 10 Channel 10 bu3416 CHAN 11 11 Channel 11 bu3416 CHAN 12 12 Channel 12 bu3416 CHAN 13 13 Channel 13 bu3416 CHAN 14 14 Channel 14 bu3416 CHAN 15 15 Channel 15 bu3416 CHAN 16 16 Channel 16 offset Variable Type ViUInt32 passed by reference This parameter returns the calibration coefficient Offset which was stored into on board EEPROM gain Variable Type ViUInt32 passed by reference This parameter returns the calibration coefficient Gain which was stored into on board EEPROM Page 88 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Erro
179. uisitionMode can be used to configure the card for the acquisition The parameter mask defines which channels should be enabled The parameter sampleRate defines the scan rate used in samples per second per channel The parameter scansToCollect can be used to limit the total amount of samples acquired If 0 zero is specified the acquisition will continue until stopped by using bu3416_stopAcquisition The parameter start mode specifies whether bu3416_startAcquisition shall start the acquisition immediately or whether it should wait for the start trigger see 6 3 Hardware Configuration Last not least the parameter stopOnError defines whether the data acquisition is stopped when an error occurs ViSession session ViStatus status ViInt16 mask TG ote configure the ProDAQ 3416 for continuous acquisition of channels 1 4 1000 Sa s ch start mode immediate and stop on all errors Kg mask 0x000f If status bu3416 setAcquisitionMode session mask 1000 0 1000000 bu3416 DA START IMM bu3416 DA STOP ERR _ANY lt VI_SUCCESS error handling Start the asynchronous acquisition as configured above Ki if status bu3416 startAcquisition session lt VI_SUCCESS error handling PERS ive TAY Figure 13 Starting the Asynchronous Acquisition To read out the acquired data at the right time the application needs to poll the status of the acquisition using th
180. ul it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Page 80 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 13 bu3416_error_query viStatus bu3416 error query ViSession instrumentHandle ViInt32 errorCode ViChar errorMessage Purpose This function queries the instrument for latest error code and error message NOTE this function is included for VXIplug amp play compatibility but is not supported by this instrument and the function always returns a VI_WARN_NSUP_ERROR_QUERY warning Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them errorCode Variable Type VilInt32 passed by reference Returns the result of the error query errorMessag
181. unction is called To close a session with the ProDAQ 3416 16 Ch Sigma Delta ADC function card the standard VXIplug amp play function bu3416_close must be used 6 3 Hardware Configuration The input multiplexer and gain stages on the ProDAQ 3416 function card are configured using the function bu3416_setChanConfig It takes as arguments the session to the instrument a channel number a selection for the input multiplexer and a value for the gain setting The channel number has to be an integer number in the range of 1 16 to select one of the channels or 0 for applying the configuration to all channels Predefined macros from the include file bu3416 h can be used bu3416 CHAN 1 tO bu3416 CHAN 16 Or bu3416 CHAN ALL The input multiplexer can be set to either connect the channel s input to the front panel connector or to the internal voltage reference bus The selection can be made by using an integer value of 0 front panel connector or 1 voltage reference bus or again by using a macro predefined in bu3416 h bu3416_CH_FP or bu3416 CH VREF The gain can be set in steps of 1 2 5 between 1 and 2000 by either using valid integer numbers 1 2 5 10 20 50 100 200 500 1000 2000 or by using the predefined macros bu3416 GAIN_1 tO bu3416 GAIN 2000 see Figure 12 If the acquisition shall be started by a hardware trigger the trigger used for this purpose can be selected by using the function bu3416_setTrigConfig The trigger can
182. urn a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between O0xBFFC0900 and OxBFFCOFFF Page 128 of 171 Copyright 2014 Bustec Production Ltd ProDAQ 3416 Function Card User Manual 3416 XX UM C 5 45 bu3416_resetDAQ ViStatus bu3416 resetDAQ ViSession instrumentHandle Purpose This function resets the Data Acquisition State Machine The reset doesn t change contents of the registers Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416 error message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and
183. vision Variable Type ViChar Because the instrument revision query function is not supported this control always returns the message Not Available Return Value Displays the return status of the function call If the function was successful it will return a status of VI_SUCCESS otherwise it will return an error code Passing the error code into the function bu3416_error_message will return a string describing the error VISA Errors See section 3 3 of the VPP 4 2 2 document for a complete list of the WIN Framework error codes and their values Appendix B of VPP 4 2 contains descriptions and a breakdown of the error codes returned by each of the VISA functions bu3416 Driver Errors Errors returned from the bu3416 drivers will be between 0xBFFC0900 and OxBFFCOFFF Copyright 2014 Bustec Production Ltd Page 133 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual C 5 50 bu3416_self_test viStatus bu3416 self _ test ViSession instrumentHandle ViInt16 testResult ViChar testMessage Purpose This function performs a self test on the instrument NOTE Self test is not supported by the hardware Parameter List instrumentHandle Variable Type ViSession The Instrument Handle is used to identify the unique session or communication channel between the driver and the instrument If more than one instrument of the same model type is used this Handle will be used to differentiate between them testResu
184. voltage reference option is installed on the motherboard or carrier selecting the voltage reference bus as input should be avoided The gain is selectable on a per channel basis between 1 and 2000 in steps of 1 2 and 5 The button Apply to all will apply the current tabs settings for input source gain and channel enable disable to all channels Copyright 2014 Bustec Production Ltd Page 31 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual 5 2 3 Acquisition Tab The Acquisition tab allows the user to specify the parameter for the acquisition started by the start or run button on the Waveform tab ProDAQ 3416 Soft Front Panel 192 168 168 63 ProDAQ 3416 24 bit Sigma Delta ADC Waveforms Channels Acquisition Acquisition r Trigger Source Motherboard Input Trigger A Waveform Length 1024 a put 1 ngg _ Motherboard Input Trigger B _ Front Panel Input Trigger 3 Sampling Rate _ Front Panel Input Trigger 3 low active Voltage Reference 0 0000Y DH Figure 9 Acquisition Configuration The Waveform Length parameter determines how many samples per channel will be acquired each time the start button is pressed The Sampling Rate selects the common sampling rate for all channels By default the acquisition starts immediately after the user presses the start or run button on the Waveform tab By select
185. y an ADC Figure 3 shows a block diagram of the analog front end circuitry for a single channel The input signal is first passed through an optional attenuator stage designed to allow for voltages of up to 60V For calibration purposes the input of every channel can be connected to the voltage reference bus available on ProDAQ motherboards and function card carriers via a 2 1 multiplexer The gain block consists of multiple stages providing gain factors of 1 2 5 10 20 50 100 200 500 1000 and 2000 independently software selectable on a per channel basis In the following ADC driver block a combined differential driver level shifter and Butterworth filter in MFB topology prepares the signal to be digitized by the 24 bit ADC available per channel Copyright 2014 Bustec Production Ltd Page 23 of 171 3416 XX UM ProDAQ 3416 Function Card User Manual 2 5V Gain Block Vref HV Attenuation 2 1 Mux LNF IN kd i i AD8253 Div2 IN Differential IN AD8250 ADC Driver AIN1P jme Attenuator IN t Level Shift AININ GE DN RC Filter From AIN2P VRef Eight Identical ADC Channels ADS1278 per ADC AIN8N Figure 4 Analog front end circuitry single channel 3 3 TEDS Reader Interface Transducer Electronic Data Sheet TEDS is a nonvolatile memory within a sensor that is u
Download Pdf Manuals
Related Search
Related Contents
Manuel d`instructions Outils d`assemblage de tuyauterie - Acklands CD-DVD Duplicator Guia Rápido Led 101 Kt Tutorial Cabri - Algo de mates Samsung Samsung GALAXY Fame 用戶手冊 ポータブルヘッドホンアンプ「SU-AX7」 (2014-5)4145KB Samsung SM-G800H راهنمای محصول Manuel d`utilisation Nokia X2-02 Programação Não Linear Copyright © All rights reserved.
Failed to retrieve file