azcam.h

Go to the documentation of this file.

#ifndef AZCAM_H
#define AZCAM_H

//
// azcam.h - AzCam Client API Header
//

// System header files 

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#include <sys/time.h>
#include <sys/times.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/file.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <time.h>
#include <termios.h>
#include <fcntl.h>
#include <signal.h>
#include <math.h>

//----------------------------------------------------------------
//
// azcam: AzCam server parameter struct
//


typedef struct azcam {

  // Server Info

  char Host[64];     
  int  Port;         
  int  FD;           
  long Timeout;      
  char CfgFile[128]; 
  char IniFile[128]; 

  // System State flags

  int State;       
  int ShutterMode; 
  int Readout;     
  int Shutter;     
  int Abort;       

  // Temperature Info

  float SetPoint;    
  float CCDTemp;     
  float DewarTemp;   
  int   DiodeSensor; 
  int   CCDSensor;   
  int   DewarSensor; 

  // Detector Region of Interest (ROI) Parameters

  int FirstCol;   
  int LastCol;    
  int ColBin;     
  int FirstRow;   
  int LastRow;    
  int RowBin;     

  // Detector Format Parameters

  int NCtotal;     
  int NCpredark;   
  int NCunderscan; 
  int NCoverscan;  
  int NRtotal;     
  int NRpredark;   
  int NRunderscan; 
  int NRoverscan;  
  int NRframexfer; 

  // Detector Readout Configuration Parameters

  int ReadMode;      
  int Splits;        
  int NumDetX;       
  int NumDetY;       
  char AmpConfig[6]; 

  // Detector Readout Pixel Count Parameters

  int Ncols;       
  int Nrows;       
  int Npixels;     
  int Nread;       

  // Other parameters

  float ExpTime;       
  int   Elapsed;       
  char  FilePath[128]; 
  char  FileName[128]; 
  int   FileNum;       
  int   FileFormat;    
  char  LastFile[128]; 

} azcam_t;

// Parameter Values

#define SH_OPEN   1   
#define SH_CLOSED 0   

#define IDLE     0    
#define READOUT  1    
#define EXPOSING 2    
#define PAUSE    3    

#define DT670  0      
#define AD590  1      
#define N914   3      

#define DARK_IMAGE  0 
#define LIGHT_IMAGE 1 
#define TDI         2 

#define EXP_NOWAIT 0  
#define EXP_WAIT   1  

#define IMMEDIATE 0   
#define DEFERRED  1   

#define STDFITS   1   
#define BINARY    2   
#define EXTFITS   3   

#define GUIDER_CLIENT 1  
#define GUIDER_CLOSE  2  
#define MESSAGE_CLIENT 3 
#define MESSAGE_CLOSE  4 
#define DISPLAY_CLIENT 5 
#define FILE_CLIENT    6 

#define SINGLE_AMP       0 
#define TWO_AMP_PARALLEL 1 
#define TWO_AMP_SERIAL   2 
#define FOUR_AMP_QUAD    3 
#define MOSAIC           6 

#define NO_SPLIT       0 
#define SPLIT_SERIAL   1 
#define SPLIT_PARALLEL 2 
#define SPLIT_QUAD     3 

// azcamutils Function Prototypes

int OpenAzCam(azcam_t *, char *);
void CloseAzCam(azcam_t *);
int WriteAzCam(azcam_t *, char *);
int ReadAzCam(azcam_t *, char *);
int AzCamCommand(azcam_t *, char *, char *);

// Method function prototypes (implement single or multiple AzCam server
// commands

// Server Control and Database Commands (server.c)

int CloseConnection(azcam_t *, char *);
int RunScript(azcam_t *, char *, char *);
int SetParameter(azcam_t *, char *, char *, char *, char *);
int GetParameter(azcam_t *, char *, char *, char *);
int ClearParameter(azcam_t *, char *); 

// Image Writing Commands (image.c)

int SetSocket(azcam_t *, int , char *, int , char *);
int WriteImage(azcam_t *, char *, char *);
int SendImage(azcam_t *, int , char *, int , char *);

// Exposure Control Commands (exposure.c)

int ClearArray(azcam_t *, char *);
int StartExposure(azcam_t *, int , char *);
int SetExposure(azcam_t *, float , char *);
int ReadExposure(azcam_t *, char *);
int AbortExposure(azcam_t *, char *);
int PauseExposure(azcam_t *, char *);
int ResumeExposure(azcam_t *, char *);
int SetFormat(azcam_t *, char *);
int SetConfiguration(azcam_t *, char *);
int SetROI(azcam_t *, char *);
int OpenShutter(azcam_t *, char *);
int CloseShutter(azcam_t *, char *);
int RowShift(azcam_t *, int , char *); 
int GetDetPars(azcam_t *, char *);
int GetPixelCount(azcam_t *, char *);
int SetShutterMode(azcam_t *, int , char *);
int SetReadoutMode(azcam_t *, int , char *);

// Temperature Commands (temperature.c)

int GetTemp(azcam_t *, char *);
int SetTemp(azcam_t *, float , char *);
int SetTempCal(azcam_t *, int , int , int , char *);

// Additional Utility Functions (azcamutils.c)

void InitAzCam(azcam_t *);
void AzCamInfo(azcam_t *);
int ARCCommand(azcam_t *, char *, char *);

#endif // AZCAM_H

---