Ocean Optics OmniDriver User Manual

OmniDriver Installation

We here at Ocean Optics want you to know that we appreciate your business. To speak to a Technical Support
representative or an Ocean Optics Applications Scientist, please call [phone]. Our office hours are
8 a.m.– 8 p.m. (Mon-Thu), 8 a.m.– 6 p.m . (F ri ) ES T.

Overview

OmniDriver can be downloaded from the Ocean Opt i cs website, or retrieved from the CD that you received with
your purchase of the software. In either case, you will need the password to complete the installation process. If you
have a CD with the OmniDriver software, the password is located on the back of the CD jacket.

Once you have installed the software, you’ll want to verify your installation, look at the javadocs provided to get an
idea of how the objects and methods for OmniDriver are organized, and then run a sample program.

When the installation process is finished, the following subdirectories will be created beneath the OmniDriver home
directory:

Subdirectory Contents

docs Main documentation area

docs\OmniDriver Javadocs for OmniDriver library functions

docs\SPAM Javadocs for SPAM library functions

include Header files for use with C/C++ application development

LabVIEW *.llb libraries and *.vi files to make the OmniDriver functions available to LabVIEW

applications

OOI_HOME The DLL, LIB, and JAR files which make up the OmniDriver and SPAM libraries

This directory also contains the Linux *.so files and the MacOSX *.dylib files.

redistribution Windows USB driver and device information files. Linux “rules” file.

samples All working sample applications which demonstrate how to use OmniDriver. The

samples are grouped by language. Refer to the “Sample Programs” chapter for a
list of all available samples.

VisualBasic6_Declarations

OmniDriver.bas file for inclusion in VB6 applications that need to use the “C”

interface to the functions in the OmniDriver DLL.

Once you have installed the software, you’ll want to verify your installation, look at the javadocs provided to get an
idea of how the objects and methods for OmniDriver are organized, and then run a sample program.

Downloading from the Ocean Optics Website

Installing on a Windows XP Platform XP

There are no issues unique to XP. The installer, named “OmniDrive rSPAM_yyyy.mm.dd_Win32.exe” should run
successfully on this platform. Simple download this file and double-click on it in Windows Explorer to begin the
installation procedure. The installer will guide you through the install process.

► Procedure

1. Start Internet Explorer.

000-20000-400-01-0109 1

OmniDriver Installation Instructions

2. Browse to http://www.oceanoptics.com/technical/softwaredownloads.asp.

3. Select the OmniDriver software appropriate for your operating system.

4. Double-click on OmniDriverSPAM_yyyy.mm.dd_Win32.exe installer and enter the password you
received when you purchased the software. The installer wizard guides you through the installation process.

5. After you have finished installing OmniDriver, you must also install Java on your PC. See
for details on how to install the required version of Java.

6. After OmniDriver and Java have been installed, you should run the OmniDoctor application to verify that
everything has been installed successfully. If OmniDriver has not been installed correctly, your
OmniDriver applications will not run properly and it may be difficult to diagnose the cause of the failure.
See

Running the OmniDoctor Verification Utility.

Installing Java

Installing on a Windows Vista Platform

You can use the install wizard “OmniDriverSPAM_yyyy.mm.dd_Win32.exe” to install OmniDriver under Windows
Vista (32-bit edition only). However, you must run it in Windows XP Compatibility mode and it must be run in
Console mode; you must be logged into an account that has Administrative privileges.

Caution

If you attempt to run the installer “normally” (i.e., without foll ow ing the steps given below),
you will encounter one or both of the following error conditions:

▪ A popup window will appear telling you the installer is unable to run in

graphical mode, or

▪ The installer will report that the total number of bytes to be installed is 0 KB.

► Procedure

To set the compatibility mode for the installer, follow these steps:

1. Ensure that you are logged on with administrative privileges. You do not need to log on to the
Administrator account, but whatever account you do log in with, it must have administrative privileges.

2. Locate the installer EXE file using Windows Explorer.

3. Right-click on the installer EXE file and choose Properties.

4. Click on the Compatibility tab.

5. Check the box labeled run this program in compatibility mode.

6. Choose Windows XP from the drop-down list box.

7. Click OK.

8. After you have finished installing OmniDriver, you must also install Java on your PC. See
for details on how to install the required version of Java.

9. After OmniDriver and Java have been installed, you can run the OmniDoctor application to verify that
everything has been installed successfully. If OmniDriver has not been installed correctly, your
OmniDriver applications will not run properly and it may be difficult to diagnose the cause of the failure.
See

Running the OmniDoctor Verification Utility.

Installing Java

Installing on a Windows 2000 Platform

The OmniDriver installer does not work under Windows 2000. Follow the steps below to manually install
OmniDriver on your PC.

2 000-20000-400-01-0109