Click or drag to resize

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: 3c9121baba46811fe6e53a58a05935662261416d
Syntax
void CalibratorOn(
	int Brightness
)

Parameters

Brightness
Type: SystemInt32
Sets the required calibrator illumination brightness in the range 0 (fully off) to MaxBrightness (fully on).
Exceptions
ExceptionCondition
MethodNotImplementedExceptionWhen CalibratorState returns NotPresent.
NotConnectedExceptionWhen Connected is False.
InvalidValueExceptionWhen the supplied brightness parameter is outside the range 0 to MaxBrightness.
Remarks

This 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