AlpacaTelescope Class

ASCOM Alpaca Telescope client

Definition

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class AlpacaTelescope : AlpacaDeviceBaseClass, 
	ITelescopeV4, IAscomDeviceV2, IAscomDevice, ITelescopeV3
Inheritance
Object    AlpacaDeviceBaseClass    AlpacaTelescope
Implements
IAscomDevice, IAscomDeviceV2, ITelescopeV3, ITelescopeV4

Constructors

AlpacaTelescope Create a client for an Alpaca Telescope device with all parameters set to default values
AlpacaTelescope(AlpacaConfiguration) Initializes a new instance of the AlpacaCamera class using the specified configuration settings.
AlpacaTelescope(ServiceType, String, Int32, Int32, Boolean, ILogger) Create a client for an Alpaca Telescope device specifying the minimum number of parameters
AlpacaTelescope(ServiceType, String, Int32, Int32, Int32, Int32, Int32, UInt32, String, String, Boolean, ILogger, String, String, Boolean, Boolean, Boolean) Create an Alpaca Telescope device specifying all parameters

Properties

AlignmentMode The alignment mode of the mount (Alt/Az, Polar, German Polar).
Altitude The Altitude above the local horizon of the telescope's current position (degrees, positive up)
ApertureArea The area of the telescope's aperture, taking into account any obstructions (square meters)
ApertureDiameter The telescope's effective aperture diameter (meters)
AtHome True if the telescope is stopped in the Home position. Set only following a FindHome operation, and reset with any slew operation. This property must be False if the telescope does not support homing.
AtPark True if the telescope has been put into the parked state by the see Park method. Set False by calling the Unpark() method.
Azimuth The azimuth at the local horizon of the telescope's current position (degrees, North-referenced, positive East/clockwise).
CanFindHome True if this telescope is capable of programmed finding its home position (FindHome method).
CanPark True if this telescope is capable of programmed parking (Parkmethod)
CanPulseGuide True if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirection, Int32) method)
CanSetDeclinationRate True if the DeclinationRate property can be changed to provide offset tracking in the declination axis.
CanSetGuideRates True if the guide rate properties used for PulseGuide(GuideDirection, Int32) can be adjusted.
CanSetPark True if this telescope is capable of programmed setting of its park position (SetPark method)
CanSetPierSide True if the SideOfPier property can be set, meaning that the mount can be forced to flip.
CanSetRightAscensionRate True if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis.
CanSetTracking True if the Tracking property can be changed, turning telescope sidereal tracking on and off.
CanSlew True if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates
CanSlewAltAz True if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates
CanSlewAltAzAsync True if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates
CanSlewAsync True if this telescope is capable of programmed asynchronous slewing to equatorial coordinates.
CanSync True if this telescope is capable of programmed synching to equatorial coordinates.
CanSyncAltAz True if this telescope is capable of programmed synching to local horizontal coordinates
CanUnpark True if this telescope is capable of programmed unparking (Unpark method).
ClientConfiguration Provide access to the client configuration
(Inherited from AlpacaDeviceBaseClass)
Connected Set True to enable the link. Set False to disable the link. You can also read the property to check whether it is connected.
(Inherited from AlpacaDeviceBaseClass)
Connecting Completion variable for asynchronous connect and disconnect operations
(Inherited from AlpacaDeviceBaseClass)
Declination The declination (degrees) of the telescope's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property. Reading the property will raise an error if the value is unavailable.
DeclinationRate The declination tracking rate (arcseconds per SI second, default = 0.0)
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from AlpacaDeviceBaseClass)
DeviceState Returns the device's operational state in a single call
(Inherited from AlpacaDeviceBaseClass)
DoesRefraction True if the telescope or driver applies atmospheric refraction to coordinates.
DriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from AlpacaDeviceBaseClass)
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from AlpacaDeviceBaseClass)
EquatorialSystem Equatorial coordinate system used by this telescope (e.g. Topocentric or J2000).
FocalLength The telescope's focal length, meters
GuideRateDeclination The current Declination movement rate offset for telescope guiding (degrees/sec)
GuideRateRightAscension The current Right Ascension movement rate offset for telescope guiding (degrees/sec)
InterfaceVersion The interface version number that this device implements.
(Inherited from AlpacaDeviceBaseClass)
IsPulseGuiding True if a PulseGuide(GuideDirection, Int32) command is in progress, False otherwise
Name The short name of the driver, for display purposes
(Inherited from AlpacaDeviceBaseClass)
RightAscension The right ascension (hours) of the telescope's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property
RightAscensionRate The right ascension tracking rate offset from sidereal (seconds per sidereal second, default = 0.0)
SideOfPier Indicates the pointing state of the mount.
SiderealTime The local apparent sidereal time from the telescope's internal clock (hours, sidereal)
SiteElevation The elevation above mean sea level (meters) of the site at which the telescope is located
SiteLatitude The geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located.
SiteLongitude The longitude (degrees, positive East, WGS84) of the site at which the telescope is located.
Slewing True if telescope is currently moving in response to one of the Slew methods or the MoveAxis(TelescopeAxis, Double) method, False at all other times.
SlewSettleTime Specifies a post-slew settling time (sec.).
SupportedActions Returns the list of action names supported by this driver.
(Inherited from AlpacaDeviceBaseClass)
TargetDeclination The declination (degrees, positive North) for the target of an equatorial slew or sync operation
TargetRightAscension The right ascension (hours) for the target of an equatorial slew or sync operation
TelescopeState State response from the device
Tracking The state of the telescope's sidereal tracking drive.
TrackingRate The current tracking rate of the telescope's sidereal drive
TrackingRates Returns a collection of supported DriveRate values that describe the permissible values of the TrackingRate property for this telescope type.
UTCDate The UTC date/time of the telescope's internal clock

Methods

AbortSlew Stops a slew in progress.
Action Invokes the specified device-specific action.
(Inherited from AlpacaDeviceBaseClass)
AxisRates Determine the rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxis, Double) method.
CanMoveAxis True if this telescope can move the requested axis
CommandBlind Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AlpacaDeviceBaseClass)
CommandBool Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AlpacaDeviceBaseClass)
CommandString Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AlpacaDeviceBaseClass)
Connect Connect to device asynchronously
(Inherited from AlpacaDeviceBaseClass)
DestinationSideOfPier Predict side of pier for German equatorial mounts
Disconnect Disconnect from device asynchronously
(Inherited from AlpacaDeviceBaseClass)
Dispose This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method.
(Inherited from AlpacaDeviceBaseClass)
FindHome Locates the telescope's "home" position
MoveAxis Move the telescope in one axis at the given rate.
Park Move the telescope to its park position, stop all motion (or restrict to a small safe range), and set AtPark to True.
PulseGuide Moves the scope in the given direction for the given interval or time at the rate given by the corresponding guide rate property
RefreshClient Updates the internal HTTP client with a new instance.
(Inherited from AlpacaDeviceBaseClass)
SetPark Sets the telescope's park position to be its current position.
SlewToAltAz Move the telescope to the given local horizontal coordinates, return when slew is complete
SlewToAltAzAsync This Method must be implemented if CanSlewAltAzAsync returns True.
SlewToCoordinates Move the telescope to the given equatorial coordinates, return when slew is complete
SlewToCoordinatesAsync Move the telescope to the given equatorial coordinates, return immediately after starting the slew.
SlewToTarget Move the telescope to the TargetRightAscension and TargetDeclination coordinates, return when slew complete.
SlewToTargetAsync Move the telescope to the TargetRightAscension and TargetDeclination coordinates, returns immediately after starting the slew.
SyncToAltAz Matches the scope's local horizontal coordinates to the given local horizontal coordinates.
SyncToCoordinates Matches the scope's equatorial coordinates to the given equatorial coordinates.
SyncToTarget Matches the scope's equatorial coordinates to the given equatorial coordinates.
Unpark Takes telescope out of the Parked state.

Extension Methods

AbortSlewAsync Returns an awaitable, running, Task that stops telescope slewing movement
(Defined by ClientExtensions)
ConnectAsync Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
DisconnectAsync Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
FindHomeAsync Returns an awaitable, running, Task that moves the telescope to the home position
(Defined by ClientExtensions)
ParkAsync Returns an awaitable, running, Task that parks the telescope
(Defined by ClientExtensions)
SlewToAltAzTaskAsync Returns an awaitable, running, Task that slews the telescope to the specified altitude / azimuth coordinates
(Defined by ClientExtensions)
SlewToCoordinatesTaskAsync Returns an awaitable, running, Task that slews the telescope to the specified RA/Dec coordinates
(Defined by ClientExtensions)
SlewToTargetTaskAsync Returns an awaitable, running, Task that slews the telescope to the coordinates specified by the TargetRA and TargetDeclination properties
(Defined by ClientExtensions)
UnparkAsync Returns an awaitable, running, Task that un-parks the telescope
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also