Interface ITelescopeAsync

Defines the capabilities supported by an ASCOM Alpaca Telescope device

Inherited Members
Namespace: ES.Ascom.Alpaca.Devices
Assembly: ES.Ascom.Alpaca.Shared.dll
Syntax
public interface ITelescopeAsync : IDeviceAsync

Methods

| Improve this Doc View Source

AbortSlewAsync()

Immediately stops a slew in progress.

Declaration
Task AbortSlewAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

CanFindHomeAsync()

Indicates whether the mount can find the home position.

Declaration
Task<bool> CanFindHomeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanMoveAxisAsync(TelescopeAxis)

Indicates whether the telescope can move the requested axis.

Declaration
Task<bool> CanMoveAxisAsync(TelescopeAxis axis)
Parameters
Type Name Description
TelescopeAxis axis

The axis about which rate information is desired.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanParkAsync()

Indicates whether the telescope can be parked.

Declaration
Task<bool> CanParkAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanPulseGuideAsync()

ndicates whether the telescope can be pulse guided.

Declaration
Task<bool> CanPulseGuideAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetDeclinationRateAsync()

Indicates whether the DeclinationRate property can be changed.

Declaration
Task<bool> CanSetDeclinationRateAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetGuideRatesAsync()

Indicates whether the DeclinationRate property can be changed.

Declaration
Task<bool> CanSetGuideRatesAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetParkAsync()

Indicates whether the telescope park position can be set.

Declaration
Task<bool> CanSetParkAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetPierSideAsync()

Indicates whether the telescope SideOfPier can be set.

Declaration
Task<bool> CanSetPierSideAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetRightAscensionRateAsync()

Indicates whether the RightAscensionRate property can be changed.

Declaration
Task<bool> CanSetRightAscensionRateAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetTrackingAsync()

Indicates whether the Tracking property can be changed.

Declaration
Task<bool> CanSetTrackingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSlewAltAzAsync()

Indicates whether the telescope can slew synchronously to AltAz coordinates.

Declaration
Task<bool> CanSlewAltAzAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSlewAsync()

Indicates whether the telescope can slew synchronously.

Declaration
Task<bool> CanSlewAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSyncAltAzAsync()

Indicates whether the telescope can sync to local horizontal coordinates.

Declaration
Task<bool> CanSyncAltAzAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSyncAsync()

Indicates whether the telescope can sync to equatorial coordinates.

Declaration
Task<bool> CanSyncAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

DoesRefractionAsync()

Indicates whether atmospheric refraction is applied to coordinates.

Declaration
Task<bool> DoesRefractionAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

FindHomeAsync()

Moves the mount to the "home" position.

Declaration
Task FindHomeAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

GetAlignmentModeAsync()

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

Declaration
Task<AlignmentMode> GetAlignmentModeAsync()
Returns
Type Description
System.Threading.Tasks.Task<AlignmentMode>
| Improve this Doc View Source

GetAltitudeAsync()

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

Declaration
Task<double> GetAltitudeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetApertureAreaAsync()

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

Declaration
Task<double> GetApertureAreaAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetApertureDiameterAsync()

Returns the telescope's effective aperture diameter (meters)

Declaration
Task<double> GetApertureDiameterAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetAxisRatesAsync(TelescopeAxis)

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

Declaration
Task<IList<AxisRate>> GetAxisRatesAsync(TelescopeAxis axis)
Parameters
Type Name Description
TelescopeAxis axis

The axis about which rate information is desired
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<AxisRate>>
| Improve this Doc View Source

GetAzimuthAsync()

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

Declaration
Task<double> GetAzimuthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetDeclinationAsync()

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

Declaration
Task<double> GetDeclinationAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetDeclinationRateAsync()

Returns the telescope's declination tracking rate.

Declaration
Task<double> GetDeclinationRateAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

The declination tracking rate (arcseconds per second, default = 0.0)
| Improve this Doc View Source

GetDestinationSideOfPierAsync(Double, Double)

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

Declaration
Task<PierSide> GetDestinationSideOfPierAsync(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
System.Threading.Tasks.Task<PierSide>
| Improve this Doc View Source

GetEquatorialSystemAsync()

Returns the current equatorial coordinate system used by this telescope.

Declaration
Task<EquatorialCoordinateType> GetEquatorialSystemAsync()
Returns
Type Description
System.Threading.Tasks.Task<EquatorialCoordinateType>
| Improve this Doc View Source

GetFocalLengthAsync()

Returns the telescope's focal length in meters.

Declaration
Task<double> GetFocalLengthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetGuideRateDeclinationAsync()

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

Declaration
Task<double> GetGuideRateDeclinationAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetGuideRateRightAscensionAsync()

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

Declaration
Task<double> GetGuideRateRightAscensionAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetRightAscensionAsync()

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

Declaration
Task<double> GetRightAscensionAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetRightAscensionRateAsync()

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

Declaration
Task<double> GetRightAscensionRateAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetSideOfPierAsync()

Indicates the pointing state of the mount.

Declaration
Task<PierSide> GetSideOfPierAsync()
Returns
Type Description
System.Threading.Tasks.Task<PierSide>
| Improve this Doc View Source

GetSiderealTimeAsync()

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

Declaration
Task<double> GetSiderealTimeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetSiteElevationAsync()

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

Declaration
Task<double> GetSiteElevationAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetSiteLatitudeAsync()

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

Declaration
Task<double> GetSiteLatitudeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetSiteLongitudeAsync()

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

Declaration
Task<double> GetSiteLongitudeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetSlewSettleTimeAsync()

Returns the post-slew settling time.

Declaration
Task<int> GetSlewSettleTimeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

GetTargetDeclinationAsync()

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

Declaration
Task<double> GetTargetDeclinationAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetTargetRightAscensionAsync()

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

Declaration
Task<double> GetTargetRightAscensionAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

GetTrackingRateAsync()

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

Declaration
Task<DriveRate> GetTrackingRateAsync()
Returns
Type Description
System.Threading.Tasks.Task<DriveRate>
| Improve this Doc View Source

GetTrackingRatesAsync()

Returns a collection of supported DriveRates values.

Declaration
Task<IList<DriveRate>> GetTrackingRatesAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<DriveRate>>
| Improve this Doc View Source

GetUtcDateAsync()

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

Declaration
Task<DateTime> GetUtcDateAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.DateTime>
| Improve this Doc View Source

IsAtHomeAsync()

Indicates whether the mount is at the home position.

Declaration
Task<bool> IsAtHomeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if the mount is stopped in the Home position.
| Improve this Doc View Source

IsAtParkAsync()

Indicates whether the telescope is at the park position.

Declaration
Task<bool> IsAtParkAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if the telescope has been put into the parked state
| Improve this Doc View Source

IsPulseGuidingAsync()

Indicates whether the telescope is currently executing a PulseGuide command

Declaration
Task<bool> IsPulseGuidingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

IsSlewingAsync()

Indicates whether the telescope is currently slewing.

Declaration
Task<bool> IsSlewingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

IsTrackingAsync()

Indicates whether the telescope is tracking.

Declaration
Task<bool> IsTrackingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

MoveAxisAsync(TelescopeAxis, Double)

Move the telescope in one axis at the given rate.

Declaration
Task MoveAxisAsync(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
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

ParkAsync()

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

Declaration
Task ParkAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

PulseGuideAsync(GuideDirection, Int32)

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

Declaration
Task PulseGuideAsync(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)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetDeclinationRateAsync(Double)

Sets the telescope's declination tracking rate.

Declaration
Task SetDeclinationRateAsync(double declinationRate)
Parameters
Type Name Description
System.Double declinationRate

Declination tracking rate (arcseconds per second)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetDoesRefractionAsync(Boolean)

Determines whether atmospheric refraction is applied to coordinates.

Declaration
Task SetDoesRefractionAsync(bool doesRefraction)
Parameters
Type Name Description
System.Boolean doesRefraction

Set True to make the telescope or driver applie atmospheric refraction to coordinates.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetGuideRateDeclinationAsync(Double)

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

Declaration
Task SetGuideRateDeclinationAsync(double guideRate)
Parameters
Type Name Description
System.Double guideRate

Declination movement rate offset degrees/sec).
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetGuideRateRightAscensionAsync(Double)

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

Declaration
Task SetGuideRateRightAscensionAsync(double guideRate)
Parameters
Type Name Description
System.Double guideRate

Right ascension movement rate offset degrees/sec).
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetParkAsync()

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

Declaration
Task SetParkAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetRightAscensionRateAsync(Double)

Sets the right ascension tracking rate (arcseconds per second)

Declaration
Task SetRightAscensionRateAsync(double rightAscensionRate)
Parameters
Type Name Description
System.Double rightAscensionRate

Right ascension tracking rate (arcseconds per second)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetSideOfPierAsync(PierSide)

Sets the pointing state of the mount.

Declaration
Task SetSideOfPierAsync(PierSide sideOfPier)
Parameters
Type Name Description
PierSide sideOfPier

New pointing state.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetSiteElevationAsync(Double)

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

Declaration
Task SetSiteElevationAsync(double siteElevation)
Parameters
Type Name Description
System.Double siteElevation

Elevation above mean sea level (metres).
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetSiteLatitudeAsync(Double)

Sets the observing site's latitude (degrees).

Declaration
Task SetSiteLatitudeAsync(double latitude)
Parameters
Type Name Description
System.Double latitude

Site latitude (degrees)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetSiteLongitudeAsync(Double)

Sets the observing site's longitude (degrees).

Declaration
Task SetSiteLongitudeAsync(double longitude)
Parameters
Type Name Description
System.Double longitude

Site longitude (degrees)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetSlewSettleTimeAsync(Int32)

Sets the post-slew settling time.

Declaration
Task SetSlewSettleTimeAsync(int settleTime)
Parameters
Type Name Description
System.Int32 settleTime

Settle time in seconds
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetTargetDeclinationAsync(Double)

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

Declaration
Task SetTargetDeclinationAsync(double declination)
Parameters
Type Name Description
System.Double declination

Target declination (degrees, positive North)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetTargetRightAscensionAsync(Double)

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

Declaration
Task SetTargetRightAscensionAsync(double rightAscension)
Parameters
Type Name Description
System.Double rightAscension

Target right ascension(hours)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetTrackingAsync(Boolean)

Enables or disables telescope tracking.

Declaration
Task SetTrackingAsync(bool tracking)
Parameters
Type Name Description
System.Boolean tracking

Tracking enabled / disabled
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetTrackingRateAsync(DriveRate)

Sets the mount's tracking rate.

Declaration
Task SetTrackingRateAsync(DriveRate trackingRate)
Parameters
Type Name Description
DriveRate trackingRate
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetUtcDateAsync(DateTime)

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

Declaration
Task SetUtcDateAsync(DateTime utcDate)
Parameters
Type Name Description
System.DateTime utcDate
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SlewToAltAzAsync(Double, Double)

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

Declaration
Task SlewToAltAzAsync(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)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SlewToCoordinatesAsync(Double, Double)

Synchronously slew to the given equatorial coordinates.

Declaration
Task SlewToCoordinatesAsync(double rightAscension, double declination)
Parameters
Type Name Description
System.Double rightAscension

Right Ascension coordinate (hours)
System.Double declination

Declination coordinate (degrees)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SlewToTargetAsync()

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

Declaration
Task SlewToTargetAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SyncToAltAzAsync(Double, Double)

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

Declaration
Task SyncToAltAzAsync(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)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SyncToCoordinatesAsync(Double, Double)

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

Declaration
Task SyncToCoordinatesAsync(double rightAscension, double declination)
Parameters
Type Name Description
System.Double rightAscension

Right Ascension coordinate (hours)
System.Double declination

Declination coordinate (degrees)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SyncToTargetAsync()

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

Declaration
Task SyncToTargetAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

UnparkAsync()

Unparks the mount.

Declaration
Task UnparkAsync()
Returns
Type Description
System.Threading.Tasks.Task

See Also