Interface IFocuserAsync

Defines the capabilities supported by an ASCOM Alpaca Focuser device

Inherited Members
Namespace: ES.Ascom.Alpaca.Devices
Assembly: ES.Ascom.Alpaca.Shared.dll
Syntax
public interface IFocuserAsync : IDeviceAsync

Methods

| Improve this Doc View Source

GetMaxIncrementAsync()

Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.

Declaration
Task<int> GetMaxIncrementAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

GetMaxStepAsync()

Returns the focuser's maximum step size.

Declaration
Task<int> GetMaxStepAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

GetPositionAsync()

Returns the focuser's current position.

Declaration
Task<int> GetPositionAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

GetStepSizeAsync()

Returns the focuser's step size.

Declaration
Task<double> GetStepSizeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

Step size (microns) for the focuser.
| Improve this Doc View Source

GetTemperatureAsync()

Returns the focuser's current temperature.

Declaration
Task<double> GetTemperatureAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
| Improve this Doc View Source

HaltAsync()

Immediately stops focuser motion.

Declaration
Task HaltAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

IsAbsoluteAsync()

Indicates whether the focuser is capable of absolute position.

Declaration
Task<bool> IsAbsoluteAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if the focuser is capable of absolute position
| Improve this Doc View Source

IsMovingAsync()

Indicates whether the focuser is currently moving.

Declaration
Task<bool> IsMovingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if the focuser is currently moving to a new position. False if the focuser is stationary.
| Improve this Doc View Source

IsTempCompAsync()

Gets the state of temperature compensation mode (if available), else always False.

Declaration
Task<bool> IsTempCompAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
| Improve this Doc View Source

IsTempCompAvailableAsync()

Indicates whether the focuser has temperature compensation.

Declaration
Task<bool> IsTempCompAvailableAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if focuser has temperature compensation available.
| Improve this Doc View Source

MoveAsync(Int32)

Moves the focuser by the specified amount or to the specified position depending on the value of the Absolute property.

Declaration
Task MoveAsync(int position)
Parameters
Type Name Description
System.Int32 position

Step distance or absolute position, depending on the value of the Absolute property
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SetTempCompAsync(Boolean)

Sets the state of temperature compensation mode.

Declaration
Task SetTempCompAsync(bool tempComp)
Parameters
Type Name Description
System.Boolean tempComp

Set true to enable the focuser's temperature compensation mode, otherwise false for normal operation.
Returns
Type Description
System.Threading.Tasks.Task

See Also