Class DeviceConfiguration

Represents the configuration for an ASCOM Alpaca device

Inheritance
System.Object
DeviceConfiguration
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ES.Ascom.Alpaca.Client.Devices
Assembly: ES.Ascom.Alpaca.Client.dll
Syntax
public class DeviceConfiguration

Properties

| Improve this Doc View Source

ApiVersion

The ASCOM Alpaca API version to use to communicate with the device

The only available version is v1

Default value is v1

Declaration
public string ApiVersion { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ClientId

The client ID

Declaration
public int ClientId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DeviceNumber

The device number of the device

Default value is 0

Declaration
public int DeviceNumber { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Host

The host to use to communicate with the device

This can be an IP address or a host name

Default value is 127.0.0.1

Declaration
public string Host { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LongTimeout

Timout duration in seconds that have to be use for long running synchronous operation

Default value is 120 seconds

Declaration
public int LongTimeout { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Port

The port to use to communicate with the device

Default value is 11111

Declaration
public int Port { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Protocol

The protocol to use to communicate with the device

Default value is http://

Declaration
public string Protocol { get; set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

GetBaseUrl()

Builds the base URL based on the set parameters

With default parameters the returned URL will be http://127.0.0.1:11111/api/v1/

Declaration
public string GetBaseUrl()
Returns
Type Description
System.String