Focuser Class

Focuser device class

Definition

Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class Focuser : ASCOMDevice, IFocuserV4, 
	IAscomDeviceV2, IAscomDevice, IFocuserV3
Inheritance
Object    ASCOMDevice    Focuser
Implements
IAscomDevice, IAscomDeviceV2, IFocuserV3, IFocuserV4

Constructors

Focuser(String) Initialise Focuser device
Focuser(String, ILogger) Initialise Focuser device with a debug logger

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.
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.
DeviceState Returns the device's operational state in a single call
(Inherited from ASCOMDevice)
DriverInfo Descriptive and version information about this ASCOM driver.
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
Focusers Return a list of all Focusers registered in the ASCOM Profile
FocuserState Focuser device state
InterfaceVersion The interface version number that this device implements.
(Inherited from ASCOMDevice)
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
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 ASCOMDevice)
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 ASCOMDevice)
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)
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 Show the device set-up dialog
(Inherited from ASCOMDevice)

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)
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