SeaBreezeWrapper.h

Go to the documentation of this file.

/***************************************************/
#ifndef SEABREEZE_WRAPPER_H
#define SEABREEZE_WRAPPER_H

#define SEABREEZE_API_VERSION "3.0.11"  
#define SEABREEZE_MAX_DEVICES 32        

#include "api/DllDecl.h"

#ifdef __cplusplus

namespace seabreeze {
    class Device;
}

class DLL_DECL SeaBreezeWrapper {
public:

    static SeaBreezeWrapper *getInstance();

    static void shutdown();

    // lifecycle
    int    openSpectrometer          (int index, int *errorCode);
    int    closeSpectrometer         (int index, int *errorCode);

    // metadata
    int    getModel                  (int index, int *errorCode, char *buf, int len);
    int    getSerialNumber           (int index, int *errorCode, char *buf, int len);

    // basic acquisitions
    void   setIntegrationTimeMicrosec(int index, int *errorCode, unsigned long integration_time_micros);
    int    getWavelengths            (int index, int *errorCode, double *wavelengths, int length);
    int    getFormattedSpectrum      (int index, int *errorCode, double* buffer, int buffer_length);
    int    getUnformattedSpectrum    (int index, int *errorCode, unsigned char *buffer, int buffer_length);
    int    getFormattedSpectrumLength(int index, int *errorCode);
    int    getUnformattedSpectrumLength(int index, int *errorCode);
    long   getMinIntegrationTimeMicrosec(int index, int *errorCode);
    long   getMaxIntegrationTimeMicrosec(int index, int *errorCode);
    int    getMaximumIntensity(int index, int *errorCode);

    // advanced features
    int    getElectricDarkPixelIndices(int index, int *errorCode, int *indices, int length);
    void   setTriggerMode            (int index, int *errorCode, int mode);
    void   setStrobeEnable           (int index, int *errorCode, unsigned char strobe_enable);
    void   setShutterOpen            (int index, int *errorCode, unsigned char opened);
    void   setContinuousStrobePeriodMicrosec(int index, int *errorCode, unsigned short strobe_id, unsigned long period_usec);
    void   setAcquisitionDelayMicrosec(int index, int *errorCode, unsigned long delay_usec);

    // Buffering features
    void   clearBuffer               (int index, int *errorCode);
    unsigned long getBufferElementCount(int index, int *errorCode);
    unsigned long getBufferCapacity  (int index, int *errorCode);
    unsigned long getBufferCapacityMaximum(int index, int *errorCode);
    unsigned long getBufferCapacityMinimum(int index, int *errorCode);
    void   setBufferCapacity         (int index, int *errorCode, unsigned long capacity);

    // EEPROM access
    int    readEEPROMSlot            (int index, int *errorCode, int slot_number, unsigned char *buffer, int buffer_length);
    int    writeEEPROMSlot           (int index, int *errorCode, int slot_number, unsigned char *buffer, int buffer_length);

    // irradiance calibration
    int    readIrradCalibration      (int index, int *errorCode, float *buffer, int buffer_length);
    int    writeIrradCalibration     (int index, int *errorCode, float *buffer, int buffer_length);
    int    hasIrradCollectionArea    (int index, int *errorCode);
    float  readIrradCollectionArea   (int index, int *errorCode);
    void   writeIrradCollectionArea  (int index, int *errorCode, float area);

    // thermal-electric cooler
    double readTECTemperature        (int index, int *errorCode);
    void   setTECTemperature         (int index, int *errorCode, double temperature_degrees_celsius);
    void   setTECEnable              (int index, int *errorCode, unsigned char tec_enable);
    void   setTECFanEnable           (int index, int *errorCode, unsigned char tec_fan_enable);

    // Wrapper features
    void   setVerbose                (bool flag);
    void   setLogfile                (char *path, int length);
    int    getAPIVersionString       (char *buffer, int length);
    int    getErrorString            (int errorCode, char *buffer, int buffer_length);

    // raw USB access
    int    writeUSB                  (int index, int *errorCode, unsigned char endpoint, unsigned char *buffer, unsigned int length);
    int    readUSB                   (int index, int *errorCode, unsigned char endpoint, unsigned char *buffer, unsigned int length);
    int    getUSBDescriptorString    (int index, int *errorCode, int id, unsigned char *buffer, int length);

    // light sources (JAZ?)
    int    getLightSourceCount       (int index, int *errorCode);
    void   setLightSourceEnable      (int index, int *errorCode, int lightIndex, unsigned char enable);
    void   setLightSourceIntensity   (int index, int *errorCode, int lightIndex, double intensity);

private:
    SeaBreezeWrapper();
    virtual ~SeaBreezeWrapper();

    static SeaBreezeWrapper *instance;

    seabreeze::Device *devices[SEABREEZE_MAX_DEVICES];
};

extern "C" {
#endif /* __cplusplus */

    /* All of these C functions start with seabreeze_ to prevent namespace
     * collisions.
     */

    DLL_DECL int
    seabreeze_open_spectrometer(int index, int *error_code);

    DLL_DECL int
    seabreeze_close_spectrometer(int index, int *error_code);

    DLL_DECL int
    seabreeze_get_error_string(int error_code, char *buffer, int buffer_length);

    DLL_DECL int
    seabreeze_get_model(int index, int *error_code, char *buffer, int buffer_length);

    DLL_DECL void
    seabreeze_set_trigger_mode(int index, int *error_code, int mode);

    DLL_DECL void
    seabreeze_set_integration_time_microsec(int index, int *error_code,
            unsigned long integration_time_micros);

    DLL_DECL long
    seabreeze_get_min_integration_time_microsec(int index, int *error_code);

    DLL_DECL void
    seabreeze_set_shutter_open(int index, int *error_code, unsigned char opened);

    DLL_DECL void
    seabreeze_set_strobe_enable(int index, int *error_code, unsigned char strobe_enable);

    DLL_DECL int
    seabreeze_get_light_source_count(int index, int *error_code);

    DLL_DECL void
    seabreeze_set_light_source_enable(int index, int *error_code,
            int light_index, unsigned char enable);

    DLL_DECL void
    seabreeze_set_light_source_intensity(int index, int *error_code,
            int light_index, double intensity);

    DLL_DECL int
    seabreeze_read_eeprom_slot(int index, int *error_code, int slot_number, unsigned char *buffer,
            int buffer_length);

    DLL_DECL int
    seabreeze_write_eeprom_slot(int index, int *error_code, int slot_number, unsigned char *buffer,
            int buffer_length);

    DLL_DECL int
    seabreeze_read_irrad_calibration(int index, int *error_code, float *buffer,
        int buffer_length);

    DLL_DECL int
    seabreeze_write_irrad_calibration(int index, int *error_code, float *buffer,
        int buffer_length);

    DLL_DECL int
    seabreeze_has_irrad_collection_area(int index, int *error_code);

    DLL_DECL float
    seabreeze_read_irrad_collection_area(int index, int *error_code);

    DLL_DECL void
    seabreeze_write_irrad_collection_area(int index, int *error_code, float area);

    DLL_DECL double
    seabreeze_read_tec_temperature(int index, int *error_code);

    DLL_DECL void
    seabreeze_set_tec_temperature(int index, int *error_code,
            double temperature_degrees_celsius);

    DLL_DECL void
    seabreeze_set_tec_enable(int index, int *error_code, unsigned char tec_enable);

    DLL_DECL void
    seabreeze_set_tec_fan_enable(int index, int *error_code, unsigned char tec_fan_enable);

    DLL_DECL int
    seabreeze_get_unformatted_spectrum(int index, int *error_code,
            unsigned char *buffer, int buffer_length);

    DLL_DECL int
    seabreeze_get_formatted_spectrum(int index, int *error_code,
            double* buffer, int buffer_length);

    DLL_DECL int
    seabreeze_get_unformatted_spectrum_length(int index, int *error_code);

    DLL_DECL int
    seabreeze_get_formatted_spectrum_length(int index, int *error_code);

    DLL_DECL int
    seabreeze_get_wavelengths(int index, int *error_code, double *wavelengths, int length);

    DLL_DECL int
    seabreeze_get_serial_number(int index, int *error_code, char *buffer, int buffer_length);

    DLL_DECL int
    seabreeze_get_electric_dark_pixel_indices(int index, int *error_code,
        int *indices, int length);

    DLL_DECL void
    seabreeze_shutdown();

    DLL_DECL int
    seabreeze_write_usb(int index, int *errorCode, unsigned char endpoint, unsigned char* buffer, unsigned int length);

    DLL_DECL int
    seabreeze_read_usb(int index, int *errorCode, unsigned char endpoint, unsigned char* buffer, unsigned int length);

    DLL_DECL int
    seabreeze_get_api_version_string(char *buffer, int len);

    DLL_DECL int
    seabreeze_get_usb_descriptor_string(int index, int *errorCode, int id, unsigned char *buffer, int len);

    DLL_DECL void
    seabreeze_set_continuous_strobe_period_microsec(int index, int *errorCode,
        unsigned short strobe_id, unsigned long period_usec);

    DLL_DECL void
    seabreeze_set_acquisition_delay_microsec(int index,
        int *errorCode, unsigned long delay_usec);

    DLL_DECL void
    seabreeze_clear_buffer(int index, int *error_code);

    DLL_DECL unsigned long
    seabreeze_get_buffer_element_count(int index, int *error_code);

    DLL_DECL unsigned long
    seabreeze_get_buffer_capacity(int index, int *error_code);

    DLL_DECL unsigned long
    seabreeze_get_buffer_capacity_maximum(int index, int *error_code);

    DLL_DECL unsigned long
    seabreeze_get_buffer_capacity_minimum(int index, int *error_code);

    DLL_DECL void
    seabreeze_set_buffer_capacity(int index, int *error_code, unsigned long capacity);

    DLL_DECL void
    seabreeze_set_verbose(int flag);

    DLL_DECL void
    seabreeze_set_logfile(char* pathname, int len);

#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* SEABREEZE_WRAPPER_H */