Alpyca icon indicating copy to clipboard operation
Alpyca copied to clipboard

Python interface for ASCOM Alpaca.

Alpyca

Python interface for ASCOM Alpaca

This project is now maintained by the ASCOM Initiative and can be found here: https://github.com/ASCOMInitiative/alpyca/

Install

Using Pip

If downloading from the Python Package Index, run

python3 -m pip install Alpyca

From source

If you have the source code in a tar file, extract it and run

python3 setup.py install

Documentation

All methods have docstrings accessible with Python's built-in help() function.

Alpyca's classes, methods, and parameters use the same names as ASCOM Alpaca's RESTful API. The documentation for Alpaca can be found at https://ascom-standards.org/api/.

Example

The address to move a telescope accessible at http://127.0.0.1:11111/api/v1/telescope/0/moveaxis with the request body {"Axis": 0, "Rate": 1.5} translates into this Python code:

# Import the Telescope class.
from alpaca import Telescope

# Initialize a Telescope object with 0 as the device number.
t = Telescope('127.0.0.1:11111', 0)

# Move the primary axis 1.5 degrees per second.
t.moveaxis(Axis=0, Rate=1.5)