Alpaca
Definition
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
public class AlpacaDiscovery : IDisposablePublic Class AlpacaDiscovery
Implements IDisposable- Inheritance
- Object AlpacaDiscovery
- Implements
- IDisposable
Remarks
The discovery process is asynchronous and is initiated by the StartDiscovery(Int32, Int32, Int32, Double, Boolean, Boolean, Boolean, ServiceType) method. Clients can then either work synchronously by looping and periodically polling the DiscoveryComplete property or work asynchronously by handling the AlpacaDevicesUpdated and DiscoveryCompleted events while doing other work.
The StartDiscovery(Int32, Int32, Int32, Double, Boolean, Boolean, Boolean, ServiceType) method is used to set the character of the discovery e.g. the discovery duration and whether to search for IPv4 and/or IPv6 devices. After the specified discovery duration, the DiscoveryComplete event fires and the DiscoveryCompleted property returns True.
Once discovery is complete, .NET clients can retrieve details of discovered Alpaca devices and associated ASCOM interface devices through the GetAlpacaDevices and GetAscomDevices(NullableDeviceTypes) methods. COM clients must use the GetAlpacaDevicesAsArrayList and GetAscomDevicesAsArrayList(NullableDeviceTypes) properties because COM does not support the generic classes used in the GetAlpacaDevices and GetAscomDevices(NullableDeviceTypes) methods.
Constructors
| AlpacaDiscovery | Initialise the Alpaca discovery component |
| AlpacaDiscovery(Boolean, ILogger, String, String) | Initialiser that takes a trace logger (Can only be used from .NET clients) |
Properties
| DiscoveryComplete | Flag that indicates when a discovery cycle is complete |
Methods
| Dispose | Disposes of the discovery component and cleans up resources |
| GetAlpacaDevices | Returns a generic List of discovered Alpaca devices. |
| GetAlpacaDevicesAsArrayList | Returns an ArrayList of discovered Alpaca devices for use by COM clients |
| GetAlpacaDevicesAsync | Returns an awaitable Task that provides a list of discovered Alpaca devices |
| GetAscomDevices | Returns a generic list of discovered ASCOM devices of the specified device type. |
| GetAscomDevicesAsArrayList | Returns an ArrayList of discovered ASCOM devices, of the specified device type, for use by COM clients |
| GetAscomDevicesAsync | Returns an awaitable Task that provides a list of discovered ASCOM devices of the specified device type |
| StartDiscovery | Start an Alpaca device discovery based on the supplied parameters |
Events
| AlpacaDevicesUpdated | Raised every time information about discovered devices is updated |
| DiscoveryCompleted | Raised when the discovery is complete |