AlpacaCoverCalibrator Class

ASCOM Alpaca CoverCalibrator client

Definition

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class AlpacaCoverCalibrator : AlpacaDeviceBaseClass, 
	ICoverCalibratorV2, IAscomDeviceV2, IAscomDevice, ICoverCalibratorV1
Inheritance
Object    AlpacaDeviceBaseClass    AlpacaCoverCalibrator
Implements
IAscomDevice, IAscomDeviceV2, ICoverCalibratorV1, ICoverCalibratorV2

Constructors

AlpacaCoverCalibrator Create a client for an Alpaca CoverCalibrator device with all parameters set to default values
AlpacaCoverCalibrator(AlpacaConfiguration) Initializes a new instance of the AlpacaCamera class using the specified configuration settings.
AlpacaCoverCalibrator(ServiceType, String, Int32, Int32, Boolean, ILogger) Create a client for an Alpaca CoverCalibrator device specifying the minimum number of parameters
AlpacaCoverCalibrator(ServiceType, String, Int32, Int32, Int32, Int32, Int32, UInt32, String, String, Boolean, ILogger, String, String, Boolean, Boolean) Create an Alpaca CoverCalibrator device specifying all parameters

Properties

Brightness Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)
CalibratorChanging True while the calibrator brightness is not stable.
CalibratorState Returns the state of the calibration device, if present, otherwise returns "NotPresent"
ClientConfiguration Provide access to the client configuration
(Inherited from AlpacaDeviceBaseClass)
Connected Set True to enable the link. Set False to disable the link. You can also read the property to check whether it is connected.
(Inherited from AlpacaDeviceBaseClass)
Connecting Completion variable for asynchronous connect and disconnect operations
(Inherited from AlpacaDeviceBaseClass)
CoverCalibratorState CoverCalibrator device state
CoverMoving True while the cover is in motion.
CoverState Returns the state of the device cover, if present, otherwise returns "NotPresent"
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from AlpacaDeviceBaseClass)
DeviceState Returns the device's operational state in a single call
(Inherited from AlpacaDeviceBaseClass)
DriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from AlpacaDeviceBaseClass)
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from AlpacaDeviceBaseClass)
InterfaceVersion The interface version number that this device implements.
(Inherited from AlpacaDeviceBaseClass)
MaxBrightness The Brightness value that makes the calibrator deliver its maximum illumination.
Name The short name of the driver, for display purposes
(Inherited from AlpacaDeviceBaseClass)
SupportedActions Returns the list of action names supported by this driver.
(Inherited from AlpacaDeviceBaseClass)

Methods

Action Invokes the specified device-specific action.
(Inherited from AlpacaDeviceBaseClass)
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
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 AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
Connect Connect to device asynchronously
(Inherited from AlpacaDeviceBaseClass)
Disconnect Disconnect from device asynchronously
(Inherited from AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
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
RefreshClient Updates the internal HTTP client with a new instance.
(Inherited from AlpacaDeviceBaseClass)

Extension Methods

CalibratorOffAsync Returns an awaitable, running, Task that turns the calibrator off
(Defined by ClientExtensions)
CalibratorOnAsync Returns an awaitable, running, Task that turns the calibrator on
(Defined by ClientExtensions)
CloseCoverAsync Returns an awaitable, running, Task that closes the cover
(Defined by ClientExtensions)
ConnectAsync Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
DisconnectAsync Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
HaltCoverAsync Returns an awaitable, running, Task that halts cover movement
(Defined by ClientExtensions)
OpenCoverAsync Returns an awaitable, running, Task that opens the cover
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also