Metadata-Version: 2.4
Name: pyrobotiqtactile
Version: 0.1.2
Summary: Python support for the Robotiq TSF-85 tactile sensor
Author: Benoit CASTETS
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/bcastets-robotiq/pyRobotiqTactile
Project-URL: Repository, https://github.com/bcastets-robotiq/pyRobotiqTactile
Project-URL: Issues, https://github.com/bcastets-robotiq/pyRobotiqTactile/issues
Classifier: Development Status :: 3 - Alpha
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: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: numpy>=1.26
Requires-Dist: pyserial>=3.5
Dynamic: license-file

# pyRobotiqTactile

A Python package for communicating with the Robotiq TSF-85 tactile sensor.

The project focuses on a public `RobotiqTactileSensor` class that provides:

- serial communication setup
- sensor configuration and autosend control
- pressure-frame decoding as NumPy arrays
- accelerometer and gyroscope access
- a structured `SensorReading` container for the decoded data

## Installation

```bash
pip install pyrobotiqtactile
```

For local development:

```bash
uv sync
uv run python -m unittest discover -s tests -v
```

## Quick start

### Explicit connection

If you already know the port name:

```python
from pyrobotiqtactile import RobotiqTactileSensor

sensor = RobotiqTactileSensor()
sensor.connect("COM3")
sensor.configure(update_period_ms=50, synchronous=True)

reading = sensor.read_frame()
print(reading.pressure.shape)
print(sensor.get_imu())
```

## Package structure

- `protocol.py`: low-level packet framing and parsing
- `data.py`: NumPy-friendly decoded sensor containers
- `sensor.py`: high-level `RobotiqTactileSensor` API

## Development

```bash
uv sync
uv build
uv run python -m unittest discover -s tests -v
```
