Trait ascom_alpaca::api::CoverCalibrator

pub trait CoverCalibrator: Device + Send + Sync {
    // Provided methods
    fn brightness<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<i32>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn calibrator_state<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<CalibratorStatus>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn cover_state<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<CoverStatus>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn max_brightness<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult<i32>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn calibrator_off<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn calibrator_on<'life0, 'async_trait>(
        &'life0 self,
        brightness: i32
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn close_cover<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn halt_cover<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn open_cover<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
}

Available on crate feature covercalibrator only.

Expand description

CoverCalibrator Specific Methods

Provided Methods§

fn brightness<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<i32>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)

Definition before the #[async_trait] expansion:

async fn brightness(&self) -> ASCOMResult<i32>

fn calibrator_state<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<CalibratorStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the state of the calibration device, if present, otherwise returns “NotPresent”. The calibrator state mode is specified as an integer value from the CalibratorStatus Enum.

Definition before the #[async_trait] expansion:

async fn calibrator_state(&self) -> ASCOMResult<CalibratorStatus>

fn cover_state<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<CoverStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the state of the device cover, if present, otherwise returns “NotPresent”. The cover state mode is specified as an integer value from the CoverStatus Enum.

Definition before the #[async_trait] expansion:

async fn cover_state(&self) -> ASCOMResult<CoverStatus>

fn max_brightness<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ASCOMResult<i32>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

The Brightness value that makes the calibrator deliver its maximum illumination.

Definition before the #[async_trait] expansion:

async fn max_brightness(&self) -> ASCOMResult<i32>

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

Turns the calibrator off if the device has calibration capability.

Definition before the #[async_trait] expansion:

async fn calibrator_off(&self) -> ASCOMResult

fn calibrator_on<'life0, 'async_trait>( &'life0 self, brightness: i32 ) -> Pin<Box<dyn Future<Output = ASCOMResult> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Turns the calibrator on at the specified brightness if the device has calibration capability.

Definition before the #[async_trait] expansion:

async fn calibrator_on(&self, brightness: i32) -> ASCOMResult

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

Initiates cover closing if a cover is present.

Definition before the #[async_trait] expansion:

async fn close_cover(&self) -> ASCOMResult

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

Stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted.

Definition before the #[async_trait] expansion:

async fn halt_cover(&self) -> ASCOMResult

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

Initiates cover opening if a cover is present.

Definition before the #[async_trait] expansion:

async fn open_cover(&self) -> ASCOMResult

Trait Implementations§

impl Hash for dyn CoverCalibrator

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

Feeds this value into the given Hasher. Read more

impl PartialEq for dyn CoverCalibrator

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

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

1.0.0 · source§

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 CoverCalibrator

Implementors§