AlpacaConfiguration Class

Represents all configuration parameters required to create and operate an Alpaca client.

Definition

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class AlpacaConfiguration
Inheritance
Object    AlpacaConfiguration

Constructors

AlpacaConfigurationInitializes a new instance of the AlpacaConfiguration class

Properties

ClientNumber Arbitrary integer that represents this client. Should be the same for all transactions from this client. Defaults to 1.
EstablishConnectionTimeout Timeout (seconds) to initially connect to the Alpaca device. Defaults to 5 seconds.
ImageArrayCompression Only applicable to Camera devices - Extent to which the ImageArray data stream should be compressed. Defaults to ImageArrayCompression.None.
ImageArrayTransferType Only applicable to Camera devices - Specifies the method used to retrieve the ImageArray property value. Defaults to ImageArrayTransferType.BestAvailable.
IpAddressString Alpaca device's IP Address. Defaults to 127.0.0.1
Logger Optional ILogger instance used to record operational information. Defaults to null.
LongDeviceResponseTimeout Timeout (seconds) for transactions expected to take a long time, e.g. Camera.ImageArray. Defaults to 100 seconds.
Password Basic authentication password for the Alpaca device. Defaults to empty string.
PortNumber Alpaca device's IP Port number. Defaults to 11111
RemoteDeviceNumber Alpaca device's device number, e.g. Telescope/0. Defaults to 0.
Request100Continue Whether to request HTTP 100-continue behaviour. Changing this to true will slow your application and may break some devices. Defaults to false.
ServiceType HTTP or HTTPS. Defaults to HTTP.
StandardDeviceResponseTimeout Timeout (seconds) for transactions expected to complete quickly,e.g. retrieving CanXXX properties. Defaults to 10 seconds.
StrictCasing Whether to tolerate or throw exceptions if the Alpaca device does not use strictly correct casing for JSON element names. Defaults to true.
ThrowOnBadDateTimeJSON Only applicable to Telescope devices - Throw an exception if a returned JSON ITelescope.UTCDate DateTime value is not a UTC value (has a trailing Z character). Defaults to false.
TrustUserGeneratedSslCertificates Whether to trust user-generated SSL certificates. Defaults to false.
UserAgentProductName Optional product name to include in the User-Agent HTTP header. Defaults to null.
UserAgentProductVersion Optional product version to include in the User-Agent HTTP header. Defaults to null.
UserName Basic authentication user name for the Alpaca device. Defaults to empty string.

Version Information

.NET Standard

Supported in: 2.0

See Also