IFocuser |
Provides universal access to Focuser drivers - Updated to IFocuserV3 and later - see remarks below
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.0.0-rc.0+0
SyntaxThe IFocuserV4 type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Absolute | True if the focuser is capable of absolute position; that is, being commanded to a specific step location. |
| Connected | Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state. |
| Connecting | Returns True while the device is undertaking an asynchronous connect or disconnect operation. |
| Description | Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used. |
| DeviceState | Returns the device's operational state in a single call. |
| DriverInfo | Descriptive and version information about this ASCOM driver. |
| DriverVersion | A string containing only the major and minor version of the driver. |
| InterfaceVersion | The interface version number that this device supports. Should return 4 for this interface version. |
| IsMoving | True if the focuser is currently moving to a new position. False if the focuser is stationary. |
| Link | State of the connection to the focuser. |
| MaxIncrement | Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation. |
| MaxStep | Maximum step position permitted. |
| Name | The short name of the driver, for display purposes |
| Position | Current focuser position, in steps. |
| StepSize | Step size (microns) for the focuser. |
| SupportedActions | Returns the list of custom action names supported by this driver. |
| TempComp | The state of temperature compensation mode (if available), else always False. |
| TempCompAvailable | True if focuser has temperature compensation available. |
| Temperature | Current ambient temperature in degrees Celsius as measured by the focuser. |
Methods| Name | Description | |
|---|---|---|
 | Action | Invokes the specified device-specific custom action. |
| 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. |
| 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. |
| 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. |
| Connect | Connect to the device asynchronously |
| Disconnect | Disconnect from the device asynchronously |
| 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. |
| Halt | Immediately stop any focuser motion due to a previous Move(Int32) method call. |
| Move | Moves the focuser by the specified amount or to the specified position depending on the value of the Absolute property. |
| SetupDialog | Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually. |
RemarksSPECIFICATION REVISION - Platform 6.4
The method signatures in the revised interface specification are identical to the preceding IFocuserV2, however, the IFocuserV3.Move command must no longer throw an InvalidOperationException exception if a Move is attempted when temperature compensation is enabled.
See Also