TwiceAsNice  2019-02-18
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
LX200Telescope Class Reference

#include <lx200telescope.h>

Inheritance diagram for LX200Telescope:
Inheritance graph
Collaboration diagram for LX200Telescope:
Collaboration graph

Public Types

enum  {
  LX200_HAS_FOCUS = 1 << 0, LX200_HAS_TRACKING_FREQ = 1 << 1, LX200_HAS_ALIGNMENT_TYPE = 1 << 2, LX200_HAS_SITES = 1 << 3,
  LX200_HAS_PULSE_GUIDING = 1 << 4
}
 
- Public Types inherited from INDI::Telescope
enum  TelescopeStatus {
  SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING, SCOPE_PARKING,
  SCOPE_PARKED, SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING,
  SCOPE_PARKING, SCOPE_PARKED
}
 
enum  TelescopeMotionCommand { MOTION_START = 0, MOTION_STOP, MOTION_START = 0, MOTION_STOP }
 
enum  TelescopeSlewRate {
  SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX,
  SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX
}
 
enum  TelescopeTrackMode {
  TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM,
  TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM
}
 
enum  TelescopeTrackState {
  TRACK_ON, TRACK_OFF, TRACK_UNKNOWN, TRACK_ON,
  TRACK_OFF, TRACK_UNKNOWN
}
 
enum  TelescopeParkData {
  PARK_NONE, PARK_RA_DEC, PARK_HA_DEC, PARK_AZ_ALT,
  PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER, PARK_NONE, PARK_RA_DEC,
  PARK_HA_DEC, PARK_AZ_ALT, PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER
}
 
enum  TelescopeLocation {
  LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION, LOCATION_LATITUDE,
  LOCATION_LONGITUDE, LOCATION_ELEVATION
}
 
enum  TelescopePierSide {
  PIER_UNKNOWN = -1, PIER_WEST = 0, PIER_EAST = 1, PIER_UNKNOWN = -1,
  PIER_WEST = 0, PIER_EAST = 1
}
 
enum  TelescopePECState {
  PEC_UNKNOWN = -1, PEC_OFF = 0, PEC_ON = 1, PEC_UNKNOWN = -1,
  PEC_OFF = 0, PEC_ON = 1
}
 
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
enum  {
  TELESCOPE_CAN_GOTO = 1 << 0, TELESCOPE_CAN_SYNC = 1 << 1, TELESCOPE_CAN_PARK = 1 << 2, TELESCOPE_CAN_ABORT = 1 << 3,
  TELESCOPE_HAS_TIME = 1 << 4, TELESCOPE_HAS_LOCATION = 1 << 5, TELESCOPE_HAS_PIER_SIDE = 1 << 6, TELESCOPE_HAS_PEC = 1 << 7,
  TELESCOPE_HAS_TRACK_MODE = 1 << 8, TELESCOPE_CAN_CONTROL_TRACK = 1 << 9, TELESCOPE_HAS_TRACK_RATE = 1 << 10
}
 
enum  TelescopeStatus {
  SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING, SCOPE_PARKING,
  SCOPE_PARKED, SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING,
  SCOPE_PARKING, SCOPE_PARKED
}
 
enum  TelescopeMotionCommand { MOTION_START = 0, MOTION_STOP, MOTION_START = 0, MOTION_STOP }
 
enum  TelescopeSlewRate {
  SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX,
  SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX
}
 
enum  TelescopeTrackMode {
  TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM,
  TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM
}
 
enum  TelescopeTrackState {
  TRACK_ON, TRACK_OFF, TRACK_UNKNOWN, TRACK_ON,
  TRACK_OFF, TRACK_UNKNOWN
}
 
enum  TelescopeParkData {
  PARK_NONE, PARK_RA_DEC, PARK_HA_DEC, PARK_AZ_ALT,
  PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER, PARK_NONE, PARK_RA_DEC,
  PARK_HA_DEC, PARK_AZ_ALT, PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER
}
 
enum  TelescopeLocation {
  LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION, LOCATION_LATITUDE,
  LOCATION_LONGITUDE, LOCATION_ELEVATION
}
 
enum  TelescopePierSide {
  PIER_UNKNOWN = -1, PIER_WEST = 0, PIER_EAST = 1, PIER_UNKNOWN = -1,
  PIER_WEST = 0, PIER_EAST = 1
}
 
enum  TelescopePECState {
  PEC_UNKNOWN = -1, PEC_OFF = 0, PEC_ON = 1, PEC_UNKNOWN = -1,
  PEC_OFF = 0, PEC_ON = 1
}
 
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
enum  {
  TELESCOPE_CAN_GOTO = 1 << 0, TELESCOPE_CAN_SYNC = 1 << 1, TELESCOPE_CAN_PARK = 1 << 2, TELESCOPE_CAN_ABORT = 1 << 3,
  TELESCOPE_HAS_TIME = 1 << 4, TELESCOPE_HAS_LOCATION = 1 << 5, TELESCOPE_HAS_PIER_SIDE = 1 << 6, TELESCOPE_HAS_PEC = 1 << 7,
  TELESCOPE_HAS_TRACK_MODE = 1 << 8, TELESCOPE_CAN_CONTROL_TRACK = 1 << 9, TELESCOPE_HAS_TRACK_RATE = 1 << 10
}
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 

Public Member Functions

 LX200Telescope ()=default
 
virtual ~LX200Telescope ()=default
 
uint32_t getLX200Capability () const
 
void setLX200Capability (uint32_t cap)
 
virtual const char * getDefaultName () override
 
virtual const char * getDriverName () override
 
virtual bool Handshake () override
 perform handshake with device to check communication More...
 
virtual bool ReadScopeStatus () override
 Read telescope status. More...
 
virtual void ISGetProperties (const char *dev) override
 define the driver's properties to the client. More...
 
virtual bool initProperties () override
 Called to initialize basic properties required all the time. More...
 
virtual bool updateProperties () override
 Called when connected state changes, to add/remove properties. More...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
void updateFocusTimer ()
 
- Public Member Functions inherited from INDI::Telescope
 Telescope ()
 
virtual ~Telescope ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
uint32_t GetTelescopeCapability () const
 GetTelescopeCapability returns the capability of the Telescope. More...
 
void SetTelescopeCapability (uint32_t cap, uint8_t slewRateCount=0)
 SetTelescopeCapability sets the Telescope capabilities. More...
 
bool CanGOTO ()
 
bool CanSync ()
 
bool CanAbort ()
 
bool CanPark ()
 
bool CanControlTrack ()
 
bool HasTime ()
 
bool HasLocation ()
 
bool HasPierSide ()
 
bool HasPECState ()
 
bool HasTrackMode ()
 
bool HasTrackRate ()
 
virtual void TimerHit ()
 Called when setTimer() time is up. More...
 
void SetParkDataType (TelescopeParkData type)
 setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More...
 
bool InitPark ()
 InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. More...
 
bool isParked ()
 isParked is mount currently parked? More...
 
void SetParked (bool isparked)
 SetParked Change the mount parking status. More...
 
double GetAxis1Park () const
 
double GetAxis1ParkDefault () const
 
double GetAxis2Park () const
 
double GetAxis2ParkDefault () const
 
void SetAxis1Park (double value)
 SetRAPark Set current RA/AZ parking position. More...
 
void SetAxis1ParkDefault (double steps)
 SetRAPark Set default RA/AZ parking position. More...
 
void SetAxis2Park (double steps)
 SetDEPark Set current DEC/ALT parking position. More...
 
void SetAxis2ParkDefault (double steps)
 SetDEParkDefault Set default DEC/ALT parking position. More...
 
bool isLocked () const
 isLocked is mount currently locked? More...
 
void setTelescopeConnection (const uint8_t &value)
 setTelescopeConnection Set telescope connection mode. More...
 
uint8_t getTelescopeConnection () const
 
void setPierSide (TelescopePierSide side)
 
TelescopePierSide getPierSide ()
 
void setPECState (TelescopePECState state)
 
TelescopePECState getPECState ()
 
 Telescope ()
 
virtual ~Telescope ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
uint32_t GetTelescopeCapability () const
 GetTelescopeCapability returns the capability of the Telescope. More...
 
void SetTelescopeCapability (uint32_t cap, uint8_t slewRateCount=0)
 SetTelescopeCapability sets the Telescope capabilities. More...
 
bool CanGOTO ()
 
bool CanSync ()
 
bool CanAbort ()
 
bool CanPark ()
 
bool CanControlTrack ()
 
bool HasTime ()
 
bool HasLocation ()
 
bool HasPierSide ()
 
bool HasPECState ()
 
bool HasTrackMode ()
 
bool HasTrackRate ()
 
virtual void TimerHit ()
 Called when setTimer() time is up. More...
 
void SetParkDataType (TelescopeParkData type)
 setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More...
 
bool InitPark ()
 InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. More...
 
bool isParked ()
 isParked is mount currently parked? More...
 
void SetParked (bool isparked)
 SetParked Change the mount parking status. More...
 
double GetAxis1Park () const
 
double GetAxis1ParkDefault () const
 
double GetAxis2Park () const
 
double GetAxis2ParkDefault () const
 
void SetAxis1Park (double value)
 SetRAPark Set current RA/AZ parking position. More...
 
void SetAxis1ParkDefault (double steps)
 SetRAPark Set default RA/AZ parking position. More...
 
void SetAxis2Park (double steps)
 SetDEPark Set current DEC/ALT parking position. More...
 
void SetAxis2ParkDefault (double steps)
 SetDEParkDefault Set default DEC/ALT parking position. More...
 
bool isLocked () const
 isLocked is mount currently locked? More...
 
void setTelescopeConnection (const uint8_t &value)
 setTelescopeConnection Set telescope connection mode. More...
 
uint8_t getTelescopeConnection () const
 
void setPierSide (TelescopePierSide side)
 
TelescopePierSide getPierSide ()
 
void setPECState (TelescopePECState state)
 
TelescopePECState getPECState ()
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
- Public Member Functions inherited from INDI::GuiderInterface
virtual void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 
virtual void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 

Public Attributes

enum LX200Telescope:: { ... }  LX200Capability
 
- Public Attributes inherited from INDI::Telescope
enum INDI::Telescope:: { ... }  TelescopeConnection
 
enum INDI::Telescope:: { ... }  TelescopeCapability
 
enum INDI::Telescope:: { ... }  TelescopeConnection
 
enum INDI::Telescope:: { ... }  TelescopeCapability
 

Protected Member Functions

virtual bool SetSlewRate (int index) override
 SetSlewRate Set desired slew rate index. More...
 
virtual bool SetTrackMode (uint8_t mode) override
 SetTrackMode Set active tracking mode. More...
 
virtual bool MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override
 Start or Stop the telescope motion in the direction dir. More...
 
virtual bool MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override
 Move the telescope in the direction dir. More...
 
virtual bool Abort () override
 Abort any telescope motion including tracking if possible. More...
 
virtual bool updateTime (ln_date *utc, double utc_offset) override
 Update telescope time, date, and UTC offset. More...
 
virtual bool updateLocation (double latitude, double longitude, double elevation) override
 Update telescope location settings. More...
 
virtual IPState GuideNorth (uint32_t ms) override
 Guide north for ms milliseconds. More...
 
virtual IPState GuideSouth (uint32_t ms) override
 Guide south for ms milliseconds. More...
 
virtual IPState GuideEast (uint32_t ms) override
 Guide east for ms milliseconds. More...
 
virtual IPState GuideWest (uint32_t ms) override
 Guide west for ms milliseconds. More...
 
virtual int SendPulseCmd (int8_t direction, uint32_t duration_msec)
 
virtual bool Goto (double ra, double dec) override
 Move the scope to the supplied RA and DEC coordinates. More...
 
virtual bool isSlewComplete ()
 
virtual bool Park () override
 Park the telescope to its home position. More...
 
virtual bool Sync (double ra, double dec) override
 Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates. More...
 
virtual bool checkConnection ()
 
virtual bool saveConfigItems (FILE *fp) override
 saveConfigItems Save specific properties in the provide config file handler. More...
 
virtual void debugTriggered (bool enable) override
 Inform driver that the debug option was triggered. More...
 
virtual void getBasicData ()
 
virtual bool getLocalDate (char *dateString)
 
virtual bool setLocalDate (uint8_t days, uint8_t months, uint16_t years)
 
virtual bool getLocalTime (char *timeString)
 
virtual bool setLocalTime24 (uint8_t hour, uint8_t minute, uint8_t second)
 
virtual bool setUTCOffset (double offset)
 
virtual bool getUTFOffset (double *offset)
 
void slewError (int slewCode)
 
void getAlignment ()
 
bool sendScopeTime ()
 
bool sendScopeLocation ()
 
bool updateSlewRate (int index)
 
void mountSim ()
 
void guideTimeoutNS ()
 
void guideTimeoutWE ()
 
- Protected Member Functions inherited from INDI::Telescope
void NewRaDec (double ra, double dec)
 The child class calls this function when it has updates. More...
 
virtual bool UnPark ()
 Unpark the telescope if already parked. More...
 
virtual bool SetTrackRate (double raRate, double deRate)
 SetTrackRate Set custom tracking rates. More...
 
virtual int AddTrackMode (const char *name, const char *label, bool isDefault=false)
 AddTrackMode. More...
 
virtual bool SetTrackEnabled (bool enabled)
 SetTrackEnabled Engages or disengages mount tracking. More...
 
virtual bool SetParkPosition (double Axis1Value, double Axis2Value)
 SetParkPosition Set desired parking position to the supplied value. More...
 
virtual bool SetCurrentPark ()
 SetCurrentPark Set current coordinates/encoders value as the desired parking position. More...
 
virtual bool SetDefaultPark ()
 SetDefaultPark Set default coordinates/encoders value as the desired parking position. More...
 
bool callHandshake ()
 callHandshake Helper function that sets the port file descriptor before calling the actual Handshake function implenented in drivers More...
 
void processNSWE (double mag, double angle)
 
void processJoystick (const char *joystick_n, double mag, double angle)
 
void processSlewPresets (double mag, double angle)
 
void processButton (const char *button_n, ISState state)
 
bool LoadScopeConfig ()
 Load scope settings from XML files. More...
 
bool HasDefaultScopeConfig ()
 Load scope settings from XML files. More...
 
bool UpdateScopeConfig ()
 Save scope settings to XML files. More...
 
std::string GetHomeDirectory () const
 Validate a file name. More...
 
int GetScopeConfigIndex () const
 Get the scope config index. More...
 
bool CheckFile (const std::string &file_name, bool writable) const
 Check if a file exists and it is readable. More...
 
void sendTimeFromSystem ()
 
char * LoadParkData ()
 
bool WriteParkData ()
 
void NewRaDec (double ra, double dec)
 The child class calls this function when it has updates. More...
 
virtual bool UnPark ()
 Unpark the telescope if already parked. More...
 
virtual bool SetTrackRate (double raRate, double deRate)
 SetTrackRate Set custom tracking rates. More...
 
virtual int AddTrackMode (const char *name, const char *label, bool isDefault=false)
 AddTrackMode. More...
 
virtual bool SetTrackEnabled (bool enabled)
 SetTrackEnabled Engages or disengages mount tracking. More...
 
virtual bool SetParkPosition (double Axis1Value, double Axis2Value)
 SetParkPosition Set desired parking position to the supplied value. More...
 
virtual bool SetCurrentPark ()
 SetCurrentPark Set current coordinates/encoders value as the desired parking position. More...
 
virtual bool SetDefaultPark ()
 SetDefaultPark Set default coordinates/encoders value as the desired parking position. More...
 
bool callHandshake ()
 callHandshake Helper function that sets the port file descriptor before calling the actual Handshake function implenented in drivers More...
 
void processNSWE (double mag, double angle)
 
void processJoystick (const char *joystick_n, double mag, double angle)
 
void processSlewPresets (double mag, double angle)
 
void processButton (const char *button_n, ISState state)
 
bool LoadScopeConfig ()
 Load scope settings from XML files. More...
 
bool HasDefaultScopeConfig ()
 Load scope settings from XML files. More...
 
bool UpdateScopeConfig ()
 Save scope settings to XML files. More...
 
std::string GetHomeDirectory () const
 Validate a file name. More...
 
int GetScopeConfigIndex () const
 Get the scope config index. More...
 
bool CheckFile (const std::string &file_name, bool writable) const
 Check if a file exists and it is readable. More...
 
void sendTimeFromSystem ()
 
char * LoadParkData ()
 
bool WriteParkData ()
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
- Protected Member Functions inherited from INDI::GuiderInterface
 GuiderInterface ()
 
 ~GuiderInterface ()
 
void initGuiderProperties (const char *deviceName, const char *groupName)
 Initilize guider properties. More...
 
void processGuiderProperties (const char *name, double values[], char *names[], int n)
 Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. More...
 
 GuiderInterface ()
 
 ~GuiderInterface ()
 
void initGuiderProperties (const char *deviceName, const char *groupName)
 Initilize guider properties. More...
 
void processGuiderProperties (const char *name, double values[], char *names[], int n)
 Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. More...
 

Static Protected Member Functions

static void updateFocusHelper (void *p)
 
static void guideTimeoutHelperNS (void *p)
 
static void guideTimeoutHelperWE (void *p)
 

Protected Attributes

int GuideNSTID { -1 }
 
int GuideWETID { -1 }
 
int8_t guide_direction_ns { -1 }
 
int8_t guide_direction_we { -1 }
 
int timeFormat =-1
 
int currentSiteNum
 
int trackingMode
 
bool sendTimeOnStartup =true
 
bool sendLocationOnStartup =true
 
uint8_t DBG_SCOPE
 
double JD
 
double targetRA
 
double targetDEC
 
double currentRA
 
double currentDEC
 
int MaxReticleFlashRate
 
ISwitchVectorProperty AlignmentSP
 
ISwitch AlignmentS [3]
 
INumberVectorProperty TrackingFreqNP
 
INumber TrackFreqN [1]
 
ISwitchVectorProperty UsePulseCmdSP
 
ISwitch UsePulseCmdS [2]
 
bool usePulseCommand { false }
 
ISwitchVectorProperty SiteSP
 
ISwitch SiteS [4]
 
ITextVectorProperty SiteNameTP
 
IText SiteNameT [1] {}
 
ISwitchVectorProperty FocusMotionSP
 
ISwitch FocusMotionS [2]
 
INumberVectorProperty FocusTimerNP
 
INumber FocusTimerN [1]
 
ISwitchVectorProperty FocusModeSP
 
ISwitch FocusModeS [3]
 
uint32_t genericCapability
 
- Protected Attributes inherited from INDI::Telescope
TelescopeStatus TrackState
 This is a variable filled in by the ReadStatus telescope low level code, used to report current state are we slewing, tracking, or parked. More...
 
TelescopeStatus RememberTrackState
 RememberTrackState Remember last state of Track State to fall back to in case of errors or aborts. More...
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
INumberVectorProperty TargetNP
 
INumber TargetN [2]
 
ISwitchVectorProperty AbortSP
 
ISwitch AbortS [1]
 
ISwitchVectorProperty CoordSP
 
ISwitch CoordS [3]
 
INumberVectorProperty LocationNP
 
INumber LocationN [3]
 
ISwitchVectorProperty ParkSP
 
ISwitch ParkS [2]
 
INumber ParkPositionN [2]
 
INumberVectorProperty ParkPositionNP
 
ISwitch ParkOptionS [3]
 
ISwitchVectorProperty ParkOptionSP
 
ISwitch MovementNSS [2]
 
ISwitchVectorProperty MovementNSSP
 
ISwitch MovementWES [2]
 
ISwitchVectorProperty MovementWESP
 
ISwitchVectorProperty SlewRateSP
 
ISwitchSlewRateS
 
INumber ScopeParametersN [4]
 
INumberVectorProperty ScopeParametersNP
 
IText TimeT [2] {}
 
ITextVectorProperty TimeTP
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [2] {}
 
ISwitchVectorProperty DomeClosedLockTP
 
ISwitch DomeClosedLockT [4]
 
ISwitch LockAxisS [2]
 
ISwitchVectorProperty LockAxisSP
 
ISwitch PierSideS [2]
 
ISwitchVectorProperty PierSideSP
 
TelescopePierSide lastPierSide
 
TelescopePierSide currentPierSide
 
ISwitch PECStateS [2]
 
ISwitchVectorProperty PECStateSP
 
ISwitchVectorProperty TrackModeSP
 
ISwitchTrackModeS { nullptr }
 
ISwitchVectorProperty TrackStateSP
 
ISwitch TrackStateS [2]
 
INumberVectorProperty TrackRateNP
 
INumber TrackRateN [2]
 
TelescopePECState lastPECState
 
TelescopePECState currentPECState
 
uint32_t capability
 
int last_we_motion
 
int last_ns_motion
 
int PortFD = -1
 
Connection::SerialserialConnection = NULL
 
Connection::TCPtcpConnection = NULL
 
const std::string ScopeConfigRootXmlNode { "scopeconfig" }
 
const std::string ScopeConfigDeviceXmlNode { "device" }
 
const std::string ScopeConfigNameXmlNode { "name" }
 
const std::string ScopeConfigScopeFocXmlNode { "scopefoc" }
 
const std::string ScopeConfigScopeApXmlNode { "scopeap" }
 
const std::string ScopeConfigGScopeFocXmlNode { "gscopefoc" }
 
const std::string ScopeConfigGScopeApXmlNode { "gscopeap" }
 
const std::string ScopeConfigLabelApXmlNode { "label" }
 
ISwitch ScopeConfigs [6]
 
ISwitchVectorProperty ScopeConfigsSP
 
ITextVectorProperty ScopeConfigNameTP
 
IText ScopeConfigNameT [1] {}
 
const std::string ScopeConfigFileName
 The telescope/guide scope configuration file name. More...
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 
- Protected Attributes inherited from INDI::GuiderInterface
INumber GuideNSN [2]
 
INumberVectorProperty GuideNSNP
 
INumber GuideWEN [2]
 
INumberVectorProperty GuideWENP
 

Additional Inherited Members

- Static Public Member Functions inherited from INDI::Telescope
static void joystickHelper (const char *joystick_n, double mag, double angle, void *context)
 
static void buttonHelper (const char *button_n, ISState state, void *context)
 
static void joystickHelper (const char *joystick_n, double mag, double angle, void *context)
 
static void buttonHelper (const char *button_n, ISState state, void *context)
 
- Protected Types inherited from INDI::Telescope
enum  {
  SCOPE_CONFIG1, SCOPE_CONFIG2, SCOPE_CONFIG3, SCOPE_CONFIG4,
  SCOPE_CONFIG5, SCOPE_CONFIG6
}
 
enum  {
  SCOPE_CONFIG1, SCOPE_CONFIG2, SCOPE_CONFIG3, SCOPE_CONFIG4,
  SCOPE_CONFIG5, SCOPE_CONFIG6
}
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
LX200_HAS_FOCUS 
LX200_HAS_TRACKING_FREQ 

Define focus properties.

LX200_HAS_ALIGNMENT_TYPE 

Define Tracking Frequency.

LX200_HAS_SITES 

Define Alignment Type.

LX200_HAS_PULSE_GUIDING 

Define Sites.

Constructor & Destructor Documentation

◆ LX200Telescope()

LX200Telescope::LX200Telescope ( )
default

◆ ~LX200Telescope()

virtual LX200Telescope::~LX200Telescope ( )
virtualdefault

Member Function Documentation

◆ Abort()

bool LX200Telescope::Abort ( )
overrideprotectedvirtual

Abort any telescope motion including tracking if possible.

Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200Pulsar2.

◆ checkConnection()

bool LX200Telescope::checkConnection ( )
protectedvirtual

◆ debugTriggered()

void LX200Telescope::debugTriggered ( bool  enable)
overrideprotectedvirtual

Inform driver that the debug option was triggered.

This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled.

Parameters
enableIf true, the debug option is set to ON.

Reimplemented from INDI::DefaultDevice.

Reimplemented in LX200AstroPhysicsExperimental, LX200AstroPhysics, and LX200AstroPhysicsGTOCP2.

◆ getAlignment()

void LX200Telescope::getAlignment ( )
protected

◆ getBasicData()

void LX200Telescope::getBasicData ( void  )
protectedvirtual

◆ getDefaultName()

const char * LX200Telescope::getDefaultName ( )
overridevirtual

◆ getDriverName()

const char * LX200Telescope::getDriverName ( )
overridevirtual
Returns
driver name

Reimplemented from INDI::DefaultDevice.

◆ getLocalDate()

bool LX200Telescope::getLocalDate ( char *  dateString)
protectedvirtual

◆ getLocalTime()

bool LX200Telescope::getLocalTime ( char *  timeString)
protectedvirtual

◆ getLX200Capability()

uint32_t LX200Telescope::getLX200Capability ( ) const
inline

◆ getUTFOffset()

bool LX200Telescope::getUTFOffset ( double *  offset)
protectedvirtual

◆ Goto()

bool LX200Telescope::Goto ( double  ra,
double  dec 
)
overrideprotectedvirtual

Move the scope to the supplied RA and DEC coordinates.

Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Pulsar2, LX200AstroPhysicsGTOCP2, ioptronHC8406, LX200ZEQ25, and LX200GotoNova.

◆ GuideEast()

IPState LX200Telescope::GuideEast ( uint32_t  ms)
overrideprotectedvirtual

Guide east for ms milliseconds.

East is defined as RA+

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implements INDI::GuiderInterface.

Reimplemented in LX200AstroPhysicsExperimental, and LX200Pulsar2.

◆ GuideNorth()

IPState LX200Telescope::GuideNorth ( uint32_t  ms)
overrideprotectedvirtual

Guide north for ms milliseconds.

North is defined as DEC+

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implements INDI::GuiderInterface.

Reimplemented in LX200AstroPhysicsExperimental, and LX200Pulsar2.

◆ GuideSouth()

IPState LX200Telescope::GuideSouth ( uint32_t  ms)
overrideprotectedvirtual

Guide south for ms milliseconds.

South is defined as DEC-

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implements INDI::GuiderInterface.

Reimplemented in LX200AstroPhysicsExperimental, and LX200Pulsar2.

◆ guideTimeoutHelperNS()

void LX200Telescope::guideTimeoutHelperNS ( void *  p)
staticprotected

◆ guideTimeoutHelperWE()

void LX200Telescope::guideTimeoutHelperWE ( void *  p)
staticprotected

◆ guideTimeoutNS()

void LX200Telescope::guideTimeoutNS ( )
protected

◆ guideTimeoutWE()

void LX200Telescope::guideTimeoutWE ( )
protected

◆ GuideWest()

IPState LX200Telescope::GuideWest ( uint32_t  ms)
overrideprotectedvirtual

Guide west for ms milliseconds.

West is defined as RA-

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implements INDI::GuiderInterface.

Reimplemented in LX200AstroPhysicsExperimental, and LX200Pulsar2.

◆ Handshake()

bool LX200Telescope::Handshake ( )
overridevirtual

perform handshake with device to check communication

Reimplemented from INDI::Telescope.

Reimplemented in LX200_10MICRON, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, and LX200Pulsar2.

◆ initProperties()

bool LX200Telescope::initProperties ( )
overridevirtual

◆ ISGetProperties()

void LX200Telescope::ISGetProperties ( const char *  dev)
overridevirtual

define the driver's properties to the client.

Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters
devname of the device
Note
This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::Telescope.

Reimplemented in LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200Gemini, LX200Pulsar2, LX200_16, LX200GPS, LX200Classic, and LX200Autostar.

◆ ISNewNumber()

bool LX200Telescope::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Telescope.

Reimplemented in LX200_10MICRON, LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, LX200_16, LX200Classic, LX200ZEQ25, LX200SS2000PC, LX200Autostar, and LX200FS2.

◆ ISNewSwitch()

bool LX200Telescope::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Telescope.

Reimplemented in LX200_10MICRON, LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Pulsar2, LX200Gemini, LX200_16, LX200Classic, ioptronHC8406, LX200AstroPhysicsGTOCP2, LX200GPS, LX200Autostar, LX200GotoNova, and LX200ZEQ25.

◆ ISNewText()

bool LX200Telescope::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Telescope.

Reimplemented in LX200_10MICRON, and LX200Pulsar2.

◆ isSlewComplete()

bool LX200Telescope::isSlewComplete ( void  )
protectedvirtual

◆ mountSim()

void LX200Telescope::mountSim ( )
protected

◆ MoveNS()

bool LX200Telescope::MoveNS ( INDI_DIR_NS  dir,
TelescopeMotionCommand  command 
)
overrideprotectedvirtual

Start or Stop the telescope motion in the direction dir.

Parameters
dirdirection of motion
commandStart or Stop command
Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200ZEQ25, and LX200Pulsar2.

◆ MoveWE()

bool LX200Telescope::MoveWE ( INDI_DIR_WE  dir,
TelescopeMotionCommand  command 
)
overrideprotectedvirtual

Move the telescope in the direction dir.

Parameters
dirdirection of motion
commandStart or Stop command
Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200ZEQ25, and LX200Pulsar2.

◆ Park()

bool LX200Telescope::Park ( )
overrideprotectedvirtual

Park the telescope to its home position.

Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200_10MICRON, LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, ioptronHC8406, LX200ZEQ25, LX200Pulsar2, LX200GotoNova, LX200Gemini, LX200AstroPhysicsGTOCP2, and LX200FS2.

◆ ReadScopeStatus()

bool LX200Telescope::ReadScopeStatus ( )
overridevirtual

Read telescope status.

This function checks the following:

  1. Check if the link to the telescope is alive.
  2. Update telescope status: Idle, Slewing, Parking..etc.
  3. Read coordinates
Returns
True if reading scope status is OK, false if an error is encounterd.
Note
This function is not implemented in Telescope, it must be implemented in the child class

Implements INDI::Telescope.

Reimplemented in LX200_10MICRON, LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, ioptronHC8406, LX200ZEQ25, LX200AstroPhysicsGTOCP2, LX200GotoNova, LX200_16, and LX200Pulsar2.

◆ saveConfigItems()

bool LX200Telescope::saveConfigItems ( FILE *  fp)
overrideprotectedvirtual

saveConfigItems Save specific properties in the provide config file handler.

Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

Parameters
fpPointer to config file handler
Returns
True if successful, false otherwise.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysicsExperimental, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200Gemini, ioptronHC8406, LX200GotoNova, LX200SS2000PC, and LX200FS2.

◆ SendPulseCmd()

int LX200Telescope::SendPulseCmd ( int8_t  direction,
uint32_t  duration_msec 
)
protectedvirtual

◆ sendScopeLocation()

bool LX200Telescope::sendScopeLocation ( )
protected

◆ sendScopeTime()

bool LX200Telescope::sendScopeTime ( )
protected

◆ setLocalDate()

bool LX200Telescope::setLocalDate ( uint8_t  days,
uint8_t  months,
uint16_t  years 
)
protectedvirtual

Reimplemented in LX200_10MICRON, and LX200_OnStep.

◆ setLocalTime24()

bool LX200Telescope::setLocalTime24 ( uint8_t  hour,
uint8_t  minute,
uint8_t  second 
)
protectedvirtual

◆ setLX200Capability()

void LX200Telescope::setLX200Capability ( uint32_t  cap)
inline

◆ SetSlewRate()

bool LX200Telescope::SetSlewRate ( int  index)
overrideprotectedvirtual

SetSlewRate Set desired slew rate index.

Parameters
indexIndex of slew rate where 0 is slowest rate and capability.nSlewRate-1 is maximum rate.
Returns
True is operation successful, false otherwise.
Note
This function as implemented in Telescope performs no function and always return true. Only reimplement it if you need to issue a command to change the slew rate at the hardware level. Most telescope drivers only utilize slew rate when issuing a motion command.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200ZEQ25, LX200GotoNova, and LX200Pulsar2.

◆ SetTrackMode()

bool LX200Telescope::SetTrackMode ( uint8_t  mode)
overrideprotectedvirtual

SetTrackMode Set active tracking mode.

Do not change track state.

Parameters
modeIndex of track mode.
Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysicsExperimental, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200Gemini, ioptronHC8406, LX200ZEQ25, and LX200GotoNova.

◆ setUTCOffset()

bool LX200Telescope::setUTCOffset ( double  offset)
protectedvirtual

Reimplemented in LX200SS2000PC.

◆ slewError()

void LX200Telescope::slewError ( int  slewCode)
protected

◆ Sync()

bool LX200Telescope::Sync ( double  ra,
double  dec 
)
overrideprotectedvirtual

Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates.

Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Pulsar2, LX200AstroPhysicsGTOCP2, ioptronHC8406, and LX200GotoNova.

◆ updateFocusHelper()

void LX200Telescope::updateFocusHelper ( void *  p)
staticprotected

◆ updateFocusTimer()

void LX200Telescope::updateFocusTimer ( )

◆ updateLocation()

bool LX200Telescope::updateLocation ( double  latitude,
double  longitude,
double  elevation 
)
overrideprotectedvirtual

Update telescope location settings.

Parameters
latitudeSite latitude in degrees.
longitudeSite latitude in degrees increasing eastward from Greenwich (0 to 360).
elevationSite elevation in meters.
Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200Pulsar2, ioptronHC8406, LX200GotoNova, LX200ZEQ25, LX200SS2000PC, and LX200FS2.

◆ updateProperties()

bool LX200Telescope::updateProperties ( )
overridevirtual

◆ updateSlewRate()

bool LX200Telescope::updateSlewRate ( int  index)
protected

◆ updateTime()

bool LX200Telescope::updateTime ( ln_date *  utc,
double  utc_offset 
)
overrideprotectedvirtual

Update telescope time, date, and UTC offset.

Parameters
utcUTC time.
utc_offsetUTC offset in hours.
Returns
True if successful, false otherwise
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Reimplemented in LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200Pulsar2, ioptronHC8406, LX200GotoNova, LX200ZEQ25, LX200GPS, and LX200SS2000PC.

Member Data Documentation

◆ AlignmentS

ISwitch LX200Telescope::AlignmentS[3]
protected

◆ AlignmentSP

ISwitchVectorProperty LX200Telescope::AlignmentSP
protected

◆ currentDEC

double LX200Telescope::currentDEC
protected

◆ currentRA

double LX200Telescope::currentRA
protected

◆ currentSiteNum

int LX200Telescope::currentSiteNum
protected

◆ DBG_SCOPE

uint8_t LX200Telescope::DBG_SCOPE
protected

◆ FocusModeS

ISwitch LX200Telescope::FocusModeS[3]
protected

◆ FocusModeSP

ISwitchVectorProperty LX200Telescope::FocusModeSP
protected

◆ FocusMotionS

ISwitch LX200Telescope::FocusMotionS[2]
protected

◆ FocusMotionSP

ISwitchVectorProperty LX200Telescope::FocusMotionSP
protected

◆ FocusTimerN

INumber LX200Telescope::FocusTimerN[1]
protected

◆ FocusTimerNP

INumberVectorProperty LX200Telescope::FocusTimerNP
protected

◆ genericCapability

uint32_t LX200Telescope::genericCapability
protected

◆ guide_direction_ns

int8_t LX200Telescope::guide_direction_ns { -1 }
protected

◆ guide_direction_we

int8_t LX200Telescope::guide_direction_we { -1 }
protected

◆ GuideNSTID

int LX200Telescope::GuideNSTID { -1 }
protected

◆ GuideWETID

int LX200Telescope::GuideWETID { -1 }
protected

◆ JD

double LX200Telescope::JD
protected

◆ LX200Capability

enum { ... } LX200Telescope::LX200Capability

◆ MaxReticleFlashRate

int LX200Telescope::MaxReticleFlashRate
protected

◆ sendLocationOnStartup

bool LX200Telescope::sendLocationOnStartup =true
protected

◆ sendTimeOnStartup

bool LX200Telescope::sendTimeOnStartup =true
protected

◆ SiteNameT

IText LX200Telescope::SiteNameT[1] {}
protected

◆ SiteNameTP

ITextVectorProperty LX200Telescope::SiteNameTP
protected

◆ SiteS

ISwitch LX200Telescope::SiteS[4]
protected

◆ SiteSP

ISwitchVectorProperty LX200Telescope::SiteSP
protected

◆ targetDEC

double LX200Telescope::targetDEC
protected

◆ targetRA

double LX200Telescope::targetRA
protected

◆ timeFormat

int LX200Telescope::timeFormat =-1
protected

◆ TrackFreqN

INumber LX200Telescope::TrackFreqN[1]
protected

◆ TrackingFreqNP

INumberVectorProperty LX200Telescope::TrackingFreqNP
protected

◆ trackingMode

int LX200Telescope::trackingMode
protected

◆ UsePulseCmdS

ISwitch LX200Telescope::UsePulseCmdS[2]
protected

◆ UsePulseCmdSP

ISwitchVectorProperty LX200Telescope::UsePulseCmdSP
protected

◆ usePulseCommand

bool LX200Telescope::usePulseCommand { false }
protected

The documentation for this class was generated from the following files: