Cover |
Provides universal access to CoverCalibrator drivers
Inheritance HierarchyNamespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 7.0.0-rc.0+0
SyntaxThe CoverCalibrator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CoverCalibrator | Creates a CoverCalibrator object with the given ProgID |
Properties| Name | Description | |
|---|---|---|
 | Brightness | Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on) |
| CalibratorChanging | Flag showing whether a calibrator brightness state change is in progress. |
| 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.
(Inherited from AscomDriver) |
| Connecting |
Returns True while the device is undertaking an asynchronous connect or disconnect operation.
(Inherited from AscomDriver) |
| CoverCalibratorState |
CoverCalibrator device state
Remarks See Device State Implementation and Requirements for further information on using the class returned by this property. |
| CoverMoving | Flag showing whether the cover is moving. |
| CoverState | Returns the state of the device cover, if present, otherwise returns "NotPresent" |
| Description |
Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used.
(Inherited from AscomDriver) |
| DeviceState |
Returns the device's operational state in a single call.
(Inherited from AscomDriver) |
| DriverInfo |
Descriptive and version information about this ASCOM driver.
(Inherited from AscomDriver) |
| DriverVersion |
A string containing only the major and minor version of the driver.
(Inherited from AscomDriver) |
| HasConnectAndDeviceState |
Returns if the device has a Platform 7 or later interface that supports Connect / Disconnect and DeviceState
(Inherited from AscomDriver) |
| InterfaceVersion |
The interface version number that this device supports.
(Inherited from AscomDriver) |
| MaxBrightness | The Brightness value that makes the calibrator deliver its maximum illumination. |
| Name |
The short name of the driver, for display purposes
(Inherited from AscomDriver) |
| SupportedActions | Returns the list of custom action names supported by this driver. (Inherited from AscomDriver) |
Methods| Name | Description | |
|---|---|---|
| Action | Invokes the specified device-specific custom action. (Inherited from AscomDriver) |
| 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 |
 | Choose | Brings up the ASCOM Chooser Dialogue to choose a CoverCalibrator |
| 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 AscomDriver) |
| 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 AscomDriver) |
| 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 AscomDriver) |
| Connect |
Connect to the device asynchronously
(Inherited from AscomDriver) |
| Disconnect |
Disconnect from the device asynchronously
(Inherited from AscomDriver) |
| 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 AscomDriver) |
| 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 dialogue box for the driver. The call will not return
until the user clicks OK or cancel manually.
(Inherited from AscomDriver) |
See Also