INDI::Telescope Class Reference

#include <inditelescope.h>

Inheritance diagram for INDI::Telescope:

Collaboration diagram for INDI::Telescope:

Public Types
enum	TelescopeStatus {   SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING, SCOPE_PARKING,   SCOPE_PARKED, SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING,   SCOPE_PARKING, SCOPE_PARKED }
enum	TelescopeMotionCommand { MOTION_START = 0, MOTION_STOP, MOTION_START = 0, MOTION_STOP }
enum	TelescopeSlewRate {   SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX,   SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX }
enum	TelescopeTrackMode {   TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM,   TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM }
enum	TelescopeTrackState {   TRACK_ON, TRACK_OFF, TRACK_UNKNOWN, 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_NONE, PARK_RA_DEC,   PARK_HA_DEC, PARK_AZ_ALT, PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER }
enum	TelescopeLocation {   LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION, LOCATION_LATITUDE,   LOCATION_LONGITUDE, LOCATION_ELEVATION }
enum	TelescopePierSide {   PIER_UNKNOWN = -1, PIER_WEST = 0, PIER_EAST = 1, PIER_UNKNOWN = -1,   PIER_WEST = 0, PIER_EAST = 1 }
enum	TelescopePECState {   PEC_UNKNOWN = -1, PEC_OFF = 0, PEC_ON = 1, PEC_UNKNOWN = -1,   PEC_OFF = 0, PEC_ON = 1 }
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 }
enum	TelescopeStatus {   SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING, SCOPE_PARKING,   SCOPE_PARKED, SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING,   SCOPE_PARKING, SCOPE_PARKED }
enum	TelescopeMotionCommand { MOTION_START = 0, MOTION_STOP, MOTION_START = 0, MOTION_STOP }
enum	TelescopeSlewRate {   SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX,   SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX }
enum	TelescopeTrackMode {   TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM,   TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM }
enum	TelescopeTrackState {   TRACK_ON, TRACK_OFF, TRACK_UNKNOWN, 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_NONE, PARK_RA_DEC,   PARK_HA_DEC, PARK_AZ_ALT, PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER }
enum	TelescopeLocation {   LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION, LOCATION_LATITUDE,   LOCATION_LONGITUDE, LOCATION_ELEVATION }
enum	TelescopePierSide {   PIER_UNKNOWN = -1, PIER_WEST = 0, PIER_EAST = 1, PIER_UNKNOWN = -1,   PIER_WEST = 0, PIER_EAST = 1 }
enum	TelescopePECState {   PEC_UNKNOWN = -1, PEC_OFF = 0, PEC_ON = 1, PEC_UNKNOWN = -1,   PEC_OFF = 0, PEC_ON = 1 }
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 }
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,   INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }
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), AUX_INTERFACE = (1 << 15),   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), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
enum	INDI_ERROR {   INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,   INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }
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), AUX_INTERFACE = (1 << 15),   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), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

Public Member Functions
	Telescope ()
virtual	~Telescope ()
virtual bool	ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
	Process the client newNumber command. More...
virtual bool	ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
	Process the client newSwitch command. More...
virtual bool	ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
	Process the client newSwitch command. More...
virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...
virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. 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. 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	initProperties ()
	Called to initialize basic properties required all the time. More...
virtual bool	updateProperties ()
	Called when connected state changes, to add/remove properties. More...
virtual bool	Handshake ()
	perform handshake with device to check communication More...
virtual void	TimerHit ()
	Called when setTimer() time is up. More...
void	SetParkDataType (TelescopeParkData type)
	setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More...
bool	InitPark ()
	InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. More...
bool	isParked ()
	isParked is mount currently parked? More...
void	SetParked (bool isparked)
	SetParked Change the mount parking status. More...
double	GetAxis1Park () const
double	GetAxis1ParkDefault () const
double	GetAxis2Park () const
double	GetAxis2ParkDefault () const
void	SetAxis1Park (double value)
	SetRAPark Set current RA/AZ parking position. More...
void	SetAxis1ParkDefault (double steps)
	SetRAPark Set default RA/AZ parking position. More...
void	SetAxis2Park (double steps)
	SetDEPark Set current DEC/ALT parking position. More...
void	SetAxis2ParkDefault (double steps)
	SetDEParkDefault Set default DEC/ALT parking position. More...
bool	isLocked () const
	isLocked is mount currently locked? More...
void	setTelescopeConnection (const uint8_t &value)
	setTelescopeConnection Set telescope connection mode. More...
uint8_t	getTelescopeConnection () const
void	setPierSide (TelescopePierSide side)
TelescopePierSide	getPierSide ()
void	setPECState (TelescopePECState state)
TelescopePECState	getPECState ()
	Telescope ()
virtual	~Telescope ()
virtual bool	ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
	Process the client newNumber command. More...
virtual bool	ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
	Process the client newSwitch command. More...
virtual bool	ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
	Process the client newSwitch command. More...
virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...
virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. 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. 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	initProperties ()
	Called to initialize basic properties required all the time. More...
virtual bool	updateProperties ()
	Called when connected state changes, to add/remove properties. More...
virtual bool	Handshake ()
	perform handshake with device to check communication More...
virtual void	TimerHit ()
	Called when setTimer() time is up. More...
void	SetParkDataType (TelescopeParkData type)
	setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More...
bool	InitPark ()
	InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. More...
bool	isParked ()
	isParked is mount currently parked? More...
void	SetParked (bool isparked)
	SetParked Change the mount parking status. More...
double	GetAxis1Park () const
double	GetAxis1ParkDefault () const
double	GetAxis2Park () const
double	GetAxis2ParkDefault () const
void	SetAxis1Park (double value)
	SetRAPark Set current RA/AZ parking position. More...
void	SetAxis1ParkDefault (double steps)
	SetRAPark Set default RA/AZ parking position. More...
void	SetAxis2Park (double steps)
	SetDEPark Set current DEC/ALT parking position. More...
void	SetAxis2ParkDefault (double steps)
	SetDEParkDefault Set default DEC/ALT parking position. More...
bool	isLocked () const
	isLocked is mount currently locked? More...
void	setTelescopeConnection (const uint8_t &value)
	setTelescopeConnection Set telescope connection mode. 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	addPollPeriodControl ()
	Add Polling period control to the driver. More...
void	resetProperties ()
	Set all properties to IDLE state. More...
void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...
void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...
void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...
void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...
void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...
virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...
virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...
int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...
void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...
virtual const char *	getDriverExec ()
virtual const char *	getDriverName ()
void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
uint16_t	getMajorVersion ()
uint16_t	getMinorVersion ()
virtual bool	ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
	Process the client newBLOB command. More...
virtual uint16_t	getDriverInterface ()
void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...
	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	addPollPeriodControl ()
	Add Polling period control to the driver. More...
void	resetProperties ()
	Set all properties to IDLE state. More...
void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...
void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...
void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...
void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...
void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...
virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...
virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...
int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...
void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...
virtual const char *	getDriverExec ()
virtual const char *	getDriverName ()
void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
uint16_t	getMajorVersion ()
uint16_t	getMinorVersion ()
virtual bool	ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
	Process the client newBLOB command. More...
virtual uint16_t	getDriverInterface ()
void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...
Public Member Functions inherited from INDI::BaseDevice
	BaseDevice ()
virtual	~BaseDevice ()
INumberVectorProperty *	getNumber (const char *name)
ITextVectorProperty *	getText (const char *name)
ISwitchVectorProperty *	getSwitch (const char *name)
ILightVectorProperty *	getLight (const char *name)
IBLOBVectorProperty *	getBLOB (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::Property *	getProperty (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::BaseMediator *	getMediator ()
const char *	getDriverName ()
const char *	getDriverExec ()
const char *	getDriverVersion ()
	BaseDevice ()
virtual	~BaseDevice ()
INumberVectorProperty *	getNumber (const char *name)
ITextVectorProperty *	getText (const char *name)
ISwitchVectorProperty *	getSwitch (const char *name)
ILightVectorProperty *	getLight (const char *name)
IBLOBVectorProperty *	getBLOB (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::Property *	getProperty (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::BaseMediator *	getMediator ()
const char *	getDriverName ()
const char *	getDriverExec ()
const char *	getDriverVersion ()

Static Public Member Functions
static void	joystickHelper (const char *joystick_n, double mag, double angle, void *context)
static void	buttonHelper (const char *button_n, ISState state, void *context)
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
enum INDI::Telescope:: { ... }	TelescopeConnection
enum INDI::Telescope:: { ... }	TelescopeCapability
enum INDI::Telescope:: { ... }	TelescopeConnection
enum INDI::Telescope:: { ... }	TelescopeCapability

Protected Types
enum	{   SCOPE_CONFIG1, SCOPE_CONFIG2, SCOPE_CONFIG3, SCOPE_CONFIG4,   SCOPE_CONFIG5, SCOPE_CONFIG6 }
enum	{   SCOPE_CONFIG1, SCOPE_CONFIG2, SCOPE_CONFIG3, SCOPE_CONFIG4,   SCOPE_CONFIG5, SCOPE_CONFIG6 }

Protected Member Functions
virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save specific properties in the provide config file handler. More...
void	NewRaDec (double ra, double dec)
	The child class calls this function when it has updates. More...
virtual bool	ReadScopeStatus ()=0
	Read telescope status. More...
virtual bool	Goto (double ra, double dec)
	Move the scope to the supplied RA and DEC coordinates. More...
virtual bool	Sync (double ra, double dec)
	Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates. More...
virtual bool	MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command)
	Start or Stop the telescope motion in the direction dir. More...
virtual bool	MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command)
	Move the telescope in the direction dir. More...
virtual bool	Park ()
	Park the telescope to its home position. More...
virtual bool	UnPark ()
	Unpark the telescope if already parked. More...
virtual bool	Abort ()
	Abort any telescope motion including tracking if possible. More...
virtual bool	SetTrackMode (uint8_t mode)
	SetTrackMode Set active tracking mode. More...
virtual bool	SetTrackRate (double raRate, double deRate)
	SetTrackRate Set custom tracking rates. More...
virtual int	AddTrackMode (const char *name, const char *label, bool isDefault=false)
	AddTrackMode. More...
virtual bool	SetTrackEnabled (bool enabled)
	SetTrackEnabled Engages or disengages mount tracking. More...
virtual bool	updateTime (ln_date *utc, double utc_offset)
	Update telescope time, date, and UTC offset. More...
virtual bool	updateLocation (double latitude, double longitude, double elevation)
	Update telescope location settings. More...
virtual bool	SetParkPosition (double Axis1Value, double Axis2Value)
	SetParkPosition Set desired parking position to the supplied value. More...
virtual bool	SetCurrentPark ()
	SetCurrentPark Set current coordinates/encoders value as the desired parking position. More...
virtual bool	SetDefaultPark ()
	SetDefaultPark Set default coordinates/encoders value as the desired parking position. More...
virtual 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...
void	sendTimeFromSystem ()
char *	LoadParkData ()
bool	WriteParkData ()
virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save specific properties in the provide config file handler. More...
void	NewRaDec (double ra, double dec)
	The child class calls this function when it has updates. More...
virtual bool	ReadScopeStatus ()=0
	Read telescope status. More...
virtual bool	Goto (double ra, double dec)
	Move the scope to the supplied RA and DEC coordinates. More...
virtual bool	Sync (double ra, double dec)
	Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates. More...
virtual bool	MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command)
	Start or Stop the telescope motion in the direction dir. More...
virtual bool	MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command)
	Move the telescope in the direction dir. More...
virtual bool	Park ()
	Park the telescope to its home position. More...
virtual bool	UnPark ()
	Unpark the telescope if already parked. More...
virtual bool	Abort ()
	Abort any telescope motion including tracking if possible. More...
virtual bool	SetTrackMode (uint8_t mode)
	SetTrackMode Set active tracking mode. More...
virtual bool	SetTrackRate (double raRate, double deRate)
	SetTrackRate Set custom tracking rates. More...
virtual int	AddTrackMode (const char *name, const char *label, bool isDefault=false)
	AddTrackMode. More...
virtual bool	SetTrackEnabled (bool enabled)
	SetTrackEnabled Engages or disengages mount tracking. More...
virtual bool	updateTime (ln_date *utc, double utc_offset)
	Update telescope time, date, and UTC offset. More...
virtual bool	updateLocation (double latitude, double longitude, double elevation)
	Update telescope location settings. More...
virtual bool	SetParkPosition (double Axis1Value, double Axis2Value)
	SetParkPosition Set desired parking position to the supplied value. More...
virtual bool	SetCurrentPark ()
	SetCurrentPark Set current coordinates/encoders value as the desired parking position. More...
virtual bool	SetDefaultPark ()
	SetDefaultPark Set default coordinates/encoders value as the desired parking position. More...
virtual 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...
void	sendTimeFromSystem ()
char *	LoadParkData ()
bool	WriteParkData ()
Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. 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. More...
virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...
bool	isDebug ()
bool	isSimulation ()
virtual bool	Connect ()
	Connect to the device. More...
virtual bool	Disconnect ()
	Disconnect from device. More...
void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...
bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...
Connection::Interface *	getActiveConnection ()
void	setDefaultPollingPeriod (uint32_t period)
uint32_t	getPollingPeriod ()
virtual const char *	getDefaultName ()=0
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. 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. More...
virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...
bool	isDebug ()
bool	isSimulation ()
virtual bool	Connect ()
	Connect to the device. More...
virtual bool	Disconnect ()
	Disconnect from device. More...
void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...
bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...
Connection::Interface *	getActiveConnection ()
void	setDefaultPollingPeriod (uint32_t period)
uint32_t	getPollingPeriod ()
virtual const char *	getDefaultName ()=0
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...
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 Attributes
TelescopeStatus	TrackState
	This is a variable filled in by the ReadStatus telescope low level code, used to report current state are we slewing, tracking, or parked. More...
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
ISwitch *	SlewRateS
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
ISwitch *	TrackModeS { 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::Serial *	serialConnection = NULL
Connection::TCP *	tcpConnection = 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	POLLMS = 1000
	Period in milliseconds to call TimerHit(). Default 1000 ms. More...

Private Member Functions
bool	processTimeInfo (const char *utc, const char *offset)
bool	processLocationInfo (double latitude, double longitude, double elevation)
void	triggerSnoop (const char *driverName, const char *propertyName)
bool	processTimeInfo (const char *utc, const char *offset)
bool	processLocationInfo (double latitude, double longitude, double elevation)
void	triggerSnoop (const char *driverName, const char *propertyName)

Private Attributes
TelescopeParkData	parkDataType
bool	IsLocked
bool	IsParked
const char *	ParkDeviceName
const std::string	ParkDataFileName
XMLEle *	ParkdataXmlRoot
XMLEle *	ParkdeviceXml
XMLEle *	ParkstatusXml
XMLEle *	ParkpositionXml
XMLEle *	ParkpositionAxis1Xml
XMLEle *	ParkpositionAxis2Xml
double	Axis1ParkPosition
double	Axis1DefaultParkPosition
double	Axis2ParkPosition
double	Axis2DefaultParkPosition
uint8_t	nSlewRate
IPState	lastEqState
uint8_t	telescopeConnection = CONNECTION_SERIAL | CONNECTION_TCP
Controller *	controller

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.

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?

anonymous enum

anonymous enum

protected

Enumerator
SCOPE_CONFIG1
SCOPE_CONFIG2
SCOPE_CONFIG3
SCOPE_CONFIG4
SCOPE_CONFIG5
SCOPE_CONFIG6

anonymous enum

anonymous enum

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

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?

anonymous enum

anonymous enum

protected

Enumerator
SCOPE_CONFIG1
SCOPE_CONFIG2
SCOPE_CONFIG3
SCOPE_CONFIG4
SCOPE_CONFIG5
SCOPE_CONFIG6

TelescopeLocation [1/2]

enum INDI::Telescope::TelescopeLocation

Enumerator
LOCATION_LATITUDE
LOCATION_LONGITUDE
LOCATION_ELEVATION
LOCATION_LATITUDE
LOCATION_LONGITUDE
LOCATION_ELEVATION

TelescopeLocation [2/2]

enum INDI::Telescope::TelescopeLocation

Enumerator
LOCATION_LATITUDE
LOCATION_LONGITUDE
LOCATION_ELEVATION
LOCATION_LATITUDE
LOCATION_LONGITUDE
LOCATION_ELEVATION

TelescopeMotionCommand [1/2]

enum INDI::Telescope::TelescopeMotionCommand

Enumerator
MOTION_START
MOTION_STOP
MOTION_START
MOTION_STOP

TelescopeMotionCommand [2/2]

enum INDI::Telescope::TelescopeMotionCommand

Enumerator
MOTION_START
MOTION_STOP
MOTION_START
MOTION_STOP

TelescopeParkData [1/2]

enum INDI::Telescope::TelescopeParkData

Enumerator
PARK_NONE
PARK_RA_DEC
PARK_HA_DEC
PARK_AZ_ALT
PARK_RA_DEC_ENCODER
PARK_AZ_ALT_ENCODER
PARK_NONE
PARK_RA_DEC
PARK_HA_DEC
PARK_AZ_ALT
PARK_RA_DEC_ENCODER
PARK_AZ_ALT_ENCODER

TelescopeParkData [2/2]

enum INDI::Telescope::TelescopeParkData

Enumerator
PARK_NONE
PARK_RA_DEC
PARK_HA_DEC
PARK_AZ_ALT
PARK_RA_DEC_ENCODER
PARK_AZ_ALT_ENCODER
PARK_NONE
PARK_RA_DEC
PARK_HA_DEC
PARK_AZ_ALT
PARK_RA_DEC_ENCODER
PARK_AZ_ALT_ENCODER

TelescopePECState [1/2]

enum INDI::Telescope::TelescopePECState

Enumerator
PEC_UNKNOWN
PEC_OFF
PEC_ON
PEC_UNKNOWN
PEC_OFF
PEC_ON

TelescopePECState [2/2]

enum INDI::Telescope::TelescopePECState

Enumerator
PEC_UNKNOWN
PEC_OFF
PEC_ON
PEC_UNKNOWN
PEC_OFF
PEC_ON

TelescopePierSide [1/2]

enum INDI::Telescope::TelescopePierSide

Enumerator
PIER_UNKNOWN
PIER_WEST
PIER_EAST
PIER_UNKNOWN
PIER_WEST
PIER_EAST

TelescopePierSide [2/2]

enum INDI::Telescope::TelescopePierSide

Enumerator
PIER_UNKNOWN
PIER_WEST
PIER_EAST
PIER_UNKNOWN
PIER_WEST
PIER_EAST

TelescopeSlewRate [1/2]

enum INDI::Telescope::TelescopeSlewRate

Enumerator
SLEW_GUIDE
SLEW_CENTERING
SLEW_FIND
SLEW_MAX
SLEW_GUIDE
SLEW_CENTERING
SLEW_FIND
SLEW_MAX

TelescopeSlewRate [2/2]

enum INDI::Telescope::TelescopeSlewRate

Enumerator
SLEW_GUIDE
SLEW_CENTERING
SLEW_FIND
SLEW_MAX
SLEW_GUIDE
SLEW_CENTERING
SLEW_FIND
SLEW_MAX

TelescopeStatus [1/2]

enum INDI::Telescope::TelescopeStatus

Enumerator
SCOPE_IDLE
SCOPE_SLEWING
SCOPE_TRACKING
SCOPE_PARKING
SCOPE_PARKED
SCOPE_IDLE
SCOPE_SLEWING
SCOPE_TRACKING
SCOPE_PARKING
SCOPE_PARKED

TelescopeStatus [2/2]

enum INDI::Telescope::TelescopeStatus

Enumerator
SCOPE_IDLE
SCOPE_SLEWING
SCOPE_TRACKING
SCOPE_PARKING
SCOPE_PARKED
SCOPE_IDLE
SCOPE_SLEWING
SCOPE_TRACKING
SCOPE_PARKING
SCOPE_PARKED

TelescopeTrackMode [1/2]

enum INDI::Telescope::TelescopeTrackMode

Enumerator
TRACK_SIDEREAL
TRACK_SOLAR
TRACK_LUNAR
TRACK_CUSTOM
TRACK_SIDEREAL
TRACK_SOLAR
TRACK_LUNAR
TRACK_CUSTOM

TelescopeTrackMode [2/2]

enum INDI::Telescope::TelescopeTrackMode

Enumerator
TRACK_SIDEREAL
TRACK_SOLAR
TRACK_LUNAR
TRACK_CUSTOM
TRACK_SIDEREAL
TRACK_SOLAR
TRACK_LUNAR
TRACK_CUSTOM

TelescopeTrackState [1/2]

enum INDI::Telescope::TelescopeTrackState

Enumerator
TRACK_ON
TRACK_OFF
TRACK_UNKNOWN
TRACK_ON
TRACK_OFF
TRACK_UNKNOWN

TelescopeTrackState [2/2]

enum INDI::Telescope::TelescopeTrackState

Enumerator
TRACK_ON
TRACK_OFF
TRACK_UNKNOWN
TRACK_ON
TRACK_OFF
TRACK_UNKNOWN

Constructor & Destructor Documentation

Telescope() [1/2]

Telescope::Telescope

(

)

~Telescope() [1/2]

Telescope::~Telescope ( )

virtual

Telescope() [2/2]

INDI::Telescope::Telescope

(

)

~Telescope() [2/2]

virtual INDI::Telescope::~Telescope ( )

virtual

Member Function Documentation

Abort() [1/2]

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 EQMod, LX200Telescope, IOptronV3, PMC8, ScopeSim, IEQPro, CelestronGPS, TemmaMount, Paramount, LX200Pulsar2, SkywatcherAPIMount, SynscanMount, ScopeScript, LX200Basic, SkywatcherAltAzSimple, SimpleScope, NexStarEvo, and ScopeSim.

Abort() [2/2]

virtual bool INDI::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 EQMod, LX200Telescope, IOptronV3, PMC8, ScopeSim, IEQPro, CelestronGPS, TemmaMount, Paramount, LX200Pulsar2, SkywatcherAPIMount, SynscanMount, ScopeScript, LX200Basic, SkywatcherAltAzSimple, SimpleScope, NexStarEvo, and ScopeSim.

AddTrackMode() [1/2]

virtual int INDI::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

AddTrackMode() [2/2]

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

buttonHelper() [1/2]

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

static

buttonHelper() [2/2]

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

static

callHandshake() [1/2]

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

callHandshake() [2/2]

bool INDI::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()

CanAbort() [1/2]

bool INDI::Telescope::CanAbort ( )

inline

Returns

True if telescope can abort motion.

CanAbort() [2/2]

bool INDI::Telescope::CanAbort ( )

inline

Returns

True if telescope can abort motion.

CanControlTrack() [1/2]

bool INDI::Telescope::CanControlTrack ( )

inline

Returns

True if telescope can enagle and disengage tracking.

CanControlTrack() [2/2]

bool INDI::Telescope::CanControlTrack ( )

inline

Returns

True if telescope can enagle and disengage tracking.

CanGOTO() [1/2]

bool INDI::Telescope::CanGOTO ( )

inline

Returns

True if telescope support goto operations

CanGOTO() [2/2]

bool INDI::Telescope::CanGOTO ( )

inline

Returns

True if telescope support goto operations

CanPark() [1/2]

bool INDI::Telescope::CanPark ( )

inline

Returns

True if telescope can park.

CanPark() [2/2]

bool INDI::Telescope::CanPark ( )

inline

Returns

True if telescope can park.

CanSync() [1/2]

bool INDI::Telescope::CanSync ( )

inline

Returns

True if telescope support sync operations

CanSync() [2/2]

bool INDI::Telescope::CanSync ( )

inline

Returns

True if telescope support sync operations

CheckFile() [1/2]

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.

CheckFile() [2/2]

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

GetAxis1Park() [1/2]

double Telescope::GetAxis1Park

(

)

const

Returns

Get current RA/AZ parking position.

GetAxis1Park() [2/2]

double INDI::Telescope::GetAxis1Park

(

)

const

Returns

Get current RA/AZ parking position.

GetAxis1ParkDefault() [1/2]

double INDI::Telescope::GetAxis1ParkDefault

(

)

const

Returns

Get default RA/AZ parking position.

GetAxis1ParkDefault() [2/2]

double Telescope::GetAxis1ParkDefault

(

)

const

Returns

Get default RA/AZ parking position.

GetAxis2Park() [1/2]

double INDI::Telescope::GetAxis2Park

(

)

const

Returns

Get current DEC/ALT parking position.

GetAxis2Park() [2/2]

double Telescope::GetAxis2Park

(

)

const

Returns

Get current DEC/ALT parking position.

GetAxis2ParkDefault() [1/2]

double INDI::Telescope::GetAxis2ParkDefault

(

)

const

Returns

Get defailt DEC/ALT parking position.

GetAxis2ParkDefault() [2/2]

double Telescope::GetAxis2ParkDefault

(

)

const

Returns

Get defailt DEC/ALT parking position.

GetHomeDirectory() [1/2]

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.

GetHomeDirectory() [2/2]

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

protected

Validate a file name.

Parameters

file_name

File name

Returns

True if the file name is valid otherwise false.

getPECState() [1/2]

TelescopePECState INDI::Telescope::getPECState ( )

inline

getPECState() [2/2]

TelescopePECState INDI::Telescope::getPECState ( )

inline

getPierSide() [1/2]

TelescopePierSide INDI::Telescope::getPierSide ( )

inline

getPierSide() [2/2]

TelescopePierSide INDI::Telescope::getPierSide ( )

inline

GetScopeConfigIndex() [1/2]

int Telescope::GetScopeConfigIndex ( ) const

protected

Get the scope config index.

Returns

The scope config index

GetScopeConfigIndex() [2/2]

int INDI::Telescope::GetScopeConfigIndex ( ) const

protected

Get the scope config index.

Returns

The scope config index

GetTelescopeCapability() [1/2]

uint32_t INDI::Telescope::GetTelescopeCapability ( ) const

inline

GetTelescopeCapability returns the capability of the Telescope.

GetTelescopeCapability() [2/2]

uint32_t INDI::Telescope::GetTelescopeCapability ( ) const

inline

GetTelescopeCapability returns the capability of the Telescope.

getTelescopeConnection() [1/2]

uint8_t Telescope::getTelescopeConnection

(

)

const

Returns

Get current telescope connection mode

getTelescopeConnection() [2/2]

uint8_t INDI::Telescope::getTelescopeConnection

(

)

const

Returns

Get current telescope connection mode

Goto() [1/2]

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 EQMod, LX200Telescope, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsExperimental, IOptronV3, PMC8, IEQPro, LX200Pulsar2, LX200AstroPhysicsGTOCP2, Paramount, CelestronGPS, ioptronHC8406, LX200ZEQ25, SkywatcherAPIMount, LX200GotoNova, ScopeScript, SkywatcherAltAzSimple, TemmaMount, LX200Basic, SynscanMount, SimpleScope, NexStarEvo, and ScopeSim.

Goto() [2/2]

virtual bool INDI::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 EQMod, LX200Telescope, ScopeSim, LX200AstroPhysics, LX200AstroPhysicsExperimental, IOptronV3, PMC8, IEQPro, LX200Pulsar2, LX200AstroPhysicsGTOCP2, Paramount, CelestronGPS, ioptronHC8406, LX200ZEQ25, SkywatcherAPIMount, LX200GotoNova, ScopeScript, SkywatcherAltAzSimple, TemmaMount, LX200Basic, SynscanMount, SimpleScope, NexStarEvo, and ScopeSim.

Handshake() [1/2]

bool Telescope::Handshake ( )

virtual

perform handshake with device to check communication

Reimplemented in EQMod, LX200_10MICRON, LX200Telescope, LX200AstroPhysics, LX200AstroPhysicsExperimental, SkywatcherAPIMount, LX200AstroPhysicsGTOCP2, DSC, IOptronV3, PMC8, SkywatcherAltAzSimple, IEQPro, TemmaMount, CelestronGPS, ScopeScript, Paramount, LX200Pulsar2, SkyCommander, LX200Basic, SimpleScope, and NexStarEvo.

Handshake() [2/2]

virtual bool INDI::Telescope::Handshake ( )

virtual

perform handshake with device to check communication

Reimplemented in EQMod, LX200_10MICRON, LX200Telescope, LX200AstroPhysics, LX200AstroPhysicsExperimental, SkywatcherAPIMount, LX200AstroPhysicsGTOCP2, DSC, IOptronV3, PMC8, SkywatcherAltAzSimple, IEQPro, TemmaMount, CelestronGPS, ScopeScript, Paramount, LX200Pulsar2, SkyCommander, LX200Basic, SimpleScope, and NexStarEvo.

HasDefaultScopeConfig() [1/2]

bool Telescope::HasDefaultScopeConfig ( )

protected

Load scope settings from XML files.

Returns

True if Config #1 exists otherwise false.

HasDefaultScopeConfig() [2/2]

bool INDI::Telescope::HasDefaultScopeConfig ( )

protected

Load scope settings from XML files.

Returns

True if Config #1 exists otherwise false.

HasLocation() [1/2]

bool INDI::Telescope::HasLocation ( )

inline

Returns

True if telescope location can be updated.

HasLocation() [2/2]

bool INDI::Telescope::HasLocation ( )

inline

Returns

True if telescope location can be updated.

HasPECState() [1/2]

bool INDI::Telescope::HasPECState ( )

inline

Returns

True if telescope supports PEC playback property

HasPECState() [2/2]

bool INDI::Telescope::HasPECState ( )

inline

Returns

True if telescope supports PEC playback property

HasPierSide() [1/2]

bool INDI::Telescope::HasPierSide ( )

inline

Returns

True if telescope supports pier side property

HasPierSide() [2/2]

bool INDI::Telescope::HasPierSide ( )

inline

Returns

True if telescope supports pier side property

HasTime() [1/2]

bool INDI::Telescope::HasTime ( )

inline

Returns

True if telescope time can be updated.

HasTime() [2/2]

bool INDI::Telescope::HasTime ( )

inline

Returns

True if telescope time can be updated.

HasTrackMode() [1/2]

bool INDI::Telescope::HasTrackMode ( )

inline

Returns

True if telescope supports track modes

HasTrackMode() [2/2]

bool INDI::Telescope::HasTrackMode ( )

inline

Returns

True if telescope supports track modes

HasTrackRate() [1/2]

bool INDI::Telescope::HasTrackRate ( )

inline

Returns

True if telescope supports custom tracking rates.

HasTrackRate() [2/2]

bool INDI::Telescope::HasTrackRate ( )

inline

Returns

True if telescope supports custom tracking rates.

InitPark() [1/2]

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.

InitPark() [2/2]

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

initProperties() [1/2]

bool Telescope::initProperties ( )

virtual

Called to initialize basic properties required all the time.

Reimplemented from INDI::DefaultDevice.

Reimplemented in EQMod, LX200_10MICRON, LX200Telescope, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, ScopeSim, LX200AstroPhysicsExperimental, DSC, LX200Gemini, IOptronV3, PMC8, SkywatcherAltAzSimple, CelestronGPS, IEQPro, LX200AstroPhysicsGTOCP2, LX200Autostar, Paramount, LX200Pulsar2, SynscanMount, TemmaMount, LX200Basic, SimpleScope, ioptronHC8406, LX200_16, LX200Classic, LX200GotoNova, LX200GPS, LX200SS2000PC, LX200ZEQ25, ScopeScript, LX200FS2, NexStarEvo, and ScopeSim.

initProperties() [2/2]

virtual bool INDI::Telescope::initProperties ( )

virtual

Called to initialize basic properties required all the time.

Reimplemented from INDI::DefaultDevice.

Reimplemented in EQMod, LX200_10MICRON, LX200Telescope, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, ScopeSim, LX200AstroPhysicsExperimental, DSC, LX200Gemini, IOptronV3, PMC8, SkywatcherAltAzSimple, CelestronGPS, IEQPro, LX200AstroPhysicsGTOCP2, LX200Autostar, Paramount, LX200Pulsar2, SynscanMount, TemmaMount, LX200Basic, SimpleScope, ioptronHC8406, LX200_16, LX200Classic, LX200GotoNova, LX200GPS, LX200SS2000PC, LX200ZEQ25, ScopeScript, LX200FS2, NexStarEvo, and ScopeSim.

ISGetProperties() [1/2]

virtual void INDI::Telescope::ISGetProperties ( const char *  dev )

virtual

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 EQMod, LX200Telescope, LX200_OnStep, SkywatcherAPIMount, ScopeSim, LX200AstroPhysics, SkywatcherAltAzSimple, LX200AstroPhysicsExperimental, CelestronGPS, LX200AstroPhysicsGTOCP2, LX200Gemini, LX200Pulsar2, LX200_16, LX200Basic, LX200GPS, LX200Classic, ScopeScript, LX200Autostar, SynscanMount, and NexStarEvo.

ISGetProperties() [2/2]

void Telescope::ISGetProperties ( const char *  dev )

virtual

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 EQMod, LX200Telescope, LX200_OnStep, SkywatcherAPIMount, ScopeSim, LX200AstroPhysics, SkywatcherAltAzSimple, LX200AstroPhysicsExperimental, CelestronGPS, LX200AstroPhysicsGTOCP2, LX200Gemini, LX200Pulsar2, LX200_16, LX200Basic, LX200GPS, LX200Classic, ScopeScript, LX200Autostar, SynscanMount, and NexStarEvo.

isLocked() [1/2]

bool Telescope::isLocked

(

)

const

isLocked is mount currently locked?

Returns

true if lock status equals true and DomeClosedLockTP is Dome Locks or Dome Locks and Dome Parks (both).

isLocked() [2/2]

bool INDI::Telescope::isLocked

(

)

const

isLocked is mount currently locked?

Returns

true if lock status equals true and DomeClosedLockTP is Dome Locks or Dome Locks and Dome Parks (both).

ISNewNumber() [1/2]

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

virtual

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 EQMod, LX200_10MICRON, LX200Telescope, LX200_OnStep, TemmaMount, SynscanMount, SkywatcherAPIMount, ScopeSim, SkywatcherAltAzSimple, LX200AstroPhysics, CelestronGPS, LX200AstroPhysicsExperimental, Paramount, DSC, LX200Gemini, LX200Basic, IOptronV3, PMC8, LX200_16, LX200Classic, LX200ZEQ25, IEQPro, LX200SS2000PC, LX200Autostar, LX200FS2, ScopeSim, and NexStarEvo.

ISNewNumber() [2/2]

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

virtual

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 EQMod, LX200_10MICRON, LX200Telescope, LX200_OnStep, TemmaMount, SynscanMount, SkywatcherAPIMount, ScopeSim, SkywatcherAltAzSimple, LX200AstroPhysics, CelestronGPS, LX200AstroPhysicsExperimental, Paramount, DSC, LX200Gemini, LX200Basic, IOptronV3, PMC8, LX200_16, LX200Classic, LX200ZEQ25, IEQPro, LX200SS2000PC, LX200Autostar, LX200FS2, ScopeSim, and NexStarEvo.

ISNewSwitch() [1/2]

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

virtual

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 EQMod, LX200_10MICRON, LX200Telescope, LX200_OnStep, TemmaMount, SynscanMount, SkywatcherAPIMount, ScopeSim, SkywatcherAltAzSimple, LX200AstroPhysics, CelestronGPS, LX200AstroPhysicsExperimental, Paramount, DSC, LX200Pulsar2, IOptronV3, LX200Gemini, PMC8, LX200_16, LX200Classic, IEQPro, ioptronHC8406, LX200AstroPhysicsGTOCP2, LX200GPS, LX200Autostar, LX200GotoNova, LX200ZEQ25, ScopeSim, and NexStarEvo.

ISNewSwitch() [2/2]

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

virtual

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 EQMod, LX200_10MICRON, LX200Telescope, LX200_OnStep, TemmaMount, SynscanMount, SkywatcherAPIMount, ScopeSim, SkywatcherAltAzSimple, LX200AstroPhysics, CelestronGPS, LX200AstroPhysicsExperimental, Paramount, DSC, LX200Pulsar2, IOptronV3, LX200Gemini, PMC8, LX200_16, LX200Classic, IEQPro, ioptronHC8406, LX200AstroPhysicsGTOCP2, LX200GPS, LX200Autostar, LX200GotoNova, LX200ZEQ25, ScopeSim, and NexStarEvo.

ISNewText() [1/2]

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

virtual

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 EQMod, LX200_10MICRON, LX200Telescope, TemmaMount, SynscanMount, SkywatcherAPIMount, SkywatcherAltAzSimple, LX200Pulsar2, DSC, ScopeScript, ScopeSim, and NexStarEvo.

ISNewText() [2/2]

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

virtual

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 EQMod, LX200_10MICRON, LX200Telescope, TemmaMount, SynscanMount, SkywatcherAPIMount, SkywatcherAltAzSimple, LX200Pulsar2, DSC, ScopeScript, ScopeSim, and NexStarEvo.

isParked() [1/2]

bool Telescope::isParked

(

)

isParked is mount currently parked?

Returns

True if parked, false otherwise.

isParked() [2/2]

bool INDI::Telescope::isParked

(

)

isParked is mount currently parked?

Returns

True if parked, false otherwise.

ISSnoopDevice() [1/2]

virtual bool INDI::Telescope::ISSnoopDevice ( XMLEle *  root )

virtual

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.

ISSnoopDevice() [2/2]

bool Telescope::ISSnoopDevice ( XMLEle *  root )

virtual

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.

joystickHelper() [1/2]

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

static

joystickHelper() [2/2]

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

static

LoadParkData() [1/2]

char* INDI::Telescope::LoadParkData ( )

protected

LoadParkData() [2/2]

char * Telescope::LoadParkData ( )

protected

LoadScopeConfig() [1/2]

bool Telescope::LoadScopeConfig ( )

protected

Load scope settings from XML files.

Returns

True if all config values were loaded otherwise false.

LoadScopeConfig() [2/2]

bool INDI::Telescope::LoadScopeConfig ( )

protected

Load scope settings from XML files.

Returns

True if all config values were loaded otherwise false.

MoveNS() [1/2]

virtual bool INDI::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 EQMod, LX200AstroPhysicsExperimental, LX200Telescope, LX200AstroPhysicsGTOCP2, SkywatcherAPIMount, ScopeSim, CelestronGPS, SkywatcherAltAzSimple, LX200ZEQ25, IOptronV3, PMC8, TemmaMount, IEQPro, Paramount, SynscanMount, LX200Pulsar2, ScopeScript, NexStarEvo, and ScopeSim.

MoveNS() [2/2]

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 EQMod, LX200AstroPhysicsExperimental, LX200Telescope, LX200AstroPhysicsGTOCP2, SkywatcherAPIMount, ScopeSim, CelestronGPS, SkywatcherAltAzSimple, LX200ZEQ25, IOptronV3, PMC8, TemmaMount, IEQPro, Paramount, SynscanMount, LX200Pulsar2, ScopeScript, NexStarEvo, and ScopeSim.

MoveWE() [1/2]

virtual bool INDI::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 EQMod, LX200AstroPhysicsExperimental, LX200Telescope, LX200AstroPhysicsGTOCP2, SkywatcherAPIMount, ScopeSim, CelestronGPS, SkywatcherAltAzSimple, LX200ZEQ25, IOptronV3, PMC8, TemmaMount, IEQPro, Paramount, SynscanMount, LX200Pulsar2, ScopeScript, NexStarEvo, and ScopeSim.

MoveWE() [2/2]

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 EQMod, LX200AstroPhysicsExperimental, LX200Telescope, LX200AstroPhysicsGTOCP2, SkywatcherAPIMount, ScopeSim, CelestronGPS, SkywatcherAltAzSimple, LX200ZEQ25, IOptronV3, PMC8, TemmaMount, IEQPro, Paramount, SynscanMount, LX200Pulsar2, ScopeScript, NexStarEvo, and ScopeSim.

NewRaDec() [1/2]

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

protected

The child class calls this function when it has updates.

NewRaDec() [2/2]

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

protected

The child class calls this function when it has updates.

Park() [1/2]

virtual bool INDI::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 EQMod, LX200_10MICRON, LX200Telescope, CelestronGPS, ScopeSim, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, LX200AstroPhysicsExperimental, ioptronHC8406, LX200ZEQ25, LX200Pulsar2, SkywatcherAltAzSimple, IOptronV3, LX200GotoNova, PMC8, Paramount, IEQPro, LX200Gemini, LX200AstroPhysicsGTOCP2, ScopeScript, TemmaMount, LX200FS2, SynscanMount, and NexStarEvo.

Park() [2/2]

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 EQMod, LX200_10MICRON, LX200Telescope, CelestronGPS, ScopeSim, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, LX200AstroPhysicsExperimental, ioptronHC8406, LX200ZEQ25, LX200Pulsar2, SkywatcherAltAzSimple, IOptronV3, LX200GotoNova, PMC8, Paramount, IEQPro, LX200Gemini, LX200AstroPhysicsGTOCP2, ScopeScript, TemmaMount, LX200FS2, SynscanMount, and NexStarEvo.

processButton() [1/2]

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

protected

processButton() [2/2]

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

protected

processJoystick() [1/2]

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

protected

processJoystick() [2/2]

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

protected

processLocationInfo() [1/2]

bool INDI::Telescope::processLocationInfo ( double  latitude, double  longitude, double  elevation  )

private

processLocationInfo() [2/2]

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

private

processNSWE() [1/2]

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

protected

processNSWE() [2/2]

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

protected

processSlewPresets() [1/2]

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

protected

processSlewPresets() [2/2]

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

protected

processTimeInfo() [1/2]

bool Telescope::processTimeInfo ( const char *  utc, const char *  offset  )

private

processTimeInfo() [2/2]

bool INDI::Telescope::processTimeInfo ( const char *  utc, const char *  offset  )

private

ReadScopeStatus() [1/2]

virtual bool INDI::Telescope::ReadScopeStatus ( )

protectedpure virtual

Read telescope status.

This function checks the following:

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

Returns

True if reading scope status is OK, false if an error is encounterd.

Note

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

Implemented in EQMod, LX200_10MICRON, LX200_OnStep, SkywatcherAPIMount, LX200Telescope, SkywatcherAltAzSimple, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, DSC, ScopeSim, IOptronV3, PMC8, IEQPro, ioptronHC8406, LX200ZEQ25, ScopeScript, LX200AstroPhysicsGTOCP2, LX200GotoNova, NexStarEvo, TemmaMount, CelestronGPS, LX200_16, SynscanMount, SimpleScope, Paramount, LX200Pulsar2, SkyCommander, LX200Basic, and ScopeSim.

ReadScopeStatus() [2/2]

virtual bool INDI::Telescope::ReadScopeStatus ( )

protectedpure virtual

Read telescope status.

This function checks the following:

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

Returns

True if reading scope status is OK, false if an error is encounterd.

Note

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

Implemented in EQMod, LX200_10MICRON, LX200_OnStep, SkywatcherAPIMount, LX200Telescope, SkywatcherAltAzSimple, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200Gemini, DSC, ScopeSim, IOptronV3, PMC8, IEQPro, ioptronHC8406, LX200ZEQ25, ScopeScript, LX200AstroPhysicsGTOCP2, LX200GotoNova, NexStarEvo, TemmaMount, CelestronGPS, LX200_16, SynscanMount, SimpleScope, Paramount, LX200Pulsar2, SkyCommander, LX200Basic, and ScopeSim.

saveConfigItems() [1/2]

bool Telescope::saveConfigItems ( FILE *  fp )

protectedvirtual

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 EQMod, LX200Telescope, LX200AstroPhysicsExperimental, CelestronGPS, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, SkywatcherAPIMount, LX200Gemini, SkywatcherAltAzSimple, ioptronHC8406, IOptronV3, LX200GotoNova, PMC8, IEQPro, DSC, LX200SS2000PC, LX200FS2, ScopeScript, and NexStarEvo.

saveConfigItems() [2/2]

virtual bool INDI::Telescope::saveConfigItems ( FILE *  fp )

protectedvirtual

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 EQMod, LX200Telescope, LX200AstroPhysicsExperimental, CelestronGPS, LX200AstroPhysics, LX200AstroPhysicsGTOCP2, SkywatcherAPIMount, LX200Gemini, SkywatcherAltAzSimple, ioptronHC8406, IOptronV3, LX200GotoNova, PMC8, IEQPro, DSC, LX200SS2000PC, LX200FS2, ScopeScript, and NexStarEvo.

sendTimeFromSystem() [1/2]

void INDI::Telescope::sendTimeFromSystem ( )

protected

sendTimeFromSystem() [2/2]

void Telescope::sendTimeFromSystem ( )

protected

SetAxis1Park() [1/2]

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

SetAxis1Park() [2/2]

void INDI::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).

SetAxis1ParkDefault() [1/2]

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

SetAxis1ParkDefault() [2/2]

void INDI::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).

SetAxis2Park() [1/2]

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

SetAxis2Park() [2/2]

void INDI::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).

SetAxis2ParkDefault() [1/2]

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

SetAxis2ParkDefault() [2/2]

void INDI::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).

SetCurrentPark() [1/2]

virtual bool INDI::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 EQMod, CelestronGPS, ScopeSim, IOptronV3, PMC8, IEQPro, LX200_OnStep, Paramount, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200ZEQ25, TemmaMount, SynscanMount, LX200AstroPhysicsGTOCP2, and LX200FS2.

SetCurrentPark() [2/2]

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 EQMod, CelestronGPS, ScopeSim, IOptronV3, PMC8, IEQPro, LX200_OnStep, Paramount, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200ZEQ25, TemmaMount, SynscanMount, LX200AstroPhysicsGTOCP2, and LX200FS2.

SetDefaultPark() [1/2]

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 EQMod, CelestronGPS, ScopeSim, IOptronV3, PMC8, IEQPro, LX200_OnStep, Paramount, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200ZEQ25, TemmaMount, SynscanMount, LX200AstroPhysicsGTOCP2, and LX200FS2.

SetDefaultPark() [2/2]

virtual bool INDI::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 EQMod, CelestronGPS, ScopeSim, IOptronV3, PMC8, IEQPro, LX200_OnStep, Paramount, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200ZEQ25, TemmaMount, SynscanMount, LX200AstroPhysicsGTOCP2, and LX200FS2.

SetParkDataType() [1/2]

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.

SetParkDataType() [2/2]

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

SetParked() [1/2]

void Telescope::SetParked

(

bool

isparked

)

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.

SetParked() [2/2]

void INDI::Telescope::SetParked

(

bool

isparked

)

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.

SetParkPosition() [1/2]

virtual bool INDI::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 Paramount.

SetParkPosition() [2/2]

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

setPECState() [1/2]

void Telescope::setPECState

(

TelescopePECState

state

)

setPECState() [2/2]

void INDI::Telescope::setPECState

(

TelescopePECState

state

)

setPierSide() [1/2]

void INDI::Telescope::setPierSide

(

TelescopePierSide

side

)

setPierSide() [2/2]

void Telescope::setPierSide

(

TelescopePierSide

side

)

SetSlewRate() [1/2]

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 IOptronV3, PMC8, IEQPro, LX200Telescope, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200ZEQ25, LX200GotoNova, SynscanMount, and LX200Pulsar2.

SetSlewRate() [2/2]

virtual bool INDI::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 IOptronV3, PMC8, IEQPro, LX200Telescope, LX200AstroPhysics, LX200AstroPhysicsExperimental, LX200AstroPhysicsGTOCP2, LX200ZEQ25, LX200GotoNova, SynscanMount, and LX200Pulsar2.

SetTelescopeCapability() [1/2]

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

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 (default is 0), 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.

SetTelescopeCapability() [2/2]

void INDI::Telescope::SetTelescopeCapability	(	uint32_t	cap,
		uint8_t	slewRateCount = 0
	)

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 (default is 0), 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.

setTelescopeConnection() [1/2]

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.

setTelescopeConnection() [2/2]

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

SetTrackEnabled() [1/2]

virtual bool INDI::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 EQMod, LX200AstroPhysicsExperimental, IOptronV3, PMC8, CelestronGPS, IEQPro, LX200AstroPhysics, ScopeSim, LX200_OnStep, LX200AstroPhysicsGTOCP2, Paramount, LX200Gemini, and ioptronHC8406.

SetTrackEnabled() [2/2]

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 EQMod, LX200AstroPhysicsExperimental, IOptronV3, PMC8, CelestronGPS, IEQPro, LX200AstroPhysics, ScopeSim, LX200_OnStep, LX200AstroPhysicsGTOCP2, Paramount, LX200Gemini, and ioptronHC8406.

SetTrackMode() [1/2]

virtual bool INDI::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 EQMod, LX200AstroPhysicsExperimental, CelestronGPS, LX200AstroPhysics, IOptronV3, PMC8, LX200Telescope, IEQPro, ScopeSim, LX200AstroPhysicsGTOCP2, Paramount, LX200Gemini, ioptronHC8406, LX200ZEQ25, and LX200GotoNova.

SetTrackMode() [2/2]

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 EQMod, LX200AstroPhysicsExperimental, CelestronGPS, LX200AstroPhysics, IOptronV3, PMC8, LX200Telescope, IEQPro, ScopeSim, LX200AstroPhysicsGTOCP2, Paramount, LX200Gemini, ioptronHC8406, LX200ZEQ25, and LX200GotoNova.

SetTrackRate() [1/2]

virtual bool INDI::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 EQMod, LX200AstroPhysicsExperimental, LX200AstroPhysics, IOptronV3, PMC8, IEQPro, ScopeSim, LX200AstroPhysicsGTOCP2, and Paramount.

SetTrackRate() [2/2]

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 EQMod, LX200AstroPhysicsExperimental, LX200AstroPhysics, IOptronV3, PMC8, IEQPro, ScopeSim, LX200AstroPhysicsGTOCP2, and Paramount.

Sync() [1/2]

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 EQMod, LX200Telescope, ScopeSim, SkywatcherAPIMount, LX200AstroPhysics, LX200AstroPhysicsExperimental, SkywatcherAltAzSimple, SynscanMount, IOptronV3, LX200Pulsar2, PMC8, IEQPro, Paramount, CelestronGPS, LX200AstroPhysicsGTOCP2, DSC, ioptronHC8406, LX200GotoNova, ScopeScript, TemmaMount, LX200Basic, ScopeSim, and NexStarEvo.

Sync() [2/2]

virtual bool INDI::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 EQMod, LX200Telescope, ScopeSim, SkywatcherAPIMount, LX200AstroPhysics, LX200AstroPhysicsExperimental, SkywatcherAltAzSimple, SynscanMount, IOptronV3, LX200Pulsar2, PMC8, IEQPro, Paramount, CelestronGPS, LX200AstroPhysicsGTOCP2, DSC, ioptronHC8406, LX200GotoNova, ScopeScript, TemmaMount, LX200Basic, ScopeSim, and NexStarEvo.

TimerHit() [1/2]

virtual void INDI::Telescope::TimerHit ( )

virtual

Called when setTimer() time is up.

Reimplemented from INDI::DefaultDevice.

Reimplemented in EQMod, SkywatcherAPIMount, SkywatcherAltAzSimple, NexStarEvo, and ScopeSim.

TimerHit() [2/2]

void Telescope::TimerHit ( )

virtual

Called when setTimer() time is up.

Reimplemented from INDI::DefaultDevice.

Reimplemented in EQMod, SkywatcherAPIMount, SkywatcherAltAzSimple, NexStarEvo, and ScopeSim.

triggerSnoop() [1/2]

void Telescope::triggerSnoop ( const char *  driverName, const char *  propertyName  )

private

triggerSnoop() [2/2]

void INDI::Telescope::triggerSnoop ( const char *  driverName, const char *  propertyName  )

private

UnPark() [1/2]

virtual bool INDI::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 EQMod, LX200_10MICRON, CelestronGPS, ScopeSim, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, LX200AstroPhysicsExperimental, ioptronHC8406, LX200Pulsar2, LX200ZEQ25, SkywatcherAltAzSimple, IOptronV3, LX200GotoNova, PMC8, Paramount, IEQPro, LX200Gemini, LX200AstroPhysicsGTOCP2, ScopeScript, TemmaMount, LX200FS2, SynscanMount, LX200GPS, and NexStarEvo.

UnPark() [2/2]

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 EQMod, LX200_10MICRON, CelestronGPS, ScopeSim, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, LX200AstroPhysicsExperimental, ioptronHC8406, LX200Pulsar2, LX200ZEQ25, SkywatcherAltAzSimple, IOptronV3, LX200GotoNova, PMC8, Paramount, IEQPro, LX200Gemini, LX200AstroPhysicsGTOCP2, ScopeScript, TemmaMount, LX200FS2, SynscanMount, LX200GPS, and NexStarEvo.

updateLocation() [1/2]

virtual bool INDI::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 EQMod, LX200Telescope, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, ScopeSim, LX200AstroPhysicsExperimental, IOptronV3, PMC8, IEQPro, CelestronGPS, LX200AstroPhysicsGTOCP2, LX200Pulsar2, DSC, ioptronHC8406, TemmaMount, LX200GotoNova, LX200ZEQ25, LX200SS2000PC, Paramount, SynscanMount, LX200FS2, NexStarEvo, and ScopeSim.

updateLocation() [2/2]

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 EQMod, LX200Telescope, LX200_OnStep, LX200AstroPhysics, SkywatcherAPIMount, ScopeSim, LX200AstroPhysicsExperimental, IOptronV3, PMC8, IEQPro, CelestronGPS, LX200AstroPhysicsGTOCP2, LX200Pulsar2, DSC, ioptronHC8406, TemmaMount, LX200GotoNova, LX200ZEQ25, LX200SS2000PC, Paramount, SynscanMount, LX200FS2, NexStarEvo, and ScopeSim.

updateProperties() [1/2]

bool Telescope::updateProperties ( )

virtual

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

Reimplemented from INDI::DefaultDevice.

Reimplemented in EQMod, LX200_10MICRON, SkywatcherAPIMount, SkywatcherAltAzSimple, LX200Telescope, LX200_OnStep, LX200AstroPhysics, ScopeSim, LX200AstroPhysicsExperimental, DSC, LX200Gemini, IOptronV3, PMC8, CelestronGPS, IEQPro, LX200AstroPhysicsGTOCP2, LX200Autostar, Paramount, LX200Pulsar2, TemmaMount, LX200Basic, LX200Classic, LX200_16, LX200GPS, LX200SS2000PC, ioptronHC8406, SynscanMount, LX200GotoNova, LX200ZEQ25, and LX200FS2.

updateProperties() [2/2]

virtual bool INDI::Telescope::updateProperties ( )

virtual

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

Reimplemented from INDI::DefaultDevice.

Reimplemented in EQMod, LX200_10MICRON, SkywatcherAPIMount, SkywatcherAltAzSimple, LX200Telescope, LX200_OnStep, LX200AstroPhysics, ScopeSim, LX200AstroPhysicsExperimental, DSC, LX200Gemini, IOptronV3, PMC8, CelestronGPS, IEQPro, LX200AstroPhysicsGTOCP2, LX200Autostar, Paramount, LX200Pulsar2, TemmaMount, LX200Basic, LX200Classic, LX200_16, LX200GPS, LX200SS2000PC, ioptronHC8406, SynscanMount, LX200GotoNova, LX200ZEQ25, and LX200FS2.

UpdateScopeConfig() [1/2]

bool INDI::Telescope::UpdateScopeConfig ( )

protected

Save scope settings to XML files.

UpdateScopeConfig() [2/2]

bool Telescope::UpdateScopeConfig ( )

protected

Save scope settings to XML files.

updateTime() [1/2]

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 EQMod, LX200Telescope, LX200AstroPhysics, LX200AstroPhysicsExperimental, IOptronV3, PMC8, CelestronGPS, IEQPro, LX200AstroPhysicsGTOCP2, LX200Pulsar2, ioptronHC8406, LX200GotoNova, LX200ZEQ25, Paramount, SynscanMount, LX200GPS, and LX200SS2000PC.

updateTime() [2/2]

virtual bool INDI::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 EQMod, LX200Telescope, LX200AstroPhysics, LX200AstroPhysicsExperimental, IOptronV3, PMC8, CelestronGPS, IEQPro, LX200AstroPhysicsGTOCP2, LX200Pulsar2, ioptronHC8406, LX200GotoNova, LX200ZEQ25, Paramount, SynscanMount, LX200GPS, and LX200SS2000PC.

WriteParkData() [1/2]

bool Telescope::WriteParkData ( )

protected

WriteParkData() [2/2]

bool INDI::Telescope::WriteParkData ( )

protected

Member Data Documentation

AbortS

ISwitch Telescope::AbortS

protected

AbortSP

ISwitchVectorProperty Telescope::AbortSP

protected

ActiveDeviceT

IText Telescope::ActiveDeviceT {}

protected

ActiveDeviceTP

ITextVectorProperty Telescope::ActiveDeviceTP

protected

Axis1DefaultParkPosition

double Telescope::Axis1DefaultParkPosition

private

Axis1ParkPosition

double Telescope::Axis1ParkPosition

private

Axis2DefaultParkPosition

double Telescope::Axis2DefaultParkPosition

private

Axis2ParkPosition

double Telescope::Axis2ParkPosition

private

capability

uint32_t Telescope::capability

protected

controller

Controller * Telescope::controller

private

CoordS

ISwitch Telescope::CoordS

protected

CoordSP

ISwitchVectorProperty Telescope::CoordSP

protected

currentPECState

TelescopePECState Telescope::currentPECState

protected

currentPierSide

TelescopePierSide Telescope::currentPierSide

protected

DomeClosedLockT

ISwitch Telescope::DomeClosedLockT

protected

DomeClosedLockTP

ISwitchVectorProperty Telescope::DomeClosedLockTP

protected

EqN

INumber Telescope::EqN

protected

EqNP

INumberVectorProperty Telescope::EqNP

protected

IsLocked

bool Telescope::IsLocked

private

IsParked

bool Telescope::IsParked

private

last_ns_motion

int Telescope::last_ns_motion

protected

last_we_motion

int Telescope::last_we_motion

protected

lastEqState

IPState Telescope::lastEqState

private

lastPECState

TelescopePECState Telescope::lastPECState

protected

lastPierSide

TelescopePierSide Telescope::lastPierSide

protected

LocationN

INumber Telescope::LocationN

protected

LocationNP

INumberVectorProperty Telescope::LocationNP

protected

LockAxisS

ISwitch Telescope::LockAxisS

protected

LockAxisSP

ISwitchVectorProperty Telescope::LockAxisSP

protected

MovementNSS

ISwitch Telescope::MovementNSS

protected

MovementNSSP

ISwitchVectorProperty Telescope::MovementNSSP

protected

MovementWES

ISwitch Telescope::MovementWES

protected

MovementWESP

ISwitchVectorProperty Telescope::MovementWESP

protected

nSlewRate

uint8_t Telescope::nSlewRate

private

ParkDataFileName

const std::string Telescope::ParkDataFileName

private

parkDataType

TelescopeParkData Telescope::parkDataType

private

ParkdataXmlRoot

XMLEle * Telescope::ParkdataXmlRoot

private

ParkDeviceName

const char * Telescope::ParkDeviceName

private

ParkdeviceXml

XMLEle * Telescope::ParkdeviceXml

private

ParkOptionS

ISwitch Telescope::ParkOptionS

protected

ParkOptionSP

ISwitchVectorProperty Telescope::ParkOptionSP

protected

ParkpositionAxis1Xml

XMLEle * Telescope::ParkpositionAxis1Xml

private

ParkpositionAxis2Xml

XMLEle * Telescope::ParkpositionAxis2Xml

private

ParkPositionN

INumber Telescope::ParkPositionN

protected

ParkPositionNP

INumberVectorProperty Telescope::ParkPositionNP

protected

ParkpositionXml

XMLEle * Telescope::ParkpositionXml

private

ParkS

ISwitch Telescope::ParkS

protected

ParkSP

ISwitchVectorProperty Telescope::ParkSP

protected

ParkstatusXml

XMLEle * Telescope::ParkstatusXml

private

PECStateS

ISwitch Telescope::PECStateS

protected

PECStateSP

ISwitchVectorProperty Telescope::PECStateSP

protected

PierSideS

ISwitch Telescope::PierSideS

protected

PierSideSP

ISwitchVectorProperty Telescope::PierSideSP

protected

PortFD

int Telescope::PortFD = -1

protected

RememberTrackState

TelescopeStatus Telescope::RememberTrackState

protected

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

ScopeConfigDeviceXmlNode

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

protected

ScopeConfigFileName

const std::string Telescope::ScopeConfigFileName

protected

The telescope/guide scope configuration file name.

ScopeConfigGScopeApXmlNode

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

protected

ScopeConfigGScopeFocXmlNode

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

protected

ScopeConfigLabelApXmlNode

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

protected

ScopeConfigNameT

IText Telescope::ScopeConfigNameT {}

protected

ScopeConfigNameTP

ITextVectorProperty Telescope::ScopeConfigNameTP

protected

ScopeConfigNameXmlNode

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

protected

ScopeConfigRootXmlNode

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

protected

ScopeConfigs

ISwitch Telescope::ScopeConfigs

protected

ScopeConfigScopeApXmlNode

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

protected

ScopeConfigScopeFocXmlNode

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

protected

ScopeConfigsSP

ISwitchVectorProperty Telescope::ScopeConfigsSP

protected

ScopeParametersN

INumber Telescope::ScopeParametersN

protected

ScopeParametersNP

INumberVectorProperty Telescope::ScopeParametersNP

protected

serialConnection

Connection::Serial * Telescope::serialConnection = NULL

protected

SlewRateS

ISwitch * Telescope::SlewRateS

protected

SlewRateSP

ISwitchVectorProperty Telescope::SlewRateSP

protected

TargetN

INumber Telescope::TargetN

protected

TargetNP

INumberVectorProperty Telescope::TargetNP

protected

tcpConnection

Connection::TCP * Telescope::tcpConnection = NULL

protected

TelescopeCapability [1/2]

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

TelescopeCapability [2/2]

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

TelescopeConnection [1/2]

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

TelescopeConnection [2/2]

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

telescopeConnection

uint8_t Telescope::telescopeConnection = CONNECTION_SERIAL | CONNECTION_TCP

private

TimeT

IText Telescope::TimeT {}

protected

TimeTP

ITextVectorProperty Telescope::TimeTP

protected

TrackModeS

ISwitch * Telescope::TrackModeS { nullptr }

protected

TrackModeSP

ISwitchVectorProperty Telescope::TrackModeSP

protected

TrackRateN

INumber Telescope::TrackRateN

protected

TrackRateNP

INumberVectorProperty Telescope::TrackRateNP

protected

TrackState

TelescopeStatus Telescope::TrackState

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.

TrackStateS

ISwitch Telescope::TrackStateS

protected

TrackStateSP

ISwitchVectorProperty Telescope::TrackStateSP

protected

---

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

• /home/nirva/insroot/include/libindi/inditelescope.h
• ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/inditelescope.cpp