ICoverCalibratorV1CalibratorOn Method |
Turns the calibrator on at the specified brightness if the device has calibration capability
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxParameters
- Brightness
- Type: SystemInt32
Sets the required calibrator illumination brightness in the range 0 (fully off) to MaxBrightness (fully on).
Exceptions| Exception | Condition |
|---|---|
| InvalidValueException | When the supplied brightness parameter is outside the range 0 to MaxBrightness. |
| MethodNotImplementedException | When CalibratorState returns NotPresent. |
| NotConnectedException | If the device is not connected. |
| DriverException | An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. |
RemarksThis is a mandatory method for a calibrator device that must be implemented.
If the calibrator takes some time to stabilise, the CalibratorState must return NotReady. When the calibrator is ready for use CalibratorState must return Ready.
For devices with both cover and calibrator capabilities, this method may change the CoverState, if required.
If an error condition arises while turning on the calibrator, CalibratorState must be set to Error rather than Unknown.
See Also