qtm-rt-pyside6 0.3.4__tar.gz

qtm_rt_pyside6-0.3.4/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - run: pip install ruff
+      - run: ruff check .
+      - run: ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.x"]
+    env:
+      QT_QPA_PLATFORM: offscreen
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: sudo apt-get update && sudo apt-get install -y libegl1
+      - run: |
+          pip install -r requirements-dev.txt
+          pip install -e .
+      - run: pytest -v

qtm_rt_pyside6-0.3.4/.github/workflows/publish.yml

@@ -0,0 +1,52 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions: 
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  upload-release-assets:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - run: gh release upload "${{ github.event.release.tag_name }}" dist/*
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}

qtm_rt_pyside6-0.3.4/.gitignore

@@ -0,0 +1,31 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE / AI tools
+.idea/
+.vscode/
+.claude/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# OS
+.DS_Store
+Thumbs.db

qtm_rt_pyside6-0.3.4/CLAUDE.md

@@ -0,0 +1,99 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+PySide6-based SDK for QTM Real-Time Protocol. Uses Qt's network stack (`QTcpSocket`, `QUdpSocket`) and signals/slots pattern instead of asyncio. Reuses packet parsing code from the original `qtm-rt` SDK, pulled in as a pip dependency (`qtm-rt>=3.0.0`).
+
+## Development Commands
+
+```bash
+# Setup environment (use Python 3.10+)
+py -3.10 -m venv .venv
+.venv/Scripts/activate  # Windows
+pip install -r requirements-dev.txt
+pip install -e .
+
+# Run all tests
+pytest -v
+
+# Run a single test file or test
+pytest tests/test_connection.py -v
+pytest tests/test_connection.py::TestQTMConnectionInit::test_creates_socket -v
+
+# Run examples (requires QTM running)
+python examples/basic_example.py
+python examples/discovery_example.py
+```
+
+```bash
+# Lint and format
+ruff check .
+ruff format --check .
+ruff format .          # auto-fix formatting
+```
+
+Tests use `pytest-qt` (configured in `pyproject.toml` with `qt_api = pyside6`). Use `qtbot.waitSignal()` for signal assertions.
+
+Version is derived from git tags via `setuptools-scm`. Tag a release with `v0.1.0` format.
+
+## Architecture
+
+### Module Structure
+
+- **`qtm_rt`** - Original SDK installed from PyPI (`qtm-rt>=3.0.0`). We import `packet` and `receiver` for binary parsing
+- **`qtm_rt_pyside6/connection.py`** - `QTMConnection(QObject)` main class using `QTcpSocket`
+- **`qtm_rt_pyside6/discovery.py`** - `QTMDiscovery(QObject)` for UDP broadcast discovery
+
+### Signal Pattern
+
+The SDK uses Qt signals instead of async/await:
+
+```python
+# Connection state
+connected = Signal()
+disconnected = Signal()
+error = Signal(str)
+
+# Streaming (high-frequency)
+packetReceived = Signal(object)   # QRTPacket
+eventReceived = Signal(object)    # QRTEvent
+
+# Request/response (generic)
+responseReceived = Signal(str, object)  # (command_name, data)
+```
+
+### Response Handling
+
+Commands that expect responses emit via `responseReceived(command, data)`. Use the helper for cleaner code:
+
+```python
+connection.onResponse("getparameters", self.handle_parameters)
+connection.getParameters(["3d"])
+```
+
+### Reused Components from `qtm-rt`
+
+- `qtm_rt.packet` - `QRTPacket`, `QRTEvent`, all struct definitions and namedtuples
+- `qtm_rt.receiver` - `Receiver` class for packet reassembly (called from `_onReadyRead`)
+
+### Data Flow
+
+1. `QTMConnection.connectToHost(host)` -> `QTcpSocket.connectToHost()`
+2. Socket `connected` signal -> send version command -> emit `connected` signal
+3. `streamFrames(components)` -> sends command to QTM
+4. Socket `readyRead` -> `Receiver.data_received()` -> packet handlers -> emit `packetReceived`
+
+### Protocol Defaults
+
+- TCP port: 22223 (little-endian)
+- UDP discovery port: 22226
+- Protocol version: "1.25"
+- Logger name: `"qtm_rt_pyside6"`
+
+### Valid Identifiers
+
+**Streaming components:** `2d`, `2dlin`, `3d`, `3dres`, `3dnolabels`, `3dnolabelsres`, `analog`, `analogsingle`, `force`, `forcesingle`, `6d`, `6dres`, `6deuler`, `6deulerres`, `gazevector`, `eyetracker`, `image`, `timecode`, `skeleton`, `skeleton:global`
+
+**Parameter names for `getParameters()`:** `all`, `general`, `3d`, `6d`, `analog`, `force`, `gazevector`, `eyetracker`, `image`, `skeleton`, `skeleton:global`, `calibration`

qtm_rt_pyside6-0.3.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Qualisys AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qtm_rt_pyside6-0.3.4/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: qtm-rt-pyside6
+Version: 0.3.4
+Summary: PySide6 SDK for QTM Real-Time Protocol
+Author-email: Qualisys AB <support@qualisys.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/qualisys/qualisys_pyside6_sdk
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_LICENSES
+Requires-Dist: PySide6>=6.0.0
+Requires-Dist: qtm-rt>=3.0.0
+Dynamic: license-file
+
+# Qualisys PySide6 SDK
+
+[![PyPI](https://img.shields.io/pypi/v/qtm-rt-pyside6)](https://pypi.org/project/qtm-rt-pyside6/)
+
+PySide6-based SDK for the Qualisys Real-Time (RT) protocol. Stream motion capture data from QTM using Qt's native networking and signals/slots.
+
+## Installation
+
+Requires Python 3.10+ and PySide6 6.0+.
+
+We recommend using a virtual environment to avoid conflicts with other packages:
+
+```bash
+# Create and activate a virtual environment
+python -m venv .venv
+
+# Windows
+.venv\Scripts\activate
+
+# macOS / Linux
+source .venv/bin/activate
+```
+
+Then install the package:
+
+```bash
+pip install qtm-rt-pyside6
+```
+
+## Quick Start
+
+```python
+import sys
+from PySide6.QtCore import QCoreApplication
+from qtm_rt_pyside6 import QTMConnection, QRTPacket
+
+def on_packet(packet: QRTPacket):
+    print(f"Frame {packet.framenumber}")
+    result = packet.get_3d_markers()
+    if result:
+        header, markers = result
+        for marker in markers:
+            print(f"  {marker.x}, {marker.y}, {marker.z}")
+
+app = QCoreApplication(sys.argv)
+
+connection = QTMConnection()
+connection.connected.connect(lambda: connection.streamFrames(["3d"]))
+connection.packetReceived.connect(on_packet)
+connection.error.connect(lambda msg: print(f"Error: {msg}"))
+connection.connectToHost("127.0.0.1")
+
+sys.exit(app.exec())
+```
+
+## API
+
+### QTMConnection Signals
+
+| Signal | Description |
+|--------|-------------|
+| `connected()` | Successfully connected and version negotiated |
+| `disconnected()` | Disconnected from QTM |
+| `error(str)` | Connection or protocol error |
+| `packetReceived(QRTPacket)` | Data packet during streaming |
+| `eventReceived(QRTEvent)` | QTM event (capture started, etc.) |
+| `responseReceived(str, object)` | Command response (command_name, data) |
+
+### QTMConnection Methods
+
+Core methods to get started:
+
+- `connectToHost(host, port=22223, version="1.25", timeout_ms=5000)` — Connect to QTM
+- `disconnectFromHost()` — Close the connection
+- `streamFrames(components, frames="allframes", udp_port=None, udp_address=None)` — Start streaming; pass `udp_port` to receive frames over UDP instead of TCP
+- `streamFramesStop()` — Stop streaming
+- `getParameters(parameters)` — Request current configuration as XML
+
+See the class docstring or run `help(QTMConnection)` for the full method
+list — control, load/save, trigger, LED, quit, XML settings, etc.
+
+### Components
+
+Valid streaming components: `2d`, `2dlin`, `3d`, `3dres`, `3dnolabels`, `3dnolabelsres`, `analog`, `analogsingle`, `force`, `forcesingle`, `6d`, `6dres`, `6deuler`, `6deulerres`, `gazevector`, `eyetracker`, `image`, `timecode`, `skeleton`, `skeleton:global`
+
+## Examples
+
+Ready-to-run scripts live in [examples/](examples/) — see
+[examples/README.md](examples/README.md) for what each one demonstrates
+and how to run it. `basic_example.py` is the shortest path to verify
+your setup; the GUI examples (`gui_example.py` and `gui_3d_example/`)
+show how to wire the SDK into a desktop application.
+
+## Known Limitations
+
+- **No automatic reconnection.** If the connection drops, you must call `connectToHost()` again. Listen to the `disconnected` signal to detect this.
+- **Single-threaded.** `QTMConnection` and `QTMDiscovery` are `QObject` subclasses and must be used from the thread that created them (typically the main thread). Use Qt signals for cross-thread communication.
+- **Password sent in plain text.** `takeControl(password)` transmits the password unencrypted over TCP. This is a QTM protocol limitation — use on trusted networks only.
+
+## Development
+
+To work on the SDK itself:
+
+```bash
+git clone https://github.com/qualisys/qualisys_pyside6_sdk.git
+cd qualisys_pyside6_sdk
+
+# Create and activate a virtual environment
+python -m venv .venv
+
+# Windows
+.venv\Scripts\activate
+
+# macOS / Linux
+source .venv/bin/activate
+
+# Install dev dependencies (pytest, pytest-qt, ruff, build) and the package
+pip install -r requirements-dev.txt
+pip install -e .
+```
+
+Run tests and linting:
+```bash
+pytest -v
+ruff check .
+ruff format --check .
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE) and [THIRD_PARTY_LICENSES](THIRD_PARTY_LICENSES).

qtm_rt_pyside6-0.3.4/README.md

@@ -0,0 +1,131 @@
+# Qualisys PySide6 SDK
+
+[![PyPI](https://img.shields.io/pypi/v/qtm-rt-pyside6)](https://pypi.org/project/qtm-rt-pyside6/)
+
+PySide6-based SDK for the Qualisys Real-Time (RT) protocol. Stream motion capture data from QTM using Qt's native networking and signals/slots.
+
+## Installation
+
+Requires Python 3.10+ and PySide6 6.0+.
+
+We recommend using a virtual environment to avoid conflicts with other packages:
+
+```bash
+# Create and activate a virtual environment
+python -m venv .venv
+
+# Windows
+.venv\Scripts\activate
+
+# macOS / Linux
+source .venv/bin/activate
+```
+
+Then install the package:
+
+```bash
+pip install qtm-rt-pyside6
+```
+
+## Quick Start
+
+```python
+import sys
+from PySide6.QtCore import QCoreApplication
+from qtm_rt_pyside6 import QTMConnection, QRTPacket
+
+def on_packet(packet: QRTPacket):
+    print(f"Frame {packet.framenumber}")
+    result = packet.get_3d_markers()
+    if result:
+        header, markers = result
+        for marker in markers:
+            print(f"  {marker.x}, {marker.y}, {marker.z}")
+
+app = QCoreApplication(sys.argv)
+
+connection = QTMConnection()
+connection.connected.connect(lambda: connection.streamFrames(["3d"]))
+connection.packetReceived.connect(on_packet)
+connection.error.connect(lambda msg: print(f"Error: {msg}"))
+connection.connectToHost("127.0.0.1")
+
+sys.exit(app.exec())
+```
+
+## API
+
+### QTMConnection Signals
+
+| Signal | Description |
+|--------|-------------|
+| `connected()` | Successfully connected and version negotiated |
+| `disconnected()` | Disconnected from QTM |
+| `error(str)` | Connection or protocol error |
+| `packetReceived(QRTPacket)` | Data packet during streaming |
+| `eventReceived(QRTEvent)` | QTM event (capture started, etc.) |
+| `responseReceived(str, object)` | Command response (command_name, data) |
+
+### QTMConnection Methods
+
+Core methods to get started:
+
+- `connectToHost(host, port=22223, version="1.25", timeout_ms=5000)` — Connect to QTM
+- `disconnectFromHost()` — Close the connection
+- `streamFrames(components, frames="allframes", udp_port=None, udp_address=None)` — Start streaming; pass `udp_port` to receive frames over UDP instead of TCP
+- `streamFramesStop()` — Stop streaming
+- `getParameters(parameters)` — Request current configuration as XML
+
+See the class docstring or run `help(QTMConnection)` for the full method
+list — control, load/save, trigger, LED, quit, XML settings, etc.
+
+### Components
+
+Valid streaming components: `2d`, `2dlin`, `3d`, `3dres`, `3dnolabels`, `3dnolabelsres`, `analog`, `analogsingle`, `force`, `forcesingle`, `6d`, `6dres`, `6deuler`, `6deulerres`, `gazevector`, `eyetracker`, `image`, `timecode`, `skeleton`, `skeleton:global`
+
+## Examples
+
+Ready-to-run scripts live in [examples/](examples/) — see
+[examples/README.md](examples/README.md) for what each one demonstrates
+and how to run it. `basic_example.py` is the shortest path to verify
+your setup; the GUI examples (`gui_example.py` and `gui_3d_example/`)
+show how to wire the SDK into a desktop application.
+
+## Known Limitations
+
+- **No automatic reconnection.** If the connection drops, you must call `connectToHost()` again. Listen to the `disconnected` signal to detect this.
+- **Single-threaded.** `QTMConnection` and `QTMDiscovery` are `QObject` subclasses and must be used from the thread that created them (typically the main thread). Use Qt signals for cross-thread communication.
+- **Password sent in plain text.** `takeControl(password)` transmits the password unencrypted over TCP. This is a QTM protocol limitation — use on trusted networks only.
+
+## Development
+
+To work on the SDK itself:
+
+```bash
+git clone https://github.com/qualisys/qualisys_pyside6_sdk.git
+cd qualisys_pyside6_sdk
+
+# Create and activate a virtual environment
+python -m venv .venv
+
+# Windows
+.venv\Scripts\activate
+
+# macOS / Linux
+source .venv/bin/activate
+
+# Install dev dependencies (pytest, pytest-qt, ruff, build) and the package
+pip install -r requirements-dev.txt
+pip install -e .
+```
+
+Run tests and linting:
+```bash
+pytest -v
+ruff check .
+ruff format --check .
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE) and [THIRD_PARTY_LICENSES](THIRD_PARTY_LICENSES).

qtm_rt_pyside6-0.3.4/THIRD_PARTY_LICENSES

@@ -0,0 +1,46 @@
+This project uses the following third-party libraries:
+
+================================================================================
+PySide6 — The Qt Company
+================================================================================
+
+License: GNU Lesser General Public License v3.0 (LGPL-3.0)
+Homepage: https://www.qt.io/qt-for-python
+Source: https://code.qt.io/cgit/pyside/pyside-setup.git
+
+PySide6 provides Python bindings for the Qt framework. It is used as a runtime
+dependency and is dynamically linked. Users may replace PySide6 with any
+compatible version under the terms of the LGPL v3.
+
+The full text of the LGPL v3 license is available at:
+https://www.gnu.org/licenses/lgpl-3.0.html
+
+================================================================================
+Qualisys Python SDK (qtm_rt) — Qualisys AB
+================================================================================
+
+License: MIT
+Homepage: https://github.com/qualisys/qualisys_python_sdk
+Included as: Git submodule (qtm_rt/)
+
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Qualisys
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qtm_rt_pyside6-0.3.4/examples/README.md

@@ -0,0 +1,71 @@
+# Examples
+
+Ready-to-run scripts demonstrating `qtm-rt-pyside6`. Each example is
+self-contained — install the package, start QTM, and run.
+
+## Prerequisites
+
+- A QTM installation reachable on the network (or `127.0.0.1` if local).
+- `qtm-rt-pyside6` installed (`pip install qtm-rt-pyside6`, or
+  `pip install -e .` from a checkout).
+- For the streaming examples, QTM should be playing back data — load a
+  file in QTM and choose **Play → Play with Real-Time output**, or run
+  a live capture.
+- The 3D and Widgets GUI examples need a display; the rest run in a
+  plain console.
+
+## Quick reference
+
+| Script | What it shows | Run |
+|---|---|---|
+| [`basic_example.py`](basic_example.py) | Stream 3D markers to the console, exit cleanly after 100 frames | `python basic_example.py` |
+| [`discovery_example.py`](discovery_example.py) | UDP-broadcast discovery of QTM instances on the network | `python discovery_example.py [interface_ip]` |
+| [`parameters_example.py`](parameters_example.py) | Request QTM configuration as XML and parse 3D markers, 6DOF bodies, and skeletons out of it | `python parameters_example.py` |
+| [`gui_example.py`](gui_example.py) | Qt Widgets app combining discovery, connect/disconnect, and a live data table with frame rate | `python gui_example.py` |
+| [`gui_3d_example/main.py`](gui_3d_example/main.py) | Qt Quick 3D viewer showing markers as spheres and skeletons as bones, with an orbit camera | `python gui_3d_example/main.py` |
+
+If you're new to the SDK, start with `basic_example.py` to confirm the
+connection works, then look at `discovery_example.py` or one of the GUI
+examples depending on what you're building.
+
+## Notes on individual examples
+
+### `basic_example.py`
+Minimal connect-and-stream loop. Exits automatically after 100 frames
+(`FRAME_LIMIT`) so it's safe to run unattended.
+
+### `discovery_example.py`
+Sends a UDP broadcast on port 22226 and prints every QTM instance that
+replies within the 2-second timeout.
+
+On machines with multiple network interfaces, the broadcast may not
+reach the QTM subnet when bound to "any" interface. Pass the local
+interface IP as the first argument to bind explicitly:
+
+```
+python discovery_example.py 192.168.10.100
+```
+
+### `parameters_example.py`
+Connects, requests `3d`, `6d`, and `skeleton` parameters, parses the
+returned XML, and prints marker / body / skeleton names. Useful as a
+template for any "fetch and inspect QTM configuration" task.
+
+### `gui_example.py`
+PySide6 / QtWidgets app with discovery, connection management, and a
+live data table. A good starting point for desktop tools built on top
+of the SDK.
+
+### `gui_3d_example/`
+PySide6 / Qt Quick 3D scene that streams 3D markers, 6DOF bodies, and
+skeletons from QTM and renders them as primitives with an orbit
+camera. The Python `main.py` provides the data backend; `main.qml`
+defines the scene.
+
+## Known limitation: TCP streaming only in these examples
+
+All streaming examples use TCP (the default). The SDK also supports
+UDP streaming via `streamFrames(..., udp_port=...)` — see the
+`QTMConnection` docstring or `help(QTMConnection)` for details. None
+of the bundled examples currently demonstrate UDP; contributions
+welcome.