mirror of
https://github.com/EyeTrackVR/EyeTrackVR-Docs.git
synced 2025-11-04 14:49:44 +08:00
2 lines
5.8 KiB
JavaScript
2 lines
5.8 KiB
JavaScript
import{_ as s,a as n}from"./chunks/index.339f98d7.js";import{_ as d,i as p}from"./chunks/index.c1fed1bd.js";import{o as u,c,O as r,E as a,w as l,l as o,k as t,a as i}from"./chunks/framework.47aa8d5b.js";const _=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1745116122000}'),h={name:"getting_started/intro.md"},w=Object.assign(h,{setup(f){return(m,e)=>(u(),c("div",null,[e[2]||(e[2]=r('<h1 class="text-3xl font-bold underline text-[#ab5ac7]" id="eyetrackvr" tabindex="-1">EyeTrackVR <a class="header-anchor" href="#eyetrackvr" aria-label="Permalink to "EyeTrackVR {.text-3xl .font-bold .underline .text-[#ab5ac7]}""></a></h1><p>EyeTrackVR is a Source First, affordable eye-tracking platform designed specifically for Virtual Reality—especially for Social VR experiences like VRChat. It works by sending real-time eye tracking data over <code>OSC</code> or <code>UDP</code>, making it compatible with many existing VR applications.</p><p>Whether you're here to build your own tracker, contribute to development, or explore how it works, you're in the right place.</p><hr><h2 id="get-started" tabindex="-1">Get Started <a class="header-anchor" href="#get-started" aria-label="Permalink to "Get Started""></a></h2><p>This documentation covers everything from assembly and firmware setup to headset mounting and safety. If you're new to the project, we recommend starting with the following pages:</p><ul><li><a href="https://docs.eyetrackvr.dev/getting_started/things_to_know" target="_blank" rel="noreferrer">Things to Know</a> – Important background before diving in</li><li><a href="https://docs.eyetrackvr.dev/how_to_build/full_build" target="_blank" rel="noreferrer">Full Build Guide</a> – Step-by-step assembly instructions</li></ul>',7)),a(s,{options:o(n).user_warning},{content:l(()=>e[0]||(e[0]=[t("p",null," This project is under active development, but it's already working reliably for many users. Your feedback helps us improve! ",-1)])),_:1},8,["options"]),e[3]||(e[3]=r('<hr><h2 id="eye-safety-notice" tabindex="-1">Eye Safety Notice <a class="header-anchor" href="#eye-safety-notice" aria-label="Permalink to "Eye Safety Notice""></a></h2><p>Eye safety is a top priority. Infrared (IR) light is invisible but not harmless—especially at close distances and high intensities. EyeTrackVR has built-in safety measures, but users must also follow proper precautions.</p><p><strong>Always use the recommended LEDs, wiring, and firmware settings.</strong></p><div class="danger custom-block"><p class="custom-block-title">DANGER</p><p>Never bypass safety features or swap out IR components without understanding the risks. Doing so could result in permanent eye damage.</p></div><p>Our default configuration stays well below international safety thresholds (see <a href="../safety/ICNIRP_optical_radiation.pdf">ICNIRP guidelines</a>), but it's your responsibility to:</p><ul><li>Use non-focused emitters</li><li>Keep total radiant intensity below <strong>5 mW/sr</strong></li><li>Verify LED brightness with an IR camera</li><li>Stop using the device if you feel warmth or discomfort in your eyes</li></ul>',7)),a(s,{options:o(n).led_power_warning},{content:l(()=>e[1]||(e[1]=[t("p",null,[i(" Use only "),t("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),i(" LEDs, and ensure total output is "),t("strong",null,"4 mW/sr or less"),i(". ")],-1)])),_:1},8,["options"]),e[4]||(e[4]=r('<details class="details custom-block"><summary>Safety References</summary><p><a href="../safety/effect_of_ir_on_the_lens.pdf">Effect of infrared radiation on the lens</a><br><a href="../safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf">Photobiological safety of LED light sources</a><br><a href="../safety/ICNIRP_optical_radiation.pdf">ICNIRP Guidelines (0.38 to 3 µm)</a><br><a href="../safety/training-library_nir_stds_20021011.pdf">Training Library – NIR Standards</a></p></details><hr><h2 id="hardware-overview" tabindex="-1">Hardware Overview <a class="header-anchor" href="#hardware-overview" aria-label="Permalink to "Hardware Overview""></a></h2><p>See our <a href="https://docs.eyetrackvr.dev/how_to_build/part_list" target="_blank" rel="noreferrer">Parts List</a> and <a href="https://github.com/EyeTrackVR/EyeTrackVR-Hardware" target="_blank" rel="noreferrer">Hardware Repository</a> to source components, print mounts, and prepare your setup.</p><h2 id="firmware" tabindex="-1">Firmware <a class="header-anchor" href="#firmware" aria-label="Permalink to "Firmware""></a></h2><p>The firmware powering EyeTrackVR's ESP32 cameras is called <strong>OpenIris</strong>, developed by <code>lorow</code>.<br> You can find it <a href="https://github.com/EyeTrackVR/OpenIris" target="_blank" rel="noreferrer">here on GitHub</a>.</p><hr><h2 id="headset-compatibility" tabindex="-1">Headset Compatibility <a class="header-anchor" href="#headset-compatibility" aria-label="Permalink to "Headset Compatibility""></a></h2><p>EyeTrackVR can work with any VR headset—but not every model has a 3D-printed mount available yet.</p><p>Check our <a href="https://docs.eyetrackvr.dev/how_to_build/parts_list#_3d-printed-mounts" target="_blank" rel="noreferrer">mount list</a> to see if your headset is supported.<br> If not, you’re welcome to design your own or wait for a community-sourced version.</p><hr><h2 id="community-support" tabindex="-1">Community & Support <a class="header-anchor" href="#community-support" aria-label="Permalink to "Community & Support""></a></h2><p>Join our Discord server for updates, and community projects. We’re excited to have you on board!</p>',13)),a(d,{options:o(p).discord_content},null,8,["options"])]))}});export{_ as __pageData,w as default};
|