OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
lhdefs.h File Reference
#include "lighthouse/api/LighthouseDllDecl.h"
#include <cstdint>
#include <cstddef>

Go to the source code of this file.

Classes

struct  lh_network_configuration_t
 
struct  lh_spectrum_with_metadata_t
 

Typedefs

typedef uint32_t lh_autonull_baseline_t
 
typedef uint32_t lh_autonull_fpga_digital_t
 
typedef uint32_t lh_autonull_saturation_t
 
typedef uint16_t lh_boxcar_width_t
 
typedef float lh_celcius_t
 
typedef const uint8_t * lh_const_mac_address_array_t
 
typedef uint32_t lh_device_id_t
 
typedef int32_t lh_error_code_t
 
typedef uint32_t lh_gpio_bitmask_t
 
typedef uint32_t lh_gpio_directions_t
 
typedef uint32_t lh_gpio_values_t
 
typedef uint8_t * lh_ipv4_address_array_t
 
typedef uint8_t * lh_mac_address_array_t
 
typedef uint16_t lh_microns_t
 
typedef uint32_t lh_microseconds_t
 
typedef uint32_t lh_milliseconds_t
 
typedef uint16_t lh_pixel_index_t
 
typedef uint32_t lh_pixel_intensity_t
 
typedef uint32_t lh_scan_averaging_t
 
typedef uint16_t lh_usb_identifier_t
 

Enumerations

enum  lh_baud_rate_t : uint32_t {
  B300 = 300 , B600 = 600 , B1200 = 1200 , B2400 = 2400 ,
  B9600 = 9600 , B14400 = 14400 , B19200 = 19200 , B38400 = 38400 ,
  B57600 = 57600 , B115200 = 115200
}
 
enum  lh_enable_state_t { off = 0x00 , on = 0x01 }
 
enum  lh_ip_assign_mode_t { manual = 0x01 , automatic = 0x02 }
 
enum  lh_open_state_t { closed = 0x00 , open = 0x01 }
 
enum  lh_serial_comms_mode_t { rs232 = 0x10 , uart = 0x20 }
 
enum  lh_trigger_mode_t { software = 0x00000000 , edge = 0x00000001 , level = 0x00000002 }
 

Typedef Documentation

◆ lh_autonull_baseline_t

typedef uint32_t lh_autonull_baseline_t

The type used for setting/retrieving the Autonulling baseline level.

◆ lh_autonull_fpga_digital_t

typedef uint32_t lh_autonull_fpga_digital_t

The type used for setting/retrieving the Autonulling FPGA digital gain/offset.

◆ lh_autonull_saturation_t

typedef uint32_t lh_autonull_saturation_t

The type used for setting/retrieving the Autonulling saturation level.

◆ lh_boxcar_width_t

typedef uint16_t lh_boxcar_width_t

The type for setting/retrieving the boxcar width

◆ lh_celcius_t

typedef float lh_celcius_t

The units of all temperature-related functions are degrees Celcius represented as a float.

◆ lh_const_mac_address_array_t

typedef const uint8_t* lh_const_mac_address_array_t

◆ lh_device_id_t

typedef uint32_t lh_device_id_t

The device identifier type returned by getDeviceIDs, used to uniquely identify individual spectrometers in API calls.

◆ lh_error_code_t

typedef int32_t lh_error_code_t

The error code type returned by most API functions.

◆ lh_gpio_bitmask_t

typedef uint32_t lh_gpio_bitmask_t

The type for specifying the GPIO bitmask for pin directions (in/out) and values (high/low)

◆ lh_gpio_directions_t

typedef uint32_t lh_gpio_directions_t

The type used for setting/retrieving the GPIO pin directions

◆ lh_gpio_values_t

typedef uint32_t lh_gpio_values_t

The type used for setting/retrieving the GPIO pin values.

◆ lh_ipv4_address_array_t

typedef uint8_t* lh_ipv4_address_array_t

IPv4 address type, expected to be 4 unsigned 8-bit integers.

◆ lh_mac_address_array_t

typedef uint8_t* lh_mac_address_array_t

MAC address type, expected to be 6 unsigned 8-bit integers.

◆ lh_microns_t

typedef uint16_t lh_microns_t

Where units of size are measured in microns they are represented as an unsigned 16-bit integer.

◆ lh_microseconds_t

typedef uint32_t lh_microseconds_t

The units of most time-related functions are microseconds, represented as an unsigned 32-bit integer.

◆ lh_milliseconds_t

typedef uint32_t lh_milliseconds_t

◆ lh_pixel_index_t

typedef uint16_t lh_pixel_index_t

The type used to specify pixel indices

◆ lh_pixel_intensity_t

typedef uint32_t lh_pixel_intensity_t

The (integer) type used to represent a pixel's ADC intensity. Note this is different to the floating point type used when returning a spectrum.

◆ lh_scan_averaging_t

typedef uint32_t lh_scan_averaging_t

The type for setting/retrieving the scans to average parameter.

◆ lh_usb_identifier_t

typedef uint16_t lh_usb_identifier_t

The type used for setting/retrieving USB vendor and product identifiers

Enumeration Type Documentation

◆ lh_baud_rate_t

enum lh_baud_rate_t : uint32_t

The type used for setting/retrieving baud rates.

Enumerator
B300 
B600 
B1200 
B2400 
B9600 
B14400 
B19200 
B38400 
B57600 
B115200 

◆ lh_enable_state_t

Some functionality is either enabled or disabled e.g. nonlinearity and electric dark correction. This enum makes the state explicitly either off or on.

Enumerator
off 
on 

◆ lh_ip_assign_mode_t

The IP address of network-enabled devices is either manually or automatically (DHCP) assigned. This enum makes the state explicitly either manual or automatic.

Enumerator
manual 
automatic 

◆ lh_open_state_t

Some device states are either closed open i.e. a shutter. This enum makes the state explicitly either closed or open.

Enumerator
closed 
open 

◆ lh_serial_comms_mode_t

The serial comms mode may be either RS-232 or UART.

Enumerator
rs232 
uart 

◆ lh_trigger_mode_t

Device trigger modes may be either software, (hardware) rising edge or (hardware) level triggered. This enum makes the values explicitly either software, rising edge or level.

Enumerator
software 
edge 
level