Metadata-Version: 2.4
Name: metaquest-teleop
Version: 0.4.0
Summary: Meta Quest hand tracking streamed to Python over USB, for teleoperation: wrist poses, 25 joints and 20 joint angles per hand.
Author: Gregorio Valenti, Lorenzo Vignoli
License-Expression: MIT
Project-URL: Homepage, https://github.com/vigno0405/MetaQuestTeleop
Project-URL: Documentation, https://vigno0405.github.io/MetaQuestTeleop/
Project-URL: Issues, https://github.com/vigno0405/MetaQuestTeleop/issues
Keywords: meta quest,quest 3,webxr,hand tracking,teleoperation,robotics,vr
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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 :: Human Machine Interfaces
Classifier: Topic :: System :: Hardware
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.8
Requires-Dist: numpy>=1.21
Requires-Dist: rich>=12
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=7.2; extra == "docs"
Requires-Dist: myst-parser>=2; extra == "docs"
Requires-Dist: sphinx-immaterial>=0.12; extra == "docs"
Dynamic: license-file

# MetaQuestTeleop

[![Documentation](https://img.shields.io/badge/Documentation-guides%20%C2%B7%20API-3c5488?labelColor=13294b)](https://vigno0405.github.io/MetaQuestTeleop/)
[![PyPI](https://img.shields.io/pypi/v/metaquest-teleop?color=3c5488&labelColor=13294b)](https://pypi.org/project/metaquest-teleop/)
[![CI](https://github.com/vigno0405/MetaQuestTeleop/actions/workflows/ci.yml/badge.svg)](https://github.com/vigno0405/MetaQuestTeleop/actions/workflows/ci.yml)

Stream your hands from a Meta Quest to Python, to control robots. Up to 120 times a second you
get both wrists, 25 joints and 20 joint angles per hand. Nothing to install on the headset.

<p align="center">
  <img src="https://raw.githubusercontent.com/vigno0405/MetaQuestTeleop/main/docs/_static/view-hand.png" width="720" alt="The 3D view: a right hand on its forearm, with its joint angles">
</p>

**Documentation: https://vigno0405.github.io/MetaQuestTeleop/**

## Install

```bash
pip install metaquest-teleop
```

You also need `adb`, the tool that talks to the headset over USB (Ubuntu: `sudo apt install
adb`, macOS: `brew install --cask android-platform-tools`), and, once, on the headset:
developer mode and hand tracking on.
[Get started](https://vigno0405.github.io/MetaQuestTeleop/start.html) has the details.

## Run

1. Plug in the headset and run `metaquest-teleop`.
2. In the Quest's browser, open **http://localhost:8012** and press **Start**.
3. Watch your hands in the terminal, or in 3D at **http://localhost:8012/view**
   ([try the 3D view in your browser](https://vigno0405.github.io/MetaQuestTeleop/view.html#try-it-here)).

No headset? Run `metaquest-teleop --no-adb`, and `metaquest-teleop-fake` in a second terminal.

## Use it in Python

```python
from metaquest_teleop import QuestHands

with QuestHands() as quest:
    while True:
        frame = quest.wait()  # the next frame from the headset
        if frame.right is not None:
            print(frame.right.wrist.position, frame.right.pinch)
```

## ADAPT hand

`metaquest_teleop.adapt` turns your hand into the ADAPT hand's 20 joint angles and 13 motor
angles, and gives your wrist's pose: see [ADAPT Hand](https://vigno0405.github.io/MetaQuestTeleop/adapt.html).

## License

MIT. Written by Gregorio Valenti and Lorenzo Vignoli.
