ClientExtensionsCalibratorOnAsync Method

Returns an awaitable, running, Task that turns the calibrator on

Definition

Namespace: ASCOM.Common
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4

C#

public static Task CalibratorOnAsync(
	this ICoverCalibratorV1 device,
	int brightness,
	CancellationToken cancellationToken = default,
	int pollInterval = 1000,
	ILogger logger = null
)

VB

<ExtensionAttribute>
Public Shared Function CalibratorOnAsync ( 
	device As ICoverCalibratorV1,
	brightness As Integer,
	Optional cancellationToken As CancellationToken = Nothing,
	Optional pollInterval As Integer = 1000,
	Optional logger As ILogger = Nothing
) As Task

Parameters

device ICoverCalibratorV1: The CoverCalibrator device
brightness Int32: Required brightness level
cancellationToken CancellationToken (Optional): Cancellation token - Default: None
pollInterval Int32 (Optional): Interval between polls of the completion variable (milliseconds) - Default: 1000 milliseconds.
logger ILogger (Optional): ILogger instance that will receive operation messages from the method - Default: No logger

Return Value

Task
Awaitable task that ends when the calibrator is on

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ICoverCalibratorV1. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Initiator: CalibratorOn(Int32)

Complete when: CalibratorState is NotPresent or Off Ready or Unknown or Error

Version Information

.NET Standard

Supported in: 2.0