Click or drag to resize

IRotatorV3 Interface

Defines the IRotatorV3 Interface including new synchronisation methods. In addition cable wrap management is clarified. (see Remarks section below)

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3c9121baba46811fe6e53a58a05935662261416d
Syntax
public interface IRotatorV3

The IRotatorV3 type exposes the following members.

Properties
  NameDescription
Public propertyCanReverse
Indicates whether the Rotator supports the Reverse method.
Public propertyCanSync
Reports True if the rotator and / or driver can perform a sync and False if it cannot.
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 3 for this interface version.
Public propertyIsMoving
Indicates whether the rotator is currently moving
Public propertyMechanicalPosition
This returns the raw mechanical position of the rotator.
Public propertyName
The short name of the driver, for display purposes
Public propertyPosition
Current instantaneous Rotator position, allowing for any sync offset, in degrees.
Public propertyReverse
Sets or Returns the rotator’s Reverse state.
Public propertyStepSize
The minimum StepSize, in degrees.
Public propertySupportedActions
Returns the list of custom action names supported by this driver.
Public propertyTargetPosition
The destination position angle for Move() and MoveAbsolute().
Top
Methods
  NameDescription
Public methodAction
Invokes the specified device-specific custom 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 Rotator motion due to a previous Move or MoveAbsolute method call.
Public methodMove
Causes the rotator to move Position degrees relative to the current Position value.
Public methodMoveAbsolute
Causes the rotator to move the absolute position of Position degrees.
Public methodMoveMechanical
Moves the rotator to the specified mechanical angle.
Public methodSetupDialog
Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Public methodSync
Syncs the rotator to the specified position angle without moving it.
Top
Remarks
The IRotatorV3 interface was introduced in Platform 6.5 to add support for rotator synchronisation through these new methods:

The rotator system (including its firmware and driver) is responsible for managing cable wrap prevention behaviour. Client applications must be able to position the rotator from any angle (0 <= angle < 360) to any angle (0 <= angle < 360) without regard to equipment clearance or cable considerations. If needed, the rotator may provide a user interface to configure specific behaviour in the driver's SetupDialog.

See Also