docs: Merge pull request #13 from DenTechs/main

Fixed spelling, grammar, and paths
This commit is contained in:
Prohurtz 2023-11-27 16:09:49 -08:00 committed by GitHub
commit 95cc908211
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 61 additions and 59 deletions

View File

@ -45,11 +45,13 @@ Ces mesures de sécurité ont été mises en places pour RÉDUIRE les risques po
</Alerts>
::: Vous voulez voir nos resources lié à la sureté?
[Effect of infrared radiation on the lens](../saftey/effect_of_ir_on_the_lens.pdf)
[Effect of infrared radiation on the lens](../safety/effect_of_ir_on_the_lens.pdf)
[AN002_Details on photobiological safety of LED light sources](../saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
[AN002_Details on photobiological safety of LED light sources](../safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
[Training-library Nir Stds](../saftey/training-library_nir_stds_20021011.pdf)
[Training-library Nir Stds](../safety/training-library_nir_stds_20021011.pdf)
[ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)](../safety/ICNIRP_optical_radiation.pdf)
:::
## Firmware

View File

@ -40,7 +40,7 @@ import { members, contributors } from '../static/members'
<VPTeamPageSection>
<template #title>Philosophy</template>
<template #lead>
The <a class="custom-links" href="/intro" target="_blank">guides</a> on this website include some of our teams own notes (not all of them are polished) that we disclose for other people to use.<br>
The <a class="custom-links" href="/intro" target="_blank">guides</a> on this website include some of our team's own notes (not all of them are polished) that we disclose for other people to use.<br>
<br>
Here, we hope you may find something useful to you.<br>
<br>

View File

@ -8,11 +8,11 @@ Please look at other pages to see how they are formatted, and for examples of ho
## Adding a Page
To add a page, you will need to create a new Markdown file in the `vitepress/docs/src/pages` folder. The file name will be the URL of the page. For example, if you create a file called `my_page.md`, the URL will be `https://docs.eyetrackvr.dev//my_page`.
To add a page, you will need to create a new Markdown file in the `vitepress/docs/src/pages` folder. The file name will be the URL of the page. For example, if you create a file called `my_page.md`, the URL will be `https://docs.eyetrackvr.dev/my_page`.
### Sub-directories
You can also create sub-directories in the `vitepress/docs/src/pages` folder. For example, if you create a file called `my_page.md` in a folder called `my_folder`, the URL will be `https://docs.eyetrackvr.dev//my_folder/my_page`.
You can also create sub-directories in the `vitepress/docs/src/pages` folder. For example, if you create a file called `my_page.md` in a folder called `my_folder`, the URL will be `https://docs.eyetrackvr.dev/my_folder/my_page`.
This is useful for organizing pages into categories.

View File

@ -19,14 +19,14 @@ import { alerts } from '../../static/alerts'
These settings are applicable only when using Wi-Fi for communication with your computer. If you are using USB, you can skip to reading about [Environments](#environments).
:::
Replace the placeholder text with your correct SSID (WiFi access point name), and password respectfully.
Replace the placeholder text with your correct SSID (WiFi access point name), and password respectively.
::: info
Special characters such as `!` and `@` are not supported. If you have a special character in your password or ssid, you will need to change it.
Spaces are not supported either. If you have a space in either, you will need to change it.
Similarly, spaces are not supported in the SSID and password. If you have a space in either, you will need to change it.
The firmware supports AP mode, but it is not recommended. If you are using AP mode, you will need to set the `enableadhoc` to `1`.
The firmware supports AP mode, however it is not recommended. If you wish to use AP mode, you will need to set the `enableadhoc` to `1`.
Then, you will need to set the `ap_ssid` to the name of your AP, and `ap_password` to the password of your AP.
@ -38,7 +38,7 @@ You can choose to leave the `ap_ssid` and `ap_password` as defaults, but you wil
<Alerts :options="alerts.parts_list_one">
<template v-slot:content>
<p>
Make sure your wifi router has a 2.4 GHz band. While most do, this is not always the case. Setting each band (5GHz, and 2.4GHz) to different SSIDs is recommended, though not required.
Make sure your WiFi router has a 2.4 GHz band. While most do, this is not always the case. Setting each band (5GHz, and 2.4GHz) to different SSIDs is recommended, though not required.
</p>
</template>
</Alerts>
@ -49,7 +49,7 @@ Double check that you have correctly entered your WiFi credentials and that said
#### `mDNS`
If you do not wish to manually keep track of the ESPs IP addresses and ports, you can enable the mDNS feature. This will allow you to connect to the ESPs using the following format: `http://<some_name>.local`. This will only work if you are connected to the same network as the ESPs, and if you have enabled mDNS on your computer. If you are using Windows, you can enable mDNS by following [this guide](./mdns).
If you do not wish to manually keep track of the ESPs IP addresses and ports, you can enable the mDNS feature. This will allow you to connect to the ESPs using the following format: `http://<some_name>.local`. This feature only works when you are on the same network as the ESPs and have mDNS enabled on your computer. If you are using Windows, you can enable mDNS by following [this guide](./mdns).
#### `OTA`

View File

@ -10,7 +10,7 @@ You can access the firmware, as well as flash your boards, using our new [Firmwa
This tool is currently in beta.
:::
We are working on adding support for OTA and configuring network settings. If you have any issues, please let us know by opening an issue on the repository.
We are working on adding support for Over-The-Air (OTA) and configuring network settings. If you have any issues, please let us know by opening an issue on the repository.
This tool relies on our own solution called `OpenIris`, [found here](https://github.com/EyeTrackVR/OpenIris).

View File

@ -9,7 +9,7 @@ import { image_settings } from '../../static/image_settings'
Open source and *affordable* VR eye tracker platform for Social VR Games via `OSC` and `UDP` protocol.
### Welcome to the EyetrackVR documentation website. Here you will find all avalable documentation regauding building, development, and other resources related to this project.
### Welcome to the EyetrackVR documentation website. Here you will find all available documentation regarding building, development, and other resources related to this project.
Want to get started? Check out the [getting started page](https://docs.eyetrackvr.dev/getting_started/things_to_know) and then the [full build guide.](https://docs.eyetrackvr.dev/how_to_build/full_build)
@ -27,7 +27,7 @@ Want to get started? Check out the [getting started page](https://docs.eyetrackv
Please *exercise caution* when messing around with IR emitters.
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't use different emitters, dont use differnt means of power, etc.
If you doubt yourself, just do exactly what we do. Don't use different emitters, don't use different means of power, etc.
::: danger
It is important that you <ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. This can result in irreversible bodily harm.
@ -44,18 +44,18 @@ The safety measures were put in place to REDUCE the potential failure risk. All
</Alerts>
::: details Want to see the safety data sheets?
[Effect of infrared radiation on the lens](https://docs.eyetrackvr.dev/saftey/effect_of_ir_on_the_lens.pdf)
[Effect of infrared radiation on the lens](../safety/effect_of_ir_on_the_lens.pdf)
[AN002_Details on photobiological safety of LED light sources](https://docs.eyetrackvr.dev/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
[AN002_Details on photobiological safety of LED light sources](../safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
[Training-library Nir Stds](https://docs.eyetrackvr.dev/saftey/training-library_nir_stds_20021011.pdf)
[Training-library Nir Stds](../safety/training-library_nir_stds_20021011.pdf)
[ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)](https://docs.eyetrackvr.dev/saftey/ICNIRP_optical_radiation.pdf)
[ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)](../safety/ICNIRP_optical_radiation.pdf)
:::
## Hardware
Please check out our [parts list](https://docs.eyetrackvr.dev/how_to_build/parts_list) and [hardware repo.](https://github.com/EyeTrackVR/EyeTrackVR-Hardware) for information regauring hardware.
Please check out our [parts list](https://docs.eyetrackvr.dev/how_to_build/parts_list) and [hardware repo.](https://github.com/EyeTrackVR/EyeTrackVR-Hardware) for information regarding hardware.
## Firmware

View File

@ -13,7 +13,7 @@ import { image_settings } from '../../static/image_settings'
Please *exercise caution* when messing around with IR emitters.
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 or are not understand something, just do exactly what we do. Don't use different emitters, don't use different means of power, etc.
If you doubt yourself or do not understand something, just do exactly what we do. Don't use different emitters, don't use different means of power, etc.
::: danger
It is important that you <ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. This can result in irreversible bodily harm.
@ -27,10 +27,10 @@ The safety measures were put in place to REDUCE the potential failure risk. All
We care about power exposure "W" to the cornea, which we can normalize over the exposed area to Irradiance "mW/cm^2"
This number gives us the amount of IR radiation being released into the normalized area. We don't really care about "mA", or "V" alone, as by themselves these do not give us the exposure levels which we need to ensure safety.
Irradiance also needs to take in to account distance of the light source (LED) as the further away you get from a source the weaker the intensity gets. (You can test this by looking at a light source from far away, and as you move closer, the brighter and more painful it is to look at) We do this by using Radiance "mW/cm2/sr" to normalize for the distance. The "sr" is a steradian. Think of it like a cone shape, getting bigger and broader as we move away from the source object.
Irradiance also needs to take into account distance of the light source (LED) as the further away you get from a source the weaker the intensity gets. (You can test this by looking at a light source from far away, and as you move closer, the brighter and more painful it is to look at) We do this by using Radiance "mW/cm2/sr" to normalize for the distance. The 'sr' stands for steradian, which can be thought of as a cone shape expanding as it moves away from the source.
The International Commission on Non-Ionizing Radiation Protection's [Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)](https://docs.eyetrackvr.dev/saftey/ICNIRP_optical_radiation.pdf) states:
The International Commission on Non-Ionizing Radiation Protection's [Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)](../safety/ICNIRP_optical_radiation.pdf) states:
> "To avoid thermal injury of the cornea and possible delayed effects on the lens of the eye (cataractogenesis), infrared radiation (780nm < > λ < > 3μm) should be limited to 100 W m⁻² (10 mW cm⁻²) for lengthy exposures (> 1000 s)"
So 10 mW/cm2 is the **max** recommended limit given by this source. In my opinion this is still quite high, you will definitely feel some warmth and likely eyestrain after a while.

View File

@ -1,10 +1,10 @@
# Things To Know Before You Start {.text-[var(--font-accent)]}
## This page will be an overview of things to know and understand before you start this project
## This page is an overview of things to know and understand before you start this project
### Software is not final
Bugs can and will occur which may hinder the experience or useability at times.
Bugs can and will occur which may hinder the experience or usability at times.
Do not expect 100% reliable and perfect function. Not all features are fully developed yet.
### Firmware may have user difficulties
@ -13,7 +13,7 @@ Our firmware has not been tested widely so issues may creep up.
### IR emitters are dangerous
If handled wrong or precautions are ignored you can and will cause damage to your eyes. Please make sure to only buy linked ones or ones with specs that match exactly. We will not be responsible for damaged caused if you go your own route.
If handled wrong or precautions are ignored you can and will cause damage to your eyes. Please make sure to only buy linked ones or ones with specs that match exactly. We will not be responsible for damage caused if you go your own route.
### Documentation may be incomplete
@ -21,7 +21,7 @@ Important steps may be missing.
### You will need to set up your avatar to use this
This will require some basic Unity knowledge and owning your own avatar.
Note: 2.0 beta app uses VRC's Native eye tracking which does **NOT** require a special avatar
This will require basic knowledge of Unity and ownership of your own avatar.
Note: The 2.0 beta version of our app uses VRC's Native eye tracking, which does **NOT** require a special avatar.
### Once you have acknowledged the items above, move on to the [Full Build Guide](https://docs.eyetrackvr.dev/how_to_build/full_build)
### Once you have acknowledged the items above, move on to the [Full Build Guide](../how_to_build/full_build)

View File

@ -4,16 +4,16 @@
So, you have a headset that does not have any mounts or none that work well for you. Here I will show some simple steps to get some form of a mount working.
## Step 1: Find a way to mount to your headsets lens
## Step 1: Find a way to mount to your headset's lens
The easiest way to get started is to find a lens protector for your headset.
Either go to a website like [Thingiverse](https://www.thingiverse.com/) or just do a search for "3d printed lens protector for {your headset here}"
You can visit a website like [Thingiverse](https://www.thingiverse.com/) or do a search for "3d printed lens protector for {your headset here}"
Example: Here is a lens protector for the Quest 1/2 and Rift S [https://www.thingiverse.com/thing:3653631](https://www.thingiverse.com/thing:3653631)
## Step 2: Find a camera mount
Now, you need a way to attach the camera. We have a basic design that qdot created (taken from his mount) on the hardware GitHub [here](https://github.com/EyeTrackVR/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Basic_Mount_Components/basic_ETVR_camera_mount.stl)
Now, you need a way to attach the camera. We have a basic design created by qdot, based on his mount on the hardware GitHub [here](https://github.com/EyeTrackVR/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Basic_Mount_Components/basic_ETVR_camera_mount.stl)
Alternatively, you can create your own mount if you have the skills.
@ -21,7 +21,7 @@ Alternatively, you can create your own mount if you have the skills.
The "Ideal" location is a place that gives a good view of the pupil when looking to all extremes, the lower corners do a good job at getting there, or nearly there.
You want to put the camera as close to the headset's lens as possible to achieve the biggest view of the eye.
It is recommended to place the camera as close as possible to the headset's lens to maximize the view of the eye.
I recommend looking at other headset mounts for [inspiration.](https://github.com/EyeTrackVR/EyeTrackVR-Hardware/tree/main/3d_Printed_Mounts)
## Step 4: Mount your LEDs

View File

@ -12,7 +12,7 @@ import { alerts } from '../../static/alerts'
## This page will contain a step-by-step assembly guide
This guide provides a walkthrough on the assembly of a **wireless** V3 eye tracking.
V4 specific final docs are WIP:
V4 specific final docs are Work In Progress:
[V4 LED Solderless assemblly rough edit:](https://www.youtube.com/watch?v=AVUbDNe7uNU)
<iframe width="500" height="300" src="https://www.youtube.com/embed/AVUbDNe7uNU" title="EyeTrackVR V4 Solder-less Assembly ROUGH EDIT" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
@ -21,17 +21,17 @@ Sketch of V4 solderless wiring:
<ImageCard :options="image_settings.V4_wire_sketch" />
Credit: @seniorpringles, @g0ldjay via [Discord](https://discord.gg/kkXYbVykZX)
Sketch of solder assembbly of V4:
Sketch of solder assembly of V4:
<ImageCard :options="image_settings.V4_solder_wire" />
Nevertheless, it's worth noting that these instructions are also mostly applicable to those who are using wired or V4 trackers.
## Step 1: Make sure your have read the [Things to know before you start](https://docs.eyetrackvr.dev/getting_started/things_to_know) guide
## Step 1: Make sure your have read the [Things to know before you start](../getting_started/things_to_know) guide
This will give you a basic overview of the project's status and what to expect currently.
## Step 2: Order all the parts listed on our [Parts list](https://docs.eyetrackvr.dev/how_to_build/parts_list)
## Step 2: Order all the parts listed on our [Parts list](../how_to_build/parts_list)
Please take note of the fact that hardware still may change, although with more developments it seems like we are going to stick with current hardware.
@ -54,7 +54,7 @@ Some ESP-CAM boards have issues with signal integrity, there are 2 things you ca
The first option is to use an external antenna.
This is the best solution when it comes to the final result. If you have Vive/Tundra trackers, this is a **REQUIRED** step. The interference from the trackers will make your ESP stream unusable. An antistatic bag does not help in this case. Unfortunately, removing the antenna is not super easy, you have to either move a resistor or, remove it and bridge 2 solder pads. The image attached below shows the orientation of the pads that need to be connected for which mode. You can not bridge all connections and have both antennas active at the same time. The 0-ohm resistor does not need to be on the board, you can simply bridge the connections.
This is the best solution when it comes to the final result. If you have Vive/Tundra trackers, this is a **REQUIRED** step. The interference from the trackers will make your ESP stream unusable. An antistatic bag does not help in this case. Unfortunately, removing the antenna is not super easy, you have to either move a resistor or, remove it and bridge 2 solder pads. The attached image below shows the orientation of the pads that need to be connected, depending on the mode You can not bridge all connections and have both antennas active at the same time. The 0-ohm resistor does not need to be on the board, you can simply bridge the connections.
<ImageCard :options="image_settings.external_antenna" />
@ -102,19 +102,19 @@ Slide your ESP into the programmer, and note the USB port goes away from the ESP
## Step 8: Configure Visual Studio Code and prepare to flash the firmware
Check out our guide on [Setting up VS Code](https://docs.eyetrackvr.dev/firmware_guide/setup_vscode)
Check out our guide on [Setting up VS Code](../firmware_guide/setup_vscode)
Once VS Code is set up, move on to the next step.
## Step 9: Plug in your ESP and flash the firmware
Our guide, [Building and uploading the firmware manually](https://docs.eyetrackvr.dev/firmware_guide/upload_and_update_firmware) has steps on how to do this.
Our guide, [Building and uploading the firmware manually](../firmware_guide/upload_and_update_firmware) has steps on how to do this.
After it has flashed, make sure you get a video stream in your browser, then power it down and flash your next ESP.
## Step 10: Connect your power wires to a USB Type-A board
::: warning
Powering from the programmer board **will not work correctly**. This delivers a lower voltage which results in dim LEDs and video artifacts. These are highly likely mess up tracking.
Powering from the programmer board **will not work correctly**. This delivers a lower voltage which results in dim LEDs and video artifacts. These are highly likely to mess up tracking.
:::
Get two pairs of wire, preferably two different colors, Cut them to length (56mm in my case) and twist together two for ground and two for 5V.
@ -150,7 +150,7 @@ Repeat [Step 12](#step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-
As a user in our discord has learned, you can short the `IO12` pin with the ground pin `(GND)` without issues.
:::
In the below example I put it on the top of the pin, It will be a week-ish joint but that's where glue comes in handy.
In the below example I put it on the top of the pin, It will be a weak-ish joint but that's where glue comes in handy.
<ImageCard :options="image_settings._13_18_two"/>
@ -258,7 +258,7 @@ Use the following diagram:
## Step 19: 3D print mounts
Head to the 3D printed parts section of the parts list [here.](https://docs.eyetrackvr.dev/how_to_build/parts_list#_3d-printed-mounts)
Head to the 3D printed parts section of the parts list [here.](../how_to_build/parts_list#_3d-printed-mounts)
Find which parts are for your headset and print them.
Some may work better or worse, it is recommended to test all of them if there are multiple, print one of each kind.
@ -296,7 +296,7 @@ Slowly apply pressure inwards until the camera snaps into place.
<ImageCard :options="image_settings.end_twelve"/>
This uses the method of gluing the camera.
This method involves gluing the camera in place.
Apply a bit of glue to the bottom of the camera mount.

View File

@ -9,7 +9,7 @@ import PartsList from '../../vue/parts_list/PartsList.vue'
<Alerts :options="alerts.parts_list_one">
<template v-slot:content>
<p>
Please note that no hardware has been fully set in stone, all purchases are at your loss if hardware changes.
Please note that no hardware has been fully set in stone, all purchases are at your own risk in case of hardware changes.
</p>
</template>
</Alerts>
@ -66,7 +66,7 @@ With that in mind, here are the required parts for the setup.
Very small size, wireless and wired support, does not require an additional programmer or separate antennas:
[SeedStudio](https://www.seeedstudio.com/XIAO-ESP32S3-Sense-p-5639.html)
alternatively:
Alternatively:
- 2x Freenove ESP 32-S3 WROOM
Much larger, price may be higher than the XIAOs, supports wired and wireless as well, does not need a separate programmer, **does not support a separate antenna**.
[Amazon](https://www.amazon.com/FREENOVE-ESP32-S3-WROOM-Compatible-Wireless-Detailed/dp/B0BMQ8F7FN)
@ -112,7 +112,7 @@ Things worth noting:
- There is an experimental option to purchase OV2640 130° FOV cameras and manually remove the IR filters. This can result in a clearer view of the eye and is smaller so it allows for HMDs like the Bigscreen Beyond, but it's not a default recommendation just yet. Checkout the listing "75MM-130 Degree" [AliEXpress](https://www.aliexpress.us/item/3256804332354572.html)
- If the cameras are Dead on Arrival (DOA), keep in mind that you can swap the lenses with the ones that come with the stock cameras that were included with the ESP32 boards though, they do require extension cables. I reccomend just buying more (3-4 instead of just 2).
- If the cameras are Dead on Arrival (DOA), keep in mind that you can swap the lenses with the ones that come with the stock cameras that were included with the ESP32 boards, though they do require extension cables. I recommend just buying more (3-4 instead of just 2).
- #### Optional Ribbon extensions:
@ -129,7 +129,7 @@ Connectors (select 24P) [Aliexpress](https://www.aliexpress.com/item/32568040967
The hub needs to support MTT if you wish to use a vive face tracker with the ESPs. Here is a hub that supports MTT and is not expensive [Amazon](https://www.amazon.com/dp/B09NDQGSPR)
Ensure that it is of good quality, lightweight, compact in size, and I suggest a minimum of three ports - one for the face tracker and two for ESP32-S3 boards.
Ensure that you acquire appropriate USB-A to USB-C adapters wherever required, such as for the Valve Index which has only one USB-A port.
Ensure that you acquire appropriate USB-A to USB-C adapters wherever required. For example the Valve Index only has one USB-A port.
Such adapter [Amazon.](https://a.co/d/gSWydCY)
- 2x USB C cables (as short as possible) to connect both ESPs
@ -140,7 +140,7 @@ You may also make custom cables using USB breakout boards of your choice and wir
### Wires and adapters
If you are soldering and using custom cables:
- 1x USB type-A male port to power both ESPs/or LEDs
- 1x USB type-A male port to power both ESPs or LEDs
[Bare breakout on AliExpress](https://www.aliexpress.com/item/2255801092919590.html)
[Amazon](https://www.amazon.com/10Gtek-DIP-Breakout-Adapter-2-54mm/dp/B09LC8WQCD/)
\
@ -218,7 +218,7 @@ Mounts with a `★` next to them are the recommended mounts for the respected hm
[Amazon](https://www.amazon.com/Assark-Sticks-School-Repairs-20W/dp/B09FYWQ44L/)
- 1x Soldering iron and solder:
[Pin64 Pinecil (Highly Recommended)](https://www.pine64.org/pinecil/) + [Amazon Solder](https://www.amazon.com/Rosin-Solder-Electronics-Components-repair/dp/B08M5YP6BN/)
[Pine64 Pinecil (Highly Recommended)](https://www.pine64.org/pinecil/) + [Amazon Solder](https://www.amazon.com/Rosin-Solder-Electronics-Components-repair/dp/B08M5YP6BN/)
[AliExpress (Generic)](https://www.aliexpress.com/item/3256801448141079.html)
[Amazon (Generic)](https://www.amazon.com/Liouhoum-Auto-Sleep-Adjustable-Temperature-Thermostatic/dp/B08PZBPXLZ/ref=sr_1_9)

View File

@ -29,7 +29,7 @@ EyeTrackVR is currently using [Python 3.11.0](https://www.python.org/downloads/r
## Installing Poetry
Since version `0.1.7` of EyeTrackVR, we have been using Poetry to manage app dependencies. To build the app, you must first install Poetry to fetch the required dependencies.
Starting with version `0.1.7`, EyeTrackVR uses Poetry to manage app dependencies. To build the app, you must first install Poetry to fetch the required dependencies.
To install Poetry open Windows Powershell and run the following command `(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -`

View File

@ -62,7 +62,7 @@ This is used to cut out things that aren't dark like your pupil.
For our method to work best, you want your eye to be level.
Use this slider to adjust it to where that is the case.
### `Restart Calibrationn`
### `Restart Calibration`
This will start a calibration mode for your eye where you look to all extremes.
@ -85,7 +85,7 @@ Press the `Save and Restart Tracking` button.
### Wired configuration (experimental)
#### Note this is a Beta app feature only. Please use the latest Open Beta in the Discord.
Find your ESPs in Device Manager and figure out their COM port numbers i. e. ``COM4``.
Find your ESPs in Device Manager and figure out their COM port numbers, e.g. ``COM4``.
Enter that COM port number into the app's `Camera Address` field.
@ -93,7 +93,7 @@ Press the `Save and Restart Tracking` button.
### Setting up ROI
Don't see your camera feed? That's because we haven't set an ROI.
Don't see your camera feed? That's because an ROI hasn't been set yet.
<ImageCard :options="image_settings.eyetrack_vr_guide_four"/>
Now press the `Cropping Mode` button.
@ -104,7 +104,7 @@ Put your headset on and use an application to see your desktop. (Virtual desktop
You should see something like this:
<ImageCard :options="image_settings.eyetrack_vr_guide_five"/>
Now, Draw a rectangle that selects your eye.
Now, draw a rectangle that selects your eye.
A good example of an ROI
<ImageCard :options="image_settings.eyetrack_vr_guide_six"/>

View File

@ -6,7 +6,7 @@ import { alerts } from '../../static/alerts'
</script>
# Setting up recalibration and recentering from VRChat.
ETVR has a mechanism that allows you to recalibrate and recenter your tracking without the need to interact with the app directly, here's how to setup your avatar to make use of OSC to trigger this from within VRC itself.
ETVR has a mechanism that allows you to recalibrate and recenter your tracking without the need to interact with the app directly, here's how to set up your avatar to make use of OSC to trigger this from within VRC itself.
<Alerts :options="alerts.parts_list_two">
<template v-slot:content>
@ -30,7 +30,7 @@ To do this, in Unity, select your avatar on the scene and find Avatar Descriptor
<ImageCard :options="image_settings.unity_vrc_expressions" />
Clicking on it will highligh the associated asset in the asset browser, click on the highlighted file to get its content to show in the inspector panel. Now, in the inspector click on the `Add` button to add the parameters mentioned above, both of them need to be of type Bool, they don't need to be synced nor saved.
Clicking on it will highlight the associated asset in the asset browser. Click on the highlighted file to get its content to show in the inspector panel. Now, in the inspector, click on the `Add` button to add the parameters mentioned above. Both of them need to be of type Bool, but they don't need to be synced nor saved.
<ImageCard :options="image_settings.unity_vrc_expressions_add_fields"/>
<ImageCard :options="image_settings.unity_vrc_expressions_fields"/>
@ -64,9 +64,9 @@ Once done simply build and upload the updated version of your avatar.
And that's it, you now should be able to recenter and recalibrate your tracking form inside of VRC!
## Reseting the OSC config in case the parameters don't work
## Resetting the OSC config in case the parameters don't work
Sometimes VRChat won't regenerate the config files that it to communicate the changes to anyone that's listening, to fix this it's enough to simply delete the auto generated configuration files and let VRC remake them.
Sometimes VRChat won't regenerate the config files that it uses to communicate the changes to anyone that's listening. To fix this, it's enough to simply delete the auto generated configuration files and let VRC remake them.
They are stored under
@ -85,4 +85,4 @@ The app itself listens to OSC messages sent on port `9001` to two addresses:
It only needs to receive a `Bool` value of `True` to trigger the recenter and calibration.
The port and the adresses can be changed in the app settings, if need be.
The port and the addresses can be changed in the app settings, if need be.