Click or drag to resize

ITelescopeV3 Interface

Defines the ITelescope Interface

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
public interface ITelescopeV3

The ITelescopeV3 type exposes the following members.

Properties
  NameDescription
Public propertyAlignmentMode
The alignment mode of the mount (Alt/Az, Polar, German Polar).
Public propertyAltitude
The Altitude above the local horizon of the telescope's current position (degrees, positive up)
Public propertyApertureArea
The area of the telescope's aperture, taking into account any obstructions (square meters)
Public propertyApertureDiameter
The telescope's effective aperture diameter (meters)
Public propertyAtHome
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.
Public propertyAtPark
True if the telescope has been put into the parked state by the seee Park method. Set False by calling the Unpark() method.
Public propertyAzimuth
The azimuth at the local horizon of the telescope's current position (degrees, North-referenced, positive East/clockwise).
Public propertyCanFindHome
True if this telescope is capable of programmed finding its home position (FindHome method).
Public propertyCanPark
True if this telescope is capable of programmed parking (Parkmethod)
Public propertyCanPulseGuide
True if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirections, Int32) method)
Public propertyCanSetDeclinationRate
True if the DeclinationRate property can be changed to provide offset tracking in the declination axis.
Public propertyCanSetGuideRates
True if the guide rate properties used for PulseGuide(GuideDirections, Int32) can ba adjusted.
Public propertyCanSetPark
True if this telescope is capable of programmed setting of its park position (SetPark method)
Public propertyCanSetPierSide
True if the SideOfPier property can be set, meaning that the mount can be forced to flip.
Public propertyCanSetRightAscensionRate
True if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis.
Public propertyCanSetTracking
True if the Tracking property can be changed, turning telescope sidereal tracking on and off.
Public propertyCanSlew
True if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates
Public propertyCanSlewAltAz
True if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates
Public propertyCanSlewAltAzAsync
True if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates
Public propertyCanSlewAsync
True if this telescope is capable of programmed asynchronous slewing to equatorial coordinates.
Public propertyCanSync
True if this telescope is capable of programmed synching to equatorial coordinates.
Public propertyCanSyncAltAz
True if this telescope is capable of programmed synching to local horizontal coordinates
Public propertyCanUnpark
True if this telescope is capable of programmed unparking (Unpark method).
Public propertyConnected
Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state.
Public propertyDeclination
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.
Public propertyDeclinationRate
The declination tracking rate (arcseconds per SI second, default = 0.0)
Public propertyDescription
Returns a description of the device, such as manufacturer and modelnumber. Any ASCII characters may be used.
Public propertyDoesRefraction
True if the telescope or driver applies atmospheric refraction to coordinates.
Public propertyDriverInfo
Descriptive and version information about this ASCOM driver.
Public propertyDriverVersion
A string containing only the major and minor version of the driver.
Public propertyEquatorialSystem
Equatorial coordinate system used by this telescope (e.g. Topocentric or J2000).
Public propertyFocalLength
The telescope's focal length, meters
Public propertyGuideRateDeclination
The current Declination movement rate offset for telescope guiding (degrees/sec)
Public propertyGuideRateRightAscension
The current Right Ascension movement rate offset for telescope guiding (degrees/sec)
Public propertyInterfaceVersion
The interface version number that this device supports. Should return 3 for this interface version.
Public propertyIsPulseGuiding
True if a PulseGuide(GuideDirections, Int32) command is in progress, False otherwise
Public propertyName
The short name of the driver, for display purposes
Public propertyRightAscension
The right ascension (hours) of the telescope's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property
Public propertyRightAscensionRate
The right ascension tracking rate offset from sidereal (seconds per sidereal second, default = 0.0)
Public propertySideOfPier
Indicates the pointing state of the mount.
Public propertySiderealTime
The local apparent sidereal time from the telescope's internal clock (hours, sidereal)
Public propertySiteElevation
The elevation above mean sea level (meters) of the site at which the telescope is located
Public propertySiteLatitude
The geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located.
Public propertySiteLongitude
The longitude (degrees, positive East, WGS84) of the site at which the telescope is located.
Public propertySlewing
True if telescope is in the process of moving in response to one of the Slew methods or the MoveAxis(TelescopeAxes, Double) method, False at all other times.
Public propertySlewSettleTime
Specifies a post-slew settling time (sec.).
Public propertySupportedActions
Returns the list of custom action names supported by this driver.
Public propertyTargetDeclination
The declination (degrees, positive North) for the target of an equatorial slew or sync operation
Public propertyTargetRightAscension
The right ascension (hours) for the target of an equatorial slew or sync operation
Public propertyTracking
The state of the telescope's sidereal tracking drive.
Public propertyTrackingRate
The current tracking rate of the telescope's sidereal drive
Public propertyTrackingRates
Returns a collection of supported DriveRates values that describe the permissible values of the TrackingRate property for this telescope type.
Public propertyUTCDate
The UTC date/time of the telescope's internal clock
Top
Methods
  NameDescription
Public methodAbortSlew
Stops a slew in progress.
Public methodAction
Invokes the specified device-specific custom action.
Public methodAxisRates
Determine the rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method.
Public methodCanMoveAxis
True if this telescope can move the requested axis
Public methodCommandBlind
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.
Public methodCommandBool
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.
Public methodCommandString
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.
Public methodDestinationSideOfPier
Predict side of pier for German equatorial mounts
Public methodDispose
Dispose the late-bound interface, if needed. Will release it via COM if it is a COM object, else if native .NET will just dereference it for GC.
Public methodFindHome
Locates the telescope's "home" position (synchronous)
Public methodMoveAxis
Move the telescope in one axis at the given rate.
Public methodPark
Move the telescope to its park position, stop all motion (or restrict to a small safe range), and set AtPark to True.
Public methodPulseGuide
Moves the scope in the given direction for the given interval or time at the rate given by the corresponding guide rate property
Public methodSetPark
Sets the telescope's park position to be its current position.
Public methodSetupDialog
Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Public methodSlewToAltAz
Move the telescope to the given local horizontal coordinates, return when slew is complete
Public methodSlewToAltAzAsync
This Method must be implemented if CanSlewAltAzAsync returns True. It returns immediately, with Slewing set to True
Public methodSlewToCoordinates
Move the telescope to the given equatorial coordinates, return when slew is complete It does not return to the caller until the slew is complete.
Public methodSlewToCoordinatesAsync
Move the telescope to the given equatorial coordinates and return with Slewing set to True immediately after starting the slew.
Public methodSlewToTarget
Move the telescope to the TargetRightAscension and TargetDeclination coordinates, return when slew complete.
Public methodSlewToTargetAsync
Move the telescope to the TargetRightAscension and TargetDeclination coordinates, returns immediately after starting the slew with Slewing set to True.
Public methodSyncToAltAz
Matches the scope's local horizontal coordinates to the given local horizontal coordinates.
Public methodSyncToCoordinates
Matches the scope's equatorial coordinates to the given equatorial coordinates.
Public methodSyncToTarget
Matches the scope's equatorial coordinates to the target equatorial coordinates.
Public methodUnpark
Takes telescope out of the Parked state.
Top
See Also