ICoverCalibratorV1 Interface

Interface for devices that support one or both of two independent capabilities: Telescope Covers and Flat Field Calibrators.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
public interface ICoverCalibratorV1 : IAscomDevice
Implements
IAscomDevice

Remarks

A device indicates whether it supports each capability through the CoverState and CalibratorState properties, which must return CoverStatus.NotPresent or CalibratorStatus.NotPresent as appropriate if the device does not implement that capability.

This interface enables clients to control the cover and calibrator states to configure the device to take images, calibration light frames and, for shutterless cameras, calibration dark/bias frames.

Properties

Brightness Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)
CalibratorState Returns the state of the calibration device, if present, otherwise returns "NotPresent"
Connected Set True to enable the link. Set False to disable the link. You can also read the property to check whether it is connected.
(Inherited from IAscomDevice)
CoverState Returns the state of the device cover, if present, otherwise returns "NotPresent"
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice)
DriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from IAscomDevice)
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from IAscomDevice)
InterfaceVersion The interface version number that this device implements.
(Inherited from IAscomDevice)
MaxBrightness The Brightness value that makes the calibrator deliver its maximum illumination.
Name The short name of the driver, for display purposes
(Inherited from IAscomDevice)
SupportedActions Returns the list of action names supported by this driver.
(Inherited from IAscomDevice)

Methods

Action Invokes the specified device-specific action.
(Inherited from IAscomDevice)
CalibratorOff Turns the calibrator off if the device has calibration capability
CalibratorOn Turns the calibrator on at the specified brightness if the device has calibration capability
CloseCover Initiates cover closing if a cover is present
CommandBlind Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from IAscomDevice)
CommandBool Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from IAscomDevice)
CommandString Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from IAscomDevice)
Dispose This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method.
(Inherited from IAscomDevice)
HaltCover Stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted.
OpenCover Initiates cover opening if a cover is present

Extension Methods

CalibratorOffAsync Returns an awaitable, running, Task that turns the calibrator off
(Defined by ClientExtensions)
CalibratorOnAsync Returns an awaitable, running, Task that turns the calibrator on
(Defined by ClientExtensions)
CloseCoverAsync Returns an awaitable, running, Task that closes the cover
(Defined by ClientExtensions)
HaltCoverAsync Returns an awaitable, running, Task that halts cover movement
(Defined by ClientExtensions)
OpenCoverAsync Returns an awaitable, running, Task that opens the cover
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also