ADDriver.h

Go to the documentation of this file.

#ifndef ADDriver_H
#define ADDriver_H

#include <epicsTypes.h>
#include <epicsMessageQueue.h>
#include <epicsTime.h>
#include <asynStandardInterfaces.h>

#include "asynNDArrayDriver.h"


#define AREA_DETECTOR_OK 0

#define AREA_DETECTOR_ERROR -1

typedef enum
{
    ADShutterClosed,    
    ADShutterOpen       
} ADShutterStatus_t;

typedef enum
{
    ADShutterModeNone,      
    ADShutterModeEPICS,     
    ADShutterModeDetector   
} ADShutterMode_t;

typedef enum
{
    ADStatusIdle,         
    ADStatusAcquire,      
    ADStatusReadout,      
    ADStatusCorrect,      
    ADStatusSaving,       
    ADStatusAborting,     
    ADStatusError,        
    ADStatusWaiting,      
    ADStatusInitializing, 
    ADStatusDisconnected, 
    ADStatusAborted       
} ADStatus_t;

typedef enum
{
    ADImageSingle,      
    ADImageMultiple,    
    ADImageContinuous   
} ADImageMode_t;

/* Enumeration of frame types */
typedef enum
{
    ADFrameNormal,          
    ADFrameBackground,      
    ADFrameFlatField,       
    ADFrameDoubleCorrelation      
} ADFrameType_t;

/* Enumeration of trigger modes */
typedef enum
{
    ADTriggerInternal,      
    ADTriggerExternal       
} ADTriggerMode_t;

 /*                               String                 asyn interface  access   Description  */
#define ADManufacturerString        "MANUFACTURER"          
#define ADModelString               "MODEL"                 
#define ADSerialNumberString        "SERIAL_NUMBER"         
#define ADSDKVersionString          "SDK_VERSION"           
#define ADFirmwareVersionString     "FIRMWARE_VERSION"      
#define ADGainString                "GAIN"                  
    /* Parameters that control the detector binning */
#define ADBinXString                "BIN_X"                 
#define ADBinYString                "BIN_Y"                 
    /* Parameters the control the region of the detector to be read out.
    * ADMinX, ADMinY, ADSizeX, and ADSizeY are in unbinned pixel units */
#define ADMinXString                "MIN_X"                 
#define ADMinYString                "MIN_Y"                 
#define ADSizeXString               "SIZE_X"                
#define ADSizeYString               "SIZE_Y"                
#define ADMaxSizeXString            "MAX_SIZE_X"            
#define ADMaxSizeYString            "MAX_SIZE_Y"            
    /* Parameters that control the orientation of the image */
#define ADReverseXString            "REVERSE_X"             
#define ADReverseYString            "REVERSE_Y"             
    /* Parameters defining the acquisition parameters. */
#define ADFrameTypeString           "FRAME_TYPE"            
#define ADImageModeString           "IMAGE_MODE"            
#define ADTriggerModeString         "TRIGGER_MODE"          
#define ADNumExposuresString        "NEXPOSURES"            
#define ADNumImagesString           "NIMAGES"               
#define ADAcquireTimeString         "ACQ_TIME"              
#define ADAcquirePeriodString       "ACQ_PERIOD"            
#define ADStatusString              "STATUS"                
#define ADAcquireString             "ACQUIRE"               
#define ADAcquireBusyString         "ACQUIRE_BUSY"          
#define ADWaitForPluginsString      "WAIT_FOR_PLUGINS"      
    /* Shutter parameters */
#define ADShutterControlString      "SHUTTER_CONTROL"       
#define ADShutterControlEPICSString "SHUTTER_CONTROL_EPICS" 
#define ADShutterStatusString       "SHUTTER_STATUS"        
#define ADShutterModeString         "SHUTTER_MODE"          
#define ADShutterOpenDelayString    "SHUTTER_OPEN_DELAY"    
#define ADShutterCloseDelayString   "SHUTTER_CLOSE_DELAY"   
    /* Temperature parameters */
#define ADTemperatureString         "TEMPERATURE"           
#define ADTemperatureActualString   "TEMPERATURE_ACTUAL"    
    /* Statistics on number of images collected and the image rate */
#define ADNumImagesCounterString    "NIMAGES_COUNTER"       
#define ADNumExposuresCounterString "NEXPOSURES_COUNTER"    
#define ADTimeRemainingString       "TIME_REMAINING"        
    /* Status reading */
#define ADReadStatusString          "READ_STATUS"           
    /* Status message strings */
#define ADStatusMessageString       "STATUS_MESSAGE"        
#define ADStringToServerString      "STRING_TO_SERVER"      
#define ADStringFromServerString    "STRING_FROM_SERVER"    
class epicsShareClass ADDriver : public asynNDArrayDriver {
public:
    /* This is the constructor for the class. */
    ADDriver(const char *portName, int maxAddr, int numParams, int maxBuffers, size_t maxMemory,
             int interfaceMask, int interruptMask,
             int asynFlags, int autoConnect, int priority, int stackSize);

    /* These are the methods that we override from asynPortDriver */
    virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
    virtual asynStatus setIntegerParam(int index, int value);
    virtual asynStatus setIntegerParam(int list, int index, int value);

    /* These are the methods that are new to this class */
    virtual void setShutter(int open);

protected:
    int ADManufacturer;
    #define FIRST_AD_PARAM ADManufacturer
    int ADModel;
    int ADSerialNumber;
    int ADSDKVersion;
    int ADFirmwareVersion;
    int ADGain;
    int ADBinX;
    int ADBinY;
    int ADMinX;
    int ADMinY;
    int ADSizeX;
    int ADSizeY;
    int ADMaxSizeX;
    int ADMaxSizeY;
    int ADReverseX;
    int ADReverseY;
    int ADFrameType;
    int ADImageMode;
    int ADNumExposures;
    int ADNumExposuresCounter;
    int ADNumImages;
    int ADNumImagesCounter;
    int ADAcquireTime;
    int ADAcquirePeriod;
    int ADTimeRemaining;
    int ADStatus;
    int ADTriggerMode;
    int ADAcquire;
    int ADAcquireBusy;
    int ADWaitForPlugins;
    int ADShutterControl;
    int ADShutterControlEPICS;
    int ADShutterStatus;
    int ADShutterMode;
    int ADShutterOpenDelay;
    int ADShutterCloseDelay;
    int ADTemperature;
    int ADTemperatureActual;
    int ADReadStatus;
    int ADStatusMessage;
    int ADStringToServer;
    int ADStringFromServer;
};

#endif