ASCOM Library
IDome
Dome interface version 3, which incorporates the new members in IAscomDeviceV2 and the members present in IDomeV2
Definition
Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
public interface IDomeV3 : IAscomDeviceV2,
IAscomDevice, IDomeV2VB
Public Interface IDomeV3
Inherits IAscomDeviceV2, IAscomDevice, IDomeV2- Implements
- IAscomDevice, IAscomDeviceV2, IDomeV2
Properties
| Altitude |
The dome altitude (degrees, horizon zero and increasing positive to 90 zenith).
(Inherited from IDomeV2) |
| AtHome |
Indicates whether 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 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. (Inherited from IDomeV2) |
| AtPark |
True if the dome is in the programmed park position.
(Inherited from IDomeV2) |
| Azimuth |
The dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West)
(Inherited from IDomeV2) |
| CanFindHome |
True if driver can do a search for home position.
(Inherited from IDomeV2) |
| CanPark |
True if driver is capable of setting dome altitude.
(Inherited from IDomeV2) |
| CanSetAltitude |
True if driver is capable of setting dome altitude.
(Inherited from IDomeV2) |
| CanSetAzimuth |
True if driver is capable of setting dome azimuth.
(Inherited from IDomeV2) |
| CanSetPark |
True if driver can set the dome park position.
(Inherited from IDomeV2) |
| CanSetShutter |
True if driver is capable of automatically operating shutter.
(Inherited from IDomeV2) |
| CanSlave |
True if the dome hardware supports slaving to a telescope.
(Inherited from IDomeV2) |
| CanSyncAzimuth |
True if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method.
(Inherited from IDomeV2) |
| 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 IAscomDevice) |
| Connecting |
Completion variable for asynchronous connect and disconnect operations
(Inherited from IAscomDeviceV2) |
| Description |
Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice) |
| DeviceState |
Returns the device's operational state in a single call
(Inherited from IAscomDeviceV2) |
| DriverInfo |
Descriptive and version information about this ASCOM driver.
(Inherited from IAscomDevice) |
| DriverVersion |
A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from IAscomDevice) |
| InterfaceVersion |
The interface version number that this device implements.
(Inherited from IAscomDevice) |
| Name |
The short name of the driver, for display purposes
(Inherited from IAscomDevice) |
| ShutterStatus |
Status of the dome shutter or roll-off roof.
(Inherited from IDomeV2) |
| Slaved |
True if the dome is slaved to the telescope in its hardware, else False.
(Inherited from IDomeV2) |
| Slewing |
True if any part of the dome is currently moving, False if all dome components are steady.
(Inherited from IDomeV2) |
| SupportedActions |
Returns the list of action names supported by this driver.
(Inherited from IAscomDevice) |
Methods
| AbortSlew |
Immediately cancel current dome operation.
(Inherited from IDomeV2) |
| Action |
Invokes the specified device-specific action.
(Inherited from IAscomDevice) |
| CloseShutter |
Close shutter or otherwise shield telescope from the sky.
(Inherited from IDomeV2) |
| 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 IAscomDevice) |
| 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 IAscomDevice) |
| 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 IAscomDevice) |
| Connect |
Connect to device asynchronously
(Inherited from IAscomDeviceV2) |
| Disconnect |
Disconnect from device asynchronously
(Inherited from IAscomDeviceV2) |
| 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 IAscomDevice) |
| FindHome |
Start operation to search for the dome home position.
(Inherited from IDomeV2) |
| OpenShutter |
Open shutter or otherwise expose telescope to the sky.
(Inherited from IDomeV2) |
| Park |
Rotate dome in azimuth to park position.
(Inherited from IDomeV2) |
| SetPark |
Set the current azimuth, altitude position of dome to be the park position.
(Inherited from IDomeV2) |
| SlewToAltitude |
Slew the dome to the given altitude position.
(Inherited from IDomeV2) |
| SlewToAzimuth |
Slew the dome to the given azimuth position.
(Inherited from IDomeV2) |
| SyncToAzimuth |
Synchronize the current position of the dome to the given azimuth.
(Inherited from IDomeV2) |
Extension Methods
| AbortSlewAsync |
Returns an awaitable, running, Task that halts all dome movement
(Defined by ClientExtensions) |
| CloseShutterAsync |
Returns an awaitable, running, Task that closes the dome shutter
(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 dome to the home position
(Defined by ClientExtensions) |
| OpenShutterAsync |
Returns an awaitable, running, Task that opens the dome shutter
(Defined by ClientExtensions) |
| ParkAsync |
Returns an awaitable, running, Task that parks the dome
(Defined by ClientExtensions) |
| SlewToAltitudeAsync |
Returns an awaitable, running, Task that slews the dome to the specified altitude
(Defined by ClientExtensions) |
| SlewToAzimuthAsync |
Returns an awaitable, running, Task that slews the dome to the specified azimuth
(Defined by ClientExtensions) |