User:Arlen22/Ascom/DeviceInterfaces

ASCOM.DeviceInterfaces

ISafetyMonitor edit

Defines the ISafetyMonitor Interface

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether it is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used.
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 1 for this interface version.
Name The short name of the driver, for display purposes
SupportedActions Returns the list of action names supported by this driver. This is only available for telescope InterfaceVersion 3
IsSafe Indicates whether the monitored state is safe for use.

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.


IRotatorV2 edit

Defines the IRotator Interface

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether it is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used.
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 2 for this interface version.
Name The short name of the driver, for display purposes
SupportedActions Returns the list of action names supported by this driver.
CanReverse Indicates whether the Rotator supports the IRotatorV2.Reverse method.
IsMoving Indicates whether the rotator is currently moving
Position Current instantaneous Rotator position, in degrees.
Reverse Sets or Returns the rotator’s Reverse state.
StepSize The minimum StepSize, in degrees.
TargetPosition The destination position angle for Move() and MoveAbsolute().

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.
Halt Immediately stop any Rotator motion due to a previous IRotatorV2.Move() or IRotatorV2.MoveAbsolute() method call.
Move Causes the rotator to move Position degrees relative to the current IRotatorV2.Position value.
  • Position: Relative position to move in degrees from current IRotatorV2.Position.
MoveAbsolute Causes the rotator to move the absolute position of IRotatorV2.Position degrees.
  • Position: Absolute position in degrees.


IRate edit

Describes a range of rates supported by the ITelescopeV3.MoveAxis() method (degrees/per second) These are contained within an IAxisRates collection and serve to describe one or more supported ranges of rates of motion about a mechanical axis. It is possible that the IRate.Maximum and IRate.Minimum properties will be equal. In this case, the IRate object expresses a single discrete rate. Both the IRate.Minimum and IRate.Maximum properties are always expressed in units of degrees per second. This is only using for Telescope InterfaceVersions 2 and 3

Properties edit

Name Description
Maximum The maximum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.
Minimum The minimum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.

Methods edit

Method Summary Params
Dispose 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.


IFilterWheelV2 edit

Defines the IFilterWheel Interface

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether it is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used.
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 2 for this interface version.
Name The short name of the driver, for display purposes
SupportedActions Returns the list of action names supported by this driver.
FocusOffsets Focus offset of each filter in the wheel
Names Name of each filter in the wheel
Position Sets or returns the current filter wheel position

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.


ICameraV2 edit

Defines the ICamera Interface

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether it is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used. For Camera devices, the string shall not exceed 68 characters (for compatibility with FITS headers).
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 2 for this interface version.
Name The short name of the driver, for display purposes. This is only available for the Camera Interface Version 2
SupportedActions Returns the list of action names supported by this driver.
BinX Sets the binning factor for the X axis, also returns the current value.
BinY Sets the binning factor for the Y axis, also returns the current value.
CameraState Returns the current camera operational state
CameraXSize Returns the width of the CCD camera chip in unbinned pixels.
CameraYSize Returns the height of the CCD camera chip in unbinned pixels.
CanAbortExposure Returns True if the camera can abort exposures; False if not.
CanAsymmetricBin Returns a flag showing whether this camera supports asymmetric binning
CanGetCoolerPower If True, the camera's cooler power setting can be read.
CanPulseGuide Returns a flag indicating whether this camera supports pulse guiding
CanSetCCDTemperature Returns a flag indicatig whether this camera supports setting the CCD temperature
CanStopExposure Returns a flag indicating whether this camera can stop an exposure that is in progress
CCDTemperature Returns the current CCD temperature in degrees Celsius.
CoolerOn Turns on and off the camera cooler, and returns the current on/off state.
CoolerPower Returns the present cooler power level, in percent.
ElectronsPerADU Returns the gain of the camera in photoelectrons per A/D unit.
FullWellCapacity Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.)
HasShutter Returns a flag indicating whether this camera has a mechanical shutter
HeatSinkTemperature Returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius.
ImageArray Returns a safearray of int of size ICameraV2.NumX * ICameraV2.NumY containing the pixel values from the last exposure.
ImageArrayVariant Returns a safearray of Variant of size ICameraV2.NumX * ICameraV2.NumY containing the pixel values from the last exposure.
ImageReady Returns a flag indicating whether the image is ready to be downloaded fom the camera
IsPulseGuiding Returns a flag indicating whether the camera is currrently in a ICameraV2.PulseGuide() operation.
LastExposureDuration Reports the actual exposure duration in seconds (i.e. shutter open time).
LastExposureStartTime Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format.
MaxADU Reports the maximum ADU value the camera can produce.
MaxBinX Returns the maximum allowed binning for the X camera axis
MaxBinY Returns the maximum allowed binning for the Y camera axis
NumX Sets the subframe width. Also returns the current value.
NumY Sets the subframe height. Also returns the current value.
PixelSizeX Returns the width of the CCD chip pixels in microns.
PixelSizeY Returns the height of the CCD chip pixels in microns.
SetCCDTemperature Sets the camera cooler setpoint in degrees Celsius, and returns the current setpoint.
StartX Sets the subframe start position for the X axis (0 based) and returns the current value.
StartY Sets the subframe start position for the Y axis (0 based). Also returns the current value.
BayerOffsetX Bayer X offset index
BayerOffsetY Returns the Y offset of the Bayer matrix, as defined in ICameraV2.SensorType.
CanFastReadout Camera has a fast readout mode
ExposureMax Returns the maximum exposure time supported by ICameraV2.StartExposure().
ExposureMin Minimium exposure time
ExposureResolution Exposure resolution
FastReadout Gets or sets Fast Readout Mode
Gain Index into the ICameraV2.Gains array for the selected camera gain
GainMax Maximum value of ICameraV2.Gain
GainMin Minimum value of ICameraV2.Gain
Gains Gains supported by the camera
PercentCompleted Percent conpleted, Interface Version 2 only
ReadoutMode Readout mode, Interface Version 2 only
ReadoutModes List of available readout modes, Interface Version 2 only
SensorName Sensor name, Interface Version 2 only
SensorType Type of colour information returned by the the camera sensor, Interface Version 2 only

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.
AbortExposure Aborts the current exposure, if any, and returns the camera to Idle state.
PulseGuide Activates the Camera's mount control sytem to instruct the mount to move in a particular direction for a given period of time
  • Direction: The direction.
  • Duration: The duration.
StartExposure Starts an exposure. Use ICameraV2.ImageReady to check when the exposure is complete.
  • Duration: Duration of exposure in seconds, can be zero if ICameraV2.StartExposure() is false
  • Light: True for light frame, False for dark frame (ignored if no shutter)
StopExposure Stops the current exposure, if any.


IFocuserV2 edit

Provides universal access to Focuser drivers

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether it is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used.
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 2 for this interface version.
Name The short name of the driver, for display purposes
SupportedActions Returns the list of action names supported by this driver.
Absolute True if the focuser is capable of absolute position; that is, being commanded to a specific step location.
IsMoving True if the focuser is currently moving to a new position. False if the focuser is stationary.
Link State of the connection to the focuser.
MaxIncrement Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.
MaxStep Maximum step position permitted.
Position Current focuser position, in steps.
StepSize Step size (microns) for the focuser.
TempComp The state of temperature compensation mode (if available), else always False.
TempCompAvailable True if focuser has temperature compensation available.
Temperature Current ambient temperature as measured by the focuser.

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.
Halt Immediately stop any focuser motion due to a previous IFocuserV2.Move() method call.
Move Moves the focuser by the specified amount or to the specified position depending on the value of the IFocuserV2.Absolute property.
  • Position: Step distance or absolute position, depending on the value of the IFocuserV2.Absolute property.


ITrackingRates edit

Returns a collection of supported DriveRate values that describe the permissible values of the TrackingRate property for this telescope type.

Properties edit

Name Description
Item(System.Int32) Returns a specified item from the collection
Count Number of DriveRates supported by the Telescope

Methods edit

Method Summary Params
GetEnumerator Returns an enumerator for the collection
Dispose Disposes of the TrackingRates object


AlignmentModes edit

The alignment mode of the mount.

Fields edit

Name Description
algAltAz Altitude-Azimuth alignment.
algPolar Polar (equatorial) mount other than German equatorial.
algGermanPolar German equatorial mount.


DriveRates edit

Well-known telescope tracking rates.

Fields edit

Name Description
driveSidereal Sidereal tracking rate (15.0 arcseconds per sidereal second).
driveLunar Lunar tracking rate (14.685 arcseconds per second).
driveSolar Solar tracking rate (15.0 arcseconds per second).
driveKing King tracking rate (15.0369 arcseconds per second).


EquatorialCoordinateType edit

Equatorial coordinate systems used by telescopes. Only used with telescope interface versions 2 and 3

Fields edit

Name Description
equOther Custom or unknown equinox and/or reference frame.
equLocalTopocentric Local topocentric; this is the most common for amateur telescopes.
equJ2000 J2000 equator/equinox, ICRS reference frame.
equJ2050 J2050 equator/equinox, ICRS reference frame.
equB1950 B1950 equinox, FK4 reference frame.


GuideDirections edit

The direction in which the guide-rate motion is to be made.

Fields edit

Name Description
guideNorth North (+ declination/altitude).
guideSouth South (- declination/altitude).
guideEast East (+ right ascension/azimuth).
guideWest West (- right ascension/azimuth)


TelescopeAxes edit

The telescope axes Only used with if the telescope interface version is 2 or 3

Fields edit

Name Description
axisPrimary Primary axis (e.g., Right Ascension or Azimuth).
axisSecondary Secondary axis (e.g., Declination or Altitude).
axisTertiary Tertiary axis (e.g. imager rotator/de-rotator).


PierSide edit

The pointing state of the mount

Fields edit

Name Description
pierEast Normal pointing state
pierUnknown Unknown or indeterminate.
pierWest Through the pole pointing state


ShutterState edit

ASCOM Dome ShutterState status values.

Fields edit

Name Description
shutterOpen Dome shutter status open
shutterClosed Dome shutter status closed
shutterOpening Dome shutter status opening
shutterClosing Dome shutter status closing
shutterError Dome shutter status error


CameraStates edit

ASCOM Camera status values.

Fields edit

Name Description
cameraIdle Camera status idle
cameraWaiting Camera status waiting
cameraExposing Camera status exposing
cameraReading Camera status reading
cameraDownload Camera status download
cameraError Camera status error


SensorType edit

Sensor type, identifies the type of colour sensor V2 cameras only

Fields edit

Name Description
Monochrome Camera produces monochrome array with no Bayer encoding
Color Camera produces color image directly, requiring not Bayer decoding
RGGB Camera produces RGGB encoded Bayer array images
CMYG Camera produces CMYG encoded Bayer array images
CMYG2 Camera produces CMYG2 encoded Bayer array images
LRGB Camera produces Kodak TRUESENSE Bayer LRGB array images


ITelescopeV3 edit

Defines the ITelescope Interface

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether the device is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used.
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 3 for this interface version.
Name The short name of the driver, for display purposes
SupportedActions Returns the list of action names supported by this driver. This is only available for telescope InterfaceVersion 3
AlignmentMode The alignment mode of the mount.
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 ITelescopeV3.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 seee ITelescopeV3.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 (ITelescopeV3.FindHome method).
CanPark True if this telescope is capable of programmed parking (ITelescopeV3.Parkmethod)
CanPulseGuide True if this telescope is capable of software-pulsed guiding (via the ITelescopeV3.PulseGuide() method)
CanSetDeclinationRate True if the ITelescopeV3.DeclinationRate property can be changed to provide offset tracking in the declination axis.
CanSetGuideRates True if the guide rate properties used for ITelescopeV3.PulseGuide() can ba adjusted.
CanSetPark True if this telescope is capable of programmed setting of its park position (ITelescopeV3.SetPark method)
CanSetPierSide True if the ITelescopeV3.SideOfPier property can be set, meaning that the mount can be forced to flip.
CanSetRightAscensionRate True if the ITelescopeV3.RightAscensionRate property can be changed to provide offset tracking in the right ascension axis.
CanSetTracking True if the ITelescopeV3.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 (ITelescopeV3.Unpark method).
Declination The declination (degrees) of the telescope's current equatorial coordinates, in the coordinate system given by the ITelescopeV3.EquatorialSystem property. Reading the property will raise an error if the value is unavailable.
DeclinationRate The declination tracking rate (arcseconds per second, default = 0.0)
DoesRefraction True if the telescope or driver applies atmospheric refraction to coordinates.
EquatorialSystem Equatorial coordinate system used by this telescope.
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)
IsPulseGuiding True if a ITelescopeV3.PulseGuide() command is in progress, False otherwise
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 ITelescopeV3.MoveAxis() method, False at all other times.
SlewSettleTime Specifies a post-slew settling time (sec.).
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
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 DriveRates values that describe the permissible values of the ITelescopeV3.TrackingRate property for this telescope type.
UTCDate The UTC date/time of the telescope's internal clock

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.
AbortSlew Stops a slew in progress.
AxisRates Determine the rates at which the telescope may be moved about the specified axis by the ITelescopeV3.MoveAxis() method.
  • Axis: The axis about which rate information is desired (TelescopeAxes value)
CanMoveAxis True if this telescope can move the requested axis
  • Axis: Primary, Secondary or Tertiary axis
DestinationSideOfPier Predict side of pier for German equatorial mounts
  • RightAscension: The destination right ascension (hours).
  • Declination: The destination declination (degrees, positive North).
FindHome Locates the telescope's "home" position (synchronous)
MoveAxis Move the telescope in one axis at the given rate.
  • Axis: The physical axis about which movement is desired
  • Rate: The rate of motion (deg/sec) about the specified axis
Park Move the telescope to its park position, stop all motion (or restrict to a small safe range), and set ITelescopeV3.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
  • Direction: The direction in which the guide-rate motion is to be made
  • Duration: The duration of the guide-rate motion (milliseconds)
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
  • Azimuth: Target azimuth (degrees, North-referenced, positive East/clockwise).
  • Altitude: Target altitude (degrees, positive up)
SlewToAltAzAsync This Method must be implemented if ITelescopeV3.CanSlewAltAzAsync returns True.
  • Azimuth: Azimuth to which to move
  • Altitude: Altitude to which to move to
SlewToCoordinates Move the telescope to the given equatorial coordinates, return when slew is complete
  • RightAscension: The destination right ascension (hours). Copied to ITelescopeV3.TargetRightAscension.
  • Declination: The destination declination (degrees, positive North). Copied to ITelescopeV3.TargetDeclination.
SlewToCoordinatesAsync Move the telescope to the given equatorial coordinates, return immediately after starting the slew.
  • RightAscension: The destination right ascension (hours). Copied to ITelescopeV3.TargetRightAscension.
  • Declination: The destination declination (degrees, positive North). Copied to ITelescopeV3.TargetDeclination.
SlewToTarget Move the telescope to the ITelescopeV3.TargetRightAscension and ITelescopeV3.TargetDeclination coordinates, return when slew complete.
SlewToTargetAsync Move the telescope to the ITelescopeV3.TargetRightAscension and ITelescopeV3.TargetDeclination coordinates, returns immediately after starting the slew.
SyncToAltAz Matches the scope's local horizontal coordinates to the given local horizontal coordinates.
  • Azimuth: Target azimuth (degrees, North-referenced, positive East/clockwise)
  • Altitude: Target altitude (degrees, positive up)
SyncToCoordinates Matches the scope's equatorial coordinates to the given equatorial coordinates.
  • RightAscension: The corrected right ascension (hours). Copied to the ITelescopeV3.TargetRightAscension property.
  • Declination: The corrected declination (degrees, positive North). Copied to the ITelescopeV3.TargetDeclination property.
SyncToTarget Matches the scope's equatorial coordinates to the given equatorial coordinates.
Unpark Takes telescope out of the Parked state.


IDomeV2 edit

Defines the IDome Interface

Properties edit

Name Description
Connected Set True to connect to the device. Set False to disconnect from the device. You can also read the property to check whether it is connected.
Description Returns a description of the driver, such as manufacturer and modelnumber. Any ASCII characters may be used.
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device supports. Should return 2 for this interface version.
Name The short name of the driver, for display purposes
SupportedActions Returns the list of action names supported by this driver.
Altitude The dome altitude (degrees, horizon zero and increasing positive to 90 zenith).
AtHome Indicates whether the dome is in the home position. Raises an error if not supported. This is normally used following a IDomeV2.FindHome operation. The value is reset with any azimuth slew operation that moves the dome away from the home position.

IDomeV2.AtHome may also become true durng normal slew operations, if the dome passes through the home position and the dome controller hardware is capable of detecting that; or at the end of a slew operation if the dome comes to rest at the home position.

AtPark True if the dome is in the programmed park position.
Azimuth The dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West)
CanFindHome True if driver can do a search for home position.
CanPark True if driver is capable of setting dome altitude.
CanSetAltitude True if driver is capable of setting dome altitude.
CanSetAzimuth True if driver is capable of setting dome azimuth.
CanSetPark True if driver can set the dome park position.
CanSetShutter True if driver is capable of automatically operating shutter.
CanSlave True if the dome hardware supports slaving to a telescope.
CanSyncAzimuth True if driver is capable of synchronizing the dome azimuth position using the IDomeV2.SyncToAzimuth() method.
ShutterStatus Status of the dome shutter or roll-off roof.
Slaved True if the dome is slaved to the telescope in its hardware, else False.
Slewing True if any part of the dome is currently moving, False if all dome components are steady.

Methods edit

Method Summary Params
SetupDialog Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Action Invokes the specified device-specific action.
  • ActionName: A well known name agreed by interested parties that represents the action to be carried out.
  • ActionParameters: List of required parameters or an if none are required.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
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.
  • Command: The literal command string to be transmitted.
  • Raw: if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.
Dispose 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.
AbortSlew Immediately cancel current dome operation.
CloseShutter Close shutter or otherwise shield telescope from the sky.
FindHome Start operation to search for the dome home position.
OpenShutter Open shutter or otherwise expose telescope to the sky.
Park Rotate dome in azimuth to park position.
SetPark Set the current azimuth, altitude position of dome to be the park position.
SlewToAltitude Slew the dome to the given altitude position.
  • Altitude: Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith)
SlewToAzimuth Slew the dome to the given azimuth position.
  • Azimuth: Target azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)
SyncToAzimuth Synchronize the current position of the dome to the given azimuth.
  • Azimuth: Target azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)


My.Resources.Resources edit

A strongly-typed resource class, for looking up localized strings, etc.

Properties edit

Name Description
ResourceManager Returns the cached ResourceManager instance used by this class.
Culture Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.


IAxisRates edit

A collection of rates at which the telescope may be moved about the specified axis by the ITelescopeV3.MoveAxis() method. This is only used if the telescope interface version is 2 or 3

Properties edit

Name Description
Item(System.Int32) Return information about the rates at which the telescope may be moved about the specified axis by the ITelescopeV3.MoveAxis() method.
Count Number of items in the returned collection

Methods edit

Method Summary Params
Dispose Disposes of the object and cleans up
GetEnumerator Returns an enumerator for the collection