Click or drag to resize
IFocuserV2 Interface
Provides universal access to Focuser drivers

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.3.0.2821)
Syntax
public interface IFocuserV2

The IFocuserV2 type exposes the following members.

Properties
  NameDescription
Public propertyAbsolute
True if the focuser is capable of absolute position; that is, being commanded to a specific step location.
Public propertyConnected
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.
Public propertyDescription
Returns a description of the device, such as manufacturer and modelnumber. Any ASCII characters may be used.
Public propertyDriverInfo
Descriptive and version information about this ASCOM driver.
Public propertyDriverVersion
A string containing only the major and minor version of the driver.
Public propertyInterfaceVersion
The interface version number that this device supports. Should return 2 for this interface version.
Public propertyIsMoving
True if the focuser is currently moving to a new position. False if the focuser is stationary.
Public propertyLink
State of the connection to the focuser.
Public propertyMaxIncrement
Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.
Public propertyMaxStep
Maximum step position permitted.
Public propertyName
The short name of the driver, for display purposes
Public propertyPosition
Current focuser position, in steps.
Public propertyStepSize
Step size (microns) for the focuser.
Public propertySupportedActions
Returns the list of action names supported by this driver.
Public propertyTempComp
The state of temperature compensation mode (if available), else always False.
Public propertyTempCompAvailable
True if focuser has temperature compensation available.
Public propertyTemperature
Current ambient temperature as measured by the focuser.
Top
Methods
  NameDescription
Public methodCode exampleAction
Invokes the specified device-specific action.
Public methodCommandBlind
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.
Public methodCommandBool
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.
Public methodCommandString
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.
Public methodDispose
Dispose the late-bound interface, if needed. Will release it via COM if it is a COM object, else if native .NET will just dereference it for GC.
Public methodHalt
Immediately stop any focuser motion due to a previous Move(Int32) method call.
Public methodMove
Moves the focuser by the specified amount or to the specified position depending on the value of the Absolute property.
Public methodSetupDialog
Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Top
See Also