GeoComPy

<h1 align="center"> <img src="https://raw.githubusercontent.com/mrclock8163/geocompy/main/docs/geocompy_logo.png" alt="GeoComPy logo" width="300"> </h1><br>

GeoComPy is a Python library providing wrapper functions for serial communication protocols of Leica surveying instruments.

The package is mainly built around the GeoCOM ASCII protocol, supported by a number of total stations and other instruments running TPS1000, 1100, 1200 and other firmware. For some older instruments that do not support GeoCOM, the GSI Online command set is used for communication.

• Download: https://pypi.org/project/geocompy/
• Documentation: https://geocompy.readthedocs.io/
• Source: https://github.com/MrClock8163/GeoComPy
• Bug reports: https://github.com/MrClock8163/GeoComPy/issues

[!TIP] Command line applications using GeoComPy are available as a separate complimentary package called Instrumentman.

Main features

• Pure Python implementation
• Support for type checkers
• Primitives for relevant data
• Command building and parsing through function calls
• Multiple supported protocols (e.g. GeoCOM, GSI Online)

Requirements

To use the package, Python 3.11 or higher is required.

For the platform independent serial communication, GeoComPy relies on the pySerial package to provide the necessary abstractions.

Installation

The preferred method to install GeoComPy is through PyPI, where both wheel and source distributions are made available.

python -m pip install geocompy

If not yet published changes/fixes are needed, that are only available in source, GeoComPy can also be installed locally from source, without any external tools. Once the repository is cloned to a directory, it can be installed with pip.

git clone https://github.com/MrClock8163/GeoComPy.git
cd GeoComPy
python -m pip install .

Short example

The below example demonstrates how to connect to a GeoCOM capable instrument through a serial connection. Once the connection is up and running, the total station is instructed to turn to horizontal 0, and position the telescope parallel to the ground.

from geocompy import (
    Angle,
    open_serial,
    GeoCom
)


with open_serial("COM1") as com:
    tps = GeoCom(com)
    tps.aut.turn_to(Angle(0), Angle(90, 'deg'))

License

GeoComPy is free and open source software, and it is distributed under the terms of the MIT License.