update readme

This commit is contained in:
Prohurtz 2022-09-30 10:47:15 -05:00 committed by GitHub
parent 42a46e9ca1
commit 64444b1585
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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)
- [Hardware](#hardware)
- [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)
- [Headset support](#headset-support)
- [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
# Please check out our [documentation site.](https://redhawk989.github.io/EyeTrackVR/)
## Documentation
Please check out our [documentation site.](https://redhawk989.github.io/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
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>**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.
> **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)
@ -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)
## 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)
Support for other headsets from the community.
#### Contact
## Contact
Please join our Discord for updates and any questions.
[![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/kkXYbVykZX)
# Licenses
## Licenses
[![GitHub license](https://img.shields.io/github/license/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/blob/master/LICENSE)