Trait ascom_alpaca::api::Dome

pub trait Dome: Device + Send + Sync {
    // Provided methods
    fn altitude<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<f64>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn at_home<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn at_park<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn azimuth<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<f64>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_find_home<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_park<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_set_altitude<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_set_azimuth<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_set_park<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_set_shutter<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_slave<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn can_sync_azimuth<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn shutter_status<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<DomeShutterStatus>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn slaved<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn set_slaved<'life0, 'async_trait>(
        &'life0 self,
        slaved: bool
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn slewing<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn abort_slew<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn close_shutter<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn find_home<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn open_shutter<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn park<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn set_park<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn slew_to_altitude<'life0, 'async_trait>(
        &'life0 self,
        altitude: f64
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn slew_to_azimuth<'life0, 'async_trait>(
        &'life0 self,
        azimuth: f64
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn sync_to_azimuth<'life0, 'async_trait>(
        &'life0 self,
        azimuth: f64
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
}

Available on crate feature dome only.

Dome Specific Methods

Provided Methods

fn altitude<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<f64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn altitude(&self) -> ASCOMResult<f64>

fn at_home<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn at_home(&self) -> ASCOMResult<bool>

fn at_park<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn at_park(&self) -> ASCOMResult<bool>

fn azimuth<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<f64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn azimuth(&self) -> ASCOMResult<f64>

fn can_find_home<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

True if the dome can move to the home position.

Definition before the #[async_trait] expansion:

async fn can_find_home(&self) -> ASCOMResult<bool>

fn can_park<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn can_park(&self) -> ASCOMResult<bool>

fn can_set_altitude<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

True if driver is capable of setting the dome altitude.

Definition before the #[async_trait] expansion:

async fn can_set_altitude(&self) -> ASCOMResult<bool>

fn can_set_azimuth<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

True if driver is capable of setting the dome azimuth.

Definition before the #[async_trait] expansion:

async fn can_set_azimuth(&self) -> ASCOMResult<bool>

fn can_set_park<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn can_set_park(&self) -> ASCOMResult<bool>

fn can_set_shutter<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

True if driver is capable of automatically operating shutter

Definition before the #[async_trait] expansion:

async fn can_set_shutter(&self) -> ASCOMResult<bool>

fn can_slave<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

True if driver is capable of slaving to a telescope.

Definition before the #[async_trait] expansion:

async fn can_slave(&self) -> ASCOMResult<bool>

fn can_sync_azimuth<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn can_sync_azimuth(&self) -> ASCOMResult<bool>

fn shutter_status<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<DomeShutterStatus>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn shutter_status(&self) -> ASCOMResult<DomeShutterStatus>

fn slaved<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn slaved(&self) -> ASCOMResult<bool>

fn set_slaved<'life0, 'async_trait>( &'life0 self, slaved: bool ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets the current subframe height.

Definition before the #[async_trait] expansion:

async fn set_slaved(&self, slaved: bool) -> ASCOMResult

fn slewing<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn slewing(&self) -> ASCOMResult<bool>

fn abort_slew<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Calling this method will immediately disable hardware slewing (Slaved will become False).

Definition before the #[async_trait] expansion:

async fn abort_slew(&self) -> ASCOMResult

fn close_shutter<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close the shutter or otherwise shield telescope from the sky.

Definition before the #[async_trait] expansion:

async fn close_shutter(&self) -> ASCOMResult

fn find_home<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

After Home position is established initializes Azimuth to the default value and sets the AtHome flag.

Definition before the #[async_trait] expansion:

async fn find_home(&self) -> ASCOMResult

fn open_shutter<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Open shutter or otherwise expose telescope to the sky.

Definition before the #[async_trait] expansion:

async fn open_shutter(&self) -> ASCOMResult

fn park<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

After assuming programmed park position, sets AtPark flag.

Definition before the #[async_trait] expansion:

async fn park(&self) -> ASCOMResult

fn set_park<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn set_park(&self) -> ASCOMResult

fn slew_to_altitude<'life0, 'async_trait>( &'life0 self, altitude: f64 ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Slew the dome to the given altitude position.

Definition before the #[async_trait] expansion:

async fn slew_to_altitude(&self, altitude: f64) -> ASCOMResult

fn slew_to_azimuth<'life0, 'async_trait>( &'life0 self, azimuth: f64 ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Slew the dome to the given azimuth position.

Definition before the #[async_trait] expansion:

async fn slew_to_azimuth(&self, azimuth: f64) -> ASCOMResult

fn sync_to_azimuth<'life0, 'async_trait>( &'life0 self, azimuth: f64 ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

Definition before the #[async_trait] expansion:

async fn sync_to_azimuth(&self, azimuth: f64) -> ASCOMResult

Trait Implementations

impl Hash for dyn Dome

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl PartialEq for dyn Dome

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for dyn Dome

Implementors