AlpacaRotator Class

ASCOM Alpaca Rotator client

Definition

Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class AlpacaRotator : AlpacaDeviceBaseClass, 
	IRotatorV4, IAscomDeviceV2, IAscomDevice, IRotatorV3
Inheritance
Object    AlpacaDeviceBaseClass    AlpacaRotator
Implements
IAscomDevice, IAscomDeviceV2, IRotatorV3, IRotatorV4

Constructors

AlpacaRotator Create a client for an Alpaca Rotator device with all parameters set to default values
AlpacaRotator(AlpacaConfiguration) Initializes a new instance of the AlpacaCamera class using the specified configuration settings.
AlpacaRotator(ServiceType, String, Int32, Int32, Boolean, ILogger) Create a client for an Alpaca Rotator device specifying the minimum number of parameters
AlpacaRotator(ServiceType, String, Int32, Int32, Int32, Int32, Int32, UInt32, String, String, Boolean, ILogger, String, String, Boolean, Boolean) Create an Alpaca Rotator device specifying all parameters

Properties

CanReverse Indicates whether the Rotator supports the Reverse method.
ClientConfiguration Provide access to the client configuration
(Inherited from AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
Connecting Completion variable for asynchronous connect and disconnect operations
(Inherited from AlpacaDeviceBaseClass)
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from AlpacaDeviceBaseClass)
DeviceState Returns the device's operational state in a single call
(Inherited from AlpacaDeviceBaseClass)
DriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from AlpacaDeviceBaseClass)
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from AlpacaDeviceBaseClass)
InterfaceVersion The interface version number that this device implements.
(Inherited from AlpacaDeviceBaseClass)
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
(Inherited from AlpacaDeviceBaseClass)
Position Current instantaneous Rotator position, allowing for any sync offset, in degrees.
Reverse Sets or Returns the rotator’s Reverse state.
RotatorState Rotator device state
StepSize The minimum StepSize, in degrees.
SupportedActions Returns the list of action names supported by this driver.
(Inherited from AlpacaDeviceBaseClass)
TargetPosition The destination position angle for Move() and MoveAbsolute().

Methods

Action Invokes the specified device-specific action.
(Inherited from AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
Connect Connect to device asynchronously
(Inherited from AlpacaDeviceBaseClass)
Disconnect Disconnect from device asynchronously
(Inherited from AlpacaDeviceBaseClass)
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 AlpacaDeviceBaseClass)
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.
RefreshClient Updates the internal HTTP client with a new instance.
(Inherited from AlpacaDeviceBaseClass)
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