PyeLink Documentation

PyeLink is a modern Python wrapper for SR Research EyeLink eye trackers with multi-backend display support (pygame, PsychoPy, pyglet). It provides programmatic control over the full EyeLink workflow—connection, calibration with configurable parameters, recording with real-time data access, and direct access to any EyeLink command for advanced configurations.

Getting Started

• Getting Started
  • Installation
  • Quick Start
  • Advanced Configuration
  • Usage Patterns

API Reference

• API Reference
  • Core – EyeLink
  • Settings
  • Data Buffer
  • Event Processor
  • Audio
  • Utilities
  • Display
  • Calibration
  • Version Compatibility

Reference

• Direct Tracker Control
• Default Settings
• EyeLink Commands Reference

---

Note

If you use PyeLink in your research, please cite:

Salari, M., Nyström, M., Niehorster, D. C., & Bednarik, R. (2026). PyeLink and SyeLink: Open-source Python tools for low-level EyeLink experiment control and data parsing. In Proceedings of the 2026 Eye Tracking Research & Applications (ETRA 2026) Late-Breaking Work. ACM. DOI: 10.1145/3797246.3805844

Note

This project has received funding from the European Union’s Horizon Europe research and innovation funding program under grant agreement No 101072410, Eyes4ICU project.

Author: Mohammadhossein Salari