{"id":18456460,"url":"https://github.com/pollen-robotics/pupil_client","last_synced_at":"2025-04-22T19:27:14.887Z","repository":{"id":83155659,"uuid":"130707667","full_name":"pollen-robotics/pupil_client","owner":"pollen-robotics","description":"Pupil client utility - retrieve gaze information from Pupil Remote","archived":false,"fork":false,"pushed_at":"2018-04-23T15:22:23.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-16T14:58:32.702Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pollen-robotics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-23T14:16:44.000Z","updated_at":"2018-04-23T15:22:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"c4040f36-c4a0-46ae-ba32-c2115475a012","html_url":"https://github.com/pollen-robotics/pupil_client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pollen-robotics%2Fpupil_client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pollen-robotics%2Fpupil_client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pollen-robotics%2Fpupil_client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pollen-robotics%2Fpupil_client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pollen-robotics","download_url":"https://codeload.github.com/pollen-robotics/pupil_client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250307796,"owners_count":21409147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T08:11:37.033Z","updated_at":"2025-04-22T19:27:14.862Z","avatar_url":"https://github.com/pollen-robotics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pupil Client Library\n\n[![Build Status](https://travis-ci.org/pollen-robotics/pupil_client.svg?branch=master)](https://travis-ci.org/pollen-robotics/pupil_client)\n\n[Pupil-labs device](https://pupil-labs.com) client library. It retrieves the gaze 3d point from the [Pupil Remote](https://docs.pupil-labs.com/#network-plugins) software and its associate timestamp. The library works asynchronously.\n\nIt works on Python \u003e=2.7 \u0026 \u003e=3.3.\n\n## Installation\n\nThe library can be installed via pip:\n\n```bash\n$ (sudo) pip install pupil_client\n```\n\nIt can also be build from the source. It depends on:\n* [pyzmq](https://github.com/zeromq/pyzmq)\n* [msgpack](https://github.com/msgpack/msgpack-python)\n\n## Getting Started\n\nFirst, make sure to setup your Pupils-labs and Pupil remote correctly. Make sure to follow the [official documentation](https://docs.pupil-labs.com). Once you have calibrated your setup and your the Pupil Remote plugin is setup, you can use *pupil_client* as follows:\n\n```python\nimport time\n\nfrom pupil_client import PupilClient\n\n# Use the IP where Pupil Remote is running\n# The default port is 50020 but you can change it in Pupil Remote\npupil = PupilClient('192.168.0.29', 50020)\n\n# Wait for pupil client to actually receive data from the server.\nwhile not pupil.ready:\n    time.sleep(0.1)\nprint('Pupil Client ready!')\n\nwhile True:\n    # Reads gaze 3d point and timestamp (done asynchronously).\n    (x, y, z) = pupil.gaze.pt3d\n    timestamp = pupil.gaze.t\n\n    print('Gaze point 3d: {} (at t={})'.format([x, y, z], timestamp)\n    time.sleep(1)\n```\n\n## License\n\nThis project is licensed under the BSD-3.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpollen-robotics%2Fpupil_client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpollen-robotics%2Fpupil_client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpollen-robotics%2Fpupil_client/lists"}