Rotator Class

Rotator device class

Definition

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

Constructors

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

Properties

CanReverse Indicates whether the Rotator supports the Reverse method.
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.
(Inherited from ASCOMDevice)
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.
InterfaceVersion The interface version number that this device implements.
(Inherited from ASCOMDevice)
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.
Rotators Return a list of all Rotators registered in the ASCOM Profile
RotatorState Rotator device state
StepSize The minimum StepSize, in degrees.
SupportedActions Returns the list of action names supported by this driver.
(Inherited from ASCOMDevice)
TargetPosition The destination position angle for Move() and MoveAbsolute().

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 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 Show the device set-up dialog
(Inherited from ASCOMDevice)
Sync Syncs the rotator to the specified position angle without moving it.

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 rotator movement
(Defined by ClientExtensions)
MoveAbsoluteAsync Returns an awaitable, running, Task that moves the rotator to the specified absolute position
(Defined by ClientExtensions)
MoveAsync Returns an awaitable, running, Task that moves the rotator to the specified relative position
(Defined by ClientExtensions)
MoveMechanicalAsync Returns an awaitable, running, Task that moves the rotator to the specified mechanical position
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also