Click or drag to resize

IDomeV2 Interface

Defines the IDome Interface

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3c9121baba46811fe6e53a58a05935662261416d
Syntax
public interface IDomeV2

The IDomeV2 type exposes the following members.

Properties
  NameDescription
Public propertyAltitude
The altitude (degrees, horizon zero and increasing positive to 90 zenith) of the part of the sky that the observer wishes to observe.
Public propertyAtHome

when the dome is in the home position. Raises an error if not supported.

This is normally used following a FindHome operation. The value is reset with any azimuth slew operation that moves the dome away from the home position.

AtHome may optionally also become true during 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.

Public propertyAtPark
if the dome is in the programmed park position.
Public propertyAzimuth
The dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West). North is true north and not magnetic north.
Public propertyCanFindHome
if driver can perform a search for home position.
Public propertyCanPark
if the driver is capable of parking the dome.
Public propertyCanSetAltitude
if driver is capable of setting dome altitude.
Public propertyCanSetAzimuth
if driver is capable of rotating the dome (or controlling the roof mechanism) in order to observe at a given azimuth.
Public propertyCanSetPark
if the driver can set the dome park position.
Public propertyCanSetShutter
if the driver is capable of opening and closing the shutter or roof mechanism.
Public propertyCanSlave
if the dome hardware supports slaving to a telescope.
Public propertyCanSyncAzimuth
if the driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method.
Public propertyConnected
Set to connect to the device hardware. Set 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 propertyDescription
Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used.
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 propertyInterfaceVersion
The interface version number that this device supports. Should return 2 for this interface version.
Public propertyName
The short name of the driver, for display purposes
Public propertyShutterStatus
Gets the status of the dome shutter or roof structure.
Public propertySlaved
if the dome is slaved to the telescope in its hardware, else .
Public propertySlewing
if any part of the dome is currently moving, if all dome components are stationary.
Public propertySupportedActions
Returns the list of custom action names supported by this driver.
Top
Methods
  NameDescription
Public methodAbortSlew
Immediately stops any and all movement.
Public methodAction
Invokes the specified device-specific custom action.
Public methodCloseShutter
Close the shutter or otherwise shield the telescope from the sky.
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 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 garbage collection.
Public methodFindHome
Start operation to search for the dome home position.
Public methodOpenShutter
Open shutter or otherwise expose telescope to the sky.
Public methodPark
Rotate dome in azimuth to park position.
Public methodSetPark
Set the current azimuth position of dome to the park 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 methodSlewToAltitude
Ensure that the requested viewing altitude is available for observing.
Public methodSlewToAzimuth
Ensure that the requested viewing azimuth is available for observing. The method should not block and the slew operation should complete asynchronously.
Public methodSyncToAzimuth
Synchronize the current position of the dome to the given azimuth.
Top
Remarks

This interface can be used to control most types of observatory structure, including domes (with or without a controllable shutter), clamshells and roll off roofs.

Dome Coordinates

The azimuth and shutter altitude coordinates within this interface refer to positioning of the dome itself and are not sky coordinates from the perspective of the observing device. Mount geometry and pier location often mean that the observing device is not located at the centre point of a hemispherical dome and this results in the dome needing to be positioned at different coordinates than those of the mount in order to expose the required part of the sky to the observing device.

Calculating the required dome position is not the responsibility of the dome driver, this must be done by the client application or by an intermediary hub such as the Device Hub. The coordinates sent to the dome driver must be those required to position the dome slit in the correct position after allowing for the geometry of the mount.

Dome Slaving

A dome is said to be slaved when its azimuth and shutter altitude are controlled by a "behind the scenes" controller that knows the required telescope observing coordinates and that can calculate the required dome position after allowing for mount geometry, observing device orientation etc. When slaved and in operational use most of the dome interface methods are of little relevance apart from the shutter control methods.

How to use the Dome interface to implement a Roll-off Roof or Clamshell

A roll off roof or clamshell is implemented using the shutter control as the roof. The properties and methods should be implemented as follows:

See Also