Alpyca: API Library for Alpaca Logo
3.1.1
  • Introduction and Quick Start
    • Status of This Document
    • Installation
    • General Usage Pattern
    • Simple Example
    • Enhancement: Emulation of Platform 7 Async Connection API
    • Member Capitalization
    • Numeric Datatypes
    • Common Misconceptions and Confusions
  • ASCOM Alpaca Device Classes
    • Camera Class
      • Camera
        • Camera.AbortExposure()
        • Camera.Action()
        • Camera.CommandBlind()
        • Camera.CommandBool()
        • Camera.CommandString()
        • Camera.Connect()
        • Camera.Disconnect()
        • Camera.PulseGuide()
        • Camera.StartExposure()
        • Camera.StopExposure()
        • Camera.BayerOffsetX
        • Camera.BayerOffsetY
        • Camera.BinX
        • Camera.BinY
        • Camera.CCDTemperature
        • Camera.CameraState
        • Camera.CameraXSize
        • Camera.CameraYSize
        • Camera.CanAbortExposure
        • Camera.CanAsymmetricBin
        • Camera.CanFastReadout
        • Camera.CanGetCoolerPower
        • Camera.CanPulseGuide
        • Camera.CanSetCCDTemperature
        • Camera.CanStopExposure
        • Camera.Connected
        • Camera.Connecting
        • Camera.CoolerOn
        • Camera.CoolerPower
        • Camera.Description
        • Camera.DeviceState
        • Camera.DriverInfo
        • Camera.DriverVersion
        • Camera.ElectronsPerADU
        • Camera.ExposureMax
        • Camera.ExposureMin
        • Camera.ExposureResolution
        • Camera.FastReadout
        • Camera.FullWellCapacity
        • Camera.Gain
        • Camera.GainMax
        • Camera.GainMin
        • Camera.Gains
        • Camera.HasShutter
        • Camera.HeatSinkTemperature
        • Camera.ImageArray
        • Camera.ImageArrayInfo
        • Camera.ImageReady
        • Camera.InterfaceVersion
        • Camera.IsPulseGuiding
        • Camera.LastExposureDuration
        • Camera.LastExposureStartTime
        • Camera.MaxADU
        • Camera.MaxBinX
        • Camera.MaxBinY
        • Camera.Name
        • Camera.NumX
        • Camera.NumY
        • Camera.Offset
        • Camera.OffsetMax
        • Camera.OffsetMin
        • Camera.Offsets
        • Camera.PercentCompleted
        • Camera.PixelSizeX
        • Camera.PixelSizeY
        • Camera.ReadoutMode
        • Camera.ReadoutModes
        • Camera.SensorName
        • Camera.SensorType
        • Camera.SetCCDTemperature
        • Camera.StartX
        • Camera.StartY
        • Camera.SubExposureDuration
        • Camera.SupportedActions
      • ImageMetadata Class
        • ImageMetadata
          • ImageMetadata.Dimension1
          • ImageMetadata.Dimension2
          • ImageMetadata.Dimension3
          • ImageMetadata.ImageElementType
          • ImageMetadata.MetadataVersion
          • ImageMetadata.Rank
          • ImageMetadata.TransmissionElementType
      • Camera-Related Constants
        • CameraStates
          • CameraStates.cameraIdle
          • CameraStates.cameraWaiting
          • CameraStates.cameraExposing
          • CameraStates.cameraReading
          • CameraStates.cameraDownload
          • CameraStates.cameraError
        • SensorType
          • SensorType.Monochrome
          • SensorType.Color
          • SensorType.RGGB
          • SensorType.CMYG
          • SensorType.CMYG2
          • SensorType.LRGB
        • ImageArrayElementTypes
          • ImageArrayElementTypes.Unknown
          • ImageArrayElementTypes.Int16
          • ImageArrayElementTypes.Int32
          • ImageArrayElementTypes.Double
          • ImageArrayElementTypes.Single
          • ImageArrayElementTypes.UInt64
          • ImageArrayElementTypes.Byte
          • ImageArrayElementTypes.Int64
          • ImageArrayElementTypes.UInt16
      • Example: Acquiring an Image, Creating FITS Image
    • CoverCalibrator Class
      • CoverCalibrator
        • CoverCalibrator.Action()
        • CoverCalibrator.CalibratorOff()
        • CoverCalibrator.CalibratorOn()
        • CoverCalibrator.CloseCover()
        • CoverCalibrator.CommandBlind()
        • CoverCalibrator.CommandBool()
        • CoverCalibrator.CommandString()
        • CoverCalibrator.Connect()
        • CoverCalibrator.Disconnect()
        • CoverCalibrator.HaltCover()
        • CoverCalibrator.OpenCover()
        • CoverCalibrator.Brightness
        • CoverCalibrator.CalibratorChanging
        • CoverCalibrator.CalibratorState
        • CoverCalibrator.Connected
        • CoverCalibrator.Connecting
        • CoverCalibrator.CoverMoving
        • CoverCalibrator.CoverState
        • CoverCalibrator.Description
        • CoverCalibrator.DeviceState
        • CoverCalibrator.DriverInfo
        • CoverCalibrator.DriverVersion
        • CoverCalibrator.InterfaceVersion
        • CoverCalibrator.MaxBrightness
        • CoverCalibrator.Name
        • CoverCalibrator.SupportedActions
      • CoverCalibrator-Related Constants
        • CoverStatus
          • CoverStatus.NotPresent
          • CoverStatus.Closed
          • CoverStatus.Moving
          • CoverStatus.Open
          • CoverStatus.Unknown
          • CoverStatus.Error
        • CalibratorStatus
          • CalibratorStatus.NotPresent
          • CalibratorStatus.Off
          • CalibratorStatus.NotReady
          • CalibratorStatus.Ready
          • CalibratorStatus.Unknown
          • CalibratorStatus.Error
    • Dome Class
      • Dome
        • Dome.AbortSlew()
        • Dome.Action()
        • Dome.CloseShutter()
        • Dome.CommandBlind()
        • Dome.CommandBool()
        • Dome.CommandString()
        • Dome.Connect()
        • Dome.Disconnect()
        • Dome.FindHome()
        • Dome.OpenShutter()
        • Dome.Park()
        • Dome.SetPark()
        • Dome.SlewToAltitude()
        • Dome.SlewToAzimuth()
        • Dome.SyncToAzimuth()
        • Dome.Altitude
        • Dome.AtHome
        • Dome.AtPark
        • Dome.Azimuth
        • Dome.CanFindHome
        • Dome.CanPark
        • Dome.CanSetAltitude
        • Dome.CanSetAzimuth
        • Dome.CanSetPark
        • Dome.CanSetShutter
        • Dome.CanSlave
        • Dome.CanSyncAzimuth
        • Dome.Connected
        • Dome.Connecting
        • Dome.Description
        • Dome.DeviceState
        • Dome.DriverInfo
        • Dome.DriverVersion
        • Dome.InterfaceVersion
        • Dome.Name
        • Dome.ShutterStatus
        • Dome.Slaved
        • Dome.Slewing
        • Dome.SupportedActions
      • Dome-Related Constants
        • ShutterState
          • ShutterState.shutterOpen
          • ShutterState.shutterClosed
          • ShutterState.shutterOpening
          • ShutterState.shutterClosing
          • ShutterState.shutterError
    • FilterWheel Class
      • FilterWheel
        • FilterWheel.Action()
        • FilterWheel.CommandBlind()
        • FilterWheel.CommandBool()
        • FilterWheel.CommandString()
        • FilterWheel.Connect()
        • FilterWheel.Disconnect()
        • FilterWheel.Connected
        • FilterWheel.Connecting
        • FilterWheel.Description
        • FilterWheel.DeviceState
        • FilterWheel.DriverInfo
        • FilterWheel.DriverVersion
        • FilterWheel.FocusOffsets
        • FilterWheel.InterfaceVersion
        • FilterWheel.Name
        • FilterWheel.Names
        • FilterWheel.Position
        • FilterWheel.SupportedActions
    • Focuser Class
      • Focuser
        • Focuser.Action()
        • Focuser.CommandBlind()
        • Focuser.CommandBool()
        • Focuser.CommandString()
        • Focuser.Connect()
        • Focuser.Disconnect()
        • Focuser.Halt()
        • Focuser.Move()
        • Focuser.Absolute
        • Focuser.Connected
        • Focuser.Connecting
        • Focuser.Description
        • Focuser.DeviceState
        • Focuser.DriverInfo
        • Focuser.DriverVersion
        • Focuser.InterfaceVersion
        • Focuser.IsMoving
        • Focuser.MaxIncrement
        • Focuser.MaxStep
        • Focuser.Name
        • Focuser.Position
        • Focuser.StepSize
        • Focuser.SupportedActions
        • Focuser.TempComp
        • Focuser.TempCompAvailable
        • Focuser.Temperature
    • ObservingConditions Class
      • ObservingConditions
        • ObservingConditions.Action()
        • ObservingConditions.CommandBlind()
        • ObservingConditions.CommandBool()
        • ObservingConditions.CommandString()
        • ObservingConditions.Connect()
        • ObservingConditions.Disconnect()
        • ObservingConditions.Refresh()
        • ObservingConditions.SensorDescription()
        • ObservingConditions.TimeSinceLastUpdate()
        • ObservingConditions.AveragePeriod
        • ObservingConditions.CloudCover
        • ObservingConditions.Connected
        • ObservingConditions.Connecting
        • ObservingConditions.Description
        • ObservingConditions.DeviceState
        • ObservingConditions.DewPoint
        • ObservingConditions.DriverInfo
        • ObservingConditions.DriverVersion
        • ObservingConditions.Humidity
        • ObservingConditions.InterfaceVersion
        • ObservingConditions.Name
        • ObservingConditions.Pressure
        • ObservingConditions.RainRate
        • ObservingConditions.SkyBrightness
        • ObservingConditions.SkyQuality
        • ObservingConditions.SkyTemperature
        • ObservingConditions.StarFWHM
        • ObservingConditions.SupportedActions
        • ObservingConditions.Temperature
        • ObservingConditions.WindDirection
        • ObservingConditions.WindGust
        • ObservingConditions.WindSpeed
    • Rotator Class
      • Rotator
        • Rotator.Action()
        • Rotator.CommandBlind()
        • Rotator.CommandBool()
        • Rotator.CommandString()
        • Rotator.Connect()
        • Rotator.Disconnect()
        • Rotator.Halt()
        • Rotator.Move()
        • Rotator.MoveAbsolute()
        • Rotator.MoveMechanical()
        • Rotator.Sync()
        • Rotator.CanReverse
        • Rotator.Connected
        • Rotator.Connecting
        • Rotator.Description
        • Rotator.DeviceState
        • Rotator.DriverInfo
        • Rotator.DriverVersion
        • Rotator.InterfaceVersion
        • Rotator.IsMoving
        • Rotator.MechanicalPosition
        • Rotator.Name
        • Rotator.Position
        • Rotator.Reverse
        • Rotator.StepSize
        • Rotator.SupportedActions
        • Rotator.TargetPosition
    • SafetyMonitor Class
      • SafetyMonitor
        • SafetyMonitor.Action()
        • SafetyMonitor.CommandBlind()
        • SafetyMonitor.CommandBool()
        • SafetyMonitor.CommandString()
        • SafetyMonitor.Connect()
        • SafetyMonitor.Disconnect()
        • SafetyMonitor.Connected
        • SafetyMonitor.Connecting
        • SafetyMonitor.Description
        • SafetyMonitor.DeviceState
        • SafetyMonitor.DriverInfo
        • SafetyMonitor.DriverVersion
        • SafetyMonitor.InterfaceVersion
        • SafetyMonitor.IsSafe
        • SafetyMonitor.Name
        • SafetyMonitor.SupportedActions
    • Switch Class
      • Switch
        • Switch.Action()
        • Switch.CanAsync()
        • Switch.CanWrite()
        • Switch.CancelAsync()
        • Switch.CommandBlind()
        • Switch.CommandBool()
        • Switch.CommandString()
        • Switch.Connect()
        • Switch.Disconnect()
        • Switch.GetSwitch()
        • Switch.GetSwitchDescription()
        • Switch.GetSwitchName()
        • Switch.GetSwitchValue()
        • Switch.MaxSwitchValue()
        • Switch.MinSwitchValue()
        • Switch.SetAsync()
        • Switch.SetAsyncValue()
        • Switch.SetSwitch()
        • Switch.SetSwitchName()
        • Switch.SetSwitchValue()
        • Switch.StateChangeComplete()
        • Switch.SwitchStep()
        • Switch.Connected
        • Switch.Connecting
        • Switch.Description
        • Switch.DeviceState
        • Switch.DriverInfo
        • Switch.DriverVersion
        • Switch.InterfaceVersion
        • Switch.MaxSwitch
        • Switch.Name
        • Switch.SupportedActions
    • Telescope Class
      • Telescope
        • Telescope.AbortSlew()
        • Telescope.Action()
        • Telescope.AxisRates()
        • Telescope.CanMoveAxis()
        • Telescope.CommandBlind()
        • Telescope.CommandBool()
        • Telescope.CommandString()
        • Telescope.Connect()
        • Telescope.DestinationSideOfPier()
        • Telescope.Disconnect()
        • Telescope.FindHome()
        • Telescope.MoveAxis()
        • Telescope.Park()
        • Telescope.PulseGuide()
        • Telescope.SetPark()
        • Telescope.SlewToAltAz()
        • Telescope.SlewToAltAzAsync()
        • Telescope.SlewToCoordinates()
        • Telescope.SlewToCoordinatesAsync()
        • Telescope.SlewToTarget()
        • Telescope.SlewToTargetAsync()
        • Telescope.SyncToAltAz()
        • Telescope.SyncToCoordinates()
        • Telescope.SyncToTarget()
        • Telescope.Unpark()
        • Telescope.AlignmentMode
        • Telescope.Altitude
        • Telescope.ApertureArea
        • Telescope.ApertureDiameter
        • Telescope.AtHome
        • Telescope.AtPark
        • Telescope.Azimuth
        • Telescope.CanFindHome
        • Telescope.CanPark
        • Telescope.CanPulseGuide
        • Telescope.CanSetDeclinationRate
        • Telescope.CanSetGuideRates
        • Telescope.CanSetPark
        • Telescope.CanSetPierSide
        • Telescope.CanSetRightAscensionRate
        • Telescope.CanSetTracking
        • Telescope.CanSlew
        • Telescope.CanSlewAltAz
        • Telescope.CanSlewAltAzAsync
        • Telescope.CanSlewAsync
        • Telescope.CanSync
        • Telescope.CanSyncAltAz
        • Telescope.CanUnpark
        • Telescope.Connected
        • Telescope.Connecting
        • Telescope.Declination
        • Telescope.DeclinationRate
        • Telescope.Description
        • Telescope.DeviceState
        • Telescope.DoesRefraction
        • Telescope.DriverInfo
        • Telescope.DriverVersion
        • Telescope.EquatorialSystem
        • Telescope.FocalLength
        • Telescope.GuideRateDeclination
        • Telescope.GuideRateRightAscension
        • Telescope.InterfaceVersion
        • Telescope.IsPulseGuiding
        • Telescope.Name
        • Telescope.RightAscension
        • Telescope.RightAscensionRate
        • Telescope.SideOfPier
        • Telescope.SiderealTime
        • Telescope.SiteElevation
        • Telescope.SiteLatitude
        • Telescope.SiteLongitude
        • Telescope.SlewSettleTime
        • Telescope.Slewing
        • Telescope.SupportedActions
        • Telescope.TargetDeclination
        • Telescope.TargetRightAscension
        • Telescope.Tracking
        • Telescope.TrackingRate
        • Telescope.TrackingRates
        • Telescope.UTCDate
      • Rate Class
        • Rate
          • Rate.Maximum
          • Rate.Minimum
      • Telescope-Related Constants
        • AlignmentModes
          • AlignmentModes.algAltAz
          • AlignmentModes.algPolar
          • AlignmentModes.algGermanPolar
        • DriveRates
          • DriveRates.driveSidereal
          • DriveRates.driveLunar
          • DriveRates.driveSolar
          • DriveRates.driveKing
        • EquatorialCoordinateType
          • EquatorialCoordinateType.equOther
          • EquatorialCoordinateType.equTopocentric
          • EquatorialCoordinateType.equJ2000
          • EquatorialCoordinateType.equJ2050
          • EquatorialCoordinateType.equB1950
        • GuideDirections
          • GuideDirections.guideNorth
          • GuideDirections.guideSouth
          • GuideDirections.guideEast
          • GuideDirections.guideWest
        • PierSide
          • PierSide.pierEast
          • PierSide.pierWest
          • PierSide.pierUnknown
        • TelescopeAxes
          • TelescopeAxes.axisPrimary
          • TelescopeAxes.axisSecondary
          • TelescopeAxes.axisTertiary
    • Device Superclass
  • ASCOM Alpaca Exception Classes
    • Exception Characteristics
    • Exception Definitions
      • ActionNotImplementedException
      • AlpacaRequestException
      • DriverException
      • InvalidOperationException
      • InvalidValueException
      • NotConnectedException
      • NotImplementedException
      • OperationCancelledException
      • ParkedException
      • SlavedException
      • ValueNotSetException
  • Alpaca Device Server Discovery
    • search_ipv4()
    • search_ipv6()
  • Alpaca Device Server Management
    • apiversions()
    • configureddevices()
    • description()
  • Frequently Asked Questions
    • How can I tell if my asynchronous request failed after being started?
    • The Dome Interface seems complex and confusing. Help me.
    • What is the meaning of “pointing state” in the docs for SideOfPier?
      • Pointing State and Side of Pier - Help for Driver Developers
    • What is DestinationSideOfPier and why would I want to use it?
    • What does MoveAxis() do and how do I use it?
Alpyca: API Library for Alpaca
  • Search

© Copyright 2022-2025, ASCOM Initiative, MIT License.

Built with Sphinx using a theme provided by Read the Docs.