AlpacaDeviceBaseClass Class

Base class for Alpaca client devices

Inheritance Hierarchy

SystemObject
ASCOM.Alpaca.ClientsAlpacaDeviceBaseClass
More

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 2.1.0+15bd426746e14ecc59ad81c289f923331d1aae8b

Syntax

public abstract class AlpacaDeviceBaseClass : IAlpacaClientV2, 
	IAscomDeviceV2, IAscomDevice, IDisposable

Public MustInherit Class AlpacaDeviceBaseClass
	Implements IAlpacaClientV2, IAscomDeviceV2, IAscomDevice, IDisposable

The AlpacaDeviceBaseClass type exposes the following members.

Constructors

	Name	Description
	AlpacaDeviceBaseClass	Create a new instance of the AlpacaDeviceBaseClass passing the instance to the client configuration class

Properties

	Name	Description
	ClientConfiguration	Provide access to the client configuration
	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.
	Connecting	Completion variable for asynchronous connect and disconnect operations
	Description	Returns a description of the driver, such as manufacturer and model number.
	DeviceState	Returns the device's operational state in a single call
	DriverInfo	Descriptive and version information about this ASCOM driver.
	DriverVersion	A string in the form "n.n" containing only the major and minor version of the driver.
	InterfaceVersion	The interface version number that this device implements.
	Name	The short name of the driver, for display purposes
	SupportedActions	Returns the list of action names supported by this driver.

Methods

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

Extension Methods

	Name	Description
	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)

Inheritance Hierarchy