Click or drag to resize

IAscomDeviceV2 Interface

Defines additional properties and methods that are common to all ASCOM device interfaces in Platform 7 and later.

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.1.0+15bd426746e14ecc59ad81c289f923331d1aae8b
Syntax
public interface IAscomDeviceV2 : IAscomDevice

The IAscomDeviceV2 type exposes the following members.

Properties
 NameDescription
Public propertyConnected 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 IAscomDevice)
Public propertyConnecting Completion variable for asynchronous connect and disconnect operations
Public propertyDescription Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice)
Public propertyDeviceState Returns the device's operational state in a single call
Public propertyDriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from IAscomDevice)
Public propertyDriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from IAscomDevice)
Public propertyInterfaceVersion The interface version number that this device implements.
(Inherited from IAscomDevice)
Public propertyName The short name of the driver, for display purposes
(Inherited from IAscomDevice)
Public propertySupportedActions Returns the list of action names supported by this driver.
(Inherited from IAscomDevice)
Top
Methods
 NameDescription
Public methodCode exampleAction Invokes the specified device-specific action.
(Inherited from IAscomDevice)
Public methodCommandBlind 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 IAscomDevice)
Public methodCommandBool 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 IAscomDevice)
Public methodCommandString 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 IAscomDevice)
Public methodConnect Connect to device asynchronously
Public methodDisconnect Disconnect from device asynchronously
Public methodDispose 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 IAscomDevice)
Top
Extension Methods
 NameDescription
Public Extension MethodConnectAsync Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
Public Extension MethodDisconnectAsync Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
Top
See Also