Click or drag to resize

IRotatorV4 Interface

Rotator interface version 4, which incorporates the new members in IAscomDeviceV2 and the members present in IRotatorV3

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.1.0+15bd426746e14ecc59ad81c289f923331d1aae8b
Syntax
public interface IRotatorV4 : IAscomDeviceV2, 
	IAscomDevice, IRotatorV3

The IRotatorV4 type exposes the following members.

Properties
 NameDescription
Public propertyCanReverse Indicates whether the Rotator supports the Reverse method.
(Inherited from IRotatorV3)
Public propertyConnected 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)
Public propertyConnecting Completion variable for asynchronous connect and disconnect operations
(Inherited from IAscomDeviceV2)
Public propertyDescription Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice)
Public propertyDeviceState Returns the device's operational state in a single call
(Inherited from IAscomDeviceV2)
Public propertyDriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from IAscomDevice)
Public propertyDriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from IAscomDevice)
Public propertyInterfaceVersion The interface version number that this device implements.
(Inherited from IAscomDevice)
Public propertyIsMoving Indicates whether the rotator is currently moving
(Inherited from IRotatorV3)
Public propertyMechanicalPosition This returns the raw mechanical position of the rotator in degrees.
(Inherited from IRotatorV3)
Public propertyName The short name of the driver, for display purposes
(Inherited from IAscomDevice)
Public propertyPosition Current instantaneous Rotator position, allowing for any sync offset, in degrees.
(Inherited from IRotatorV3)
Public propertyReverse Sets or Returns the rotator’s Reverse state.
(Inherited from IRotatorV3)
Public propertyStepSize The minimum StepSize, in degrees.
(Inherited from IRotatorV3)
Public propertySupportedActions Returns the list of action names supported by this driver.
(Inherited from IAscomDevice)
Public propertyTargetPosition The destination position angle for Move() and MoveAbsolute().
(Inherited from IRotatorV3)
Top
Methods
 NameDescription
Public methodCode exampleAction Invokes the specified device-specific action.
(Inherited from IAscomDevice)
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.
(Inherited from IAscomDevice)
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.
(Inherited from IAscomDevice)
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.
(Inherited from IAscomDevice)
Public methodConnect Connect to device asynchronously
(Inherited from IAscomDeviceV2)
Public methodDisconnect Disconnect from device asynchronously
(Inherited from IAscomDeviceV2)
Public methodDispose 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)
Public methodHalt Immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call.
(Inherited from IRotatorV3)
Public methodMove Causes the rotator to move Position degrees relative to the current Position value.
(Inherited from IRotatorV3)
Public methodMoveAbsolute Causes the rotator to move the absolute position of Position degrees.
(Inherited from IRotatorV3)
Public methodMoveMechanical Moves the rotator to the specified mechanical angle.
(Inherited from IRotatorV3)
Public methodSync Syncs the rotator to the specified position angle without moving it.
(Inherited from IRotatorV3)
Top
Extension Methods
 NameDescription
Public Extension MethodConnectAsync Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
Public Extension MethodDisconnectAsync Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
Public Extension MethodHaltAsync Returns an awaitable, running, Task that halts rotator movement
(Defined by ClientExtensions)
Public Extension MethodMoveAbsoluteAsync Returns an awaitable, running, Task that moves the rotator to the specified absolute position
(Defined by ClientExtensions)
Public Extension MethodMoveAsync Returns an awaitable, running, Task that moves the rotator to the specified relative position
(Defined by ClientExtensions)
Public Extension MethodMoveMechanicalAsync Returns an awaitable, running, Task that moves the rotator to the specified mechanical position
(Defined by ClientExtensions)
Top
See Also