AlpacaSwitch Class

ASCOM Alpaca Switch client

Definition

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class AlpacaSwitch : AlpacaDeviceBaseClass, 
	ISwitchV3, IAscomDeviceV2, IAscomDevice, ISwitchV2
Inheritance
Object    AlpacaDeviceBaseClass    AlpacaSwitch
Implements
IAscomDevice, IAscomDeviceV2, ISwitchV2, ISwitchV3

Constructors

AlpacaSwitch Create a client for an Alpaca Switch device with all parameters set to default values
AlpacaSwitch(AlpacaConfiguration) Initializes a new instance of the AlpacaCamera class using the specified configuration settings.
AlpacaSwitch(ServiceType, String, Int32, Int32, Boolean, ILogger) Create a client for an Alpaca Switch device specifying the minimum number of parameters
AlpacaSwitch(ServiceType, String, Int32, Int32, Int32, Int32, Int32, UInt32, String, String, Boolean, ILogger, String, String, Boolean, Boolean) Create an Alpaca Switch device specifying all parameters

Properties

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

Methods

Action Invokes the specified device-specific action.
(Inherited from AlpacaDeviceBaseClass)
CanAsync Flag indicating whether this switch can operate asynchronously.
CancelAsync Cancels an in-progress asynchronous operation.
CanWrite Reports if the specified switch device can be written to, default true. This is false if the device cannot be written to, for example a limit switch or a sensor.
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.
(Inherited from AlpacaDeviceBaseClass)
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.
(Inherited from AlpacaDeviceBaseClass)
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.
(Inherited from AlpacaDeviceBaseClass)
Connect Connect to device asynchronously
(Inherited from AlpacaDeviceBaseClass)
Disconnect Disconnect from device asynchronously
(Inherited from AlpacaDeviceBaseClass)
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.
(Inherited from AlpacaDeviceBaseClass)
GetSwitch Return the state of switch device id as a boolean
GetSwitchDescription Gets the description of the specified switch device. This is to allow a fuller description of the device to be returned, for example for a tool tip.
GetSwitchName Return the name of switch device n.
GetSwitchValue Returns the value for switch device id as a double
MaxSwitchValue Returns the maximum value for this switch device, this must be greater than MinSwitchValue(Int16).
MinSwitchValue Returns the minimum value for this switch device, this must be less than MaxSwitchValue(Int16)
RefreshClient Updates the internal HTTP client with a new instance.
(Inherited from AlpacaDeviceBaseClass)
SetAsync Set a boolean switch's state asynchronously
SetAsyncValue Set a switch's value asynchronously
SetSwitch Sets a switch controller device to the specified state, true or false.
SetSwitchName Set a switch device name to a specified value.
SetSwitchValue Set the value for this device as a double.
StateChangeComplete Completion variable for asynchronous changes.
SwitchStep Returns the step size that this device supports (the difference between successive values of the device).

Extension Methods

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)
SetAsync Returns an awaitable, running, Task that sets the switch to a given boolean state
(Defined by ClientExtensions)
SetAsyncValue Returns an awaitable, running, Task that sets the switch to a given value
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also