ASCOM Library
Switch Class
Switch device class
Definition
Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class Switch : ASCOMDevice, ISwitchV3,
IAscomDeviceV2, IAscomDevice, ISwitchV2VB
Public Class Switch
Inherits ASCOMDevice
Implements ISwitchV3, IAscomDeviceV2, IAscomDevice, ISwitchV2- Inheritance
- Object ASCOMDevice Switch
- Implements
- IAscomDevice, IAscomDeviceV2, ISwitchV2, ISwitchV3
Constructors
| Switch(String) | Initialise Switch device |
| Switch(String, ILogger) | Initialise Switch device with a debug logger |
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 ASCOMDevice) |
| Connecting |
Completion variable for asynchronous connect and disconnect operations
(Inherited from ASCOMDevice) |
| Description |
Returns a description of the driver, such as manufacturer and model number.
(Inherited from ASCOMDevice) |
| DeviceState |
Returns the device's operational state in a single call
(Inherited from ASCOMDevice) |
| DriverInfo |
Descriptive and version information about this ASCOM driver.
(Inherited from ASCOMDevice) |
| DriverVersion |
A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from ASCOMDevice) |
| InterfaceVersion |
The interface version number that this device implements.
(Inherited from ASCOMDevice) |
| MaxSwitch | The number of switch devices managed by this driver |
| Name |
The short name of the driver, for display purposes
(Inherited from ASCOMDevice) |
| SupportedActions |
Returns the list of action names supported by this driver.
(Inherited from ASCOMDevice) |
| Switches | Return a list of all Switches registered in the ASCOM Profile |
Methods
| Action |
Invokes the specified device-specific action.
(Inherited from ASCOMDevice) |
| 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 ASCOMDevice) |
| 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 ASCOMDevice) |
| 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 ASCOMDevice) |
| Connect |
Connect to device asynchronously
(Inherited from ASCOMDevice) |
| Disconnect |
Disconnect from device asynchronously
(Inherited from ASCOMDevice) |
| 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 ASCOMDevice) |
| 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) |
| 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. |
| SetupDialog |
Show the device set-up dialog
(Inherited from ASCOMDevice) |
| 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) |