Welcome to Alpyca 3.1.1

This document describes the Alpyca package, a Python API client library for ASCOM Alpaca, produced by the ASCOM Initiative, and derived from Ethan Chappel’s Alpyca 1.0.0. Ethan kindly released the name Alpyca to the ASCOM Initiative, hence this expanded package starts life as Version 2.0.

The package provides all of the ASCOM Standard universal interfaces to astronomical devices using the Alpaca network protocol. As an application developer, your usage of the various devices is simplified and universal, independent of the particular make/model of device.

For example, the same code can be used to control any ASCOM-compatible telescope. This includes not only telescopes that are controlled with classic ASCOM/COM on a Windows machine, but also any telescopes which are not connected to a Windows machine, but instead speak Alpaca natively. The Windows ASCOM Remote middleware (external) gives an Alpaca interface to any Windows-resident device, allowing you to use the device via this library from any platform on the net or local host.

Tip

Start Here: Introduction and Quick Start

Note

This is version 3.1.1, a maintenance release. For release notes see the CHANGES document (external) on the Alpyca GitHub repository.

For background see About Alpaca and ASCOM (external) on the ASCOM Initiative web site (external). As an astronomy developer wanting to use Alpaca, we suggest you look over Alpaca Developers Info (external) and join the ASCOM Driver and Application Development Support Forum (external).

Attention

Alpaca is not dependent on Windows. See About Alpaca and ASCOM (external).

• 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
  • CoverCalibrator Class
  • Dome Class
  • FilterWheel Class
  • Focuser Class
  • ObservingConditions Class
  • Rotator Class
  • SafetyMonitor Class
  • Switch Class
  • Telescope Class
  • Device Superclass
• ASCOM Alpaca Exception Classes
  • Exception Characteristics
  • Exception Definitions
• 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?
  • What is DestinationSideOfPier and why would I want to use it?
  • What does MoveAxis() do and how do I use it?

Indices and tables

• Index

• Module Index

• Search Page