mirror of
https://github.com/EyeTrackVR/EyeTrackVR.git
synced 2025-11-04 14:39:42 +08:00
update readme
This commit is contained in:
parent
42a46e9ca1
commit
64444b1585
39
README.md
39
README.md
@ -7,7 +7,7 @@ Picture courtesy of Wackalope#6737
|
|||||||
- [This project is in development and is not fully finished](#this-project-is-in-development-and-is-not-fully-finished)
|
- [This project is in development and is not fully finished](#this-project-is-in-development-and-is-not-fully-finished)
|
||||||
- [Hardware](#hardware)
|
- [Hardware](#hardware)
|
||||||
- [About IR Emitter Safety](#about-ir-emitter-safety)
|
- [About IR Emitter Safety](#about-ir-emitter-safety)
|
||||||
- [Make sure you are using NON-focused emmiters and at around 5ma total power](#make-sure-you-are-using-non-focused-emmiters-and-at-around-5ma-total-power)
|
- [Make sure you are using NON-focused emitters and at around 5ma total power](#make-sure-you-are-using-non-focused-emmiters-and-at-around-5ma-total-power)
|
||||||
- [Firmware](#firmware)
|
- [Firmware](#firmware)
|
||||||
- [Headset support](#headset-support)
|
- [Headset support](#headset-support)
|
||||||
- [Contact](#contact)
|
- [Contact](#contact)
|
||||||
@ -21,22 +21,40 @@ Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.
|
|||||||
|
|
||||||
> **Note**: This project is in development and is not fully finished
|
> **Note**: This project is in development and is not fully finished
|
||||||
|
|
||||||
# Please check out our [documentation site.](https://redhawk989.github.io/EyeTrackVR/)
|
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
Please check out our [documentation site.](https://redhawk989.github.io/EyeTrackVR/)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Hardware
|
## Hardware
|
||||||
|
|
||||||
3d files for mounting brackets will be found [here](https://github.com/RedHawk989/EyeTrackVR-Hardware)
|
3d files for mounting brackets will be found [here](https://github.com/RedHawk989/EyeTrackVR-Hardware)
|
||||||
IR emitter files are also located there.
|
IR emitter files are also located there. For more info please reference our [documentation site](https://redhawk989.github.io/EyeTrackVR/parts-list/)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## ESP-CAM Firmware
|
||||||
|
|
||||||
|
Current work has been with our official firmware by `lorow`, found [here](https://github.com/lorow/OpenIris).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Headset support
|
||||||
|
|
||||||
|
Any headset that can fit the camera and LEDs can likely be supported, however, mounts may not have been made for it. Please reference to our [parts list](https://redhawk989.github.io/EyeTrackVR/parts-list/#other-parts) for details.
|
||||||
|
|
||||||
|
|
||||||
## About IR Emitter Safety
|
## About IR Emitter Safety
|
||||||
|
|
||||||
Please *exercise extreme caution* when messing around with IR emitters.
|
Please *exercise extreme caution* when messing around with IR emitters.
|
||||||
<ins>Once safety testing has been completed links and files will be provided for the emitters</ins>. Please make sure you know what you are doing when assembling the IR emitters.
|
<ins>Once safety testing has been completed links and files will be provided for the emitters</ins>. Please make sure you know what you are doing when assembling the IR emitters.
|
||||||
<ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. This can result in irreversible bodily harm.
|
<ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. This can result in irreversible bodily harm.
|
||||||
The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities is on the user.
|
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 making sure you do not feel warmth.
|
This includes visually checking with an IR camera that the brightness is correct and making sure you do not feel warmth.
|
||||||
|
|
||||||
> **Warning**: Make sure you are using **NON-focused** emitters and at around ***5ma total power***.
|
> **Warning**: Make sure you are using **NON-focused** emitters and at around ***5ma-8ma total power per eye***.
|
||||||
|
|
||||||
[Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)
|
[Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)
|
||||||
|
|
||||||
@ -44,23 +62,16 @@ This includes visually checking with an IR camera that the brightness is correct
|
|||||||
|
|
||||||
[AN002_Details on photobiological safety of LED light sources](./docs/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
|
[AN002_Details on photobiological safety of LED light sources](./docs/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
|
||||||
|
|
||||||
## Firmware
|
|
||||||
|
|
||||||
Current testing has been with `lorow's` firmware found [here](https://github.com/lorow/OpenIris).
|
|
||||||
|
|
||||||
|
|
||||||
## Headset support
|
|
||||||
|
|
||||||
Initial support will be Quest 2 (pcvr)
|
## Contact
|
||||||
Support for other headsets from the community.
|
|
||||||
|
|
||||||
#### Contact
|
|
||||||
|
|
||||||
Please join our Discord for updates and any questions.
|
Please join our Discord for updates and any questions.
|
||||||
|
|
||||||
[](https://discord.gg/kkXYbVykZX)
|
[](https://discord.gg/kkXYbVykZX)
|
||||||
|
|
||||||
# Licenses
|
## Licenses
|
||||||
|
|
||||||
[](https://github.com/RedHawk989/EyeTrackVR/blob/master/LICENSE)
|
[](https://github.com/RedHawk989/EyeTrackVR/blob/master/LICENSE)
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user