AxsunOCTControl_LW_C.h

Go to the documentation of this file.

// AxsunOCTControl_LW_C.h
// Copyright 2023 Excelitas Technologies
 
#ifndef AXSUNOCTCONTROLLW_C_H
#define AXSUNOCTCONTROLLW_C_H
 
#include "AxsunCommonEnums.h"
 
#ifdef __cplusplus
#include <cstdint>
extern "C" {
#else
#include <stdint.h>
#endif // __cplusplus
 
typedef enum
#ifdef __cplusplus
class
#endif // __cplusplus
AxConnectionType {
    NONE = 0,
    USB = 1,                    
    RS232_PASSTHROUGH = 2,      
    RS232 = 3,                  
    ETHERNET = 4                
} AxConnectionType;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxDevType {
    UNDEFINED = 0,
    LASER = 40,         
    CLDAQ = 41,         
    EDAQ = 42,          
    AZMYTH_LASER = 43   
} AxDevType;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxTECState {
    TEC_UNINITIALIZED = 0,          
    WARMING_UP = 1,                 
    WAITING_IN_RANGE = 2,           
    READY = 3,                      
    NOT_INSTALLED = 5,              
    ERROR_NEVER_GOT_TO_READY = 16,  
    ERROR_WENT_OUT_OF_RANGE = 17,   
    TEC_STATE_UNAVAILABLE = 99
} AxTECState;
 
typedef enum
#ifdef __cplusplus
class
#endif // __cplusplus
AxPowerUpBehavior {
    BEHAVIOR_UNAVAILABLE = 0,
    OFF_AT_POWER_UP = 1,            
    ON_AT_POWER_UP = 2,             
    USE_DIGITAL_INPUT = 3,          
    LINK_TO_SWEPT_LASER = 4,        
    BEHAVIOR_RFU = 5
} AxPowerUpBehavior;
 
typedef enum
#ifdef __cplusplus
class
#endif // __cplusplus
AxNamedDataType {
    UNINIT_TYPE = 0,                
    INTEGER_TYPE = 1,               
    BOOL_TYPE = 2,                  
    SINGLE_TYPE = 3                 
} AxNamedDataType;
 
typedef uint32_t AxDeviceHandle;
 
struct AxDeviceInfo {
    AxDevType device_type;              
    AxConnectionType connection_type;   
    char serial_number[40];             
    char firmware_version[16];          
    char FPGA_version[16];              
    AxDeviceHandle handle;              
};
typedef struct AxDeviceInfo AxDeviceInfo;
 
#ifndef __cplusplus
#include <stdbool.h>
#endif // !__cplusplus
union AxNamedDataValue {
    uint32_t u;
    int32_t i;
    bool b;
    float f;
};
typedef union AxNamedDataValue AxNamedDataValue;
 
typedef void(__cdecl *AxConnectCallbackFunctionC_t)(void*);
 
typedef void(__cdecl* AxCallbackConnectOrDisconnect_t)(AxDeviceInfo, int32_t, void*);
 
 
 AXSUN_EXPORTS 
AxErr __cdecl axOpenAxsunOCTControl(uint32_t open_all_interfaces);
 
 AXSUN_EXPORTS 
AxErr __cdecl axCloseAxsunOCTControl();
 
 AXSUN_EXPORTS 
uint32_t __cdecl axCountConnectedDevices();
 
 AXSUN_EXPORTS 
void __cdecl axGetErrorExplained(AxErr errornum, char* error_string);
 
 AXSUN_EXPORTS 
AxErr __cdecl axUSBInterfaceOpen(uint32_t interface_status);
 
 AXSUN_EXPORTS 
AxErr __cdecl axNetworkInterfaceOpen(uint32_t interface_status);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSerialInterfaceOpen(uint32_t interface_status, const char* port);
 
 AXSUN_EXPORTS 
AxErr __cdecl axLibraryVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t* build);
 
 AXSUN_EXPORTS 
const char* axLWLibVersion();
 
 AXSUN_EXPORTS 
int32_t __cdecl axGetLWBuildDateTime(char* datetime_str);
 
 AXSUN_EXPORTS 
const char* axLWBuildDateTime();
 
 AXSUN_EXPORTS 
int32_t __cdecl axGetLWBuildCfg();
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetLibusbVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t* build);
 
 AXSUN_EXPORTS 
AxErr __cdecl axRegisterConnectCallback(AxConnectCallbackFunctionC_t callback_function, void* userData);
 
 AXSUN_EXPORTS 
AxErr __cdecl axRegCallbackConnectOnly(AxCallbackConnectOrDisconnect_t callback_function, void* userData);
 
 AXSUN_EXPORTS 
AxErr __cdecl axRegCallbackDisconnectOnly(AxCallbackConnectOrDisconnect_t callback_function, void* userData);
 
 AXSUN_EXPORTS 
AxErr __cdecl axRegisterLabVIEWCallback(uint32_t* refnumptr);
 
 
 
 
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetDeviceHandle(AxDeviceHandle* handle, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axFirmwareVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axFPGAVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t* build, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axDeviceType(AxDevType* device_type, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSerialNumber(char* serial_number, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axPartNumber(char* part_number, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axConnectionType(AxConnectionType* connection_type, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetDeviceInfo(AxDeviceInfo* device_info, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetNamedData(uint32_t named_index, AxNamedDataType* named_type, AxNamedDataValue* named_value, char* field_name, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetNamedData(uint32_t named_index, AxNamedDataType named_type, AxNamedDataValue named_value, const char* field_name, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axClearNamedData(uint32_t named_index, uint32_t which_device);
 
 AXSUN_EXPORTS 
AxErr __cdecl axClearAllNamedData(uint32_t which_device);
 
 
 
 
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetLaserEmission(uint32_t emission_state, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetLaserEmission(uint32_t* emitting, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axSetPointerEmission(uint32_t emission_state, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetPointerEmission(uint32_t* emitting, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axSetLaserPowerUp(AxPowerUpBehavior behavior, uint32_t which_laser);
 
 AXSUN_EXPORTS 
    AxErr __cdecl axGetLaserPowerUp(AxPowerUpBehavior* behavior, uint32_t which_laser);
 
 AXSUN_EXPORTS 
    AxErr __cdecl axSetPointerPowerUp(AxPowerUpBehavior behavior, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetPointerPowerUp(AxPowerUpBehavior* behavior, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axSetClockDelay(uint32_t delay_code, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetClockDelay(uint32_t* delay_code, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axSetDriveConfiguration(uint32_t which_config, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetDriveConfiguration(uint32_t* current_configuration, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetElapsedTimers(uint32_t* cum_emission_sec, uint32_t* cum_system_sec, uint32_t* uptime_msec, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetTECState(AxTECState* TEC_state, uint32_t which_TEC, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetLaserErrorState(uint32_t* error_bitfield, uint32_t which_laser);
 
 AXSUN_EXPORTS 
 AxErr __cdecl axGetLaserDiagnostics(uint32_t* num_of_values, float* values, char** names, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axHomeVDL(uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axStopVDL(uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axMoveRelVDL(float rel_position, float speed, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axMoveAbsVDL(float abs_position, float speed, uint32_t which_laser);
 
 AXSUN_EXPORTS 
     AxErr __cdecl axGetVDLStatus(float* current_pos, float* target_pos, float* speed,
         int32_t* error_from_last_home, uint32_t* last_move_time,
         uint8_t* state, uint8_t* home_switch, uint8_t* limit_switch, uint8_t* VDL_error, uint32_t which_laser);
 
 
 
 
 
 AXSUN_EXPORTS 
AxErr __cdecl axImagingCntrlEthernet(int16_t number_of_images, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetImageSyncSource(AxEdgeSource source, float frequency, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetBurstRecordSource(AxEdgeSource source, AxRcrdTrigBehavior behavior, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetSampleClockSource(AxEdgeSource source, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetSweepTriggerSource(AxEdgeSource source, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetSwpTrigSrcAndEdge(AxEdgeSource source, AxSwpTrgMode trig_edge, uint32_t trig_freq_Hz, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetPipelineMode(AxPipelineMode pipeline_mode, AxChannelMode polarization_mode, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetEightBitGain(float gain, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetEightBitOffset(float offset, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetSubsamplingFactor(uint8_t subsampling_factor, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetFPGARegister(const uint32_t regnum, uint16_t* regval, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetFPGARegisterRange(const uint32_t start_regnum, const uint32_t end_regnum, uint16_t* regvals, const uint32_t bytes_allocated, uint32_t which_DAQ);
 
 
 AXSUN_EXPORTS 
AxErr __cdecl axGetFPGARegisterDefaults(uint32_t elements_allocated, uint16_t* regnums, uint16_t* regvals, uint32_t* elements_returned, uint32_t which_DAQ);
 
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGARegisterDefaults(const uint16_t* regnums, const uint16_t* regvals, uint32_t count, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGARegister(uint32_t regnum, uint16_t regval, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGARegisterMasked(uint32_t regnum, uint16_t regval, uint16_t bitmask, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGARegisterSingleBit(uint32_t regnum, uint32_t which_bit, uint32_t value, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGARegisterSingleByte(uint32_t regnum, uint32_t which_byte, uint32_t value, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGARegisterSingleNibble(uint32_t regnum, uint32_t which_nibble, uint32_t value, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGADataArray(uint32_t regnum, const uint16_t* data_array, uint32_t number_of_words, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGAWindowFunction(AxChannelMode channel, const float* window_real, const float* window_imag, uint32_t window_length, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axSetFPGAWindowFunc(AxChannelMode channel, AxSwpTrgMode trig_edge, const float* window_real, const float* window_imag, uint32_t window_length, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr __cdecl axCalcWindowFunc(window_func_t params, float* window_real_out, float* window_imag_out);
 
 AXSUN_EXPORTS 
AxErr __cdecl axCalcWindowFuncToFPGA(AxChannelMode channel, AxSwpTrgMode trig_edge, window_func_t params, const float* shape, float* window_real_out, float* window_imag_out, uint32_t which_DAQ);
 
 
#ifdef __cplusplus
}       // end extern "C"
 
inline const char* AxConnectTypeString(AxConnectionType connection) {
    switch (connection) {
    case AxConnectionType::USB: return "USB";
    case AxConnectionType::RS232: return "RS-232";
    case AxConnectionType::RS232_PASSTHROUGH: return "via DAQ";
    case AxConnectionType::ETHERNET: return "Ethernet";
    default: return "Unknown";
    }
}
 
inline const char* AxDevTypeString(AxDevType device) {
    switch (device) {
    case AxDevType::LASER: return "Laser";
    case AxDevType::AZMYTH_LASER: return "Azmyth Laser";
    case AxDevType::EDAQ: return "EDAQ";
    case AxDevType::CLDAQ: return "CLDAQ";
    default: return "Unknown";
    }
}
 
#endif // end __cplusplus
 
#endif // end header include guard