PyeLink Documentation
=====================

|PyPI| |Downloads| |License| |Documentation| |DOI|

.. |PyPI| image:: https://img.shields.io/pypi/v/pyelink
   :target: https://pypi.org/project/pyelink/
   :alt: PyPI version

.. |Downloads| image:: https://static.pepy.tech/badge/pyelink
   :target: https://pepy.tech/project/pyelink
   :alt: Downloads

.. |License| image:: https://img.shields.io/pypi/l/pyelink
   :target: https://github.com/mh-salari/pyelink/blob/main/LICENSE
   :alt: License

.. |Documentation| image:: https://readthedocs.org/projects/pyelink/badge/?version=latest
   :target: https://pyelink.readthedocs.io/
   :alt: Documentation

.. |DOI| image:: https://img.shields.io/badge/DOI-10.1145%2F3797246.3805844-blue
   :target: https://doi.org/10.1145/3797246.3805844
   :alt: DOI

**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.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index

.. toctree::
   :maxdepth: 1
   :caption: Reference

   direct_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 <https://doi.org/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.

.. image:: ../resources/Funded_by_EU_Eyes4ICU.png
   :alt: Funded by EU Eyes4ICU
   :align: center
   :width: 500px

| Author: `Mohammadhossein Salari <https://mh-salari.ir>`_