Instrument Neutral Distributed Interface INDI  1.9.2
Public Member Functions | Protected Member Functions | List of all members
SkywatcherAPIMount Class Reference

#include <skywatcherAPIMount.h>

Inheritance diagram for SkywatcherAPIMount:
SkywatcherAPI INDI::Telescope INDI::GuiderInterface INDI::AlignmentSubsystem::AlignmentSubsystemForDrivers INDI::DefaultDevice INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase INDI::AlignmentSubsystem::MathPluginManagement INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions INDI::BaseDevice INDI::AlignmentSubsystem::InMemoryDatabase INDI::AlignmentSubsystem::MathPlugin

Public Member Functions

 SkywatcherAPIMount ()
 
virtual ~SkywatcherAPIMount ()=default
 
virtual bool initProperties () override
 Called to initialize basic properties required all the time. 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 updateProperties () override
 Called when connected state changes, to add/remove properties. More...
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n) override
 Process the client newBLOB command. 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...
 
- Public Member Functions inherited from SkywatcherAPI
 SkywatcherAPI ()
 
virtual ~SkywatcherAPI ()=default
 
unsigned long BCDstr2long (std::string &String)
 
unsigned long Highstr2long (std::string &String)
 
bool CheckIfDCMotor ()
 
bool IsMerlinMount () const
 Check if the current mount is a Virtuoso (AltAz) More...
 
long DegreesPerSecondToClocksTicksPerMicrostep (AXISID Axis, double DegreesPerSecond)
 Check if the current mount is AZ GTi. More...
 
long DegreesToMicrosteps (AXISID Axis, double AngleInDegrees)
 Convert angle in degrees to microsteps. More...
 
bool GetEncoder (AXISID Axis)
 Set the CurrentEncoders status variable to the current encoder value in microsteps for the specified axis. More...
 
bool GetHighSpeedRatio (AXISID Axis)
 Set the HighSpeedRatio status variable to the ratio between high and low speed stepping modes. More...
 
bool GetMicrostepsPerRevolution (AXISID Axis)
 Set the MicrostepsPerRevolution status variable to the number of microsteps for a 360 degree revolution of the axis. More...
 
bool GetMicrostepsPerWormRevolution (AXISID Axis)
 Set the MicrostepsPermWormRevolution status variable to the number of microsteps for a 360 degree revolution of the worm gear. More...
 
bool GetMotorBoardVersion (AXISID Axis)
 
PositiveRotationSense_t GetPositiveRotationDirection (AXISID Axis)
 Returns the rotation direction for a positive step on the designated axis. More...
 
bool GetStatus (AXISID Axis)
 
bool GetStepperClockFrequency (AXISID Axis)
 Set the StepperClockFrequency status variable to fixed PIC timer interrupt frequency (ticks per second). More...
 
bool InitializeMC ()
 
bool InitMount ()
 Initialize the communication to the mount. More...
 
bool InstantStop (AXISID Axis)
 Bring the axis to an immediate halt. N.B. This command could cause damage to the mount or telescope and should not normally be used except for emergency stops. More...
 
void Long2BCDstr (long Number, std::string &String)
 
double MicrostepsToDegrees (AXISID Axis, long Microsteps)
 Convert microsteps to angle in degrees. More...
 
double MicrostepsToRadians (AXISID Axis, long Microsteps)
 Convert microsteps to angle in radians. More...
 
void PrepareForSlewing (AXISID Axis, double Speed)
 
long RadiansPerSecondToClocksTicksPerMicrostep (AXISID Axis, double RadiansPerSecond)
 Convert a slewing rate in radians per second into the required clock ticks per microstep setting. More...
 
long RadiansToMicrosteps (AXISID Axis, double AngleInRadians)
 Convert angle in radians to microsteps. More...
 
bool SetEncoder (AXISID Axis, long Microsteps)
 Set axis encoder to the specified value. More...
 
bool SetGotoTargetOffset (AXISID Axis, long OffsetInMicrosteps)
 Set the goto target offset per the specified axis. More...
 
bool SetMotionMode (AXISID Axis, char Func, char Direction)
 Set the motion mode per the specified axis. More...
 
void SetSerialPort (int port)
 Set the serail port to be usb for mount communication. More...
 
bool SetClockTicksPerMicrostep (AXISID Axis, long ClockTicksPerMicrostep)
 Set the PIC internal divider variable which determines how many clock interrupts have to occur between each microstep. More...
 
bool SetSlewModeDeccelerationRampLength (AXISID Axis, long Microsteps)
 Set the length of the deccelaration ramp for Slew mode. More...
 
bool SetSlewToModeDeccelerationRampLength (AXISID Axis, long Microsteps)
 Set the length of the deccelaration ramp for SlewTo mode. More...
 
bool SetSwitch (bool OnOff)
 Set the camera control switch to the given state. More...
 
void Slew (AXISID Axis, double SpeedInRadiansPerSecond, bool IgnoreSilentMode=true)
 Start the axis slewing at the given rate. More...
 
void SlewTo (AXISID Axis, long OffsetInMicrosteps, bool verbose=true)
 Slew to the given offset and stop. More...
 
bool SlowStop (AXISID Axis)
 Bring the axis to slow stop in the distance specified by SetSlewModeDeccelerationRampLength. More...
 
bool StartMotion (AXISID Axis)
 Start the axis slewing in the prevously selected mode. More...
 
bool TalkWithAxis (AXISID Axis, char Command, std::string &cmdDataStr, std::string &responseStr)
 
bool IsInMotion (AXISID Axis)
 Check if an axis is moving. More...
 
- 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 ()
 
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 ()
 
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 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::AlignmentSubsystem::AlignmentSubsystemForDrivers
 AlignmentSubsystemForDrivers ()
 Default constructor. More...
 
virtual ~AlignmentSubsystemForDrivers ()
 Virtual destructor. More...
 
void InitAlignmentProperties (Telescope *pTelescope)
 Initilize alignment subsystem properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void ProcessAlignmentBLOBProperties (Telescope *pTelescope, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Call this function from within the ISNewBlob processing path. The function will handle any alignment subsystem related properties. More...
 
void ProcessAlignmentNumberProperties (Telescope *pTelescope, const char *name, double values[], char *names[], int n)
 Call this function from within the ISNewNumber processing path. The function will handle any alignment subsystem related properties. More...
 
void ProcessAlignmentSwitchProperties (Telescope *pTelescope, const char *name, ISState *states, char *names[], int n)
 Call this function from within the ISNewSwitch processing path. The function will handle any alignment subsystem related properties. More...
 
void ProcessAlignmentTextProperties (Telescope *pTelescope, const char *name, char *texts[], char *names[], int n)
 Call this function from within the ISNewText processing path. The function will handle any alignment subsystem related properties. This only text property at the moment is contained in the config file so this will normally only have work to do when the config file is loaded. More...
 
void SaveAlignmentConfigProperties (FILE *fp)
 Call this function to save persistent alignment related properties. This function should be called from within the saveConfigItems function of your driver. More...
 
bool AddAlignmentEntryEquatorial (double actualRA, double actualDec, double mountRA, double mountDec)
 Adds an alignment point to the model database, usually called from Sync. More...
 
bool SkyToTelescopeEquatorial (double actualRA, double actualDec, double &mountRA, double &mountDec)
 Converts an actual sky location to coordinates to send to the mount, usually called in Goto. More...
 
bool TelescopeEquatorialToSky (double mountRA, double mountDec, double &actualRA, double &actualDec)
 Converts a mount location to actual sky coordinates, usually called in ReadScopeStatus. More...
 
bool AddAlignmentEntryAltAz (double actualRA, double actualDec, double mountAlt, double mountAz)
 Adds an alignment point to the model database, usually called from Sync. More...
 
bool SkyToTelescopeAltAz (double actualRA, double actualDec, double &mountAlt, double &mountAz)
 Converts an actual sky location to coordinates to send to the mount, usually called in Goto. More...
 
bool TelescopeAltAzToSky (double mountAlt, double mountAz, double &actualRA, double &actualDec)
 Converts a mount location to actual sky coordinates, usually called in ReadScopeStatus. More...
 
- Public Member Functions inherited from INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase
virtual ~MapPropertiesToInMemoryDatabase ()
 Virtual destructor. More...
 
void InitProperties (Telescope *pTelescope)
 Initialize alignment database properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void ProcessBlobProperties (Telescope *pTelescope, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Call this function from within the ISNewBLOB processing path. The function will handle any alignment database related properties. More...
 
void ProcessNumberProperties (Telescope *, const char *name, double values[], char *names[], int n)
 Call this function from within the ISNewNumber processing path. The function will handle any alignment database related properties. More...
 
void ProcessSwitchProperties (Telescope *pTelescope, const char *name, ISState *states, char *names[], int n)
 Call this function from within the ISNewSwitch processing path. The function will handle any alignment database related properties. More...
 
void UpdateLocation (double latitude, double longitude, double elevation)
 Call this function from within the updateLocation processing path. More...
 
void UpdateSize ()
 Call this function when the number of entries in the database changes. More...
 
- Public Member Functions inherited from INDI::AlignmentSubsystem::InMemoryDatabase
 InMemoryDatabase ()
 Default constructor. More...
 
virtual ~InMemoryDatabase ()
 Virtual destructor. More...
 
bool CheckForDuplicateSyncPoint (const AlignmentDatabaseEntry &CandidateEntry, double Tolerance=0.1) const
 Check if a entry already exists in the database. More...
 
AlignmentDatabaseTypeGetAlignmentDatabase ()
 Get a reference to the in memory database. More...
 
bool GetDatabaseReferencePosition (IGeographicCoordinates &Position)
 Get the database reference position. More...
 
bool LoadDatabase (const char *DeviceName)
 Load the database from persistent storage. More...
 
bool SaveDatabase (const char *DeviceName)
 Save the database to persistent storage. More...
 
void SetDatabaseReferencePosition (double Latitude, double Longitude)
 Set the database reference position. More...
 
void SetLoadDatabaseCallback (LoadDatabaseCallbackPointer_t CallbackPointer, void *ThisPointer)
 Set the function to be called when the database is loaded or reloaded. More...
 
- Public Member Functions inherited from INDI::AlignmentSubsystem::MathPluginManagement
 MathPluginManagement ()
 Default constructor. More...
 
virtual ~MathPluginManagement ()
 Virtual destructor. More...
 
void InitProperties (Telescope *pTelescope)
 Initialize alignment math plugin properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void ProcessSwitchProperties (Telescope *pTelescope, const char *name, ISState *states, char *names[], int n)
 Call this function from within the ISNewSwitch processing path. The function will handle any math plugin switch properties. More...
 
void ProcessTextProperties (Telescope *pTelescope, const char *name, char *texts[], char *names[], int n)
 Call this function from within the ISNewText processing path. The function will handle any math plugin text properties. This text property is at the moment only contained in the config file so this will normally only have work to do when the config file is loaded. More...
 
void SaveConfigProperties (FILE *fp)
 Call this function to save persistent math plugin properties. This function should be called from within the saveConfigItems function of your driver. More...
 
void SetApproximateMountAlignmentFromMountType (MountType_t Type)
 Call this function to set the ApproximateMountAlignment property of the current Math Plugin. The alignment database should be initialised before this function is called so that it can use the DatabaseReferencePosition to determine which hemisphere the current observing site is in. For equatorial the ApproximateMountAlignment property will set to NORTH_CELESTIAL_POLE for sites in the northern hemisphere and SOUTH_CELESTIAL_POLE for sites in the southern hemisphere. For altaz mounts the ApproximateMountAlignment will be set to ZENITH. More...
 
void SetCurrentInMemoryDatabase (InMemoryDatabase *pDatabase)
 Set the current in memory database. More...
 
void SetAlignmentSubsystemActive (bool enable)
 SetAlignmentSubsystemActive Enable or Disable alignment subsystem. More...
 
bool IsAlignmentSubsystemActive () const
 Return status of alignment subsystem. More...
 
MountAlignment_t GetApproximateMountAlignment ()
 Get the approximate alognment of the mount. More...
 
bool Initialise (InMemoryDatabase *pInMemoryDatabase)
 Initialise or re-initialise the math plugin. Re-reading the in memory database as necessary. More...
 
void SetApproximateMountAlignment (MountAlignment_t ApproximateAlignment)
 Set the approximate alognment of the mount. More...
 
bool TransformCelestialToTelescope (const double RightAscension, const double Declination, double JulianOffset, TelescopeDirectionVector &ApparentTelescopeDirectionVector)
 Get the alignment corrected telescope pointing direction for the supplied celestial coordinates. More...
 
bool TransformTelescopeToCelestial (const TelescopeDirectionVector &ApparentTelescopeDirectionVector, double &RightAscension, double &Declination)
 Get the true celestial coordinates for the supplied telescope pointing direction. More...
 
- Public Member Functions inherited from INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions
virtual ~TelescopeDirectionVectorSupportFunctions ()
 Virtual destructor. More...
 
void AltitudeAzimuthFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, INDI::IHorizontalCoordinates &HorizontalCoordinates)
 Calculates an altitude and azimuth from the supplied normalised direction vector and declination. More...
 
void EquatorialCoordinatesFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, INDI::IEquatorialCoordinates &EquatorialCoordinates)
 Calculates equatorial coordinates from the supplied telescope direction vector and declination. More...
 
void LocalHourAngleDeclinationFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, INDI::IEquatorialCoordinates &EquatorialCoordinates)
 Calculates a local hour angle and declination from the supplied telescope direction vector and declination. More...
 
void SphericalCoordinateFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, double &AzimuthAngle, AzimuthAngleDirection_t AzimuthAngleDirection, double &PolarAngle, PolarAngleDirection_t PolarAngleDirection)
 Calculates a spherical coordinate from the supplied telescope direction vector. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromAltitudeAzimuth (INDI::IHorizontalCoordinates HorizontalCoordinates)
 Calculates a normalised direction vector from the supplied altitude and azimuth. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromEquatorialCoordinates (INDI::IEquatorialCoordinates EquatorialCoordinates)
 Calculates a telescope direction vector from the supplied equatorial coordinates. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromLocalHourAngleDeclination (INDI::IEquatorialCoordinates EquatorialCoordinates)
 Calculates a telescope direction vector from the supplied local hour angle and declination. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromSphericalCoordinate (const double AzimuthAngle, AzimuthAngleDirection_t AzimuthAngleDirection, const double PolarAngle, PolarAngleDirection_t PolarAngleDirection)
 Calculates a telescope direction vector from the supplied spherical coordinate information. More...
 

Protected Member Functions

virtual bool Handshake () override
 Communication. More...
 
virtual bool ReadScopeStatus () override
 Read telescope status. More...
 
virtual bool MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override
 Motion. More...
 
virtual bool MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override
 Move the telescope in the direction dir. More...
 
virtual bool Goto (double ra, double dec) override
 Move the scope to the supplied RA and DEC coordinates. 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 Abort () override
 Abort any telescope motion including tracking if possible. More...
 
virtual const char * getDefaultName () override
 Misc. More...
 
virtual void TimerHit () override
 Called when setTimer() time is up. More...
 
virtual bool updateLocation (double latitude, double longitude, double elevation) override
 Update telescope location settings. More...
 
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...
 
double GetSlewRate ()
 
double GetParkDeltaAz (ParkDirection_t target_direction, ParkPosition_t target_position)
 
virtual IPState GuideNorth (uint32_t ms) override
 Guiding. 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 bool Park () override
 Parking. More...
 
virtual bool UnPark () override
 Unpark the telescope if already parked. More...
 
virtual bool SetCurrentPark () override
 SetCurrentPark Set current coordinates/encoders value as the desired parking position. More...
 
virtual bool SetDefaultPark () override
 SetDefaultPark Set default coordinates/encoders value as the desired parking position. More...
 
- 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 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...
 
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 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...
 
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 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from SkywatcherAPI
enum  AXISID { AXIS1 = 0, AXIS2 = 1 }
 
enum  PositiveRotationSense_t { CLOCKWISE, ANTICLOCKWISE }
 
enum  MountType {
  EQ6 = 0x00, HEQ5 = 0x01, EQ5 = 0x02, EQ3 = 0x03,
  AZEQ6 = 0x22, GT = 0x80, MF = 0x81, _114GT = 0x82,
  DOB = 0x90
}
 
- 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::AlignmentSubsystem::InMemoryDatabase
typedef std::vector< AlignmentDatabaseEntryAlignmentDatabaseType
 
typedef void(* LoadDatabaseCallbackPointer_t) (void *)
 
- Public Types inherited from INDI::AlignmentSubsystem::MathPluginManagement
enum  MountType { EQUATORIAL, ALTAZ }
 Describes the basic type of the mount. More...
 
typedef enum INDI::AlignmentSubsystem::MathPluginManagement::MountType MountType_t
 
- Public Types inherited from INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions
enum  AzimuthAngleDirection { CLOCKWISE, ANTI_CLOCKWISE }
 
enum  PolarAngleDirection { FROM_POLAR_AXIS, FROM_AZIMUTHAL_PLANE }
 
typedef enum INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions::AzimuthAngleDirection AzimuthAngleDirection_t
 
typedef enum INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions::PolarAngleDirection PolarAngleDirection_t
 
- 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)
 
- Public Attributes inherited from SkywatcherAPI
unsigned long MCVersion { 0 }
 
unsigned long MountCode { 0 }
 
bool IsDCMotor { false }
 
bool SilentSlewMode { true }
 
long MicrostepsPerRevolution [2]
 
long StepperClockFrequency [2]
 
long HighSpeedRatio [2]
 
long MicrostepsPerWormRevolution [2]
 
double RadiansPerMicrostep [2]
 
double MicrostepsPerRadian [2]
 
double DegreesPerMicrostep [2]
 
double MicrostepsPerDegree [2]
 
long LowSpeedGotoMargin [2]
 
long LastSlewToTarget [2]
 
long CurrentEncoders [2]
 Current encoder values (microsteps). More...
 
long PolarisPositionEncoders [2]
 Polaris position (initial) encoder values (microsteps). More...
 
long ZeroPositionEncoders [2]
 Zero position encoder values (microsteps). More...
 
AXISSTATUS AxesStatus [2]
 
double SlewingSpeed [2]
 
INDI::TelescopepChildTelescope { nullptr }
 
- Public Attributes inherited from INDI::Telescope
enum INDI::Telescope:: { ... }  TelescopeConnection
 
enum INDI::Telescope:: { ... }  TelescopeCapability
 
- Static Public Attributes inherited from SkywatcherAPI
static constexpr double SIDEREALRATE { (2 * M_PI / 86164.09065) }
 
static constexpr double MAX_SPEED { 500.0 }
 
static constexpr double LOW_SPEED_MARGIN { 128.0 * SIDEREALRATE }
 
- 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
}
 
- Protected Attributes inherited from SkywatcherAPI
unsigned int DBG_SCOPE { 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
 

Detailed Description

Definition at line 35 of file skywatcherAPIMount.h.

Constructor & Destructor Documentation

◆ SkywatcherAPIMount()

SkywatcherAPIMount::SkywatcherAPIMount ( )

Definition at line 42 of file skywatcherAPIMount.cpp.

◆ ~SkywatcherAPIMount()

virtual SkywatcherAPIMount::~SkywatcherAPIMount ( )
virtualdefault

Member Function Documentation

◆ Abort()

bool SkywatcherAPIMount::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.

Definition at line 897 of file skywatcherAPIMount.cpp.

◆ getDefaultName()

const char * SkywatcherAPIMount::getDefaultName ( )
overrideprotectedvirtual

Misc.

Implements INDI::DefaultDevice.

Definition at line 73 of file skywatcherAPIMount.cpp.

◆ GetParkDeltaAz()

double SkywatcherAPIMount::GetParkDeltaAz ( ParkDirection_t  target_direction,
ParkPosition_t  target_position 
)
protected

◆ GetSlewRate()

double SkywatcherAPIMount::GetSlewRate ( )
protected

Definition at line 577 of file skywatcherAPIMount.cpp.

◆ Goto()

bool SkywatcherAPIMount::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.

Definition at line 194 of file skywatcherAPIMount.cpp.

◆ GuideEast()

IPState SkywatcherAPIMount::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.

Definition at line 1298 of file skywatcherAPIMount.cpp.

◆ GuideNorth()

IPState SkywatcherAPIMount::GuideNorth ( uint32_t  ms)
overrideprotectedvirtual

Guiding.

Implements INDI::GuiderInterface.

Definition at line 1250 of file skywatcherAPIMount.cpp.

◆ GuideSouth()

IPState SkywatcherAPIMount::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.

Definition at line 1266 of file skywatcherAPIMount.cpp.

◆ GuideWest()

IPState SkywatcherAPIMount::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.

Definition at line 1282 of file skywatcherAPIMount.cpp.

◆ Handshake()

bool SkywatcherAPIMount::Handshake ( )
overrideprotectedvirtual

Communication.

Reimplemented from INDI::Telescope.

Definition at line 56 of file skywatcherAPIMount.cpp.

◆ initProperties()

bool SkywatcherAPIMount::initProperties ( )
overridevirtual

Called to initialize basic properties required all the time.

Reimplemented from INDI::Telescope.

Definition at line 301 of file skywatcherAPIMount.cpp.

◆ ISGetProperties()

void SkywatcherAPIMount::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.

Definition at line 440 of file skywatcherAPIMount.cpp.

◆ ISNewBLOB()

bool SkywatcherAPIMount::ISNewBLOB ( const char *  dev,
const char *  name,
int  sizes[],
int  blobsizes[],
char *  blobs[],
char *  formats[],
char *  names[],
int  n 
)
overridevirtual

Process the client newBLOB 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.

Definition at line 81 of file skywatcherAPIMount.cpp.

◆ ISNewNumber()

bool SkywatcherAPIMount::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.

Definition at line 96 of file skywatcherAPIMount.cpp.

◆ ISNewSwitch()

bool SkywatcherAPIMount::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.

Definition at line 157 of file skywatcherAPIMount.cpp.

◆ ISNewText()

bool SkywatcherAPIMount::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.

Definition at line 171 of file skywatcherAPIMount.cpp.

◆ MoveNS()

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

Motion.

Reimplemented from INDI::Telescope.

Definition at line 588 of file skywatcherAPIMount.cpp.

◆ MoveWE()

bool SkywatcherAPIMount::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.

Definition at line 617 of file skywatcherAPIMount.cpp.

◆ Park()

bool SkywatcherAPIMount::Park ( )
overrideprotectedvirtual

Parking.

Reimplemented from INDI::Telescope.

Definition at line 646 of file skywatcherAPIMount.cpp.

◆ ReadScopeStatus()

bool SkywatcherAPIMount::ReadScopeStatus ( )
overrideprotectedvirtual

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.

Definition at line 683 of file skywatcherAPIMount.cpp.

◆ saveConfigItems()

bool SkywatcherAPIMount::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.

Definition at line 814 of file skywatcherAPIMount.cpp.

◆ SetCurrentPark()

bool SkywatcherAPIMount::SetCurrentPark ( )
overrideprotectedvirtual

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 from INDI::Telescope.

Definition at line 1576 of file skywatcherAPIMount.cpp.

◆ SetDefaultPark()

bool SkywatcherAPIMount::SetDefaultPark ( )
overrideprotectedvirtual

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 from INDI::Telescope.

Definition at line 1586 of file skywatcherAPIMount.cpp.

◆ Sync()

bool SkywatcherAPIMount::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.

Definition at line 824 of file skywatcherAPIMount.cpp.

◆ TimerHit()

void SkywatcherAPIMount::TimerHit ( )
overrideprotectedvirtual

Called when setTimer() time is up.

Reimplemented from INDI::Telescope.

Definition at line 923 of file skywatcherAPIMount.cpp.

◆ UnPark()

bool SkywatcherAPIMount::UnPark ( )
overrideprotectedvirtual

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 from INDI::Telescope.

Definition at line 674 of file skywatcherAPIMount.cpp.

◆ updateLocation()

bool SkywatcherAPIMount::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.

Definition at line 1160 of file skywatcherAPIMount.cpp.

◆ updateProperties()

bool SkywatcherAPIMount::updateProperties ( )
overridevirtual

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

Reimplemented from INDI::Telescope.

Definition at line 1170 of file skywatcherAPIMount.cpp.


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