EyeTrackVR-Docs/assets/getting_started_intro.md.b9a8b634.js
RedHawk989 d21aa6dfec docs: Merge pull request #22 from Frosty704/main with tweaks
Updated camera page to have IR filter removal, parts updates, JLC3DP page, 3d Printed Mounts update, clarify wording
2024-10-06 18:52:47 +00:00

2 lines
6.7 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as s,a as n}from"./chunks/index.b5dd7625.js";import{_ as d,i as c}from"./chunks/index.3af2e52b.js";import{o as h,c as u,O as t,E as r,w as l,l as o,k as a,a as i}from"./chunks/framework.a4daa24a.js";const k=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1700510338000}'),p={name:"getting_started/intro.md"},w=Object.assign(p,{setup(m){return(f,e)=>(h(),u("div",null,[e[2]||(e[2]=t('<h1 class="text-3xl font-bold underline text-[#ab5ac7]" id="eyetrackvr" tabindex="-1">EyeTrackVR <a class="header-anchor" href="#eyetrackvr" aria-label="Permalink to &quot;EyeTrackVR {.text-3xl .font-bold .underline .text-[#ab5ac7]}&quot;"></a></h1><p>Open source and <em>affordable</em> VR eye tracker platform for Social VR Games via <code>OSC</code> and <code>UDP</code> protocol.</p><h3 id="welcome-to-the-eyetrackvr-documentation-website-here-you-will-find-all-available-documentation-regarding-building-development-and-other-resources-related-to-this-project" tabindex="-1">Welcome to the EyetrackVR documentation website. Here you will find all available documentation regarding building, development, and other resources related to this project. <a class="header-anchor" href="#welcome-to-the-eyetrackvr-documentation-website-here-you-will-find-all-available-documentation-regarding-building-development-and-other-resources-related-to-this-project" aria-label="Permalink to &quot;Welcome to the EyetrackVR documentation website. Here you will find all available documentation regarding building, development, and other resources related to this project.&quot;"></a></h3><p>Want to get started? Check out the <a href="https://docs.eyetrackvr.dev/getting_started/things_to_know" target="_blank" rel="noreferrer">getting started page</a> and then the <a href="https://docs.eyetrackvr.dev/how_to_build/full_build" target="_blank" rel="noreferrer">full build guide.</a></p>',4)),r(s,{options:o(n).user_warning},{content:l(()=>e[0]||(e[0]=[a("p",null," This project is in active development. However, it is working for most users. ",-1)])),_:1},8,["options"]),e[3]||(e[3]=t('<h2 id="about-ir-emitter-safety" tabindex="-1">About IR Emitter Safety <a class="header-anchor" href="#about-ir-emitter-safety" aria-label="Permalink to &quot;About IR Emitter Safety&quot;"></a></h2><p>Please <em>exercise caution</em> when messing around with IR emitters.</p><p>IR can be dangerous to your eyes once at a certain power level. It is not recommended to use different emitters unless you know exactly what you are doing as it could result in harm to your eyes. If you doubt yourself, just do exactly what we do. Don&#39;t use different emitters, don&#39;t use different means of power, etc.</p><div class="danger custom-block"><p class="custom-block-title">DANGER</p><p>It is important that you <ins><strong>DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE</strong></ins>. This can result in irreversible bodily harm.</p></div><p>The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities are on the user. This includes visually checking with an IR camera that the brightness is correct and that you do not feel warmth or experience short-term effects after being exposed to the IR light (symptoms such as dark spots or dry/warm feeling eyes while actively using). While we strive to make EyeTrackVR as safe as possible, we do not hold any responsibility for damage done.</p>',5)),r(s,{options:o(n).led_power_warning},{content:l(()=>e[1]||(e[1]=[a("p",null,[i(" Make sure you are using "),a("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),i(" emitters and no more than "),a("ins",{class:"font-bold"},"5 mW/sr"),i(" total power. ")],-1)])),_:1},8,["options"]),e[4]||(e[4]=t('<details class="details custom-block"><summary>Want to see the safety data sheets?</summary><p><a href="../safety/effect_of_ir_on_the_lens.pdf">Effect of infrared radiation on the lens</a></p><p><a href="../safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf">AN002_Details on photobiological safety of LED light sources</a></p><p><a href="../safety/training-library_nir_stds_20021011.pdf">Training-library Nir Stds</a></p><p><a href="../safety/ICNIRP_optical_radiation.pdf">ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)</a></p></details><h2 id="hardware" tabindex="-1">Hardware <a class="header-anchor" href="#hardware" aria-label="Permalink to &quot;Hardware&quot;"></a></h2><p>Please check out our <a href="https://docs.eyetrackvr.dev/how_to_build/parts_list" target="_blank" rel="noreferrer">parts list</a> and <a href="https://github.com/EyeTrackVR/EyeTrackVR-Hardware" target="_blank" rel="noreferrer">hardware repo.</a> for information regarding hardware.</p><h2 id="firmware" tabindex="-1">Firmware <a class="header-anchor" href="#firmware" aria-label="Permalink to &quot;Firmware&quot;"></a></h2><p>Our firmware called OpenIris is made by <code>lorow</code> found <a href="https://github.com/lorow/OpenIris" target="_blank" rel="noreferrer">here</a>.</p><h2 id="headset-support" tabindex="-1">Headset support <a class="header-anchor" href="#headset-support" aria-label="Permalink to &quot;Headset support&quot;"></a></h2><p>In theory, we are compatible with every VR headset. However, mounts may not have been made yet. Please take a look at our list of <a href="https://docs.eyetrackvr.dev/how_to_build/parts_list#_3d-printed-mounts" target="_blank" rel="noreferrer">3d printable mounts</a> and see if your headset is on the list. If it is not listed, It is recommended that you try to make a mount, or wait for a skilled community member to create one.</p><h4 id="contact" tabindex="-1">Contact <a class="header-anchor" href="#contact" aria-label="Permalink to &quot;Contact&quot;"></a></h4><p>Please join our discord for updates and any questions. We hope to see you there!</p>',9)),r(d,{options:o(c).discord_content},null,8,["options"]),e[5]||(e[5]=t('<h1 id="licenses" tabindex="-1">Licenses <a class="header-anchor" href="#licenses" aria-label="Permalink to &quot;Licenses&quot;"></a></h1><p><a href="https://github.com/EyeTrackVR/EyeTrackVR/blob/main/LICENSE" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/license/EyeTrackVR/EyeTrackVR?style=plastic" alt="GitHub license"></a></p><p><em><strong>All software is under the <a href="http://opensource.org/licenses/MIT" target="_blank" rel="noreferrer">MIT License</a>. All documentation, including the <a href="https://github.com/EyeTrackVR/EyeTrackVR/wiki" target="_blank" rel="noreferrer">Wiki</a>, is under the Creative Commons CC-BY-SA-4.0 license</strong></em>.</p>',3))]))}});export{k as __pageData,w as default};