Instrument Neutral Distributed Interface INDI  2.0.2
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
INDI::Telescope Class Referenceabstract

#include <inditelescope.h>

Inheritance diagram for INDI::Telescope:
INDI::DefaultDevice INDI::ParentDevice INDI::BaseDevice AstroTrac CelestronGPS DSC IEQPro IEQProLegacy IOptronV3 LX200Basic LX200Telescope LX200_TeenAstro MountDriver PMC8 Paramount Rainbow Scope ScopeScript ScopeSim ScopeSim SimpleScope SkyCommander SkywatcherAPIMount SkywatcherAltAzSimple SynscanDriver SynscanLegacyDriver TemmaMount TitanTCS

Public Types

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 , TELESCOPE_CAN_FLIP = 1 << 13
}
 
- Public Types inherited from INDI::ParentDevice
enum  Type { Valid , Invalid }
 
- 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  WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }
 
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 Member Functions

 Telescope ()
 
virtual ~Telescope ()
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch 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 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 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)
 SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized. More...
 
bool CanGOTO ()
 
bool CanSync ()
 
bool CanFlip ()
 
bool CanAbort ()
 
bool CanPark ()
 
bool CanControlTrack ()
 
bool HasTime ()
 
bool HasLocation ()
 
bool HasPierSide ()
 
bool HasPierSideSimulation ()
 
bool CanTrackSatellite ()
 
bool HasPECState ()
 
bool HasTrackMode ()
 
bool HasTrackRate ()
 
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 Handshake ()
 perform handshake with device to check communication More...
 
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...
 
virtual 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)
 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)
 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)
 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)
 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)
 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...
 
bool deleteProperty (INDI::Property &property)
 deleteProperty 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 ()
 
virtual const char * getDriverName ()
 
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...
 
uint16_t getDriverInterface () const
 
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...
 
void watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
 Add a device to the watch list. More...
 
- Public Member Functions inherited from INDI::ParentDevice
 ParentDevice (Type type)
 
 ~ParentDevice ()
 
 ParentDevice (ParentDevice &&other)=default
 
ParentDeviceoperator= (ParentDevice &&other)=default
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
void registerProperty (const INDI::Property &property)
 Register the property to be able to observe and update. More...
 
void registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
 Call the callback function if property is available. 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
 
INDI::PropertyNumber getNumber (const char *name) const
 
INDI::PropertyText getText (const char *name) const
 
INDI::PropertySwitch getSwitch (const char *name) const
 
INDI::PropertyLight getLight (const char *name) const
 
INDI::PropertyBlob getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
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 isValid () const
 
bool isConnected () const
 
void attach ()
 indicates that the device is ready More...
 
void detach ()
 indicates that the device is being removed More...
 
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
 
uint16_t getDriverInterface () const
 getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
int buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (const INDI::LilXmlElement &root, char *errmsg)
 handle SetXXX commands from client More...
 
 operator BaseDevice * ()
 
BaseDeviceoperator-> ()
 
bool operator!= (std::nullptr_t) const
 
bool operator== (std::nullptr_t) const
 
 operator bool () const
 
 operator bool ()
 

Static Public Member Functions

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)
 
- Static Public Member Functions inherited from INDI::BaseDevice
static std::string getSharedFilePath (std::string fileName)
 

Public Attributes

enum INDI::Telescope:: { ... }  TelescopeConnection
 
enum INDI::Telescope:: { ... }  TelescopeCapability
 

Protected Types

enum  { PARK_CURRENT , PARK_DEFAULT , PARK_WRITE_DATA , PARK_PURGE_DATA }
 
enum  { REVERSE_NS , REVERSE_WE }
 
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
}
 

Protected Member Functions

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...
 
void NewRaDec (double ra, double dec)
 The child class calls this function when it has updates. More...
 
virtual bool ReadScopeStatus ()=0
 Read telescope status. More...
 
virtual bool Flip (double ra, double dec)
 Move and flip the scope to the supplied RA and DEC coordinates. More...
 
virtual bool Goto (double ra, double dec)
 Move the scope to the supplied RA and DEC coordinates. More...
 
virtual bool Sync (double ra, double dec)
 Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates. More...
 
virtual bool MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command)
 Start or Stop the telescope motion in the direction dir. More...
 
virtual bool MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command)
 Move the telescope in the direction dir. More...
 
virtual bool Park ()
 Park the telescope to its home position. More...
 
virtual bool UnPark ()
 Unpark the telescope if already parked. More...
 
virtual bool Abort ()
 Abort any telescope motion including tracking if possible. More...
 
virtual bool SetTrackMode (uint8_t mode)
 SetTrackMode Set active tracking mode. Do not change track state. 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...
 
virtual bool updateTime (ln_date *utc, double utc_offset)
 Update telescope time, date, and UTC offset. More...
 
virtual bool updateLocation (double latitude, double longitude, double elevation)
 Update telescope location settings. 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...
 
virtual void SyncParkStatus (bool isparked)
 SyncParkStatus Update the state and switches for parking. More...
 
virtual bool SetSlewRate (int index)
 SetSlewRate Set desired slew rate index. 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...
 
bool loadConfig (INDI::Property &property)
 Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
bool saveConfig (INDI::Property &property)
 Save a property in the 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 debugTriggered (bool enable)
 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 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...
 
bool isInitializationComplete () const
 isInitializationComplete Check if driver initialization is complete. More...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
virtual const char * getDefaultName ()=0
 
 DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd)
 
- Protected Member Functions inherited from INDI::ParentDevice
 ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 
 BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd)
 

Protected Attributes

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 [4]
 
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
 
INDI::PropertySwitch ReverseMovementSP {2}
 
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...
 
bool IsParked {false}
 
TelescopeParkData parkDataType {PARK_NONE}
 
- Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivated_ptr
 

Detailed Description

Examples
simplescope.h.

Definition at line 71 of file inditelescope.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CONNECTION_NONE 
CONNECTION_SERIAL 

Do not use any connection plugin

CONNECTION_TCP 

For regular serial and bluetooth connections

Definition at line 147 of file inditelescope.h.

◆ anonymous enum

anonymous enum
Enumerator
TELESCOPE_CAN_GOTO 
TELESCOPE_CAN_SYNC 

Can the telescope go to to specific coordinates?

TELESCOPE_CAN_PARK 

Can the telescope sync to specific coordinates?

TELESCOPE_CAN_ABORT 

Can the telescope park?

TELESCOPE_HAS_TIME 

Can the telescope abort motion?

TELESCOPE_HAS_LOCATION 

Does the telescope have configurable date and time settings?

TELESCOPE_HAS_PIER_SIDE 

Does the telescope have configuration location settings?

TELESCOPE_HAS_PEC 

Does the telescope have pier side property?

TELESCOPE_HAS_TRACK_MODE 

Does the telescope have PEC playback?

TELESCOPE_CAN_CONTROL_TRACK 

Does the telescope have track modes (sidereal, lunar, solar..etc)?

TELESCOPE_HAS_TRACK_RATE 

Can the telescope engage and disengage tracking?

TELESCOPE_HAS_PIER_SIDE_SIMULATION 

Does the telescope have custom track rates?

TELESCOPE_CAN_TRACK_SATELLITE 

Does the telescope simulate the pier side property?

TELESCOPE_CAN_FLIP 

Can the telescope track satellites?

Definition at line 158 of file inditelescope.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
PARK_CURRENT 
PARK_DEFAULT 
PARK_WRITE_DATA 
PARK_PURGE_DATA 

Definition at line 750 of file inditelescope.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
REVERSE_NS 
REVERSE_WE 

Definition at line 768 of file inditelescope.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
MOTION_CONTROL_JOYSTICK 
MOTION_CONTROL_AXES 

Definition at line 798 of file inditelescope.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
SAT_PASS_WINDOW_START 

Index for start of the window.

SAT_PASS_WINDOW_END 

Index for end of the window.

SAT_PASS_WINDOW_COUNT 

Number of indices.

Definition at line 834 of file inditelescope.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
SAT_TRACK 

Track signal.

SAT_HALT 

Halt signal (abort)

SAT_TRACK_COUNT 

State counter.

Definition at line 850 of file inditelescope.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
SCOPE_CONFIG1 
SCOPE_CONFIG2 
SCOPE_CONFIG3 
SCOPE_CONFIG4 
SCOPE_CONFIG5 
SCOPE_CONFIG6 

Definition at line 905 of file inditelescope.h.

◆ DomeLockingPolicy

Dome Locking Policy

Enumerator
DOME_IGNORED 

Dome is ignored. Mount can park or unpark irrespective of dome parking status.

DOME_LOCKS 

Dome locks. Mount can only unpark if dome is already unparked.

Definition at line 137 of file inditelescope.h.

◆ TelescopeLocation

Enumerator
LOCATION_LATITUDE 
LOCATION_LONGITUDE 
LOCATION_ELEVATION 

Definition at line 116 of file inditelescope.h.

◆ TelescopeMotionCommand

Enumerator
MOTION_START 
MOTION_STOP 

Definition at line 82 of file inditelescope.h.

◆ TelescopeParkData

Enumerator
PARK_NONE 
PARK_RA_DEC 
PARK_HA_DEC 
PARK_AZ_ALT 
PARK_RA_DEC_ENCODER 
PARK_AZ_ALT_ENCODER 

Definition at line 107 of file inditelescope.h.

◆ TelescopePECState

Enumerator
PEC_UNKNOWN 
PEC_OFF 
PEC_ON 

Definition at line 129 of file inditelescope.h.

◆ TelescopePierSide

Enumerator
PIER_UNKNOWN 
PIER_WEST 
PIER_EAST 

Definition at line 122 of file inditelescope.h.

◆ TelescopeSlewRate

Enumerator
SLEW_GUIDE 
SLEW_CENTERING 
SLEW_FIND 
SLEW_MAX 

Definition at line 87 of file inditelescope.h.

◆ TelescopeStatus

Enumerator
SCOPE_IDLE 
SCOPE_SLEWING 
SCOPE_TRACKING 
SCOPE_PARKING 
SCOPE_PARKED 

Definition at line 74 of file inditelescope.h.

◆ TelescopeTrackMode

Enumerator
TRACK_SIDEREAL 
TRACK_SOLAR 
TRACK_LUNAR 
TRACK_CUSTOM 

Definition at line 94 of file inditelescope.h.

◆ TelescopeTrackState

Enumerator
TRACK_ON 
TRACK_OFF 
TRACK_UNKNOWN 

Definition at line 101 of file inditelescope.h.

Constructor & Destructor Documentation

◆ Telescope()

Telescope::Telescope ( )

Definition at line 42 of file inditelescope.cpp.

◆ ~Telescope()

Telescope::~Telescope ( )
virtual

Definition at line 58 of file inditelescope.cpp.

Member Function Documentation

◆ Abort()

bool Telescope::Abort ( )
protectedvirtual

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 in SkywatcherAltAzSimple, SimpleScope, ScopeSim, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200Telescope, LX200Pulsar2, LX200Basic, LX200_TeenAstro, IOptronV3, IEQProLegacy, IEQPro, EQ500X, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1687 of file inditelescope.cpp.

◆ AddTrackMode()

int Telescope::AddTrackMode ( const char *  name,
const char *  label,
bool  isDefault = false 
)
protectedvirtual

AddTrackMode.

Parameters
nameName of track mode. It is recommended to use standard properties names such as TRACK_SIDEREAL..etc.
labelLabel of track mode that appears at the client side.
isDefaultSet to true to mark the track mode as the default. Only one mode should be marked as default.
Returns
Index of added track mode
Note
Child class should add all track modes be

Definition at line 1727 of file inditelescope.cpp.

◆ axisHelper()

void Telescope::axisHelper ( const char *  axis_n,
double  value,
void *  context 
)
static

Definition at line 2647 of file inditelescope.cpp.

◆ buttonHelper()

void Telescope::buttonHelper ( const char *  button_n,
ISState  state,
void *  context 
)
static

Definition at line 2652 of file inditelescope.cpp.

◆ callHandshake()

bool Telescope::callHandshake ( )
protected

callHandshake Helper function that sets the port file descriptor before calling the actual Handshake function implenented in drivers

Returns
Result of actual device Handshake()

Definition at line 1631 of file inditelescope.cpp.

◆ CanAbort()

bool INDI::Telescope::CanAbort ( )
inline
Returns
True if telescope can abort motion.

Definition at line 230 of file inditelescope.h.

◆ CanControlTrack()

bool INDI::Telescope::CanControlTrack ( )
inline
Returns
True if telescope can enagle and disengage tracking.

Definition at line 246 of file inditelescope.h.

◆ CanFlip()

bool INDI::Telescope::CanFlip ( )
inline
Returns
True if telescope support sync operations

Definition at line 222 of file inditelescope.h.

◆ CanGOTO()

bool INDI::Telescope::CanGOTO ( )
inline
Returns
True if telescope support goto operations

Definition at line 206 of file inditelescope.h.

◆ CanPark()

bool INDI::Telescope::CanPark ( )
inline
Returns
True if telescope can park.

Definition at line 238 of file inditelescope.h.

◆ CanSync()

bool INDI::Telescope::CanSync ( )
inline
Returns
True if telescope support sync operations

Definition at line 214 of file inditelescope.h.

◆ CanTrackSatellite()

bool INDI::Telescope::CanTrackSatellite ( )
inline
Returns
True if telescope can track satellites

Definition at line 285 of file inditelescope.h.

◆ CheckFile()

bool Telescope::CheckFile ( const std::string &  file_name,
bool  writable 
) const
protected

Check if a file exists and it is readable.

Parameters
file_nameFile name
writableAdditional check if the file is writable
Returns
True if the checks are successful otherwise false.

Definition at line 3083 of file inditelescope.cpp.

◆ expectedPierSide()

Telescope::TelescopePierSide Telescope::expectedPierSide ( double  ra)
protected

Calculate the expected pier side for scopes that do not report this property themselves.

Simulates pier side using the hour angle. A correct implementation uses the declination axis value, this is only for where this isn't available, such as in the telescope simulator or a GEM which does not provide any pier side or axis information. This last is deeply unsatisfactory, it will not be able to reflect the true pointing state reliably for positions close to the meridian.

Definition at line 2681 of file inditelescope.cpp.

◆ Flip()

bool Telescope::Flip ( double  ra,
double  dec 
)
protectedvirtual

Move and flip 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 in LX200Gemini.

Definition at line 1669 of file inditelescope.cpp.

◆ GetAxis1Park()

double Telescope::GetAxis1Park ( ) const
Returns
Get current RA/AZ parking position.

Definition at line 2304 of file inditelescope.cpp.

◆ GetAxis1ParkDefault()

double Telescope::GetAxis1ParkDefault ( ) const
Returns
Get default RA/AZ parking position.

Definition at line 2308 of file inditelescope.cpp.

◆ GetAxis2Park()

double Telescope::GetAxis2Park ( ) const
Returns
Get current DEC/ALT parking position.

Definition at line 2312 of file inditelescope.cpp.

◆ GetAxis2ParkDefault()

double Telescope::GetAxis2ParkDefault ( ) const
Returns
Get defailt DEC/ALT parking position.

Definition at line 2316 of file inditelescope.cpp.

◆ GetHomeDirectory()

std::string Telescope::GetHomeDirectory ( ) const
protected

Validate a file name.

Parameters
file_nameFile name
Returns
True if the file name is valid otherwise false.

Definition at line 3041 of file inditelescope.cpp.

◆ getPECState()

TelescopePECState INDI::Telescope::getPECState ( )
inline

Definition at line 435 of file inditelescope.h.

◆ getPierSide()

TelescopePierSide INDI::Telescope::getPierSide ( )
inline

Definition at line 429 of file inditelescope.h.

◆ getPierSideStr()

const char * Telescope::getPierSideStr ( TelescopePierSide  ps)
protected

Definition at line 3119 of file inditelescope.cpp.

◆ GetScopeConfigIndex()

int Telescope::GetScopeConfigIndex ( ) const
protected

Get the scope config index.

Returns
The scope config index

Definition at line 3054 of file inditelescope.cpp.

◆ getSimulatePierSide()

bool Telescope::getSimulatePierSide ( ) const
protected

Definition at line 3114 of file inditelescope.cpp.

◆ GetTelescopeCapability()

uint32_t INDI::Telescope::GetTelescopeCapability ( ) const
inline

GetTelescopeCapability returns the capability of the Telescope.

Definition at line 188 of file inditelescope.h.

◆ getTelescopeConnection()

uint8_t Telescope::getTelescopeConnection ( ) const
Returns
Get current telescope connection mode

Definition at line 634 of file inditelescope.cpp.

◆ Goto()

bool Telescope::Goto ( double  ra,
double  dec 
)
protectedvirtual

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 in LX200AstroPhysics, SimpleScope, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, PMC8, Paramount, LX200ZEQ25, LX200Pulsar2, LX200GotoNova, LX200Basic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, ioptronHC8406, IEQProLegacy, IEQPro, EQ500X, Scope, SkywatcherAltAzSimple, ScopeSim, TemmaMount, SkywatcherAPIMount, Rainbow, LX200Telescope, LX200Gemini, LX200_OnStep, TitanTCS, CelestronGPS, AstroTrac, IOptronV3, and MountDriver.

Definition at line 1678 of file inditelescope.cpp.

◆ Handshake()

bool Telescope::Handshake ( )
virtual

◆ HasDefaultScopeConfig()

bool Telescope::HasDefaultScopeConfig ( )
protected

Load scope settings from XML files.

Returns
True if Config #1 exists otherwise false.

Definition at line 2852 of file inditelescope.cpp.

◆ HasLocation()

bool INDI::Telescope::HasLocation ( )
inline
Returns
True if telescope location can be updated.

Definition at line 262 of file inditelescope.h.

◆ HasPECState()

bool INDI::Telescope::HasPECState ( )
inline
Returns
True if telescope supports PEC playback property

Definition at line 292 of file inditelescope.h.

◆ HasPierSide()

bool INDI::Telescope::HasPierSide ( )
inline
Returns
True if telescope supports pier side property

Definition at line 270 of file inditelescope.h.

◆ HasPierSideSimulation()

bool INDI::Telescope::HasPierSideSimulation ( )
inline
Returns
True if telescope simulates pier side property

Definition at line 278 of file inditelescope.h.

◆ HasTime()

bool INDI::Telescope::HasTime ( )
inline
Returns
True if telescope time can be updated.

Definition at line 254 of file inditelescope.h.

◆ HasTrackMode()

bool INDI::Telescope::HasTrackMode ( )
inline
Returns
True if telescope supports track modes

Definition at line 300 of file inditelescope.h.

◆ HasTrackRate()

bool INDI::Telescope::HasTrackRate ( )
inline
Returns
True if telescope supports custom tracking rates.

Definition at line 308 of file inditelescope.h.

◆ InitPark()

bool Telescope::InitPark ( )

InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position.

Returns
True if loading is successful and data is read, false otherwise. On success, you must call SetAxis1ParkDefault() and SetAxis2ParkDefault() to set the default parking values. On failure, you must call SetAxis1ParkDefault() and SetAxis2ParkDefault() to set the default parking values in addition to SetAxis1Park() and SetAxis2Park() to set the current parking position.

Definition at line 2001 of file inditelescope.cpp.

◆ initProperties()

bool Telescope::initProperties ( )
overridevirtual

◆ ISGetProperties()

void Telescope::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::DefaultDevice.

Reimplemented in Scope, SkywatcherAltAzSimple, LX200AstroPhysics, ScopeSim, ScopeScript, SkywatcherAPIMount, PMC8, LX200Telescope, LX200Pulsar2, LX200Gemini, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, LX200_OnStep, CelestronGPS, AstroTrac, LX200GPS, and LX200_16.

Definition at line 312 of file inditelescope.cpp.

◆ isLocked()

bool Telescope::isLocked ( ) const

isLocked is mount currently locked?

Returns
true if lock status equals true and Dome Policy is Dome Locks.

Definition at line 2349 of file inditelescope.cpp.

◆ ISNewNumber()

bool Telescope::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::DefaultDevice.

Reimplemented in Scope, SkywatcherAltAzSimple, LX200AstroPhysics, ScopeSim, TemmaMount, ScopeSim, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200SS2000PC, LX200Pulsar2, LX200Gemini, LX200FS2, LX200Classic, LX200Basic, LX200AstroPhysicsV2, LX200AstroPhysics, LX200AM5, LX200_TeenAstro, LX200NYX101, LX200_OpenAstroTech, LX200_OnStep, LX200_10MICRON, IOptronV3, IEQProLegacy, IEQPro, DSC, TitanTCS, CelestronGPS, AstroTrac, MountDriver, and LX200_16.

Definition at line 816 of file inditelescope.cpp.

◆ ISNewSwitch()

bool Telescope::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::DefaultDevice.

Reimplemented in Scope, SkywatcherAltAzSimple, LX200AstroPhysics, ScopeSim, TemmaMount, ScopeSim, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200Pulsar2, LX200GotoNova, LX200Gemini, LX200FS2, LX200Classic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200AM5, LX200_TeenAstro, LX200NYX101, LX200_OpenAstroTech, LX200_OnStep, LX200_10MICRON, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, DSC, TitanTCS, CelestronGPS, AstroTrac, LX200GPS, and LX200_16.

Definition at line 1044 of file inditelescope.cpp.

◆ ISNewText()

bool Telescope::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::DefaultDevice.

Reimplemented in Scope, SkywatcherAltAzSimple, ScopeSim, TemmaMount, ScopeScript, SynscanLegacyDriver, SkywatcherAPIMount, LX200Telescope, LX200Pulsar2, LX200_TeenAstro, LX200_OpenAstroTech, LX200_10MICRON, DSC, and AstroTrac.

Definition at line 770 of file inditelescope.cpp.

◆ isParked()

bool Telescope::isParked ( )

isParked is mount currently parked?

Returns
True if parked, false otherwise.

Definition at line 1996 of file inditelescope.cpp.

◆ ISSnoopDevice()

bool Telescope::ISSnoopDevice ( XMLEle root)
overridevirtual

Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.

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::DefaultDevice.

Reimplemented in Scope.

Definition at line 530 of file inditelescope.cpp.

◆ joystickHelper()

void Telescope::joystickHelper ( const char *  joystick_n,
double  mag,
double  angle,
void *  context 
)
static

Definition at line 2642 of file inditelescope.cpp.

◆ LoadParkData()

const char * Telescope::LoadParkData ( )
protected

Definition at line 2113 of file inditelescope.cpp.

◆ LoadScopeConfig()

bool Telescope::LoadScopeConfig ( )
protected

Load scope settings from XML files.

Returns
True if all config values were loaded otherwise false.

Definition at line 2711 of file inditelescope.cpp.

◆ MoveNS()

bool Telescope::MoveNS ( INDI_DIR_NS  dir,
TelescopeMotionCommand  command 
)
protectedvirtual

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 in EQ500X, SkywatcherAltAzSimple, ScopeSim, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200Pulsar2, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, IOptronV3, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 745 of file inditelescope.cpp.

◆ MoveWE()

bool Telescope::MoveWE ( INDI_DIR_WE  dir,
TelescopeMotionCommand  command 
)
protectedvirtual

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 in SkywatcherAltAzSimple, ScopeSim, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200Pulsar2, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, IOptronV3, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 756 of file inditelescope.cpp.

◆ NewRaDec()

void Telescope::NewRaDec ( double  ra,
double  dec 
)
protected

The child class calls this function when it has updates.

Examples
simplescope.cpp.

Definition at line 691 of file inditelescope.cpp.

◆ Park()

bool Telescope::Park ( )
protectedvirtual

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 in SkywatcherAltAzSimple, LX200AstroPhysics, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200SS2000PC, LX200Pulsar2, LX200GotoNova, LX200Gemini, LX200FS2, LX200Classic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200AM5, LX200_TeenAstro, LX200NYX101, LX200_OnStep, LX200_10MICRON, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1693 of file inditelescope.cpp.

◆ processAxis()

void Telescope::processAxis ( const char *  axis_n,
double  value 
)
protected

Definition at line 2417 of file inditelescope.cpp.

◆ processButton()

void Telescope::processButton ( const char *  button_n,
ISState  state 
)
protected

Definition at line 2360 of file inditelescope.cpp.

◆ processJoystick()

void Telescope::processJoystick ( const char *  joystick_n,
double  mag,
double  angle 
)
protected

Definition at line 2401 of file inditelescope.cpp.

◆ processNSWE()

void Telescope::processNSWE ( double  mag,
double  angle 
)
protected

Definition at line 2482 of file inditelescope.cpp.

◆ processSlewPresets()

void Telescope::processSlewPresets ( double  mag,
double  angle 
)
protected

Definition at line 2610 of file inditelescope.cpp.

◆ PurgeParkData()

bool Telescope::PurgeParkData ( )
protected

Definition at line 2148 of file inditelescope.cpp.

◆ ReadScopeStatus()

virtual bool INDI::Telescope::ReadScopeStatus ( )
protectedpure virtual

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

Implemented in Scope, SkywatcherAltAzSimple, LX200AstroPhysics, SimpleScope, ScopeSim, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200SS2000PC, LX200Pulsar2, LX200GotoNova, LX200Gemini, LX200FS2, LX200Classic, LX200Basic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200AM5, LX200_TeenAstro, LX200NYX101, LX200_OpenAstroTech, LX200_OnStep, LX200_10MICRON, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, EQ500X, DSC, TitanTCS, CelestronGPS, AstroTrac, MountDriver, SkyCommander, and LX200_16.

◆ saveConfigItems()

bool Telescope::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::DefaultDevice.

Reimplemented in SkywatcherAltAzSimple, LX200AstroPhysics, ScopeSim, ScopeScript, SkywatcherAPIMount, PMC8, LX200Telescope, LX200SS2000PC, LX200GotoNova, LX200Gemini, LX200FS2, LX200Classic, LX200Basic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, LX200_OnStep, LX200_10MICRON, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, DSC, CelestronGPS, and AstroTrac.

Definition at line 652 of file inditelescope.cpp.

◆ sendTimeFromSystem()

void Telescope::sendTimeFromSystem ( )
protected

Definition at line 3095 of file inditelescope.cpp.

◆ SetAxis1Park()

void Telescope::SetAxis1Park ( double  value)

SetRAPark Set current RA/AZ parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

Parameters
valuecurrent Axis 1 value (RA or AZ either in angles or encoder values as specified by the TelescopeParkData type).

Definition at line 2321 of file inditelescope.cpp.

◆ SetAxis1ParkDefault()

void Telescope::SetAxis1ParkDefault ( double  steps)

SetRAPark Set default RA/AZ parking position.

Parameters
valueDefault Axis 1 value (RA or AZ either in angles or encoder values as specified by the TelescopeParkData type).

Definition at line 2329 of file inditelescope.cpp.

◆ SetAxis2Park()

void Telescope::SetAxis2Park ( double  steps)

SetDEPark Set current DEC/ALT parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

Parameters
valuecurrent Axis 1 value (DEC or ALT either in angles or encoder values as specified by the TelescopeParkData type).

Definition at line 2335 of file inditelescope.cpp.

◆ SetAxis2ParkDefault()

void Telescope::SetAxis2ParkDefault ( double  steps)

SetDEParkDefault Set default DEC/ALT parking position.

Parameters
valueDefault Axis 2 value (DEC or ALT either in angles or encoder values as specified by the TelescopeParkData type).

Definition at line 2343 of file inditelescope.cpp.

◆ SetCurrentPark()

bool Telescope::SetCurrentPark ( )
protectedvirtual

SetCurrentPark Set current coordinates/encoders value as the desired parking position.

Returns
True if current mount coordinates are set as parking position, false on error.
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200AstroPhysics, TemmaMount, ScopeSim, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200SS2000PC, LX200FS2, LX200Classic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, LX200_OnStep, IOptronV3, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1740 of file inditelescope.cpp.

◆ SetDefaultPark()

bool Telescope::SetDefaultPark ( )
protectedvirtual

SetDefaultPark Set default coordinates/encoders value as the desired parking position.

Returns
True if default park coordinates are set as parking position, false on error.
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200AstroPhysics, TemmaMount, ScopeSim, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200SS2000PC, LX200FS2, LX200Classic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_OnStep, IOptronV3, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1746 of file inditelescope.cpp.

◆ SetParkDataType()

void Telescope::SetParkDataType ( TelescopeParkData  type)

setParkDataType Sets the type of parking data stored in the park data file and presented to the user.

Parameters
typeparking data type. If PARK_NONE then no properties will be presented to the user for custom parking position.

Definition at line 1924 of file inditelescope.cpp.

◆ SetParked()

void Telescope::SetParked ( bool  isparked)
virtual

SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

Parameters
isparkedset to true if parked, false otherwise.

Reimplemented in LX200_OnStep.

Definition at line 1988 of file inditelescope.cpp.

◆ SetParkPosition()

bool Telescope::SetParkPosition ( double  Axis1Value,
double  Axis2Value 
)
protectedvirtual

SetParkPosition Set desired parking position to the supplied value. This ONLY sets the desired park position value and does not perform parking.

Parameters
Axis1ValueFirst axis value
Axis2ValueSecond axis value
Returns
True if desired parking position is accepted and set. False otherwise.
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in Paramount, and TitanTCS.

Definition at line 1862 of file inditelescope.cpp.

◆ setPECState()

void Telescope::setPECState ( TelescopePECState  state)

Definition at line 2695 of file inditelescope.cpp.

◆ setPierSide()

void Telescope::setPierSide ( TelescopePierSide  side)

Definition at line 2657 of file inditelescope.cpp.

◆ setSimulatePierSide()

void Telescope::setSimulatePierSide ( bool  value)
protected

Definition at line 3132 of file inditelescope.cpp.

◆ SetSlewRate()

bool Telescope::SetSlewRate ( int  index)
protectedvirtual

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 in LX200AstroPhysics, SynscanLegacyDriver, SynscanDriver, Rainbow, PMC8, LX200ZEQ25, LX200Telescope, LX200Pulsar2, LX200GotoNova, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200AM5, LX200NYX101, IOptronV3, IEQProLegacy, IEQPro, and TitanTCS.

Definition at line 2354 of file inditelescope.cpp.

◆ SetTelescopeCapability()

void Telescope::SetTelescopeCapability ( uint32_t  cap,
uint8_t  slewRateCount 
)

SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized.

Parameters
capORed list of telescope capabilities.
slewRateCountNumber of slew rates supported by the telescope. If < 4, no slew rate properties will be defined to the client. If >=4, the driver will construct the default slew rate property TELESCOPE_SLEW_RATE with SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, and SLEW_MAX members where SLEW_GUIDE is the at the lowest setting and SLEW_MAX is at the highest.
Examples
simplescope.cpp.

Definition at line 1869 of file inditelescope.cpp.

◆ setTelescopeConnection()

void Telescope::setTelescopeConnection ( const uint8_t &  value)

setTelescopeConnection Set telescope connection mode. Child class should call this in the constructor before Telescope registers any connection interfaces

Parameters
valueORed combination of TelescopeConnection values.

Definition at line 639 of file inditelescope.cpp.

◆ SetTrackEnabled()

bool Telescope::SetTrackEnabled ( bool  enabled)
protectedvirtual

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.

Parameters
enabledTrue to engage tracking, false to stop tracking completely.
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 in LX200AstroPhysics, TemmaMount, ScopeSim, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200Gemini, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200AM5, LX200_TeenAstro, LX200NYX101, LX200_OnStep, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1720 of file inditelescope.cpp.

◆ SetTrackMode()

bool Telescope::SetTrackMode ( uint8_t  mode)
protectedvirtual

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 in LX200AstroPhysics, TemmaMount, ScopeSim, SynscanDriver, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200GotoNova, LX200Gemini, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1705 of file inditelescope.cpp.

◆ SetTrackRate()

bool Telescope::SetTrackRate ( double  raRate,
double  deRate 
)
protectedvirtual

SetTrackRate Set custom tracking rates.

Parameters
raRateRA tracking rate in arcsecs/s
deRateDEC tracking rate in arcsecs/s
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 in LX200AstroPhysics, ScopeSim, PMC8, Paramount, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_OnStep, IOptronV3, IEQProLegacy, IEQPro, AstroTrac, and MountDriver.

Definition at line 1712 of file inditelescope.cpp.

◆ Sync()

bool Telescope::Sync ( double  ra,
double  dec 
)
protectedvirtual

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 in LX200ZEQ25, EQ500X, Scope, SkywatcherAltAzSimple, LX200AstroPhysics, ScopeSim, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200Telescope, LX200Pulsar2, LX200GotoNova, LX200Basic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, LX200_OnStep, ioptronHC8406, IEQProLegacy, IEQPro, DSC, TitanTCS, CelestronGPS, AstroTrac, IOptronV3, and MountDriver.

Definition at line 736 of file inditelescope.cpp.

◆ SyncParkStatus()

void Telescope::SyncParkStatus ( bool  isparked)
protectedvirtual

SyncParkStatus Update the state and switches for parking.

Parameters
isparkedTrue if parked, false otherwise.

Reimplemented in LX200_OnStep.

Definition at line 1966 of file inditelescope.cpp.

◆ TimerHit()

void Telescope::TimerHit ( )
overridevirtual

Called when setTimer() time is up.

Reimplemented from INDI::DefaultDevice.

Reimplemented in SkywatcherAltAzSimple, ScopeSim, and SkywatcherAPIMount.

Definition at line 1650 of file inditelescope.cpp.

◆ UnPark()

bool Telescope::UnPark ( )
protectedvirtual

Unpark the telescope if already parked.

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 in SkywatcherAltAzSimple, LX200AstroPhysics, TemmaMount, ScopeSim, ScopeScript, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, Paramount, LX200ZEQ25, LX200SS2000PC, LX200Pulsar2, LX200GotoNova, LX200Gemini, LX200FS2, LX200Classic, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200_TeenAstro, LX200NYX101, LX200_OnStep, LX200_10MICRON, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, MountDriver, and LX200GPS.

Definition at line 1699 of file inditelescope.cpp.

◆ updateLocation()

bool Telescope::updateLocation ( double  latitude,
double  longitude,
double  elevation 
)
protectedvirtual

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 in EQ500X, Scope, LX200AstroPhysics, ScopeSim, TemmaMount, ScopeSim, SynscanLegacyDriver, SynscanDriver, SkywatcherAPIMount, Rainbow, PMC8, LX200ZEQ25, LX200Telescope, LX200SS2000PC, LX200Pulsar2, LX200GotoNova, LX200FS2, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, LX200AM5, LX200_TeenAstro, LX200NYX101, LX200_OnStep, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, DSC, TitanTCS, CelestronGPS, AstroTrac, and MountDriver.

Definition at line 1837 of file inditelescope.cpp.

◆ updateObserverLocation()

void Telescope::updateObserverLocation ( double  latitude,
double  longitude,
double  elevation 
)
protected

Update location settings of the observer.

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.

Definition at line 1845 of file inditelescope.cpp.

◆ updateProperties()

bool Telescope::updateProperties ( )
overridevirtual

◆ UpdateScopeConfig()

bool Telescope::UpdateScopeConfig ( )
protected

Save scope settings to XML files.

Definition at line 2911 of file inditelescope.cpp.

◆ updateTime()

bool Telescope::updateTime ( ln_date *  utc,
double  utc_offset 
)
protectedvirtual

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 in LX200AstroPhysics, SynscanLegacyDriver, SynscanDriver, PMC8, Paramount, LX200ZEQ25, LX200Telescope, LX200SS2000PC, LX200Pulsar2, LX200GotoNova, LX200AstroPhysicsV2, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, IOptronV3, ioptronHC8406, IEQProLegacy, IEQPro, TitanTCS, CelestronGPS, AstroTrac, and LX200GPS.

Definition at line 1830 of file inditelescope.cpp.

◆ WriteParkData()

bool Telescope::WriteParkData ( )
protected

Definition at line 2244 of file inditelescope.cpp.

Member Data Documentation

◆ AbortS

ISwitch INDI::Telescope::AbortS[1]
protected

Definition at line 729 of file inditelescope.h.

◆ AbortSP

ISwitchVectorProperty INDI::Telescope::AbortSP
protected

Definition at line 728 of file inditelescope.h.

◆ ActiveDeviceT

IText INDI::Telescope::ActiveDeviceT[2] {}
protected

Definition at line 789 of file inditelescope.h.

◆ ActiveDeviceTP

ITextVectorProperty INDI::Telescope::ActiveDeviceTP
protected

Definition at line 788 of file inditelescope.h.

◆ capability

uint32_t INDI::Telescope::capability {0}
protected

Definition at line 882 of file inditelescope.h.

◆ CoordS

ISwitch INDI::Telescope::CoordS[4]
protected

Definition at line 733 of file inditelescope.h.

◆ CoordSP

ISwitchVectorProperty INDI::Telescope::CoordSP
protected

Definition at line 732 of file inditelescope.h.

◆ currentPECState

TelescopePECState INDI::Telescope::currentPECState {PEC_UNKNOWN}
protected

Definition at line 880 of file inditelescope.h.

◆ currentPierSide

TelescopePierSide INDI::Telescope::currentPierSide
protected

Definition at line 819 of file inditelescope.h.

◆ DomePolicyS

ISwitch INDI::Telescope::DomePolicyS[2]
protected

Definition at line 793 of file inditelescope.h.

◆ DomePolicySP

ISwitchVectorProperty INDI::Telescope::DomePolicySP
protected

Definition at line 792 of file inditelescope.h.

◆ EqN

INumber INDI::Telescope::EqN[2]
protected

Definition at line 720 of file inditelescope.h.

◆ EqNP

INumberVectorProperty INDI::Telescope::EqNP
protected

Definition at line 719 of file inditelescope.h.

◆ IsParked

bool INDI::Telescope::IsParked {false}
protected

Definition at line 924 of file inditelescope.h.

◆ last_ns_motion

int INDI::Telescope::last_ns_motion {-1}
protected

Definition at line 883 of file inditelescope.h.

◆ last_we_motion

int INDI::Telescope::last_we_motion {-1}
protected

Definition at line 883 of file inditelescope.h.

◆ lastPECState

TelescopePECState INDI::Telescope::lastPECState {PEC_UNKNOWN}
protected

Definition at line 880 of file inditelescope.h.

◆ lastPierSide

TelescopePierSide INDI::Telescope::lastPierSide
protected

Definition at line 819 of file inditelescope.h.

◆ LocationN

INumber INDI::Telescope::LocationN[3]
protected

Definition at line 737 of file inditelescope.h.

◆ LocationNP

INumberVectorProperty INDI::Telescope::LocationNP
protected

Definition at line 736 of file inditelescope.h.

◆ LockAxisS

ISwitch INDI::Telescope::LockAxisS[2]
protected

Definition at line 805 of file inditelescope.h.

◆ LockAxisSP

ISwitchVectorProperty INDI::Telescope::LockAxisSP
protected

Definition at line 806 of file inditelescope.h.

◆ m_Location

IGeographicCoordinates INDI::Telescope::m_Location { 0, 0, 0 }
protected

Definition at line 666 of file inditelescope.h.

◆ MotionControlModeT

ISwitch INDI::Telescope::MotionControlModeT[2]
protected

Definition at line 797 of file inditelescope.h.

◆ MotionControlModeTP

ISwitchVectorProperty INDI::Telescope::MotionControlModeTP
protected

Definition at line 796 of file inditelescope.h.

◆ MovementNSS

ISwitch INDI::Telescope::MovementNSS[2]
protected

Definition at line 759 of file inditelescope.h.

◆ MovementNSSP

ISwitchVectorProperty INDI::Telescope::MovementNSSP
protected

Definition at line 760 of file inditelescope.h.

◆ MovementWES

ISwitch INDI::Telescope::MovementWES[2]
protected

Definition at line 763 of file inditelescope.h.

◆ MovementWESP

ISwitchVectorProperty INDI::Telescope::MovementWESP
protected

Definition at line 764 of file inditelescope.h.

◆ parkDataType

TelescopeParkData INDI::Telescope::parkDataType {PARK_NONE}
protected

Definition at line 925 of file inditelescope.h.

◆ ParkOptionS

ISwitch INDI::Telescope::ParkOptionS[4]
protected

Definition at line 748 of file inditelescope.h.

◆ ParkOptionSP

ISwitchVectorProperty INDI::Telescope::ParkOptionSP
protected

Definition at line 749 of file inditelescope.h.

◆ ParkPositionN

INumber INDI::Telescope::ParkPositionN[2]
protected

Definition at line 744 of file inditelescope.h.

◆ ParkPositionNP

INumberVectorProperty INDI::Telescope::ParkPositionNP
protected

Definition at line 745 of file inditelescope.h.

◆ ParkS

ISwitch INDI::Telescope::ParkS[2]
protected

Definition at line 741 of file inditelescope.h.

◆ ParkSP

ISwitchVectorProperty INDI::Telescope::ParkSP
protected

Definition at line 740 of file inditelescope.h.

◆ PECStateS

ISwitch INDI::Telescope::PECStateS[2]
protected

Definition at line 864 of file inditelescope.h.

◆ PECStateSP

ISwitchVectorProperty INDI::Telescope::PECStateSP
protected

Definition at line 865 of file inditelescope.h.

◆ PierSideS

ISwitch INDI::Telescope::PierSideS[2]
protected

Definition at line 809 of file inditelescope.h.

◆ PierSideSP

ISwitchVectorProperty INDI::Telescope::PierSideSP
protected

Definition at line 810 of file inditelescope.h.

◆ PortFD

int INDI::Telescope::PortFD = -1
protected

Definition at line 890 of file inditelescope.h.

◆ RememberTrackState

TelescopeStatus INDI::Telescope::RememberTrackState {SCOPE_IDLE}
protected

RememberTrackState Remember last state of Track State to fall back to in case of errors or aborts.

Definition at line 716 of file inditelescope.h.

◆ ReverseMovementSP

INDI::PropertySwitch INDI::Telescope::ReverseMovementSP {2}
protected

Definition at line 767 of file inditelescope.h.

◆ 

enum { ... } INDI::Telescope::SatelliteTracking

◆ 

enum { ... } INDI::Telescope::SatelliteWindow

◆ SatPassWindowT

IText INDI::Telescope::SatPassWindowT[SAT_PASS_WINDOW_COUNT] {}
protected

Definition at line 845 of file inditelescope.h.

◆ SatPassWindowTP

ITextVectorProperty INDI::Telescope::SatPassWindowTP
protected

Text Vector property defining the start and end of a satellite pass (window contains pass). Example implementation.

Definition at line 844 of file inditelescope.h.

◆ ScopeConfigDeviceXmlNode

const std::string INDI::Telescope::ScopeConfigDeviceXmlNode { "device" }
protected

Definition at line 896 of file inditelescope.h.

◆ ScopeConfigFileName

const std::string INDI::Telescope::ScopeConfigFileName
protected

The telescope/guide scope configuration file name.

Definition at line 922 of file inditelescope.h.

◆ ScopeConfigGScopeApXmlNode

const std::string INDI::Telescope::ScopeConfigGScopeApXmlNode { "gscopeap" }
protected

Definition at line 901 of file inditelescope.h.

◆ ScopeConfigGScopeFocXmlNode

const std::string INDI::Telescope::ScopeConfigGScopeFocXmlNode { "gscopefoc" }
protected

Definition at line 900 of file inditelescope.h.

◆ ScopeConfigLabelApXmlNode

const std::string INDI::Telescope::ScopeConfigLabelApXmlNode { "label" }
protected

Definition at line 902 of file inditelescope.h.

◆ ScopeConfigNameT

IText INDI::Telescope::ScopeConfigNameT[1] {}
protected

Definition at line 919 of file inditelescope.h.

◆ ScopeConfigNameTP

ITextVectorProperty INDI::Telescope::ScopeConfigNameTP
protected

Definition at line 918 of file inditelescope.h.

◆ ScopeConfigNameXmlNode

const std::string INDI::Telescope::ScopeConfigNameXmlNode { "name" }
protected

Definition at line 897 of file inditelescope.h.

◆ ScopeConfigRootXmlNode

const std::string INDI::Telescope::ScopeConfigRootXmlNode { "scopeconfig" }
protected

Definition at line 895 of file inditelescope.h.

◆ ScopeConfigs

ISwitch INDI::Telescope::ScopeConfigs[6]
protected

Definition at line 914 of file inditelescope.h.

◆ ScopeConfigScopeApXmlNode

const std::string INDI::Telescope::ScopeConfigScopeApXmlNode { "scopeap" }
protected

Definition at line 899 of file inditelescope.h.

◆ ScopeConfigScopeFocXmlNode

const std::string INDI::Telescope::ScopeConfigScopeFocXmlNode { "scopefoc" }
protected

Definition at line 898 of file inditelescope.h.

◆ ScopeConfigsSP

ISwitchVectorProperty INDI::Telescope::ScopeConfigsSP
protected

Definition at line 915 of file inditelescope.h.

◆ ScopeParametersN

INumber INDI::Telescope::ScopeParametersN[4]
protected

Definition at line 779 of file inditelescope.h.

◆ ScopeParametersNP

INumberVectorProperty INDI::Telescope::ScopeParametersNP
protected

Definition at line 780 of file inditelescope.h.

◆ serialConnection

Connection::Serial* INDI::Telescope::serialConnection = nullptr
protected

Definition at line 891 of file inditelescope.h.

◆ SimulatePierSideS

ISwitch INDI::Telescope::SimulatePierSideS[2]
protected

Definition at line 814 of file inditelescope.h.

◆ SimulatePierSideSP

ISwitchVectorProperty INDI::Telescope::SimulatePierSideSP
protected

Definition at line 813 of file inditelescope.h.

◆ SlewRateS

ISwitch* INDI::Telescope::SlewRateS {nullptr}
protected

Definition at line 776 of file inditelescope.h.

◆ SlewRateSP

ISwitchVectorProperty INDI::Telescope::SlewRateSP
protected

Definition at line 775 of file inditelescope.h.

◆ TargetN

INumber INDI::Telescope::TargetN[2]
protected

Definition at line 725 of file inditelescope.h.

◆ TargetNP

INumberVectorProperty INDI::Telescope::TargetNP
protected

Definition at line 724 of file inditelescope.h.

◆ tcpConnection

Connection::TCP* INDI::Telescope::tcpConnection = nullptr
protected

Definition at line 892 of file inditelescope.h.

◆ 

enum { ... } INDI::Telescope::TelescopeCapability

◆ 

enum { ... } INDI::Telescope::TelescopeConnection

◆ TimeT

IText INDI::Telescope::TimeT[2] {}
protected

Definition at line 783 of file inditelescope.h.

◆ TimeTP

ITextVectorProperty INDI::Telescope::TimeTP
protected

Definition at line 784 of file inditelescope.h.

◆ TLEtoTrackT

IText INDI::Telescope::TLEtoTrackT[1] {}
protected

Definition at line 829 of file inditelescope.h.

◆ TLEtoTrackTP

ITextVectorProperty INDI::Telescope::TLEtoTrackTP
protected

Text Vector property defining the orbital elements of an artificial satellite (TLE). Example implementation.

Definition at line 828 of file inditelescope.h.

◆ TrackModeS

ISwitch* INDI::Telescope::TrackModeS { nullptr }
protected

Definition at line 869 of file inditelescope.h.

◆ TrackModeSP

ISwitchVectorProperty INDI::Telescope::TrackModeSP
protected

Definition at line 868 of file inditelescope.h.

◆ TrackRateN

INumber INDI::Telescope::TrackRateN[2]
protected

Definition at line 877 of file inditelescope.h.

◆ TrackRateNP

INumberVectorProperty INDI::Telescope::TrackRateNP
protected

Definition at line 876 of file inditelescope.h.

◆ TrackSatS

ISwitch INDI::Telescope::TrackSatS[SAT_TRACK_COUNT]
protected

Definition at line 861 of file inditelescope.h.

◆ TrackSatSP

ISwitchVectorProperty INDI::Telescope::TrackSatSP
protected

Switch Vector property defining the state of the satellite tracking of the mount. Example implementation.

Definition at line 860 of file inditelescope.h.

◆ TrackState

TelescopeStatus INDI::Telescope::TrackState {SCOPE_IDLE}
protected

This is a variable filled in by the ReadStatus telescope low level code, used to report current state are we slewing, tracking, or parked.

Examples
simplescope.cpp.

Definition at line 711 of file inditelescope.h.

◆ TrackStateS

ISwitch INDI::Telescope::TrackStateS[2]
protected

Definition at line 873 of file inditelescope.h.

◆ TrackStateSP

ISwitchVectorProperty INDI::Telescope::TrackStateSP
protected

Definition at line 872 of file inditelescope.h.


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