ICover |
Interface for devices that support one or both of two independent capabilities: Telescope Covers and Flat Field Calibrators.
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.6.9999.9999)
SyntaxThe ICoverCalibratorV1 type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | 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 connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state. |
| CoverState | Returns the state of the device cover, if present, otherwise returns "NotPresent" |
| Description | Returns a description of the device, such as manufacturer and modelnumber. Any ASCII characters may be used. |
| DriverInfo | Descriptive and version information about this ASCOM driver. |
| DriverVersion | A string containing only the major and minor version of the driver. |
| InterfaceVersion | The interface version number that this device supports. Should return 1 for this interface version. |
| MaxBrightness | The Brightness value that makes the calibrator deliver its maximum illumination. |
| Name | The short name of the driver, for display purposes |
| SupportedActions | Returns the list of custom action names supported by this driver. |
Methods| Name | Description | |
|---|---|---|
 | Action | Invokes the specified device-specific custom action. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 |
| SetupDialog | Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually. |
RemarksA 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.
See Also