https://github.com/qualisys/qualisys_python_sdk
Python implementation of the real-time protocol for Qualisys Track Manager
https://github.com/qualisys/qualisys_python_sdk
motion-capture motion-control motion-tracking position-tracking python qtm qualisys realtime
Last synced: 3 months ago
JSON representation
Python implementation of the real-time protocol for Qualisys Track Manager
- Host: GitHub
- URL: https://github.com/qualisys/qualisys_python_sdk
- Owner: qualisys
- License: mit
- Created: 2016-10-07T12:10:14.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T09:12:50.000Z (over 1 year ago)
- Last Synced: 2025-06-06T10:53:15.045Z (4 months ago)
- Topics: motion-capture, motion-control, motion-tracking, position-tracking, python, qtm, qualisys, realtime
- Language: Python
- Homepage: https://qualisys.github.io/qualisys_python_sdk/index.html
- Size: 3.57 MB
- Stars: 44
- Watchers: 7
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Qualisys SDK for Python
================================
The Qualisys SDK for Python implements our RealTime(RT) protocol and works with Python 3.5 and above.
Installation
------------
The easiest way to install the qtm_rt package is by using [pip]((https://pip.pypa.io/en/stable/installing/)):
```
python -m pip install pip --upgrade # Upgrade to latest pip
python -m pip install qtm-rt
```
It's also possible to install from github:
```
python -m pip install git+https://github.com/qualisys/qualisys_python_sdk.git
```
Or just clone the repo and copy the qtm_rt folder into you project folder,
Documentation
-------------
https://qualisys.github.io/qualisys_python_sdk/index.html
Examples
--------
See the examples folder.
Missing RT features and limitations
-----------------------------------
Implementation only uses little endian, should connect to standard port 22223.
Protocol version must be 1.8 or later.
GetCaptureC3D is not implemented.
GetCaptureQTM is not implemented.
No support for selecting analog channel.
Development
-----------
Use the following `bash` commands in sequence to build the distribution and
documentation:
```
# Setup build environment
python -m venv .venv
source ./.venv/Scripts/activate
pip install -r requirements-dev.txt
# Run tests
pytest test/
# Build source tarball and python wheel in dist/
python -m build
# Build sphinx documentation in docs/_build/html/
make -C docs html
# Copy build output to gh-pages branch (checked out in a separate clone of the repository in ../qualisys_python_sdk_gh_pages)
# Make sure to keep v102/, v103/ and v212/ directories with the old documentation.
cp -r docs/_build/html/* ../qualisys_python_sdk_gh_pages
# Commit the changes with a message like "Update documentation to version x.y.z"
git -C ../qualisys_python_sdk_gh_pages add .
git -C ../qualisys_python_sdk_gh_pages commit
git -C ../qualisys_python_sdk_gh_pages push origin gh-pages
# Upload new version to https://pypi.org/project/qtm-rt (needs API key)
twine upload dist/*
# Git tag and manually make release on github
git tag vx.y.z
git push --tags
```