Click or drag to resize

ICoverCalibratorV1 Interface

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: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
public interface ICoverCalibratorV1

The ICoverCalibratorV1 type exposes the following members.

Properties
  NameDescription
Public propertyBrightness
Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)
Public propertyCalibratorState
Returns the state of the calibration device, if present, otherwise returns "NotPresent"
Public propertyConnected
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.
Public propertyCoverState
Returns the state of the device cover, if present, otherwise returns "NotPresent"
Public propertyDescription
Returns a description of the device, such as manufacturer and modelnumber. Any ASCII characters may be used.
Public propertyDriverInfo
Descriptive and version information about this ASCOM driver.
Public propertyDriverVersion
A string containing only the major and minor version of the driver.
Public propertyInterfaceVersion
The interface version number that this device supports. Should return 1 for this interface version.
Public propertyMaxBrightness
The Brightness value that makes the calibrator deliver its maximum illumination.
Public propertyName
The short name of the driver, for display purposes
Public propertySupportedActions
Returns the list of custom action names supported by this driver.
Top
Methods
  NameDescription
Public methodAction
Invokes the specified device-specific custom action.
Public methodCalibratorOff
Turns the calibrator off if the device has calibration capability
Public methodCalibratorOn
Turns the calibrator on at the specified brightness if the device has calibration capability
Public methodCloseCover
Initiates cover closing if a cover is present
Public methodCommandBlind
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.
Public methodCommandBool
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.
Public methodCommandString
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.
Public methodDispose
Dispose the late-bound interface, if needed. Will release it via COM if it is a COM object, else if native .NET will just dereference it for GC.
Public methodHaltCover
Stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted.
Public methodOpenCover
Initiates cover opening if a cover is present
Public methodSetupDialog
Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Top
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.

See Also