#include <inditelescope.h>

Inheritance diagram for INDI::Telescope:

Public Types
enum	TelescopeStatus { SCOPE_IDLE , SCOPE_SLEWING , SCOPE_TRACKING , SCOPE_PARKING , SCOPE_PARKED }

enum	TelescopeMotionCommand { MOTION_START = 0 , MOTION_STOP }

enum	TelescopeSlewRate { SLEW_GUIDE , SLEW_CENTERING , SLEW_FIND , SLEW_MAX }

enum	TelescopeTrackMode { TRACK_SIDEREAL , TRACK_SOLAR , TRACK_LUNAR , TRACK_CUSTOM }

enum	TelescopeTrackState { TRACK_ON , TRACK_OFF , TRACK_UNKNOWN }

enum	TelescopeParkData { PARK_NONE , PARK_RA_DEC , PARK_HA_DEC , PARK_AZ_ALT , PARK_RA_DEC_ENCODER , PARK_AZ_ALT_ENCODER , PARK_SIMPLE }

enum	TelescopeLocation { LOCATION_LATITUDE , LOCATION_LONGITUDE , LOCATION_ELEVATION }

enum	TelescopePierSide { PIER_UNKNOWN = -1 , PIER_WEST = 0 , PIER_EAST = 1 }

enum	TelescopeHomeAction { HOME_FIND , HOME_SET , HOME_GO }

enum	TelescopePECState { PEC_UNKNOWN = -1 , PEC_OFF = 0 , PEC_ON = 1 }

enum	DomeLockingPolicy { DOME_IGNORED , DOME_LOCKS }

enum	{ CONNECTION_NONE = 1 << 0 , CONNECTION_SERIAL = 1 << 1 , CONNECTION_TCP = 1 << 2 }

enum	{ TELESCOPE_CAN_GOTO = 1 << 0 , TELESCOPE_CAN_SYNC = 1 << 1 , TELESCOPE_CAN_PARK = 1 << 2 , TELESCOPE_CAN_ABORT = 1 << 3 , TELESCOPE_HAS_TIME = 1 << 4 , TELESCOPE_HAS_LOCATION = 1 << 5 , TELESCOPE_HAS_PIER_SIDE = 1 << 6 , TELESCOPE_HAS_PEC = 1 << 7 , TELESCOPE_HAS_TRACK_MODE = 1 << 8 , TELESCOPE_CAN_CONTROL_TRACK = 1 << 9 , TELESCOPE_HAS_TRACK_RATE = 1 << 10 , TELESCOPE_HAS_PIER_SIDE_SIMULATION = 1 << 11 , TELESCOPE_CAN_TRACK_SATELLITE = 1 << 12 , TELESCOPE_CAN_FLIP = 1 << 13 , TELESCOPE_CAN_HOME_FIND = 1 << 14 , TELESCOPE_CAN_HOME_SET = 1 << 15 , TELESCOPE_CAN_HOME_GO = 1 << 16 }

Public Types inherited from INDI::ParentDevice
enum	Type { Valid , Invalid }

Public Types inherited from INDI::BaseDevice
enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1 , INDI_PROPERTY_INVALID = -2 , INDI_PROPERTY_DUPLICATED = -3 , INDI_DISPATCH_ERROR = -4 }

enum	{ INDI_ENABLED , INDI_DISABLED }

enum	WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0 , TELESCOPE_INTERFACE = (1 << 0) , CCD_INTERFACE = (1 << 1) , GUIDER_INTERFACE = (1 << 2) , FOCUSER_INTERFACE = (1 << 3) , FILTER_INTERFACE = (1 << 4) , DOME_INTERFACE = (1 << 5) , GPS_INTERFACE = (1 << 6) , WEATHER_INTERFACE = (1 << 7) , AO_INTERFACE = (1 << 8) , DUSTCAP_INTERFACE = (1 << 9) , LIGHTBOX_INTERFACE = (1 << 10) , DETECTOR_INTERFACE = (1 << 11) , ROTATOR_INTERFACE = (1 << 12) , SPECTROGRAPH_INTERFACE = (1 << 13) , CORRELATOR_INTERFACE = (1 << 14) , AUX_INTERFACE = (1 << 15) , OUTPUT_INTERFACE = (1 << 16) , INPUT_INTERFACE = (1 << 17) , POWER_INTERFACE = (1 << 18) , IMU_INTERFACE = (1 << 19) , PAC_INTERFACE = (1 << 20) , SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE \| DETECTOR_INTERFACE \| CORRELATOR_INTERFACE }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...

typedef INDI::Properties	Properties

Public Member Functions
	Telescope ()

virtual	~Telescope ()

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n) override
	Process the client newNumber command.

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n) override
	Process the client newSwitch command.

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n) override
	Process the client newSwitch command.

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.

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.

uint32_t	GetTelescopeCapability () const
	GetTelescopeCapability returns the capability of the Telescope.

void	SetTelescopeCapability (uint32_t cap, uint8_t slewRateCount)
	SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized.

bool	CanGOTO ()

bool	CanSync ()

bool	CanFlip ()

bool	CanAbort ()

bool	CanPark ()

bool	CanControlTrack ()

bool	HasTime ()

bool	HasLocation ()

bool	HasPierSide ()

bool	HasPierSideSimulation ()

bool	CanTrackSatellite ()

bool	HasPECState ()

bool	HasTrackMode ()

bool	HasTrackRate ()

bool	CanHomeFind ()

bool	CanHomeSet ()

bool	CanHomeGo ()

virtual bool	initProperties () override
	Called to initialize basic properties required all the time.

virtual bool	updateProperties () override
	Called when connected state changes, to add/remove properties.

virtual bool	Handshake ()
	perform handshake with device to check communication

virtual void	TimerHit () override
	Called when setTimer() time is up.

void	SetParkDataType (TelescopeParkData type)
	setParkDataType Sets the type of parking data stored in the park data file and presented to the user.

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

bool	isParked ()
	isParked is mount currently parked?

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

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.

void	SetAxis1ParkDefault (double steps)
	SetRAPark Set default RA/AZ parking position.

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.

void	SetAxis2ParkDefault (double steps)
	SetDEParkDefault Set default DEC/ALT parking position.

bool	isLocked () const
	isLocked is mount currently locked?

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

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.

void	addDebugControl ()
	Add Debug control to the driver.

void	addSimulationControl ()
	Add Simulation control to the driver.

void	addConfigurationControl ()
	Add Configuration control to the driver.

void	addPollPeriodControl ()
	Add Polling period control to the driver.

void	addNicknameControl ()
	Add Nickname text property to the driver.

void	resetProperties ()
	Set all properties to IDLE state.

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.

void	defineProperty (INumberVectorProperty *property)

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (ITextVectorProperty *property)

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (ISwitchVectorProperty *property)

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (ILightVectorProperty *property)

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files.

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.

bool	deleteProperty (INDI::Property &property)
	deleteProperty Delete a property and unregister it. It will also be deleted from all clients.

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client.

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds.

void	RemoveTimer (int id)
	Remove timer added with SetTimer.

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.

uint16_t	getMajorVersion () const

uint16_t	getMinorVersion () const

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command.

bool	ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value)
	Generic convenience function to update a property element as if by client request, simulating an ISNew... call.

template<typename PropertyType , typename ValueType >
bool	updateProperty (PropertyType &property, ValueType values, char names[], int n, std::function< bool()> updater, bool saveConfig=false)
	Generic helper function to update an INDI property based on an external operation.

uint32_t	getDriverInterface () const

void	setDriverInterface (uint32_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.

void	watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
	Add a device to the watch list.

Public Member Functions inherited from INDI::ParentDevice
	ParentDevice (Type type)

	~ParentDevice ()

	ParentDevice (ParentDevice &&other)=default

ParentDevice &	operator= (ParentDevice &&other)=default

Public Member Functions inherited from INDI::BaseDevice
	BaseDevice ()

virtual	~BaseDevice ()

void	registerProperty (const INDI::Property &property)
	Register the property to be able to observe and update.

void	registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property.

void	watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
	Call the callback function if property is available.

Property	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name.

Properties	getProperties ()
	Return a list of all properties in the device.

const Properties	getProperties () const

INDI::PropertyNumber	getNumber (const char *name) const

INDI::PropertyText	getText (const char *name) const

INDI::PropertySwitch	getSwitch (const char *name) const

INDI::PropertyLight	getLight (const char *name) const

INDI::PropertyBlob	getBLOB (const char *name) const

IPState	getPropertyState (const char *name) const

IPerm	getPropertyPermission (const char *name) const

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name.

void	addMessage (const std::string &msg)
	Add message to the driver's message queue.

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

const std::string &	messageQueue (size_t index) const

const std::string &	lastMessage () const

bool	isValid () const

bool	isSameDevice (const BaseDevice &other) const

bool	isConnected () const

void	attach ()
	indicates that the device is ready

void	detach ()
	indicates that the device is being removed

void	setMediator (INDI::BaseMediator *mediator)
	Set the driver's mediator to receive notification of news devices and updated property values.

INDI::BaseMediator *	getMediator () const

void	setDeviceName (const char *dev)
	Set the device name.

const char *	getDeviceName () const

bool	isDeviceNameMatch (const char *otherName) const
	Check that the device name matches the argument.

bool	isDeviceNameMatch (const std::string &otherName) const
	Check that the device name matches the argument.

const char *	getDriverName () const

const char *	getDriverExec () const

const char *	getDriverVersion () const

uint16_t	getDriverInterface () const
	getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver.

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file.

int	buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
	Build a property given the supplied XML element (defXXX)

int	setValue (const INDI::LilXmlElement &root, char *errmsg)
	handle SetXXX commands from client

	operator BaseDevice * ()

BaseDevice *	operator-> ()

bool	operator!= (std::nullptr_t) const

bool	operator== (std::nullptr_t) const

	operator bool () const

	operator bool ()

Static Public Member Functions
static void	joystickHelper (const char joystick_n, double mag, double angle, void context)

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

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

Static Public Member Functions inherited from INDI::BaseDevice
static std::string	getSharedFilePath (std::string fileName)

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

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

Protected Types
enum	{ PARK , UNPARK }

enum	{ PARK_CURRENT , PARK_DEFAULT , PARK_WRITE_DATA , PARK_PURGE_DATA }

enum	{ REVERSE_NS , REVERSE_WE }

enum	{ UTC , OFFSET }

enum	{ ACTIVE_GPS , ACTIVE_DOME }

enum	{ MOTION_CONTROL_MODE_JOYSTICK , MOTION_CONTROL_MODE_AXES }

enum	{ LOCK_AXIS_1 , LOCK_AXIS_2 }

enum	{ JOYSTICK_REVERSE_NS , JOYSTICK_REVERSE_WE , JOYSTICK_REVERSE_SWAP }

enum	{ SIMULATE_YES , SIMULATE_NO }

enum	{ SAT_PASS_WINDOW_START , SAT_PASS_WINDOW_END }

enum	{ SAT_TRACK , SAT_HALT }

enum	{ MOUNT_ALTAZ , MOUNT_EQ_FORK , MOUNT_EQ_GEM }

Protected Member Functions
virtual bool	saveConfigItems (FILE *fp) override
	saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

void	NewRaDec (double ra, double dec)
	The child class calls this function when it has updates.

virtual bool	ReadScopeStatus ()=0
	Read telescope status.

virtual bool	Flip (double ra, double dec)
	Move and flip the scope to the supplied RA and DEC coordinates.

virtual bool	Goto (double ra, double dec)
	Move the scope to the supplied RA and DEC coordinates.

virtual bool	Sync (double ra, double dec)
	Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates.

virtual bool	MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command)
	Start or Stop the telescope motion in the direction dir.

virtual bool	MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command)
	Move the telescope in the direction dir.

virtual bool	Park ()
	Park the telescope to its home position.

virtual bool	UnPark ()
	Unpark the telescope if already parked.

virtual bool	Abort ()
	Abort any telescope motion including tracking if possible.

virtual bool	SetTrackMode (uint8_t mode)
	SetTrackMode Set active tracking mode. Do not change track state.

virtual bool	SetTrackRate (double raRate, double deRate)
	SetTrackRate Set custom tracking rates.

virtual int	AddTrackMode (const char name, const char label, bool isDefault=false)
	AddTrackMode.

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.

virtual bool	updateTime (ln_date *utc, double utc_offset)
	Update telescope time, date, and UTC offset.

virtual bool	updateLocation (double latitude, double longitude, double elevation)
	Update telescope location settings.

void	updateObserverLocation (double latitude, double longitude, double elevation)
	Update location settings of the observer.

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.

virtual IPState	ExecuteHomeAction (TelescopeHomeAction action)
	Execute a homing action.

virtual bool	SetCurrentPark ()
	SetCurrentPark Set current coordinates/encoders value as the desired parking position.

virtual bool	SetDefaultPark ()
	SetDefaultPark Set default coordinates/encoders value as the desired parking position.

virtual void	SyncParkStatus (bool isparked)
	SyncParkStatus Update the state and switches for parking.

virtual bool	SetSlewRate (int index)
	SetSlewRate Set desired slew rate index.

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

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.

std::string	GetHomeDirectory () const
	Validate a file name.

int	GetScopeConfigIndex () const
	Get the scope config index.

bool	CheckFile (const std::string &file_name, bool writable) const
	Check if a file exists and it is readable.

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

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file.

bool	loadConfig (INDI::Property &property)
	Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file.

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file.

bool	saveConfig (INDI::Property &property)
	Save a property in the configuration file.

virtual bool	purgeConfig ()
	purgeConfig Remove config file from disk.

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file

virtual bool	loadDefaultConfig ()
	Load the default configuration file.

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client.

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client.

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.

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.

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.

virtual bool	Disconnect ()
	Disconnect from device.

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()

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool

Connection::Interface *	getActiveConnection ()

void	setActiveConnection (Connection::Interface *existingConnection)
	setActiveConnection Switch the active connection to the passed connection plugin

void	setDefaultPollingPeriod (uint32_t msec)
	setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver.

void	setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
	setPollingPeriodRange Set the range permitted by the polling range in milliseconds

uint32_t	getPollingPeriod () const
	getPollingPeriod Return the polling period.

void	setCurrentPollingPeriod (uint32_t msec)
	setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver.

uint32_t	getCurrentPollingPeriod () const
	getCurrentPollingPeriod Return the current polling period.

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.

bool	isInitializationComplete () const
	isInitializationComplete Check if driver initialization is complete.

void	syncDriverInfo ()
	syncDriverInfo sends the current driver information to the client.

virtual const char *	getDefaultName ()=0

void	setDeviceNickname (const char *nick)
	Set the device nickname.

const char *	getDeviceNickname ()

const char *	lookupDeviceNicknameFromId (const char identifier, const char device=nullptr)
	Lookup device nickname for an identifier.

bool	setDeviceNicknameFromId (const char *identifier)
	Set device nickname based on an identifier.

void	saveNicknameId (const char nickname, const char identifier)

virtual void	nicknameSet (const char *nickname)
	Inform driver that the nickname has been set.

	DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd)

Protected Member Functions inherited from INDI::ParentDevice
	ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd)

Protected Member Functions inherited from INDI::BaseDevice
	BaseDevice (BaseDevicePrivate &dd)

	BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd)

Protected Attributes
IGeographicCoordinates	m_Location { 0, 0, 0 }

TelescopeStatus	TrackState {SCOPE_IDLE}

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

INDI::PropertyNumber	EqNP {2}

INDI::PropertyNumber	TargetNP {2}

INDI::PropertySwitch	AbortSP {1}

INDI::PropertySwitch	CoordSP {4}

INDI::PropertyNumber	LocationNP {3}

INDI::PropertySwitch	ParkSP {2}

INDI::PropertyNumber	ParkPositionNP {2}

INDI::PropertySwitch	ParkOptionSP {4}

INDI::PropertySwitch	MovementNSSP {2}

INDI::PropertySwitch	MovementWESP {2}

INDI::PropertySwitch	ReverseMovementSP {2}

INDI::PropertySwitch	SlewRateSP {0}

INDI::PropertyText	TimeTP {2}

INDI::PropertyText	ActiveDeviceTP {2}

INDI::PropertySwitch	DomePolicySP {2}

INDI::PropertySwitch	MotionControlModeTP {2}

INDI::PropertySwitch	LockAxisSP {2}

INDI::PropertySwitch	JoystickReverseSP {3}

INDI::PropertySwitch	PierSideSP {2}

INDI::PropertySwitch	SimulatePierSideSP {2}

TelescopePierSide	lastPierSide

TelescopePierSide	currentPierSide

INDI::PropertyText	TLEtoTrackTP {1}
	Text Vector property defining the orbital elements of an artificial satellite (TLE). Example implementation.

INDI::PropertyText	SatPassWindowTP {2}
	Text Vector property defining the start and end of a satellite pass (window contains pass). Example implementation.

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

INDI::PropertySwitch	TrackSatSP {2}
	Switch Vector property defining the state of the satellite tracking of the mount. Example implementation.

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

INDI::PropertySwitch	PECStateSP {2}

INDI::PropertySwitch	MountTypeSP {3}

INDI::PropertySwitch	TrackModeSP {0}

INDI::PropertySwitch	TrackStateSP {2}

INDI::PropertyNumber	TrackRateNP {2}

INDI::PropertySwitch	HomeSP {0}

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::Serial *	serialConnection = nullptr

Connection::TCP *	tcpConnection = nullptr

bool	IsParked {false}

TelescopeParkData	parkDataType {PARK_NONE}

Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivate >	d_ptr

Detailed Description

Examples: simplescope.h.

Definition at line 78 of file inditelescope.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin
CONNECTION_TCP	For regular serial and bluetooth connections

Definition at line 162 of file inditelescope.h.

◆ anonymous enum

anonymous enum

Enumerator
TELESCOPE_CAN_GOTO
TELESCOPE_CAN_SYNC	Can the telescope go to to specific coordinates?
TELESCOPE_CAN_PARK	Can the telescope sync to specific coordinates?
TELESCOPE_CAN_ABORT	Can the telescope park?
TELESCOPE_HAS_TIME	Can the telescope abort motion?
TELESCOPE_HAS_LOCATION	Does the telescope have configurable date and time settings?
TELESCOPE_HAS_PIER_SIDE	Does the telescope have configuration location settings?
TELESCOPE_HAS_PEC	Does the telescope have pier side property?
TELESCOPE_HAS_TRACK_MODE	Does the telescope have PEC playback?
TELESCOPE_CAN_CONTROL_TRACK	Does the telescope have track modes (sidereal, lunar, solar..etc)?
TELESCOPE_HAS_TRACK_RATE	Can the telescope engage and disengage tracking?
TELESCOPE_HAS_PIER_SIDE_SIMULATION	Does the telescope have custom track rates?
TELESCOPE_CAN_TRACK_SATELLITE	Does the telescope simulate the pier side property?
TELESCOPE_CAN_FLIP	Can the telescope track satellites?
TELESCOPE_CAN_HOME_FIND	Does the telescope have a command for flipping?
TELESCOPE_CAN_HOME_SET	Can the telescope find home position?
TELESCOPE_CAN_HOME_GO	Can the telescope set the current position as the new home position?

Definition at line 173 of file inditelescope.h.

◆ DomeLockingPolicy

enum INDI::Telescope::DomeLockingPolicy

Dome Locking Policy

Enumerator
DOME_IGNORED	Dome is ignored. Mount can park or unpark irrespective of dome parking status.
DOME_LOCKS	Dome locks. Mount can only unpark if dome is already unparked.

Definition at line 152 of file inditelescope.h.

◆ TelescopeHomeAction

enum INDI::Telescope::TelescopeHomeAction

Enumerator
HOME_FIND	Command mount to search for home position.
HOME_SET	Command mount to accept current position as the home position.
HOME_GO	Command mount to slew to home position.

Definition at line 137 of file inditelescope.h.

◆ TelescopeLocation

enum INDI::Telescope::TelescopeLocation

Enumerator
LOCATION_LATITUDE
LOCATION_LONGITUDE
LOCATION_ELEVATION

Definition at line 124 of file inditelescope.h.

◆ TelescopeMotionCommand

enum INDI::Telescope::TelescopeMotionCommand

Enumerator
MOTION_START
MOTION_STOP

Definition at line 89 of file inditelescope.h.

◆ TelescopeParkData

enum INDI::Telescope::TelescopeParkData

Enumerator
PARK_NONE	Mount does not support any form of parking
PARK_RA_DEC	Park to specific RA/DE coordinate. Deprecated, do not use
PARK_HA_DEC	Park to specific HA/DE coordinate. Hour Angle & Declination degrees
PARK_AZ_ALT	Park to specific AZ/ALT coordinate. Azimuth & Altitude degrees
PARK_RA_DEC_ENCODER	Park to specific HA/DE encoder. Hour Angle & Declination steps
PARK_AZ_ALT_ENCODER	Park to specific AZ/ALT encoder. Azimuth & Altitude steps
PARK_SIMPLE	Only Park or Unpark is known but location is unknown.

Definition at line 114 of file inditelescope.h.

◆ TelescopePECState

enum INDI::Telescope::TelescopePECState

Enumerator
PEC_UNKNOWN
PEC_OFF
PEC_ON

Definition at line 144 of file inditelescope.h.

◆ TelescopePierSide

enum INDI::Telescope::TelescopePierSide

Enumerator
PIER_UNKNOWN
PIER_WEST
PIER_EAST

Definition at line 130 of file inditelescope.h.

◆ TelescopeSlewRate

enum INDI::Telescope::TelescopeSlewRate

Enumerator
SLEW_GUIDE
SLEW_CENTERING
SLEW_FIND
SLEW_MAX

Definition at line 94 of file inditelescope.h.

◆ TelescopeStatus

enum INDI::Telescope::TelescopeStatus

Enumerator
SCOPE_IDLE
SCOPE_SLEWING
SCOPE_TRACKING
SCOPE_PARKING
SCOPE_PARKED

Definition at line 81 of file inditelescope.h.

◆ TelescopeTrackMode

enum INDI::Telescope::TelescopeTrackMode

Enumerator
TRACK_SIDEREAL
TRACK_SOLAR
TRACK_LUNAR
TRACK_CUSTOM

Definition at line 101 of file inditelescope.h.

◆ TelescopeTrackState

enum INDI::Telescope::TelescopeTrackState

Enumerator
TRACK_ON
TRACK_OFF
TRACK_UNKNOWN

Definition at line 108 of file inditelescope.h.

Constructor & Destructor Documentation

◆ Telescope()

Telescope::Telescope ( )

Definition at line 42 of file inditelescope.cpp.

◆ ~Telescope()

Telescope::~Telescope ( )

virtual

Definition at line 57 of file inditelescope.cpp.

Member Function Documentation

◆ Abort()

bool Telescope::Abort ( )

protectedvirtual

Abort any telescope motion including tracking if possible.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, EQ500X, IEQPro, IEQProLegacy, alpacaTelescopeDriver, IOptronV3, LX200_TeenAstro, LX200Basic, LX200Pulsar2, LX200Telescope, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, TemmaMount, ScopeSim, SimpleScope, and SkywatcherAltAzSimple.

Definition at line 1683 of file inditelescope.cpp.

◆ AddTrackMode()

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

protectedvirtual

AddTrackMode.

Parameters

name	Name of track mode. It is recommended to use standard properties names such as TRACK_SIDEREAL..etc.
label	Label of track mode that appears at the client side.
isDefault	Set to true to mark the track mode as the default. Only one mode should be marked as default.

Returns: Index of added track mode

Note: Child class should add all track modes be

Definition at line 1723 of file inditelescope.cpp.

◆ axisHelper()

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

static

Definition at line 2739 of file inditelescope.cpp.

◆ buttonHelper()

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

static

Definition at line 2744 of file inditelescope.cpp.

◆ callHandshake()

bool Telescope::callHandshake ( )

protected

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

Returns: Result of actual device Handshake()

Definition at line 1627 of file inditelescope.cpp.

◆ CanAbort()

bool INDI::Telescope::CanAbort ( )

inline

Returns: True if telescope can abort motion.

Definition at line 248 of file inditelescope.h.

◆ CanControlTrack()

bool INDI::Telescope::CanControlTrack ( )

inline

Returns: True if telescope can enagle and disengage tracking.

Definition at line 264 of file inditelescope.h.

◆ CanFlip()

bool INDI::Telescope::CanFlip ( )

inline

Returns: True if telescope support sync operations

Definition at line 240 of file inditelescope.h.

◆ CanGOTO()

bool INDI::Telescope::CanGOTO ( )

inline

Returns: True if telescope support goto operations

Definition at line 224 of file inditelescope.h.

◆ CanHomeFind()

bool INDI::Telescope::CanHomeFind ( )

inline

Returns: True if telescope can search for home position.

Definition at line 334 of file inditelescope.h.

◆ CanHomeGo()

bool INDI::Telescope::CanHomeGo ( )

inline

Returns: True if telescope can go to the home position.

Definition at line 350 of file inditelescope.h.

◆ CanHomeSet()

bool INDI::Telescope::CanHomeSet ( )

inline

Returns: True if telescope can set current position as the home position.

Definition at line 342 of file inditelescope.h.

◆ CanPark()

bool INDI::Telescope::CanPark ( )

inline

Returns: True if telescope can park.

Definition at line 256 of file inditelescope.h.

◆ CanSync()

bool INDI::Telescope::CanSync ( )

inline

Returns: True if telescope support sync operations

Definition at line 232 of file inditelescope.h.

◆ CanTrackSatellite()

bool INDI::Telescope::CanTrackSatellite ( )

inline

Returns: True if telescope can track satellites

Definition at line 303 of file inditelescope.h.

◆ CheckFile()

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

protected

Check if a file exists and it is readable.

Parameters

file_name	File name
writable	Additional check if the file is writable

Returns: True if the checks are successful otherwise false.

Definition at line 2816 of file inditelescope.cpp.

◆ ExecuteHomeAction()

IPState Telescope::ExecuteHomeAction ( TelescopeHomeAction action )

protectedvirtual

Execute a homing action.

Parameters

action Depending on the telescope supported homing capabilities, this could be either FIND, SET, or GO.

Returns: State of executed action. IPS_OK if action is completed successfully, IPS_BUSY if in progress, IPS_ALERT if failed.

Reimplemented in IEQPro, IOptronV3, LX200_esp32go, LX200_OnStep, LX200_OpenAstroTech, LX200NYX101, LX200AM5, LX200ZEQ25, Paramount, Rainbow, ScopeSim, and ToupSH20.

Definition at line 1837 of file inditelescope.cpp.

◆ expectedPierSide()

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

protected

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

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

Definition at line 2773 of file inditelescope.cpp.

◆ Flip()

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

protectedvirtual

Move and flip the scope to the supplied RA and DEC coordinates.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200_10MICRON, and LX200Gemini.

Definition at line 1665 of file inditelescope.cpp.

◆ GetAxis1Park()

double Telescope::GetAxis1Park ( ) const

Returns: Get current RA/AZ parking position.

Definition at line 2364 of file inditelescope.cpp.

◆ GetAxis1ParkDefault()

double Telescope::GetAxis1ParkDefault ( ) const

Returns: Get default RA/AZ parking position.

Definition at line 2368 of file inditelescope.cpp.

◆ GetAxis2Park()

double Telescope::GetAxis2Park ( ) const

Returns: Get current DEC/ALT parking position.

Definition at line 2372 of file inditelescope.cpp.

◆ GetAxis2ParkDefault()

double Telescope::GetAxis2ParkDefault ( ) const

Returns: Get default DEC/ALT parking position.

Definition at line 2376 of file inditelescope.cpp.

◆ GetHomeDirectory()

std::string Telescope::GetHomeDirectory ( ) const

protected

Validate a file name.

Parameters

file_name File name

Returns: True if the file name is valid otherwise false.

Definition at line 2803 of file inditelescope.cpp.

◆ getPECState()

TelescopePECState INDI::Telescope::getPECState ( )

inline

Definition at line 477 of file inditelescope.h.

◆ getPierSide()

TelescopePierSide INDI::Telescope::getPierSide ( )

inline

Definition at line 471 of file inditelescope.h.

◆ GetScopeConfigIndex()

int INDI::Telescope::GetScopeConfigIndex ( ) const

protected

Get the scope config index.

Returns: The scope config index

◆ GetTelescopeCapability()

uint32_t INDI::Telescope::GetTelescopeCapability ( ) const

inline

GetTelescopeCapability returns the capability of the Telescope.

Definition at line 206 of file inditelescope.h.

◆ getTelescopeConnection()

uint8_t Telescope::getTelescopeConnection ( ) const

Returns: Get current telescope connection mode

Definition at line 625 of file inditelescope.cpp.

◆ Goto()

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

protectedvirtual

Move the scope to the supplied RA and DEC coordinates.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200FS2, MountDriver, IOptronV3, AstroTrac, CelestronGPS, TitanTCS, alpacaTelescopeDriver, LX200_OnStep, LX200Gemini, LX200SS2000PC, LX200Telescope, MXHDTelescope, PlaneWave, Rainbow, SkywatcherAPIMount, TemmaMount, ToupSH20, ScopeSim, SkywatcherAltAzSimple, Scope, EQ500X, IEQPro, IEQProLegacy, ioptronHC8406, LX200_TeenAstro, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Basic, LX200GotoNova, LX200Pulsar2, LX200ZEQ25, Paramount, PMC8, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, SimpleScope, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and LX200AstroPhysics.

Definition at line 1674 of file inditelescope.cpp.

◆ Handshake()

bool Telescope::Handshake ( )

virtual

perform handshake with device to check communication

Reimplemented in SkyCommander, MountDriver, AstroTrac, CelestronGPS, TitanTCS, DSC, IEQPro, IEQProLegacy, alpacaTelescopeDriver, IOptronV3, LX200_10MICRON, LX200_OnStep, LX200_OpenAstroTech, LX200_TeenAstro, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Basic, LX200Pulsar2, LX200Telescope, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, ScopeScript, TemmaMount, SimpleScope, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, SkywatcherAltAzSimple, and Scope.

Definition at line 1640 of file inditelescope.cpp.

◆ HasLocation()

bool INDI::Telescope::HasLocation ( )

inline

Returns: True if telescope location can be updated.

Definition at line 280 of file inditelescope.h.

◆ HasPECState()

bool INDI::Telescope::HasPECState ( )

inline

Returns: True if telescope supports PEC playback property

Definition at line 310 of file inditelescope.h.

◆ HasPierSide()

bool INDI::Telescope::HasPierSide ( )

inline

Returns: True if telescope supports pier side property

Definition at line 288 of file inditelescope.h.

◆ HasPierSideSimulation()

bool INDI::Telescope::HasPierSideSimulation ( )

inline

Returns: True if telescope simulates pier side property

Definition at line 296 of file inditelescope.h.

◆ HasTime()

bool INDI::Telescope::HasTime ( )

inline

Returns: True if telescope time can be updated.

Definition at line 272 of file inditelescope.h.

◆ HasTrackMode()

bool INDI::Telescope::HasTrackMode ( )

inline

Returns: True if telescope supports track modes

Definition at line 318 of file inditelescope.h.

◆ HasTrackRate()

bool INDI::Telescope::HasTrackRate ( )

inline

Returns: True if telescope supports custom tracking rates.

Definition at line 326 of file inditelescope.h.

◆ InitPark()

bool Telescope::InitPark ( )

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

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

Definition at line 2042 of file inditelescope.cpp.

◆ initProperties()

bool Telescope::initProperties ( )

overridevirtual

Called to initialize basic properties required all the time.

Reimplemented from INDI::DefaultDevice.

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

Examples: simplescope.cpp.

Definition at line 65 of file inditelescope.cpp.

◆ ISGetProperties()

void Telescope::ISGetProperties ( const char * dev )

overridevirtual

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

Parameters

dev	name of the device

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

Reimplemented from INDI::DefaultDevice.

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

Definition at line 311 of file inditelescope.cpp.

◆ isLocked()

bool Telescope::isLocked ( ) const

isLocked is mount currently locked?

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

Definition at line 2409 of file inditelescope.cpp.

◆ ISNewNumber()

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

overridevirtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

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

Definition at line 795 of file inditelescope.cpp.

◆ ISNewSwitch()

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

overridevirtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

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

Definition at line 1000 of file inditelescope.cpp.

◆ ISNewText()

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

overridevirtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

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

Definition at line 756 of file inditelescope.cpp.

◆ isParked()

bool Telescope::isParked ( )

isParked is mount currently parked?

Returns: True if parked, false otherwise.

Definition at line 2037 of file inditelescope.cpp.

◆ ISSnoopDevice()

bool Telescope::ISSnoopDevice ( XMLEle * root )

overridevirtual

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

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in ScopeSim, and Scope.

Definition at line 520 of file inditelescope.cpp.

◆ joystickHelper()

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

static

Definition at line 2734 of file inditelescope.cpp.

◆ LoadParkData()

const char * Telescope::LoadParkData ( )

protected

Definition at line 2165 of file inditelescope.cpp.

◆ MoveNS()

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

protectedvirtual

Start or Stop the telescope motion in the direction dir.

Parameters

dir	direction of motion
command	Start or Stop command

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, IOptronV3, LX200_OnStep, LX200_TeenAstro, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Pulsar2, LX200Telescope, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, TemmaMount, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, SkywatcherAltAzSimple, and EQ500X.

Definition at line 731 of file inditelescope.cpp.

◆ MoveWE()

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

protectedvirtual

Move the telescope in the direction dir.

Parameters

dir	direction of motion
command	Start or Stop command

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, IOptronV3, LX200_OnStep, LX200_TeenAstro, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Pulsar2, LX200Telescope, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, TemmaMount, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and SkywatcherAltAzSimple.

Definition at line 742 of file inditelescope.cpp.

◆ NewRaDec()

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

protected

The child class calls this function when it has updates.

Examples: simplescope.cpp.

Definition at line 675 of file inditelescope.cpp.

◆ Park()

bool Telescope::Park ( )

protectedvirtual

Park the telescope to its home position.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200_10MICRON, LX200_esp32go, LX200_OnStep, LX200NYX101, LX200_TeenAstro, LX200AM5, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Classic, LX200FS2, LX200Gemini, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, LX200Telescope, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, TemmaMount, ToupSH20, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, and SkywatcherAltAzSimple.

Definition at line 1689 of file inditelescope.cpp.

◆ processAxis()

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

protected

Definition at line 2485 of file inditelescope.cpp.

◆ processButton()

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

protected

Definition at line 2420 of file inditelescope.cpp.

◆ processJoystick()

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

protected

Definition at line 2469 of file inditelescope.cpp.

◆ processNSWE()

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

protected

Definition at line 2550 of file inditelescope.cpp.

◆ processSlewPresets()

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

protected

Definition at line 2686 of file inditelescope.cpp.

◆ PurgeParkData()

bool Telescope::PurgeParkData ( )

protected

Definition at line 2205 of file inditelescope.cpp.

◆ ReadScopeStatus()

virtual bool INDI::Telescope::ReadScopeStatus ( )

protectedpure virtual

Read telescope status.

This function checks the following:

Check if the link to the telescope is alive.
Update telescope status: Idle, Slewing, Parking..etc.
Read coordinates

Returns: True if reading scope status is OK, false if an error is encountered.

Note: This function is not implemented in Telescope, it must be implemented in the child class

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

◆ saveConfigItems()

bool Telescope::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

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

Parameters

fp	Pointer to config file handler

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

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

Definition at line 643 of file inditelescope.cpp.

◆ SetAxis1Park()

void Telescope::SetAxis1Park ( double value )

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

Parameters

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

Definition at line 2381 of file inditelescope.cpp.

◆ SetAxis1ParkDefault()

void Telescope::SetAxis1ParkDefault ( double steps )

SetRAPark Set default RA/AZ parking position.

Parameters

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

Definition at line 2389 of file inditelescope.cpp.

◆ SetAxis2Park()

void Telescope::SetAxis2Park ( double steps )

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

Parameters

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

Definition at line 2395 of file inditelescope.cpp.

◆ SetAxis2ParkDefault()

void Telescope::SetAxis2ParkDefault ( double steps )

SetDEParkDefault Set default DEC/ALT parking position.

Parameters

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

Definition at line 2403 of file inditelescope.cpp.

◆ SetCurrentPark()

bool Telescope::SetCurrentPark ( )

protectedvirtual

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

Returns: True if current mount coordinates are set as parking position, false on error.

Note: If not implemented by the child class, this function by default returns false with a warning message.

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

Definition at line 1731 of file inditelescope.cpp.

◆ SetDefaultPark()

bool Telescope::SetDefaultPark ( )

protectedvirtual

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

Returns: True if default park coordinates are set as parking position, false on error.

Note: If not implemented by the child class, this function by default returns false with a warning message.

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

Definition at line 1737 of file inditelescope.cpp.

◆ SetParkDataType()

void Telescope::SetParkDataType ( TelescopeParkData type )

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

Parameters

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

Definition at line 1966 of file inditelescope.cpp.

◆ SetParked()

void Telescope::SetParked ( bool isparked )

virtual

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

Parameters

isparked set to true if parked, false otherwise.

Reimplemented in LX200_OnStep.

Definition at line 2029 of file inditelescope.cpp.

◆ SetParkPosition()

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

protectedvirtual

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

Parameters

Axis1Value	First axis value
Axis2Value	Second axis value

Returns: True if desired parking position is accepted and set. False otherwise.

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in TitanTCS, and Paramount.

Definition at line 1860 of file inditelescope.cpp.

◆ setPECState()

void Telescope::setPECState ( TelescopePECState state )

Definition at line 2787 of file inditelescope.cpp.

◆ setPierSide()

void Telescope::setPierSide ( TelescopePierSide side )

Definition at line 2749 of file inditelescope.cpp.

◆ SetSlewRate()

bool Telescope::SetSlewRate ( int index )

protectedvirtual

SetSlewRate Set desired slew rate index.

Parameters

index Index of slew rate where 0 is slowest rate and capability.nSlewRate-1 is maximum rate.

Returns: True is operation successful, false otherwise.

Note: This function as implemented in Telescope performs no function and always return true. Only reimplement it if you need to issue a command to change the slew rate at the hardware level. Most telescope drivers only utilize slew rate when issuing a motion command.

Reimplemented in TitanTCS, IEQPro, IEQProLegacy, IOptronV3, LX200NYX101, LX200AM5, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200GotoNova, LX200Pulsar2, LX200Telescope, LX200ZEQ25, MXHDTelescope, PMC8, Rainbow, SynscanDriver, SynscanLegacyDriver, ToupSH20, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and LX200AstroPhysics.

Definition at line 2414 of file inditelescope.cpp.

◆ SetTelescopeCapability()

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

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

Parameters

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

Examples: simplescope.cpp.

Definition at line 1898 of file inditelescope.cpp.

◆ setTelescopeConnection()

void Telescope::setTelescopeConnection ( const uint8_t & value )

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

Parameters

value ORed combination of TelescopeConnection values.

Definition at line 630 of file inditelescope.cpp.

◆ SetTrackEnabled()

bool Telescope::SetTrackEnabled ( bool enabled )

protectedvirtual

SetTrackEnabled Engages or disengages mount tracking. If there are no tracking modes available, it is assumed sidereal. Otherwise, whatever tracking mode should be activated or deactivated accordingly.

Parameters

enabled True to engage tracking, false to stop tracking completely.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200_10MICRON, LX200_esp32go, LX200_OnStep, LX200_OpenAstroTech, LX200NYX101, LX200_TeenAstro, LX200AM5, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Gemini, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, ScopeSim, TemmaMount, ToupSH20, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and LX200AstroPhysics.

Definition at line 1716 of file inditelescope.cpp.

◆ SetTrackMode()

bool Telescope::SetTrackMode ( uint8_t mode )

protectedvirtual

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

Parameters

mode	Index of track mode.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200_esp32go, LX200NYX101, LX200_TeenAstro, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Gemini, LX200GotoNova, LX200Telescope, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SynscanDriver, ScopeSim, TemmaMount, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and LX200AstroPhysics.

Definition at line 1701 of file inditelescope.cpp.

◆ SetTrackRate()

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

protectedvirtual

SetTrackRate Set custom tracking rates.

Parameters

raRate	RA tracking rate in arcsecs/s
deRate	DEC tracking rate in arcsecs/s

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, IEQPro, IEQProLegacy, alpacaTelescopeDriver, IOptronV3, LX200_OnStep, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, Paramount, PlaneWave, PMC8, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and LX200AstroPhysics.

Definition at line 1708 of file inditelescope.cpp.

◆ Sync()

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

protectedvirtual

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

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200FS2, MountDriver, IOptronV3, AstroTrac, CelestronGPS, TitanTCS, DSC, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, LX200_OnStep, LX200_TeenAstro, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Basic, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, LX200Telescope, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, TemmaMount, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, SkywatcherAltAzSimple, Scope, EQ500X, and LX200ZEQ25.

Definition at line 722 of file inditelescope.cpp.

◆ SyncParkStatus()

void Telescope::SyncParkStatus ( bool isparked )

protectedvirtual

SyncParkStatus Update the state and switches for parking.

Parameters

isparked True if parked, false otherwise.

Reimplemented in LX200_OnStep.

Definition at line 2007 of file inditelescope.cpp.

◆ TimerHit()

void Telescope::TimerHit ( )

overridevirtual

Called when setTimer() time is up.

Reimplemented from INDI::DefaultDevice.

Reimplemented in MXHDTelescope, SkywatcherAPIMount, ScopeSim, and SkywatcherAltAzSimple.

Definition at line 1646 of file inditelescope.cpp.

◆ UnPark()

bool Telescope::UnPark ( )

protectedvirtual

Unpark the telescope if already parked.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200GPS, MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200_10MICRON, LX200_esp32go, LX200_OnStep, LX200NYX101, LX200_TeenAstro, LX200AM5, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Classic, LX200FS2, LX200Gemini, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeScript, ScopeSim, TemmaMount, ToupSH20, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, and SkywatcherAltAzSimple.

Definition at line 1695 of file inditelescope.cpp.

◆ updateLocation()

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

protectedvirtual

Update telescope location settings.

Parameters

latitude	Site latitude in degrees.
longitude	Site latitude in degrees increasing eastward from Greenwich (0 to 360).
elevation	Site elevation in meters.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in MountDriver, AstroTrac, CelestronGPS, TitanTCS, DSC, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200_OnStep, LX200NYX101, LX200_TeenAstro, LX200AM5, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200FS2, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, LX200Telescope, LX200ZEQ25, MXHDTelescope, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeSim, TemmaMount, ToupSH20, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, Scope, and EQ500X.

Definition at line 1829 of file inditelescope.cpp.

◆ updateObserverLocation()

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

protected

Update location settings of the observer.

Parameters

latitude	Site latitude in degrees.
longitude	Site latitude in degrees increasing eastward from Greenwich (0 to 360).
elevation	Site elevation in meters.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Definition at line 1843 of file inditelescope.cpp.

◆ updateProperties()

bool Telescope::updateProperties ( )

overridevirtual

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

Reimplemented from INDI::DefaultDevice.

Reimplemented in LX200_16, LX200GPS, MountDriver, AstroTrac, CelestronGPS, TitanTCS, DSC, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200_10MICRON, LX200_esp32go, LX200_OnStep, LX200_OpenAstroTech, LX200NYX101, LX200_Proxisky, LX200_TeenAstro, LX200AM5, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200Autostar, LX200Basic, LX200Classic, LX200FS2, LX200Gemini, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, LX200Telescope, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, SynscanLegacyDriver, ScopeSim, TemmaMount, ToupSH20, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, LX200AstroPhysics, and SkywatcherAltAzSimple.

Definition at line 332 of file inditelescope.cpp.

◆ updateTime()

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

protectedvirtual

Update telescope time, date, and UTC offset.

Parameters

utc	UTC time.
utc_offset	UTC offset in hours.

Returns: True if successful, false otherwise

Note: If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented in LX200GPS, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, alpacaTelescopeDriver, ioptronHC8406, IOptronV3, LX200AstroPhysicsGTOCP2, LX200AstroPhysicsV2, LX200GotoNova, LX200Pulsar2, LX200SS2000PC, LX200Telescope, LX200ZEQ25, MXHDTelescope, Paramount, PlaneWave, PMC8, SynscanDriver, SynscanLegacyDriver, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, and LX200AstroPhysics.

Definition at line 1822 of file inditelescope.cpp.

◆ WriteParkData()

bool Telescope::WriteParkData ( )

protected

Definition at line 2301 of file inditelescope.cpp.

Member Data Documentation

◆ capability

uint32_t INDI::Telescope::capability {0}

protected

Definition at line 950 of file inditelescope.h.

◆ currentPECState

TelescopePECState INDI::Telescope::currentPECState {PEC_UNKNOWN}

protected

Definition at line 948 of file inditelescope.h.

◆ IsParked

bool INDI::Telescope::IsParked {false}

protected

Definition at line 962 of file inditelescope.h.

◆ last_ns_motion

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

protected

Definition at line 951 of file inditelescope.h.

◆ last_we_motion

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

protected

Definition at line 951 of file inditelescope.h.

◆ lastPECState

TelescopePECState INDI::Telescope::lastPECState {PEC_UNKNOWN}

protected

Definition at line 948 of file inditelescope.h.

◆ m_Location

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

protected

Definition at line 716 of file inditelescope.h.

◆ parkDataType

TelescopeParkData INDI::Telescope::parkDataType {PARK_NONE}

protected

Definition at line 963 of file inditelescope.h.

◆ PortFD

int INDI::Telescope::PortFD = -1

protected

Definition at line 958 of file inditelescope.h.

◆ RememberTrackState

TelescopeStatus INDI::Telescope::RememberTrackState {SCOPE_IDLE}

protected

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

Definition at line 749 of file inditelescope.h.

◆ serialConnection

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

protected

Definition at line 959 of file inditelescope.h.

◆ tcpConnection

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

protected

Definition at line 960 of file inditelescope.h.

◆ []

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

◆ []

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

◆ TrackState

TelescopeStatus INDI::Telescope::TrackState {SCOPE_IDLE}

protected

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

Examples: simplescope.cpp.

Definition at line 744 of file inditelescope.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ DomeLockingPolicy

◆ TelescopeHomeAction

◆ TelescopeLocation

◆ TelescopeMotionCommand

◆ TelescopeParkData

◆ TelescopePECState

◆ TelescopePierSide

◆ TelescopeSlewRate

◆ TelescopeStatus

◆ TelescopeTrackMode

◆ TelescopeTrackState

Constructor & Destructor Documentation

◆ Telescope()

◆ ~Telescope()

Member Function Documentation

◆ Abort()

◆ AddTrackMode()

◆ axisHelper()

◆ buttonHelper()

◆ callHandshake()

◆ CanAbort()

◆ CanControlTrack()

◆ CanFlip()

◆ CanGOTO()

◆ CanHomeFind()

◆ CanHomeGo()

◆ CanHomeSet()

◆ CanPark()

◆ CanSync()

◆ CanTrackSatellite()

◆ CheckFile()

◆ ExecuteHomeAction()

◆ expectedPierSide()

◆ Flip()

◆ GetAxis1Park()

◆ GetAxis1ParkDefault()

◆ GetAxis2Park()

◆ GetAxis2ParkDefault()

◆ GetHomeDirectory()

◆ getPECState()

◆ getPierSide()

◆ GetScopeConfigIndex()

◆ GetTelescopeCapability()

◆ getTelescopeConnection()

◆ Goto()

◆ Handshake()

◆ HasLocation()

◆ HasPECState()

◆ HasPierSide()

◆ HasPierSideSimulation()

◆ HasTime()

◆ HasTrackMode()

◆ HasTrackRate()

◆ InitPark()

◆ initProperties()

◆ ISGetProperties()

◆ isLocked()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISNewText()

◆ isParked()

◆ ISSnoopDevice()

◆ joystickHelper()

◆ LoadParkData()

◆ MoveNS()

◆ MoveWE()

◆ NewRaDec()

◆ Park()

◆ processAxis()