NetOceanDirectLighthouse  3.1.1
OceanDirect Lighthouse .NET API
NETOceanDirect API

Overview

OceanDirect is a minimalistic, multi-platform (Windows, Linux) device driver for Ocean Optics spectrometers, designed specifically for embedded applications needing to run in resource-constrained hardware environments. OceanDirect provides a fully working and tested REFERENCE IMPLEMENTATION of the Ocean Optics USB and Ethernet interface, demonstrating how Ocean Optics spectrometers can be commanded and controlled from C/C++/Python/NET/MatLab.

Note this detailed documentation is for the OceanDirect C++/CLI interface but mimics the dotNET Framework in method signature and argument types.

Distribution Contents

    OceanConnect-x.xx/  The driver and key components
        doc/            Documentation relating to OceanDirect and its API
        include/        headers for building OceanDirect
        lib/            exportable headers for client applications
        distribution/   helpers for specific operating systems
                        linux: provides udev rules allowing non-root users to claim devices
                        windows: provides working Visual Studio 2017 solutions
        test/           command-line tests, including C/MATLAB/Python examples

Generated Documentation

NetOceanDirect documentation is now maintained in Doxygen format, and can be rendered as HTML, RTF (MS Word), Unix 'man' pages, or other styles. For convenience, pre-rendered documentation is generated for each customer release (RTF, converted to Microsoft .docx) which may be found in the ./doc directory.

Windows

Dependencies

  • oceandirect.lib

It is necessary to put NetOceanDirect.dll into your library path to run any programs against this driver.

Test programs in the 'test' directory should be built alongside NetOceanDirect and can be used as starting points for new development. As long as the libraries are in the appropiate Windows path variable.

Testing OceanDirect

Some test programs are provided with NetOceanDirect. Note that many of them are intended for use with a copy of OceanDirect.

Release Notes

See revision_change-log.txt