ISwitchV3 Interface

Switch interface version 3, which incorporates the new members in IAscomDeviceV2 and the members present in ISwitchV2 plus the new ISwitchV3 asynchronous methods.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
public interface ISwitchV3 : IAscomDeviceV2, 
	IAscomDevice, ISwitchV2
Implements
IAscomDevice, IAscomDeviceV2, ISwitchV2

Properties

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

Methods

Action Invokes the specified device-specific action.
(Inherited from IAscomDevice)
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.
(Inherited from ISwitchV2)
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 IAscomDevice)
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 IAscomDevice)
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 IAscomDevice)
Connect Connect to device asynchronously
(Inherited from IAscomDeviceV2)
Disconnect Disconnect from device asynchronously
(Inherited from IAscomDeviceV2)
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 IAscomDevice)
GetSwitch Return the state of switch device id as a boolean
(Inherited from ISwitchV2)
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.
(Inherited from ISwitchV2)
GetSwitchName Return the name of switch device n.
(Inherited from ISwitchV2)
GetSwitchValue Returns the value for switch device id as a double
(Inherited from ISwitchV2)
MaxSwitchValue Returns the maximum value for this switch device, this must be greater than MinSwitchValue(Int16).
(Inherited from ISwitchV2)
MinSwitchValue Returns the minimum value for this switch device, this must be less than MaxSwitchValue(Int16)
(Inherited from ISwitchV2)
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.
(Inherited from ISwitchV2)
SetSwitchName Set a switch device name to a specified value.
(Inherited from ISwitchV2)
SetSwitchValue Set the value for this device as a double.
(Inherited from ISwitchV2)
StateChangeComplete Completion variable for asynchronous changes.
SwitchStep Returns the step size that this device supports (the difference between successive values of the device).
(Inherited from ISwitchV2)

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