IRotator |
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: 6.0.0.0 (6.6.9999.9999)
SyntaxThe IRotatorV3 type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CanReverse | Indicates whether the Rotator supports the Reverse method. |
| Connected | 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. |
| Description | Returns a description of the device, such as manufacturer and modelnumber. Any ASCII characters may be used. |
| DriverInfo | Descriptive and version information about this ASCOM driver. |
| DriverVersion | A string containing only the major and minor version of the driver. |
| InterfaceVersion | The interface version number that this device supports. Should return 3 for this interface version. |
| IsMoving | Indicates whether the rotator is currently moving |
| MechanicalPosition | This returns the raw mechanical position of the rotator in degrees. |
| Name | The short name of the driver, for display purposes |
| Position | Current instantaneous Rotator position, allowing for any sync offset, in degrees. |
| Reverse | Sets or Returns the rotator’s Reverse state. |
| StepSize | The minimum StepSize, in degrees. |
| SupportedActions | Returns the list of custom action names supported by this driver. |
| TargetPosition | The destination position angle for Move() and MoveAbsolute(). |
Methods| Name | Description | |
|---|---|---|
 | Action | Invokes the specified device-specific custom action. |
| 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. |
| 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. |
| 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. |
| 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. |
| Halt | Immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call. |
| Move | Causes the rotator to move Position degrees relative to the current Position value. |
| MoveAbsolute | Causes the rotator to move the absolute position of Position degrees. |
| MoveMechanical | Moves the rotator to the specified mechanical angle. |
| SetupDialog | Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually. |
| Sync | Syncs the rotator to the specified position angle without moving it. |
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