Interface IDome

Defines the capabilities supported by an ASCOM Alpaca Dome device

Inherited Members

IDevice.DeviceNumber

IDevice.InvokeAction(String, String)

IDevice.SendCommandBlind(String, Boolean)

IDevice.SendCommandBool(String, Boolean)

IDevice.SendCommandString(String, Boolean)

IDevice.IsConnected()

IDevice.SetConnected(Boolean)

IDevice.GetDescription()

IDevice.GetDriverInfo()

IDevice.GetDriverVersion()

IDevice.GetInterfaceVersion()

IDevice.GetName()

IDevice.GetSupportedActions()

Namespace: ES.Ascom.Alpaca.Devices

Assembly: ES.Ascom.Alpaca.Shared.dll

Syntax

public interface IDome : IDevice

Methods

AbortSlew()

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

Declaration

void AbortSlew()

CanFindHome()

True if the dome can move to the home position.

Declaration

bool CanFindHome()

Returns

Type	Description
System.Boolean

CanPark()

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

Declaration

bool CanPark()

Returns

Type	Description
System.Boolean

CanSetAltitude()

True if driver is capable of setting the dome altitude.

Declaration

bool CanSetAltitude()

Returns

Type	Description
System.Boolean

CanSetAzimuth()

True if driver is capable of setting the dome azimuth.

Declaration

bool CanSetAzimuth()

Returns

Type	Description
System.Boolean

CanSetPark()

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

Declaration

bool CanSetPark()

Returns

Type	Description
System.Boolean

CanSetShutter()

True if driver is capable of automatically operating shutter

Declaration

bool CanSetShutter()

Returns

Type	Description
System.Boolean

CanSlave()

True if driver is capable of slaving to a telescope.

Declaration

bool CanSlave()

Returns

Type	Description
System.Boolean

CanSyncAzimuth()

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

Declaration

bool CanSyncAzimuth()

Returns

Type	Description
System.Boolean

CloseShutter()

Close the shutter or otherwise shield telescope from the sky.

Declaration

void CloseShutter()

FindHome()

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

void FindHome()

GetAltitude()

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

Declaration

double GetAltitude()

Returns

Type	Description
System.Double	The dome altitude

GetAzimuth()

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

Declaration

double GetAzimuth()

Returns

Type	Description
System.Double	The dome azimuth in degrees

GetShutterStatus()

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

Declaration

ShutterState GetShutterStatus()

Returns

Type	Description
ShutterState

IsAtHome()

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

bool IsAtHome()

Returns

Type	Description
System.Boolean	True if the dome is in the home position, false if not

IsAtPark()

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

Declaration

bool IsAtPark()

Returns

Type	Description
System.Boolean	True if the dome is in the park position, false if not

IsSlaved()

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

Declaration

bool IsSlaved()

Returns

Type	Description
System.Boolean

IsSlewing()

Indicates whether the any part of the dome is moving

Declaration

bool IsSlewing()

Returns

Type	Description
System.Boolean	True if any part of the dome is currently moving, False if all dome components are steady.

OpenShutter()

Open shutter or otherwise expose telescope to the sky.

Declaration

void OpenShutter()

Park()

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

Declaration

void Park()

SetPark()

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

Declaration

void SetPark()

SetSlaved(Boolean)

Sets whether the dome is slaved to the telescope

Declaration

void SetSlaved(bool slaved)

Parameters

Type	Name	Description
System.Boolean	slaved	True if telescope is slaved to dome, otherwise false

SlewToAltitude(Double)

Slew the dome to the given altitude position.

Declaration

void SlewToAltitude(double altitude)

Parameters

Type	Name	Description
System.Double	altitude	Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith)

SlewToAzimuth(Double)

Slew the dome to the given azimuth position.

Declaration

void SlewToAzimuth(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)

SyncToAzimuth(Double)

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

Declaration

void SyncToAzimuth(double azimuth)

Parameters

Type	Name	Description
System.Double	azimuth

See Also

IDomeAsync