Skip to content
Snippets Groups Projects
Commit 6e4ad734 authored by Maxence Grand's avatar Maxence Grand
Browse files

write doc + add licence

parent 3a041a00
No related branches found
No related tags found
No related merge requests found
LICENSE 0 → 100644
This diff is collapsed.
# Tobii
A repository for managing Tobii eye-tracking devices on Ubuntu 20.04. This project includes installation scripts, dependency handling, calibration tools, and guidance for using the Tobii 4C driver and Tobii Pro Eye Tracker Manager.
## Driver installation
All dependencies and installation scripts and deb files are tested for Ubuntu 20.04
......@@ -26,4 +28,60 @@ The manager is obtained at https://developer.tobiipro.com/eyetrackermanager.html
sudo apt install /path/to/manager/TobiiProEyeTrackerManager-2.4.11
## Usage
## Launcher Scripts
### Overview
The **launcher/launch.py** script provides a comprehensive tool to manage the calibration, validation, and recording of data from the Tobii Pro 4C. It enables you to:
* Connect to a Tobii eye tracker.
* Perform and validate calibrations.
* Record gaze data for participants.
### Dependencies for **launcher/launch.py**
```bash
pip install tobii-research
```
### Usage of **launcher/launch.py**
```bash
python3.10 launcher/launch.py
```
#### Key Features
1. **Participant Information**: The script prompts for participant ID and a directory to save the data.
2. **Calibration and Validation**:
* Calibration is performed using the Calibrator class.
* Validation checks ensure the calibration is accurate.
3. **Data Recording**:
* Gaze data is saved as a CSV file in the specified directory.
* The filename includes the structure name entered during the session.
#### Example Workflow
1. Launch the script:
```bash
python3.10 launcher/launch.py
```
2. Enter the participant ID and directory path when prompted.
3. Follow the on-screen instructions to:
* Calibrate the tracker.
* Validate calibration.
* Record gaze data.
4. Repeat experiments as needed or terminate the session when complete.
---
## Contact
For questions or support, please contact:
- Maxence Grand
- Email: Maxence.Grand@univ-grenoble-alpes.fr
---
## License
This project is licensed under the GNU LGPL 2.1 license.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment