Interface ITelescope

Defines the capabilities supported by an ASCOM Alpaca Telescope device

Inherited Members

IDevice.DeviceNumber

IDevice.InvokeAction(String, String)

IDevice.SendCommandBlind(String, Boolean)

IDevice.SendCommandBool(String, Boolean)

IDevice.SendCommandString(String, Boolean)

IDevice.IsConnected()

IDevice.SetConnected(Boolean)

IDevice.GetDescription()

IDevice.GetDriverInfo()

IDevice.GetDriverVersion()

IDevice.GetInterfaceVersion()

IDevice.GetName()

IDevice.GetSupportedActions()

Namespace: ES.Ascom.Alpaca.Devices

Assembly: ES.Ascom.Alpaca.Shared.dll

Syntax

public interface ITelescope : IDevice

Methods

| Improve this Doc View Source

AbortSlew()

Immediately stops a slew in progress.

Declaration

void AbortSlew()

| Improve this Doc View Source

CanFindHome()

Indicates whether the mount can find the home position.

Declaration

bool CanFindHome()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanMoveAxis(TelescopeAxis)

Indicates whether the telescope can move the requested axis.

Declaration

bool CanMoveAxis(TelescopeAxis axis)

Parameters

Type	Name	Description
TelescopeAxis	axis	The axis about which rate information is desired.

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanPark()

Indicates whether the telescope can be parked.

Declaration

bool CanPark()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanPulseGuide()

ndicates whether the telescope can be pulse guided.

Declaration

bool CanPulseGuide()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSetDeclinationRate()

Indicates whether the DeclinationRate property can be changed.

Declaration

bool CanSetDeclinationRate()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSetGuideRates()

Indicates whether the DeclinationRate property can be changed.

Declaration

bool CanSetGuideRates()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSetPark()

Indicates whether the telescope park position can be set.

Declaration

bool CanSetPark()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSetPierSide()

Indicates whether the telescope SideOfPier can be set.

Declaration

bool CanSetPierSide()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSetRightAscensionRate()

Indicates whether the RightAscensionRate property can be changed.

Declaration

bool CanSetRightAscensionRate()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSetTracking()

Indicates whether the Tracking property can be changed.

Declaration

bool CanSetTracking()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSlew()

Indicates whether the telescope can slew synchronously.

Declaration

bool CanSlew()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSlewAltAz()

Indicates whether the telescope can slew synchronously to AltAz coordinates.

Declaration

bool CanSlewAltAz()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSync()

Indicates whether the telescope can sync to equatorial coordinates.

Declaration

bool CanSync()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanSyncAltAz()

Indicates whether the telescope can sync to local horizontal coordinates.

Declaration

bool CanSyncAltAz()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

DoesRefraction()

Indicates whether atmospheric refraction is applied to coordinates.

Declaration

bool DoesRefraction()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

FindHome()

Moves the mount to the "home" position.

Declaration

void FindHome()

| Improve this Doc View Source

GetAlignmentMode()

Returns the alignment mode of the mount (Alt/Az, Polar, German Polar).

Declaration

AlignmentMode GetAlignmentMode()

Returns

Type	Description
AlignmentMode

| Improve this Doc View Source

GetAltitude()

Returns the Altitude above the local horizon of the telescope's current position (degrees, positive up)

Declaration

double GetAltitude()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetApertureArea()

Returns thhe area of the telescope's aperture, taking into account any obstructions (square meters)

Declaration

double GetApertureArea()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetApertureDiameter()

Returns the telescope's effective aperture diameter (meters)

Declaration

double GetApertureDiameter()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetAxisRates(TelescopeAxis)

Returns the rates at which the telescope may be moved about the specified axis.

Declaration

IList<AxisRate> GetAxisRates(TelescopeAxis axis)

Parameters

Type	Name	Description
TelescopeAxis	axis	The axis about which rate information is desired

Returns

Type	Description
System.Collections.Generic.IList<AxisRate>

| Improve this Doc View Source

GetAzimuth()

Returns the azimuth at the local horizon of the telescope's current position (degrees, North-referenced, positive East/clockwise).

Declaration

double GetAzimuth()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetDeclination()

The declination (degrees) of the telescope's current equatorial coordinates, in the coordinate system given by GetEquatorialSystem().

Declaration

double GetDeclination()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetDeclinationRate()

Returns the telescope's declination tracking rate.

Declaration

double GetDeclinationRate()

Returns

Type	Description
System.Double	The declination tracking rate (arcseconds per second, default = 0.0)

| Improve this Doc View Source

GetDestinationSideOfPier(Double, Double)

Predicts the pointing state after a German equatorial mount slews to given coordinates.

Declaration

PierSide GetDestinationSideOfPier(double rightAscension, double declination)

Parameters

Type	Name	Description
System.Double	rightAscension	Right Ascension coordinate (0.0 to 23.99999999 hours
System.Double	declination	Declination coordinate (-90.0 to +90.0 degrees)

Returns

Type	Description
PierSide

| Improve this Doc View Source

GetEquatorialSystem()

Returns the current equatorial coordinate system used by this telescope.

Declaration

EquatorialCoordinateType GetEquatorialSystem()

Returns

Type	Description
EquatorialCoordinateType

| Improve this Doc View Source

GetFocalLength()

Returns the telescope's focal length in meters.

Declaration

double GetFocalLength()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetGuideRateDeclination()

Returns the current Declination rate offset for telescope guiding (degrees/sec)

Declaration

double GetGuideRateDeclination()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetGuideRateRightAscension()

Returns the current Right ascension rate offset for telescope guiding (degrees/sec)

Declaration

double GetGuideRateRightAscension()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetRightAscension()

Returns the right ascension (hours) of the telescope's current equatorial coordinates, in the coordinate system given by the GetEquatorialSystem()

Declaration

double GetRightAscension()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetRightAscensionRate()

Returns the right ascension tracking rate (arcseconds per second, default = 0.0)

Declaration

double GetRightAscensionRate()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSideOfPier()

Indicates the pointing state of the mount.

Declaration

PierSide GetSideOfPier()

Returns

Type	Description
PierSide

| Improve this Doc View Source

GetSiderealTime()

Returns the local apparent sidereal time from the telescope's internal clock (hours, sidereal).

Declaration

double GetSiderealTime()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSiteElevation()

Returns the elevation above mean sea level (meters) of the site at which the telescope is located.

Declaration

double GetSiteElevation()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSiteLatitude()

Returns the latitude (degrees, positive East, WGS84) of the site at which the telescope is located.

Declaration

double GetSiteLatitude()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSiteLongitude()

Returns the longitude (degrees, positive East, WGS84) of the site at which the telescope is located.

Declaration

double GetSiteLongitude()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetSlewSettleTime()

Returns the post-slew settling time.

Declaration

int GetSlewSettleTime()

Returns

Type	Description
System.Int32

| Improve this Doc View Source

GetTargetDeclination()

Returns the declination (degrees, positive North) for the target of an equatorial slew or sync operation

Declaration

double GetTargetDeclination()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetTargetRightAscension()

Returns the right ascension (hours) for the target of an equatorial slew or sync operation

Declaration

double GetTargetRightAscension()

Returns

Type	Description
System.Double

| Improve this Doc View Source

GetTrackingRate()

Returns the current tracking rate of the telescope's sidereal drive.

Declaration

DriveRate GetTrackingRate()

Returns

Type	Description
DriveRate

| Improve this Doc View Source

GetTrackingRates()

Returns a collection of supported DriveRates values.

Declaration

IList<DriveRate> GetTrackingRates()

Returns

Type	Description
System.Collections.Generic.IList<DriveRate>

| Improve this Doc View Source

GetUtcDate()

Returns the UTC date/time of the telescope's internal clock.

Declaration

DateTime GetUtcDate()

Returns

Type	Description
System.DateTime

| Improve this Doc View Source

IsAtHome()

Indicates whether the mount is at the home position.

Declaration

bool IsAtHome()

Returns

Type	Description
System.Boolean	True if the mount is stopped in the Home position.

| Improve this Doc View Source

IsAtPark()

Indicates whether the telescope is at the park position.

Declaration

bool IsAtPark()

Returns

Type	Description
System.Boolean	True if the telescope has been put into the parked state

| Improve this Doc View Source

IsPulseGuiding()

Indicates whether the telescope is currently executing a PulseGuide command

Declaration

bool IsPulseGuiding()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsSlewing()

Indicates whether the telescope is currently slewing.

Declaration

bool IsSlewing()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsTracking()

Indicates whether the telescope is tracking.

Declaration

bool IsTracking()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

MoveAxis(TelescopeAxis, Double)

Move the telescope in one axis at the given rate.

Declaration

void MoveAxis(TelescopeAxis axis, double rate)

Parameters

Type	Name	Description
TelescopeAxis	axis	The axis about which rate information is desired
System.Double	rate	The rate of motion (deg/sec) about the specified axis

| Improve this Doc View Source

Park()

Move the telescope to its park position, stop all motion (or restrict to a small safe range), and set AtPark to True. )

Declaration

void Park()

| Improve this Doc View Source

PulseGuide(GuideDirection, Int32)

Moves the scope in the given direction for the given time.

Declaration

void PulseGuide(GuideDirection direction, int duration)

Parameters

Type	Name	Description
GuideDirection	direction	The direction in which the guide-rate motion is to be made
System.Int32	duration	The duration of the guide-rate motion (milliseconds)

| Improve this Doc View Source

SetDeclinationRate(Double)

Sets the telescope's declination tracking rate.

Declaration

void SetDeclinationRate(double declinationRate)

Parameters

Type	Name	Description
System.Double	declinationRate	Declination tracking rate (arcseconds per second)

| Improve this Doc View Source

SetDoesRefraction(Boolean)

Determines whether atmospheric refraction is applied to coordinates.

Declaration

void SetDoesRefraction(bool doesRefraction)

Parameters

Type	Name	Description
System.Boolean	doesRefraction	Set True to make the telescope or driver applie atmospheric refraction to coordinates.

| Improve this Doc View Source

SetGuideRateDeclination(Double)

Sets the current Declination movement rate offset for telescope guiding (degrees/sec).

Declaration

void SetGuideRateDeclination(double guideRate)

Parameters

Type	Name	Description
System.Double	guideRate	Declination movement rate offset degrees/sec).

| Improve this Doc View Source

SetGuideRateRightAscension(Double)

Sets the current Right ascension movement rate offset for telescope guiding (degrees/sec).

Declaration

void SetGuideRateRightAscension(double guideRate)

Parameters

Type	Name	Description
System.Double	guideRate	Right ascension movement rate offset degrees/sec).

| Improve this Doc View Source

SetPark()

Sets the telescope's park position to be its current position.

Declaration

void SetPark()

| Improve this Doc View Source

SetRightAscensionRate(Double)

Sets the right ascension tracking rate (arcseconds per second)

Declaration

void SetRightAscensionRate(double rightAscensionRate)

Parameters

Type	Name	Description
System.Double	rightAscensionRate	Right ascension tracking rate (arcseconds per second)

| Improve this Doc View Source

SetSideOfPier(PierSide)

Sets the pointing state of the mount.

Declaration

void SetSideOfPier(PierSide sideOfPier)

Parameters

Type	Name	Description
PierSide	sideOfPier	New pointing state.

| Improve this Doc View Source

SetSiteElevation(Double)

Sets the elevation above mean sea level (metres) of the site at which the telescope is located.

Declaration

void SetSiteElevation(double siteElevation)

Parameters

Type	Name	Description
System.Double	siteElevation	Elevation above mean sea level (metres).

| Improve this Doc View Source

SetSiteLatitude(Double)

Sets the observing site's latitude (degrees).

Declaration

void SetSiteLatitude(double latitude)

Parameters

Type	Name	Description
System.Double	latitude	Site latitude (degrees)

| Improve this Doc View Source

SetSiteLongitude(Double)

Sets the observing site's longitude (degrees).

Declaration

void SetSiteLongitude(double longitude)

Parameters

Type	Name	Description
System.Double	longitude	Site longitude (degrees)

| Improve this Doc View Source

SetSlewSettleTime(Int32)

Sets the post-slew settling time.

Declaration

void SetSlewSettleTime(int settleTime)

Parameters

Type	Name	Description
System.Int32	settleTime	Settle time in seconds

| Improve this Doc View Source

SetTargetDeclination(Double)

Sets the declination (degrees, positive North) for the target of an equatorial slew or sync operation

Declaration

void SetTargetDeclination(double declination)

Parameters

Type	Name	Description
System.Double	declination	Target declination (degrees, positive North)

| Improve this Doc View Source

SetTargetRightAscension(Double)

Sets the right ascension (hours) for the target of an equatorial slew or sync operation

Declaration

void SetTargetRightAscension(double rightAscension)

Parameters

Type	Name	Description
System.Double	rightAscension	Target right ascension(hours)

| Improve this Doc View Source

SetTracking(Boolean)

Enables or disables telescope tracking.

Declaration

void SetTracking(bool tracking)

Parameters

Type	Name	Description
System.Boolean	tracking	Tracking enabled / disabled

| Improve this Doc View Source

SetTrackingRate(DriveRate)

Sets the mount's tracking rate.

Declaration

void SetTrackingRate(DriveRate trackingRate)

Parameters

Type	Name	Description
DriveRate	trackingRate

| Improve this Doc View Source

SetUtcDate(DateTime)

Sets the UTC date/time of the telescope's internal clock.

Declaration

void SetUtcDate(DateTime utcDate)

Parameters

Type	Name	Description
System.DateTime	utcDate

| Improve this Doc View Source

SlewToAltAz(Double, Double)

Move the telescope to the given local horizontal coordinates, return when slew is complete

Declaration

void SlewToAltAz(double altitude, double azimuth)

Parameters

Type	Name	Description
System.Double	altitude	Altitude coordinate (degrees, positive up)
System.Double	azimuth	Azimuth coordinate (degrees, North-referenced, positive East/clockwise)

| Improve this Doc View Source

SlewToCoordinates(Double, Double)

Synchronously slew to the given equatorial coordinates.

Declaration

void SlewToCoordinates(double rightAscension, double declination)

Parameters

Type	Name	Description
System.Double	rightAscension	Right Ascension coordinate (hours)
System.Double	declination	Declination coordinate (degrees)

| Improve this Doc View Source

SlewToTarget()

Move the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return when slew is complete

Declaration

void SlewToTarget()

| Improve this Doc View Source

SyncToAltAz(Double, Double)

Matches the scope's local horizontal coordinates to the given local horizontal coordinates.

Declaration

void SyncToAltAz(double altitude, double azimuth)

Parameters

Type	Name	Description
System.Double	altitude	Altitude coordinate (degrees, positive up)
System.Double	azimuth	Azimuth coordinate (degrees, North-referenced, positive East/clockwise)

| Improve this Doc View Source

SyncToCoordinates(Double, Double)

Matches the scope's equatorial coordinates to the given equatorial coordinates.

Declaration

void SyncToCoordinates(double rightAscension, double declination)

Parameters

Type	Name	Description
System.Double	rightAscension	Right Ascension coordinate (hours)
System.Double	declination	Declination coordinate (degrees)

| Improve this Doc View Source

SyncToTarget()

Matches the scope's equatorial coordinates to the TargetRightAscension and TargetDeclination equatorial coordinates.

Declaration

void SyncToTarget()

| Improve this Doc View Source

Unpark()

Unparks the mount.

Declaration

void Unpark()