pbl-exp 0.1__py3-none-any.whl

PBL/exp/__init__.py

@@ -0,0 +1,3 @@
+from .pupil_labs import get_pupil_labs_device, send_event_to_pupil_labs
+
+__all__ = ["get_pupil_labs_device", "send_event_to_pupil_labs"]

PBL/exp/pupil_labs.py

@@ -0,0 +1,99 @@
+import sys
+from time import time_ns
+
+from psychopy import gui, logging
+from pupil_labs.realtime_api.simple import Device, discover_devices
+
+
+def get_pupil_labs_device(search_duration_seconds=5.0):
+    """
+    Get the Pupil Labs device and its time offset.
+
+    Parameters
+    ----------
+    search_duration_seconds : float
+        Duration to search for Pupil Labs devices.
+
+    Returns
+    -------
+    device : object or None
+        The connected Pupil Labs device, or None if not used.
+    median_offset_ns : int or None
+        The estimated median time offset of the device in nanoseconds, or None if not used.
+
+    Raises
+    ------
+    RuntimeError
+        If no Pupil Labs device is found when one is expected.
+    """
+    # Get whether to use the Pupil Labs Eye Tracker
+    dlg = gui.Dlg(title="Pupil Labs Eye Tracker")
+    dlg.addField("Use Pupil Labs eye tracker?", False, choices=[True, False])
+    dlg_data = dlg.show()
+    sys.exit() if not dlg.OK else None
+    record_pl = dlg_data[0]
+
+    if record_pl:
+        devices = discover_devices(search_duration_seconds=search_duration_seconds)
+        if not devices:
+            dlg = gui.Dlg(title="No Pupil Labs device found")
+            dlg.addText("No Pupil Labs device found. Check your connection.")
+            dlg.show()
+            raise RuntimeError("No Pupil Labs device found.")
+        elif len(devices) == 1:
+            device = devices[0]
+            dlg = gui.Dlg(title="Pupil Labs configuration")
+            dlg.addText(f"Using the only Pupil Labs device found at {device.address}")
+            dlg.show()
+        else:
+            ip_addresses = [device.address for device in devices]
+            dlg = gui.Dlg(title="Pupil Labs configuration")
+            dlg.addText("Multiple Pupil Labs devices found.")
+            dlg.addField("Select the device to use:", choices=ip_addresses)
+            dlg.show()
+            selected_ip = dlg.data[0]
+            for d in devices:
+                if d.address == selected_ip:
+                    device = d
+                else:
+                    d.close()
+        logging.info(f"Connected to Pupil Labs device at {device.address}")
+
+        median_offset_ns = round(
+            device.estimate_time_offset().time_offset_ms.median * 1_000_000
+        )
+        offset_std = round(device.estimate_time_offset().time_offset_ms.std * 1_000_000)
+        logging.info(
+            f"Estimated Pupil Labs device time offset (ns) = {median_offset_ns} ± {offset_std} (median ± std)"
+        )
+
+        return device, median_offset_ns
+    else:
+        return None, None
+
+
+def send_event_to_pupil_labs(device: Device, event_string: str, clock_offset_ns: int):
+    """
+    Send an event to the Pupil Labs device with a timestamp.
+
+    Parameters
+    ----------
+    device : Device
+        The connected Pupil Labs device.
+    event_string : str
+        The event description to send.
+    clock_offset_ns : int
+        The clock offset in nanoseconds to adjust the event timestamp.
+    """
+    if device is not None:
+        device.send_event(
+            event_string,
+            event_timestamp_unix_ns=int(time_ns() - clock_offset_ns),
+        )
+
+
+if __name__ == "__main__":
+    logging.console.setLevel(logging.INFO)
+    device, offset_ns = get_pupil_labs_device()
+    if device is not None:
+        device.close()

pbl_exp-0.1.dist-info/METADATA

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: pbl-exp
+Version: 0.1
+Summary: Helper functions for running experiments at the Predictive Brain Lab (Bochum)
+Author-email: Qian Chu <qianchu99@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psychopy
+Requires-Dist: pupil-labs-realtime-api
+Requires-Dist: sr-research-pylink
+Dynamic: license-file
+
+# pbl-exp
+

pbl_exp-0.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+PBL/exp/__init__.py,sha256=kUAinEwPe-XFXPUMiNUIiMQ2Mcnim6LoUg6WF2fEuH4,137
+PBL/exp/eyelink.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PBL/exp/psychopy.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PBL/exp/pupil_labs.py,sha256=TVYulqy7w3gNqxdIa21qF5GKh8M2VFo_X3_4n5WMu2Q,3338
+pbl_exp-0.1.dist-info/licenses/LICENSE,sha256=Kp1DPQGh36k51G0yLkCg_spVbXzIi66A3FbmfEfylaE,1065
+pbl_exp-0.1.dist-info/METADATA,sha256=tLv5m3rbfCI7BiLCcixtLGYz3ZhpPAfaHLMpulZqRnc,398
+pbl_exp-0.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+pbl_exp-0.1.dist-info/top_level.txt,sha256=f91EmcvJrGR9OWvloABxrRykiMkHNcZhxeBj-bTK06c,4
+pbl_exp-0.1.dist-info/RECORD,,

pbl_exp-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pbl_exp-0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Qian Chu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pbl_exp-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+PBL