Instrument Neutral Distributed Interface INDI  1.6.0
Public Member Functions | Protected Member Functions | Friends | List of all members
ScopeSim Class Reference

The ScopeSim class provides a simple mount simulator of an equatorial mount. More...

#include <telescope_simulator.h>

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

Public Member Functions

 ScopeSim ()
 
virtual ~ScopeSim ()=default
 
virtual const char * getDefaultName () override
 
virtual bool Connect () override
 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 () override
 Disconnect from device. More...
 
virtual bool ReadScopeStatus () override
 Read telescope status. More...
 
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 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...
 
 ScopeSim ()
 
- Public Member Functions inherited from INDI::Telescope
 Telescope ()
 
virtual ~Telescope ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 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 HasPECState ()
 
bool HasTrackMode ()
 
bool HasTrackRate ()
 
virtual bool Handshake ()
 perform handshake with device to check communication More...
 
void SetParkDataType (TelescopeParkData type)
 setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More...
 
bool InitPark ()
 InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. More...
 
bool isParked ()
 isParked is mount currently parked? More...
 
void SetParked (bool isparked)
 SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. More...
 
double GetAxis1Park ()
 
double GetAxis1ParkDefault ()
 
double GetAxis2Park ()
 
double GetAxis2ParkDefault ()
 
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 ()
 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 ()
 
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 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 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 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 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 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...
 
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 (int 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 ()
 
uint16_t getMinorVersion ()
 
virtual uint16_t getDriverInterface ()
 
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 ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
- Public Member Functions inherited from INDI::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...
 
- 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 *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 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 (ln_lnlat_posn &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, ln_hrz_posn &HorizontalCoordinates)
 Calculates an altitude and azimuth from the supplied normalised direction vector and declination. More...
 
void AltitudeAzimuthFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, lnh_hrz_posn &HorizontalCoordinates)
 Calculates an altitude and azimuth from the supplied normalised direction vector and declination. More...
 
void EquatorialCoordinatesFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, struct ln_equ_posn &EquatorialCoordinates)
 Calculates equatorial coordinates from the supplied telescope direction vector and declination. More...
 
void EquatorialCoordinatesFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, struct lnh_equ_posn &EquatorialCoordinates)
 Calculates equatorial coordinates from the supplied telescope direction vector and declination. More...
 
void LocalHourAngleDeclinationFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, struct ln_equ_posn &EquatorialCoordinates)
 Calculates a local hour angle and declination from the supplied telescope direction vector and declination. More...
 
void LocalHourAngleDeclinationFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, struct lnh_equ_posn &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 (ln_hrz_posn HorizontalCoordinates)
 Calculates a normalised direction vector from the supplied altitude and azimuth. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromAltitudeAzimuth (lnh_hrz_posn HorizontalCoordinates)
 Calculates a normalised direction vector from the supplied altitude and azimuth. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromEquatorialCoordinates (struct ln_equ_posn EquatorialCoordinates)
 Calculates a telescope direction vector from the supplied equatorial coordinates. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromEquatorialCoordinates (struct lnh_equ_posn EquatorialCoordinates)
 Calculates a telescope direction vector from the supplied equatorial coordinates. More...
 
const TelescopeDirectionVector TelescopeDirectionVectorFromLocalHourAngleDeclination (struct ln_equ_posn 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...
 
- Public Member Functions inherited from INDI::GuiderInterface
virtual void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 

Protected Member Functions

virtual bool MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override
 Start or Stop the telescope motion in the direction dir. More...
 
virtual bool MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override
 Move the telescope in the direction dir. More...
 
virtual bool Abort () override
 Abort any telescope motion including tracking if possible. More...
 
virtual IPState GuideNorth (float ms) override
 Guide north for ms milliseconds. North is defined as DEC+. More...
 
virtual IPState GuideSouth (float ms) override
 Guide south for ms milliseconds. South is defined as DEC-. More...
 
virtual IPState GuideEast (float ms) override
 Guide east for ms milliseconds. East is defined as RA+. More...
 
virtual IPState GuideWest (float ms) override
 Guide west for ms milliseconds. West is defined as RA-. More...
 
virtual bool updateLocation (double latitude, double longitude, double elevation) override
 Update telescope location settings. More...
 
virtual bool SetTrackMode (uint8_t mode) override
 SetTrackMode Set active tracking mode. Do not change track state. More...
 
virtual bool SetTrackEnabled (bool enabled) override
 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 SetTrackRate (double raRate, double deRate) override
 SetTrackRate Set custom tracking rates. More...
 
virtual bool Goto (double, double) override
 Move the scope to the supplied RA and DEC coordinates. More...
 
virtual bool Park () override
 Park the telescope to its home position. More...
 
virtual bool UnPark () override
 Unpark the telescope if already parked. 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 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
virtual bool saveConfigItems (FILE *fp)
 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 int AddTrackMode (const char *name, const char *label, bool isDefault=false)
 AddTrackMode. More...
 
virtual bool updateTime (ln_date *utc, double utc_offset)
 Update telescope time, date, and UTC offset. 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 processSlewPresets (double mag, double angle)
 
void processButton (const char *button_n, ISState state)
 
bool LoadScopeConfig ()
 Load scope settings from XML files. More...
 
bool HasDefaultScopeConfig ()
 Load scope settings from XML files. More...
 
bool UpdateScopeConfig ()
 Save scope settings to XML files. More...
 
std::string GetHomeDirectory () const
 Validate a file name. More...
 
int GetScopeConfigIndex () const
 Get the scope config index. More...
 
bool CheckFile (const std::string &file_name, bool writable) const
 Check if a file exists and it is readable. More...
 
char * LoadParkData ()
 
bool WriteParkData ()
 
- 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 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 ()
 
bool isSimulation ()
 
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 ()
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
- 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...
 

Friends

void ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Update data of an existing blob vector property. More...
 
void ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
 
void ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Update the value of an existing switch vector property. More...
 
void ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Update the value of an existing text vector property. More...
 

Additional Inherited Members

- Public Types inherited from INDI::Telescope
- Public Types inherited from INDI::BaseDevice
- Public Types inherited from INDI::AlignmentSubsystem::InMemoryDatabase
typedef std::vector< AlignmentDatabaseEntryAlignmentDatabaseType
 
typedef void(* LoadDatabaseCallbackPointer_t) (void *)
 
- Public Types inherited from INDI::AlignmentSubsystem::MathPluginManagement
typedef enum INDI::AlignmentSubsystem::MathPluginManagement::MountType MountType_t
 
- Public Types inherited from INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions
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 buttonHelper (const char *button_n, ISState state, void *context)
 
- Public Attributes inherited from INDI::Telescope
enum INDI::Telescope:: { ... }  TelescopeConnection
 
enum INDI::Telescope:: { ... }  TelescopeCapability
 
- Protected Types inherited from INDI::Telescope
- Protected Attributes inherited from INDI::Telescope
TelescopeStatus TrackState
 
TelescopeStatus RememberTrackState
 RememberTrackState Remember last state of Track State to fall back to in case of errors or aborts. More...
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
INumberVectorProperty TargetNP
 
INumber TargetN [2]
 
ISwitchVectorProperty AbortSP
 
ISwitch AbortS [1]
 
ISwitchVectorProperty CoordSP
 
ISwitch CoordS [3]
 
INumberVectorProperty LocationNP
 
INumber LocationN [3]
 
ISwitchVectorProperty ParkSP
 
ISwitch ParkS [2]
 
INumber ParkPositionN [2]
 
INumberVectorProperty ParkPositionNP
 
ISwitch ParkOptionS [3]
 
ISwitchVectorProperty ParkOptionSP
 
ISwitch MovementNSS [2]
 
ISwitchVectorProperty MovementNSSP
 
ISwitch MovementWES [2]
 
ISwitchVectorProperty MovementWESP
 
ISwitchVectorProperty SlewRateSP
 
ISwitchSlewRateS
 
INumber ScopeParametersN [4]
 
INumberVectorProperty ScopeParametersNP
 
IText TimeT [2]
 
ITextVectorProperty TimeTP
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [2]
 
ISwitchVectorProperty DomeClosedLockTP
 
ISwitch DomeClosedLockT [4]
 
ISwitch LockAxisS [2]
 
ISwitchVectorProperty LockAxisSP
 
ISwitch PierSideS [2]
 
ISwitchVectorProperty PierSideSP
 
TelescopePierSide lastPierSide
 
TelescopePierSide currentPierSide
 
ISwitch PECStateS [2]
 
ISwitchVectorProperty PECStateSP
 
ISwitchVectorProperty TrackModeSP
 
ISwitchTrackModeS { nullptr }
 
ISwitchVectorProperty TrackStateSP
 
ISwitch TrackStateS [2]
 
INumberVectorProperty TrackRateNP
 
INumber TrackRateN [2]
 
TelescopePECState lastPECState
 
TelescopePECState currentPECState
 
uint32_t capability
 
int last_we_motion
 
int last_ns_motion
 
int PortFD = -1
 
Connection::SerialserialConnection = NULL
 
Connection::TCPtcpConnection = NULL
 
const std::string ScopeConfigRootXmlNode { "scopeconfig" }
 
const std::string ScopeConfigDeviceXmlNode { "device" }
 
const std::string ScopeConfigNameXmlNode { "name" }
 
const std::string ScopeConfigScopeFocXmlNode { "scopefoc" }
 
const std::string ScopeConfigScopeApXmlNode { "scopeap" }
 
const std::string ScopeConfigGScopeFocXmlNode { "gscopefoc" }
 
const std::string ScopeConfigGScopeApXmlNode { "gscopeap" }
 
const std::string ScopeConfigLabelApXmlNode { "label" }
 
ISwitch ScopeConfigs [6]
 
ISwitchVectorProperty ScopeConfigsSP
 
ITextVectorProperty ScopeConfigNameTP
 
IText ScopeConfigNameT [1]
 
const std::string ScopeConfigFileName
 The telescope/guide scope configuration file name. More...
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t updatePeriodMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 
- Protected Attributes inherited from INDI::GuiderInterface
INumber GuideNSN [2]
 
INumberVectorProperty GuideNSNP
 
INumber GuideWEN [2]
 
INumberVectorProperty GuideWENP
 

Detailed Description

The ScopeSim class provides a simple mount simulator of an equatorial mount.

It supports the following features:

On startup and by default the mount shall point to the celestial pole.

Author
Jasem Mutlaq

Definition at line 39 of file telescope_simulator.h.

Constructor & Destructor Documentation

ScopeSim::ScopeSim ( )

Definition at line 91 of file telescope_simulator.cpp.

virtual ScopeSim::~ScopeSim ( )
virtualdefault
ScopeSim::ScopeSim ( )

Member Function Documentation

bool ScopeSim::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 726 of file telescope_simulator.cpp.

bool ScopeSim::Connect ( )
overridevirtual

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.

Returns
True if connection is successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 238 of file telescope_simulator.cpp.

bool ScopeSim::Disconnect ( )
overridevirtual

Disconnect from device.

Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 245 of file telescope_simulator.cpp.

const char * ScopeSim::getDefaultName ( )
overridevirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 103 of file telescope_simulator.cpp.

bool ScopeSim::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 556 of file telescope_simulator.cpp.

IPState ScopeSim::GuideEast ( float  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 771 of file telescope_simulator.cpp.

IPState ScopeSim::GuideNorth ( float  ms)
overrideprotectedvirtual

Guide north for ms milliseconds. North is defined as DEC+.

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

Implements INDI::GuiderInterface.

Definition at line 757 of file telescope_simulator.cpp.

IPState ScopeSim::GuideSouth ( float  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 764 of file telescope_simulator.cpp.

IPState ScopeSim::GuideWest ( float  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 778 of file telescope_simulator.cpp.

bool ScopeSim::initProperties ( )
overridevirtual

Called to initialize basic properties required all the time.

Reimplemented from INDI::Telescope.

Definition at line 108 of file telescope_simulator.cpp.

void ScopeSim::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 175 of file telescope_simulator.cpp.

bool ScopeSim::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 632 of file telescope_simulator.cpp.

bool ScopeSim::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 658 of file telescope_simulator.cpp.

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

Start or Stop the telescope motion in the direction dir.

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

Reimplemented from INDI::Telescope.

Definition at line 731 of file telescope_simulator.cpp.

bool ScopeSim::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 744 of file telescope_simulator.cpp.

bool ScopeSim::Park ( )
overrideprotectedvirtual

Park the telescope to its home position.

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

Reimplemented from INDI::Telescope.

Definition at line 617 of file telescope_simulator.cpp.

bool ScopeSim::ReadScopeStatus ( )
overridevirtual

Read telescope status.

This function checks the following:

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

Implements INDI::Telescope.

Definition at line 251 of file telescope_simulator.cpp.

bool ScopeSim::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 799 of file telescope_simulator.cpp.

bool ScopeSim::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 807 of file telescope_simulator.cpp.

bool ScopeSim::SetTrackEnabled ( bool  enabled)
overrideprotectedvirtual

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

Definition at line 824 of file telescope_simulator.cpp.

bool ScopeSim::SetTrackMode ( uint8_t  mode)
overrideprotectedvirtual

SetTrackMode Set active tracking mode. Do not change track state.

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

Reimplemented from INDI::Telescope.

Definition at line 818 of file telescope_simulator.cpp.

bool ScopeSim::SetTrackRate ( double  raRate,
double  deRate 
)
overrideprotectedvirtual

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

Definition at line 830 of file telescope_simulator.cpp.

bool ScopeSim::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 599 of file telescope_simulator.cpp.

bool ScopeSim::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 626 of file telescope_simulator.cpp.

bool ScopeSim::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 785 of file telescope_simulator.cpp.

bool ScopeSim::updateProperties ( )
overridevirtual

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

Reimplemented from INDI::Telescope.

Definition at line 191 of file telescope_simulator.cpp.

Friends And Related Function Documentation

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

Update data of an existing blob vector property.

Parameters
devthe name of the device.
namethe name of the blob vector property to update.
sizesan array of base64 blob sizes in bytes before decoding.
blobsizesan array of the sizes of blobs after decoding from base64.
blobsan array of decoded data. Each blob size is found in blobsizes array.
formatsBlob data format (e.g. fits.z).
namesnames of blob members to update.
nthe number of blobs to update.
Note
You do not need to call this function, it is called by INDI when new blob values arrive from the client. e.g. BLOB element with name names[0] has data located in blobs[0] with size sizes[0] and format formats[0].

Definition at line 57 of file agent_imager.cpp.

void ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
friend

Definition at line 52 of file agent_imager.cpp.

void ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
friend

Update the value of an existing switch vector property.

Parameters
devthe name of the device.
namethe name of the switch vector property to update.
statesan array of switch states.
namesparallel names to the array of switch states.
nthe dimension of states[].
Note
You do not need to call this function, it is called by INDI when new switch values arrive from the client.

Definition at line 42 of file agent_imager.cpp.

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

Update the value of an existing text vector property.

Parameters
devthe name of the device.
namethe name of the text vector property to update.
textsan array of text values.
namesparallel names to the array of text values.
nthe dimension of texts[].
Note
You do not need to call this function, it is called by INDI when new text values arrive from the client.

Definition at line 47 of file agent_imager.cpp.


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