Driver Software for Spectrometers - World PrecisionDriver Software for Spectrometers WORLD PRECISION...

Driver Software for Spectrometers

ADC500/PC1000, PCI1200, DAQCard700, DAQCard1200 and LabPCDrivers for Macintosh / Windows® 95, 98 and LabVIEW™ 4.x, 5.x

INSTRUCTION MANUAL

Serial No._____________________

08/00

World Precision Instruments, Inc.


WORLD PRECISION INSTRUMENTS 27

Copyright © 2000 by World Precision Instruments, Inc. All rights reserved. No partof this publication may be reproduced or translated into any language, in anyform, without prior written permission of World Precision Instruments, Inc.

PC1000 and ADC500 are trademarks of Ocean Optics, Inc. DAQCard700,DAQCard1200, NI-DAQ, PCI1200 and LabPC are trademarks of NationalInstruments Corp.

ContentsCreate your own LabVIEW-based application ................................. 1

ADC500, DAQCard700 and PC1000 Drivers ..................................... 2

Test front panel ............................................................................................ 4

Test.vi front panel ...................................................................................... 13

PCI1200, DAQCard700, DAQCard1200 and LabPC Drivers ............ 14

S/SD1000 and LabNB / LabPC+ /PCI-1200/ DAQPad1200 pinouts ........ 21

S/SD2000 and LabNB/LabPC/PCI-1200/ DAQCard1200 pinouts ............ 22

PS/PSD1000 and DAQCard-700 pinout .................................................... 23

S/SD2000 and DAQCard-700 pinout ........................................................ 24

Limited Warranty ............................................................................ 25



Create your own LabVIEW-basedapplication using these VIs from WPIThis software package supports both the 1000 and 2000 series spectrometers incombination with Ocean Optics or National Instruments A/D hardware: S1000 orS2000 series spectrometers with ADC500, DAQCard700, PCI1200, DAQCard1200,LabPC or PC1000 plug-in spectrometer. This manual is divided into two sections:“OOI” for Ocean Optics interface DLL and “NI” for NI-DAQ. Ocean Optics DLLsupports the Ocean Optics ADC500/PC1000 as well as the National InstrumentsDAQCard700 (without NI-DAQ). The NI-DAQ section supports PCI1200,DAQCard700 and DAQCard1200 on both the Macintosh and IBMcompatible PCs. LabPC is supported only on IBM compatible PCs. As you cansee, for DAQCard700, you have the option to use either NI-DAQ or the directaccess DLL method.

Note: Macintosh users will have to save the entire library (in NI folder) using the“Save with Options” into a new LLB file to “register” it as a LabVIEW file on theMacintosh desktop (convert from DOS format).

These VIs will initialize the hardware and configure it to acquire 1024/2048 CCDpixel values. Each pixel in the array represents a wavelength (which is notnecessarily an integer value). The increment between successive pixels’wavelength values depends on the optical bench’s grating. The match between theindex value and the wavelength is done using a VI called “CoeffToScale” whichtakes three values and creates an array of 1024/2048 wavelength values whichmatch the array of 1024/2048 physical pixels.

The VI named “Test” is a basic example program to show how to use thefunctions and VIs. Before you start using the VIs, take a look at the “Test.vi”diagram to see how the sub-VIs and the “call function library” are being used.Throughout the program, standard terminal connections are used.

We assume you are familiar with basics of spectrometry, LabVIEW, and yourcomputer. So we will not try to explain how to derive the Absorbance,Transmittance and other properties of optical systems, nor will we try to explainhow to program in LabVIEW. We will explain how to acquire a spectrum.

On-line help is available using the “Help” window.



ADC500, DAQCard700 and PC1000DriversThere two disks in this set. The first is for LabVIEW 4.x and the second is forLabVIEW 5.x. Please use only the disk appropriate for your version of LabVIEW.

For hardware setup and configuration please read the spectrometer manual. Youwill also find some information on ADC500/S2000/PC1000 hardware and theory ofoperation which will help you in writing your own LabVIEW code. We assume youselected an available base address and IRQ in your PC. You will need to use themin the software (default values are address=300H and IRQ=7 which on somecomputers is used by LPT2). make sure jumpers are set accordingly.

This package includes six files (copy them into a folder on your computer) :

ooidrv.dllctl3d32.dlldriverx.vxdregcfg.exelv_drv.llbreadme.txt

Move “ctl3d32.dll” and “driverx.vxd” into the system folder which is located insidethe Windows 95 folder. Do not keep a copy with the LabVIEW files !

Run “regcfg.exe” only once when this package is installed. This will modify theWindows 95 registry. Restart your computer!

In Windows 98, type REGSVR32 *.VXD or *.DLL to add a new file to the registry.For example: REGSVR32 DRIVERX.VXD

SPECTROMETER TYPE, BASE ADDRESS and IRQ information for the ADC500 orPC1000 ISA cards is stored in “ooidrv.ini”. This file is located in the Windows 95folder. After the first time you run this software, if it does not exist, it will becreated.

To open the VI double-click on the file named “lv_drv.llb”. Test VI is its top level VI.

The test VI is writen so every time you run it, the hardware configuration panelopens to make sure it has the correct information before the DLL is called. Youshould remove this feature or make it controlable by settin “cmd” to 0 andremoving the content of frames 3 and 4 of the main sequence.

You will control the spectrometer using an array of parameters which is passed tothe DLL. This DLL is made so every call to OOI_DoScan_Array is independent.



Every call has all the information needed to return a scan. Hardware parameters, ofcourse, have to be entered in the hardware configuration panel.

The only value in the array which does not generate a scan is the “cmd” valuewhich is a command value. Set this value to 1 if you want to view or modify thehardware parameters like base address, IRQ and spectrometer type. All othervalues in the array will affect the scan you read back from the spectrometer.

ooidrv32.dll should remain with lv_drv.llb. When running for the first time, ifLabVIEW asks you for this file, select it in the file dialog and click OK. Sometimes itdoes not work and you should cancel this operation, and then you should :

find the two “Call Library Function" in the “Test" VI.double click on “Call Library Function".click on “Browse" and locate this dll again.

Parameters:==========cmd - send a command to the driver :

0 - no specific command1 - display the setup dialog2 - return the status of the driver3 - test comunication with the driver

fdc - continuous strobe delay in msec (1000 series spectrometers ONLY)dsf - 1000 spectrometer : A/D rate in kHz.

2000 spectrometers : integration period in msec.boxcar - boxcar pixel smoothing width. 1 - no smoothing.average - number of spectra to average. 1 - no averaging.chan_ena_array - spectrometer channels enabled (out of 4 possible).

0 - channel disabled.1 - channel enabled.

scan_dark - enable an external light source for a scan0 - enable1 - do not enable

correct_dark - correct collected spectra for detector's dark signal0 - do not correct for dark.1 - correct for electrical dark signal.

extrig - triggereng mode0 - no external triggering.1 - external software triggering (all spectrometers)2 - external synchronization trigger mode (2000 spectrometers ONLY)3 - external hardware trigger mode (2000 spectrometers ONLY)

upper4chan - enable acquisition channels 5-8 (slave 4 through 7).



Test front panelSpectrometer is used to select spectrometer type. 1K (1024 pixels) for 1000series spectrometers and 2K (2048 pixels) for 2000 series spectrometers. Thisvalue here is used only for X scale generation.

Boxcar smooth is used to smooth displayed curves. Number specified is thenumber of pixels, on right and left of every pixel, averaged and then placedinstead of original pixel value

Average is used to set the number of scans for each spectrum displayed. This istime averaging.



Integ.Freq.

1000 series spectrometers : A/D rate [kHz] which is used to transfer and collectscans from spectrometer's CCD. Range is between 1 and 500 kHz.

Integration Period= 8,192 * A/D clock period

2000 series spectrometers : sets the CCD's integration period for its timing circuits.Range is between 6 and 60,000 mS.

Strobe (optional) is used for continuous strobe delay in msec. 1000 seriesspectrometers only !

Spectra is an array of 8192 intensity values for physical CCD pixels (0-4095).This array is used as a temporary storage for spectra read from all spectrometers(maximum of 4 spectrometers at one time).

X Scale is an array of 1024/2048 wavelength values for the 1024/2048 physicalCCD pixels. Calculated from spectrometer's calibration coefficients located ondata-sheet.



In the first frame, X scale information is calculated from he coefficients found onyour spectrometer's data sheet. Selection of spectrometer type, 1000 or 2000series, is used to generate 1024 or 2048 values.

NOTE: Third coefficient is not used.



Frame 2 initializes the parameter array. It is set for normal acquisition with oneexception. “cmd" is set to “1" - Disply the setup dialog. After you understand theway this VI works you should set this value here to “0" and remove the next twoframes.

In this frame you will initialize an array of 8192 elements. This array will be passedby reference to the DLL. The DLL will fill the eray with spectra values to be readback in this VI. Each spectrometer is assigned 2048 values. For 1000 seriesspectrometers, only the first 1024 values of the 2048 will be active. For example ifyou have 2000 spectrometer and set chan_ena0 and chan_ena1 as “1" to readmaster and first slave, data will be returned in the first 2048 elements for the masterand the next 2048 for the slave. For a 1000 spectrometer, data for the master willbe in first 1024 elements and data for slave will be in elements 2048-3072.



Frame 3 uses the Call Library Function to call the OOI_DoScan_Array function inthe ooidrv32.dll. This call here will display the hardware setup panel.



Frame 4 of main sequence sets the parameter array back to normal acquisitionmode. cmd is set to “0” for future calles to the DLL.



Frames 0, 1, 2 and 3 of loop monitor front panel changes for integration period,Average, Strobe and Boxcar values.

The coresponding parameters in array will be updated for future calls to the DLL.



Frame 4 in loop calles the OOI_DoScan_Array in OOIDRV32.DLL to scan thespectrometer. The spectra are returned in Spectra array.



Frame 5 of loop displays a combined spectra/wavelengths curve.

Note that this is a single curve display. To display multiple curves (master andslave spectrometers) use the “Build array” tool to combine individual spectra into amultiple spectra display. Make sure to get the correct sections of spectra array forthe spectrometers you enabled and combine them with the matching X scalearrays made of coefficients from spectrometer's data sheet.



We assume that you are using the right cable for your configuration or a cablemade according to the description in the next few pages, but if you want to use

On-line help is available on the different connections for each VI on the helpwindow (place your cursor on the different controls and indicators while the helpwindow is open). You can also get information on each VI when you choose “GetInfo” (first open the VI).

Test.vi front panelBoard ID # is the device number you select for the A/D board. You select ID #and configure the board in NI-DAQ. Default value is 1.



PCI1200, DAQCard700, DAQCard1200and LabPC Drivers

AI channel is the analog input channel used to transfer the CCD scan from thespectrometer to the computer. Default is chanel 0. Channel should be set to Bipolar-5 to +5V on DAQCard700 or Unipolar 0 to 10V on all other cards. ReferencedSingle Ended.

Integration period is the time period in which the CCD is “exposed” toincoming light. This value is in milliseconds and defaults to 100 mS. Minimum valuedepends on your spectrometer. Minimum of ~65 mS for 1K and a minimum of22mS for 2K spectrometers.

Average is the number of CCD scans taken and averaged to display onespectrum.

1K/2K CCD is the selection of your spectrometer’s CCD pixel number. 1000series spectrometers have a 1024 pixel CCD and 2000 series spectrometers havea 2048 pixels CCD.

DAQCard700? is the selection of your A/D card. Select NO if you have one of theother cards (PCI1200/LabPC/DAQCard1200).

AI ID, DO ID and DI ID are LabVIEW internal ID numbers to identify the analoginput, digital output and digital input signals.

X scale is an array of 2048 x scale values to match CCD pixels. Three coefficientsare used to map the wavelengths to CCD pixels. The three coefficients will befound on spectrometer’s data sheet.

Counter Count (1K spectrometers only) is an internal number to keep track ofthe spectrometer’s system clock value. There is a relationship between thespectrometer clock and integration period. An increase in one count of the countercorresponds to about 4 mS of integration period.

Before running this VI you will have to run NI-DAQ and assign the board an IDnumber. You will have to set, on some boards, the analog input to Unipolar, 0 to10V (except the DAQCard700 which is set to Bipolar -5 to +5V) - refferenced singleended. Digital port A has to be set as output and digital port B as input.



Frame 0 is a board reset and the “Stop” button initialization.

NOTE: Third coefficient is not used.



Frame 1 : initializing A/D board and spectrometer.

Board ID, AI channel and Integration period from Test front panel are used here.You can connect values from other sources.

2K spectrometers only :

Count 0 is the number of cycles from the internal clock, used, to generate thesystem square wave - twice the card’s maximum sampling rate. In this example thesystem clock is 2MHz/10=200KHz.

Count 1 is the number of cycles from clock 0, used, to generate the 1KHz squarewave for clock 2. In this example : 200KHz/200=1KHz. This is the 1mS resolutionfor integration period.

If your card’s maximum sampling rate is less than 100KHz and want to keep theintegration period in mS units, you need to calculate count 0 and count 1 togenerate 1 KHz at clock 1 output.



The system clock is in most cases twice the A/D card’s maximum sampling rate socount 0 has to be such that clock 0 generates a frequency equal or lower thantwice of your cards maximum sampling rate.

The integration period has a lower limit of 2048 times period of sampling clock. Inour example the system clock is 200KHz. Integration period will have to be greaterthan 2048 times 1/100KHz. In other words integration period has to be greater than20 mS.

For most applications the default values will suffice. If the light is to bright, you canuse filters to prevent the light from saturating the CCD.


The VI calculates spectrometer system clock’s count value and a Low/Highintegration cycle bit for a particular integration period.

Frame 2 : Creating 2048 x scale values from data sheet coefficients.



Frame 3 : the scan loop. frame 0 monitors for changes in integration period valueon the front panel.

2K spectrometers :

Integration period assumes clock 2 generates a 1KHz square wave. It is done inInit.vi and you do not have to do anything as long as you did not change count0and count1. DO ID and Counter Count are not used.

1K spectrometers :

This VI uses the last Counter Count value to set a new integration period. Whenincreasing the integration period by 1mS you will notice the value actualy changesby about 4mS. This is due to the dependancy on Counter Count value. Theacquisition frequency is half the frequency supplied to the spectrometer.

The Low/High switch changes the integration period according to :Scan integration period = 8,192 * acquisition clock periods (Low)



Frame 3 : the scan loop. frame 1 scans the spectrometer and displays aspectrum on the screen.

Collect VI receives the local variables for analog input, digital output and digitalinput ID numbers. These values are generated by Init.vi.

Average is the number of CCD scans for one spectrum display.

Timeout is set here to be three times the integration period. This value is importantin case there is a hardware problem. The card will usually wait for 1040/2048external conversion signals. If, for some reason these signals are not received, theVI will give control back to test.vi. for next loop execution.

Ext. Trigg will cause the software to wait for a +5V signal on pin 1 of DB9 beforetaking a scan




AutoCorrect is an optional dark current removal. Software will average andsubstract the value of few extra covered pixels, which are not part of the 1024active pixels, from all 1024 active pixels.

Frame 3,2 : optional strobing for 1K spectrometers only.

Normly not active, this frame will alow you to start or stop either single or multipleflahes per scan. Activate this frame only once with the right integration period,number of flashes and OFF/ON information. 1K spectrometers only !



S/SD1000 and LabNB / LabPC+ /PCI-1200/ DAQPad1200 pinoutsThe LabNB, PCI1200, LabPC+ and the DAQPad1200have the same pinouts. The following connections shouldbe done for either of them.

Connections between A/D card andspectrometer (D25)

1. ACH0 channel 0 for the S1000 or the masterspectrometer on the SD1000, pin 13 onDB25.

2. ACH1 channel 1 for the slave spectrometer onthe SD1000, pin 11 on DB25.

14. PA0 digital out (Enable),pin 2 on DB25

16. PA2 digital out (Low/High), pin 22 on DB25.

17. PA3 single flash enable to pin 20 on DB25.

40. EXTCONV* A/D timing. Pin 3 on DB25.

41. OUTB0 clock pulses to the spectrometer fortiming, pin 1 on DB25.

43. OUTB1 continuous flash pulses to pin 19 onDB25

49. +5V power supply to the spectrometer, pin 9on D25. This power current is fused onthe LabPC and LabNB so if thespectrometer does not seem to run,check this fuse.

9. AIGND A/D converter’s ground, pin 12 on DB25.

13. DGND digital ground, pin 7 on DB25.

Jumper pin 41 to pin 45 for continuous flashes.



S/SD2000 and LabNB/LabPC/PCI-1200/ DAQCard1200 pinoutsThe LabNB, PCI1200, LabPC and DAQCard1200 havethe same pinouts. The following connections should bedone for either of them.

Connections between A/D card andspectrometer (D25)

1. ACH0 channel 0 for the S2000 or the masterchannel on the SD2000, pin 1 on DB25.

2. ACH1 channel 1 for the slave spectrometer onthe SD2000, pin 2 on DB25.

9. AIGND Analog ground, pin 5 on DB25.

13. DGND digital ground, pin 9 on DB25.

14. PA0 strobe enable (S0) pin 24 on DB25.

15. PA1 mode (S1), pin 22 on DB25.

17. PA3 Enable scan, pin 25 on DB25

25. PB3 external trigger - to software pin 21 onDB25.

40. EXTCONV* A/D timing. Pin 10 on DB25.

41. OUTB0 spectrometer’s system clock, pin 11 onDB25.

46. OUTB2 scan integration period to pin 23 onDB25

49. +5V power supply to the spectrometer, pin 13on D25. The current is fused on mostcards. If spectrometer does not havepower check this fuse.

Jumper pin 41 to pin 45 and pin 43 to pin 48.



AIGND 1 2 AIGND

ACH0 3 4 ACH8

ACH1 5 6 ACH9

ACH2 7 8 ACH10

ACH3 9 10 ACH11

ACH4 11 12 ACH12

ACH5 13 14 ACH13

ACH6 15 16 ACH14

ACH7 17 18 ACH15

DGND 19 20 NC

NC 21 22 DIN0

DIN1 23 24 DIN2

DIN3 25 26 DIN4

DIN5 27 28 DIN6

DIN7 29 30 DOUT0

DOUT1 31 32 DOUT2

DOUT3 33 34 DOUT4

DOUT5 35 36 DOUT6

DOUT7 37 38 OUT1*

EXTINT* 39 40 EXTCONV*

OUT0 41 42 GATE0

OUT1 43 44 GATE1

CLK1 45 46 OUT2

GATE2 47 48 CLK2

VCC 49 50 DGND

PS/PSD1000 and DAQCard-700 pinoutPS1000/PSD1000 has a flat ribbon cable with connector to plug intoDAQCard-700. The operation of these drivers assumes you have theOceanOptics’ original box and cable.

ACH0 channel 0 for the S1000 or the master spectrometer onthe SD1000, pin 13 on DB25.

ACH1 channel 1 for the slave spectrometer on the SD1000, pin11 on DB25.

DOUT3 digital out (Enable), pin 2 on DB25

DOUT1 digital out (Low/High), pin 22 on DB25.

DOUT0 single flash enable to pin 20 on DB25.

EXTCONV* A/D timing. Pin 3 on DB25.

OUT1 clock pulses to the spectrometer for timing, pin 1 onDB25.

OUT2 continuous flash pulses to pin 19 on DB25.

+5V power supply to the spectrometer, pin 9 on DB25.

AIGND A/D converter’s ground, pin 12 on DB25.

DGND digital ground, pin 7 on DB25

Jumper pin 43 to pin 48 for continuous flashes.

Xenon flash lamp is connected to DB9 connector on spectrometer.

Pin 1 GND

Pin 5 single pulse (# of flashes = 1)

Pin 6 continuous pulses (# of flashes > 1)jumpered to pin 19 on DB25



AIGND 1 2 AIGND

ACH0 3 4 ACH8

ACH1 5 6 ACH9

ACH2 7 8 ACH10

ACH3 9 10 ACH11

ACH4 11 12 ACH12

ACH5 13 14 ACH13

ACH6 15 16 ACH14

ACH7 17 18 ACH15

DGND 19 20 NC

NC 21 22 DIN0

DIN1 23 24 DIN2

DIN3 25 26 DIN4

DIN5 27 28 DIN6

DIN7 29 30 DOUT0

DOUT1 31 32 DOUT2

DOUT3 33 34 DOUT4

DOUT5 35 36 DOUT6

DOUT7 37 38 OUT1*

EXTINT* 39 40 EXTCONV*

OUT0 41 42 GATE0

OUT1 43 44 GATE1

CLK1 45 46 OUT2

GATE2 47 48 CLK2

VCC 49 50 DGND

S/SD2000 and DAQCard-700 pinoutS2000/SD2000 has a flat ribbon cable with connector to plug intoDAQCard-700. The operation of these drivers assumes you have theOceanOptics’ original box and cable.

Connections between A/D card and spectrometer.

1. AIGND Analog ground.

3. ACH0 channel 0 for the S2000 or the master channel on theSD2000.

5. ACH1 channel 1 for the slave spectrometer on the SD2000.

19. DGND digital ground.

25. DIN3 external trigger - to software.

30. DOUT0 strobe enable, mode (S0).

31. DOUT1 mode (S1).

33. DOUT3 Enable scan.

40. EXTCONV* A/D timing pulses.

43. OUT1 spectrometer’s system clock.

46. OUT2 scan integration period.

49. +5V power supply to the spectrometer.

Table for mode selectionS1 S0 mode

L L 0,1 normal, software trigger

L H 0,1 normal, software trigger

H L 2, synchronization

H H 3, hardware trigger



Limited Warranty

Although WPI has tested the software and reviewed the documentation, WPImakes no warranty or representation, either express or implied, with respect to thissoftware, its quality, performance, merchantability, or fitness for a particularpurpose. This software is provided “as is,” without warranty of any kind. The entirerisk as to the quality and performance of the program is with the buyer and, shouldthe program prove defective, you and not WPI, assume the entire cost of allnecessary servicing, repair, or correction.

WPI does warrant to the original licensee that the disk on which the program isrecorded will be free from defects in materials and workmanship under normal useand service for a period of ninety (90) days from the date of delivery. WPI’s entireliability and your exclusive remedy shall be replacement of the disk not meetingWPI’s limited warranty and which is returned to WPI with a Return MerchandiseAuthorization (RMA) number obtained from a WPI customer service representative.If failure of the disk has resulted from accident, abuse, or misapplication of theproduct, then WPI shall have no responsibility to replace the disk under this limitedwarranty.

Neither WPI nor anyone else who has been involved in the creation, production, ordelivery of this program shall be liable for any direct, indirect, consequential, orincidental damages arising out of the use, the result of use, or inability to use thesoftware or its documentation.

World Precision Instruments, Inc.USA: International Trade Center, 175 Sarasota Center Boulevard, Sarasota FL 34240-9258 USA

Tel: 941-371-1003 • Fax: 941-377-5428 • E-mail: [email protected]: Astonbury Farm Business Centre • Aston, Stevenage, Hertfordshire SG2 7EG England • Tel: 01438-880025 • Fax: 01438-880026 • E-mail: [email protected]

Germany: Liegnitzer Str. 15, D-10999 Berlin, Germany • Tel: 030-6188845 • Fax: 030-6188670 • E-mail: [email protected]: 1-4-2-702 Naka-Meguro, Meguro, Tokyo 153, Japan • Tel: 03-3760-5050 • Fax: 03-3760-5055 • E-mail: [email protected]

Australia: P.O. Box 1191, Glen Waverley, Victoria 3150, Australia • Tel: (03) 9887-6262 • Fax: (03) 9887-9585 • E-mail: [email protected]

Date post:	14-Mar-2020
Category:	Documents
Upload:	others
View:	3 times
Download:	0 times

Driver Software for Spectrometers - World PrecisionDriver Software for Spectrometers WORLD PRECISION...

Documents