Instrument Neutral Distributed Interface INDI  1.9.2
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:
INDI::Telescope INDI::GuiderInterface INDI::FocuserInterface INDI::DefaultDevice INDI::BaseDevice LX200Generic EQ500X ioptronHC8406 LX200_10MICRON LX200_OnStep LX200AstroPhysics LX200AstroPhysicsExperimental LX200AstroPhysicsGTOCP2 LX200Autostar LX200Classic LX200FS2 LX200Gemini LX200GotoNova LX200Pulsar2 LX200SS2000PC LX200ZEQ25

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, LX200_HAS_PRECISE_TRACKING_FREQ = 1 << 5
}
 
- Public Types inherited from INDI::Telescope
enum  TelescopeStatus {
  SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING, SCOPE_PARKING,
  SCOPE_PARKED
}
 
enum  TelescopeMotionCommand { MOTION_START = 0, MOTION_STOP }
 
enum  TelescopeSlewRate { SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX }
 
enum  TelescopeTrackMode { TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM }
 
enum  TelescopeTrackState { 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
}
 
enum  TelescopeLocation { LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION }
 
enum  TelescopePierSide { PIER_UNKNOWN = -1, PIER_WEST = 0, PIER_EAST = 1 }
 
enum  TelescopePECState { PEC_UNKNOWN = -1, PEC_OFF = 0, PEC_ON = 1 }
 
enum  DomeLockingPolicy { DOME_IGNORED, DOME_LOCKS }
 
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, TELESCOPE_HAS_PIER_SIDE_SIMULATION = 1 << 11,
  TELESCOPE_CAN_TRACK_SATELLITE = 1 << 12
}
 
- 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 }
 
enum  { INDI_ENABLED, INDI_DISABLED }
 
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), CORRELATOR_INTERFACE = (1 << 14),
  AUX_INTERFACE = (1 << 15), SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 
typedef INDI::Properties Properties
 
- Public Types inherited from INDI::FocuserInterface
enum  FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD }
 
enum  {
  FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_CAN_REVERSE = 1 << 3,
  FOCUSER_CAN_SYNC = 1 << 4, FOCUSER_HAS_VARIABLE_SPEED = 1 << 5, FOCUSER_HAS_BACKLASH = 1 << 6
}
 

Public Member Functions

 LX200Telescope ()
 
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. 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. 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) override
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. 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. All capabilities must be initialized. More...
 
bool CanGOTO ()
 
bool CanSync ()
 
bool CanAbort ()
 
bool CanPark ()
 
bool CanControlTrack ()
 
bool HasTime ()
 
bool HasLocation ()
 
bool HasPierSide ()
 
bool HasPierSideSimulation ()
 
bool CanTrackSatellite ()
 
bool HasPECState ()
 
bool HasTrackMode ()
 
bool HasTrackRate ()
 
virtual void TimerHit () override
 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. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. More...
 
double GetAxis1Park () const
 
double GetAxis1ParkDefault () const
 
double GetAxis2Park () const
 
double GetAxis2ParkDefault () const
 
void SetAxis1Park (double value)
 SetRAPark Set current RA/AZ parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. More...
 
void SetAxis1ParkDefault (double steps)
 SetRAPark Set default RA/AZ parking position. More...
 
void SetAxis2Park (double steps)
 SetDEPark Set current DEC/ALT parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. 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. Child class should call this in the constructor before Telescope registers any connection interfaces 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 () override=default
 
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) __attribute__((deprecated))
 Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (INumberVectorProperty *property)
 
void defineText (ITextVectorProperty *tvp) __attribute__((deprecated))
 Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (ITextVectorProperty *property)
 
void defineSwitch (ISwitchVectorProperty *svp) __attribute__((deprecated))
 Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (ISwitchVectorProperty *property)
 
void defineLight (ILightVectorProperty *lvp) __attribute__((deprecated))
 Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (ILightVectorProperty *property)
 
void defineBLOB (IBLOBVectorProperty *bvp) __attribute__((deprecated))
 Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (IBLOBVectorProperty *property)
 
void defineProperty (INDI::Property &property)
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. It will also be deleted from all clients. 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 () const
 
uint16_t getMinorVersion () const
 
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 () override
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INDI::PropertyView< INumber > * getNumber (const char *name) const
 
INDI::PropertyView< IText > * getText (const char *name) const
 
INDI::PropertyView< ISwitch > * getSwitch (const char *name) const
 
INDI::PropertyView< ILight > * getLight (const char *name) const
 
INDI::PropertyView< IBLOB > * getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
void registerProperty (ITextVectorProperty *property)
 
void registerProperty (INumberVectorProperty *property)
 
void registerProperty (ISwitchVectorProperty *property)
 
void registerProperty (ILightVectorProperty *property)
 
void registerProperty (IBLOBVectorProperty *property)
 
void registerProperty (INDI::PropertyView< IText > *property)
 
void registerProperty (INDI::PropertyView< INumber > *property)
 
void registerProperty (INDI::PropertyView< ISwitch > *property)
 
void registerProperty (INDI::PropertyView< ILight > *property)
 
void registerProperty (INDI::PropertyView< IBLOB > *property)
 
void registerProperty (INDI::Property &property)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Property getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Properties getProperties ()
 Return a list of all properties in the device. More...
 
const Properties getProperties () const
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
const std::string & messageQueue (size_t index) const
 
const std::string & lastMessage () const
 
bool isConnected () const
 
void setMediator (INDI::BaseMediator *mediator)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator () const
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName () const
 
bool isDeviceNameMatch (const char *otherName) const
 Check that the device name matches the argument. More...
 
bool isDeviceNameMatch (const std::string &otherName) const
 Check that the device name matches the argument. More...
 
const char * getDriverName () const
 
const char * getDriverExec () const
 
const char * getDriverVersion () const
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. 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...
 
- Public Member Functions inherited from INDI::GuiderInterface
virtual void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 
- Public Member Functions inherited from INDI::FocuserInterface
uint32_t GetCapability () const
 GetFocuserCapability returns the capability of the focuser. More...
 
void SetCapability (uint32_t cap)
 FI::SetCapability sets the focuser capabilities. All capabilities must be initialized. More...
 
bool CanAbsMove ()
 
bool CanRelMove ()
 
bool CanAbort ()
 
bool CanReverse ()
 
bool CanSync ()
 
bool HasVariableSpeed ()
 
bool HasBacklash ()
 

Public Attributes

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

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. Do not change track state. 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. North is defined as DEC+. More...
 
virtual IPState GuideSouth (uint32_t ms) override
 Guide south for ms milliseconds. South is defined as DEC-. More...
 
virtual IPState GuideEast (uint32_t ms) override
 Guide east for ms milliseconds. East is defined as RA+. More...
 
virtual IPState GuideWest (uint32_t ms) override
 Guide west for ms milliseconds. West is defined as RA-. 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. 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. More...
 
virtual void debugTriggered (bool enable) override
 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. 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)
 
virtual void slewError (int slewCode)
 
void getAlignment ()
 
virtual bool sendScopeTime ()
 
virtual bool sendScopeLocation ()
 
bool updateSlewRate (int index)
 
void mountSim ()
 
virtual bool AbortFocuser () override
 AbortFocuser all focus motion. More...
 
virtual bool ReverseFocuser (bool enabled) override
 ReverseFocuser Reverse focuser motion direction. More...
 
virtual IPState MoveFocuser (FocusDirection dir, int speed, uint16_t duration) override
 MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More...
 
virtual bool SetFocuserSpeed (int speed) override
 SetFocuserSpeed Set Focuser speed. More...
 
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. If there are no tracking modes available, it is assumed sidereal. Otherwise, whatever tracking mode should be activated or deactivated accordingly. More...
 
void updateObserverLocation (double latitude, double longitude, double elevation)
 Update location settings of the observer. More...
 
virtual bool SetParkPosition (double Axis1Value, double Axis2Value)
 SetParkPosition Set desired parking position to the supplied value. This ONLY sets the desired park position value and does not perform parking. 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 processAxis (const char *axis_n, double value)
 
void processSlewPresets (double mag, double angle)
 
void processButton (const char *button_n, ISState state)
 
TelescopePierSide expectedPierSide (double ra)
 Calculate the expected pier side for scopes that do not report this property themselves. More...
 
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 ()
 
bool getSimulatePierSide () const
 
void setSimulatePierSide (bool value)
 
const char * getPierSideStr (TelescopePierSide ps)
 
const char * LoadParkData ()
 
bool WriteParkData ()
 
bool PurgeParkData ()
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when ┼▒deleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. 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 purgeConfig ()
 purgeConfig Remove config file from disk. 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. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More...
 
bool isDebug () const
 
bool isSimulation () const
 
virtual bool Connect ()
 Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setActiveConnection (Connection::Interface *existingConnection)
 setActiveConnection Switch the active connection to the passed connection plugin More...
 
void setDefaultPollingPeriod (uint32_t msec)
 setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More...
 
void setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
 setPollingPeriodRange Set the range permitted by the polling range in milliseconds More...
 
uint32_t getPollingPeriod () const
 getPollingPeriod Return the polling period. More...
 
void setCurrentPollingPeriod (uint32_t msec)
 setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More...
 
uint32_t getCurrentPollingPeriod () const
 getCurrentPollingPeriod Return the current polling period. More...
 
uint32_t & refCurrentPollingPeriod () __attribute__((deprecated))
 
uint32_t refCurrentPollingPeriod () const __attribute__((deprecated))
 
bool isConfigLoading () const
 isConfigLoading Check if driver configuration is currently in the process of getting loaded. More...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
 DefaultDevice (DefaultDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::GuiderInterface
 GuiderInterface ()
 
 ~GuiderInterface ()
 
void initGuiderProperties (const char *deviceName, const char *groupName)
 Initilize guider properties. It is recommended to call this function within initProperties() of your primary device. 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. This function then takes care of issuing the corresponding GuideXXXX function accordingly. More...
 
- Protected Member Functions inherited from INDI::FocuserInterface
 FocuserInterface (DefaultDevice *defaultDevice)
 
virtual ~FocuserInterface ()=default
 
void initProperties (const char *groupName)
 Initilize focuser properties. It is recommended to call this function within initProperties() of your primary device. More...
 
bool updateProperties ()
 updateProperties Define or Delete Rotator properties based on the connection status of the base device More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process focus number properties. More...
 
bool processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process focus switch properties. More...
 
virtual IPState MoveAbsFocuser (uint32_t targetTicks)
 MoveFocuser the focuser to an absolute position. More...
 
virtual IPState MoveRelFocuser (FocusDirection dir, uint32_t ticks)
 MoveFocuser the focuser to an relative position. More...
 
virtual bool SyncFocuser (uint32_t ticks)
 SyncFocuser Set current position to ticks without moving the focuser. More...
 
virtual bool SetFocuserMaxPosition (uint32_t ticks)
 SetFocuserMaxPosition Set Focuser Maximum position limit in the hardware. More...
 
virtual bool SetFocuserBacklash (int32_t steps)
 SetFocuserBacklash Set the focuser backlash compensation value. More...
 
virtual bool SetFocuserBacklashEnabled (bool enabled)
 SetFocuserBacklashEnabled Enables or disables the focuser backlash compensation. More...
 
bool saveConfigItems (FILE *fp)
 saveConfigItems save focuser properties defined in the interface in config file 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 {0}
 
int trackingMode {0}
 
bool sendTimeOnStartup = true
 
bool sendLocationOnStartup = true
 
uint8_t DBG_SCOPE {0}
 
double JD {0}
 
double targetRA {0}
 
double targetDEC {0}
 
double currentRA {0.0000001}
 
double currentDEC {0.0000001}
 
int MaxReticleFlashRate {0}
 
ISwitchVectorProperty AlignmentSP
 
ISwitch AlignmentS [3]
 
INumberVectorProperty TrackFreqNP
 
INumber TrackFreqN [1]
 
ISwitchVectorProperty UsePulseCmdSP
 
ISwitch UsePulseCmdS [2]
 
bool usePulseCommand { false }
 
ISwitchVectorProperty SiteSP
 
ISwitch SiteS [4]
 
ITextVectorProperty SiteNameTP
 
IText SiteNameT [1] {}
 
ISwitchVectorProperty FocusModeSP
 
ISwitch FocusModeS [3]
 
uint32_t genericCapability {0}
 
- Protected Attributes inherited from INDI::Telescope
IGeographicCoordinates m_Location { 0, 0, 0 }
 
TelescopeStatus TrackState {SCOPE_IDLE}
 
TelescopeStatus RememberTrackState {SCOPE_IDLE}
 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 [4]
 
ISwitchVectorProperty ParkOptionSP
 
ISwitch MovementNSS [2]
 
ISwitchVectorProperty MovementNSSP
 
ISwitch MovementWES [2]
 
ISwitchVectorProperty MovementWESP
 
ISwitchVectorProperty SlewRateSP
 
ISwitchSlewRateS {nullptr}
 
INumber ScopeParametersN [4]
 
INumberVectorProperty ScopeParametersNP
 
IText TimeT [2] {}
 
ITextVectorProperty TimeTP
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [2] {}
 
ISwitchVectorProperty DomePolicySP
 
ISwitch DomePolicyS [2]
 
ISwitchVectorProperty MotionControlModeTP
 
ISwitch MotionControlModeT [2]
 
ISwitch LockAxisS [2]
 
ISwitchVectorProperty LockAxisSP
 
ISwitch PierSideS [2]
 
ISwitchVectorProperty PierSideSP
 
ISwitchVectorProperty SimulatePierSideSP
 
ISwitch SimulatePierSideS [2]
 
TelescopePierSide lastPierSide
 
TelescopePierSide currentPierSide
 
ITextVectorProperty TLEtoTrackTP
 Text Vector property defining the orbital elements of an artificial satellite (TLE). Example implementation. More...
 
IText TLEtoTrackT [1] {}
 
enum INDI::Telescope:: { ... }  SatelliteWindow
 
ITextVectorProperty SatPassWindowTP
 Text Vector property defining the start and end of a satellite pass (window contains pass). Example implementation. More...
 
IText SatPassWindowT [SAT_PASS_WINDOW_COUNT] {}
 
enum INDI::Telescope:: { ... }  SatelliteTracking
 
ISwitchVectorProperty TrackSatSP
 Switch Vector property defining the state of the satellite tracking of the mount. Example implementation. More...
 
ISwitch TrackSatS [SAT_TRACK_COUNT]
 
ISwitch PECStateS [2]
 
ISwitchVectorProperty PECStateSP
 
ISwitchVectorProperty TrackModeSP
 
ISwitchTrackModeS { nullptr }
 
ISwitchVectorProperty TrackStateSP
 
ISwitch TrackStateS [2]
 
INumberVectorProperty TrackRateNP
 
INumber TrackRateN [2]
 
TelescopePECState lastPECState {PEC_UNKNOWN}
 
TelescopePECState currentPECState {PEC_UNKNOWN}
 
uint32_t capability {0}
 
int last_we_motion {-1}
 
int last_ns_motion {-1}
 
int PortFD = -1
 
Connection::SerialserialConnection = nullptr
 
Connection::TCPtcpConnection = nullptr
 
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::BaseDevice
std::shared_ptr< BaseDevicePrivated_ptr
 
- Protected Attributes inherited from INDI::GuiderInterface
INumber GuideNSN [2]
 
INumberVectorProperty GuideNSNP
 
INumber GuideWEN [2]
 
INumberVectorProperty GuideWENP
 
- Protected Attributes inherited from INDI::FocuserInterface
INumberVectorProperty FocusSpeedNP
 
INumber FocusSpeedN [1]
 
ISwitchVectorProperty FocusMotionSP
 
ISwitch FocusMotionS [2]
 
INumberVectorProperty FocusTimerNP
 
INumber FocusTimerN [1]
 
INumberVectorProperty FocusAbsPosNP
 
INumber FocusAbsPosN [1]
 
INumberVectorProperty FocusRelPosNP
 
INumber FocusRelPosN [1]
 
INumberVectorProperty FocusMaxPosNP
 
INumber FocusMaxPosN [1]
 
INumberVectorProperty FocusSyncNP
 
INumber FocusSyncN [1]
 
ISwitchVectorProperty FocusAbortSP
 
ISwitch FocusAbortS [1]
 
ISwitchVectorProperty FocusReverseSP
 
ISwitch FocusReverseS [2]
 
ISwitchVectorProperty FocusBacklashSP
 
ISwitch FocusBacklashS [2]
 
INumberVectorProperty FocusBacklashNP
 
INumber FocusBacklashN [1]
 
uint32_t capability
 
double lastTimerValue = { 0 }
 
DefaultDevicem_defaultDevice { nullptr }
 

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 axisHelper (const char *axis_n, double value, void *context)
 
static void buttonHelper (const char *button_n, ISState state, void *context)
 
- Protected Types inherited from INDI::Telescope
enum  { PARK_CURRENT, PARK_DEFAULT, PARK_WRITE_DATA, PARK_PURGE_DATA }
 
enum  { MOTION_CONTROL_JOYSTICK, MOTION_CONTROL_AXES }
 
enum  { SAT_PASS_WINDOW_START, SAT_PASS_WINDOW_END, SAT_PASS_WINDOW_COUNT }
 
enum  { SAT_TRACK, SAT_HALT, SAT_TRACK_COUNT }
 
enum  {
  SCOPE_CONFIG1, SCOPE_CONFIG2, SCOPE_CONFIG3, SCOPE_CONFIG4,
  SCOPE_CONFIG5, SCOPE_CONFIG6
}
 

Detailed Description

Definition at line 34 of file lx200telescope.h.

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

LX200_HAS_PRECISE_TRACKING_FREQ 

Define Pulse Guiding

Definition at line 42 of file lx200telescope.h.

Constructor & Destructor Documentation

◆ LX200Telescope()

LX200Telescope::LX200Telescope ( )

Definition at line 42 of file lx200telescope.cpp.

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 EQ500X, and LX200Pulsar2.

Definition at line 546 of file lx200telescope.cpp.

◆ AbortFocuser()

bool LX200Telescope::AbortFocuser ( )
overrideprotectedvirtual

AbortFocuser all focus motion.

Returns
True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Reimplemented in LX200_OnStep.

Definition at line 1639 of file lx200telescope.cpp.

◆ checkConnection()

bool LX200Telescope::checkConnection ( )
protectedvirtual

Reimplemented in EQ500X, LX200Pulsar2, LX200Gemini, ioptronHC8406, LX200ZEQ25, LX200GotoNova, and LX200FS2.

Definition at line 255 of file lx200telescope.cpp.

◆ 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.

Definition at line 46 of file lx200telescope.cpp.

◆ getAlignment()

void LX200Telescope::getAlignment ( )
protected

Definition at line 1218 of file lx200telescope.cpp.

◆ getBasicData()

void LX200Telescope::getBasicData ( )
protectedvirtual

◆ getDefaultName()

const char * LX200Telescope::getDefaultName ( )
overridevirtual

◆ getDriverName()

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

Reimplemented from INDI::DefaultDevice.

Definition at line 52 of file lx200telescope.cpp.

◆ getLocalDate()

bool LX200Telescope::getLocalDate ( char *  dateString)
protectedvirtual

Definition at line 1267 of file lx200telescope.cpp.

◆ getLocalTime()

bool LX200Telescope::getLocalTime ( char *  timeString)
protectedvirtual

Definition at line 1248 of file lx200telescope.cpp.

◆ getLX200Capability()

uint32_t LX200Telescope::getLX200Capability ( ) const
inline

Definition at line 52 of file lx200telescope.h.

◆ 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 EQ500X, LX200Pulsar2, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, ioptronHC8406, LX200ZEQ25, and LX200GotoNova.

Definition at line 321 of file lx200telescope.cpp.

◆ 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.

Definition at line 1494 of file lx200telescope.cpp.

◆ 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.

Definition at line 1416 of file lx200telescope.cpp.

◆ 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.

Definition at line 1455 of file lx200telescope.cpp.

◆ guideTimeoutHelperNS()

void LX200Telescope::guideTimeoutHelperNS ( void *  p)
staticprotected

Definition at line 1577 of file lx200telescope.cpp.

◆ guideTimeoutHelperWE()

void LX200Telescope::guideTimeoutHelperWE ( void *  p)
staticprotected

Definition at line 1582 of file lx200telescope.cpp.

◆ guideTimeoutNS()

void LX200Telescope::guideTimeoutNS ( )
protected

Definition at line 1603 of file lx200telescope.cpp.

◆ guideTimeoutWE()

void LX200Telescope::guideTimeoutWE ( )
protected

Definition at line 1587 of file lx200telescope.cpp.

◆ 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.

Definition at line 1533 of file lx200telescope.cpp.

◆ 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.

Definition at line 263 of file lx200telescope.cpp.

◆ 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, LX200Pulsar2, LX200Gemini, LX200AstroPhysicsGTOCP2, LX200_16, and LX200GPS.

Definition at line 155 of file lx200telescope.cpp.

◆ 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_OnStep, LX200_10MICRON, LX200Pulsar2, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, LX200ZEQ25, LX200SS2000PC, LX200FS2, LX200Classic, and LX200_16.

Definition at line 694 of file lx200telescope.cpp.

◆ 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_OnStep, LX200_10MICRON, LX200Pulsar2, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, ioptronHC8406, LX200AstroPhysicsGTOCP2, LX200GotoNova, LX200ZEQ25, LX200FS2, LX200Classic, LX200_16, and LX200GPS.

Definition at line 784 of file lx200telescope.cpp.

◆ 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.

Definition at line 670 of file lx200telescope.cpp.

◆ isSlewComplete()

bool LX200Telescope::isSlewComplete ( )
protectedvirtual

◆ mountSim()

void LX200Telescope::mountSim ( )
protected

Definition at line 1052 of file lx200telescope.cpp.

◆ MoveFocuser()

IPState LX200Telescope::MoveFocuser ( FocusDirection  dir,
int  speed,
uint16_t  duration 
)
overrideprotectedvirtual

MoveFocuser the focuser in a particular direction with a specific speed for a finite duration.

Parameters
dirDirection of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
speedSpeed of focuser if supported by the focuser.
durationThe timeout in milliseconds before the focus motion halts. Pass 0 to move indefinitely.
Returns
Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

Reimplemented in LX200_OnStep.

Definition at line 1644 of file lx200telescope.cpp.

◆ 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 EQ500X, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200Pulsar2, and LX200ZEQ25.

Definition at line 483 of file lx200telescope.cpp.

◆ 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, LX200Pulsar2, and LX200ZEQ25.

Definition at line 515 of file lx200telescope.cpp.

◆ 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_OnStep, LX200_10MICRON, LX200Pulsar2, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200ZEQ25, ioptronHC8406, LX200GotoNova, LX200Gemini, LX200AstroPhysicsGTOCP2, LX200SS2000PC, LX200Classic, and LX200FS2.

Definition at line 433 of file lx200telescope.cpp.

◆ 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_OnStep, LX200_10MICRON, EQ500X, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, LX200FS2, LX200Classic, ioptronHC8406, LX200ZEQ25, LX200AstroPhysicsGTOCP2, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, and LX200_16.

Definition at line 273 of file lx200telescope.cpp.

◆ ReverseFocuser()

bool LX200Telescope::ReverseFocuser ( bool  enabled)
overrideprotectedvirtual

ReverseFocuser Reverse focuser motion direction.

Parameters
enabledIf true, normal default focuser motion is reversed. If false, the direction is set to the default focuser motion.
Returns
True if successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 1633 of file lx200telescope.cpp.

◆ 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 LX200_OnStep, LX200_10MICRON, LX200AstroPhysicsExperimental, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200Gemini, ioptronHC8406, LX200GotoNova, LX200SS2000PC, LX200FS2, and LX200Classic.

Definition at line 1620 of file lx200telescope.cpp.

◆ SendPulseCmd()

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

◆ sendScopeLocation()

bool LX200Telescope::sendScopeLocation ( )
protectedvirtual

Reimplemented in LX200_OnStep.

Definition at line 1364 of file lx200telescope.cpp.

◆ sendScopeTime()

bool LX200Telescope::sendScopeTime ( )
protectedvirtual

Reimplemented in LX200_OnStep, and ioptronHC8406.

Definition at line 1297 of file lx200telescope.cpp.

◆ SetFocuserSpeed()

bool LX200Telescope::SetFocuserSpeed ( int  speed)
overrideprotectedvirtual

SetFocuserSpeed Set Focuser speed.

Parameters
speedfocuser speed
Returns
true if successful, false otherwise

Reimplemented from INDI::FocuserInterface.

Reimplemented in LX200Autostar.

Definition at line 1660 of file lx200telescope.cpp.

◆ setLocalDate()

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

Reimplemented in LX200_OnStep, and LX200_10MICRON.

Definition at line 582 of file lx200telescope.cpp.

◆ setLocalTime24()

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

Definition at line 587 of file lx200telescope.cpp.

◆ setLX200Capability()

void LX200Telescope::setLX200Capability ( uint32_t  cap)
inline

Definition at line 56 of file lx200telescope.h.

◆ 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, LX200Pulsar2, LX200ZEQ25, and LX200GotoNova.

Definition at line 954 of file lx200telescope.cpp.

◆ 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.

Definition at line 937 of file lx200telescope.cpp.

◆ setUTCOffset()

bool LX200Telescope::setUTCOffset ( double  offset)
protectedvirtual

Reimplemented in LX200SS2000PC.

Definition at line 592 of file lx200telescope.cpp.

◆ slewError()

void LX200Telescope::slewError ( int  slewCode)
protectedvirtual

Reimplemented in LX200_OnStep.

Definition at line 1205 of file lx200telescope.cpp.

◆ 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 EQ500X, LX200ZEQ25, LX200_OnStep, LX200Pulsar2, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, ioptronHC8406, and LX200GotoNova.

Definition at line 403 of file lx200telescope.cpp.

◆ updateFocusHelper()

void LX200Telescope::updateFocusHelper ( void *  p)
staticprotected

Definition at line 987 of file lx200telescope.cpp.

◆ updateFocusTimer()

void LX200Telescope::updateFocusTimer ( )

Definition at line 992 of file lx200telescope.cpp.

◆ 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 EQ500X, LX200_OnStep, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Pulsar2, LX200FS2, LX200AstroPhysicsGTOCP2, ioptronHC8406, LX200ZEQ25, LX200GotoNova, and LX200SS2000PC.

Definition at line 635 of file lx200telescope.cpp.

◆ updateProperties()

bool LX200Telescope::updateProperties ( )
overridevirtual

Called when connected state changes, to add/remove properties.

Reimplemented from INDI::Telescope.

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

Definition at line 193 of file lx200telescope.cpp.

◆ updateSlewRate()

bool LX200Telescope::updateSlewRate ( int  index)
protected

Definition at line 968 of file lx200telescope.cpp.

◆ 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, LX200Pulsar2, LX200AstroPhysicsGTOCP2, ioptronHC8406, LX200ZEQ25, LX200GotoNova, LX200SS2000PC, and LX200GPS.

Definition at line 597 of file lx200telescope.cpp.

Member Data Documentation

◆ AlignmentS

ISwitch LX200Telescope::AlignmentS[3]
protected

Definition at line 183 of file lx200telescope.h.

◆ AlignmentSP

ISwitchVectorProperty LX200Telescope::AlignmentSP
protected

Definition at line 182 of file lx200telescope.h.

◆ currentDEC

double LX200Telescope::currentDEC {0.0000001}
protected

Definition at line 178 of file lx200telescope.h.

◆ currentRA

double LX200Telescope::currentRA {0.0000001}
protected

Definition at line 178 of file lx200telescope.h.

◆ currentSiteNum

int LX200Telescope::currentSiteNum {0}
protected

Definition at line 170 of file lx200telescope.h.

◆ DBG_SCOPE

uint8_t LX200Telescope::DBG_SCOPE {0}
protected

Definition at line 174 of file lx200telescope.h.

◆ FocusModeS

ISwitch LX200Telescope::FocusModeS[3]
protected

Definition at line 204 of file lx200telescope.h.

◆ FocusModeSP

ISwitchVectorProperty LX200Telescope::FocusModeSP
protected

Definition at line 203 of file lx200telescope.h.

◆ genericCapability

uint32_t LX200Telescope::genericCapability {0}
protected

Definition at line 206 of file lx200telescope.h.

◆ guide_direction_ns

int8_t LX200Telescope::guide_direction_ns { -1 }
protected

Definition at line 166 of file lx200telescope.h.

◆ guide_direction_we

int8_t LX200Telescope::guide_direction_we { -1 }
protected

Definition at line 167 of file lx200telescope.h.

◆ GuideNSTID

int LX200Telescope::GuideNSTID { -1 }
protected

Definition at line 164 of file lx200telescope.h.

◆ GuideWETID

int LX200Telescope::GuideWETID { -1 }
protected

Definition at line 165 of file lx200telescope.h.

◆ JD

double LX200Telescope::JD {0}
protected

Definition at line 176 of file lx200telescope.h.

◆ LX200Capability

enum { ... } LX200Telescope::LX200Capability

◆ MaxReticleFlashRate

int LX200Telescope::MaxReticleFlashRate {0}
protected

Definition at line 179 of file lx200telescope.h.

◆ sendLocationOnStartup

bool LX200Telescope::sendLocationOnStartup = true
protected

Definition at line 173 of file lx200telescope.h.

◆ sendTimeOnStartup

bool LX200Telescope::sendTimeOnStartup = true
protected

Definition at line 173 of file lx200telescope.h.

◆ SiteNameT

IText LX200Telescope::SiteNameT[1] {}
protected

Definition at line 200 of file lx200telescope.h.

◆ SiteNameTP

ITextVectorProperty LX200Telescope::SiteNameTP
protected

Definition at line 199 of file lx200telescope.h.

◆ SiteS

ISwitch LX200Telescope::SiteS[4]
protected

Definition at line 196 of file lx200telescope.h.

◆ SiteSP

ISwitchVectorProperty LX200Telescope::SiteSP
protected

Definition at line 195 of file lx200telescope.h.

◆ targetDEC

double LX200Telescope::targetDEC {0}
protected

Definition at line 177 of file lx200telescope.h.

◆ targetRA

double LX200Telescope::targetRA {0}
protected

Definition at line 177 of file lx200telescope.h.

◆ timeFormat

int LX200Telescope::timeFormat = -1
protected

Definition at line 169 of file lx200telescope.h.

◆ TrackFreqN

INumber LX200Telescope::TrackFreqN[1]
protected

Definition at line 187 of file lx200telescope.h.

◆ TrackFreqNP

INumberVectorProperty LX200Telescope::TrackFreqNP
protected

Definition at line 186 of file lx200telescope.h.

◆ trackingMode

int LX200Telescope::trackingMode {0}
protected

Definition at line 171 of file lx200telescope.h.

◆ UsePulseCmdS

ISwitch LX200Telescope::UsePulseCmdS[2]
protected

Definition at line 191 of file lx200telescope.h.

◆ UsePulseCmdSP

ISwitchVectorProperty LX200Telescope::UsePulseCmdSP
protected

Definition at line 190 of file lx200telescope.h.

◆ usePulseCommand

bool LX200Telescope::usePulseCommand { false }
protected

Definition at line 192 of file lx200telescope.h.


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