AtikCameras.h

Go to the documentation of this file.

#pragma once
 
 
#ifdef _WIN32
#include <comdef.h>
#else
#include <stddef.h>
typedef int BOOL;
typedef void * HINSTANCE;
#endif
 
#ifdef __cplusplus
extern "C" {
#else
#include <stdbool.h>
#endif
 
    enum ARTEMISERROR
    {
        ARTEMIS_OK = 0,
        ARTEMIS_INVALID_PARAMETER,
        ARTEMIS_NOT_CONNECTED,
        ARTEMIS_NOT_IMPLEMENTED,
        ARTEMIS_NO_RESPONSE,
        ARTEMIS_INVALID_FUNCTION,
        ARTEMIS_NOT_INITIALIZED,
        ARTEMIS_OPERATION_FAILED,
    };
 
    enum ARTEMISCOLOURTYPE
    {
        ARTEMIS_COLOUR_UNKNOWN = 0,
        ARTEMIS_COLOUR_NONE,
        ARTEMIS_COLOUR_RGGB
    };
 
    enum ARTEMISPRECHARGEMODE
    {
        PRECHARGE_NONE = 0,     
        PRECHARGE_ICPS,         
        PRECHARGE_FULL,         
    };
 
    enum ARTEMISCAMERASTATE
    {
        CAMERA_ERROR = -1,
        CAMERA_IDLE = 0,
        CAMERA_WAITING,
        CAMERA_EXPOSING,
        CAMERA_READING,
        CAMERA_DOWNLOADING,
        CAMERA_FLUSHING,
    };
 
    // @see ArtemisCameraConnectionState
    enum ARTEMISCONNECTIONSTATE
    {
        CAMERA_CONNECTING      = 1,
        CAMERA_CONNECTED       = 2,
        CAMERA_CONNECT_FAILED  = 3,
        CAMERA_SUSPENDED       = 4,
        CAMERA_CONNECT_UNKNOWN = 5
    };
 
    enum ARTEMISPROCESSING
    {
        ARTEMIS_PROCESS_LINEARISE = 1,  
        ARTEMIS_PROCESS_VBE = 2, 
    };
 
    enum ARTEMISPROPERTIESCCDFLAGS
    {
        ARTEMIS_PROPERTIES_CCDFLAGS_INTERLACED = 1, 
        ARTEMIS_PROPERTIES_CCDFLAGS_DUMMY = 0x7FFFFFFF 
    };
 
    enum ARTEMISPROPERTIESCAMERAFLAGS
    {
        ARTEMIS_PROPERTIES_CAMERAFLAGS_FIFO = 1, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_EXT_TRIGGER = 2, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_PREVIEW = 4, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_SUBSAMPLE = 8, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_SHUTTER = 16, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_GUIDE_PORT = 32, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_GPIO = 64, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_WINDOW_HEATER = 128, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_EIGHT_BIT_MODE = 256, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_OVERLAP_MODE = 512, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_FILTERWHEEL = 1024, 
        ARTEMIS_PROPERTIES_CAMERAFLAGS_DUMMY = 0x7FFFFFFF 
    };
 
    enum ARTEMISCOOLINGINFO
    {
        ARTEMIS_COOLING_INFO_HASCOOLING          = 1,
        ARTEMIS_COOLING_INFO_CONTROLLABLE        = 2,
        ARTEMIS_COOLING_INFO_ONOFFCOOLINGCONTROL = 4,
        ARTEMIS_COOLING_INFO_POWERLEVELCONTROL   = 8,
        ARTEMIS_COOLING_INFO_SETPOINTCONTROL     = 16,
        ARTEMIS_COOLING_INFO_WARMINGUP           = 32,
        ARTEMIS_COOLING_INFO_COOLINGON           = 64,
        ARTEMIS_COOLING_INFO_SETPOINTCONTROLON   = 128
    };
 
    enum ARTEMISEFWTYPE
    {
        ARTEMIS_EFW1 = 1,
        ARTEMIS_EFW2 = 2
    };
 
    enum CameraSpecificOptionsIDs
    {
        ID_GOPresetMode     = 1,
        ID_GOPresetLow      = 2,
        ID_GOPresetMed      = 3,
        ID_GOPresetHigh     = 4,
        ID_GOCustomGain     = 5,
        ID_GOCustomOffset   = 6,
        ID_EvenIllumination = 12,
        ID_PadData          = 13,
        ID_ExposureSpeed    = 14,
        ID_BitSendMode      = 15,
        ID_FX3Version       = 200,
        ID_FPGAVersion      = 201,
    };
 
    struct ARTEMISPROPERTIES
    {
        int Protocol;
        int nPixelsX;
        int nPixelsY;
        float PixelMicronsX;
        float PixelMicronsY;
        int ccdflags;
        int cameraflags;
        char Description[40];
        char Manufacturer[40];
    };
 
    typedef void * ArtemisHandle;
 
    static HINSTANCE hArtemisDLL = NULL;
 
    //
    // Interface functions for Atik Cameras Camera Library
    //
 
 
    #define artfn extern
 
    // -------------------  DLL --------------------------
        
    artfn int  ArtemisAPIVersion();
 
    artfn int  ArtemisDLLVersion();
 
    artfn BOOL ArtemisIsLocalConnection();
 
    artfn void ArtemisAllowDebugToConsole(bool value);
 
    artfn void ArtemisSetDebugCallback(void(*callback)(const char *message));
 
    artfn void ArtemisSetDebugCallbackContext(void * context, void(*callback)(void * context, const char *message));
 
    artfn void ArtemisSetFirmwareDir(const char * firmwareDir);
 
    artfn void ArtemisSetAtikAir(const char * host, int port);
 
    artfn void ArtemisShutdown();
 
    // -------------------  Device --------------------------
    
    artfn int           ArtemisDeviceCount();
 
    artfn BOOL          ArtemisDeviceIsPresent(int iDevice);
 
    artfn BOOL          ArtemisDevicePresent(  int iDevice);
 
    artfn BOOL          ArtemisDeviceInUse(    int iDevice);
 
    artfn BOOL          ArtemisDeviceName(          int iDevice, char *pName);
 
    artfn BOOL          ArtemisDeviceSerial(        int iDevice, char *pSerial);
 
    artfn BOOL          ArtemisDeviceIsCamera(      int iDevice);
 
    artfn BOOL          ArtemisDeviceHasFilterWheel(int iDevice);
 
    artfn BOOL          ArtemisDeviceHasGuidePort(  int iDevice);
 
    artfn ArtemisHandle ArtemisConnect(    int iDevice);
 
    artfn BOOL          ArtemisIsConnected(ArtemisHandle handle);
 
    artfn BOOL          ArtemisDisconnect( ArtemisHandle handle);
 
    artfn int           ArtemisRefreshDevicesCount();
 
 
    // ------------------- Camera Info -----------------------------------
    
    artfn int ArtemisCameraSerial(ArtemisHandle handle, int* flags, int* serial);
 
    artfn int ArtemisColourProperties(ArtemisHandle handle, ARTEMISCOLOURTYPE *colourType, int *normalOffsetX, int *normalOffsetY, int *previewOffsetX, int *previewOffsetY);
 
    artfn int ArtemisProperties(           ArtemisHandle handle, struct ARTEMISPROPERTIES *pProp);
 
    artfn int ArtemisCameraConnectionState(ArtemisHandle handle, ARTEMISCONNECTIONSTATE * state);
 
    // ------------------- Exposure Settings -----------------------------------
 
    artfn int  ArtemisBin(                              ArtemisHandle handle, int  x, int  y);
 
    artfn int  ArtemisGetBin(                           ArtemisHandle handle, int *x, int *y);
 
    artfn int  ArtemisGetMaxBin(                        ArtemisHandle handle, int *x, int *y);
 
    artfn int  ArtemisGetSubframe(                      ArtemisHandle handle, int *x, int *y, int *w, int *h);
 
    artfn int  ArtemisSubframe(                         ArtemisHandle handle, int  x, int  y, int  w, int  h);
 
    artfn int  ArtemisSubframePos(                      ArtemisHandle handle, int  x, int y);
 
    artfn int  ArtemisSubframeSize(                     ArtemisHandle handle, int  w, int h);
 
    artfn int  ArtemisSetSubSample(                     ArtemisHandle handle, bool bSub);
 
    artfn BOOL ArtemisContinuousExposingModeSupported(  ArtemisHandle handle);
 
    artfn BOOL ArtemisGetContinuousExposingMode(        ArtemisHandle handle);
 
    artfn int  ArtemisSetContinuousExposingMode(        ArtemisHandle handle, bool bEnable);
 
    artfn BOOL ArtemisGetDarkMode(                      ArtemisHandle handle);
 
    artfn int  ArtemisSetDarkMode(                      ArtemisHandle handle, bool bEnable);
 
    artfn int  ArtemisSetPreview(                       ArtemisHandle handle, bool bPrev);
 
    artfn int  ArtemisAutoAdjustBlackLevel(             ArtemisHandle handle, bool bEnable);
 
    artfn int  ArtemisPrechargeMode(                    ArtemisHandle handle, int mode);
 
    artfn int  ArtemisEightBitMode(                     ArtemisHandle handle, bool eightbit);
 
    artfn int  ArtemisGetEightBitMode(                  ArtemisHandle handle, bool *eightbit);
 
    artfn int  ArtemisStartOverlappedExposure(          ArtemisHandle handle);
 
    artfn BOOL ArtemisOverlappedExposureValid(          ArtemisHandle handle);
 
    artfn int  ArtemisSetOverlappedExposureTime(        ArtemisHandle handle, float fSeconds);
 
    artfn int  ArtemisTriggeredExposure(                ArtemisHandle handle, bool bAwaitTrigger);
 
    artfn int  ArtemisGetProcessing(                    ArtemisHandle handle);
 
    artfn int  ArtemisSetProcessing(                    ArtemisHandle handle, int options);
 
 
    // ------------------- Exposures -----------------------------------
 
    artfn int   ArtemisStartExposure(            ArtemisHandle handle, float seconds);
 
    artfn int   ArtemisStartExposureMS(          ArtemisHandle handle, int ms);
 
    artfn int   ArtemisAbortExposure(            ArtemisHandle handle);
 
    artfn int   ArtemisStopExposure(             ArtemisHandle handle);
 
    artfn BOOL  ArtemisImageReady(               ArtemisHandle handle);
 
    artfn int   ArtemisCameraState(              ArtemisHandle handle);
 
    artfn float ArtemisExposureTimeRemaining(    ArtemisHandle handle);
 
    artfn int   ArtemisDownloadPercent(          ArtemisHandle handle);
 
    artfn int   ArtemisGetImageData(             ArtemisHandle handle, int *x, int *y, int *w, int *h, int *binx, int *biny);
 
    artfn void* ArtemisImageBuffer(              ArtemisHandle handle);
 
    artfn float ArtemisLastExposureDuration(     ArtemisHandle handle);
 
    artfn char* ArtemisLastStartTime(            ArtemisHandle handle);
 
    artfn int   ArtemisLastStartTimeMilliseconds(ArtemisHandle handle);
 
    artfn int   ArtemisClearVReg(                ArtemisHandle handle);
    
    artfn BOOL ArtemisHasFastMode(      ArtemisHandle handle);
 
    artfn BOOL ArtemisStartFastExposure(ArtemisHandle handle, int ms);
 
    artfn BOOL ArtemisSetFastCallback(  ArtemisHandle handle, void(*callback)(ArtemisHandle handle, int x, int y, int w, int h, int binx, int biny, void * imageBuffer));
 
    // ------------------- Amplifier -----------------------------------
 
    artfn int  ArtemisAmplifier(           ArtemisHandle handle, bool bOn);
 
    artfn BOOL ArtemisGetAmplifierSwitched(ArtemisHandle handle);
 
    artfn int  ArtemisSetAmplifierSwitched(ArtemisHandle handle, bool bSwitched);
        
    // ------------ Camera Specific Options -------------
 
    artfn bool ArtemisHasCameraSpecificOption(    ArtemisHandle handle, unsigned short id);
 
    artfn int  ArtemisCameraSpecificOptionGetData(ArtemisHandle handle, unsigned short id, unsigned char * data, int dataLength, int * actualLength);
 
    artfn int  ArtemisCameraSpecificOptionSetData(ArtemisHandle handle, unsigned short id, unsigned char * data, int dataLength);
 
    // ------------------- Column Repair ---------------------------------- 
 
    artfn int ArtemisSetColumnRepairColumns(        ArtemisHandle handle, int   nColumn, unsigned short * columns);
 
    artfn int ArtemisGetColumnRepairColumns(        ArtemisHandle handle, int * nColumn, unsigned short * columns);
 
    artfn int ArtemisClearColumnRepairColumns(      ArtemisHandle handle);
 
    artfn int ArtemisSetColumnRepairFixColumns(     ArtemisHandle handle, bool value);
 
    artfn int ArtemisGetColumnRepairFixColumns(     ArtemisHandle handle, bool * value);
 
    artfn int ArtemisGetColumnRepairCanFixColumns(  ArtemisHandle handle, bool * value);
 
    // ---------------- EEPROM -------------------------
 
    artfn int ArtemisCanInteractWithEEPROM(ArtemisHandle handle, bool * canInteract);
 
    artfn int ArtemisWriteToEEPROM(        ArtemisHandle handle, char * password, int address, int length, const unsigned char * data);
 
    artfn int ArtemisReadFromEEPROM(       ArtemisHandle handle, char * password, int address, int length,       unsigned char * data);
 
 
    // ------------------- Filter Wheel -----------------------------------
 
    artfn int           ArtemisFilterWheelInfo(ArtemisHandle handle, int *numFilters, int *moving, int *currentPos, int *targetPos);
 
    artfn int           ArtemisFilterWheelMove(ArtemisHandle handle, int targetPos);
 
    artfn BOOL          ArtemisEFWIsPresent(int i);
 
    artfn int           ArtemisEFWGetDeviceDetails(int i, ARTEMISEFWTYPE * type, char * serialNumber);
 
    artfn ArtemisHandle ArtemisEFWConnect(int i);
 
    artfn bool          ArtemisEFWIsConnected(ArtemisHandle handle);
 
    artfn int           ArtemisEFWDisconnect( ArtemisHandle handle);
 
    artfn int           ArtemisEFWGetDetails( ArtemisHandle handle, ARTEMISEFWTYPE * type, char * serialNumber);
 
    artfn int           ArtemisEFWNmrPosition(ArtemisHandle handle, int * nPosition);
 
    artfn int           ArtemisEFWSetPosition(ArtemisHandle handle, int   iPosition);
 
    artfn int           ArtemisEFWGetPosition(ArtemisHandle handle, int * iPosition, bool * isMoving);
 
    // ------------------- Firmware ----------------------------------------    
 
    artfn bool ArtemisCanUploadFirmware(ArtemisHandle handle);
 
    artfn int  ArtemisUploadFirmware(   ArtemisHandle handle, char * fileName, char * password);
 
    // ------------------- Gain ----------------------------------
 
    artfn int ArtemisGetGain(ArtemisHandle handle, bool isPreview, int *gain, int *offset);
 
    artfn int ArtemisSetGain(ArtemisHandle handle, bool isPreview, int  gain, int  offset);
 
    // ------------------- GPIO -----------------------------------
 
    artfn int ArtemisGetGpioInformation(ArtemisHandle handle, int* lineCount, int* lineValues);
 
    artfn int ArtemisSetGpioDirection(  ArtemisHandle handle, int directionMask);
 
    artfn int ArtemisSetGpioValues(     ArtemisHandle handle, int lineValues);
 
    // ------------------- Guiding -----------------------------------
 
    artfn int ArtemisGuide(                    ArtemisHandle handle, int axis);
 
    artfn int ArtemisGuidePort(                ArtemisHandle handle, int nibble);
 
    artfn int ArtemisPulseGuide(               ArtemisHandle handle, int axis, int milli);
 
    artfn int ArtemisStopGuiding(              ArtemisHandle handle);
 
    artfn int ArtemisStopGuidingBeforeDownload(ArtemisHandle handle, bool bEnable);
 
    // ------------------- Hot Pixel ------------------------------
 
    enum HotPixelSensitivity { HPS_HIGH, HPS_MEDIUM, HPS_LOW };
 
    artfn int ArtemisAutoHotPixelRemoval(ArtemisHandle handle, bool on);
 
    artfn int ArtemisAdvancedHotPixelRemoval(ArtemisHandle handle, bool on, bool darkFrame, bool checkForAdjacentHotPixels, HotPixelSensitivity hps);
 
    // ------------------- Lens -----------------------------------
 
    artfn int ArtemisGetLensAperture(ArtemisHandle handle, int* aperture);
 
    artfn int ArtemisGetLensFocus(   ArtemisHandle handle, int* focus);
 
    artfn int ArtemisGetLensLimits(  ArtemisHandle handle, int* apertureMin, int* apertureMax, int* focusMin, int* focusMax);
 
    artfn int ArtemisInitializeLens( ArtemisHandle handle);
 
    artfn int ArtemisSetLensAperture(ArtemisHandle handle, int aperture);
 
    artfn int ArtemisSetLensFocus(   ArtemisHandle handle, int focus);
 
    // ------------------- Shutter ----------------------------------       
 
    artfn int ArtemisCanControlShutter( ArtemisHandle handle, bool * canControl);
 
    artfn int ArtemisOpenShutter(       ArtemisHandle handle);
 
    artfn int ArtemisCloseShutter(      ArtemisHandle handle);
 
    artfn int ArtemisCanSetShutterSpeed(ArtemisHandle handle, bool *canSetShutterSpeed);
 
    artfn int ArtemisGetShutterSpeed(   ArtemisHandle handle, int *speed);
 
    artfn int ArtemisSetShutterSpeed(   ArtemisHandle handle, int  speed);
 
    // ------------------- Temperature -----------------------------------
 
    artfn int ArtemisTemperatureSensorInfo(ArtemisHandle handle, int sensor, int* temperature);
 
    artfn int ArtemisSetCooling(           ArtemisHandle handle, int setpoint);
 
    artfn int ArtemisSetCoolingPower(      ArtemisHandle handle, int power);
 
    artfn int ArtemisCoolingInfo(          ArtemisHandle handle, int* flags, int* level, int* minlvl, int* maxlvl, int* setpoint);
 
    artfn int ArtemisCoolerWarmUp(         ArtemisHandle handle);
 
    artfn int ArtemisGetWindowHeaterPower( ArtemisHandle handle, int* windowHeaterPower);
 
    artfn int ArtemisSetWindowHeaterPower( ArtemisHandle handle, int  windowHeaterPower);
    
    artfn bool ArtemisLoadDLL(const char * fileName);
 
    artfn void ArtemisUnLoadDLL();
 
    #undef artfn
 
#ifdef __cplusplus
}
#endif