---

lx200.h

/***************************************************************************
                          lx200.h  -  description
                             -------------------
    begin                : Fri Nov 1 2002
    copyright            : (C) 2002 by Jasem Mutlaq
    email                : mutlaqja@ku.edu
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef LX200_H
#define LX200_H

class LX200PortException
{
  static const char * errorMSG[];
  char error[64];

  public:
  LX200PortException() { strcpy(error, "UNKNOWN_ERROR");}
  LX200PortException(int errorType) { strcpy(error, errorMSG[errorType]); }

  const char * getError() const {return error;}
};


class LX200
{
   public:
  LX200();
  ~LX200();

  enum TSlew { CENTER, GUIDE, MOVE, SLEW};
  enum TAlign { ALTAZ, GERMAN, LAND, POLAR};
  enum TDirection { EAST, NORTH, SOUTH, WEST};
  enum TFormat { LX200SHORT, LX200LONG, LX200UNDEFINED };
  enum TTelescope { LX200CLASSIC, LX200AUTOSTAR };
  enum TFocus { FOCUSIN, FOCUSOUT, QUITFOCUS, FOCUSFAST, FOCUSSLOW };
  enum TTime { TWELVEHOUR, TWENTYFOURHOUR };
  enum TObjects { CNGC, IC, UGC};
  enum TLibrary { STAR, SAO, GCVS};
  enum TFreq { MANUAL, QUARTZ, INCREMENT, DECREMENT};
 
   bool Connect();

   bool Connect(const char *portID);


   /*********************************
   // Get Commands Groupings
   *********************************/

   char  ACK();

   int getHourMode();

   double  getLX200RA();
   
   double getLX200DEC();

   double getObjRA();

   double getObjDEC();

   double getLX200Alt();

   double getLX200Az();

   double getSideralTime();

   char * getCalenderDate();

   double getSiteLaitude();

   double getSiteLongitude();

   double getLocalTime(int timeFormat);

   bool isFINDTypeSelected();

   char * getFINDQuality();

   int getFINDBoundaryLimit(int boundary);

   double getFINDMagnitudeLimit(int boundary);

   int getFINDSizeLimit(int boundary);
   
   int getFIELDRadius();

   char * getSiteName(int siteNum);

   int getUCTOffset();

   double getCurrentTrackFreq();

   char * getVersionDate();
   char * getVersionTime();
   char * getFullVersion();
   char * getVersionNumber();
   char * getProductName();

   int getNumberOfBars();

   TFormat getLX200Format();


    /*********************************
     // SET Commands Groupings
    *********************************/
    bool setObjAlt(int degrees, int minutes);
    
    bool setObjAz(int degrees, int minutes);

    bool setCalendarDate(int dd, int mm, int yy);
    
    bool setSiteLongitude(int degrees, int minutes);
    
    bool setSiteLatitude(int degrees, int minutes);

    bool setUTCOffset(int hours);
        
    bool setLocalTime(int hours, int minutes, int seconds);

    bool setSiteName(int siteNum, const char * siteName);

    bool setObjDEC(int degrees, int minutes, int seconds);

    bool setObjRA(int hours, int minutes, int seconds);

    bool setSiderealTime(int hours, int minutes, int seconds);
    
    bool setTrackFreq(double Freq);
    
    bool setMaxSlewRate(int slewRate);

    void setAlignmentMode(TAlign alignMode);
    
    void setHourMode(TTime hMode);

    void setTrackingRate(TFreq tRate);

    void selectSite(int siteNum);

    bool setFINDMagnitudeLimit(int boundary, double magnitude);

    bool setFINDBoundaryLimit(int boundary, int degrees);

    bool setFINDSizeLimit(int boundary, int size);

    bool setFINDStringType();

    bool setFIELDRadius(int radius);

    void increaseReticleBrightness();
    void descreaseReticleBrightness();

    void setReticleFlashingMode(int fMode);
   
    void setLX200Format(TFormat format);

    /*********************************
   // Motion Commands Groupings
   *********************************/
   void slewToAltAz();

   void move(TDirection dir);

   int slewToObj();

   void abortMove(TDirection dir);

   void abortSlew();

   /*********************************
   // Library Commands Groupings
   *********************************/
   
   void libraryPrevObj();

    void libraryNextObj();

   void libraryStartFind();

   char * libraryObjInfo();


   char * libraryFieldInfo();

   void libraryFindCNGC(int identifier);

   void libraryFindMessier(int identifier);

   void libraryFindStarType(int identifer);

   bool librarySetNGCType(TObjects ID);

   bool librarySetSTARType(TLibrary ID);

   /*********************************
   // Misc. Commands Groupings
   *********************************/
   char * Sync();

   void turnFanOn();
   
   void turnFanOff();

   void startHomeSearch(int SaveSetOption);

   int HomeSearchResult();

   void fieldDeRotator(bool turnOn);
   
   void focusControl(TFocus fMode);

   bool highPrecision();

   void toggleSmartDrive (int cToggle);
   
  private:
  int fd;
  static const char* ports[4];
  enum TError { READ_ERROR, WRITE_ERROR, READOUT_ERROR, PORT_ERROR};

  TSlew SlewType;
  TAlign Alignment;
  TDirection Direction;
  TFormat LX200Format;
  TTelescope Telescope;
  TTime timeFormat;
  bool LX200Connected;

  void queryLX200Format();
  void LX200readOut();
  bool setStandardProcedure(const char * writeData);

  protected:
   int openPort(const char *portID);

   int portWrite(const char * buf);

    int portRead(char *buf, int nbytes);

    bool queryData();
  
};

#endif

---