Trait Focuser 

pub trait Focuser:
    Device
    + Send
    + Sync {
    // Required methods
    fn absolute<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool>;
    fn is_moving<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool>;
    fn max_increment<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32>;
    fn max_step<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32>;
    fn temp_comp<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool>;
    fn temp_comp_available<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool>;
    fn move_<'this: 'async_trait, 'async_trait>(
        &'this self,
        position: i32,
    ) -> ASCOMResultFuture<'async_trait, ()>;

    // Provided methods
    fn position<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn step_size<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn set_temp_comp<'this: 'async_trait, 'async_trait>(
        &'this self,
        temp_comp: bool,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn temperature<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn halt<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn interface_version<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn device_state<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, TimestampedDeviceState<DeviceState>> { ... }
}

Available on crate feature focuser only.

Focuser Specific Methods.

Required Methods

fn absolute<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, bool>

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

True if the focuser is capable of absolute position; that is, being commanded to a specific step location.

fn is_moving<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, bool>

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

True if the focuser is currently moving to a new position.

False if the focuser is stationary.

fn max_increment<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, i32>

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

Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.

fn max_step<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, i32>

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

Maximum step position permitted.

fn temp_comp<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, bool>

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

Gets the state of temperature compensation mode (if available), else always False.

fn temp_comp_available<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, bool>

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

True if focuser has temperature compensation available.

fn move_<'this: 'async_trait, 'async_trait>( &'this self, position: i32, ) -> ASCOMResultFuture<'async_trait, ()>

async fn move_(&self, position: i32) -> ASCOMResult<()>

Starts moving the focuser by the specified amount or to the specified position depending on the value of the Absolute property.

Provided Methods

fn position<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, i32>

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

Current focuser position, in steps.

fn step_size<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, f64>

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

Step size (microns) for the focuser.

fn set_temp_comp<'this: 'async_trait, 'async_trait>( &'this self, temp_comp: bool, ) -> ASCOMResultFuture<'async_trait, ()>

async fn set_temp_comp(&self, temp_comp: bool) -> ASCOMResult<()>

Sets the state of temperature compensation mode.

fn temperature<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, f64>

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

Current ambient temperature as measured by the focuser.

fn halt<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, ()>

async fn halt(&self) -> ASCOMResult<()>

Immediately stop any focuser motion due to a previous Move(Int32) method call.

fn interface_version<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, i32>

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

This method returns the version of the ASCOM device interface contract to which this device complies.

Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure thay can use the largest number of devices.

fn device_state<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, TimestampedDeviceState<DeviceState>>

Return all operational properties of this device.

See What is the “read all” feature and what are its rules?.

Trait Implementations

impl Hash for dyn Focuser

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

Feeds this value into the given Hasher.

impl PartialEq for dyn Focuser

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for dyn Focuser

Implementors