Trait Camera 

pub trait Camera:
    Device
    + Send
    + Sync {
    // Required methods
    fn exposure_max<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64>;
    fn exposure_min<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64>;
    fn exposure_resolution<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64>;
    fn has_shutter<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool>;
    fn max_adu<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32>;
    fn pixel_size_x<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64>;
    fn pixel_size_y<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64>;
    fn start_x<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32>;
    fn set_start_x<'this: 'async_trait, 'async_trait>(
        &'this self,
        start_x: i32,
    ) -> ASCOMResultFuture<'async_trait, ()>;
    fn start_y<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32>;
    fn set_start_y<'this: 'async_trait, 'async_trait>(
        &'this self,
        start_y: i32,
    ) -> ASCOMResultFuture<'async_trait, ()>;
    fn start_exposure<'this: 'async_trait, 'async_trait>(
        &'this self,
        duration: f64,
        light: bool,
    ) -> ASCOMResultFuture<'async_trait, ()>;

    // Provided methods
    fn bayer_offset_x<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn bayer_offset_y<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn bin_x<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_bin_x<'this: 'async_trait, 'async_trait>(
        &'this self,
        bin_x: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn bin_y<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_bin_y<'this: 'async_trait, 'async_trait>(
        &'this self,
        bin_y: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn camera_state<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, CameraState> { ... }
    fn camera_xsize<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn camera_ysize<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn can_abort_exposure<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn can_asymmetric_bin<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn can_fast_readout<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn can_get_cooler_power<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn can_pulse_guide<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn can_set_ccd_temperature<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn can_stop_exposure<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn ccd_temperature<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn cooler_on<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn set_cooler_on<'this: 'async_trait, 'async_trait>(
        &'this self,
        cooler_on: bool,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn cooler_power<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn electrons_per_adu<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn fast_readout<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn set_fast_readout<'this: 'async_trait, 'async_trait>(
        &'this self,
        fast_readout: bool,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn full_well_capacity<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn gain<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_gain<'this: 'async_trait, 'async_trait>(
        &'this self,
        gain: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn gain_max<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn gain_min<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn gains<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, Vec<String>> { ... }
    fn heat_sink_temperature<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn image_array<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, ImageArray> { ... }
    fn image_ready<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn is_pulse_guiding<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, bool> { ... }
    fn last_exposure_duration<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn last_exposure_start_time<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, SystemTime> { ... }
    fn max_bin_x<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn max_bin_y<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn num_x<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_num_x<'this: 'async_trait, 'async_trait>(
        &'this self,
        num_x: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn num_y<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_num_y<'this: 'async_trait, 'async_trait>(
        &'this self,
        num_y: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn offset<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_offset<'this: 'async_trait, 'async_trait>(
        &'this self,
        offset: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn offset_max<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn offset_min<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn offsets<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, Vec<String>> { ... }
    fn percent_completed<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn readout_mode<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, i32> { ... }
    fn set_readout_mode<'this: 'async_trait, 'async_trait>(
        &'this self,
        readout_mode: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn readout_modes<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, Vec<String>> { ... }
    fn sensor_name<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, String> { ... }
    fn sensor_type<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, SensorType> { ... }
    fn set_ccd_temperature<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn set_set_ccd_temperature<'this: 'async_trait, 'async_trait>(
        &'this self,
        set_ccd_temperature: f64,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn sub_exposure_duration<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, f64> { ... }
    fn set_sub_exposure_duration<'this: 'async_trait, 'async_trait>(
        &'this self,
        sub_exposure_duration: f64,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn abort_exposure<'this: 'async_trait, 'async_trait>(
        &'this self,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn pulse_guide<'this: 'async_trait, 'async_trait>(
        &'this self,
        direction: GuideDirection,
        duration: i32,
    ) -> ASCOMResultFuture<'async_trait, ()> { ... }
    fn stop_exposure<'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 camera only.

Camera Specific Methods.

Required Methods

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

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

Returns the maximum exposure time in seconds supported by StartExposure.

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

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

Returns the minimium exposure time in seconds supported by StartExposure.

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

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

Returns the smallest increment in exposure time supported by StartExposure.

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

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

Returns a flag indicating whether this camera has a mechanical shutter.

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

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

Reports the maximum ADU value the camera can produce.

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

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

Returns the width of the CCD chip pixels in microns.

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

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

Returns the Height of the CCD chip pixels in microns.

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

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

Returns the current subframe start position for the X axis (0 based) in binned pixels.

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

async fn set_start_x(&self, start_x: i32) -> ASCOMResult<()>

Sets the current subframe X axis start position in binned pixels.

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

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

Returns the current subframe start position for the Y axis (0 based) in binned pixels.

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

async fn set_start_y(&self, start_y: i32) -> ASCOMResult<()>

Sets the current subframe Y axis start position in binned pixels.

fn start_exposure<'this: 'async_trait, 'async_trait>( &'this self, duration: f64, light: bool, ) -> ASCOMResultFuture<'async_trait, ()>

async fn start_exposure(&self, duration: f64, light: bool) -> ASCOMResult<()>

Starts an exposure.

Use ImageReady to check when the exposure is complete.

Provided Methods

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

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

Returns the X offset of the Bayer matrix, as defined in SensorType.

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

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

Returns the Y offset of the Bayer matrix, as defined in SensorType.

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

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

Returns the binning factor for the X axis.

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

async fn set_bin_x(&self, bin_x: i32) -> ASCOMResult<()>

Sets the binning factor for the X axis.

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

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

Returns the binning factor for the Y axis.

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

async fn set_bin_y(&self, bin_y: i32) -> ASCOMResult<()>

Sets the binning factor for the Y axis.

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

async fn camera_state(&self) -> ASCOMResult<CameraState>

Returns the current camera operational state as an integer.

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

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

Returns the width of the CCD camera chip in unbinned pixels.

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

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

Returns the height of the CCD camera chip in unbinned pixels.

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

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

Returns true if the camera can abort exposures; false if not.

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

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

Returns a flag showing whether this camera supports asymmetric binning.

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

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

Indicates whether the camera has a fast readout mode.

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

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

If true, the camera’s cooler power setting can be read.

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

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

Returns a flag indicating whether this camera supports pulse guiding.

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

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

Returns a flag indicatig whether this camera supports setting the CCD temperature.

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

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

Returns a flag indicating whether this camera can stop an exposure that is in progress.

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

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

Returns the current CCD temperature in degrees Celsius.

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

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

Returns the current cooler on/off state.

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

async fn set_cooler_on(&self, cooler_on: bool) -> ASCOMResult<()>

Turns on and off the camera cooler.

True = cooler on, False = cooler off.

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

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

Returns the present cooler power level, in percent.

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

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

Returns the gain of the camera in photoelectrons per A/D unit.

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

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

Returns whenther Fast Readout Mode is enabled.

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

async fn set_fast_readout(&self, fast_readout: bool) -> ASCOMResult<()>

Sets whether Fast Readout Mode is enabled.

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

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

Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.).

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

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

The camera’s gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).

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

async fn set_gain(&self, gain: i32) -> ASCOMResult<()>

The camera’s gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).

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

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

Returns the maximum value of Gain.

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

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

Returns the minimum value of Gain.

fn gains<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, Vec<String>>

async fn gains(&self) -> ASCOMResult<Vec<String>>

Returns the Gains supported by the camera.

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

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

Returns the current heat sink temperature (called “ambient temperature” by some manufacturers) in degrees Celsius.

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

async fn image_array(&self) -> ASCOMResult<ImageArray>

Returns an array of 32bit integers containing the pixel values from the last exposure.

This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes. Where applicable, the size of NumPlanes has to be determined by inspection of the returned array.

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

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

Returns a flag indicating whether the image is ready to be downloaded from the camera.

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

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

Returns a flag indicating whether the camera is currrently in a PulseGuide operation.

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

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

Reports the actual exposure duration in seconds (i.e. shutter open time).

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

async fn last_exposure_start_time(&self) -> ASCOMResult<SystemTime>

Reports the actual exposure start.

The time must be UTC.

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

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

Returns the maximum allowed binning for the X camera axis.

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

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

Returns the maximum allowed binning for the Y camera axis.

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

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

Returns the current subframe width in binned pixels.

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

async fn set_num_x(&self, num_x: i32) -> ASCOMResult<()>

Sets the current subframe width in binned pixels.

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

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

Returns the current subframe height in binned pixels.

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

async fn set_num_y(&self, num_y: i32) -> ASCOMResult<()>

Sets the current subframe height in binned pixels.

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

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

Returns the camera’s offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).

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

async fn set_offset(&self, offset: i32) -> ASCOMResult<()>

Sets the camera’s offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).

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

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

Returns the maximum value of offset.

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

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

Returns the Minimum value of offset.

fn offsets<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, Vec<String>>

async fn offsets(&self) -> ASCOMResult<Vec<String>>

Returns the offsets supported by the camera.

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

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

Returns the percentage of the current operation that is complete.

If valid, returns an integer between 0 and 100, where 0 indicates 0% progress (function just started) and 100 indicates 100% progress (i.e. completion).

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

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

ReadoutMode is an index into the array ReadoutModes and returns the desired readout mode for the camera.

Defaults to 0 if not set.

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

async fn set_readout_mode(&self, readout_mode: i32) -> ASCOMResult<()>

Sets the ReadoutMode as an index into the array ReadoutModes.

fn readout_modes<'this: 'async_trait, 'async_trait>( &'this self, ) -> ASCOMResultFuture<'async_trait, Vec<String>>

async fn readout_modes(&self) -> ASCOMResult<Vec<String>>

This property provides an array of strings, each of which describes an available readout mode of the camera.

At least one string must be present in the list.

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

async fn sensor_name(&self) -> ASCOMResult<String>

The name of the sensor used within the camera.

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

async fn sensor_type(&self) -> ASCOMResult<SensorType>

Returns a value indicating whether the sensor is monochrome, or what Bayer matrix it encodes.

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

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

Returns the current camera cooler setpoint in degrees Celsius.

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

async fn set_set_ccd_temperature(&self, set_ccd_temperature: f64) -> ASCOMResult<()>

Set’s the camera’s cooler setpoint in degrees Celsius.

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

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

The Camera’s sub exposure duration in seconds.

ICameraV3 and later.

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

async fn set_sub_exposure_duration(&self, sub_exposure_duration: f64) -> ASCOMResult<()>

Sets image sub exposure duration in seconds.

ICameraV3 and later.

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

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

Aborts the current exposure, if any, and returns the camera to Idle state.

fn pulse_guide<'this: 'async_trait, 'async_trait>( &'this self, direction: GuideDirection, duration: i32, ) -> ASCOMResultFuture<'async_trait, ()>

async fn pulse_guide(&self, direction: GuideDirection, duration: i32) -> ASCOMResult<()>

Activates the Camera’s mount control sytem to instruct the mount to move in a particular direction for a given period of time.

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

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

Stops the current exposure, if any.

If an exposure is in progress, the readout process is initiated. Ignored if readout is already in process.

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

Implementations

impl dyn Camera

Convenience methods for the client to get/set related properties together.

pub async fn bayer_offset(&self) -> ASCOMResult<[i32; 2]>

Available on crate feature client only.

Returns the X and Y offsets of the Bayer matrix, as defined in SensorType.

This is an aggregation of following methods, see their docs for more details:

• bayer_offset_x
• bayer_offset_y

pub async fn bin(&self) -> ASCOMResult<[i32; 2]>

Available on crate feature client only.

Returns the binning factors for the X and Y axes.

This is an aggregation of following methods, see their docs for more details:

• bin_x
• bin_y

pub async fn set_bin(&self, bin: [i32; 2]) -> ASCOMResult<()>

Available on crate feature client only.

Sets the binning factors for the X and Y axes.

This is an aggregation of following methods, see their docs for more details:

• set_bin_x
• set_bin_y

pub async fn camera_size(&self) -> ASCOMResult<[i32; 2]>

Available on crate feature client only.

Returns the width and height of the CCD camera chip in unbinned pixels.

This is an aggregation of following methods, see their docs for more details:

• camera_xsize
• camera_ysize

pub async fn exposure_range(&self) -> ASCOMResult<RangeInclusive<f64>>

Available on crate feature client only.

Returns the exposure time range in seconds supported by StartExposure.

This is an aggregation of following methods, see their docs for more details:

• exposure_min
• exposure_max

pub async fn gain_range(&self) -> ASCOMResult<RangeInclusive<i32>>

Available on crate feature client only.

Returns the supported gain range.

This is an aggregation of following methods, see their docs for more details:

• gain_min
• gain_max

pub async fn max_bin(&self) -> ASCOMResult<[i32; 2]>

Available on crate feature client only.

Returns the maximum allowed binning for the X and Y camera axes.

This is an aggregation of following methods, see their docs for more details:

• max_bin_x
• max_bin_y

pub async fn num(&self) -> ASCOMResult<[i32; 2]>

Available on crate feature client only.

Returns the current subframe width and height in binned pixels.

This is an aggregation of following methods, see their docs for more details:

• num_x
• num_y

pub async fn set_num(&self, num: [i32; 2]) -> ASCOMResult<()>

Available on crate feature client only.

Sets the current subframe width and height in binned pixels.

This is an aggregation of following methods, see their docs for more details:

• set_num_x
• set_num_y

pub async fn offset_range(&self) -> ASCOMResult<RangeInclusive<i32>>

Available on crate feature client only.

Returns the supported offset range.

This is an aggregation of following methods, see their docs for more details:

• offset_min
• offset_max

pub async fn pixel_size(&self) -> ASCOMResult<[f64; 2]>

Available on crate feature client only.

Returns the width and height of the CCD chip pixels in microns.

This is an aggregation of following methods, see their docs for more details:

• pixel_size_x
• pixel_size_y

pub async fn start(&self) -> ASCOMResult<[i32; 2]>

Available on crate feature client only.

Returns the current subframe start position for the X and Y axes (0 based) in binned pixels.

This is an aggregation of following methods, see their docs for more details:

• start_x
• start_y

impl dyn Camera

pub async fn gain_mode(&self) -> ASCOMResult<Option<GainMode>>

Available on crate feature client only.

Return the camera gain mode with valid Gain values, or None if Gain is not supported.

This is a convenience method for clients aggregating following properties:

• gain_min
• gain_max
• gains

Trait Implementations

impl Hash for dyn Camera

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

Feeds this value into the given Hasher.

impl PartialEq for dyn Camera

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 Camera

Implementors