AxsunOCTControl_LW_C.h

Go to the documentation of this file.

// AxsunOCTControl_LW_C.h
// Copyright 2020 Axsun Technologies
 
#ifndef AXSUNOCTCONTROLLW_C_H
#define AXSUNOCTCONTROLLW_C_H
 
#include "AxsunCommonEnums.h"
 
#ifdef LabVIEW_CALLBACK
#include "extcode.h"        // only required for LabVIEW callback integration
#endif
 
#ifdef __cplusplus
#include <cstdint>
extern "C" {
#else
#include <stdint.h>
#endif // __cplusplus
 
typedef enum {
    EXTERNAL = 0,   
    INTERNAL = 1,   
    LVDS = 2,       
    LVCMOS = 3,     
} AxEdgeSource;
 
typedef enum {
    NONE = 0,
    USB = 1,                    
    RS232_PASSTHROUGH = 2,      
    RS232 = 3,                  
    ETHERNET = 4                
} AxConnectionType;
 
typedef enum {
    UNDEFINED = 0,
    LASER = 40,         
    CLDAQ = 41,         
    EDAQ = 42           
} AxDevType;
 
typedef enum {
    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    
} AxTECState;
 
typedef void(__cdecl *AxConnectCallbackFunctionC_t)(void*);
 AXSUN_EXPORTS 
void axGetErrorExplained(AxErr errornum, char* error_string);
 AXSUN_EXPORTS 
AxErr axOpenAxsunOCTControl(uint32_t open_all_interfaces);
 AXSUN_EXPORTS 
AxErr axCloseAxsunOCTControl();
 AXSUN_EXPORTS 
AxErr axNetworkInterfaceOpen(uint32_t interface_status);
 AXSUN_EXPORTS 
AxErr axUSBInterfaceOpen(uint32_t interface_status);
 AXSUN_EXPORTS 
AxErr axSerialInterfaceOpen(uint32_t interface_status, char* port);
 AXSUN_EXPORTS 
AxErr axImagingCntrlEthernet(int16_t number_of_images, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetImageSyncSource(AxEdgeSource source, float frequency, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetSampleClockSource(AxEdgeSource source, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetSweepTriggerSource(AxEdgeSource source, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetPipelineMode(AxPipelineMode pipeline_mode, AxChannelMode polarization_mode, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetEightBitGain(float gain, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetEightBitOffset(float offset, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetSubsamplingFactor(uint8_t subsampling_factor, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axGetFPGARegister(const uint32_t regnum, uint16_t* regval, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr 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 axGetFPGARegisterDefaults(uint32_t elements_allocated, uint16_t* regnums, uint16_t* regvals, uint32_t* elements_returned, uint32_t which_DAQ);
 
 AXSUN_EXPORTS 
AxErr axSetFPGARegisterDefaults(const uint16_t* regnums, const uint16_t* regvals, const uint32_t count, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetFPGARegister(const uint32_t regnum, const uint16_t regval, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetFPGARegisterMasked(const uint32_t regnum, const uint16_t regval, const uint16_t bitmask, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetFPGARegisterSingleBit(const uint32_t regnum, const uint32_t which_bit, const uint32_t value, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetFPGARegisterSingleByte(const uint32_t regnum, const uint32_t which_byte, const uint32_t value, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetFPGARegisterSingleNibble(const uint32_t regnum, const uint32_t which_nibble, const uint32_t value, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axSetFPGADataArray(const uint32_t regnum, const uint16_t* data_array, const uint32_t number_of_words, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axReadDAQPHYRegister(uint32_t phynum, uint32_t regnum, uint16_t* regval, uint32_t which_DAQ);
 AXSUN_EXPORTS 
AxErr axConnectionHeartbeat(uint32_t heartbeat_state, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axDebugCommand(uint32_t command_number, uint32_t value_out, uint32_t* command_in, uint32_t* value_in, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axFirmwareVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axFPGAVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t* build, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axLibraryVersion(uint32_t* major, uint32_t* minor, uint32_t* patch, uint32_t* build);
 AXSUN_EXPORTS 
AxErr axDeviceType(AxDevType * device_type, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axSerialNumber(char * serial_number, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axConnectionType(AxConnectionType * connection_type, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axCountDeviceSettings(uint32_t* float_count, uint32_t* int_count, uint32_t* bool_count, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axGetFloatSetting(uint32_t which_setting, float* setting_value, char * setting_string, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axGetIntSetting(uint32_t which_setting, int32_t* setting_value, char * setting_string, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axGetBoolSetting(uint32_t which_setting, uint8_t* setting_value, char * setting_string, uint32_t which_device);
 AXSUN_EXPORTS 
AxErr axSettingsToDevice(uint32_t float_count, uint32_t int_count, uint32_t bool_count, float* float_values, int32_t* int_values, uint8_t* bool_values, uint32_t which_device);
 AXSUN_EXPORTS 
uint32_t axCountConnectedDevices();
 AXSUN_EXPORTS 
AxErr axSetLaserEmission(uint32_t emission_state, uint32_t which_laser);
     AXSUN_EXPORTS 
AxErr axGetLaserEmission(uint32_t* emitting, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axSetPointerEmission(uint32_t emission_state, uint32_t which_laser);
     AXSUN_EXPORTS 
AxErr axGetPointerEmission(uint32_t* emitting, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axSetClockDelay(uint32_t delay_code, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axGetClockDelay(uint32_t* delay_code, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axHomeVDL(uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axStopVDL(uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axMoveRelVDL(float rel_position, float speed, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axMoveAbsVDL(float abs_position, float speed, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr 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 axGetTECState(AxTECState* TEC_state, uint32_t which_TEC, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axSetDACTable(uint32_t points, uint32_t speed, uint32_t timer1time, uint32_t timer2time,
    uint32_t timer1duration, uint32_t timer2duration, uint16_t* volts_currents, uint32_t save_to_flash, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axGetDACTable(uint32_t* points, uint32_t* speed, uint32_t* timer1time, uint32_t* timer2time,
    uint32_t* timer1duration, uint32_t* timer2duration, uint16_t* volts_currents, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axSetDriveConfiguration(uint32_t which_config, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axGetDriveConfiguration(uint32_t * current_configuration, uint32_t which_laser);
 AXSUN_EXPORTS 
AxErr axRegisterConnectCallback(AxConnectCallbackFunctionC_t callback_function, void * userData);
 
#ifdef LabVIEW_CALLBACK
 AXSUN_EXPORTS 
AxErr axRegisterLabVIEWCallback(LVUserEventRef* refnumptr);
#endif
 
#ifdef __cplusplus
}       // end extern "C"
#endif // __cplusplus
 
#endif      /* End header include guard */