Dome Class

Dome device class

Definition

Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class Dome : ASCOMDevice, IDomeV3, IAscomDeviceV2, 
	IAscomDevice, IDomeV2
Inheritance
Object    ASCOMDevice    Dome
Implements
IAscomDevice, IAscomDeviceV2, IDomeV2, IDomeV3

Constructors

Dome(String) Initialise Dome device
Dome(String, ILogger) Initialise Dome device with a debug logger

Properties

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 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.

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 SyncToAzimuth(Double) method.
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 ASCOMDevice)
Connecting Completion variable for asynchronous connect and disconnect operations
(Inherited from ASCOMDevice)
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from ASCOMDevice)
DeviceState Returns the device's operational state in a single call
(Inherited from ASCOMDevice)
Domes Return a list of all Dome devices registered in the ASCOM Profile
DomeState Dome device state
DriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from ASCOMDevice)
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
InterfaceVersion The interface version number that this device implements.
(Inherited from ASCOMDevice)
Name The short name of the driver, for display purposes
(Inherited from ASCOMDevice)
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.
SupportedActions Returns the list of action names supported by this driver.
(Inherited from ASCOMDevice)

Methods

AbortSlew Immediately cancel current dome operation.
Action Invokes the specified device-specific action.
(Inherited from ASCOMDevice)
CloseShutter Close shutter or otherwise shield telescope from the sky.
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 ASCOMDevice)
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 ASCOMDevice)
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 ASCOMDevice)
Connect Connect to device asynchronously
(Inherited from ASCOMDevice)
Disconnect Disconnect from device asynchronously
(Inherited from ASCOMDevice)
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 ASCOMDevice)
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.
SetupDialog Show the device set-up dialog
(Inherited from ASCOMDevice)
SlewToAltitude Slew the dome to the given altitude position.
SlewToAzimuth Slew the dome to the given azimuth position.
SyncToAzimuth Synchronize the current position of the dome to the given azimuth.

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)

Version Information

.NET Standard

Supported in: 2.0

See Also