INDI::GuiderInterface Class Reference

#include <indiguiderinterface.h>

Inheritance diagram for INDI::GuiderInterface:

Public Member Functions
virtual IPState	GuideNorth (uint32_t ms)=0
	Guide north for ms milliseconds. North is defined as DEC+.
virtual IPState	GuideSouth (uint32_t ms)=0
	Guide south for ms milliseconds. South is defined as DEC-.
virtual IPState	GuideEast (uint32_t ms)=0
	Guide east for ms milliseconds. East is defined as RA+.
virtual IPState	GuideWest (uint32_t ms)=0
	Guide west for ms milliseconds. West is defined as RA-.
virtual void	GuideComplete (INDI_EQ_AXIS axis)
	Call GuideComplete once the guiding pulse is complete.

Protected Member Functions
	GuiderInterface (DefaultDevice *defaultDevice)
	~GuiderInterface ()
void	initProperties (const char *groupName)
	Initialize guider properties. It is recommended to call this function within initProperties() of your primary device.
bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device
bool	processNumber (const char *dev, const char *name, double values[], char *names[], int n)
	Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. This function then takes care of issuing the corresponding GuideXXXX function accordingly.

Protected Attributes
INDI::PropertyNumber	GuideNSNP {2}
INDI::PropertyNumber	GuideWENP {2}

Detailed Description

Definition at line 56 of file indiguiderinterface.h.

Constructor & Destructor Documentation

GuiderInterface()

GuiderInterface::GuiderInterface ( DefaultDevice *  defaultDevice )

protected

Definition at line 31 of file indiguiderinterface.cpp.

~GuiderInterface()

GuiderInterface::~GuiderInterface ( )

protected

Definition at line 38 of file indiguiderinterface.cpp.

Member Function Documentation

GuideComplete()

void GuiderInterface::GuideComplete ( INDI_EQ_AXIS  axis )

virtual

Call GuideComplete once the guiding pulse is complete.

Parameters

axis	Axis of completed guiding operation.

Reimplemented in INDI::CCD.

Definition at line 122 of file indiguiderinterface.cpp.

GuideEast()

virtual IPState INDI::GuiderInterface::GuideEast ( uint32_t  ms )

pure virtual

Guide east for ms milliseconds. East is defined as RA+.

Returns

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

Implemented in ArduinoST4, GPUSB, STAR2000, AlpacaCCD, MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, IOptronV3, LX200_TeenAstro, LX200AstroPhysicsV2, LX200Pulsar2, LX200Telescope, Paramount, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, ScopeSim, TemmaMount, INDI::CCD, LX200AstroPhysics, SkywatcherAltAzSimple, CCDSim, and GuideSim.

GuideNorth()

virtual IPState INDI::GuiderInterface::GuideNorth ( uint32_t  ms )

pure virtual

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

Returns

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

Implemented in ArduinoST4, GPUSB, STAR2000, AlpacaCCD, MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, IOptronV3, LX200_TeenAstro, LX200AstroPhysicsV2, LX200Pulsar2, LX200Telescope, Paramount, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, ScopeSim, TemmaMount, INDI::CCD, LX200AstroPhysics, SkywatcherAltAzSimple, CCDSim, and GuideSim.

GuideSouth()

virtual IPState INDI::GuiderInterface::GuideSouth ( uint32_t  ms )

pure virtual

Guide south for ms milliseconds. South is defined as DEC-.

Returns

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

Implemented in ArduinoST4, GPUSB, STAR2000, AlpacaCCD, MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, IOptronV3, LX200_TeenAstro, LX200AstroPhysicsV2, LX200Pulsar2, LX200Telescope, Paramount, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, ScopeSim, TemmaMount, INDI::CCD, LX200AstroPhysics, SkywatcherAltAzSimple, CCDSim, and GuideSim.

GuideWest()

virtual IPState INDI::GuiderInterface::GuideWest ( uint32_t  ms )

pure virtual

Guide west for ms milliseconds. West is defined as RA-.

Returns

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

Implemented in ArduinoST4, GPUSB, STAR2000, AlpacaCCD, MountDriver, AstroTrac, CelestronGPS, TitanTCS, IEQPro, IEQProLegacy, IOptronV3, LX200_TeenAstro, LX200AstroPhysicsV2, LX200Pulsar2, LX200Telescope, Paramount, PMC8, Rainbow, SkywatcherAPIMount, SynscanDriver, ScopeSim, TemmaMount, INDI::CCD, LX200AstroPhysics, SkywatcherAltAzSimple, CCDSim, and GuideSim.

initProperties()

void GuiderInterface::initProperties ( const char *  groupName )

protected

Initialize guider properties. It is recommended to call this function within initProperties() of your primary device.

Parameters

groupName

Group or tab name to be used to define guider properties.

Definition at line 45 of file indiguiderinterface.cpp.

processNumber()

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

protected

Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. This function then takes care of issuing the corresponding GuideXXXX function accordingly.

Parameters

dev	device name
name	property name
values	value as passed by the client
names	names as passed by the client
n	number of values and names pair to process.

Returns

True if the Guide properties are processed, false otherwise.

Definition at line 80 of file indiguiderinterface.cpp.

updateProperties()

bool GuiderInterface::updateProperties ( )

protected

updateProperties Define or Delete Rotator properties based on the connection status of the base device

Returns

True if successful, false otherwise.

Definition at line 61 of file indiguiderinterface.cpp.

Member Data Documentation

GuideNSNP

INDI::PropertyNumber INDI::GuiderInterface::GuideNSNP {2}

protected

Definition at line 123 of file indiguiderinterface.h.

GuideWENP

INDI::PropertyNumber INDI::GuiderInterface::GuideWENP {2}

protected

Definition at line 124 of file indiguiderinterface.h.

---

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

• indiguiderinterface.h
• indiguiderinterface.cpp