IFocuserV3 Interface

Provides universal access to Focuser drivers - Updated to IFocuserV3 - see remarks below

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public interface IFocuserV3 : IAscomDevice
Implements
IAscomDevice

Remarks

SPECIFICATION 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.

Properties

Absolute True if the focuser is capable of absolute position; that is, being commanded to a specific step location.
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)
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice)
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)
IsMoving True if the focuser is currently moving to a new position. False if the focuser is stationary.
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
(Inherited from IAscomDevice)
Position Current focuser position, in steps.
StepSize Step size (microns) for the focuser.
SupportedActions Returns the list of action names supported by this driver.
(Inherited from IAscomDevice)
TempComp The state of temperature compensation mode (if available), else always False.
TempCompAvailable True if focuser has temperature compensation available.
Temperature Current ambient temperature as measured by the focuser.

Methods

Action Invokes the specified device-specific action.
(Inherited from IAscomDevice)
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)
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)
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.

Extension Methods

HaltAsync Returns an awaitable, running, Task that halts focuser movement
(Defined by ClientExtensions)
MoveAsync Returns an awaitable, running, Task that moves to the specified focuser position
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also