Interface IDomeAsync

Defines the capabilities supported by an ASCOM Alpaca Dome device

Inherited Members
Namespace: ES.Ascom.Alpaca.Devices
Assembly: ES.Ascom.Alpaca.Shared.dll
Syntax
public interface IDomeAsync : IDeviceAsync

Methods

| Improve this Doc View Source

AbortSlewAsync()

Immediately cancel current dome operation. Calling this method will immediately disable hardware slewing (Slaved will become False).

Declaration
Task AbortSlewAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

CanFindHomeAsync()

True if the dome can move to the home position.

Declaration
Task<bool> CanFindHomeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanParkAsync()

True if the dome is capable of programmed parking (Park() method)

Declaration
Task<bool> CanParkAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetAltitudeAsync()

True if driver is capable of setting the dome altitude.

Declaration
Task<bool> CanSetAltitudeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetAzimuthAsync()

True if driver is capable of setting the dome azimuth.

Declaration
Task<bool> CanSetAzimuthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetParkAsync()

True if driver is capable of setting the dome park position.

Declaration
Task<bool> CanSetParkAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSetShutterAsync()

True if driver is capable of automatically operating shutter

Declaration
Task<bool> CanSetShutterAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSlaveAsync()

True if driver is capable of slaving to a telescope.

Declaration
Task<bool> CanSlaveAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CanSyncAzimuthAsync()

True if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method.

Declaration
Task<bool> CanSyncAzimuthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

CloseShutterAsync()

Close the shutter or otherwise shield telescope from the sky.

Declaration
Task CloseShutterAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

FindHomeAsync()

Start operation to search for the dome home position. After Home position is established initializes Azimuth to the default value and sets the AtHome flag.

Declaration
Task FindHomeAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

GetAltitudeAsync()

The dome altitude (degrees, horizon zero and increasing positive to 90 zenith).

Declaration
Task<double> GetAltitudeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

The dome altitude
| Improve this Doc View Source

GetAzimuthAsync()

Returns the dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West)

Declaration
Task<double> GetAzimuthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

The dome azimuth in degrees
| Improve this Doc View Source

GetShutterStatusAsync()

Returns the status of the dome shutter or roll-off roof.

Declaration
Task<ShutterState> GetShutterStatusAsync()
Returns
Type Description
System.Threading.Tasks.Task<ShutterState>
| Improve this Doc View Source

IsAtHomeAsync()

Indicates whether the dome is in the home position. 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.

Declaration
Task<bool> IsAtHomeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if the dome is in the home position, false if not
| Improve this Doc View Source

IsAtParkAsync()

True if the dome is in the programmed park position. Set only following a Park() operation and reset with any slew operation.

Declaration
Task<bool> IsAtParkAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if the dome is in the park position, false if not
| Improve this Doc View Source

IsSlavedAsync()

True if the dome is slaved to the telescope in its hardware, else False.

Declaration
Task<bool> IsSlavedAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

IsSlewingAsync()

Indicates whether the any part of the dome is moving

Declaration
Task<bool> IsSlewingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if any part of the dome is currently moving, False if all dome components are steady.
| Improve this Doc View Source

OpenShutterAsync()

Open shutter or otherwise expose telescope to the sky.

Declaration
Task OpenShutterAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

ParkAsync()

Rotate dome in azimuth to park position. After assuming programmed park position, sets AtPark flag.

Declaration
Task ParkAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetParkAsync()

Set the current azimuth, altitude position of dome to be the park position

Declaration
Task SetParkAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetSlavedAsync(Boolean)

Sets whether the dome is slaved to the telescope

Declaration
Task SetSlavedAsync(bool slaved)
Parameters
Type Name Description
System.Boolean slaved
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SlewToAltitudeAsync(Double)

Slew the dome to the given altitude position.

Declaration
Task SlewToAltitudeAsync(double altitude)
Parameters
Type Name Description
System.Double altitude

Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SlewToAzimuthAsync(Double)

Slew the dome to the given azimuth position.

Declaration
Task SlewToAzimuthAsync(double azimuth)
Parameters
Type Name Description
System.Double azimuth

Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SyncToAzimuthAsync(Double)

Synchronize the current position of the dome to the given azimuth.

Declaration
Task SyncToAzimuthAsync(double azimuth)
Parameters
Type Name Description
System.Double azimuth
Returns
Type Description
System.Threading.Tasks.Task

See Also