English | 简体中文

OptiKey-ET5-Plugin

Open-source Tobii Eye Tracker 5 (ET5) input plugin for OptiKey 4.x.

Designed for individuals with ALS/MND, locked-in syndrome, and severe motor disabilities who rely on assistive computer access and augmentative and alternative communication (AAC).

• Operating System: Windows 10 / 11 (64-bit)
• Host Application: OptiKey 4.x
• Hardware: Tobii Eye Tracker 5
• Zero Bundled Binaries: Seamlessly uses the user's locally installed Tobii Experience runtime
• Strict Privacy Invariant: Real-time memory processing only; zero gaze logging, persistence, or telemetry
• Clean Architecture: Interruptible callback pump with bounded shutdown and stuck-worker isolation

---

Requirements

Before using this plugin, ensure your workstation satisfies:

1. Windows 10 or 11 (x64).
2. Tobii Eye Tracker 5 connected to your primary display.
3. Official Tobii Experience installed from Tobii Gaming Getting Started with display setup and user calibration successfully completed.
4. OptiKey 4.x installed from OptiKey Releases.

For display resolutions, aspect ratios, and DPI scaling information, consult the Compatibility Guide.

---

Quick Start

The standard user experience requires zero code compilation or manual DLL copying:

Install Tobii Experience & Calibrate ET5
                 ↓
Launch OptiKey -> Open Management Console (Alt + M)
                 ↓
Navigate to "Pointing & Selecting"
                 ↓
Click "Find more eye tracker options online"
                 ↓
Select "Tobii Eye Tracker 5" -> Click Install
                 ↓
Select as Pointing Device -> Start Gaze Control

For complete offline installation and multi-device configuration steps, see the Installation & Setup Guide.

---

Troubleshooting

• Plugin not found in OptiKey: Verify that OptiKey.ET5.Plugin.dll is located under %APPDATA%\OptiKey\OptiKey\EyeTrackerPlugins\ (e.g. %APPDATA%\OptiKey\OptiKey\EyeTrackerPlugins\OptiKey-ET5-Plugin\OptiKey.ET5.Plugin.dll).
• Runtime Not Found: Ensure official Tobii Experience is installed and the Tobii Service is running in services.msc.
• Red Disconnected State: Unplug and reconnect the Eye Tracker 5 USB cable, then re-open OptiKey.
• Diagnostic Tool: Run tools/HardwareDiagnostics/diagnose.ps1 to inspect runtime discovery, PE architecture, and code signatures.

Detailed diagnostic flows are available in the Troubleshooting Guide.

---

Privacy & Safety

• Volatile Processing: Gaze coordinates are processed in volatile memory solely to dispatch real-time pointer events.
• Zero Storage: Raw coordinates, eye images, and device URLs are never saved to disk or transmitted.
• Zero Telemetry: No analytics or remote network calls exist in this codebase.
• Fail-Safe Worker Isolation: Bounded shutdown loops protect the OptiKey host application from unmanaged crashes.

Read our full Biometric Privacy Policy and Security Architecture.

---

Documentation Navigation

Comprehensive documentation is organized by audience in our Documentation Hub:

• User Guides: Installation, Troubleshooting, Compatibility
• Project Status: Status Dashboard, Roadmap
• Policies & Compliance: Legal & Provenance, Privacy, Third-Party Notices
• Development & Architecture: Agent SOP, Documentation Policy, Hardware Protocol, Architecture Decision Records (ADRs)
• Technical Research: ABI Provenance, Runtime Research, Callback Research

---

Community & Contributing

• Report Issues: Submit bug reports via GitHub Issue Templates.
• Contributing: Review our Contributing Guidelines and Code of Conduct.
• Agent Instructions: Coding agents must follow AGENTS.md.

---

License

This project is licensed under the GNU General Public License v3.0 only (GPL-3.0-only). No proprietary Tobii software, binaries, or headers are bundled or redistributed.