From 111f4eaad6687ebc3e779455e1b803158c7d0398 Mon Sep 17 00:00:00 2001 From: ZanzyTHEbar Date: Thu, 26 Oct 2023 10:25:35 +0000 Subject: [PATCH] fix: Update image settings to fix paths --- 404.html | 2 +- about.html | 2 +- archive/fox_ir_v2_build_instructions.html | 6 +++--- ...> archive_fox_ir_v2_build_instructions.md.a1e531db.js} | 2 +- ...hive_fox_ir_v2_build_instructions.md.a1e531db.lean.js} | 2 +- assets/chunks/{index.0e6ad99c.js => index.10f74b3d.js} | 2 +- ...s => firmware_guide_configure_firmware.md.04dc1dcd.js} | 2 +- ...firmware_guide_configure_firmware.md.04dc1dcd.lean.js} | 2 +- ...e526.js => firmware_guide_environments.md.d5d0818e.js} | 2 +- ...js => firmware_guide_environments.md.d5d0818e.lean.js} | 2 +- ...20e.js => firmware_guide_flashing_tool.md.6ad5e454.js} | 2 +- ...s => firmware_guide_flashing_tool.md.6ad5e454.lean.js} | 2 +- ...20d8.js => firmware_guide_setup_vscode.md.6234c70e.js} | 2 +- ...js => firmware_guide_setup_vscode.md.6234c70e.lean.js} | 2 +- ...js => firmware_guide_update_platformio.md.f1f0be3e.js} | 2 +- ... firmware_guide_update_platformio.md.f1f0be3e.lean.js} | 2 +- ...mware_guide_upload_and_update_firmware.md.faf8113d.js} | 2 +- ..._guide_upload_and_update_firmware.md.faf8113d.lean.js} | 2 +- ...d.193e8e8d.js => getting_started_intro.md.4c4c39e8.js} | 2 +- ....lean.js => getting_started_intro.md.4c4c39e8.lean.js} | 2 +- ...b9c84c14.js => how_to_build_full_build.md.af5219a2.js} | 2 +- ...ean.js => how_to_build_full_build.md.af5219a2.lean.js} | 2 +- ...=> software_guide_eyetrackvr_app_guide.md.2f90c236.js} | 2 +- ...ftware_guide_eyetrackvr_app_guide.md.2f90c236.lean.js} | 2 +- ...969c73c.js => software_guide_osc_setup.md.da0e63a0.js} | 2 +- ...an.js => software_guide_osc_setup.md.da0e63a0.lean.js} | 2 +- contact.html | 2 +- dev_roadmap.html | 2 +- development/docs/dev_docs.html | 2 +- development/docs/pages.html | 2 +- development/docs/standards.html | 2 +- firmware_guide/configure_firmware.html | 6 +++--- firmware_guide/environments.html | 6 +++--- firmware_guide/firmware.html | 2 +- firmware_guide/flashing_tool.html | 8 ++++---- firmware_guide/mdns.html | 2 +- firmware_guide/rest_api.html | 2 +- firmware_guide/setup_vscode.html | 6 +++--- firmware_guide/update_platformio.html | 6 +++--- firmware_guide/upload_and_update_firmware.html | 6 +++--- getting_started/intro.html | 6 +++--- getting_started/led_safety.html | 2 +- getting_started/things_to_know.html | 2 +- hashmap.json | 2 +- how_to_build/creating_your_own_mount.html | 2 +- how_to_build/full_build.html | 6 +++--- how_to_build/parts_list.html | 2 +- index.html | 2 +- misc/faq.html | 2 +- misc/vrc_avatar_setup.html | 2 +- software_guide/build_software.html | 2 +- software_guide/eyetrackvr_app_guide.html | 6 +++--- software_guide/osc_setup.html | 6 +++--- 53 files changed, 76 insertions(+), 76 deletions(-) rename assets/{archive_fox_ir_v2_build_instructions.md.b320b3b5.js => archive_fox_ir_v2_build_instructions.md.a1e531db.js} (98%) rename assets/{archive_fox_ir_v2_build_instructions.md.b320b3b5.lean.js => archive_fox_ir_v2_build_instructions.md.a1e531db.lean.js} (98%) rename assets/chunks/{index.0e6ad99c.js => index.10f74b3d.js} (97%) rename assets/{firmware_guide_configure_firmware.md.7852fa9f.js => firmware_guide_configure_firmware.md.04dc1dcd.js} (99%) rename assets/{firmware_guide_configure_firmware.md.7852fa9f.lean.js => firmware_guide_configure_firmware.md.04dc1dcd.lean.js} (96%) rename assets/{firmware_guide_environments.md.5499e526.js => firmware_guide_environments.md.d5d0818e.js} (98%) rename assets/{firmware_guide_environments.md.5499e526.lean.js => firmware_guide_environments.md.d5d0818e.lean.js} (88%) rename assets/{firmware_guide_flashing_tool.md.52fe420e.js => firmware_guide_flashing_tool.md.6ad5e454.js} (97%) rename assets/{firmware_guide_flashing_tool.md.52fe420e.lean.js => firmware_guide_flashing_tool.md.6ad5e454.lean.js} (94%) rename assets/{firmware_guide_setup_vscode.md.bc9620d8.js => firmware_guide_setup_vscode.md.6234c70e.js} (98%) rename assets/{firmware_guide_setup_vscode.md.bc9620d8.lean.js => firmware_guide_setup_vscode.md.6234c70e.lean.js} (97%) rename assets/{firmware_guide_update_platformio.md.af6d4d76.js => firmware_guide_update_platformio.md.f1f0be3e.js} (98%) rename assets/{firmware_guide_update_platformio.md.af6d4d76.lean.js => firmware_guide_update_platformio.md.f1f0be3e.lean.js} (97%) rename assets/{firmware_guide_upload_and_update_firmware.md.1076bd51.js => firmware_guide_upload_and_update_firmware.md.faf8113d.js} (99%) rename assets/{firmware_guide_upload_and_update_firmware.md.1076bd51.lean.js => firmware_guide_upload_and_update_firmware.md.faf8113d.lean.js} (98%) rename assets/{getting_started_intro.md.193e8e8d.js => getting_started_intro.md.4c4c39e8.js} (99%) rename assets/{getting_started_intro.md.193e8e8d.lean.js => getting_started_intro.md.4c4c39e8.lean.js} (94%) rename assets/{how_to_build_full_build.md.b9c84c14.js => how_to_build_full_build.md.af5219a2.js} (99%) rename assets/{how_to_build_full_build.md.b9c84c14.lean.js => how_to_build_full_build.md.af5219a2.lean.js} (99%) rename assets/{software_guide_eyetrackvr_app_guide.md.7beed7fa.js => software_guide_eyetrackvr_app_guide.md.2f90c236.js} (99%) rename assets/{software_guide_eyetrackvr_app_guide.md.7beed7fa.lean.js => software_guide_eyetrackvr_app_guide.md.2f90c236.lean.js} (97%) rename assets/{software_guide_osc_setup.md.5969c73c.js => software_guide_osc_setup.md.da0e63a0.js} (98%) rename assets/{software_guide_osc_setup.md.5969c73c.lean.js => software_guide_osc_setup.md.da0e63a0.lean.js} (98%) diff --git a/404.html b/404.html index 17484388..f5fb3e45 100644 --- a/404.html +++ b/404.html @@ -14,7 +14,7 @@
EyeTrackVR Docs

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/about.html b/about.html index 27f93c69..dd29bfe5 100644 --- a/about.html +++ b/about.html @@ -17,7 +17,7 @@
EyeTrackVR Docs

Appearance

Our Team

The development of EyeTrackVR is guided by an international team, some of whom have chosen to be featured below.

EyeTrackVR developers are a group of people who are passionate about the field of augmented and virtual reality.

Prohurtz

Prohurtz

Creator / Lead Software Developer / Documentor / Hardware Developer

GitHub
Summer

Summer

Machine Learning Engineer / Data Scientist / App Developer

GitHub
lorow

lorow

Lead Firmware Developer / App Developer

GitHub
DaOfficialWizard

DaOfficialWizard

Firmware Developer / Documentation Manager / App Developer

GitHub

Contributors

Those who have actively contributed to development.
Community Support

Philosophy

The guides on this website include some of our teams own notes (not all of them are polished) that we disclose for other people to use.

Here, we hope you may find something useful to you.

We advocate the Open Source model.

This is why we strive to make our work open to other people for consultation, replication and reuse.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/archive/fox_ir_v2_build_instructions.html b/archive/fox_ir_v2_build_instructions.html index 37ad1106..86698e91 100644 --- a/archive/fox_ir_v2_build_instructions.html +++ b/archive/fox_ir_v2_build_instructions.html @@ -11,14 +11,14 @@ - - + +
EyeTrackVR Docs

Appearance

Fox IR V2 Buil dInstructions ​

Step 15: Prepare to solder IR LED PCB V2s ​

Get your magnifying glass out, it's time to solder very smol things.

Gather 4 PCBs, 4 IR LEDs, and 2 ~700ohm resistors.

'img'

698ohm resistors and V2 PCBs

Here are the PCB pin-out labels:

'img'

V2

LED labels:

'img'

The green markings and notched corners mark the positive sides of the LEDs pictured above.

If you have different LEDs, please consult their datasheet.

Some terminology related to them:

5V: 5-volt power in.

GND: Ground or power out.

AR: After-Resistor this is to be used as the power in on the 2nd PCB in series as resistors are not needed on the 2nd PCB since they are on the 1st one.

SNG: Single resistor, use this as 5V in if you are using only 1 ~700ohm resistor on V3 boards (not recommended).

Negative: This marks the negative side of the LED.

Positive: This marks the positive side of the LED.

Step 17: Solder resistors on PCB V2 ​

You only need 1 PCB to have a resistor per eye.

'img'

Tin the resistor pads.

'img'

Hold the resistor in place.

'img'

Solder one end.

'img'

Flip to the other side of the resistor and solder it.

'img'

Solder LEDs on PCB V2 ​

'img'

Tin the pads

'img'

Place the resistor on the pads in the correct orientation.

'img'

Solder each side of the resistor. Be careful not to solder at too high of a temp, recommended soldering temp is 230C with a max of 245C.

'img'

The LED is flipped in this Image, the green dot should face AWAY from the PCB.

Wire up the PCBs V2 ​

Basic full wiring diagram of IR PCBs V2.

'drawing'

The PCB that receives the 5V power is the one with the resistor. The second one, which gets its power from the ground pin of the first, does not have a resistor on it and its power input pin is the AR pin (After-Resistor). The 2nd PCBs ground pin goes to the ground of the system, in the diagram it is the ESPs ground pin.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/assets/archive_fox_ir_v2_build_instructions.md.b320b3b5.js b/assets/archive_fox_ir_v2_build_instructions.md.a1e531db.js similarity index 98% rename from assets/archive_fox_ir_v2_build_instructions.md.b320b3b5.js rename to assets/archive_fox_ir_v2_build_instructions.md.a1e531db.js index b755d84f..00bf1045 100644 --- a/assets/archive_fox_ir_v2_build_instructions.md.b320b3b5.js +++ b/assets/archive_fox_ir_v2_build_instructions.md.a1e531db.js @@ -1 +1 @@ -import{_ as o,i as t}from"./chunks/index.0e6ad99c.js";import{o as r,c as l,H as s,l as i,k as e,a as n,Q as a}from"./chunks/framework.e4c952c1.js";const d=e("h1",{class:"text-[var(--font-accent)]",id:"fox-ir-v2-buil-dinstructions",tabindex:"-1"},[n("Fox IR V2 Buil dInstructions "),e("a",{class:"header-anchor",href:"#fox-ir-v2-buil-dinstructions","aria-label":'Permalink to "Fox IR V2 Buil dInstructions {.text-[var(--font-accent)]}"'},"​")],-1),_=e("h2",{id:"step-15-prepare-to-solder-ir-led-pcb-v2s",tabindex:"-1"},[n("Step 15: Prepare to solder IR LED PCB V2s "),e("a",{class:"header-anchor",href:"#step-15-prepare-to-solder-ir-led-pcb-v2s","aria-label":'Permalink to "Step 15: Prepare to solder IR LED PCB V2s"'},"​")],-1),p=e("p",null,"Get your magnifying glass out, it's time to solder very smol things.",-1),c=e("p",null,"Gather 4 PCBs, 4 IR LEDs, and 2 ~700ohm resistors.",-1),h=e("p",null,"Here are the PCB pin-out labels:",-1),u=e("p",null,"LED labels:",-1),f=a('

If you have different LEDs, please consult their datasheet.

Some terminology related to them:

5V: 5-volt power in.

GND: Ground or power out.

AR: After-Resistor this is to be used as the power in on the 2nd PCB in series as resistors are not needed on the 2nd PCB since they are on the 1st one.

SNG: Single resistor, use this as 5V in if you are using only 1 ~700ohm resistor on V3 boards (not recommended).

Negative: This marks the negative side of the LED.

Positive: This marks the positive side of the LED.

Step 17: Solder resistors on PCB V2 ​

You only need 1 PCB to have a resistor per eye.

',10),m=e("p",null,"Tin the resistor pads.",-1),b=e("p",null,"Hold the resistor in place.",-1),v=e("p",null,"Solder one end.",-1),x=e("p",null,"Flip to the other side of the resistor and solder it.",-1),P=e("h2",{id:"solder-leds-on-pcb-v2",tabindex:"-1"},[n("Solder LEDs on PCB V2 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v2","aria-label":'Permalink to "Solder LEDs on PCB V2"'},"​")],-1),g=e("p",null,"Tin the pads",-1),B=e("p",null,"Place the resistor on the pads in the correct orientation.",-1),V=e("p",null,[n("Solder each side of the resistor. Be careful not to solder at too high of a temp, recommended soldering temp is "),e("code",null,"230C with a max of 245C"),n(".")],-1),C=e("h2",{id:"wire-up-the-pcbs-v2",tabindex:"-1"},[n("Wire up the PCBs V2 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v2","aria-label":'Permalink to "Wire up the PCBs V2"'},"​")],-1),S=e("p",null,"Basic full wiring diagram of IR PCBs V2.",-1),w=e("p",null,"The PCB that receives the 5V power is the one with the resistor. The second one, which gets its power from the ground pin of the first, does not have a resistor on it and its power input pin is the AR pin (After-Resistor). The 2nd PCBs ground pin goes to the ground of the system, in the diagram it is the ESPs ground pin.",-1),k=JSON.parse('{"title":"Fox IR V2 Buil dInstructions","description":"","frontmatter":{},"headers":[],"relativePath":"archive/fox_ir_v2_build_instructions.md","filePath":"archive/fox_ir_v2_build_instructions.md","lastUpdated":1676223729000}'),T={name:"archive/fox_ir_v2_build_instructions.md"},L=Object.assign(T,{setup(I){return(D,E)=>(r(),l("div",null,[d,_,p,c,s(o,{options:i(t).fox_ir_build_instructions_one},null,8,["options"]),h,s(o,{options:i(t).fox_ir_build_instructions_two},null,8,["options"]),u,s(o,{options:i(t).fox_ir_build_instructions_three},null,8,["options"]),f,s(o,{options:i(t).fox_ir_build_instructions_four},null,8,["options"]),m,s(o,{options:i(t).fox_ir_build_instructions_five},null,8,["options"]),b,s(o,{options:i(t).fox_ir_build_instructions_six},null,8,["options"]),v,s(o,{options:i(t).fox_ir_build_instructions_seven},null,8,["options"]),x,s(o,{options:i(t).fox_ir_build_instructions_eight},null,8,["options"]),P,s(o,{options:i(t).fox_ir_build_instructions_nine},null,8,["options"]),g,s(o,{options:i(t).fox_ir_build_instructions_ten},null,8,["options"]),B,s(o,{options:i(t).fox_ir_build_instructions_eleven},null,8,["options"]),V,s(o,{options:i(t).fox_ir_build_instructions_twelve},null,8,["options"]),C,S,s(o,{options:i(t).fox_ir_build_instructions_thirteen},null,8,["options"]),w]))}});export{k as __pageData,L as default}; +import{_ as o,i as t}from"./chunks/index.10f74b3d.js";import{o as r,c as l,H as s,l as i,k as e,a as n,Q as a}from"./chunks/framework.e4c952c1.js";const d=e("h1",{class:"text-[var(--font-accent)]",id:"fox-ir-v2-buil-dinstructions",tabindex:"-1"},[n("Fox IR V2 Buil dInstructions "),e("a",{class:"header-anchor",href:"#fox-ir-v2-buil-dinstructions","aria-label":'Permalink to "Fox IR V2 Buil dInstructions {.text-[var(--font-accent)]}"'},"​")],-1),_=e("h2",{id:"step-15-prepare-to-solder-ir-led-pcb-v2s",tabindex:"-1"},[n("Step 15: Prepare to solder IR LED PCB V2s "),e("a",{class:"header-anchor",href:"#step-15-prepare-to-solder-ir-led-pcb-v2s","aria-label":'Permalink to "Step 15: Prepare to solder IR LED PCB V2s"'},"​")],-1),p=e("p",null,"Get your magnifying glass out, it's time to solder very smol things.",-1),c=e("p",null,"Gather 4 PCBs, 4 IR LEDs, and 2 ~700ohm resistors.",-1),h=e("p",null,"Here are the PCB pin-out labels:",-1),u=e("p",null,"LED labels:",-1),f=a('

If you have different LEDs, please consult their datasheet.

Some terminology related to them:

5V: 5-volt power in.

GND: Ground or power out.

AR: After-Resistor this is to be used as the power in on the 2nd PCB in series as resistors are not needed on the 2nd PCB since they are on the 1st one.

SNG: Single resistor, use this as 5V in if you are using only 1 ~700ohm resistor on V3 boards (not recommended).

Negative: This marks the negative side of the LED.

Positive: This marks the positive side of the LED.

Step 17: Solder resistors on PCB V2 ​

You only need 1 PCB to have a resistor per eye.

',10),m=e("p",null,"Tin the resistor pads.",-1),b=e("p",null,"Hold the resistor in place.",-1),v=e("p",null,"Solder one end.",-1),x=e("p",null,"Flip to the other side of the resistor and solder it.",-1),P=e("h2",{id:"solder-leds-on-pcb-v2",tabindex:"-1"},[n("Solder LEDs on PCB V2 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v2","aria-label":'Permalink to "Solder LEDs on PCB V2"'},"​")],-1),g=e("p",null,"Tin the pads",-1),B=e("p",null,"Place the resistor on the pads in the correct orientation.",-1),V=e("p",null,[n("Solder each side of the resistor. Be careful not to solder at too high of a temp, recommended soldering temp is "),e("code",null,"230C with a max of 245C"),n(".")],-1),C=e("h2",{id:"wire-up-the-pcbs-v2",tabindex:"-1"},[n("Wire up the PCBs V2 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v2","aria-label":'Permalink to "Wire up the PCBs V2"'},"​")],-1),S=e("p",null,"Basic full wiring diagram of IR PCBs V2.",-1),w=e("p",null,"The PCB that receives the 5V power is the one with the resistor. The second one, which gets its power from the ground pin of the first, does not have a resistor on it and its power input pin is the AR pin (After-Resistor). The 2nd PCBs ground pin goes to the ground of the system, in the diagram it is the ESPs ground pin.",-1),k=JSON.parse('{"title":"Fox IR V2 Buil dInstructions","description":"","frontmatter":{},"headers":[],"relativePath":"archive/fox_ir_v2_build_instructions.md","filePath":"archive/fox_ir_v2_build_instructions.md","lastUpdated":1676223729000}'),T={name:"archive/fox_ir_v2_build_instructions.md"},L=Object.assign(T,{setup(I){return(D,E)=>(r(),l("div",null,[d,_,p,c,s(o,{options:i(t).fox_ir_build_instructions_one},null,8,["options"]),h,s(o,{options:i(t).fox_ir_build_instructions_two},null,8,["options"]),u,s(o,{options:i(t).fox_ir_build_instructions_three},null,8,["options"]),f,s(o,{options:i(t).fox_ir_build_instructions_four},null,8,["options"]),m,s(o,{options:i(t).fox_ir_build_instructions_five},null,8,["options"]),b,s(o,{options:i(t).fox_ir_build_instructions_six},null,8,["options"]),v,s(o,{options:i(t).fox_ir_build_instructions_seven},null,8,["options"]),x,s(o,{options:i(t).fox_ir_build_instructions_eight},null,8,["options"]),P,s(o,{options:i(t).fox_ir_build_instructions_nine},null,8,["options"]),g,s(o,{options:i(t).fox_ir_build_instructions_ten},null,8,["options"]),B,s(o,{options:i(t).fox_ir_build_instructions_eleven},null,8,["options"]),V,s(o,{options:i(t).fox_ir_build_instructions_twelve},null,8,["options"]),C,S,s(o,{options:i(t).fox_ir_build_instructions_thirteen},null,8,["options"]),w]))}});export{k as __pageData,L as default}; diff --git a/assets/archive_fox_ir_v2_build_instructions.md.b320b3b5.lean.js b/assets/archive_fox_ir_v2_build_instructions.md.a1e531db.lean.js similarity index 98% rename from assets/archive_fox_ir_v2_build_instructions.md.b320b3b5.lean.js rename to assets/archive_fox_ir_v2_build_instructions.md.a1e531db.lean.js index 1516952a..12586de0 100644 --- a/assets/archive_fox_ir_v2_build_instructions.md.b320b3b5.lean.js +++ b/assets/archive_fox_ir_v2_build_instructions.md.a1e531db.lean.js @@ -1 +1 @@ -import{_ as o,i as t}from"./chunks/index.0e6ad99c.js";import{o as r,c as l,H as s,l as i,k as e,a as n,Q as a}from"./chunks/framework.e4c952c1.js";const d=e("h1",{class:"text-[var(--font-accent)]",id:"fox-ir-v2-buil-dinstructions",tabindex:"-1"},[n("Fox IR V2 Buil dInstructions "),e("a",{class:"header-anchor",href:"#fox-ir-v2-buil-dinstructions","aria-label":'Permalink to "Fox IR V2 Buil dInstructions {.text-[var(--font-accent)]}"'},"​")],-1),_=e("h2",{id:"step-15-prepare-to-solder-ir-led-pcb-v2s",tabindex:"-1"},[n("Step 15: Prepare to solder IR LED PCB V2s "),e("a",{class:"header-anchor",href:"#step-15-prepare-to-solder-ir-led-pcb-v2s","aria-label":'Permalink to "Step 15: Prepare to solder IR LED PCB V2s"'},"​")],-1),p=e("p",null,"Get your magnifying glass out, it's time to solder very smol things.",-1),c=e("p",null,"Gather 4 PCBs, 4 IR LEDs, and 2 ~700ohm resistors.",-1),h=e("p",null,"Here are the PCB pin-out labels:",-1),u=e("p",null,"LED labels:",-1),f=a("",10),m=e("p",null,"Tin the resistor pads.",-1),b=e("p",null,"Hold the resistor in place.",-1),v=e("p",null,"Solder one end.",-1),x=e("p",null,"Flip to the other side of the resistor and solder it.",-1),P=e("h2",{id:"solder-leds-on-pcb-v2",tabindex:"-1"},[n("Solder LEDs on PCB V2 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v2","aria-label":'Permalink to "Solder LEDs on PCB V2"'},"​")],-1),g=e("p",null,"Tin the pads",-1),B=e("p",null,"Place the resistor on the pads in the correct orientation.",-1),V=e("p",null,[n("Solder each side of the resistor. Be careful not to solder at too high of a temp, recommended soldering temp is "),e("code",null,"230C with a max of 245C"),n(".")],-1),C=e("h2",{id:"wire-up-the-pcbs-v2",tabindex:"-1"},[n("Wire up the PCBs V2 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v2","aria-label":'Permalink to "Wire up the PCBs V2"'},"​")],-1),S=e("p",null,"Basic full wiring diagram of IR PCBs V2.",-1),w=e("p",null,"The PCB that receives the 5V power is the one with the resistor. The second one, which gets its power from the ground pin of the first, does not have a resistor on it and its power input pin is the AR pin (After-Resistor). The 2nd PCBs ground pin goes to the ground of the system, in the diagram it is the ESPs ground pin.",-1),k=JSON.parse('{"title":"Fox IR V2 Buil dInstructions","description":"","frontmatter":{},"headers":[],"relativePath":"archive/fox_ir_v2_build_instructions.md","filePath":"archive/fox_ir_v2_build_instructions.md","lastUpdated":1676223729000}'),T={name:"archive/fox_ir_v2_build_instructions.md"},L=Object.assign(T,{setup(I){return(D,E)=>(r(),l("div",null,[d,_,p,c,s(o,{options:i(t).fox_ir_build_instructions_one},null,8,["options"]),h,s(o,{options:i(t).fox_ir_build_instructions_two},null,8,["options"]),u,s(o,{options:i(t).fox_ir_build_instructions_three},null,8,["options"]),f,s(o,{options:i(t).fox_ir_build_instructions_four},null,8,["options"]),m,s(o,{options:i(t).fox_ir_build_instructions_five},null,8,["options"]),b,s(o,{options:i(t).fox_ir_build_instructions_six},null,8,["options"]),v,s(o,{options:i(t).fox_ir_build_instructions_seven},null,8,["options"]),x,s(o,{options:i(t).fox_ir_build_instructions_eight},null,8,["options"]),P,s(o,{options:i(t).fox_ir_build_instructions_nine},null,8,["options"]),g,s(o,{options:i(t).fox_ir_build_instructions_ten},null,8,["options"]),B,s(o,{options:i(t).fox_ir_build_instructions_eleven},null,8,["options"]),V,s(o,{options:i(t).fox_ir_build_instructions_twelve},null,8,["options"]),C,S,s(o,{options:i(t).fox_ir_build_instructions_thirteen},null,8,["options"]),w]))}});export{k as __pageData,L as default}; +import{_ as o,i as t}from"./chunks/index.10f74b3d.js";import{o as r,c as l,H as s,l as i,k as e,a as n,Q as a}from"./chunks/framework.e4c952c1.js";const d=e("h1",{class:"text-[var(--font-accent)]",id:"fox-ir-v2-buil-dinstructions",tabindex:"-1"},[n("Fox IR V2 Buil dInstructions "),e("a",{class:"header-anchor",href:"#fox-ir-v2-buil-dinstructions","aria-label":'Permalink to "Fox IR V2 Buil dInstructions {.text-[var(--font-accent)]}"'},"​")],-1),_=e("h2",{id:"step-15-prepare-to-solder-ir-led-pcb-v2s",tabindex:"-1"},[n("Step 15: Prepare to solder IR LED PCB V2s "),e("a",{class:"header-anchor",href:"#step-15-prepare-to-solder-ir-led-pcb-v2s","aria-label":'Permalink to "Step 15: Prepare to solder IR LED PCB V2s"'},"​")],-1),p=e("p",null,"Get your magnifying glass out, it's time to solder very smol things.",-1),c=e("p",null,"Gather 4 PCBs, 4 IR LEDs, and 2 ~700ohm resistors.",-1),h=e("p",null,"Here are the PCB pin-out labels:",-1),u=e("p",null,"LED labels:",-1),f=a("",10),m=e("p",null,"Tin the resistor pads.",-1),b=e("p",null,"Hold the resistor in place.",-1),v=e("p",null,"Solder one end.",-1),x=e("p",null,"Flip to the other side of the resistor and solder it.",-1),P=e("h2",{id:"solder-leds-on-pcb-v2",tabindex:"-1"},[n("Solder LEDs on PCB V2 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v2","aria-label":'Permalink to "Solder LEDs on PCB V2"'},"​")],-1),g=e("p",null,"Tin the pads",-1),B=e("p",null,"Place the resistor on the pads in the correct orientation.",-1),V=e("p",null,[n("Solder each side of the resistor. Be careful not to solder at too high of a temp, recommended soldering temp is "),e("code",null,"230C with a max of 245C"),n(".")],-1),C=e("h2",{id:"wire-up-the-pcbs-v2",tabindex:"-1"},[n("Wire up the PCBs V2 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v2","aria-label":'Permalink to "Wire up the PCBs V2"'},"​")],-1),S=e("p",null,"Basic full wiring diagram of IR PCBs V2.",-1),w=e("p",null,"The PCB that receives the 5V power is the one with the resistor. The second one, which gets its power from the ground pin of the first, does not have a resistor on it and its power input pin is the AR pin (After-Resistor). The 2nd PCBs ground pin goes to the ground of the system, in the diagram it is the ESPs ground pin.",-1),k=JSON.parse('{"title":"Fox IR V2 Buil dInstructions","description":"","frontmatter":{},"headers":[],"relativePath":"archive/fox_ir_v2_build_instructions.md","filePath":"archive/fox_ir_v2_build_instructions.md","lastUpdated":1676223729000}'),T={name:"archive/fox_ir_v2_build_instructions.md"},L=Object.assign(T,{setup(I){return(D,E)=>(r(),l("div",null,[d,_,p,c,s(o,{options:i(t).fox_ir_build_instructions_one},null,8,["options"]),h,s(o,{options:i(t).fox_ir_build_instructions_two},null,8,["options"]),u,s(o,{options:i(t).fox_ir_build_instructions_three},null,8,["options"]),f,s(o,{options:i(t).fox_ir_build_instructions_four},null,8,["options"]),m,s(o,{options:i(t).fox_ir_build_instructions_five},null,8,["options"]),b,s(o,{options:i(t).fox_ir_build_instructions_six},null,8,["options"]),v,s(o,{options:i(t).fox_ir_build_instructions_seven},null,8,["options"]),x,s(o,{options:i(t).fox_ir_build_instructions_eight},null,8,["options"]),P,s(o,{options:i(t).fox_ir_build_instructions_nine},null,8,["options"]),g,s(o,{options:i(t).fox_ir_build_instructions_ten},null,8,["options"]),B,s(o,{options:i(t).fox_ir_build_instructions_eleven},null,8,["options"]),V,s(o,{options:i(t).fox_ir_build_instructions_twelve},null,8,["options"]),C,S,s(o,{options:i(t).fox_ir_build_instructions_thirteen},null,8,["options"]),w]))}});export{k as __pageData,L as default}; diff --git a/assets/chunks/index.0e6ad99c.js b/assets/chunks/index.10f74b3d.js similarity index 97% rename from assets/chunks/index.0e6ad99c.js rename to assets/chunks/index.10f74b3d.js index d26894a8..30de2bd8 100644 --- a/assets/chunks/index.0e6ad99c.js +++ b/assets/chunks/index.10f74b3d.js @@ -1 +1 @@ -import{o as i,c as a,k as m,N as o,a as p,t as e,e as r}from"./framework.e4c952c1.js";const h={align:"center",class:"mb-4"},n=["href"],l=["src","alt"],_=["href"],d=["src","alt"],s={key:2},x=m("br",null,null,-1),g=["href"],u={class:"iconify","data-icon":"mdi:open-in-new","data-inline":"false"},v={__name:"ImageComponent",props:["options"],setup(t){return(c,w)=>(i(),a("div",h,[m("figure",null,[t.options.url_2?(i(),a("a",{key:0,class:"no_icon",target:"_blank",rel:"noopener",href:t.options.url_2},[m("img",{class:"docimage max-w-full h-auto rounded-lg",src:t.options.url,alt:t.options.alt,style:o(t.options.max_width)},null,12,l)],8,n)):(i(),a("a",{key:1,class:"no_icon",target:"_blank",rel:"noopener",href:t.options.url},[m("img",{class:"docimage max-w-full h-auto rounded-lg",src:t.options.url,alt:t.options.alt,style:o(t.options.max_width)},null,12,d)],8,_)),t.options.caption?(i(),a("figcaption",s,[x,p(" "+e(t.options.caption)+" ",1),t.options.caption_link?(i(),a("a",{key:0,href:t.options.caption_link,target:"_blank"},[m("span",u,e(t.options.caption_link),1)],8,g)):r("",!0)])):r("",!0)])]))}},b={image_one:{url:"https://i.imgur.com/j18rRI7.jpg",alt:"'img of components'",caption:"'ESPs, cams, a programmer and a USB connector'",max_width:"max-width: 400px;"},discord_content:{url:"https://discord.com/api/guilds/946212245187199026/widget.png?style=banner3",url_2:"https://discord.gg/kkXYbVykZX",alt:"'discord banner'",max_width:"max-width: 400px;"},external_antenna:{url:"https://i.imgur.com/OzpxFMD.png",alt:"'img of external antenna'",caption:"Image from:",caption_link:"https://randomnerdtutorials.com/esp32-cam-connect-external-antenna",max_width:"max-width: 400px;"},external_antenna_resistors:{url:"https://i.imgur.com/RIFpNqW.jpg",alt:"'img of external antenna resistors'",max_width:"max-width: 400px;"},camera_socket:{url:"https://i.imgur.com/T5asLGN.jpg",alt:"'img of camera socket'",max_width:"max-width: 400px;"},camera_socket_clip:{url:"https://i.imgur.com/Z8b8Sin.jpg",alt:"'img of camera clip'",max_width:"max-width: 400px;"},camera_cable:{url:"https://i.imgur.com/dDBIi9j.jpg",alt:"'img of camera cable'",max_width:"max-width: 400px;"},camera_clip_close:{url:"https://i.imgur.com/VnFi5XS.jpg",alt:"'img of camera cable'",max_width:"max-width: 400px;"},_7_12_one:{url:"https://i.imgur.com/LsLPAcd.jpg",alt:"",max_width:"max-width: 400px;"},_7_12_two:{url:"https://i.imgur.com/Cdu9lSN.jpg",alt:"",max_width:"max-width: 400px;"},_7_12_three:{url:"https://i.imgur.com/QlRrWNn.jpg",alt:"",max_width:"max-width: 400px;"},_13_18_one:{url:"https://i.imgur.com/DhnmLBG.jpg",alt:"",max_width:"max-width: 400px;"},_13_18_two:{url:"https://i.imgur.com/PWA0gtq.jpg",alt:"",max_width:"max-width: 400px;"},_13_18_three:{url:"https://i.imgur.com/0zXY79j.jpg",alt:"",caption:"357ohm resistors and V3 PCBs",max_width:"max-width: 400px;"},_13_18_four:{url:"https://i.imgur.com/n1noWKq.png",alt:"",caption:"V3",max_width:"max-width: 400px;"},_13_18_five:{url:"https://i.imgur.com/Ap8OAWY.png",alt:"",caption:"The green markings and notched corners mark the positive sides of the LEDs pictured above.",max_width:"max-width: 400px;"},_13_18_six:{url:"https://i.imgur.com/gb4etdB.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_seven:{url:"https://i.imgur.com/ev5QFch.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_eight:{url:"https://i.imgur.com/8jCQOHw.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_nine:{url:"https://i.imgur.com/CHUb7Iv.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_ten:{url:"https://i.imgur.com/jZYAm5O.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_one:{url:"https://i.imgur.com/pjvLHJL.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_two:{url:"https://i.imgur.com/RbHZQhl.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_three:{url:"https://i.imgur.com/VyClWvp.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_four:{url:"https://i.imgur.com/tFCQTqE.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_five:{url:"https://i.imgur.com/tFCQTqE.jpeg",alt:"",caption:"",max_width:"max-width: 400px;"},end_six:{url:"https://i.imgur.com/pqDgpYP.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_seven:{url:"https://i.imgur.com/bEq6Ww0.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_eight:{url:"https://i.imgur.com/r2Jo45t.png",alt:"",caption:"",max_width:"max-width: 400px;"},end_nine:{url:"https://i.imgur.com/a6ERUFx.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_ten:{url:"https://i.imgur.com/Wy89UWy.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_eleven:{url:"https://i.imgur.com/LtKOLWo.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_twelve:{url:"https://i.imgur.com/9mty1bv.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_thirteen:{url:"https://i.imgur.com/ArLO1ls.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_fourteen:{url:"https://i.imgur.com/ZIecsMM.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_fifteen:{url:"https://i.imgur.com/tYD1KKe.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_sixteen:{url:"https://i.imgur.com/3rCRU5A.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},upload_firmware_image_one:{url:"https://i.imgur.com/dSPSpkY.png",alt:"'platformio serial monitor button'",max_width:"max-width: 500px;"},upload_firmware_image_two:{url:"https://i.imgur.com/PoHP3NC.png",alt:"'img of platformio serial monitor'",max_width:"max-width: 600px;"},upload_firmware_build_button:{url:"https://i.imgur.com/5E5u5Jz.png",alt:"'Selecting platformio environment'",max_width:"max-width: 600px;"},upload_firmware_webpage:{url:"https://i.imgur.com/wMXdZcJ.png",alt:"'Firmware uploading web page'",max_width:"max-width: 600px;"},upload_firmware_webpage_directory:{url:"https://i.imgur.com/KnnB28z.png",alt:"'An example of how the bin file directory looks like'",max_width:"max-width: 600px;"},upload_firmware_webpage_directory_file:{url:"https://i.imgur.com/Ujx3iaG.png",alt:"'An example of how the bin file looks like'",max_width:"max-width: 600px;"},upload_firmware_webpage_upload_finished:{url:"https://i.imgur.com/O2KzHAN.png",alt:"'A finished OTA upload'",max_width:"max-width: 600px;"},upload_firmware_select_env:{url:"https://i.imgur.com/8sn6FSe.png",alt:"'An example of how the popup list of envs looks like'",max_width:"max-width: 600px;"},upload_firmware_select_env_dropdown:{url:"https://i.imgur.com/nRpuBSI.png",alt:"'An example of how the button for selecting env looks like'",max_width:"max-width: 600px;"},ant_logo_platformio:{url:"https://i.imgur.com/B6zK6n8.png",alt:"Platformio logo button",max_width:"max-width: 600px;"},platformio_quick_access:{url:"https://i.imgur.com/94Xgg9k.png",alt:"Platformio logo Quick Access Section",max_width:"max-width: 600px;"},platformio_quick_access_miscellaneous:{url:"https://i.imgur.com/Zoolr2M.png",alt:"Platformio miscellaneous section",max_width:"max-width: 600px;"},platformio_quick_access_upgrade_core:{url:"https://i.imgur.com/nOF817M.png",alt:"Platformio upgrade core button",max_width:"max-width: 600px;"},platformio_pio_home:{url:"https://i.imgur.com/M7ZYAtU.png",alt:"Platformio open home",max_width:"max-width: 600px;"},platformio_pio_sidebar_platforms:{url:"https://i.imgur.com/LgnU4HG.png",alt:"Platformio platforms sidebar",max_width:"max-width: 600px;"},platformio_pio_sidebar_platforms_updates:{url:"https://i.imgur.com/ZsKos2E.png",alt:"Platformio platforms sections",max_width:"max-width: 600px;"},platformio_pio_espressif32:{url:"https://i.imgur.com/mQdM6X2.png",alt:"Platformio platforms update view",max_width:"max-width: 600px;"},setup_vscode_image_one:{url:"https://i.imgur.com/jXPXIFz.gif",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_two:{url:"https://i.imgur.com/hAm3Zu0.gif",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_three:{url:"https://i.imgur.com/ebV0IgT.gif",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_four:{url:"https://i.imgur.com/DWO5vkE.png",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_five:{url:"https://i.imgur.com/fJs4GJR.png",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_six:{url:"https://i.imgur.com/YbXpX7t.png",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_seven:{url:"https://i.imgur.com/c61Cpaz.gif",alt:"'img'",max_width:"max-width: 500px;"},configure_firmware_one:{url:"https://i.imgur.com/1Ficr7f.png",alt:"'img'",max_width:"max-width: 500px;"},configure_firmware_two:{url:"https://i.imgur.com/Sq4iQJe.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_one:{url:"https://i.imgur.com/olwRFYI.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_two:{url:"https://i.imgur.com/Ugzzgbh.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_three:{url:"https://i.imgur.com/z6V7A71.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_four:{url:"https://i.imgur.com/MJb2h74.png",alt:"'img'",caption:"See the Awaiting Eye Cropping Settings text?",max_width:"max-width: 500px;"},eyetrack_vr_guide_five:{url:"https://i.imgur.com/1pNYITS.png",alt:"'img'",caption:":O It's my eye!",max_width:"max-width: 500px;"},eyetrack_vr_guide_six:{url:"https://i.imgur.com/HZSvFBv.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_seven:{url:"https://i.imgur.com/xXTB3sM.png",alt:"'img'",caption:"It's crooked!",max_width:"max-width: 500px;"},eyetrack_vr_guide_eight:{url:"https://i.imgur.com/blsrpCX.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},eyetrack_vr_guide_nine:{url:"https://i.imgur.com/30fFadH.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},eyetrack_vr_guide_ten:{url:"https://i.imgur.com/ZjpKfCV.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},eyetrack_vr_guide_eleven:{url:"https://i.imgur.com/KPUn8S1.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},fox_ir_build_instructions_one:{url:"https://i.imgur.com/WyoVdcR.jpg",alt:"'img'",caption:"698ohm resistors and V2 PCBs",max_width:"max-width: 400px;"},fox_ir_build_instructions_two:{url:"https://i.imgur.com/sNB6ju2.png",alt:"'img'",caption:"V2",max_width:"max-width: 400px;"},fox_ir_build_instructions_three:{url:"https://i.imgur.com/Ap8OAWY.png",alt:"'img'",caption:"The green markings and notched corners mark the positive sides of the LEDs pictured above.",max_width:"max-width: 400px;"},fox_ir_build_instructions_four:{url:"https://i.imgur.com/ayQ5vkf.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_five:{url:"https://i.imgur.com/DpFwecO.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_six:{url:"https://i.imgur.com/50ydMrl.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_seven:{url:"https://i.imgur.com/Qq3cvxi.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_eight:{url:"https://i.imgur.com/yWGaKaC.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_nine:{url:"https://i.imgur.com/Ql4zYCq.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_ten:{url:"https://i.imgur.com/Xrczoyv.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_eleven:{url:"https://i.imgur.com/KKgP8qs.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_twelve:{url:"https://i.imgur.com/SvbHAuY.jpg",alt:"'img'",caption:"The LED is flipped in this Image, the green dot should face AWAY from the PCB.",max_width:"max-width: 400px;"},fox_ir_build_instructions_thirteen:{url:"https://i.imgur.com/gopjVG3.png",alt:"'drawing'",max_width:"max-width: 500px;"},pio_upgrade_command:{url:"https://i.imgur.com/taDa3vj.png",alt:"pio upgrade command in the terminal",max_width:"max-width: 500px;"},unity_vrc_expressions:{url:"https://i.imgur.com/hdbJQ0h.png",alt:"Screenshot showing expressions section of vrc avatar descriptor",max_width:"max-width: 600px;"},unity_vrc_expressions_add_fields:{url:"https://i.imgur.com/VGA0zqb.png",alt:"Screenshot showing adding parameters to parameter menu",max_width:"max-width: 600px;"},unity_vrc_expressions_fields:{url:"https://i.imgur.com/hkcT013.png",alt:"Screenshot showing the params that need to be added",max_width:"max-width: 600px;"},unity_vrc_empty_control:{url:"https://i.imgur.com/PluHjmI.png",alt:"Screenshot showing the the empty controls field",max_width:"max-width: 600px;"},unity_vrc_control_setup:{url:"https://i.imgur.com/XgN2230.png",alt:"Screenshot showing the the controls setup",max_width:"max-width: 600px;"},V4_wire_sketch:{url:"https://i.imgur.com/OWSh6WM.png",alt:"Sketch of V4 wiring",max_width:"max-width: 600px;"},V4_solder_wire:{url:"https://i.imgur.com/yB9e92o.jpg",alt:"Sketch of V4 wire",max_width:"max-width: 400px;"},esp_board_env:{url:"https://i.imgur.com/5BbQmCE.gif",alt:"GIF showing a switch of board environments.",max_width:"max-width: 600px;"},flashing_tool:{url:"https://docs.eyetrackvr.dev/imgs/flashing_tool.png",alt:"Flashing Tool ui",max_width:"max-width: 600px;"},flashing_tool_1:{url:"https://docs.eyetrackvr.dev/imgs/flashing_tool_1.png",alt:"Flashing Tool ui lower half",max_width:"max-width: 600px;"}};export{v as _,b as i}; +import{o as i,c as a,k as m,N as o,a as p,t as e,e as r}from"./framework.e4c952c1.js";const h={align:"center",class:"mb-4"},n=["href"],l=["src","alt"],_=["href"],d=["src","alt"],s={key:2},x=m("br",null,null,-1),g=["href"],u={class:"iconify","data-icon":"mdi:open-in-new","data-inline":"false"},v={__name:"ImageComponent",props:["options"],setup(t){return(c,w)=>(i(),a("div",h,[m("figure",null,[t.options.url_2?(i(),a("a",{key:0,class:"no_icon",target:"_blank",rel:"noopener",href:t.options.url_2},[m("img",{class:"docimage max-w-full h-auto rounded-lg",src:t.options.url,alt:t.options.alt,style:o(t.options.max_width)},null,12,l)],8,n)):(i(),a("a",{key:1,class:"no_icon",target:"_blank",rel:"noopener",href:t.options.url},[m("img",{class:"docimage max-w-full h-auto rounded-lg",src:t.options.url,alt:t.options.alt,style:o(t.options.max_width)},null,12,d)],8,_)),t.options.caption?(i(),a("figcaption",s,[x,p(" "+e(t.options.caption)+" ",1),t.options.caption_link?(i(),a("a",{key:0,href:t.options.caption_link,target:"_blank"},[m("span",u,e(t.options.caption_link),1)],8,g)):r("",!0)])):r("",!0)])]))}},b={image_one:{url:"https://i.imgur.com/j18rRI7.jpg",alt:"'img of components'",caption:"'ESPs, cams, a programmer and a USB connector'",max_width:"max-width: 400px;"},discord_content:{url:"https://discord.com/api/guilds/946212245187199026/widget.png?style=banner3",url_2:"https://discord.gg/kkXYbVykZX",alt:"'discord banner'",max_width:"max-width: 400px;"},external_antenna:{url:"https://i.imgur.com/OzpxFMD.png",alt:"'img of external antenna'",caption:"Image from:",caption_link:"https://randomnerdtutorials.com/esp32-cam-connect-external-antenna",max_width:"max-width: 400px;"},external_antenna_resistors:{url:"https://i.imgur.com/RIFpNqW.jpg",alt:"'img of external antenna resistors'",max_width:"max-width: 400px;"},camera_socket:{url:"https://i.imgur.com/T5asLGN.jpg",alt:"'img of camera socket'",max_width:"max-width: 400px;"},camera_socket_clip:{url:"https://i.imgur.com/Z8b8Sin.jpg",alt:"'img of camera clip'",max_width:"max-width: 400px;"},camera_cable:{url:"https://i.imgur.com/dDBIi9j.jpg",alt:"'img of camera cable'",max_width:"max-width: 400px;"},camera_clip_close:{url:"https://i.imgur.com/VnFi5XS.jpg",alt:"'img of camera cable'",max_width:"max-width: 400px;"},_7_12_one:{url:"https://i.imgur.com/LsLPAcd.jpg",alt:"",max_width:"max-width: 400px;"},_7_12_two:{url:"https://i.imgur.com/Cdu9lSN.jpg",alt:"",max_width:"max-width: 400px;"},_7_12_three:{url:"https://i.imgur.com/QlRrWNn.jpg",alt:"",max_width:"max-width: 400px;"},_13_18_one:{url:"https://i.imgur.com/DhnmLBG.jpg",alt:"",max_width:"max-width: 400px;"},_13_18_two:{url:"https://i.imgur.com/PWA0gtq.jpg",alt:"",max_width:"max-width: 400px;"},_13_18_three:{url:"https://i.imgur.com/0zXY79j.jpg",alt:"",caption:"357ohm resistors and V3 PCBs",max_width:"max-width: 400px;"},_13_18_four:{url:"https://i.imgur.com/n1noWKq.png",alt:"",caption:"V3",max_width:"max-width: 400px;"},_13_18_five:{url:"https://i.imgur.com/Ap8OAWY.png",alt:"",caption:"The green markings and notched corners mark the positive sides of the LEDs pictured above.",max_width:"max-width: 400px;"},_13_18_six:{url:"https://i.imgur.com/gb4etdB.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_seven:{url:"https://i.imgur.com/ev5QFch.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_eight:{url:"https://i.imgur.com/8jCQOHw.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_nine:{url:"https://i.imgur.com/CHUb7Iv.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},_13_18_ten:{url:"https://i.imgur.com/jZYAm5O.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_one:{url:"https://i.imgur.com/pjvLHJL.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_two:{url:"https://i.imgur.com/RbHZQhl.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_three:{url:"https://i.imgur.com/VyClWvp.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_four:{url:"https://i.imgur.com/tFCQTqE.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_five:{url:"https://i.imgur.com/tFCQTqE.jpeg",alt:"",caption:"",max_width:"max-width: 400px;"},end_six:{url:"https://i.imgur.com/pqDgpYP.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_seven:{url:"https://i.imgur.com/bEq6Ww0.jpg",alt:"",caption:"",max_width:"max-width: 400px;"},end_eight:{url:"https://i.imgur.com/r2Jo45t.png",alt:"",caption:"",max_width:"max-width: 400px;"},end_nine:{url:"https://i.imgur.com/a6ERUFx.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_ten:{url:"https://i.imgur.com/Wy89UWy.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_eleven:{url:"https://i.imgur.com/LtKOLWo.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_twelve:{url:"https://i.imgur.com/9mty1bv.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_thirteen:{url:"https://i.imgur.com/ArLO1ls.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_fourteen:{url:"https://i.imgur.com/ZIecsMM.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},end_fifteen:{url:"https://i.imgur.com/tYD1KKe.png",alt:"",caption:"",max_width:"max-width: 500px;"},end_sixteen:{url:"https://i.imgur.com/3rCRU5A.jpg",alt:"",caption:"",max_width:"max-width: 500px;"},upload_firmware_image_one:{url:"https://i.imgur.com/dSPSpkY.png",alt:"'platformio serial monitor button'",max_width:"max-width: 500px;"},upload_firmware_image_two:{url:"https://i.imgur.com/PoHP3NC.png",alt:"'img of platformio serial monitor'",max_width:"max-width: 600px;"},upload_firmware_build_button:{url:"https://i.imgur.com/5E5u5Jz.png",alt:"'Selecting platformio environment'",max_width:"max-width: 600px;"},upload_firmware_webpage:{url:"https://i.imgur.com/wMXdZcJ.png",alt:"'Firmware uploading web page'",max_width:"max-width: 600px;"},upload_firmware_webpage_directory:{url:"https://i.imgur.com/KnnB28z.png",alt:"'An example of how the bin file directory looks like'",max_width:"max-width: 600px;"},upload_firmware_webpage_directory_file:{url:"https://i.imgur.com/Ujx3iaG.png",alt:"'An example of how the bin file looks like'",max_width:"max-width: 600px;"},upload_firmware_webpage_upload_finished:{url:"https://i.imgur.com/O2KzHAN.png",alt:"'A finished OTA upload'",max_width:"max-width: 600px;"},upload_firmware_select_env:{url:"https://i.imgur.com/8sn6FSe.png",alt:"'An example of how the popup list of envs looks like'",max_width:"max-width: 600px;"},upload_firmware_select_env_dropdown:{url:"https://i.imgur.com/nRpuBSI.png",alt:"'An example of how the button for selecting env looks like'",max_width:"max-width: 600px;"},ant_logo_platformio:{url:"https://i.imgur.com/B6zK6n8.png",alt:"Platformio logo button",max_width:"max-width: 600px;"},platformio_quick_access:{url:"https://i.imgur.com/94Xgg9k.png",alt:"Platformio logo Quick Access Section",max_width:"max-width: 600px;"},platformio_quick_access_miscellaneous:{url:"https://i.imgur.com/Zoolr2M.png",alt:"Platformio miscellaneous section",max_width:"max-width: 600px;"},platformio_quick_access_upgrade_core:{url:"https://i.imgur.com/nOF817M.png",alt:"Platformio upgrade core button",max_width:"max-width: 600px;"},platformio_pio_home:{url:"https://i.imgur.com/M7ZYAtU.png",alt:"Platformio open home",max_width:"max-width: 600px;"},platformio_pio_sidebar_platforms:{url:"https://i.imgur.com/LgnU4HG.png",alt:"Platformio platforms sidebar",max_width:"max-width: 600px;"},platformio_pio_sidebar_platforms_updates:{url:"https://i.imgur.com/ZsKos2E.png",alt:"Platformio platforms sections",max_width:"max-width: 600px;"},platformio_pio_espressif32:{url:"https://i.imgur.com/mQdM6X2.png",alt:"Platformio platforms update view",max_width:"max-width: 600px;"},setup_vscode_image_one:{url:"https://i.imgur.com/jXPXIFz.gif",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_two:{url:"https://i.imgur.com/hAm3Zu0.gif",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_three:{url:"https://i.imgur.com/ebV0IgT.gif",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_four:{url:"https://i.imgur.com/DWO5vkE.png",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_five:{url:"https://i.imgur.com/fJs4GJR.png",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_six:{url:"https://i.imgur.com/YbXpX7t.png",alt:"'img'",max_width:"max-width: 500px;"},setup_vscode_image_seven:{url:"https://i.imgur.com/c61Cpaz.gif",alt:"'img'",max_width:"max-width: 500px;"},configure_firmware_one:{url:"https://i.imgur.com/1Ficr7f.png",alt:"'img'",max_width:"max-width: 500px;"},configure_firmware_two:{url:"https://i.imgur.com/Sq4iQJe.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_one:{url:"https://i.imgur.com/olwRFYI.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_two:{url:"https://i.imgur.com/Ugzzgbh.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_three:{url:"https://i.imgur.com/z6V7A71.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_four:{url:"https://i.imgur.com/MJb2h74.png",alt:"'img'",caption:"See the Awaiting Eye Cropping Settings text?",max_width:"max-width: 500px;"},eyetrack_vr_guide_five:{url:"https://i.imgur.com/1pNYITS.png",alt:"'img'",caption:":O It's my eye!",max_width:"max-width: 500px;"},eyetrack_vr_guide_six:{url:"https://i.imgur.com/HZSvFBv.png",alt:"'img'",max_width:"max-width: 500px;"},eyetrack_vr_guide_seven:{url:"https://i.imgur.com/xXTB3sM.png",alt:"'img'",caption:"It's crooked!",max_width:"max-width: 500px;"},eyetrack_vr_guide_eight:{url:"https://i.imgur.com/blsrpCX.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},eyetrack_vr_guide_nine:{url:"https://i.imgur.com/30fFadH.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},eyetrack_vr_guide_ten:{url:"https://i.imgur.com/ZjpKfCV.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},eyetrack_vr_guide_eleven:{url:"https://i.imgur.com/KPUn8S1.png",alt:"'img'",caption:"Much better!",max_width:"max-width: 500px;"},fox_ir_build_instructions_one:{url:"https://i.imgur.com/WyoVdcR.jpg",alt:"'img'",caption:"698ohm resistors and V2 PCBs",max_width:"max-width: 400px;"},fox_ir_build_instructions_two:{url:"https://i.imgur.com/sNB6ju2.png",alt:"'img'",caption:"V2",max_width:"max-width: 400px;"},fox_ir_build_instructions_three:{url:"https://i.imgur.com/Ap8OAWY.png",alt:"'img'",caption:"The green markings and notched corners mark the positive sides of the LEDs pictured above.",max_width:"max-width: 400px;"},fox_ir_build_instructions_four:{url:"https://i.imgur.com/ayQ5vkf.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_five:{url:"https://i.imgur.com/DpFwecO.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_six:{url:"https://i.imgur.com/50ydMrl.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_seven:{url:"https://i.imgur.com/Qq3cvxi.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_eight:{url:"https://i.imgur.com/yWGaKaC.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_nine:{url:"https://i.imgur.com/Ql4zYCq.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_ten:{url:"https://i.imgur.com/Xrczoyv.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_eleven:{url:"https://i.imgur.com/KKgP8qs.jpg",alt:"'img'",max_width:"max-width: 400px;"},fox_ir_build_instructions_twelve:{url:"https://i.imgur.com/SvbHAuY.jpg",alt:"'img'",caption:"The LED is flipped in this Image, the green dot should face AWAY from the PCB.",max_width:"max-width: 400px;"},fox_ir_build_instructions_thirteen:{url:"https://i.imgur.com/gopjVG3.png",alt:"'drawing'",max_width:"max-width: 500px;"},pio_upgrade_command:{url:"https://i.imgur.com/taDa3vj.png",alt:"pio upgrade command in the terminal",max_width:"max-width: 500px;"},unity_vrc_expressions:{url:"https://i.imgur.com/hdbJQ0h.png",alt:"Screenshot showing expressions section of vrc avatar descriptor",max_width:"max-width: 600px;"},unity_vrc_expressions_add_fields:{url:"https://i.imgur.com/VGA0zqb.png",alt:"Screenshot showing adding parameters to parameter menu",max_width:"max-width: 600px;"},unity_vrc_expressions_fields:{url:"https://i.imgur.com/hkcT013.png",alt:"Screenshot showing the params that need to be added",max_width:"max-width: 600px;"},unity_vrc_empty_control:{url:"https://i.imgur.com/PluHjmI.png",alt:"Screenshot showing the the empty controls field",max_width:"max-width: 600px;"},unity_vrc_control_setup:{url:"https://i.imgur.com/XgN2230.png",alt:"Screenshot showing the the controls setup",max_width:"max-width: 600px;"},V4_wire_sketch:{url:"https://i.imgur.com/OWSh6WM.png",alt:"Sketch of V4 wiring",max_width:"max-width: 600px;"},V4_solder_wire:{url:"https://i.imgur.com/yB9e92o.jpg",alt:"Sketch of V4 wire",max_width:"max-width: 400px;"},esp_board_env:{url:"https://i.imgur.com/5BbQmCE.gif",alt:"GIF showing a switch of board environments.",max_width:"max-width: 600px;"},flashing_tool:{url:"https://docs.eyetrackvr.dev/imgs/flashingtool.png",alt:"Flashing Tool ui",max_width:"max-width: 600px;"},flashing_tool_1:{url:"https://docs.eyetrackvr.dev/imgs/flashingtool_1.png",alt:"Flashing Tool ui lower half",max_width:"max-width: 600px;"}};export{v as _,b as i}; diff --git a/assets/firmware_guide_configure_firmware.md.7852fa9f.js b/assets/firmware_guide_configure_firmware.md.04dc1dcd.js similarity index 99% rename from assets/firmware_guide_configure_firmware.md.7852fa9f.js rename to assets/firmware_guide_configure_firmware.md.04dc1dcd.js index d28ee5aa..e323f2cd 100644 --- a/assets/firmware_guide_configure_firmware.md.7852fa9f.js +++ b/assets/firmware_guide_configure_firmware.md.04dc1dcd.js @@ -1 +1 @@ -import{_ as s,a as d}from"./chunks/index.8ad7dc66.js";import{_ as n,i}from"./chunks/index.0e6ad99c.js";import{o as h,c,H as t,l as a,w as l,k as e,a as o,Q as r}from"./chunks/framework.e4c952c1.js";const u=e("h1",{class:"text-[var(--font-accent)]",id:"configuring-the-firmware",tabindex:"-1"},[o("Configuring the firmware "),e("a",{class:"header-anchor",href:"#configuring-the-firmware","aria-label":'Permalink to "Configuring the firmware {.text-[var(--font-accent)]}"'},"​")],-1),p=e("h2",{id:"once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this",tabindex:"-1"},[o("Once you have opened the project, you should see something on the left side like this "),e("a",{class:"header-anchor",href:"#once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this","aria-label":'Permalink to "Once you have opened the project, you should see something on the left side like this"'},"​")],-1),f=e("h2",{id:"open-the-ini-user-config-ini-file",tabindex:"-1"},[o("Open the "),e("code",null,"ini/user_config.ini"),o(" file "),e("a",{class:"header-anchor",href:"#open-the-ini-user-config-ini-file","aria-label":'Permalink to "Open the `ini/user_config.ini` file"'},"​")],-1),m=r('

INFO

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.

Replace the placeholder text with your correct SSID (WiFi access point name), and password respectfully.

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.

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.

Then, you will need to set the ap_ssid to the name of your AP, and ap_password to the password of your AP.

You can choose to leave the ap_ssid and ap_password as defaults, but you will need to set the enableadhoc to 1.

Note: If you are enabling AP mode for both ESPs, you will need to set the ap_ssid and ap_password to different values for both ESPs. It is best to set AP mode only for one ESP, and leave the other ESP in STA mode. Connect the other ESP to the AP of the ESP in AP mode. Then connect your computer to the AP of the ESP in AP mode. This will allow you to connect to the ESP in AP mode, and the ESP in STA mode.

',3),w=e("p",null," 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. ",-1),_=r('

Double check that you have correctly entered your WiFi credentials and that said wifi network has a 2.4GHz band.

Additional configuration ​

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.

OTA ​

The firmware supports OTA updates. This means that you can update the firmware without having to connect to the ESPs. To enable OTA updates, you will need to set the enableota to 1. Then, you will need to set the otapassword to the password you wish to use to update the firmware. You will need to use this password to update the firmware. If you do not wish to use a password, you can set the otapassword to nothing. This will allow you to update the firmware without a password. However, this is not recommended, as anyone on your network will be able to update the firmware.

You will also need to set the otaserverip to the IP address of the ESP you wish to update. This is the IP address of the ESP you wish to update. If you are using mDNS, you can use the mDNS name of the ESP you wish to update. For example, if you are updating the ESP with the dns set to http://esp32.local, you will need to set the otaserverip to http://esp32.local.

REST API ​

The firmware also supports a fully featured REST API. This means that you can control the ESPs using a REST API. This feature is enabled by defauly, and can not be turned off.

This feature is used more for advanced users, and is not required for basic operation.

The REST API was developed to be used by our new app (still in development). However, it can be used by any REST API client, you can not send POST requests to the ESPs using a browser though, so some REST API functionality can only be used by tools like Thunder Client or Postman.

The full REST API is documented here.

Environments ​

The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.

Please reference the Firmware Enviroments Page for more information.

Now, move on to uploading the firmware ​

',16),E=JSON.parse('{"title":"Configuring the firmware","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/configure_firmware.md","filePath":"firmware_guide/configure_firmware.md","lastUpdated":1698315393000}'),y={name:"firmware_guide/configure_firmware.md"},k=Object.assign(y,{setup(g){return(P,b)=>(h(),c("div",null,[u,p,t(n,{options:a(i).configure_firmware_one},null,8,["options"]),f,t(n,{options:a(i).configure_firmware_two},null,8,["options"]),m,t(s,{options:a(d).parts_list_one},{content:l(()=>[w]),_:1},8,["options"]),_]))}});export{E as __pageData,k as default}; +import{_ as s,a as d}from"./chunks/index.8ad7dc66.js";import{_ as n,i}from"./chunks/index.10f74b3d.js";import{o as h,c,H as t,l as a,w as l,k as e,a as o,Q as r}from"./chunks/framework.e4c952c1.js";const u=e("h1",{class:"text-[var(--font-accent)]",id:"configuring-the-firmware",tabindex:"-1"},[o("Configuring the firmware "),e("a",{class:"header-anchor",href:"#configuring-the-firmware","aria-label":'Permalink to "Configuring the firmware {.text-[var(--font-accent)]}"'},"​")],-1),p=e("h2",{id:"once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this",tabindex:"-1"},[o("Once you have opened the project, you should see something on the left side like this "),e("a",{class:"header-anchor",href:"#once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this","aria-label":'Permalink to "Once you have opened the project, you should see something on the left side like this"'},"​")],-1),f=e("h2",{id:"open-the-ini-user-config-ini-file",tabindex:"-1"},[o("Open the "),e("code",null,"ini/user_config.ini"),o(" file "),e("a",{class:"header-anchor",href:"#open-the-ini-user-config-ini-file","aria-label":'Permalink to "Open the `ini/user_config.ini` file"'},"​")],-1),m=r('

INFO

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.

Replace the placeholder text with your correct SSID (WiFi access point name), and password respectfully.

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.

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.

Then, you will need to set the ap_ssid to the name of your AP, and ap_password to the password of your AP.

You can choose to leave the ap_ssid and ap_password as defaults, but you will need to set the enableadhoc to 1.

Note: If you are enabling AP mode for both ESPs, you will need to set the ap_ssid and ap_password to different values for both ESPs. It is best to set AP mode only for one ESP, and leave the other ESP in STA mode. Connect the other ESP to the AP of the ESP in AP mode. Then connect your computer to the AP of the ESP in AP mode. This will allow you to connect to the ESP in AP mode, and the ESP in STA mode.

',3),w=e("p",null," 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. ",-1),_=r('

Double check that you have correctly entered your WiFi credentials and that said wifi network has a 2.4GHz band.

Additional configuration ​

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.

OTA ​

The firmware supports OTA updates. This means that you can update the firmware without having to connect to the ESPs. To enable OTA updates, you will need to set the enableota to 1. Then, you will need to set the otapassword to the password you wish to use to update the firmware. You will need to use this password to update the firmware. If you do not wish to use a password, you can set the otapassword to nothing. This will allow you to update the firmware without a password. However, this is not recommended, as anyone on your network will be able to update the firmware.

You will also need to set the otaserverip to the IP address of the ESP you wish to update. This is the IP address of the ESP you wish to update. If you are using mDNS, you can use the mDNS name of the ESP you wish to update. For example, if you are updating the ESP with the dns set to http://esp32.local, you will need to set the otaserverip to http://esp32.local.

REST API ​

The firmware also supports a fully featured REST API. This means that you can control the ESPs using a REST API. This feature is enabled by defauly, and can not be turned off.

This feature is used more for advanced users, and is not required for basic operation.

The REST API was developed to be used by our new app (still in development). However, it can be used by any REST API client, you can not send POST requests to the ESPs using a browser though, so some REST API functionality can only be used by tools like Thunder Client or Postman.

The full REST API is documented here.

Environments ​

The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.

Please reference the Firmware Enviroments Page for more information.

Now, move on to uploading the firmware ​

',16),E=JSON.parse('{"title":"Configuring the firmware","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/configure_firmware.md","filePath":"firmware_guide/configure_firmware.md","lastUpdated":1698315393000}'),y={name:"firmware_guide/configure_firmware.md"},k=Object.assign(y,{setup(g){return(P,b)=>(h(),c("div",null,[u,p,t(n,{options:a(i).configure_firmware_one},null,8,["options"]),f,t(n,{options:a(i).configure_firmware_two},null,8,["options"]),m,t(s,{options:a(d).parts_list_one},{content:l(()=>[w]),_:1},8,["options"]),_]))}});export{E as __pageData,k as default}; diff --git a/assets/firmware_guide_configure_firmware.md.7852fa9f.lean.js b/assets/firmware_guide_configure_firmware.md.04dc1dcd.lean.js similarity index 96% rename from assets/firmware_guide_configure_firmware.md.7852fa9f.lean.js rename to assets/firmware_guide_configure_firmware.md.04dc1dcd.lean.js index 000bfa5a..68fa6888 100644 --- a/assets/firmware_guide_configure_firmware.md.7852fa9f.lean.js +++ b/assets/firmware_guide_configure_firmware.md.04dc1dcd.lean.js @@ -1 +1 @@ -import{_ as s,a as d}from"./chunks/index.8ad7dc66.js";import{_ as n,i}from"./chunks/index.0e6ad99c.js";import{o as h,c,H as t,l as a,w as l,k as e,a as o,Q as r}from"./chunks/framework.e4c952c1.js";const u=e("h1",{class:"text-[var(--font-accent)]",id:"configuring-the-firmware",tabindex:"-1"},[o("Configuring the firmware "),e("a",{class:"header-anchor",href:"#configuring-the-firmware","aria-label":'Permalink to "Configuring the firmware {.text-[var(--font-accent)]}"'},"​")],-1),p=e("h2",{id:"once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this",tabindex:"-1"},[o("Once you have opened the project, you should see something on the left side like this "),e("a",{class:"header-anchor",href:"#once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this","aria-label":'Permalink to "Once you have opened the project, you should see something on the left side like this"'},"​")],-1),f=e("h2",{id:"open-the-ini-user-config-ini-file",tabindex:"-1"},[o("Open the "),e("code",null,"ini/user_config.ini"),o(" file "),e("a",{class:"header-anchor",href:"#open-the-ini-user-config-ini-file","aria-label":'Permalink to "Open the `ini/user_config.ini` file"'},"​")],-1),m=r("",3),w=e("p",null," 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. ",-1),_=r("",16),E=JSON.parse('{"title":"Configuring the firmware","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/configure_firmware.md","filePath":"firmware_guide/configure_firmware.md","lastUpdated":1698315393000}'),y={name:"firmware_guide/configure_firmware.md"},k=Object.assign(y,{setup(g){return(P,b)=>(h(),c("div",null,[u,p,t(n,{options:a(i).configure_firmware_one},null,8,["options"]),f,t(n,{options:a(i).configure_firmware_two},null,8,["options"]),m,t(s,{options:a(d).parts_list_one},{content:l(()=>[w]),_:1},8,["options"]),_]))}});export{E as __pageData,k as default}; +import{_ as s,a as d}from"./chunks/index.8ad7dc66.js";import{_ as n,i}from"./chunks/index.10f74b3d.js";import{o as h,c,H as t,l as a,w as l,k as e,a as o,Q as r}from"./chunks/framework.e4c952c1.js";const u=e("h1",{class:"text-[var(--font-accent)]",id:"configuring-the-firmware",tabindex:"-1"},[o("Configuring the firmware "),e("a",{class:"header-anchor",href:"#configuring-the-firmware","aria-label":'Permalink to "Configuring the firmware {.text-[var(--font-accent)]}"'},"​")],-1),p=e("h2",{id:"once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this",tabindex:"-1"},[o("Once you have opened the project, you should see something on the left side like this "),e("a",{class:"header-anchor",href:"#once-you-have-opened-the-project-you-should-see-something-on-the-left-side-like-this","aria-label":'Permalink to "Once you have opened the project, you should see something on the left side like this"'},"​")],-1),f=e("h2",{id:"open-the-ini-user-config-ini-file",tabindex:"-1"},[o("Open the "),e("code",null,"ini/user_config.ini"),o(" file "),e("a",{class:"header-anchor",href:"#open-the-ini-user-config-ini-file","aria-label":'Permalink to "Open the `ini/user_config.ini` file"'},"​")],-1),m=r("",3),w=e("p",null," 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. ",-1),_=r("",16),E=JSON.parse('{"title":"Configuring the firmware","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/configure_firmware.md","filePath":"firmware_guide/configure_firmware.md","lastUpdated":1698315393000}'),y={name:"firmware_guide/configure_firmware.md"},k=Object.assign(y,{setup(g){return(P,b)=>(h(),c("div",null,[u,p,t(n,{options:a(i).configure_firmware_one},null,8,["options"]),f,t(n,{options:a(i).configure_firmware_two},null,8,["options"]),m,t(s,{options:a(d).parts_list_one},{content:l(()=>[w]),_:1},8,["options"]),_]))}});export{E as __pageData,k as default}; diff --git a/assets/firmware_guide_environments.md.5499e526.js b/assets/firmware_guide_environments.md.d5d0818e.js similarity index 98% rename from assets/firmware_guide_environments.md.5499e526.js rename to assets/firmware_guide_environments.md.d5d0818e.js index ced24274..5aa8173a 100644 --- a/assets/firmware_guide_environments.md.5499e526.js +++ b/assets/firmware_guide_environments.md.d5d0818e.js @@ -1 +1 @@ -import{_ as e,i as o}from"./chunks/index.0e6ad99c.js";import{o as i,c as t,H as s,l as n,Q as a}from"./chunks/framework.e4c952c1.js";const r=a('

Firmware Environments ​

What is it? ​

A firmware environment is a way to store the custom firmware config for a specific device. This is useful if you want to have multiple devices with different firmware configs.

We use environments to store the firmware config for each device, so that you can easily switch between them.

Environments are broken up into two distinct parts:

Build Types ​

We now have a couple of options letting us decide how we want to build the firmware.

Examples:
xiaosenses3 - This is the debug environment.
xiaosenses3_release - This is the release environment for daily use.

Tip

We recommend starting with a debug environment, and then switching to release once everything is working. A debug environnement should not be used permanently.

Board Types ​

We currently support for several different boards, and we are working on adding more.

Warning

It is important to note that the esp32AIThinker environment is the default environment. Only switch your environment if you have another board or an environment is not working.

Most esp32Cams from Aliexpress will work with the esp32AIThinker environment, but some may require the esp32cam environment. Test the default environment first, and if it does not work, try the esp32cam environment.

Currently supported boards:

You can change the board enviroment by changing the default_envs argument in platformio.ini to a supported board like shown:

',17),u=JSON.parse('{"title":"Firmware Environments","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/environments.md","filePath":"firmware_guide/environments.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/environments.md"},f=Object.assign(d,{setup(l){return(c,m)=>(i(),t("div",null,[r,s(e,{options:n(o).esp_board_env},null,8,["options"])]))}});export{u as __pageData,f as default}; +import{_ as e,i as o}from"./chunks/index.10f74b3d.js";import{o as i,c as t,H as s,l as n,Q as a}from"./chunks/framework.e4c952c1.js";const r=a('

Firmware Environments ​

What is it? ​

A firmware environment is a way to store the custom firmware config for a specific device. This is useful if you want to have multiple devices with different firmware configs.

We use environments to store the firmware config for each device, so that you can easily switch between them.

Environments are broken up into two distinct parts:

Build Types ​

We now have a couple of options letting us decide how we want to build the firmware.

Examples:
xiaosenses3 - This is the debug environment.
xiaosenses3_release - This is the release environment for daily use.

Tip

We recommend starting with a debug environment, and then switching to release once everything is working. A debug environnement should not be used permanently.

Board Types ​

We currently support for several different boards, and we are working on adding more.

Warning

It is important to note that the esp32AIThinker environment is the default environment. Only switch your environment if you have another board or an environment is not working.

Most esp32Cams from Aliexpress will work with the esp32AIThinker environment, but some may require the esp32cam environment. Test the default environment first, and if it does not work, try the esp32cam environment.

Currently supported boards:

You can change the board enviroment by changing the default_envs argument in platformio.ini to a supported board like shown:

',17),u=JSON.parse('{"title":"Firmware Environments","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/environments.md","filePath":"firmware_guide/environments.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/environments.md"},f=Object.assign(d,{setup(l){return(c,m)=>(i(),t("div",null,[r,s(e,{options:n(o).esp_board_env},null,8,["options"])]))}});export{u as __pageData,f as default}; diff --git a/assets/firmware_guide_environments.md.5499e526.lean.js b/assets/firmware_guide_environments.md.d5d0818e.lean.js similarity index 88% rename from assets/firmware_guide_environments.md.5499e526.lean.js rename to assets/firmware_guide_environments.md.d5d0818e.lean.js index 3806db67..ae67d2f7 100644 --- a/assets/firmware_guide_environments.md.5499e526.lean.js +++ b/assets/firmware_guide_environments.md.d5d0818e.lean.js @@ -1 +1 @@ -import{_ as e,i as o}from"./chunks/index.0e6ad99c.js";import{o as i,c as t,H as s,l as n,Q as a}from"./chunks/framework.e4c952c1.js";const r=a("",17),u=JSON.parse('{"title":"Firmware Environments","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/environments.md","filePath":"firmware_guide/environments.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/environments.md"},f=Object.assign(d,{setup(l){return(c,m)=>(i(),t("div",null,[r,s(e,{options:n(o).esp_board_env},null,8,["options"])]))}});export{u as __pageData,f as default}; +import{_ as e,i as o}from"./chunks/index.10f74b3d.js";import{o as i,c as t,H as s,l as n,Q as a}from"./chunks/framework.e4c952c1.js";const r=a("",17),u=JSON.parse('{"title":"Firmware Environments","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/environments.md","filePath":"firmware_guide/environments.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/environments.md"},f=Object.assign(d,{setup(l){return(c,m)=>(i(),t("div",null,[r,s(e,{options:n(o).esp_board_env},null,8,["options"])]))}});export{u as __pageData,f as default}; diff --git a/assets/firmware_guide_flashing_tool.md.52fe420e.js b/assets/firmware_guide_flashing_tool.md.6ad5e454.js similarity index 97% rename from assets/firmware_guide_flashing_tool.md.52fe420e.js rename to assets/firmware_guide_flashing_tool.md.6ad5e454.js index 3a03ee05..11b8e4a9 100644 --- a/assets/firmware_guide_flashing_tool.md.52fe420e.js +++ b/assets/firmware_guide_flashing_tool.md.6ad5e454.js @@ -1 +1 @@ -import{_ as a,i as o}from"./chunks/index.0e6ad99c.js";import{o as n,c as s,H as i,l as r,Q as l,k as e,a as t}from"./chunks/framework.e4c952c1.js";const h=l('

Firmware Flashing Tool ​

What is this? ​

The Firmware Flashing Tool allows you to flash the firmware to your ESPs without requiring VScode. It is a GUI tool that is built using Tauri and SolidJS.

Features include:

Note

This tool is currently in beta, and 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.

',6),f=e("h2",{id:"environments",tabindex:"-1"},[e("code",null,"Environments"),t(),e("a",{class:"header-anchor",href:"#environments","aria-label":'Permalink to "`Environments`"'},"​")],-1),c=e("p",null,"The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.",-1),u=e("p",null,[t("Please reference the "),e("a",{href:"./../firmware_guide/environments"},"Firmware Environments Page"),t(" for more information.")],-1),b=JSON.parse('{"title":"Firmware Flashing Tool","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/flashing_tool.md","filePath":"firmware_guide/flashing_tool.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/flashing_tool.md"},v=Object.assign(d,{setup(m){return(_,p)=>(n(),s("div",null,[h,i(a,{options:r(o).flashing_tool},null,8,["options"]),i(a,{options:r(o).flashing_tool_1},null,8,["options"]),f,c,u]))}});export{b as __pageData,v as default}; +import{_ as a,i as o}from"./chunks/index.10f74b3d.js";import{o as n,c as s,H as i,l as r,Q as l,k as e,a as t}from"./chunks/framework.e4c952c1.js";const h=l('

Firmware Flashing Tool ​

What is this? ​

The Firmware Flashing Tool allows you to flash the firmware to your ESPs without requiring VScode. It is a GUI tool that is built using Tauri and SolidJS.

Features include:

Note

This tool is currently in beta, and 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.

',6),f=e("h2",{id:"environments",tabindex:"-1"},[e("code",null,"Environments"),t(),e("a",{class:"header-anchor",href:"#environments","aria-label":'Permalink to "`Environments`"'},"​")],-1),c=e("p",null,"The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.",-1),u=e("p",null,[t("Please reference the "),e("a",{href:"./../firmware_guide/environments"},"Firmware Environments Page"),t(" for more information.")],-1),b=JSON.parse('{"title":"Firmware Flashing Tool","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/flashing_tool.md","filePath":"firmware_guide/flashing_tool.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/flashing_tool.md"},v=Object.assign(d,{setup(m){return(_,p)=>(n(),s("div",null,[h,i(a,{options:r(o).flashing_tool},null,8,["options"]),i(a,{options:r(o).flashing_tool_1},null,8,["options"]),f,c,u]))}});export{b as __pageData,v as default}; diff --git a/assets/firmware_guide_flashing_tool.md.52fe420e.lean.js b/assets/firmware_guide_flashing_tool.md.6ad5e454.lean.js similarity index 94% rename from assets/firmware_guide_flashing_tool.md.52fe420e.lean.js rename to assets/firmware_guide_flashing_tool.md.6ad5e454.lean.js index 61b967b0..2846644a 100644 --- a/assets/firmware_guide_flashing_tool.md.52fe420e.lean.js +++ b/assets/firmware_guide_flashing_tool.md.6ad5e454.lean.js @@ -1 +1 @@ -import{_ as a,i as o}from"./chunks/index.0e6ad99c.js";import{o as n,c as s,H as i,l as r,Q as l,k as e,a as t}from"./chunks/framework.e4c952c1.js";const h=l("",6),f=e("h2",{id:"environments",tabindex:"-1"},[e("code",null,"Environments"),t(),e("a",{class:"header-anchor",href:"#environments","aria-label":'Permalink to "`Environments`"'},"​")],-1),c=e("p",null,"The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.",-1),u=e("p",null,[t("Please reference the "),e("a",{href:"./../firmware_guide/environments"},"Firmware Environments Page"),t(" for more information.")],-1),b=JSON.parse('{"title":"Firmware Flashing Tool","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/flashing_tool.md","filePath":"firmware_guide/flashing_tool.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/flashing_tool.md"},v=Object.assign(d,{setup(m){return(_,p)=>(n(),s("div",null,[h,i(a,{options:r(o).flashing_tool},null,8,["options"]),i(a,{options:r(o).flashing_tool_1},null,8,["options"]),f,c,u]))}});export{b as __pageData,v as default}; +import{_ as a,i as o}from"./chunks/index.10f74b3d.js";import{o as n,c as s,H as i,l as r,Q as l,k as e,a as t}from"./chunks/framework.e4c952c1.js";const h=l("",6),f=e("h2",{id:"environments",tabindex:"-1"},[e("code",null,"Environments"),t(),e("a",{class:"header-anchor",href:"#environments","aria-label":'Permalink to "`Environments`"'},"​")],-1),c=e("p",null,"The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.",-1),u=e("p",null,[t("Please reference the "),e("a",{href:"./../firmware_guide/environments"},"Firmware Environments Page"),t(" for more information.")],-1),b=JSON.parse('{"title":"Firmware Flashing Tool","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/flashing_tool.md","filePath":"firmware_guide/flashing_tool.md","lastUpdated":1698315393000}'),d={name:"firmware_guide/flashing_tool.md"},v=Object.assign(d,{setup(m){return(_,p)=>(n(),s("div",null,[h,i(a,{options:r(o).flashing_tool},null,8,["options"]),i(a,{options:r(o).flashing_tool_1},null,8,["options"]),f,c,u]))}});export{b as __pageData,v as default}; diff --git a/assets/firmware_guide_setup_vscode.md.bc9620d8.js b/assets/firmware_guide_setup_vscode.md.6234c70e.js similarity index 98% rename from assets/firmware_guide_setup_vscode.md.bc9620d8.js rename to assets/firmware_guide_setup_vscode.md.6234c70e.js index b7589350..78d66e11 100644 --- a/assets/firmware_guide_setup_vscode.md.bc9620d8.js +++ b/assets/firmware_guide_setup_vscode.md.6234c70e.js @@ -1 +1 @@ -import{_ as o,i as a}from"./chunks/index.0e6ad99c.js";import{o as i,c as s,H as l,l as n,Q as r,k as e,a as t}from"./chunks/framework.e4c952c1.js";const d=r('

Setting up the environment ​

This procedure will show how to prepare your system for uploading the firmware to your tracker.

1. Install Visual Studio Code ​

Download the latest Visual Studio Code and install it.

Download ​


',6),h=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"​")],-1),c=e("br",null,null,-1),_=r('

2. Install the drivers ​

In order to flash the firmware, you'll need some drivers, mainly the CH340 drivers, here's where to get them from:

https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all

3. Install PlatformIO IDE ​

Once Visual Studio Code is installed, open it and install PlatformIO IDE for VSCode, an extension that will allow you to connect to the tracker, build and upload the firmware.

',5),p=r('

4. Clone the firmware project ​

Make sure you close any current projects you have open or open a new window before moving forward with these steps.

  1. Go to https://github.com/EyeTrackVR/OpenIris and clone the latest version from the main branch.

    1. If you do not have git installed please install it from here.

    2. Open Git Bash.

',3),u=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),m=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/EyeTrackVR/OpenIris.git")])],-1),f=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),g=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),w=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),P=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1689532703000}'),b={name:"firmware_guide/setup_vscode.md"},V=Object.assign(b,{setup(I){return(k,S)=>(i(),s("div",null,[d,l(o,{options:n(a).setup_vscode_image_one},null,8,["options"]),h,c,l(o,{options:n(a).setup_vscode_image_two},null,8,["options"]),_,l(o,{options:n(a).setup_vscode_image_three},null,8,["options"]),p,l(o,{options:n(a).setup_vscode_image_four},null,8,["options"]),u,l(o,{options:n(a).setup_vscode_image_five},null,8,["options"]),m,l(o,{options:n(a).setup_vscode_image_six},null,8,["options"]),f,g,w,l(o,{options:n(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{P as __pageData,V as default}; +import{_ as o,i as a}from"./chunks/index.10f74b3d.js";import{o as i,c as s,H as l,l as n,Q as r,k as e,a as t}from"./chunks/framework.e4c952c1.js";const d=r('

Setting up the environment ​

This procedure will show how to prepare your system for uploading the firmware to your tracker.

1. Install Visual Studio Code ​

Download the latest Visual Studio Code and install it.

Download ​


',6),h=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"​")],-1),c=e("br",null,null,-1),_=r('

2. Install the drivers ​

In order to flash the firmware, you'll need some drivers, mainly the CH340 drivers, here's where to get them from:

https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all

3. Install PlatformIO IDE ​

Once Visual Studio Code is installed, open it and install PlatformIO IDE for VSCode, an extension that will allow you to connect to the tracker, build and upload the firmware.

',5),p=r('

4. Clone the firmware project ​

Make sure you close any current projects you have open or open a new window before moving forward with these steps.

  1. Go to https://github.com/EyeTrackVR/OpenIris and clone the latest version from the main branch.

    1. If you do not have git installed please install it from here.

    2. Open Git Bash.

',3),u=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),m=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/EyeTrackVR/OpenIris.git")])],-1),f=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),g=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),w=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),P=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1689532703000}'),b={name:"firmware_guide/setup_vscode.md"},V=Object.assign(b,{setup(I){return(k,S)=>(i(),s("div",null,[d,l(o,{options:n(a).setup_vscode_image_one},null,8,["options"]),h,c,l(o,{options:n(a).setup_vscode_image_two},null,8,["options"]),_,l(o,{options:n(a).setup_vscode_image_three},null,8,["options"]),p,l(o,{options:n(a).setup_vscode_image_four},null,8,["options"]),u,l(o,{options:n(a).setup_vscode_image_five},null,8,["options"]),m,l(o,{options:n(a).setup_vscode_image_six},null,8,["options"]),f,g,w,l(o,{options:n(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{P as __pageData,V as default}; diff --git a/assets/firmware_guide_setup_vscode.md.bc9620d8.lean.js b/assets/firmware_guide_setup_vscode.md.6234c70e.lean.js similarity index 97% rename from assets/firmware_guide_setup_vscode.md.bc9620d8.lean.js rename to assets/firmware_guide_setup_vscode.md.6234c70e.lean.js index 4bddfbfb..0fb414e2 100644 --- a/assets/firmware_guide_setup_vscode.md.bc9620d8.lean.js +++ b/assets/firmware_guide_setup_vscode.md.6234c70e.lean.js @@ -1 +1 @@ -import{_ as o,i as a}from"./chunks/index.0e6ad99c.js";import{o as i,c as s,H as l,l as n,Q as r,k as e,a as t}from"./chunks/framework.e4c952c1.js";const d=r("",6),h=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"​")],-1),c=e("br",null,null,-1),_=r("",5),p=r("",3),u=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),m=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/EyeTrackVR/OpenIris.git")])],-1),f=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),g=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),w=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),P=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1689532703000}'),b={name:"firmware_guide/setup_vscode.md"},V=Object.assign(b,{setup(I){return(k,S)=>(i(),s("div",null,[d,l(o,{options:n(a).setup_vscode_image_one},null,8,["options"]),h,c,l(o,{options:n(a).setup_vscode_image_two},null,8,["options"]),_,l(o,{options:n(a).setup_vscode_image_three},null,8,["options"]),p,l(o,{options:n(a).setup_vscode_image_four},null,8,["options"]),u,l(o,{options:n(a).setup_vscode_image_five},null,8,["options"]),m,l(o,{options:n(a).setup_vscode_image_six},null,8,["options"]),f,g,w,l(o,{options:n(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{P as __pageData,V as default}; +import{_ as o,i as a}from"./chunks/index.10f74b3d.js";import{o as i,c as s,H as l,l as n,Q as r,k as e,a as t}from"./chunks/framework.e4c952c1.js";const d=r("",6),h=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"​")],-1),c=e("br",null,null,-1),_=r("",5),p=r("",3),u=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),m=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/EyeTrackVR/OpenIris.git")])],-1),f=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),g=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),w=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),P=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1689532703000}'),b={name:"firmware_guide/setup_vscode.md"},V=Object.assign(b,{setup(I){return(k,S)=>(i(),s("div",null,[d,l(o,{options:n(a).setup_vscode_image_one},null,8,["options"]),h,c,l(o,{options:n(a).setup_vscode_image_two},null,8,["options"]),_,l(o,{options:n(a).setup_vscode_image_three},null,8,["options"]),p,l(o,{options:n(a).setup_vscode_image_four},null,8,["options"]),u,l(o,{options:n(a).setup_vscode_image_five},null,8,["options"]),m,l(o,{options:n(a).setup_vscode_image_six},null,8,["options"]),f,g,w,l(o,{options:n(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{P as __pageData,V as default}; diff --git a/assets/firmware_guide_update_platformio.md.af6d4d76.js b/assets/firmware_guide_update_platformio.md.f1f0be3e.js similarity index 98% rename from assets/firmware_guide_update_platformio.md.af6d4d76.js rename to assets/firmware_guide_update_platformio.md.f1f0be3e.js index 5a520119..23d27da7 100644 --- a/assets/firmware_guide_update_platformio.md.af6d4d76.js +++ b/assets/firmware_guide_update_platformio.md.f1f0be3e.js @@ -1 +1 @@ -import{_ as a,i as e}from"./chunks/index.0e6ad99c.js";import{o as s,c as r,H as i,l,Q as n,k as o,a as t}from"./chunks/framework.e4c952c1.js";const d=n('

Updating Platformio ​

Sometimes, when building and uploading the firmware, you may run into bizarre, even-though the code is correct - platformio will refuse to build and instead will complain with some weird error.

It usually means that either PlatformIO, or ArduinoSDK got and update and that's the moment when this guide may come in handy.

Updating PlatformIO itself ​

There are two ways to update your platformio installation

Via CLI ​

You can update it easily by simply typing in one command into your terminal.

',7),c=n('
  1. Open a terminal / command prompt
  2. Type pio upgrade and press enter
  3. Wait for it to finish
  4. Done

Via PlatformIO in Visual Studio Code ​

You can also update it using the platformio tab in your Visual Studio Code.

  1. Open VSC
  2. Click on that little and icon on the sidebar
',4),p=o("ol",{start:"3"},[o("li",null,[t("A side panel will open, there will be a couple of sections, one of them called "),o("code",null,"Quick Access"),t(", open it.")])],-1),u=o("ol",{start:"4"},[o("li",null,[t("In "),o("code",null,"Quick Access"),t(" section, click on the "),o("code",null,"Miscelleneous"),t(" tab")])],-1),_=o("ol",{start:"5"},[o("li",null,[t("Then, click on the "),o("code",null,"Upgrade PlatformIO Core")])],-1),h=n('
  1. Wait for it to finnish and done!

Upgrading the SDK ​

You'll also need to upgrade the SDK from timem to do this

Upgrading the SDK via VSC ​

  1. Follow the guide above up until clicking on the Quick Access section.
  2. Instead, open the PIO Home and select Open
',5),m=o("ol",{start:"3"},[o("li",null,[t("This will open a window for PlatformIO dashboard, in there, click on a "),o("code",null,"Platforms"),t(" button on the sidebar")])],-1),f=o("ol",{start:"4"},[o("li",null,[t("Once there, you should see a couple of tabs next to the side bard, things like "),o("code",null,"Installed"),t(" or "),o("code",null,"Embedded"),t(". Click on "),o("code",null,"Updates")])],-1),g=o("ol",{start:"5"},[o("li",null,[t("Locate a platform called "),o("code",null,"Espressif 32"),t(" and click on "),o("code",null,"Update to ")])],-1),b=o("ol",{start:"6"},[o("li",null,"Wait until it is done and that's it!")],-1),v=JSON.parse('{"title":"Updating Platformio","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/update_platformio.md","filePath":"firmware_guide/update_platformio.md","lastUpdated":1678402493000}'),k={name:"firmware_guide/update_platformio.md"},w=Object.assign(k,{setup(P){return(S,T)=>(s(),r("div",null,[d,i(a,{options:l(e).pio_upgrade_command},null,8,["options"]),c,i(a,{options:l(e).ant_logo_platformio},null,8,["options"]),p,i(a,{options:l(e).platformio_quick_access},null,8,["options"]),u,i(a,{options:l(e).platformio_quick_access_miscellaneous},null,8,["options"]),_,i(a,{options:l(e).platformio_quick_access_upgrade_core},null,8,["options"]),h,i(a,{options:l(e).platformio_pio_home},null,8,["options"]),m,i(a,{options:l(e).platformio_pio_sidebar_platforms},null,8,["options"]),f,i(a,{options:l(e).platformio_pio_sidebar_platforms_updates},null,8,["options"]),g,i(a,{options:l(e).platformio_pio_espressif32},null,8,["options"]),b]))}});export{v as __pageData,w as default}; +import{_ as a,i as e}from"./chunks/index.10f74b3d.js";import{o as s,c as r,H as i,l,Q as n,k as o,a as t}from"./chunks/framework.e4c952c1.js";const d=n('

Updating Platformio ​

Sometimes, when building and uploading the firmware, you may run into bizarre, even-though the code is correct - platformio will refuse to build and instead will complain with some weird error.

It usually means that either PlatformIO, or ArduinoSDK got and update and that's the moment when this guide may come in handy.

Updating PlatformIO itself ​

There are two ways to update your platformio installation

Via CLI ​

You can update it easily by simply typing in one command into your terminal.

',7),c=n('
  1. Open a terminal / command prompt
  2. Type pio upgrade and press enter
  3. Wait for it to finish
  4. Done

Via PlatformIO in Visual Studio Code ​

You can also update it using the platformio tab in your Visual Studio Code.

  1. Open VSC
  2. Click on that little and icon on the sidebar
',4),p=o("ol",{start:"3"},[o("li",null,[t("A side panel will open, there will be a couple of sections, one of them called "),o("code",null,"Quick Access"),t(", open it.")])],-1),u=o("ol",{start:"4"},[o("li",null,[t("In "),o("code",null,"Quick Access"),t(" section, click on the "),o("code",null,"Miscelleneous"),t(" tab")])],-1),_=o("ol",{start:"5"},[o("li",null,[t("Then, click on the "),o("code",null,"Upgrade PlatformIO Core")])],-1),h=n('
  1. Wait for it to finnish and done!

Upgrading the SDK ​

You'll also need to upgrade the SDK from timem to do this

Upgrading the SDK via VSC ​

  1. Follow the guide above up until clicking on the Quick Access section.
  2. Instead, open the PIO Home and select Open
',5),m=o("ol",{start:"3"},[o("li",null,[t("This will open a window for PlatformIO dashboard, in there, click on a "),o("code",null,"Platforms"),t(" button on the sidebar")])],-1),f=o("ol",{start:"4"},[o("li",null,[t("Once there, you should see a couple of tabs next to the side bard, things like "),o("code",null,"Installed"),t(" or "),o("code",null,"Embedded"),t(". Click on "),o("code",null,"Updates")])],-1),g=o("ol",{start:"5"},[o("li",null,[t("Locate a platform called "),o("code",null,"Espressif 32"),t(" and click on "),o("code",null,"Update to ")])],-1),b=o("ol",{start:"6"},[o("li",null,"Wait until it is done and that's it!")],-1),v=JSON.parse('{"title":"Updating Platformio","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/update_platformio.md","filePath":"firmware_guide/update_platformio.md","lastUpdated":1678402493000}'),k={name:"firmware_guide/update_platformio.md"},w=Object.assign(k,{setup(P){return(S,T)=>(s(),r("div",null,[d,i(a,{options:l(e).pio_upgrade_command},null,8,["options"]),c,i(a,{options:l(e).ant_logo_platformio},null,8,["options"]),p,i(a,{options:l(e).platformio_quick_access},null,8,["options"]),u,i(a,{options:l(e).platformio_quick_access_miscellaneous},null,8,["options"]),_,i(a,{options:l(e).platformio_quick_access_upgrade_core},null,8,["options"]),h,i(a,{options:l(e).platformio_pio_home},null,8,["options"]),m,i(a,{options:l(e).platformio_pio_sidebar_platforms},null,8,["options"]),f,i(a,{options:l(e).platformio_pio_sidebar_platforms_updates},null,8,["options"]),g,i(a,{options:l(e).platformio_pio_espressif32},null,8,["options"]),b]))}});export{v as __pageData,w as default}; diff --git a/assets/firmware_guide_update_platformio.md.af6d4d76.lean.js b/assets/firmware_guide_update_platformio.md.f1f0be3e.lean.js similarity index 97% rename from assets/firmware_guide_update_platformio.md.af6d4d76.lean.js rename to assets/firmware_guide_update_platformio.md.f1f0be3e.lean.js index 5355b4ce..a28ee9ed 100644 --- a/assets/firmware_guide_update_platformio.md.af6d4d76.lean.js +++ b/assets/firmware_guide_update_platformio.md.f1f0be3e.lean.js @@ -1 +1 @@ -import{_ as a,i as e}from"./chunks/index.0e6ad99c.js";import{o as s,c as r,H as i,l,Q as n,k as o,a as t}from"./chunks/framework.e4c952c1.js";const d=n("",7),c=n("",4),p=o("ol",{start:"3"},[o("li",null,[t("A side panel will open, there will be a couple of sections, one of them called "),o("code",null,"Quick Access"),t(", open it.")])],-1),u=o("ol",{start:"4"},[o("li",null,[t("In "),o("code",null,"Quick Access"),t(" section, click on the "),o("code",null,"Miscelleneous"),t(" tab")])],-1),_=o("ol",{start:"5"},[o("li",null,[t("Then, click on the "),o("code",null,"Upgrade PlatformIO Core")])],-1),h=n("",5),m=o("ol",{start:"3"},[o("li",null,[t("This will open a window for PlatformIO dashboard, in there, click on a "),o("code",null,"Platforms"),t(" button on the sidebar")])],-1),f=o("ol",{start:"4"},[o("li",null,[t("Once there, you should see a couple of tabs next to the side bard, things like "),o("code",null,"Installed"),t(" or "),o("code",null,"Embedded"),t(". Click on "),o("code",null,"Updates")])],-1),g=o("ol",{start:"5"},[o("li",null,[t("Locate a platform called "),o("code",null,"Espressif 32"),t(" and click on "),o("code",null,"Update to ")])],-1),b=o("ol",{start:"6"},[o("li",null,"Wait until it is done and that's it!")],-1),v=JSON.parse('{"title":"Updating Platformio","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/update_platformio.md","filePath":"firmware_guide/update_platformio.md","lastUpdated":1678402493000}'),k={name:"firmware_guide/update_platformio.md"},w=Object.assign(k,{setup(P){return(S,T)=>(s(),r("div",null,[d,i(a,{options:l(e).pio_upgrade_command},null,8,["options"]),c,i(a,{options:l(e).ant_logo_platformio},null,8,["options"]),p,i(a,{options:l(e).platformio_quick_access},null,8,["options"]),u,i(a,{options:l(e).platformio_quick_access_miscellaneous},null,8,["options"]),_,i(a,{options:l(e).platformio_quick_access_upgrade_core},null,8,["options"]),h,i(a,{options:l(e).platformio_pio_home},null,8,["options"]),m,i(a,{options:l(e).platformio_pio_sidebar_platforms},null,8,["options"]),f,i(a,{options:l(e).platformio_pio_sidebar_platforms_updates},null,8,["options"]),g,i(a,{options:l(e).platformio_pio_espressif32},null,8,["options"]),b]))}});export{v as __pageData,w as default}; +import{_ as a,i as e}from"./chunks/index.10f74b3d.js";import{o as s,c as r,H as i,l,Q as n,k as o,a as t}from"./chunks/framework.e4c952c1.js";const d=n("",7),c=n("",4),p=o("ol",{start:"3"},[o("li",null,[t("A side panel will open, there will be a couple of sections, one of them called "),o("code",null,"Quick Access"),t(", open it.")])],-1),u=o("ol",{start:"4"},[o("li",null,[t("In "),o("code",null,"Quick Access"),t(" section, click on the "),o("code",null,"Miscelleneous"),t(" tab")])],-1),_=o("ol",{start:"5"},[o("li",null,[t("Then, click on the "),o("code",null,"Upgrade PlatformIO Core")])],-1),h=n("",5),m=o("ol",{start:"3"},[o("li",null,[t("This will open a window for PlatformIO dashboard, in there, click on a "),o("code",null,"Platforms"),t(" button on the sidebar")])],-1),f=o("ol",{start:"4"},[o("li",null,[t("Once there, you should see a couple of tabs next to the side bard, things like "),o("code",null,"Installed"),t(" or "),o("code",null,"Embedded"),t(". Click on "),o("code",null,"Updates")])],-1),g=o("ol",{start:"5"},[o("li",null,[t("Locate a platform called "),o("code",null,"Espressif 32"),t(" and click on "),o("code",null,"Update to ")])],-1),b=o("ol",{start:"6"},[o("li",null,"Wait until it is done and that's it!")],-1),v=JSON.parse('{"title":"Updating Platformio","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/update_platformio.md","filePath":"firmware_guide/update_platformio.md","lastUpdated":1678402493000}'),k={name:"firmware_guide/update_platformio.md"},w=Object.assign(k,{setup(P){return(S,T)=>(s(),r("div",null,[d,i(a,{options:l(e).pio_upgrade_command},null,8,["options"]),c,i(a,{options:l(e).ant_logo_platformio},null,8,["options"]),p,i(a,{options:l(e).platformio_quick_access},null,8,["options"]),u,i(a,{options:l(e).platformio_quick_access_miscellaneous},null,8,["options"]),_,i(a,{options:l(e).platformio_quick_access_upgrade_core},null,8,["options"]),h,i(a,{options:l(e).platformio_pio_home},null,8,["options"]),m,i(a,{options:l(e).platformio_pio_sidebar_platforms},null,8,["options"]),f,i(a,{options:l(e).platformio_pio_sidebar_platforms_updates},null,8,["options"]),g,i(a,{options:l(e).platformio_pio_espressif32},null,8,["options"]),b]))}});export{v as __pageData,w as default}; diff --git a/assets/firmware_guide_upload_and_update_firmware.md.1076bd51.js b/assets/firmware_guide_upload_and_update_firmware.md.faf8113d.js similarity index 99% rename from assets/firmware_guide_upload_and_update_firmware.md.1076bd51.js rename to assets/firmware_guide_upload_and_update_firmware.md.faf8113d.js index 08295328..e6f7be65 100644 --- a/assets/firmware_guide_upload_and_update_firmware.md.1076bd51.js +++ b/assets/firmware_guide_upload_and_update_firmware.md.faf8113d.js @@ -1,4 +1,4 @@ -import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as r}from"./chunks/index.0e6ad99c.js";import{o as u,c as d,H as o,w as p,l as t,Q as i,k as e,a as n}from"./chunks/framework.e4c952c1.js";const h=i('

Building and uploading the firmware manually ​

Uploading your firmware must initially be done over cable. Once you have the tracker connected to your WiFi after your first firmware update, you can opt to use OTA in the future.

1. Connect your tracker to your PC ​

Option 1: Connect ESP32-CAM via the programmer ​

First, connect your ESP32-Cam to your programmer. In the case of the ESP32-Cam-MB board, it's as simple as sticking it into the socket the way it came in the package and then connecting it to your PC with a micro-USB cable.

In some cases, there is a button labeled IOO on the programmer. If that button exists make sure to hold it in while you plug the programmer into your PC, once plugged in you can release the button.

In the case of an FTDI programmer, the steps aren't as easy, so grab this guide for how to set it up.

Option 2: Connect ESP32-S3 via USB-C directly ​

To begin, connect your ESP32-S3 board directly to your PC.

On the initial attempt, you may have to adjust the USB mode by pressing the BOOT button and holding it down, then pressing the RESET button while still holding down BOOT, and finally releasing the BOOT button. This will produce a sound indicating the connection of a new device.

Once completed, you should be all set to proceed.

2. Build your firmware ​

  1. Press the build button at the bottom of Visual Studio Code.

This builds the firmware, but does not send it to the ESP yet.

img

3. Upload your firmware ​

  • If you are using the OTA method, skip to the OTA section below.

  • Once the firmware has been built, press the upload button to upload the firmware.

    This sends the firmware to the ESP. img

',17),c=e("p",null," The MB board does the resetting for you. If you're using the FTDI programmer, follow the guide linked above (the one from randomnerdtutorials) ",-1),m=i('

  • If the upload is successful, you should get an output that looks like this:

    img

Congratulations! You have now successfully uploaded the firmware to your EyeTrackVR Tracker!

If you have trouble with uploading your firmware over cable check the following:

  1. Make sure your USB cable from the tracker is plugged firmly into your PC.
  2. Make sure that your USB cable is a data and charging cable (it is suggested you try other cables or devices with the cable).
  3. Make sure that your drivers are up-to-date.
  4. Some ports might not work, try other ones.

Additionally, this can be caused by software hogging COM ports (VSCode and Cura can be the cause of this).

Uploading via OTA ​

What is it? ​

OTA stands for Over The Air, and it is a way to update your firmware without having to connect your device to your computer.

How do I use it? ​

To use OTA, you need to have working firmware on your ESPs first. Follow the manual building guide

Once you have manually flashed the firmware at least once, you can use the OTA environment to upate your ESPs.

Coming Soon

Currently, we only support OTA using the provided web interface, but we are working on a new app, where you will be able to upload your firmware to your ESPs over WiFi straight from the app.

For firmware versions 1.1.0 and up: ​

Since version 1.1.0 we've switched from using OTA via platformio to a more user-friendly approach.

',14),f=e("p",null," You don't have to have the trackers connected to your pc for any of these steps, just powered on and connected to the Wi-Fi. ",-1),_=e("ol",null,[e("li",null,[n("Build the firmware using your current environment, if you've switched to an OTA env in the past - repeat those steps but select the environment without the "),e("code",null,"_OTA"),n(" suffix. Next, press the checkmark button to build it without uploading.")])],-1),g=i('

  1. Turn on your trackers and wait for them to connect to Wi-Fi

  2. Locate their ip or mDNS name. For mDNS, the default is: http://openiristracker.local/

  3. Having done that, open http://<your-up-or-mdns-name>:81/update in your browser

for example: http://openiristracker.local/

This should open a page similar to this:

',3),y=e("p",null,[n("Click on the select file button, and navigate to where you cloned the project and then to the "),e("code",null,"ESP/"),n(" directory.")],-1),w=e("p",null,[n("Once there, open "),e("code",null,".pio\\build\\your-environment"),n(" like so:")],-1),b=e("blockquote",null,[e("p",null,[n("By default, windows treats files and directories with a dot in front of their name as hidden. To change that - "),e("a",{href:"https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5",target:"_blank",rel:"noreferrer"},"see here")])],-1),v=e("p",null,[n("You'll find a couple files in there, select the one named "),e("code",null,"your-environment-vVersion-feature"),n(".")],-1),k=e("p",null,"like this one:",-1),T=e("ol",{start:"5"},[e("li",null,"Press upload and wait for it to finish. Done!")],-1),S=i(`

For firmware versions of 1.0.0 and under: ​

  1. Retrieve the IP or mDNS name of the tracker you wish to flash. The IP can be found through network monitoring applications, or by viewing tracker output in a serial monitor.
  2. In the ini/user_config.ini file:
    • Put IP or hostname of device into config file

Like so:

ini
[ota]
+import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as r}from"./chunks/index.10f74b3d.js";import{o as u,c as d,H as o,w as p,l as t,Q as i,k as e,a as n}from"./chunks/framework.e4c952c1.js";const h=i('
Building and uploading the firmware manually ​
Uploading your firmware must initially be done over cable. Once you have the tracker connected to your WiFi after your first firmware update, you can opt to use OTA in the future.
1. Connect your tracker to your PC ​
Option 1: Connect ESP32-CAM via the programmer ​
First, connect your ESP32-Cam to your programmer. In the case of the ESP32-Cam-MB board, it's as simple as sticking it into the socket the way it came in the package and then connecting it to your PC with a micro-USB cable.
In some cases, there is a button labeled IOO on the programmer. If that button exists make sure to hold it in while you plug the programmer into your PC, once plugged in you can release the button.
In the case of an FTDI programmer, the steps aren't as easy, so grab this guide for how to set it up.
Option 2: Connect ESP32-S3 via USB-C directly ​
To begin, connect your ESP32-S3 board directly to your PC.
On the initial attempt, you may have to adjust the USB mode by pressing the BOOT button and holding it down, then pressing the RESET button while still holding down BOOT, and finally releasing the BOOT button. This will produce a sound indicating the connection of a new device.
Once completed, you should be all set to proceed.
2. Build your firmware ​
  1. Press the build button at the bottom of Visual Studio Code.
This builds the firmware, but does not send it to the ESP yet.
img
3. Upload your firmware ​
  • If you are using the OTA method, skip to the OTA section below.
  • Once the firmware has been built, press the upload button to upload the firmware.
    This sends the firmware to the ESP. img
',17),c=e("p",null," The MB board does the resetting for you. If you're using the FTDI programmer, follow the guide linked above (the one from randomnerdtutorials) ",-1),m=i('
  • If the upload is successful, you should get an output that looks like this:
    img
Congratulations! You have now successfully uploaded the firmware to your EyeTrackVR Tracker!
If you have trouble with uploading your firmware over cable check the following:
  1. Make sure your USB cable from the tracker is plugged firmly into your PC.
  2. Make sure that your USB cable is a data and charging cable (it is suggested you try other cables or devices with the cable).
  3. Make sure that your drivers are up-to-date.
  4. Some ports might not work, try other ones.
Additionally, this can be caused by software hogging COM ports (VSCode and Cura can be the cause of this).
Uploading via OTA ​
What is it? ​
OTA stands for Over The Air, and it is a way to update your firmware without having to connect your device to your computer.
How do I use it? ​
To use OTA, you need to have working firmware on your ESPs first. Follow the manual building guide
Once you have manually flashed the firmware at least once, you can use the OTA environment to upate your ESPs.
Coming Soon
Currently, we only support OTA using the provided web interface, but we are working on a new app, where you will be able to upload your firmware to your ESPs over WiFi straight from the app.
For firmware versions 1.1.0 and up: ​
Since version 1.1.0 we've switched from using OTA via platformio to a more user-friendly approach.
',14),f=e("p",null," You don't have to have the trackers connected to your pc for any of these steps, just powered on and connected to the Wi-Fi. ",-1),_=e("ol",null,[e("li",null,[n("Build the firmware using your current environment, if you've switched to an OTA env in the past - repeat those steps but select the environment without the "),e("code",null,"_OTA"),n(" suffix. Next, press the checkmark button to build it without uploading.")])],-1),g=i('
  1. Turn on your trackers and wait for them to connect to Wi-Fi
  2. Locate their ip or mDNS name. For mDNS, the default is: http://openiristracker.local/
  3. Having done that, open http://<your-up-or-mdns-name>:81/update in your browser
for example: http://openiristracker.local/
This should open a page similar to this:
',3),y=e("p",null,[n("Click on the select file button, and navigate to where you cloned the project and then to the "),e("code",null,"ESP/"),n(" directory.")],-1),w=e("p",null,[n("Once there, open "),e("code",null,".pio\\build\\your-environment"),n(" like so:")],-1),b=e("blockquote",null,[e("p",null,[n("By default, windows treats files and directories with a dot in front of their name as hidden. To change that - "),e("a",{href:"https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5",target:"_blank",rel:"noreferrer"},"see here")])],-1),v=e("p",null,[n("You'll find a couple files in there, select the one named "),e("code",null,"your-environment-vVersion-feature"),n(".")],-1),k=e("p",null,"like this one:",-1),T=e("ol",{start:"5"},[e("li",null,"Press upload and wait for it to finish. Done!")],-1),S=i(`
For firmware versions of 1.0.0 and under: ​
  1. Retrieve the IP or mDNS name of the tracker you wish to flash. The IP can be found through network monitoring applications, or by viewing tracker output in a serial monitor.
  2. In the ini/user_config.ini file: 
    • Put IP or hostname of device into config file
Like so:
ini
[ota]
 enableota = 1
 otaserverip = "openiristrackerL.local" # here we use a custom mDNS name
 otapassword = "12345678"
diff --git a/assets/firmware_guide_upload_and_update_firmware.md.1076bd51.lean.js b/assets/firmware_guide_upload_and_update_firmware.md.faf8113d.lean.js
similarity index 98%
rename from assets/firmware_guide_upload_and_update_firmware.md.1076bd51.lean.js
rename to assets/firmware_guide_upload_and_update_firmware.md.faf8113d.lean.js
index d09b0d98..63461aea 100644
--- a/assets/firmware_guide_upload_and_update_firmware.md.1076bd51.lean.js
+++ b/assets/firmware_guide_upload_and_update_firmware.md.faf8113d.lean.js
@@ -1 +1 @@
-import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as r}from"./chunks/index.0e6ad99c.js";import{o as u,c as d,H as o,w as p,l as t,Q as i,k as e,a as n}from"./chunks/framework.e4c952c1.js";const h=i("",17),c=e("p",null," The MB board does the resetting for you. If you're using the FTDI programmer, follow the guide linked above (the one from randomnerdtutorials) ",-1),m=i("",14),f=e("p",null," You don't have to have the trackers connected to your pc for any of these steps, just powered on and connected to the Wi-Fi. ",-1),_=e("ol",null,[e("li",null,[n("Build the firmware using your current environment, if you've switched to an OTA env in the past - repeat those steps but select the environment without the "),e("code",null,"_OTA"),n(" suffix. Next, press the checkmark button to build it without uploading.")])],-1),g=i("",3),y=e("p",null,[n("Click on the select file button, and navigate to where you cloned the project and then to the "),e("code",null,"ESP/"),n(" directory.")],-1),w=e("p",null,[n("Once there, open "),e("code",null,".pio\\build\\your-environment"),n(" like so:")],-1),b=e("blockquote",null,[e("p",null,[n("By default, windows treats files and directories with a dot in front of their name as hidden. To change that - "),e("a",{href:"https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5",target:"_blank",rel:"noreferrer"},"see here")])],-1),v=e("p",null,[n("You'll find a couple files in there, select the one named "),e("code",null,"your-environment-vVersion-feature"),n(".")],-1),k=e("p",null,"like this one:",-1),T=e("ol",{start:"5"},[e("li",null,"Press upload and wait for it to finish. Done!")],-1),S=i("",8),P=e("p",null,"This will open a list of all available environments, select the one that matches your board and has a _OTA suffix",-1),A=i("",3),C=e("p",null,"Now, press the restart button on the esp itself. watch the monitor for output like this:",-1),D=i("",5),I=e("p",null," Skip this step if the update message denotes that the config had changed. If it does so, retype your credentials in the updated files. ",-1),F=i("",6),U=JSON.parse('{"title":"Building and uploading the firmware manually","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/upload_and_update_firmware.md","filePath":"firmware_guide/upload_and_update_firmware.md","lastUpdated":1682366995000}'),B={name:"firmware_guide/upload_and_update_firmware.md"},R=Object.assign(B,{setup(O){return(E,q)=>(u(),d("div",null,[h,o(s,{options:t(l).upload_firmware_one},{content:p(()=>[c]),_:1},8,["options"]),m,o(s,{options:t(l).upload_firmware_one},{content:p(()=>[f]),_:1},8,["options"]),_,o(a,{options:t(r).upload_firmware_build_button},null,8,["options"]),g,o(a,{options:t(r).upload_firmware_webpage},null,8,["options"]),y,w,b,o(a,{options:t(r).upload_firmware_webpage_directory},null,8,["options"]),v,k,o(a,{options:t(r).upload_firmware_webpage_directory_file},null,8,["options"]),T,o(a,{options:t(r).upload_firmware_webpage_upload_finished},null,8,["options"]),S,o(a,{options:t(r).upload_firmware_select_env},null,8,["options"]),P,o(a,{options:t(r).upload_firmware_select_env_dropdown},null,8,["options"]),A,o(a,{options:t(r).upload_firmware_image_one},null,8,["options"]),C,o(a,{options:t(r).upload_firmware_image_two},null,8,["options"]),D,o(s,{options:t(l).user_warning},{content:p(()=>[I]),_:1},8,["options"]),F]))}});export{U as __pageData,R as default};
+import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as r}from"./chunks/index.10f74b3d.js";import{o as u,c as d,H as o,w as p,l as t,Q as i,k as e,a as n}from"./chunks/framework.e4c952c1.js";const h=i("",17),c=e("p",null," The MB board does the resetting for you. If you're using the FTDI programmer, follow the guide linked above (the one from randomnerdtutorials) ",-1),m=i("",14),f=e("p",null," You don't have to have the trackers connected to your pc for any of these steps, just powered on and connected to the Wi-Fi. ",-1),_=e("ol",null,[e("li",null,[n("Build the firmware using your current environment, if you've switched to an OTA env in the past - repeat those steps but select the environment without the "),e("code",null,"_OTA"),n(" suffix. Next, press the checkmark button to build it without uploading.")])],-1),g=i("",3),y=e("p",null,[n("Click on the select file button, and navigate to where you cloned the project and then to the "),e("code",null,"ESP/"),n(" directory.")],-1),w=e("p",null,[n("Once there, open "),e("code",null,".pio\\build\\your-environment"),n(" like so:")],-1),b=e("blockquote",null,[e("p",null,[n("By default, windows treats files and directories with a dot in front of their name as hidden. To change that - "),e("a",{href:"https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5",target:"_blank",rel:"noreferrer"},"see here")])],-1),v=e("p",null,[n("You'll find a couple files in there, select the one named "),e("code",null,"your-environment-vVersion-feature"),n(".")],-1),k=e("p",null,"like this one:",-1),T=e("ol",{start:"5"},[e("li",null,"Press upload and wait for it to finish. Done!")],-1),S=i("",8),P=e("p",null,"This will open a list of all available environments, select the one that matches your board and has a _OTA suffix",-1),A=i("",3),C=e("p",null,"Now, press the restart button on the esp itself. watch the monitor for output like this:",-1),D=i("",5),I=e("p",null," Skip this step if the update message denotes that the config had changed. If it does so, retype your credentials in the updated files. ",-1),F=i("",6),U=JSON.parse('{"title":"Building and uploading the firmware manually","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/upload_and_update_firmware.md","filePath":"firmware_guide/upload_and_update_firmware.md","lastUpdated":1682366995000}'),B={name:"firmware_guide/upload_and_update_firmware.md"},R=Object.assign(B,{setup(O){return(E,q)=>(u(),d("div",null,[h,o(s,{options:t(l).upload_firmware_one},{content:p(()=>[c]),_:1},8,["options"]),m,o(s,{options:t(l).upload_firmware_one},{content:p(()=>[f]),_:1},8,["options"]),_,o(a,{options:t(r).upload_firmware_build_button},null,8,["options"]),g,o(a,{options:t(r).upload_firmware_webpage},null,8,["options"]),y,w,b,o(a,{options:t(r).upload_firmware_webpage_directory},null,8,["options"]),v,k,o(a,{options:t(r).upload_firmware_webpage_directory_file},null,8,["options"]),T,o(a,{options:t(r).upload_firmware_webpage_upload_finished},null,8,["options"]),S,o(a,{options:t(r).upload_firmware_select_env},null,8,["options"]),P,o(a,{options:t(r).upload_firmware_select_env_dropdown},null,8,["options"]),A,o(a,{options:t(r).upload_firmware_image_one},null,8,["options"]),C,o(a,{options:t(r).upload_firmware_image_two},null,8,["options"]),D,o(s,{options:t(l).user_warning},{content:p(()=>[I]),_:1},8,["options"]),F]))}});export{U as __pageData,R as default};
diff --git a/assets/getting_started_intro.md.193e8e8d.js b/assets/getting_started_intro.md.4c4c39e8.js
similarity index 99%
rename from assets/getting_started_intro.md.193e8e8d.js
rename to assets/getting_started_intro.md.4c4c39e8.js
index 411861af..e0f9f67e 100644
--- a/assets/getting_started_intro.md.193e8e8d.js
+++ b/assets/getting_started_intro.md.4c4c39e8.js
@@ -1 +1 @@
-import{_ as s,a as i}from"./chunks/index.8ad7dc66.js";import{_ as l,i as d}from"./chunks/index.0e6ad99c.js";import{o as c,c as h,H as a,w as n,l as r,Q as t,k as e,a as o}from"./chunks/framework.e4c952c1.js";const u=t('
EyeTrackVR ​
Open source and affordable VR eye tracker platform for Social VR Games via OSC and UDP protocol.
Want to get started? Check out the getting started page and then the full build guide.
',4),_=e("p",null," This project is in active development. However, it is working for most users. ",-1),p=t('
About IR Emitter Safety ​
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.
DANGER
It is important that you DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE. This can result in irreversible bodily harm.
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.
',5),f=e("p",null,[o(" Make sure you are using "),e("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),o(" emitters and no more than "),e("ins",{class:"font-bold"},"5 mW/sr"),o(" total power. ")],-1),m=t('
Want to see the safety data sheets?
Effect of infrared radiation on the lens
AN002_Details on photobiological safety of LED light sources
Training-library Nir Stds
ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)
Hardware ​
Please check out our parts list and hardware repo. for information regauring hardware.
Firmware ​
Our firmware called OpenIris is made by lorow found here.
Headset support ​
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 3d printable mounts 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.
Contact ​
Please join our discord for updates and any questions. We hope to see you there!
',9),b=t('
Licenses ​
GitHub license
All software is under the MIT License. All documentation, including the Wiki, is under the Creative Commons CC-BY-SA-4.0 license.
',3),R=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1698315393000}'),y={name:"getting_started/intro.md"},I=Object.assign(y,{setup(g){return(k,w)=>(c(),h("div",null,[u,a(s,{options:r(i).user_warning},{content:n(()=>[_]),_:1},8,["options"]),p,a(s,{options:r(i).led_power_warning},{content:n(()=>[f]),_:1},8,["options"]),m,a(l,{options:r(d).discord_content},null,8,["options"]),b]))}});export{R as __pageData,I as default};
+import{_ as s,a as i}from"./chunks/index.8ad7dc66.js";import{_ as l,i as d}from"./chunks/index.10f74b3d.js";import{o as c,c as h,H as a,w as n,l as r,Q as t,k as e,a as o}from"./chunks/framework.e4c952c1.js";const u=t('
EyeTrackVR ​
Open source and affordable VR eye tracker platform for Social VR Games via OSC and UDP protocol.
Want to get started? Check out the getting started page and then the full build guide.
',4),_=e("p",null," This project is in active development. However, it is working for most users. ",-1),p=t('
About IR Emitter Safety ​
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.
DANGER
It is important that you DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE. This can result in irreversible bodily harm.
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.
',5),f=e("p",null,[o(" Make sure you are using "),e("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),o(" emitters and no more than "),e("ins",{class:"font-bold"},"5 mW/sr"),o(" total power. ")],-1),m=t('
Want to see the safety data sheets?
Effect of infrared radiation on the lens
AN002_Details on photobiological safety of LED light sources
Training-library Nir Stds
ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)
Hardware ​
Please check out our parts list and hardware repo. for information regauring hardware.
Firmware ​
Our firmware called OpenIris is made by lorow found here.
Headset support ​
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 3d printable mounts 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.
Contact ​
Please join our discord for updates and any questions. We hope to see you there!
',9),b=t('
Licenses ​
GitHub license
All software is under the MIT License. All documentation, including the Wiki, is under the Creative Commons CC-BY-SA-4.0 license.
',3),R=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1698315393000}'),y={name:"getting_started/intro.md"},I=Object.assign(y,{setup(g){return(k,w)=>(c(),h("div",null,[u,a(s,{options:r(i).user_warning},{content:n(()=>[_]),_:1},8,["options"]),p,a(s,{options:r(i).led_power_warning},{content:n(()=>[f]),_:1},8,["options"]),m,a(l,{options:r(d).discord_content},null,8,["options"]),b]))}});export{R as __pageData,I as default};
diff --git a/assets/getting_started_intro.md.193e8e8d.lean.js b/assets/getting_started_intro.md.4c4c39e8.lean.js
similarity index 94%
rename from assets/getting_started_intro.md.193e8e8d.lean.js
rename to assets/getting_started_intro.md.4c4c39e8.lean.js
index 5738f96f..42e6ecea 100644
--- a/assets/getting_started_intro.md.193e8e8d.lean.js
+++ b/assets/getting_started_intro.md.4c4c39e8.lean.js
@@ -1 +1 @@
-import{_ as s,a as i}from"./chunks/index.8ad7dc66.js";import{_ as l,i as d}from"./chunks/index.0e6ad99c.js";import{o as c,c as h,H as a,w as n,l as r,Q as t,k as e,a as o}from"./chunks/framework.e4c952c1.js";const u=t("",4),_=e("p",null," This project is in active development. However, it is working for most users. ",-1),p=t("",5),f=e("p",null,[o(" Make sure you are using "),e("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),o(" emitters and no more than "),e("ins",{class:"font-bold"},"5 mW/sr"),o(" total power. ")],-1),m=t("",9),b=t("",3),R=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1698315393000}'),y={name:"getting_started/intro.md"},I=Object.assign(y,{setup(g){return(k,w)=>(c(),h("div",null,[u,a(s,{options:r(i).user_warning},{content:n(()=>[_]),_:1},8,["options"]),p,a(s,{options:r(i).led_power_warning},{content:n(()=>[f]),_:1},8,["options"]),m,a(l,{options:r(d).discord_content},null,8,["options"]),b]))}});export{R as __pageData,I as default};
+import{_ as s,a as i}from"./chunks/index.8ad7dc66.js";import{_ as l,i as d}from"./chunks/index.10f74b3d.js";import{o as c,c as h,H as a,w as n,l as r,Q as t,k as e,a as o}from"./chunks/framework.e4c952c1.js";const u=t("",4),_=e("p",null," This project is in active development. However, it is working for most users. ",-1),p=t("",5),f=e("p",null,[o(" Make sure you are using "),e("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),o(" emitters and no more than "),e("ins",{class:"font-bold"},"5 mW/sr"),o(" total power. ")],-1),m=t("",9),b=t("",3),R=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1698315393000}'),y={name:"getting_started/intro.md"},I=Object.assign(y,{setup(g){return(k,w)=>(c(),h("div",null,[u,a(s,{options:r(i).user_warning},{content:n(()=>[_]),_:1},8,["options"]),p,a(s,{options:r(i).led_power_warning},{content:n(()=>[f]),_:1},8,["options"]),m,a(l,{options:r(d).discord_content},null,8,["options"]),b]))}});export{R as __pageData,I as default};
diff --git a/assets/how_to_build_full_build.md.b9c84c14.js b/assets/how_to_build_full_build.md.af5219a2.js
similarity index 99%
rename from assets/how_to_build_full_build.md.b9c84c14.js
rename to assets/how_to_build_full_build.md.af5219a2.js
index a4e78976..cd5e2356 100644
--- a/assets/how_to_build_full_build.md.b9c84c14.js
+++ b/assets/how_to_build_full_build.md.af5219a2.js
@@ -1 +1 @@
-import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as h}from"./chunks/CheckBoxList.9fb033ec.js";import{_ as a,i as s}from"./chunks/index.0e6ad99c.js";import{o as d,c as p,H as t,l as o,k as e,w as c,Q as i,a as n}from"./chunks/framework.e4c952c1.js";const u={state:!0,object:[{label:"2 ESP 32 CAM boards"},{label:"2 160 degree cameras"},{label:"1 USB board to power your ESPs"},{label:"1 Programmer board(buying an extra is reccomended)"},{label:"IR emitters, resistors, and preferably PCBs"},{label:"Lower gauge wire to power ESPs"},{label:"Higher gauge wire to power IR LEDs"},{label:"3d printer to print mounts. (Buying them from some place like JLCPCB is also an option)"},{label:"Glue of some form, hot glue highly recommended."}]},_=i('
Build Guide ​
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 LED Solderless assemblly rough edit:
',3),m=e("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:""},null,-1),f=e("p",null,"Sketch of V4 solderless wiring:",-1),w=e("p",null,[n("Credit: @seniorpringles, @g0ldjay via "),e("a",{href:"https://discord.gg/kkXYbVykZX",target:"_blank",rel:"noreferrer"},"Discord")],-1),g=e("p",null,"Sketch of solder assembbly of V4:",-1),b=i('
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 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 ​
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.
Step 3: Wait for things to arrive ​
Long shipping times from China are f u n. Please allow anywhere from 2 weeks to 2 months for everything to arrive.
Step 4: Gather up all of your hardware ​
Make sure you have at least the following:
',9),y=e("h2",{id:"step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag",tabindex:"-1"},[n("Step 5: Install external antennas or shield ESP antenna with an antistatic bag "),e("a",{class:"header-anchor",href:"#step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag","aria-label":'Permalink to "Step 5: Install external antennas or shield ESP antenna with an antistatic bag"'},"​")],-1),v=e("p",null,"Some ESP-CAM boards have issues with signal integrity, there are 2 things you can do to help/solve the issues.",-1),S=e("p",null,"The first option is to use an external antenna.",-1),k=e("p",null,[n("This is the best solution when it comes to the final result. If you have Vive/Tundra trackers, this is a "),e("strong",null,"REQUIRED"),n(" 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.")],-1),P=e("p",null,"Below is an example of bridging the connections and attaching an antenna.",-1),T=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/aBTZuvg5sM8",title:"How to add an external antenna to an ESP32-CAM (2 methods)",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:""})],-1),E=e("p",null,"The second option is to cover the ESP's antenna with an antistatic bag. This can help aid problems, and can completely solve them in some cases. Best of all, it is completely free! However, it should be noted that it performs worse than an external antenna and in certain cases will not solve the issue like if you have Vive trackers.",-1),x=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/wS4PS3Mw250",title:"Covering an ESP32-CAM's antenna with anti-static bag",frameborder:"0",allow:"accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:""})],-1),C=e("h2",{id:"step-6-attach-cameras-to-esps",tabindex:"-1"},[n("Step 6: Attach cameras to ESPs "),e("a",{class:"header-anchor",href:"#step-6-attach-cameras-to-esps","aria-label":'Permalink to "Step 6: Attach cameras to ESPs"'},"​")],-1),I=e("p",null,"Look at your ESP and locate the camera ribbon cable connector as circled below.",-1),V=e("p",null,"Flip the gray part up to allow the cameras to be connected. Do not force it, or shove objects into it to open, fingernails are fine.",-1),D=e("p",null,"Now slide in a camera, please note that the pins are facing down, you should only see the black part.",-1),A=e("p",null,"Once the camera has been slid in, press the gray part of the connector back down. There will be a small amount of force but still be gentle. Note the ammount of black coming out of the connector.",-1),B=e("h2",{id:"step-7-connect-esp-to-the-programmer-to-flash",tabindex:"-1"},[n("Step 7: Connect ESP to the programmer to flash "),e("a",{class:"header-anchor",href:"#step-7-connect-esp-to-the-programmer-to-flash","aria-label":'Permalink to "Step 7: Connect ESP to the programmer to flash"'},"​")],-1),q=e("p",null,"Why flash before you have it assembled? It's simple, to make sure they actually work before you spend time soldering to them.",-1),N=e("p",null,"Slide your ESP into the programmer, and note the USB port goes away from the ESP's camera.",-1),L=i('
Step 8: Configure Visual Studio Code and prepare to flash the firmware ​
Check out our guide on Setting up VS Code
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 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.
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. Here I used speaker wire where the copper denotes positive and silver negative. Then, strip the wires to about 3mm of exposed wire.
',8),R=e("h2",{id:"step-11-cut-wires-for-ir-leds",tabindex:"-1"},[n("Step 11: Cut wires for IR LEDs "),e("a",{class:"header-anchor",href:"#step-11-cut-wires-for-ir-leds","aria-label":'Permalink to "Step 11: Cut wires for IR LEDs"'},"​")],-1),G=e("p",null,"To find the optimal length, take a piece of wire and a marker and mock up your wire route, and mark the wire, cut it, then make another at the same size for the other eye. You will need 3 different cuts of wire. 2 short ones for connecting the 2 PCBs per eye together, 2 Longer ones for power, or ground and 2 slightly longer ones for power or ground for the LED near the camera at the bottom.",-1),U=e("p",null,"Once cut, strip them to around 4mm of exposed wire.",-1),O=e("h2",{id:"step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them",tabindex:"-1"},[n("Step 12: Twist the positive USB wire and positive IR LED wires together and tin them "),e("a",{class:"header-anchor",href:"#step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them","aria-label":'Permalink to "Step 12: Twist the positive USB wire and positive IR LED wires together and tin them"'},"​")],-1),H=e("p",null,"Once twisted together add solder to keep them together. This makes the connection much easier.",-1),W=e("h2",{id:"step-13-solder-the-positive-wire-to-esp",tabindex:"-1"},[n("Step 13: Solder the positive wire to ESP "),e("a",{class:"header-anchor",href:"#step-13-solder-the-positive-wire-to-esp","aria-label":'Permalink to "Step 13: Solder the positive wire to ESP"'},"​")],-1),M=e("p",null,"Lay the wire on the outside of the 5V pin and apply solder.",-1),j=i('
Step 14: Solder the negative wire to ESP ​
Repeat Step 12 but with the negative wires.
INFO
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.
',4),F=i('
Step 15: Wire up the 2nd ESP ​
Repeat steps 12-14 with the 2nd ESP.
Step 16: Prepare to solder IR LED PCBs ​
Get your magnifying glass out, it's time to solder very smol things.
Gather 4 PCBs, 4 IR LEDs, and either 4 ~350ohm.
',5),Y=e("p",null,"Here are the PCB pin-out labels:",-1),z=e("p",null,"LED labels:",-1),$=i('
If you have different LEDs, please consult their datasheet.
Some terminology related to them:
5V: 5-volt power in.
GND: Ground or power out.
AR: After-Resistor this is to be used as the power in on the 2nd PCB in series as resistors are not needed on the 2nd PCB since they are on the 1st one.
SNG: Single resistor, use this as 5V in if you are using only 1 ~700ohm resistor on V3 boards (not recommended).
Negative: This marks the negative side of the LED.
Positive: This marks the positive side of the LED.
Step 18: Solder resistors on PCB V3 ​
You only need 1 PCB to have resistors per eye.
Tin the resistor pads. Note: in this example, I use too much solder, it should only be enough to lightly cover the pad.
',11),J=e("p",null,"Next, grab a resistor and hold it on the pads.",-1),Q=e("p",null,"While holding the resistor add solder to your soldering iron and apply it to the resistor.",-1),X=e("p",null,"I like to do this by having a piece of my solder stick up in the air and then put it on my iron that way.",-1),Z=e("p",null,"Flip the PCB and solder the other end.",-1),K=e("p",null,"Now repeat for the other one.",-1),ee=e("h2",{id:"solder-leds-on-pcb-v3",tabindex:"-1"},[n("Solder LEDs on PCB V3 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v3","aria-label":'Permalink to "Solder LEDs on PCB V3"'},"​")],-1),te=e("p",null,"Tin the LED pads.",-1),oe=e("p",null,"Orientate the LED and hold it in place.",-1),ae=e("p",null,"Solder one end.",-1),se=e("p",null,"Flip around and solder the other end.",-1),ne=e("h2",{id:"wire-up-the-pcbs-v3",tabindex:"-1"},[n("Wire up the PCBs V3 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v3","aria-label":'Permalink to "Wire up the PCBs V3"'},"​")],-1),ie=e("div",{class:"warning custom-block"},[e("p",{class:"custom-block-title"},"WARNING"),e("p",null,"Pay attention to the direction of the LEDs on the PCBs.")],-1),re=e("p",null,"If the green dot is facing inwards toward the text like in the picture below:",-1),le=e("p",null,"Use the following diagram:",-1),he=e("p",null,"If the green dot is facing away from the text like the picture below:",-1),de=e("p",null,"Use the following diagram:",-1),pe=i('
Step 19: 3D print mounts ​
Head to the 3D printed parts section of the parts list here.
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. If none work, try making an edit yourself if you have the skills. If you have made a mount make sure to ping me, Prohurtz#0001, so I can add them to the list.
Having trouble getting them to fit? Try resizing the mounts up, or down a little to ensure a good fit.
There are 2 different types of mounts, how to secure the camera to each type will be documented below.
Type 1 ​
',6),ce=e("p",null,"This uses a method of sliding in the camera. Generally, this is the recommended mounting method as it generally requires no glue.",-1),ue=e("p",null,"Place the camera into the mount",-1),_e=e("p",null,"Slowly apply pressure inwards until the camera snaps into place.",-1),me={align:"center"},fe=e("p",null," There is a good chance of breaking the mount when putting in the camera. If this happens you may be able to save the mount depending on where the break was. A small dab of hot glue around the camera is likely all that is needed. ",-1),we=e("h3",{id:"type-2",tabindex:"-1"},[n("Type 2 "),e("a",{class:"header-anchor",href:"#type-2","aria-label":'Permalink to "Type 2"'},"​")],-1),ge=e("p",null,"This uses the method of gluing the camera.",-1),be=e("p",null,"Apply a bit of glue to the bottom of the camera mount.",-1),ye=e("p",null,"Place the camera on the mount.",-1),ve=e("h2",{id:"ir-led-mounting",tabindex:"-1"},[n("IR LED mounting "),e("a",{class:"header-anchor",href:"#ir-led-mounting","aria-label":'Permalink to "IR LED mounting"'},"​")],-1),Se=e("p",null,"This again differs from mount to mount.",-1),ke=e("p",null,"In some cases, there are designated spots for the LEDs to go.",-1),Pe=e("p",null,"In others there are no specified spots, you will have to mess around to find what works best. This image shows the optimal/near-optimal position for the LEDs. Hot glue is your friend with this.",-1),Te=e("div",{class:"tip custom-block"},[e("p",{class:"custom-block-title"},"TIP"),e("p",null,"Use rubbing alcohol to easily remove hot glue.")],-1),qe=JSON.parse('{"title":"Build Guide","description":"","frontmatter":{},"headers":[],"relativePath":"how_to_build/full_build.md","filePath":"how_to_build/full_build.md","lastUpdated":1694358539000}'),Ee={name:"how_to_build/full_build.md"},Ne=Object.assign(Ee,{setup(xe){return(Ce,Ie)=>(d(),p("div",null,[_,m,f,t(a,{options:o(s).V4_wire_sketch},null,8,["options"]),w,g,t(a,{options:o(s).V4_solder_wire},null,8,["options"]),b,t(h,{options:{...o(u)}},null,8,["options"]),t(a,{options:o(s).image_one},null,8,["options"]),y,v,S,k,t(a,{options:o(s).external_antenna},null,8,["options"]),P,t(a,{options:o(s).external_antenna_resistors},null,8,["options"]),T,E,x,C,I,t(a,{options:o(s).camera_socket},null,8,["options"]),V,t(a,{options:o(s).camera_socket_clip},null,8,["options"]),D,t(a,{options:o(s).camera_cable},null,8,["options"]),A,t(a,{options:o(s).camera_clip_close},null,8,["options"]),B,q,N,t(a,{options:o(s)._7_12_one},null,8,["options"]),L,t(a,{options:o(s)._7_12_two},null,8,["options"]),R,G,U,O,H,t(a,{options:o(s)._7_12_three},null,8,["options"]),W,M,t(a,{options:o(s)._13_18_one},null,8,["options"]),j,t(a,{options:o(s)._13_18_two},null,8,["options"]),F,t(a,{options:o(s)._13_18_three},null,8,["options"]),Y,t(a,{options:o(s)._13_18_four},null,8,["options"]),z,t(a,{options:o(s)._13_18_five},null,8,["options"]),$,t(a,{options:o(s)._13_18_six},null,8,["options"]),J,t(a,{options:o(s)._13_18_seven},null,8,["options"]),Q,X,t(a,{options:o(s)._13_18_eight},null,8,["options"]),Z,t(a,{options:o(s)._13_18_nine},null,8,["options"]),K,t(a,{options:o(s)._13_18_ten},null,8,["options"]),ee,te,t(a,{options:o(s).end_one},null,8,["options"]),oe,t(a,{options:o(s).end_two},null,8,["options"]),ae,t(a,{options:o(s).end_three},null,8,["options"]),se,t(a,{options:o(s).end_four},null,8,["options"]),ne,ie,re,t(a,{options:o(s).end_five},null,8,["options"]),le,t(a,{options:o(s).end_six},null,8,["options"]),he,t(a,{options:o(s).end_seven},null,8,["options"]),de,t(a,{options:o(s).end_eight},null,8,["options"]),pe,t(a,{options:o(s).end_nine},null,8,["options"]),ce,ue,t(a,{options:o(s).end_ten},null,8,["options"]),_e,t(a,{options:o(s).end_eleven},null,8,["options"]),e("div",me,[t(r,{options:o(l).end_one},{content:c(()=>[fe]),_:1},8,["options"])]),we,t(a,{options:o(s).end_twelve},null,8,["options"]),ge,be,t(a,{options:o(s).end_thirteen},null,8,["options"]),ye,t(a,{options:o(s).end_fourteen},null,8,["options"]),ve,Se,ke,t(a,{options:o(s).end_fifteen},null,8,["options"]),Pe,t(a,{options:o(s).end_sixteen},null,8,["options"]),Te]))}});export{qe as __pageData,Ne as default};
+import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as h}from"./chunks/CheckBoxList.9fb033ec.js";import{_ as a,i as s}from"./chunks/index.10f74b3d.js";import{o as d,c as p,H as t,l as o,k as e,w as c,Q as i,a as n}from"./chunks/framework.e4c952c1.js";const u={state:!0,object:[{label:"2 ESP 32 CAM boards"},{label:"2 160 degree cameras"},{label:"1 USB board to power your ESPs"},{label:"1 Programmer board(buying an extra is reccomended)"},{label:"IR emitters, resistors, and preferably PCBs"},{label:"Lower gauge wire to power ESPs"},{label:"Higher gauge wire to power IR LEDs"},{label:"3d printer to print mounts. (Buying them from some place like JLCPCB is also an option)"},{label:"Glue of some form, hot glue highly recommended."}]},_=i('
Build Guide ​
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 LED Solderless assemblly rough edit:
',3),m=e("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:""},null,-1),f=e("p",null,"Sketch of V4 solderless wiring:",-1),w=e("p",null,[n("Credit: @seniorpringles, @g0ldjay via "),e("a",{href:"https://discord.gg/kkXYbVykZX",target:"_blank",rel:"noreferrer"},"Discord")],-1),g=e("p",null,"Sketch of solder assembbly of V4:",-1),b=i('
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 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 ​
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.
Step 3: Wait for things to arrive ​
Long shipping times from China are f u n. Please allow anywhere from 2 weeks to 2 months for everything to arrive.
Step 4: Gather up all of your hardware ​
Make sure you have at least the following:
',9),y=e("h2",{id:"step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag",tabindex:"-1"},[n("Step 5: Install external antennas or shield ESP antenna with an antistatic bag "),e("a",{class:"header-anchor",href:"#step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag","aria-label":'Permalink to "Step 5: Install external antennas or shield ESP antenna with an antistatic bag"'},"​")],-1),v=e("p",null,"Some ESP-CAM boards have issues with signal integrity, there are 2 things you can do to help/solve the issues.",-1),S=e("p",null,"The first option is to use an external antenna.",-1),k=e("p",null,[n("This is the best solution when it comes to the final result. If you have Vive/Tundra trackers, this is a "),e("strong",null,"REQUIRED"),n(" 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.")],-1),P=e("p",null,"Below is an example of bridging the connections and attaching an antenna.",-1),T=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/aBTZuvg5sM8",title:"How to add an external antenna to an ESP32-CAM (2 methods)",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:""})],-1),E=e("p",null,"The second option is to cover the ESP's antenna with an antistatic bag. This can help aid problems, and can completely solve them in some cases. Best of all, it is completely free! However, it should be noted that it performs worse than an external antenna and in certain cases will not solve the issue like if you have Vive trackers.",-1),x=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/wS4PS3Mw250",title:"Covering an ESP32-CAM's antenna with anti-static bag",frameborder:"0",allow:"accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:""})],-1),C=e("h2",{id:"step-6-attach-cameras-to-esps",tabindex:"-1"},[n("Step 6: Attach cameras to ESPs "),e("a",{class:"header-anchor",href:"#step-6-attach-cameras-to-esps","aria-label":'Permalink to "Step 6: Attach cameras to ESPs"'},"​")],-1),I=e("p",null,"Look at your ESP and locate the camera ribbon cable connector as circled below.",-1),V=e("p",null,"Flip the gray part up to allow the cameras to be connected. Do not force it, or shove objects into it to open, fingernails are fine.",-1),D=e("p",null,"Now slide in a camera, please note that the pins are facing down, you should only see the black part.",-1),A=e("p",null,"Once the camera has been slid in, press the gray part of the connector back down. There will be a small amount of force but still be gentle. Note the ammount of black coming out of the connector.",-1),B=e("h2",{id:"step-7-connect-esp-to-the-programmer-to-flash",tabindex:"-1"},[n("Step 7: Connect ESP to the programmer to flash "),e("a",{class:"header-anchor",href:"#step-7-connect-esp-to-the-programmer-to-flash","aria-label":'Permalink to "Step 7: Connect ESP to the programmer to flash"'},"​")],-1),q=e("p",null,"Why flash before you have it assembled? It's simple, to make sure they actually work before you spend time soldering to them.",-1),N=e("p",null,"Slide your ESP into the programmer, and note the USB port goes away from the ESP's camera.",-1),L=i('
Step 8: Configure Visual Studio Code and prepare to flash the firmware ​
Check out our guide on Setting up VS Code
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 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.
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. Here I used speaker wire where the copper denotes positive and silver negative. Then, strip the wires to about 3mm of exposed wire.
',8),R=e("h2",{id:"step-11-cut-wires-for-ir-leds",tabindex:"-1"},[n("Step 11: Cut wires for IR LEDs "),e("a",{class:"header-anchor",href:"#step-11-cut-wires-for-ir-leds","aria-label":'Permalink to "Step 11: Cut wires for IR LEDs"'},"​")],-1),G=e("p",null,"To find the optimal length, take a piece of wire and a marker and mock up your wire route, and mark the wire, cut it, then make another at the same size for the other eye. You will need 3 different cuts of wire. 2 short ones for connecting the 2 PCBs per eye together, 2 Longer ones for power, or ground and 2 slightly longer ones for power or ground for the LED near the camera at the bottom.",-1),U=e("p",null,"Once cut, strip them to around 4mm of exposed wire.",-1),O=e("h2",{id:"step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them",tabindex:"-1"},[n("Step 12: Twist the positive USB wire and positive IR LED wires together and tin them "),e("a",{class:"header-anchor",href:"#step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them","aria-label":'Permalink to "Step 12: Twist the positive USB wire and positive IR LED wires together and tin them"'},"​")],-1),H=e("p",null,"Once twisted together add solder to keep them together. This makes the connection much easier.",-1),W=e("h2",{id:"step-13-solder-the-positive-wire-to-esp",tabindex:"-1"},[n("Step 13: Solder the positive wire to ESP "),e("a",{class:"header-anchor",href:"#step-13-solder-the-positive-wire-to-esp","aria-label":'Permalink to "Step 13: Solder the positive wire to ESP"'},"​")],-1),M=e("p",null,"Lay the wire on the outside of the 5V pin and apply solder.",-1),j=i('
Step 14: Solder the negative wire to ESP ​
Repeat Step 12 but with the negative wires.
INFO
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.
',4),F=i('
Step 15: Wire up the 2nd ESP ​
Repeat steps 12-14 with the 2nd ESP.
Step 16: Prepare to solder IR LED PCBs ​
Get your magnifying glass out, it's time to solder very smol things.
Gather 4 PCBs, 4 IR LEDs, and either 4 ~350ohm.
',5),Y=e("p",null,"Here are the PCB pin-out labels:",-1),z=e("p",null,"LED labels:",-1),$=i('
If you have different LEDs, please consult their datasheet.
Some terminology related to them:
5V: 5-volt power in.
GND: Ground or power out.
AR: After-Resistor this is to be used as the power in on the 2nd PCB in series as resistors are not needed on the 2nd PCB since they are on the 1st one.
SNG: Single resistor, use this as 5V in if you are using only 1 ~700ohm resistor on V3 boards (not recommended).
Negative: This marks the negative side of the LED.
Positive: This marks the positive side of the LED.
Step 18: Solder resistors on PCB V3 ​
You only need 1 PCB to have resistors per eye.
Tin the resistor pads. Note: in this example, I use too much solder, it should only be enough to lightly cover the pad.
',11),J=e("p",null,"Next, grab a resistor and hold it on the pads.",-1),Q=e("p",null,"While holding the resistor add solder to your soldering iron and apply it to the resistor.",-1),X=e("p",null,"I like to do this by having a piece of my solder stick up in the air and then put it on my iron that way.",-1),Z=e("p",null,"Flip the PCB and solder the other end.",-1),K=e("p",null,"Now repeat for the other one.",-1),ee=e("h2",{id:"solder-leds-on-pcb-v3",tabindex:"-1"},[n("Solder LEDs on PCB V3 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v3","aria-label":'Permalink to "Solder LEDs on PCB V3"'},"​")],-1),te=e("p",null,"Tin the LED pads.",-1),oe=e("p",null,"Orientate the LED and hold it in place.",-1),ae=e("p",null,"Solder one end.",-1),se=e("p",null,"Flip around and solder the other end.",-1),ne=e("h2",{id:"wire-up-the-pcbs-v3",tabindex:"-1"},[n("Wire up the PCBs V3 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v3","aria-label":'Permalink to "Wire up the PCBs V3"'},"​")],-1),ie=e("div",{class:"warning custom-block"},[e("p",{class:"custom-block-title"},"WARNING"),e("p",null,"Pay attention to the direction of the LEDs on the PCBs.")],-1),re=e("p",null,"If the green dot is facing inwards toward the text like in the picture below:",-1),le=e("p",null,"Use the following diagram:",-1),he=e("p",null,"If the green dot is facing away from the text like the picture below:",-1),de=e("p",null,"Use the following diagram:",-1),pe=i('
Step 19: 3D print mounts ​
Head to the 3D printed parts section of the parts list here.
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. If none work, try making an edit yourself if you have the skills. If you have made a mount make sure to ping me, Prohurtz#0001, so I can add them to the list.
Having trouble getting them to fit? Try resizing the mounts up, or down a little to ensure a good fit.
There are 2 different types of mounts, how to secure the camera to each type will be documented below.
Type 1 ​
',6),ce=e("p",null,"This uses a method of sliding in the camera. Generally, this is the recommended mounting method as it generally requires no glue.",-1),ue=e("p",null,"Place the camera into the mount",-1),_e=e("p",null,"Slowly apply pressure inwards until the camera snaps into place.",-1),me={align:"center"},fe=e("p",null," There is a good chance of breaking the mount when putting in the camera. If this happens you may be able to save the mount depending on where the break was. A small dab of hot glue around the camera is likely all that is needed. ",-1),we=e("h3",{id:"type-2",tabindex:"-1"},[n("Type 2 "),e("a",{class:"header-anchor",href:"#type-2","aria-label":'Permalink to "Type 2"'},"​")],-1),ge=e("p",null,"This uses the method of gluing the camera.",-1),be=e("p",null,"Apply a bit of glue to the bottom of the camera mount.",-1),ye=e("p",null,"Place the camera on the mount.",-1),ve=e("h2",{id:"ir-led-mounting",tabindex:"-1"},[n("IR LED mounting "),e("a",{class:"header-anchor",href:"#ir-led-mounting","aria-label":'Permalink to "IR LED mounting"'},"​")],-1),Se=e("p",null,"This again differs from mount to mount.",-1),ke=e("p",null,"In some cases, there are designated spots for the LEDs to go.",-1),Pe=e("p",null,"In others there are no specified spots, you will have to mess around to find what works best. This image shows the optimal/near-optimal position for the LEDs. Hot glue is your friend with this.",-1),Te=e("div",{class:"tip custom-block"},[e("p",{class:"custom-block-title"},"TIP"),e("p",null,"Use rubbing alcohol to easily remove hot glue.")],-1),qe=JSON.parse('{"title":"Build Guide","description":"","frontmatter":{},"headers":[],"relativePath":"how_to_build/full_build.md","filePath":"how_to_build/full_build.md","lastUpdated":1694358539000}'),Ee={name:"how_to_build/full_build.md"},Ne=Object.assign(Ee,{setup(xe){return(Ce,Ie)=>(d(),p("div",null,[_,m,f,t(a,{options:o(s).V4_wire_sketch},null,8,["options"]),w,g,t(a,{options:o(s).V4_solder_wire},null,8,["options"]),b,t(h,{options:{...o(u)}},null,8,["options"]),t(a,{options:o(s).image_one},null,8,["options"]),y,v,S,k,t(a,{options:o(s).external_antenna},null,8,["options"]),P,t(a,{options:o(s).external_antenna_resistors},null,8,["options"]),T,E,x,C,I,t(a,{options:o(s).camera_socket},null,8,["options"]),V,t(a,{options:o(s).camera_socket_clip},null,8,["options"]),D,t(a,{options:o(s).camera_cable},null,8,["options"]),A,t(a,{options:o(s).camera_clip_close},null,8,["options"]),B,q,N,t(a,{options:o(s)._7_12_one},null,8,["options"]),L,t(a,{options:o(s)._7_12_two},null,8,["options"]),R,G,U,O,H,t(a,{options:o(s)._7_12_three},null,8,["options"]),W,M,t(a,{options:o(s)._13_18_one},null,8,["options"]),j,t(a,{options:o(s)._13_18_two},null,8,["options"]),F,t(a,{options:o(s)._13_18_three},null,8,["options"]),Y,t(a,{options:o(s)._13_18_four},null,8,["options"]),z,t(a,{options:o(s)._13_18_five},null,8,["options"]),$,t(a,{options:o(s)._13_18_six},null,8,["options"]),J,t(a,{options:o(s)._13_18_seven},null,8,["options"]),Q,X,t(a,{options:o(s)._13_18_eight},null,8,["options"]),Z,t(a,{options:o(s)._13_18_nine},null,8,["options"]),K,t(a,{options:o(s)._13_18_ten},null,8,["options"]),ee,te,t(a,{options:o(s).end_one},null,8,["options"]),oe,t(a,{options:o(s).end_two},null,8,["options"]),ae,t(a,{options:o(s).end_three},null,8,["options"]),se,t(a,{options:o(s).end_four},null,8,["options"]),ne,ie,re,t(a,{options:o(s).end_five},null,8,["options"]),le,t(a,{options:o(s).end_six},null,8,["options"]),he,t(a,{options:o(s).end_seven},null,8,["options"]),de,t(a,{options:o(s).end_eight},null,8,["options"]),pe,t(a,{options:o(s).end_nine},null,8,["options"]),ce,ue,t(a,{options:o(s).end_ten},null,8,["options"]),_e,t(a,{options:o(s).end_eleven},null,8,["options"]),e("div",me,[t(r,{options:o(l).end_one},{content:c(()=>[fe]),_:1},8,["options"])]),we,t(a,{options:o(s).end_twelve},null,8,["options"]),ge,be,t(a,{options:o(s).end_thirteen},null,8,["options"]),ye,t(a,{options:o(s).end_fourteen},null,8,["options"]),ve,Se,ke,t(a,{options:o(s).end_fifteen},null,8,["options"]),Pe,t(a,{options:o(s).end_sixteen},null,8,["options"]),Te]))}});export{qe as __pageData,Ne as default};
diff --git a/assets/how_to_build_full_build.md.b9c84c14.lean.js b/assets/how_to_build_full_build.md.af5219a2.lean.js
similarity index 99%
rename from assets/how_to_build_full_build.md.b9c84c14.lean.js
rename to assets/how_to_build_full_build.md.af5219a2.lean.js
index 1e67d99e..42e35909 100644
--- a/assets/how_to_build_full_build.md.b9c84c14.lean.js
+++ b/assets/how_to_build_full_build.md.af5219a2.lean.js
@@ -1 +1 @@
-import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as h}from"./chunks/CheckBoxList.9fb033ec.js";import{_ as a,i as s}from"./chunks/index.0e6ad99c.js";import{o as d,c as p,H as t,l as o,k as e,w as c,Q as i,a as n}from"./chunks/framework.e4c952c1.js";const u={state:!0,object:[{label:"2 ESP 32 CAM boards"},{label:"2 160 degree cameras"},{label:"1 USB board to power your ESPs"},{label:"1 Programmer board(buying an extra is reccomended)"},{label:"IR emitters, resistors, and preferably PCBs"},{label:"Lower gauge wire to power ESPs"},{label:"Higher gauge wire to power IR LEDs"},{label:"3d printer to print mounts. (Buying them from some place like JLCPCB is also an option)"},{label:"Glue of some form, hot glue highly recommended."}]},_=i("",3),m=e("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:""},null,-1),f=e("p",null,"Sketch of V4 solderless wiring:",-1),w=e("p",null,[n("Credit: @seniorpringles, @g0ldjay via "),e("a",{href:"https://discord.gg/kkXYbVykZX",target:"_blank",rel:"noreferrer"},"Discord")],-1),g=e("p",null,"Sketch of solder assembbly of V4:",-1),b=i("",9),y=e("h2",{id:"step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag",tabindex:"-1"},[n("Step 5: Install external antennas or shield ESP antenna with an antistatic bag "),e("a",{class:"header-anchor",href:"#step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag","aria-label":'Permalink to "Step 5: Install external antennas or shield ESP antenna with an antistatic bag"'},"​")],-1),v=e("p",null,"Some ESP-CAM boards have issues with signal integrity, there are 2 things you can do to help/solve the issues.",-1),S=e("p",null,"The first option is to use an external antenna.",-1),k=e("p",null,[n("This is the best solution when it comes to the final result. If you have Vive/Tundra trackers, this is a "),e("strong",null,"REQUIRED"),n(" 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.")],-1),P=e("p",null,"Below is an example of bridging the connections and attaching an antenna.",-1),T=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/aBTZuvg5sM8",title:"How to add an external antenna to an ESP32-CAM (2 methods)",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:""})],-1),E=e("p",null,"The second option is to cover the ESP's antenna with an antistatic bag. This can help aid problems, and can completely solve them in some cases. Best of all, it is completely free! However, it should be noted that it performs worse than an external antenna and in certain cases will not solve the issue like if you have Vive trackers.",-1),x=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/wS4PS3Mw250",title:"Covering an ESP32-CAM's antenna with anti-static bag",frameborder:"0",allow:"accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:""})],-1),C=e("h2",{id:"step-6-attach-cameras-to-esps",tabindex:"-1"},[n("Step 6: Attach cameras to ESPs "),e("a",{class:"header-anchor",href:"#step-6-attach-cameras-to-esps","aria-label":'Permalink to "Step 6: Attach cameras to ESPs"'},"​")],-1),I=e("p",null,"Look at your ESP and locate the camera ribbon cable connector as circled below.",-1),V=e("p",null,"Flip the gray part up to allow the cameras to be connected. Do not force it, or shove objects into it to open, fingernails are fine.",-1),D=e("p",null,"Now slide in a camera, please note that the pins are facing down, you should only see the black part.",-1),A=e("p",null,"Once the camera has been slid in, press the gray part of the connector back down. There will be a small amount of force but still be gentle. Note the ammount of black coming out of the connector.",-1),B=e("h2",{id:"step-7-connect-esp-to-the-programmer-to-flash",tabindex:"-1"},[n("Step 7: Connect ESP to the programmer to flash "),e("a",{class:"header-anchor",href:"#step-7-connect-esp-to-the-programmer-to-flash","aria-label":'Permalink to "Step 7: Connect ESP to the programmer to flash"'},"​")],-1),q=e("p",null,"Why flash before you have it assembled? It's simple, to make sure they actually work before you spend time soldering to them.",-1),N=e("p",null,"Slide your ESP into the programmer, and note the USB port goes away from the ESP's camera.",-1),L=i("",8),R=e("h2",{id:"step-11-cut-wires-for-ir-leds",tabindex:"-1"},[n("Step 11: Cut wires for IR LEDs "),e("a",{class:"header-anchor",href:"#step-11-cut-wires-for-ir-leds","aria-label":'Permalink to "Step 11: Cut wires for IR LEDs"'},"​")],-1),G=e("p",null,"To find the optimal length, take a piece of wire and a marker and mock up your wire route, and mark the wire, cut it, then make another at the same size for the other eye. You will need 3 different cuts of wire. 2 short ones for connecting the 2 PCBs per eye together, 2 Longer ones for power, or ground and 2 slightly longer ones for power or ground for the LED near the camera at the bottom.",-1),U=e("p",null,"Once cut, strip them to around 4mm of exposed wire.",-1),O=e("h2",{id:"step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them",tabindex:"-1"},[n("Step 12: Twist the positive USB wire and positive IR LED wires together and tin them "),e("a",{class:"header-anchor",href:"#step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them","aria-label":'Permalink to "Step 12: Twist the positive USB wire and positive IR LED wires together and tin them"'},"​")],-1),H=e("p",null,"Once twisted together add solder to keep them together. This makes the connection much easier.",-1),W=e("h2",{id:"step-13-solder-the-positive-wire-to-esp",tabindex:"-1"},[n("Step 13: Solder the positive wire to ESP "),e("a",{class:"header-anchor",href:"#step-13-solder-the-positive-wire-to-esp","aria-label":'Permalink to "Step 13: Solder the positive wire to ESP"'},"​")],-1),M=e("p",null,"Lay the wire on the outside of the 5V pin and apply solder.",-1),j=i("",4),F=i("",5),Y=e("p",null,"Here are the PCB pin-out labels:",-1),z=e("p",null,"LED labels:",-1),$=i("",11),J=e("p",null,"Next, grab a resistor and hold it on the pads.",-1),Q=e("p",null,"While holding the resistor add solder to your soldering iron and apply it to the resistor.",-1),X=e("p",null,"I like to do this by having a piece of my solder stick up in the air and then put it on my iron that way.",-1),Z=e("p",null,"Flip the PCB and solder the other end.",-1),K=e("p",null,"Now repeat for the other one.",-1),ee=e("h2",{id:"solder-leds-on-pcb-v3",tabindex:"-1"},[n("Solder LEDs on PCB V3 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v3","aria-label":'Permalink to "Solder LEDs on PCB V3"'},"​")],-1),te=e("p",null,"Tin the LED pads.",-1),oe=e("p",null,"Orientate the LED and hold it in place.",-1),ae=e("p",null,"Solder one end.",-1),se=e("p",null,"Flip around and solder the other end.",-1),ne=e("h2",{id:"wire-up-the-pcbs-v3",tabindex:"-1"},[n("Wire up the PCBs V3 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v3","aria-label":'Permalink to "Wire up the PCBs V3"'},"​")],-1),ie=e("div",{class:"warning custom-block"},[e("p",{class:"custom-block-title"},"WARNING"),e("p",null,"Pay attention to the direction of the LEDs on the PCBs.")],-1),re=e("p",null,"If the green dot is facing inwards toward the text like in the picture below:",-1),le=e("p",null,"Use the following diagram:",-1),he=e("p",null,"If the green dot is facing away from the text like the picture below:",-1),de=e("p",null,"Use the following diagram:",-1),pe=i("",6),ce=e("p",null,"This uses a method of sliding in the camera. Generally, this is the recommended mounting method as it generally requires no glue.",-1),ue=e("p",null,"Place the camera into the mount",-1),_e=e("p",null,"Slowly apply pressure inwards until the camera snaps into place.",-1),me={align:"center"},fe=e("p",null," There is a good chance of breaking the mount when putting in the camera. If this happens you may be able to save the mount depending on where the break was. A small dab of hot glue around the camera is likely all that is needed. ",-1),we=e("h3",{id:"type-2",tabindex:"-1"},[n("Type 2 "),e("a",{class:"header-anchor",href:"#type-2","aria-label":'Permalink to "Type 2"'},"​")],-1),ge=e("p",null,"This uses the method of gluing the camera.",-1),be=e("p",null,"Apply a bit of glue to the bottom of the camera mount.",-1),ye=e("p",null,"Place the camera on the mount.",-1),ve=e("h2",{id:"ir-led-mounting",tabindex:"-1"},[n("IR LED mounting "),e("a",{class:"header-anchor",href:"#ir-led-mounting","aria-label":'Permalink to "IR LED mounting"'},"​")],-1),Se=e("p",null,"This again differs from mount to mount.",-1),ke=e("p",null,"In some cases, there are designated spots for the LEDs to go.",-1),Pe=e("p",null,"In others there are no specified spots, you will have to mess around to find what works best. This image shows the optimal/near-optimal position for the LEDs. Hot glue is your friend with this.",-1),Te=e("div",{class:"tip custom-block"},[e("p",{class:"custom-block-title"},"TIP"),e("p",null,"Use rubbing alcohol to easily remove hot glue.")],-1),qe=JSON.parse('{"title":"Build Guide","description":"","frontmatter":{},"headers":[],"relativePath":"how_to_build/full_build.md","filePath":"how_to_build/full_build.md","lastUpdated":1694358539000}'),Ee={name:"how_to_build/full_build.md"},Ne=Object.assign(Ee,{setup(xe){return(Ce,Ie)=>(d(),p("div",null,[_,m,f,t(a,{options:o(s).V4_wire_sketch},null,8,["options"]),w,g,t(a,{options:o(s).V4_solder_wire},null,8,["options"]),b,t(h,{options:{...o(u)}},null,8,["options"]),t(a,{options:o(s).image_one},null,8,["options"]),y,v,S,k,t(a,{options:o(s).external_antenna},null,8,["options"]),P,t(a,{options:o(s).external_antenna_resistors},null,8,["options"]),T,E,x,C,I,t(a,{options:o(s).camera_socket},null,8,["options"]),V,t(a,{options:o(s).camera_socket_clip},null,8,["options"]),D,t(a,{options:o(s).camera_cable},null,8,["options"]),A,t(a,{options:o(s).camera_clip_close},null,8,["options"]),B,q,N,t(a,{options:o(s)._7_12_one},null,8,["options"]),L,t(a,{options:o(s)._7_12_two},null,8,["options"]),R,G,U,O,H,t(a,{options:o(s)._7_12_three},null,8,["options"]),W,M,t(a,{options:o(s)._13_18_one},null,8,["options"]),j,t(a,{options:o(s)._13_18_two},null,8,["options"]),F,t(a,{options:o(s)._13_18_three},null,8,["options"]),Y,t(a,{options:o(s)._13_18_four},null,8,["options"]),z,t(a,{options:o(s)._13_18_five},null,8,["options"]),$,t(a,{options:o(s)._13_18_six},null,8,["options"]),J,t(a,{options:o(s)._13_18_seven},null,8,["options"]),Q,X,t(a,{options:o(s)._13_18_eight},null,8,["options"]),Z,t(a,{options:o(s)._13_18_nine},null,8,["options"]),K,t(a,{options:o(s)._13_18_ten},null,8,["options"]),ee,te,t(a,{options:o(s).end_one},null,8,["options"]),oe,t(a,{options:o(s).end_two},null,8,["options"]),ae,t(a,{options:o(s).end_three},null,8,["options"]),se,t(a,{options:o(s).end_four},null,8,["options"]),ne,ie,re,t(a,{options:o(s).end_five},null,8,["options"]),le,t(a,{options:o(s).end_six},null,8,["options"]),he,t(a,{options:o(s).end_seven},null,8,["options"]),de,t(a,{options:o(s).end_eight},null,8,["options"]),pe,t(a,{options:o(s).end_nine},null,8,["options"]),ce,ue,t(a,{options:o(s).end_ten},null,8,["options"]),_e,t(a,{options:o(s).end_eleven},null,8,["options"]),e("div",me,[t(r,{options:o(l).end_one},{content:c(()=>[fe]),_:1},8,["options"])]),we,t(a,{options:o(s).end_twelve},null,8,["options"]),ge,be,t(a,{options:o(s).end_thirteen},null,8,["options"]),ye,t(a,{options:o(s).end_fourteen},null,8,["options"]),ve,Se,ke,t(a,{options:o(s).end_fifteen},null,8,["options"]),Pe,t(a,{options:o(s).end_sixteen},null,8,["options"]),Te]))}});export{qe as __pageData,Ne as default};
+import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as h}from"./chunks/CheckBoxList.9fb033ec.js";import{_ as a,i as s}from"./chunks/index.10f74b3d.js";import{o as d,c as p,H as t,l as o,k as e,w as c,Q as i,a as n}from"./chunks/framework.e4c952c1.js";const u={state:!0,object:[{label:"2 ESP 32 CAM boards"},{label:"2 160 degree cameras"},{label:"1 USB board to power your ESPs"},{label:"1 Programmer board(buying an extra is reccomended)"},{label:"IR emitters, resistors, and preferably PCBs"},{label:"Lower gauge wire to power ESPs"},{label:"Higher gauge wire to power IR LEDs"},{label:"3d printer to print mounts. (Buying them from some place like JLCPCB is also an option)"},{label:"Glue of some form, hot glue highly recommended."}]},_=i("",3),m=e("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:""},null,-1),f=e("p",null,"Sketch of V4 solderless wiring:",-1),w=e("p",null,[n("Credit: @seniorpringles, @g0ldjay via "),e("a",{href:"https://discord.gg/kkXYbVykZX",target:"_blank",rel:"noreferrer"},"Discord")],-1),g=e("p",null,"Sketch of solder assembbly of V4:",-1),b=i("",9),y=e("h2",{id:"step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag",tabindex:"-1"},[n("Step 5: Install external antennas or shield ESP antenna with an antistatic bag "),e("a",{class:"header-anchor",href:"#step-5-install-external-antennas-or-shield-esp-antenna-with-an-antistatic-bag","aria-label":'Permalink to "Step 5: Install external antennas or shield ESP antenna with an antistatic bag"'},"​")],-1),v=e("p",null,"Some ESP-CAM boards have issues with signal integrity, there are 2 things you can do to help/solve the issues.",-1),S=e("p",null,"The first option is to use an external antenna.",-1),k=e("p",null,[n("This is the best solution when it comes to the final result. If you have Vive/Tundra trackers, this is a "),e("strong",null,"REQUIRED"),n(" 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.")],-1),P=e("p",null,"Below is an example of bridging the connections and attaching an antenna.",-1),T=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/aBTZuvg5sM8",title:"How to add an external antenna to an ESP32-CAM (2 methods)",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:""})],-1),E=e("p",null,"The second option is to cover the ESP's antenna with an antistatic bag. This can help aid problems, and can completely solve them in some cases. Best of all, it is completely free! However, it should be noted that it performs worse than an external antenna and in certain cases will not solve the issue like if you have Vive trackers.",-1),x=e("div",{align:"center"},[e("iframe",{width:"500",height:"300",src:"https://www.youtube.com/embed/wS4PS3Mw250",title:"Covering an ESP32-CAM's antenna with anti-static bag",frameborder:"0",allow:"accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:""})],-1),C=e("h2",{id:"step-6-attach-cameras-to-esps",tabindex:"-1"},[n("Step 6: Attach cameras to ESPs "),e("a",{class:"header-anchor",href:"#step-6-attach-cameras-to-esps","aria-label":'Permalink to "Step 6: Attach cameras to ESPs"'},"​")],-1),I=e("p",null,"Look at your ESP and locate the camera ribbon cable connector as circled below.",-1),V=e("p",null,"Flip the gray part up to allow the cameras to be connected. Do not force it, or shove objects into it to open, fingernails are fine.",-1),D=e("p",null,"Now slide in a camera, please note that the pins are facing down, you should only see the black part.",-1),A=e("p",null,"Once the camera has been slid in, press the gray part of the connector back down. There will be a small amount of force but still be gentle. Note the ammount of black coming out of the connector.",-1),B=e("h2",{id:"step-7-connect-esp-to-the-programmer-to-flash",tabindex:"-1"},[n("Step 7: Connect ESP to the programmer to flash "),e("a",{class:"header-anchor",href:"#step-7-connect-esp-to-the-programmer-to-flash","aria-label":'Permalink to "Step 7: Connect ESP to the programmer to flash"'},"​")],-1),q=e("p",null,"Why flash before you have it assembled? It's simple, to make sure they actually work before you spend time soldering to them.",-1),N=e("p",null,"Slide your ESP into the programmer, and note the USB port goes away from the ESP's camera.",-1),L=i("",8),R=e("h2",{id:"step-11-cut-wires-for-ir-leds",tabindex:"-1"},[n("Step 11: Cut wires for IR LEDs "),e("a",{class:"header-anchor",href:"#step-11-cut-wires-for-ir-leds","aria-label":'Permalink to "Step 11: Cut wires for IR LEDs"'},"​")],-1),G=e("p",null,"To find the optimal length, take a piece of wire and a marker and mock up your wire route, and mark the wire, cut it, then make another at the same size for the other eye. You will need 3 different cuts of wire. 2 short ones for connecting the 2 PCBs per eye together, 2 Longer ones for power, or ground and 2 slightly longer ones for power or ground for the LED near the camera at the bottom.",-1),U=e("p",null,"Once cut, strip them to around 4mm of exposed wire.",-1),O=e("h2",{id:"step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them",tabindex:"-1"},[n("Step 12: Twist the positive USB wire and positive IR LED wires together and tin them "),e("a",{class:"header-anchor",href:"#step-12-twist-the-positive-usb-wire-and-positive-ir-led-wires-together-and-tin-them","aria-label":'Permalink to "Step 12: Twist the positive USB wire and positive IR LED wires together and tin them"'},"​")],-1),H=e("p",null,"Once twisted together add solder to keep them together. This makes the connection much easier.",-1),W=e("h2",{id:"step-13-solder-the-positive-wire-to-esp",tabindex:"-1"},[n("Step 13: Solder the positive wire to ESP "),e("a",{class:"header-anchor",href:"#step-13-solder-the-positive-wire-to-esp","aria-label":'Permalink to "Step 13: Solder the positive wire to ESP"'},"​")],-1),M=e("p",null,"Lay the wire on the outside of the 5V pin and apply solder.",-1),j=i("",4),F=i("",5),Y=e("p",null,"Here are the PCB pin-out labels:",-1),z=e("p",null,"LED labels:",-1),$=i("",11),J=e("p",null,"Next, grab a resistor and hold it on the pads.",-1),Q=e("p",null,"While holding the resistor add solder to your soldering iron and apply it to the resistor.",-1),X=e("p",null,"I like to do this by having a piece of my solder stick up in the air and then put it on my iron that way.",-1),Z=e("p",null,"Flip the PCB and solder the other end.",-1),K=e("p",null,"Now repeat for the other one.",-1),ee=e("h2",{id:"solder-leds-on-pcb-v3",tabindex:"-1"},[n("Solder LEDs on PCB V3 "),e("a",{class:"header-anchor",href:"#solder-leds-on-pcb-v3","aria-label":'Permalink to "Solder LEDs on PCB V3"'},"​")],-1),te=e("p",null,"Tin the LED pads.",-1),oe=e("p",null,"Orientate the LED and hold it in place.",-1),ae=e("p",null,"Solder one end.",-1),se=e("p",null,"Flip around and solder the other end.",-1),ne=e("h2",{id:"wire-up-the-pcbs-v3",tabindex:"-1"},[n("Wire up the PCBs V3 "),e("a",{class:"header-anchor",href:"#wire-up-the-pcbs-v3","aria-label":'Permalink to "Wire up the PCBs V3"'},"​")],-1),ie=e("div",{class:"warning custom-block"},[e("p",{class:"custom-block-title"},"WARNING"),e("p",null,"Pay attention to the direction of the LEDs on the PCBs.")],-1),re=e("p",null,"If the green dot is facing inwards toward the text like in the picture below:",-1),le=e("p",null,"Use the following diagram:",-1),he=e("p",null,"If the green dot is facing away from the text like the picture below:",-1),de=e("p",null,"Use the following diagram:",-1),pe=i("",6),ce=e("p",null,"This uses a method of sliding in the camera. Generally, this is the recommended mounting method as it generally requires no glue.",-1),ue=e("p",null,"Place the camera into the mount",-1),_e=e("p",null,"Slowly apply pressure inwards until the camera snaps into place.",-1),me={align:"center"},fe=e("p",null," There is a good chance of breaking the mount when putting in the camera. If this happens you may be able to save the mount depending on where the break was. A small dab of hot glue around the camera is likely all that is needed. ",-1),we=e("h3",{id:"type-2",tabindex:"-1"},[n("Type 2 "),e("a",{class:"header-anchor",href:"#type-2","aria-label":'Permalink to "Type 2"'},"​")],-1),ge=e("p",null,"This uses the method of gluing the camera.",-1),be=e("p",null,"Apply a bit of glue to the bottom of the camera mount.",-1),ye=e("p",null,"Place the camera on the mount.",-1),ve=e("h2",{id:"ir-led-mounting",tabindex:"-1"},[n("IR LED mounting "),e("a",{class:"header-anchor",href:"#ir-led-mounting","aria-label":'Permalink to "IR LED mounting"'},"​")],-1),Se=e("p",null,"This again differs from mount to mount.",-1),ke=e("p",null,"In some cases, there are designated spots for the LEDs to go.",-1),Pe=e("p",null,"In others there are no specified spots, you will have to mess around to find what works best. This image shows the optimal/near-optimal position for the LEDs. Hot glue is your friend with this.",-1),Te=e("div",{class:"tip custom-block"},[e("p",{class:"custom-block-title"},"TIP"),e("p",null,"Use rubbing alcohol to easily remove hot glue.")],-1),qe=JSON.parse('{"title":"Build Guide","description":"","frontmatter":{},"headers":[],"relativePath":"how_to_build/full_build.md","filePath":"how_to_build/full_build.md","lastUpdated":1694358539000}'),Ee={name:"how_to_build/full_build.md"},Ne=Object.assign(Ee,{setup(xe){return(Ce,Ie)=>(d(),p("div",null,[_,m,f,t(a,{options:o(s).V4_wire_sketch},null,8,["options"]),w,g,t(a,{options:o(s).V4_solder_wire},null,8,["options"]),b,t(h,{options:{...o(u)}},null,8,["options"]),t(a,{options:o(s).image_one},null,8,["options"]),y,v,S,k,t(a,{options:o(s).external_antenna},null,8,["options"]),P,t(a,{options:o(s).external_antenna_resistors},null,8,["options"]),T,E,x,C,I,t(a,{options:o(s).camera_socket},null,8,["options"]),V,t(a,{options:o(s).camera_socket_clip},null,8,["options"]),D,t(a,{options:o(s).camera_cable},null,8,["options"]),A,t(a,{options:o(s).camera_clip_close},null,8,["options"]),B,q,N,t(a,{options:o(s)._7_12_one},null,8,["options"]),L,t(a,{options:o(s)._7_12_two},null,8,["options"]),R,G,U,O,H,t(a,{options:o(s)._7_12_three},null,8,["options"]),W,M,t(a,{options:o(s)._13_18_one},null,8,["options"]),j,t(a,{options:o(s)._13_18_two},null,8,["options"]),F,t(a,{options:o(s)._13_18_three},null,8,["options"]),Y,t(a,{options:o(s)._13_18_four},null,8,["options"]),z,t(a,{options:o(s)._13_18_five},null,8,["options"]),$,t(a,{options:o(s)._13_18_six},null,8,["options"]),J,t(a,{options:o(s)._13_18_seven},null,8,["options"]),Q,X,t(a,{options:o(s)._13_18_eight},null,8,["options"]),Z,t(a,{options:o(s)._13_18_nine},null,8,["options"]),K,t(a,{options:o(s)._13_18_ten},null,8,["options"]),ee,te,t(a,{options:o(s).end_one},null,8,["options"]),oe,t(a,{options:o(s).end_two},null,8,["options"]),ae,t(a,{options:o(s).end_three},null,8,["options"]),se,t(a,{options:o(s).end_four},null,8,["options"]),ne,ie,re,t(a,{options:o(s).end_five},null,8,["options"]),le,t(a,{options:o(s).end_six},null,8,["options"]),he,t(a,{options:o(s).end_seven},null,8,["options"]),de,t(a,{options:o(s).end_eight},null,8,["options"]),pe,t(a,{options:o(s).end_nine},null,8,["options"]),ce,ue,t(a,{options:o(s).end_ten},null,8,["options"]),_e,t(a,{options:o(s).end_eleven},null,8,["options"]),e("div",me,[t(r,{options:o(l).end_one},{content:c(()=>[fe]),_:1},8,["options"])]),we,t(a,{options:o(s).end_twelve},null,8,["options"]),ge,be,t(a,{options:o(s).end_thirteen},null,8,["options"]),ye,t(a,{options:o(s).end_fourteen},null,8,["options"]),ve,Se,ke,t(a,{options:o(s).end_fifteen},null,8,["options"]),Pe,t(a,{options:o(s).end_sixteen},null,8,["options"]),Te]))}});export{qe as __pageData,Ne as default};
diff --git a/assets/software_guide_eyetrackvr_app_guide.md.7beed7fa.js b/assets/software_guide_eyetrackvr_app_guide.md.2f90c236.js
similarity index 99%
rename from assets/software_guide_eyetrackvr_app_guide.md.7beed7fa.js
rename to assets/software_guide_eyetrackvr_app_guide.md.2f90c236.js
index 51f2f8ea..5942bc33 100644
--- a/assets/software_guide_eyetrackvr_app_guide.md.7beed7fa.js
+++ b/assets/software_guide_eyetrackvr_app_guide.md.2f90c236.js
@@ -1 +1 @@
-import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as o,i as r}from"./chunks/index.0e6ad99c.js";import{o as d,c as h,H as t,l as a,w as c,Q as n,k as e,a as i}from"./chunks/framework.e4c952c1.js";const p=n('
How to install, run and adjust the EyeTrackVR app. ​
Step 1: Download the EyeTrackVR Installer and install the EyeTrackVR app ​
Go to the latest GitHub release here and download the Setup.exe file.
Follow the prompts and the app should be installed.
Step 2: Run the EyeTrackVR app ​
If the Create Desktop Shortcut option was checked you should see an icon on your desktop, double click it to run.
You then should be greeted with a GUI that looks like this:
',7),u=n('
Step 3: Getting familiar with settings and terminology ​
Let's go over some basic terminology you will find in the app.
Starting from the top:
Right eye ​
Shows the right eye feed and settings only.
Left eye ​
Shows the left eye feed and settings only.
Both eyes ​
Shows both eyes' feed and settings.
Camera Address ​
This is where you enter the IP address of your camera. Alternatively, it can be used to put the cam number for wired cameras or pass in a video file.
Tracking Mode ​
This changes the GUI to the tracking mode where it outputs values.
Cropping Mode ​
This is where you will crop out your eye.
Threshold ​
This is used to cut out things that aren't dark like your pupil.
Rotation ​
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 ​
This will start a calibration mode for your eye where you look to all extremes.
Recenter Eye ​
This will recenter your eye to whatever point you are looking at.
Step 4: Adding your cameras to the software and configuring them ​
Wireless configuration ​
Power your ESPs and find what the IP address is for your right eye. This can be done by opening both Cameras in a browser and then holding your finger over your right eye camera.
Copy that IP address and then close the browser tab with it open.
Enter that IP address into the app's Camera Address field.
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.
Enter that COM port number into the app's Camera Address field.
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.
',36),y=e("p",null,[i("Now press the "),e("code",null,"Cropping Mode"),i(" button. You should see a feed of your camera.")],-1),_=e("p",null,"Put your headset on and use an application to see your desktop. (Virtual desktop, SteamVR desktop, etc.)",-1),g=e("p",null,"You should see something like this:",-1),f=e("p",null,"Now, Draw a rectangle that selects your eye.",-1),m=e("p",null,"A good example of an ROI",-1),b=e("p",null,[i("Head back over to the "),e("code",null,"Tracking mode"),i(".")],-1),k=e("p",null,[i("We will now adjust our rotation by moving the "),e("code",null,"Rotation"),i(" slider.")],-1),w=e("p",null,"From this:",-1),T=e("p",null,"To this:",-1),v=e("p",null,"Now we will adjust our threshold.",-1),P=e("p",null,"Continuing with your headset on, move the slider all the way up. start slowly backing it off until mainly only your pupil is being visualized in the threshold viewer.",-1),q=e("p",null,"Example of a threshold being too low:",-1),x=e("p",null,"Example of too high of a threshold:",-1),R=e("p",null,"Example of a good threshold:",-1),S=n('
Repeat everything in this step for your left eye.
Step 5: Calibrating your eyes ​
Once your eye is trackable by the software we need to calibrate it.
Press the Restart Calibration button and look around. The important part is that you look to all extremes, all the way up, left, etc. Once you have done so, wait for the Mode to say Tracking
The next step is to center your eye.
Look straight forward and press the Recenter Eye button.
Your eye is now fully calibrated.
Repeat for your other eye.
',8),C=e("p",null," To best center both eyes, look at one spot and hit the 'Recenter Eye' button for each eye without moving your eyes. ",-1),E=e("h2",{id:"see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001",tabindex:"-1"},[i("See anything outdated on this guide? Let me know! "),e("code",null,"Prohurtz#0001"),i(),e("a",{class:"header-anchor",href:"#see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001","aria-label":'Permalink to "See anything outdated on this guide? Let me know! `Prohurtz#0001`"'},"​")],-1),j=JSON.parse('{"title":"How to install, run and adjust the EyeTrackVR app.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/eyetrackvr_app_guide.md","filePath":"software_guide/eyetrackvr_app_guide.md","lastUpdated":1689147044000}'),V={name:"software_guide/eyetrackvr_app_guide.md"},B=Object.assign(V,{setup(I){return(A,N)=>(d(),h("div",null,[p,t(o,{options:a(r).eyetrack_vr_guide_three},null,8,["options"]),u,t(o,{options:a(r).eyetrack_vr_guide_four},null,8,["options"]),y,_,g,t(o,{options:a(r).eyetrack_vr_guide_five},null,8,["options"]),f,m,t(o,{options:a(r).eyetrack_vr_guide_six},null,8,["options"]),b,k,w,t(o,{options:a(r).eyetrack_vr_guide_seven},null,8,["options"]),T,t(o,{options:a(r).eyetrack_vr_guide_eight},null,8,["options"]),v,P,q,t(o,{options:a(r).eyetrack_vr_guide_nine},null,8,["options"]),x,t(o,{options:a(r).eyetrack_vr_guide_ten},null,8,["options"]),R,t(o,{options:a(r).eyetrack_vr_guide_eleven},null,8,["options"]),S,t(s,{options:a(l).eyetrack_vr_guide_two},{content:c(()=>[C]),_:1},8,["options"]),E]))}});export{j as __pageData,B as default};
+import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as o,i as r}from"./chunks/index.10f74b3d.js";import{o as d,c as h,H as t,l as a,w as c,Q as n,k as e,a as i}from"./chunks/framework.e4c952c1.js";const p=n('
How to install, run and adjust the EyeTrackVR app. ​
Step 1: Download the EyeTrackVR Installer and install the EyeTrackVR app ​
Go to the latest GitHub release here and download the Setup.exe file.
Follow the prompts and the app should be installed.
Step 2: Run the EyeTrackVR app ​
If the Create Desktop Shortcut option was checked you should see an icon on your desktop, double click it to run.
You then should be greeted with a GUI that looks like this:
',7),u=n('
Step 3: Getting familiar with settings and terminology ​
Let's go over some basic terminology you will find in the app.
Starting from the top:
Right eye ​
Shows the right eye feed and settings only.
Left eye ​
Shows the left eye feed and settings only.
Both eyes ​
Shows both eyes' feed and settings.
Camera Address ​
This is where you enter the IP address of your camera. Alternatively, it can be used to put the cam number for wired cameras or pass in a video file.
Tracking Mode ​
This changes the GUI to the tracking mode where it outputs values.
Cropping Mode ​
This is where you will crop out your eye.
Threshold ​
This is used to cut out things that aren't dark like your pupil.
Rotation ​
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 ​
This will start a calibration mode for your eye where you look to all extremes.
Recenter Eye ​
This will recenter your eye to whatever point you are looking at.
Step 4: Adding your cameras to the software and configuring them ​
Wireless configuration ​
Power your ESPs and find what the IP address is for your right eye. This can be done by opening both Cameras in a browser and then holding your finger over your right eye camera.
Copy that IP address and then close the browser tab with it open.
Enter that IP address into the app's Camera Address field.
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.
Enter that COM port number into the app's Camera Address field.
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.
',36),y=e("p",null,[i("Now press the "),e("code",null,"Cropping Mode"),i(" button. You should see a feed of your camera.")],-1),_=e("p",null,"Put your headset on and use an application to see your desktop. (Virtual desktop, SteamVR desktop, etc.)",-1),g=e("p",null,"You should see something like this:",-1),f=e("p",null,"Now, Draw a rectangle that selects your eye.",-1),m=e("p",null,"A good example of an ROI",-1),b=e("p",null,[i("Head back over to the "),e("code",null,"Tracking mode"),i(".")],-1),k=e("p",null,[i("We will now adjust our rotation by moving the "),e("code",null,"Rotation"),i(" slider.")],-1),w=e("p",null,"From this:",-1),T=e("p",null,"To this:",-1),v=e("p",null,"Now we will adjust our threshold.",-1),P=e("p",null,"Continuing with your headset on, move the slider all the way up. start slowly backing it off until mainly only your pupil is being visualized in the threshold viewer.",-1),q=e("p",null,"Example of a threshold being too low:",-1),x=e("p",null,"Example of too high of a threshold:",-1),R=e("p",null,"Example of a good threshold:",-1),S=n('
Repeat everything in this step for your left eye.
Step 5: Calibrating your eyes ​
Once your eye is trackable by the software we need to calibrate it.
Press the Restart Calibration button and look around. The important part is that you look to all extremes, all the way up, left, etc. Once you have done so, wait for the Mode to say Tracking
The next step is to center your eye.
Look straight forward and press the Recenter Eye button.
Your eye is now fully calibrated.
Repeat for your other eye.
',8),C=e("p",null," To best center both eyes, look at one spot and hit the 'Recenter Eye' button for each eye without moving your eyes. ",-1),E=e("h2",{id:"see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001",tabindex:"-1"},[i("See anything outdated on this guide? Let me know! "),e("code",null,"Prohurtz#0001"),i(),e("a",{class:"header-anchor",href:"#see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001","aria-label":'Permalink to "See anything outdated on this guide? Let me know! `Prohurtz#0001`"'},"​")],-1),j=JSON.parse('{"title":"How to install, run and adjust the EyeTrackVR app.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/eyetrackvr_app_guide.md","filePath":"software_guide/eyetrackvr_app_guide.md","lastUpdated":1689147044000}'),V={name:"software_guide/eyetrackvr_app_guide.md"},B=Object.assign(V,{setup(I){return(A,N)=>(d(),h("div",null,[p,t(o,{options:a(r).eyetrack_vr_guide_three},null,8,["options"]),u,t(o,{options:a(r).eyetrack_vr_guide_four},null,8,["options"]),y,_,g,t(o,{options:a(r).eyetrack_vr_guide_five},null,8,["options"]),f,m,t(o,{options:a(r).eyetrack_vr_guide_six},null,8,["options"]),b,k,w,t(o,{options:a(r).eyetrack_vr_guide_seven},null,8,["options"]),T,t(o,{options:a(r).eyetrack_vr_guide_eight},null,8,["options"]),v,P,q,t(o,{options:a(r).eyetrack_vr_guide_nine},null,8,["options"]),x,t(o,{options:a(r).eyetrack_vr_guide_ten},null,8,["options"]),R,t(o,{options:a(r).eyetrack_vr_guide_eleven},null,8,["options"]),S,t(s,{options:a(l).eyetrack_vr_guide_two},{content:c(()=>[C]),_:1},8,["options"]),E]))}});export{j as __pageData,B as default};
diff --git a/assets/software_guide_eyetrackvr_app_guide.md.7beed7fa.lean.js b/assets/software_guide_eyetrackvr_app_guide.md.2f90c236.lean.js
similarity index 97%
rename from assets/software_guide_eyetrackvr_app_guide.md.7beed7fa.lean.js
rename to assets/software_guide_eyetrackvr_app_guide.md.2f90c236.lean.js
index f604023f..dae6403d 100644
--- a/assets/software_guide_eyetrackvr_app_guide.md.7beed7fa.lean.js
+++ b/assets/software_guide_eyetrackvr_app_guide.md.2f90c236.lean.js
@@ -1 +1 @@
-import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as o,i as r}from"./chunks/index.0e6ad99c.js";import{o as d,c as h,H as t,l as a,w as c,Q as n,k as e,a as i}from"./chunks/framework.e4c952c1.js";const p=n("",7),u=n("",36),y=e("p",null,[i("Now press the "),e("code",null,"Cropping Mode"),i(" button. You should see a feed of your camera.")],-1),_=e("p",null,"Put your headset on and use an application to see your desktop. (Virtual desktop, SteamVR desktop, etc.)",-1),g=e("p",null,"You should see something like this:",-1),f=e("p",null,"Now, Draw a rectangle that selects your eye.",-1),m=e("p",null,"A good example of an ROI",-1),b=e("p",null,[i("Head back over to the "),e("code",null,"Tracking mode"),i(".")],-1),k=e("p",null,[i("We will now adjust our rotation by moving the "),e("code",null,"Rotation"),i(" slider.")],-1),w=e("p",null,"From this:",-1),T=e("p",null,"To this:",-1),v=e("p",null,"Now we will adjust our threshold.",-1),P=e("p",null,"Continuing with your headset on, move the slider all the way up. start slowly backing it off until mainly only your pupil is being visualized in the threshold viewer.",-1),q=e("p",null,"Example of a threshold being too low:",-1),x=e("p",null,"Example of too high of a threshold:",-1),R=e("p",null,"Example of a good threshold:",-1),S=n("",8),C=e("p",null," To best center both eyes, look at one spot and hit the 'Recenter Eye' button for each eye without moving your eyes. ",-1),E=e("h2",{id:"see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001",tabindex:"-1"},[i("See anything outdated on this guide? Let me know! "),e("code",null,"Prohurtz#0001"),i(),e("a",{class:"header-anchor",href:"#see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001","aria-label":'Permalink to "See anything outdated on this guide? Let me know! `Prohurtz#0001`"'},"​")],-1),j=JSON.parse('{"title":"How to install, run and adjust the EyeTrackVR app.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/eyetrackvr_app_guide.md","filePath":"software_guide/eyetrackvr_app_guide.md","lastUpdated":1689147044000}'),V={name:"software_guide/eyetrackvr_app_guide.md"},B=Object.assign(V,{setup(I){return(A,N)=>(d(),h("div",null,[p,t(o,{options:a(r).eyetrack_vr_guide_three},null,8,["options"]),u,t(o,{options:a(r).eyetrack_vr_guide_four},null,8,["options"]),y,_,g,t(o,{options:a(r).eyetrack_vr_guide_five},null,8,["options"]),f,m,t(o,{options:a(r).eyetrack_vr_guide_six},null,8,["options"]),b,k,w,t(o,{options:a(r).eyetrack_vr_guide_seven},null,8,["options"]),T,t(o,{options:a(r).eyetrack_vr_guide_eight},null,8,["options"]),v,P,q,t(o,{options:a(r).eyetrack_vr_guide_nine},null,8,["options"]),x,t(o,{options:a(r).eyetrack_vr_guide_ten},null,8,["options"]),R,t(o,{options:a(r).eyetrack_vr_guide_eleven},null,8,["options"]),S,t(s,{options:a(l).eyetrack_vr_guide_two},{content:c(()=>[C]),_:1},8,["options"]),E]))}});export{j as __pageData,B as default};
+import{_ as s,a as l}from"./chunks/index.8ad7dc66.js";import{_ as o,i as r}from"./chunks/index.10f74b3d.js";import{o as d,c as h,H as t,l as a,w as c,Q as n,k as e,a as i}from"./chunks/framework.e4c952c1.js";const p=n("",7),u=n("",36),y=e("p",null,[i("Now press the "),e("code",null,"Cropping Mode"),i(" button. You should see a feed of your camera.")],-1),_=e("p",null,"Put your headset on and use an application to see your desktop. (Virtual desktop, SteamVR desktop, etc.)",-1),g=e("p",null,"You should see something like this:",-1),f=e("p",null,"Now, Draw a rectangle that selects your eye.",-1),m=e("p",null,"A good example of an ROI",-1),b=e("p",null,[i("Head back over to the "),e("code",null,"Tracking mode"),i(".")],-1),k=e("p",null,[i("We will now adjust our rotation by moving the "),e("code",null,"Rotation"),i(" slider.")],-1),w=e("p",null,"From this:",-1),T=e("p",null,"To this:",-1),v=e("p",null,"Now we will adjust our threshold.",-1),P=e("p",null,"Continuing with your headset on, move the slider all the way up. start slowly backing it off until mainly only your pupil is being visualized in the threshold viewer.",-1),q=e("p",null,"Example of a threshold being too low:",-1),x=e("p",null,"Example of too high of a threshold:",-1),R=e("p",null,"Example of a good threshold:",-1),S=n("",8),C=e("p",null," To best center both eyes, look at one spot and hit the 'Recenter Eye' button for each eye without moving your eyes. ",-1),E=e("h2",{id:"see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001",tabindex:"-1"},[i("See anything outdated on this guide? Let me know! "),e("code",null,"Prohurtz#0001"),i(),e("a",{class:"header-anchor",href:"#see-anything-outdated-on-this-guide-let-me-know-prohurtz-0001","aria-label":'Permalink to "See anything outdated on this guide? Let me know! `Prohurtz#0001`"'},"​")],-1),j=JSON.parse('{"title":"How to install, run and adjust the EyeTrackVR app.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/eyetrackvr_app_guide.md","filePath":"software_guide/eyetrackvr_app_guide.md","lastUpdated":1689147044000}'),V={name:"software_guide/eyetrackvr_app_guide.md"},B=Object.assign(V,{setup(I){return(A,N)=>(d(),h("div",null,[p,t(o,{options:a(r).eyetrack_vr_guide_three},null,8,["options"]),u,t(o,{options:a(r).eyetrack_vr_guide_four},null,8,["options"]),y,_,g,t(o,{options:a(r).eyetrack_vr_guide_five},null,8,["options"]),f,m,t(o,{options:a(r).eyetrack_vr_guide_six},null,8,["options"]),b,k,w,t(o,{options:a(r).eyetrack_vr_guide_seven},null,8,["options"]),T,t(o,{options:a(r).eyetrack_vr_guide_eight},null,8,["options"]),v,P,q,t(o,{options:a(r).eyetrack_vr_guide_nine},null,8,["options"]),x,t(o,{options:a(r).eyetrack_vr_guide_ten},null,8,["options"]),R,t(o,{options:a(r).eyetrack_vr_guide_eleven},null,8,["options"]),S,t(s,{options:a(l).eyetrack_vr_guide_two},{content:c(()=>[C]),_:1},8,["options"]),E]))}});export{j as __pageData,B as default};
diff --git a/assets/software_guide_osc_setup.md.5969c73c.js b/assets/software_guide_osc_setup.md.da0e63a0.js
similarity index 98%
rename from assets/software_guide_osc_setup.md.5969c73c.js
rename to assets/software_guide_osc_setup.md.da0e63a0.js
index 69239a52..f192ed90 100644
--- a/assets/software_guide_osc_setup.md.5969c73c.js
+++ b/assets/software_guide_osc_setup.md.da0e63a0.js
@@ -1 +1 @@
-import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as n}from"./chunks/index.0e6ad99c.js";import{o as c,c as d,H as t,w as h,l as o,k as e,a as i,Q as s}from"./chunks/framework.e4c952c1.js";const p=e("h1",{id:"setting-up-recalibration-and-recentering-from-vrchat",tabindex:"-1"},[i("Setting up recalibration and recentering from VRChat. "),e("a",{class:"header-anchor",href:"#setting-up-recalibration-and-recentering-from-vrchat","aria-label":'Permalink to "Setting up recalibration and recentering from VRChat."'},"​")],-1),u=e("p",null,"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.",-1),_=e("p",null," Note, while this page explains how to do it from the point of view of vrchat, it can be done in Neos and CVR too, all the app listens to are two OSC messages. ",-1),m=s('
Setting up your parameters ​
Adding parameters ​
You'll need to add two parameters to your Parameters config, those being:
  • etvr_recalibrate: Bool
  • etvr_recenter: Bool
Both of them do not have to be synced, meaning they won't increase your total memory count.
To do this, in Unity, select your avatar on the scene and find Avatar Descriptor in the inspector. In it, find the section named "expressions", expand it and click on the file assigned to the "parameters" field, that's your Parameters config.
',6),f=e("p",null,[i("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 "),e("code",null,"Add"),i(" 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.")],-1),g=e("p",null,"That's it for the parameters.",-1),b=e("h3",{id:"adding-buttons-to-the-menu",tabindex:"-1"},[i("Adding buttons to the menu "),e("a",{class:"header-anchor",href:"#adding-buttons-to-the-menu","aria-label":'Permalink to "Adding buttons to the menu"'},"​")],-1),y=e("p",null,"Now, you will need to add actual buttons for them in your gesture menu.",-1),v=e("p",null,"The expressions section mentioned above also contains the menu, you can use that to either add the buttons there directly or create a small submenu to make it less cluttered, here we will add them directly.",-1),w=e("p",null,'Once you have the menu file opened in the inspector, click on the "add control" button. This will add an empty action slot, expand it.',-1),k=e("p",null,`You'll see a bunch of fields, like name, icon, type and parameter. Firstly, let's give it a friendly name like "recalibrate eyes" or "recenter tracking" depending on the action you want to assign to them.`,-1),C=e("p",null,"Leave the type as is - as a button, it's more convenient as it bounces back into the off state by itself.",-1),T=e("p",null,[i("Now, in the parameter section, click on the "),e("code",null,"[None]"),i(" and select one of the parameters you have created in the previous section.")],-1),x=s('
Repeat the steps for the other one.
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 ​
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.
They are stored under
C:\\Users\\<user>\\AppData\\LocalLow\\VRChat\\VRChat\\OSC\\<your user uuid>\\Avatars\\
Deleting the contents of the Avatars directory will resolve the issue.
Other platforms ​
Like mentioned in the note, this functionality is not limited to VRC.
The app itself listens to OSC messages sent on port 9001 to two addresses:
  • /avatar/parameters/etvr_recenter
  • /avatar/parameters/etvr_recalibrate
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.
',14),O=JSON.parse('{"title":"Setting up recalibration and recentering from VRChat.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/osc_setup.md","filePath":"software_guide/osc_setup.md","lastUpdated":1682887355000}'),S={name:"software_guide/osc_setup.md"},B=Object.assign(S,{setup(V){return(R,A)=>(c(),d("div",null,[p,u,t(r,{options:o(l).parts_list_two},{content:h(()=>[_]),_:1},8,["options"]),m,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),f,t(a,{options:o(n).unity_vrc_expressions_add_fields},null,8,["options"]),t(a,{options:o(n).unity_vrc_expressions_fields},null,8,["options"]),g,b,y,v,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),w,t(a,{options:o(n).unity_vrc_empty_control},null,8,["options"]),k,C,T,t(a,{options:o(n).unity_vrc_control_setup},null,8,["options"]),x]))}});export{O as __pageData,B as default};
+import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as n}from"./chunks/index.10f74b3d.js";import{o as c,c as d,H as t,w as h,l as o,k as e,a as i,Q as s}from"./chunks/framework.e4c952c1.js";const p=e("h1",{id:"setting-up-recalibration-and-recentering-from-vrchat",tabindex:"-1"},[i("Setting up recalibration and recentering from VRChat. "),e("a",{class:"header-anchor",href:"#setting-up-recalibration-and-recentering-from-vrchat","aria-label":'Permalink to "Setting up recalibration and recentering from VRChat."'},"​")],-1),u=e("p",null,"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.",-1),_=e("p",null," Note, while this page explains how to do it from the point of view of vrchat, it can be done in Neos and CVR too, all the app listens to are two OSC messages. ",-1),m=s('
Setting up your parameters ​
Adding parameters ​
You'll need to add two parameters to your Parameters config, those being:
  • etvr_recalibrate: Bool
  • etvr_recenter: Bool
Both of them do not have to be synced, meaning they won't increase your total memory count.
To do this, in Unity, select your avatar on the scene and find Avatar Descriptor in the inspector. In it, find the section named "expressions", expand it and click on the file assigned to the "parameters" field, that's your Parameters config.
',6),f=e("p",null,[i("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 "),e("code",null,"Add"),i(" 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.")],-1),g=e("p",null,"That's it for the parameters.",-1),b=e("h3",{id:"adding-buttons-to-the-menu",tabindex:"-1"},[i("Adding buttons to the menu "),e("a",{class:"header-anchor",href:"#adding-buttons-to-the-menu","aria-label":'Permalink to "Adding buttons to the menu"'},"​")],-1),y=e("p",null,"Now, you will need to add actual buttons for them in your gesture menu.",-1),v=e("p",null,"The expressions section mentioned above also contains the menu, you can use that to either add the buttons there directly or create a small submenu to make it less cluttered, here we will add them directly.",-1),w=e("p",null,'Once you have the menu file opened in the inspector, click on the "add control" button. This will add an empty action slot, expand it.',-1),k=e("p",null,`You'll see a bunch of fields, like name, icon, type and parameter. Firstly, let's give it a friendly name like "recalibrate eyes" or "recenter tracking" depending on the action you want to assign to them.`,-1),C=e("p",null,"Leave the type as is - as a button, it's more convenient as it bounces back into the off state by itself.",-1),T=e("p",null,[i("Now, in the parameter section, click on the "),e("code",null,"[None]"),i(" and select one of the parameters you have created in the previous section.")],-1),x=s('
Repeat the steps for the other one.
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 ​
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.
They are stored under
C:\\Users\\<user>\\AppData\\LocalLow\\VRChat\\VRChat\\OSC\\<your user uuid>\\Avatars\\
Deleting the contents of the Avatars directory will resolve the issue.
Other platforms ​
Like mentioned in the note, this functionality is not limited to VRC.
The app itself listens to OSC messages sent on port 9001 to two addresses:
  • /avatar/parameters/etvr_recenter
  • /avatar/parameters/etvr_recalibrate
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.
',14),O=JSON.parse('{"title":"Setting up recalibration and recentering from VRChat.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/osc_setup.md","filePath":"software_guide/osc_setup.md","lastUpdated":1682887355000}'),S={name:"software_guide/osc_setup.md"},B=Object.assign(S,{setup(V){return(R,A)=>(c(),d("div",null,[p,u,t(r,{options:o(l).parts_list_two},{content:h(()=>[_]),_:1},8,["options"]),m,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),f,t(a,{options:o(n).unity_vrc_expressions_add_fields},null,8,["options"]),t(a,{options:o(n).unity_vrc_expressions_fields},null,8,["options"]),g,b,y,v,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),w,t(a,{options:o(n).unity_vrc_empty_control},null,8,["options"]),k,C,T,t(a,{options:o(n).unity_vrc_control_setup},null,8,["options"]),x]))}});export{O as __pageData,B as default};
diff --git a/assets/software_guide_osc_setup.md.5969c73c.lean.js b/assets/software_guide_osc_setup.md.da0e63a0.lean.js
similarity index 98%
rename from assets/software_guide_osc_setup.md.5969c73c.lean.js
rename to assets/software_guide_osc_setup.md.da0e63a0.lean.js
index b44acf2e..f42f8556 100644
--- a/assets/software_guide_osc_setup.md.5969c73c.lean.js
+++ b/assets/software_guide_osc_setup.md.da0e63a0.lean.js
@@ -1 +1 @@
-import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as n}from"./chunks/index.0e6ad99c.js";import{o as c,c as d,H as t,w as h,l as o,k as e,a as i,Q as s}from"./chunks/framework.e4c952c1.js";const p=e("h1",{id:"setting-up-recalibration-and-recentering-from-vrchat",tabindex:"-1"},[i("Setting up recalibration and recentering from VRChat. "),e("a",{class:"header-anchor",href:"#setting-up-recalibration-and-recentering-from-vrchat","aria-label":'Permalink to "Setting up recalibration and recentering from VRChat."'},"​")],-1),u=e("p",null,"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.",-1),_=e("p",null," Note, while this page explains how to do it from the point of view of vrchat, it can be done in Neos and CVR too, all the app listens to are two OSC messages. ",-1),m=s("",6),f=e("p",null,[i("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 "),e("code",null,"Add"),i(" 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.")],-1),g=e("p",null,"That's it for the parameters.",-1),b=e("h3",{id:"adding-buttons-to-the-menu",tabindex:"-1"},[i("Adding buttons to the menu "),e("a",{class:"header-anchor",href:"#adding-buttons-to-the-menu","aria-label":'Permalink to "Adding buttons to the menu"'},"​")],-1),y=e("p",null,"Now, you will need to add actual buttons for them in your gesture menu.",-1),v=e("p",null,"The expressions section mentioned above also contains the menu, you can use that to either add the buttons there directly or create a small submenu to make it less cluttered, here we will add them directly.",-1),w=e("p",null,'Once you have the menu file opened in the inspector, click on the "add control" button. This will add an empty action slot, expand it.',-1),k=e("p",null,`You'll see a bunch of fields, like name, icon, type and parameter. Firstly, let's give it a friendly name like "recalibrate eyes" or "recenter tracking" depending on the action you want to assign to them.`,-1),C=e("p",null,"Leave the type as is - as a button, it's more convenient as it bounces back into the off state by itself.",-1),T=e("p",null,[i("Now, in the parameter section, click on the "),e("code",null,"[None]"),i(" and select one of the parameters you have created in the previous section.")],-1),x=s("",14),O=JSON.parse('{"title":"Setting up recalibration and recentering from VRChat.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/osc_setup.md","filePath":"software_guide/osc_setup.md","lastUpdated":1682887355000}'),S={name:"software_guide/osc_setup.md"},B=Object.assign(S,{setup(V){return(R,A)=>(c(),d("div",null,[p,u,t(r,{options:o(l).parts_list_two},{content:h(()=>[_]),_:1},8,["options"]),m,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),f,t(a,{options:o(n).unity_vrc_expressions_add_fields},null,8,["options"]),t(a,{options:o(n).unity_vrc_expressions_fields},null,8,["options"]),g,b,y,v,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),w,t(a,{options:o(n).unity_vrc_empty_control},null,8,["options"]),k,C,T,t(a,{options:o(n).unity_vrc_control_setup},null,8,["options"]),x]))}});export{O as __pageData,B as default};
+import{_ as r,a as l}from"./chunks/index.8ad7dc66.js";import{_ as a,i as n}from"./chunks/index.10f74b3d.js";import{o as c,c as d,H as t,w as h,l as o,k as e,a as i,Q as s}from"./chunks/framework.e4c952c1.js";const p=e("h1",{id:"setting-up-recalibration-and-recentering-from-vrchat",tabindex:"-1"},[i("Setting up recalibration and recentering from VRChat. "),e("a",{class:"header-anchor",href:"#setting-up-recalibration-and-recentering-from-vrchat","aria-label":'Permalink to "Setting up recalibration and recentering from VRChat."'},"​")],-1),u=e("p",null,"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.",-1),_=e("p",null," Note, while this page explains how to do it from the point of view of vrchat, it can be done in Neos and CVR too, all the app listens to are two OSC messages. ",-1),m=s("",6),f=e("p",null,[i("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 "),e("code",null,"Add"),i(" 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.")],-1),g=e("p",null,"That's it for the parameters.",-1),b=e("h3",{id:"adding-buttons-to-the-menu",tabindex:"-1"},[i("Adding buttons to the menu "),e("a",{class:"header-anchor",href:"#adding-buttons-to-the-menu","aria-label":'Permalink to "Adding buttons to the menu"'},"​")],-1),y=e("p",null,"Now, you will need to add actual buttons for them in your gesture menu.",-1),v=e("p",null,"The expressions section mentioned above also contains the menu, you can use that to either add the buttons there directly or create a small submenu to make it less cluttered, here we will add them directly.",-1),w=e("p",null,'Once you have the menu file opened in the inspector, click on the "add control" button. This will add an empty action slot, expand it.',-1),k=e("p",null,`You'll see a bunch of fields, like name, icon, type and parameter. Firstly, let's give it a friendly name like "recalibrate eyes" or "recenter tracking" depending on the action you want to assign to them.`,-1),C=e("p",null,"Leave the type as is - as a button, it's more convenient as it bounces back into the off state by itself.",-1),T=e("p",null,[i("Now, in the parameter section, click on the "),e("code",null,"[None]"),i(" and select one of the parameters you have created in the previous section.")],-1),x=s("",14),O=JSON.parse('{"title":"Setting up recalibration and recentering from VRChat.","description":"","frontmatter":{},"headers":[],"relativePath":"software_guide/osc_setup.md","filePath":"software_guide/osc_setup.md","lastUpdated":1682887355000}'),S={name:"software_guide/osc_setup.md"},B=Object.assign(S,{setup(V){return(R,A)=>(c(),d("div",null,[p,u,t(r,{options:o(l).parts_list_two},{content:h(()=>[_]),_:1},8,["options"]),m,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),f,t(a,{options:o(n).unity_vrc_expressions_add_fields},null,8,["options"]),t(a,{options:o(n).unity_vrc_expressions_fields},null,8,["options"]),g,b,y,v,t(a,{options:o(n).unity_vrc_expressions},null,8,["options"]),w,t(a,{options:o(n).unity_vrc_empty_control},null,8,["options"]),k,C,T,t(a,{options:o(n).unity_vrc_control_setup},null,8,["options"]),x]))}});export{O as __pageData,B as default};
diff --git a/contact.html b/contact.html
index 7fb195f0..3caaec89 100644
--- a/contact.html
+++ b/contact.html
@@ -17,7 +17,7 @@
   
   
     
-    
+    
     
   
 
\ No newline at end of file
diff --git a/dev_roadmap.html b/dev_roadmap.html
index 3656c110..17e36521 100644
--- a/dev_roadmap.html
+++ b/dev_roadmap.html
@@ -18,7 +18,7 @@
   
   
     
EyeTrackVR Docs
Appearance
Released under the MIT License.
Copyright © 2022-present ETVR

-    
+    
     
   
 
\ No newline at end of file
diff --git a/development/docs/dev_docs.html b/development/docs/dev_docs.html
index 62be0c57..1045b214 100644
--- a/development/docs/dev_docs.html
+++ b/development/docs/dev_docs.html
@@ -17,7 +17,7 @@
   
   
     
EyeTrackVR Docs
Appearance
Development Documentation for the EyeTrackVR Docs Site ​
This is the documentation for the EyeTrackVR Docs site. It is built using VitePress.
Getting Started ​
Prerequisites ​
  • Node.js (v14.15.4 or higher)
  • Yarn (v1.22.10 or higher)
  • Git (v2.30.1 or higher)
  • VSCode (v1.56.2 or higher)
Installation ​
  1. Clone the repo
    sh
    git clone https://github.com/EyeTrackVR/EyeTrackVR-Docs.git
  2. Navigate to the vitepress folder
    sh
    cd vitepress
  3. Install Yarn packages
    sh
     yarn
  4. Start the dev server
    sh
    yarn dev
  5. Open the site in your browser
Contributing ​
Project Structure ​
  1. Familiarize yourself with the VitePress documentation.
  2. Then, move on to our project specific documentation below.
Standards ​
  • All documentation should be written in Markdown or Vue components.
  • All file names are snake case and lowercase letters.
  • Do not make naming changes to the vitepress folder.
  • Do not make major changes to the vitepress folder structure without proir consultation of team members.
  • For Vue componentes, follow the Vue3 docs.
Released under the MIT License.
Copyright © 2022-present ETVR

-    
+    
     
   
 
\ No newline at end of file
diff --git a/development/docs/pages.html b/development/docs/pages.html
index c3718351..c8d9cda6 100644
--- a/development/docs/pages.html
+++ b/development/docs/pages.html
@@ -25,7 +25,7 @@
         { text: "My Page", link: "/my_folder/my_page" }, // Add this line - subdir then file
     ],
 },
Note
The link property does not require a file extension. Please do not add it.
Title Style ​
The title style is the style of the title that appears at the top of the page.
We like to keep this cohesive, so please use the following style:
md
# My Page {.text-[var(--font-accent)]}
This will give the title a nice orange colour.
The {} are required, and the .text-[#e67e22] is the colour using TailWindCSS classes. You can also use our built in CSS variables {.text-[var(--font-accent)]}. You will find these in the src/styles/theme.css file. You can change this to any colour you like, but please keep it consistent with the rest of the site.
Tip
This entire site supports TailWindCSS classes. You can find the documentation here.
All classes you wish to add, must be prefaced with a . when inside of the {}.
When using classes on HTML elements, you can use the class attribute. For example:
html
<h1 class="text-[#e67e22]">My Page</h1>
Editing a Page ​
To edit a page, you will need to edit the Markdown file in the vitepress/docs/src/pages folder.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/development/docs/standards.html b/development/docs/standards.html index dfe9773c..f443ec7f 100644 --- a/development/docs/standards.html +++ b/development/docs/standards.html @@ -25,7 +25,7 @@ - added new thing # some detail about the new thing BREAKING CHANGE: this is a breaking change #this line is optionaland only used if needed

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/configure_firmware.html b/firmware_guide/configure_firmware.html index a830250d..a1eaf9ee 100644 --- a/firmware_guide/configure_firmware.html +++ b/firmware_guide/configure_firmware.html @@ -12,14 +12,14 @@ - - + +
EyeTrackVR Docs

Appearance

Configuring the firmware ​

Once you have opened the project, you should see something on the left side like this ​

'img'

Open the ini/user_config.ini file ​

'img'

INFO

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.

Replace the placeholder text with your correct SSID (WiFi access point name), and password respectfully.

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.

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.

Then, you will need to set the ap_ssid to the name of your AP, and ap_password to the password of your AP.

You can choose to leave the ap_ssid and ap_password as defaults, but you will need to set the enableadhoc to 1.

Note: If you are enabling AP mode for both ESPs, you will need to set the ap_ssid and ap_password to different values for both ESPs. It is best to set AP mode only for one ESP, and leave the other ESP in STA mode. Connect the other ESP to the AP of the ESP in AP mode. Then connect your computer to the AP of the ESP in AP mode. This will allow you to connect to the ESP in AP mode, and the ESP in STA mode.

CAUTION

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.

Double check that you have correctly entered your WiFi credentials and that said wifi network has a 2.4GHz band.

Additional configuration ​

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.

OTA ​

The firmware supports OTA updates. This means that you can update the firmware without having to connect to the ESPs. To enable OTA updates, you will need to set the enableota to 1. Then, you will need to set the otapassword to the password you wish to use to update the firmware. You will need to use this password to update the firmware. If you do not wish to use a password, you can set the otapassword to nothing. This will allow you to update the firmware without a password. However, this is not recommended, as anyone on your network will be able to update the firmware.

You will also need to set the otaserverip to the IP address of the ESP you wish to update. This is the IP address of the ESP you wish to update. If you are using mDNS, you can use the mDNS name of the ESP you wish to update. For example, if you are updating the ESP with the dns set to http://esp32.local, you will need to set the otaserverip to http://esp32.local.

REST API ​

The firmware also supports a fully featured REST API. This means that you can control the ESPs using a REST API. This feature is enabled by defauly, and can not be turned off.

This feature is used more for advanced users, and is not required for basic operation.

The REST API was developed to be used by our new app (still in development). However, it can be used by any REST API client, you can not send POST requests to the ESPs using a browser though, so some REST API functionality can only be used by tools like Thunder Client or Postman.

The full REST API is documented here.

Environments ​

The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.

Please reference the Firmware Enviroments Page for more information.

Now, move on to uploading the firmware ​

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/environments.html b/firmware_guide/environments.html index f6c8b879..828b6fc5 100644 --- a/firmware_guide/environments.html +++ b/firmware_guide/environments.html @@ -11,14 +11,14 @@ - - + +
EyeTrackVR Docs

Appearance

Firmware Environments ​

What is it? ​

A firmware environment is a way to store the custom firmware config for a specific device. This is useful if you want to have multiple devices with different firmware configs.

We use environments to store the firmware config for each device, so that you can easily switch between them.

Environments are broken up into two distinct parts:

  • The build type (e.g. debug, release)
  • The board type (e.g. espaithinker, esp32cam)

Build Types ​

We now have a couple of options letting us decide how we want to build the firmware.

  • Debug - The debug environment is the default environment and does not need to be specified. It has a lot of logging so it is useful for getting everything setup for the first time and to see what is going on.

  • _release - Has a lot less debugging, may also be missing some things available only in debug for debug purposes, this should be flashed when everything is working.

Examples:
xiaosenses3 - This is the debug environment.
xiaosenses3_release - This is the release environment for daily use.

Tip

We recommend starting with a debug environment, and then switching to release once everything is working. A debug environnement should not be used permanently.

Board Types ​

We currently support for several different boards, and we are working on adding more.

Warning

It is important to note that the esp32AIThinker environment is the default environment. Only switch your environment if you have another board or an environment is not working.

Most esp32Cams from Aliexpress will work with the esp32AIThinker environment, but some may require the esp32cam environment. Test the default environment first, and if it does not work, try the esp32cam environment.

Currently supported boards:

  • esp32AIThinker - This is the default environment. This is for the ESP32-AI-THINKER and generic alibaba/aliexpress/amazon esp cam boards.
  • esp32Cam - This is for the special ESP32-CAM, it is unlikely that you will need to use this environment.
  • esp32M5Stack - This is for ESP32M5Stack.
  • esp32WRover - This is for the ESP32WRover.
  • esp-eye - This is for the ESP-EYE (not the S3 variant).
  • wrooms3 - For FREENOVE-ESP32-S3 (wireless mode)
  • wrooms3QIO - For FREENOVE-ESP32-S3 (wireless mode, for boards with octal flash)
  • wrooms3USB - For FREENOVE-ESP32-S3 (wired mode)
  • wrooms3QIOUSB - For FREENOVE-ESP32-S3 (wired mode, for boards with octal flash)
  • xiaosenses3 - For SeedStudio's XAIO ESP32-S3 Sense (wireless mode)
  • xiaosenses3_USB - For SeedStudio's XAIO ESP32-S3 Sense (wired mode)

You can change the board enviroment by changing the default_envs argument in platformio.ini to a supported board like shown:

GIF showing a switch of board environments.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/firmware.html b/firmware_guide/firmware.html index 955f4fab..72e525f3 100644 --- a/firmware_guide/firmware.html +++ b/firmware_guide/firmware.html @@ -17,7 +17,7 @@
EyeTrackVR Docs

Appearance

What is this? ​

Firmware is the second part of the equation to get your trackers going. It lives on the ESP32 chip, and is responsible for streaming video data from the tracker. We currently fully support wireless streaming over 2.4GHz, and are working on adding support for wired streaming to the main desktop App.

What should I download and where? ​

You can access the firmware, as well as flash your boards, using our new Firmware Flashing Tool.

Caution

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.

This tool relies on our own solution called OpenIris, found here.

Note

You do not need to download OpenIris separately. The flashing tool will download it for you.

To check the status of the project, please visit the Development Road Map

I want to use VSCode - How would I do this?

Follow the steps described here

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/flashing_tool.html b/firmware_guide/flashing_tool.html index f702ba35..6b1d398a 100644 --- a/firmware_guide/flashing_tool.html +++ b/firmware_guide/flashing_tool.html @@ -11,14 +11,14 @@ - - + + -
EyeTrackVR Docs

Appearance

Firmware Flashing Tool ​

What is this? ​

The Firmware Flashing Tool allows you to flash the firmware to your ESPs without requiring VScode. It is a GUI tool that is built using Tauri and SolidJS.

Features include:

  • download pre-built firmware binaries
  • configure firmware settings
  • flash firmware to ESPs
  • open a serial monitor to view the ESPs output for debugging

Note

This tool is currently in beta, and 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.

Flashing Tool ui
Flashing Tool ui lower half

Environments ​

The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.

Please reference the Firmware Environments Page for more information.

Released under the MIT License.

Copyright © 2022-present ETVR

- +
EyeTrackVR Docs

Appearance

Firmware Flashing Tool ​

What is this? ​

The Firmware Flashing Tool allows you to flash the firmware to your ESPs without requiring VScode. It is a GUI tool that is built using Tauri and SolidJS.

Features include:

  • download pre-built firmware binaries
  • configure firmware settings
  • flash firmware to ESPs
  • open a serial monitor to view the ESPs output for debugging

Note

This tool is currently in beta, and 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.

Flashing Tool ui
Flashing Tool ui lower half

Environments ​

The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.

Please reference the Firmware Environments Page for more information.

Released under the MIT License.

Copyright © 2022-present ETVR

+ \ No newline at end of file diff --git a/firmware_guide/mdns.html b/firmware_guide/mdns.html index 98caf6e6..3a906cac 100644 --- a/firmware_guide/mdns.html +++ b/firmware_guide/mdns.html @@ -17,7 +17,7 @@
EyeTrackVR Docs

Appearance

MDNS ​

What is it? ​

mDNS is a protocol that allows you to connect to a device using a name instead of an IP address. This is useful if you do not know the IP address of the device, or if you do not want to keep track of the IP address of the device. This is also useful if you are using a device that does not have a static IP address.

In the mDNS protocol the IP address of the device can change, but the name of the device will always be the same. This means that you can connect to the device using the name of the device, even if the IP address of the device changes.

How to use it ​

Enable mDNS ​

The mDNS is enabled by default on the new firmware, and can not be disabled.

To use it, all you need to do is set the name of the device in the firmware config file.

This setting can be located under the [wifi] section of the ini/user_config.ini file.

ini
mdnsname = "openiristracker" # do not add .local

By default, the name of the device is openiristracker, however you can change it to whatever you want.

Change the name

Since you have two ESP32 devices, you need to make sure that the name of the device is different for each device. If you do not change the name of the device, you will not be able to connect to both devices at the same time.

Connect to the device ​

To connect to the device, you need to use the name of the device followed by .local. For example, if the name of the device is esp32, you can connect to the device using http://esp32.local.

Prerequisites Bonjour ​

Bonjour is required to use the mDNS protocol for windows and mac only. If you are using Windows, you can download Bonjour from here. If you are using macOS, Bonjour is already installed.

You can also get the fully tested Bonjour package from us here (for Windows only).

Troubleshooting ​

Can not connect to the device ​

If you can not connect to the device, make sure that the name of the device is correct. If the name of the device is correct, make sure that the device is connected to the network.

If the device is connected to the network, try to restart the device. If the device is still not connected, try to restart the router.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/rest_api.html b/firmware_guide/rest_api.html index 09f8962e..eee91d24 100644 --- a/firmware_guide/rest_api.html +++ b/firmware_guide/rest_api.html @@ -43,7 +43,7 @@ WIFI_POWER_2dBm = 8,// 2dBm WIFI_POWER_MINUS_1dBm = -4// -1dBm } wifi_power_t;
ParamDescription
txPowerThe power level to set.

Camera Params ​

Coming Soon

We are currently working on this section of documentation.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/setup_vscode.html b/firmware_guide/setup_vscode.html index d9ebe789..e78f15a7 100644 --- a/firmware_guide/setup_vscode.html +++ b/firmware_guide/setup_vscode.html @@ -11,14 +11,14 @@ - - + +
EyeTrackVR Docs

Appearance

Setting up the environment ​

This procedure will show how to prepare your system for uploading the firmware to your tracker.

1. Install Visual Studio Code ​

Download the latest Visual Studio Code and install it.

Download ​


'img'

Install ​


'img'

2. Install the drivers ​

In order to flash the firmware, you'll need some drivers, mainly the CH340 drivers, here's where to get them from:

https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all

3. Install PlatformIO IDE ​

Once Visual Studio Code is installed, open it and install PlatformIO IDE for VSCode, an extension that will allow you to connect to the tracker, build and upload the firmware.

'img'

4. Clone the firmware project ​

Make sure you close any current projects you have open or open a new window before moving forward with these steps.

  1. Go to https://github.com/EyeTrackVR/OpenIris and clone the latest version from the main branch.

    1. If you do not have git installed please install it from here.

    2. Open Git Bash.

'img'
  1. Change the directory to the directory that you want the firmware to be cloned. Ex: cd C:/
'img'
  1. Clone the repository by entering the command: git clone https://github.com/EyeTrackVR/OpenIris.git
'img'

For more info about cloning please refer to this documentation

Do not download as a zip - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.

  1. Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to OpenIris/ESP folder and opening it.
'img'

This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team adapted from here

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/update_platformio.html b/firmware_guide/update_platformio.html index 0fa30b1c..9aad08ac 100644 --- a/firmware_guide/update_platformio.html +++ b/firmware_guide/update_platformio.html @@ -11,14 +11,14 @@ - - + +
EyeTrackVR Docs

Appearance

Updating Platformio ​

Sometimes, when building and uploading the firmware, you may run into bizarre, even-though the code is correct - platformio will refuse to build and instead will complain with some weird error.

It usually means that either PlatformIO, or ArduinoSDK got and update and that's the moment when this guide may come in handy.

Updating PlatformIO itself ​

There are two ways to update your platformio installation

Via CLI ​

You can update it easily by simply typing in one command into your terminal.

pio upgrade command in the terminal
  1. Open a terminal / command prompt
  2. Type pio upgrade and press enter
  3. Wait for it to finish
  4. Done

Via PlatformIO in Visual Studio Code ​

You can also update it using the platformio tab in your Visual Studio Code.

  1. Open VSC
  2. Click on that little and icon on the sidebar
Platformio logo button
  1. A side panel will open, there will be a couple of sections, one of them called Quick Access, open it.
Platformio logo Quick Access Section
  1. In Quick Access section, click on the Miscelleneous tab
Platformio miscellaneous section
  1. Then, click on the Upgrade PlatformIO Core
Platformio upgrade core button
  1. Wait for it to finnish and done!

Upgrading the SDK ​

You'll also need to upgrade the SDK from timem to do this

Upgrading the SDK via VSC ​

  1. Follow the guide above up until clicking on the Quick Access section.
  2. Instead, open the PIO Home and select Open
Platformio open home
  1. This will open a window for PlatformIO dashboard, in there, click on a Platforms button on the sidebar
Platformio platforms sidebar
  1. Once there, you should see a couple of tabs next to the side bard, things like Installed or Embedded. Click on Updates
Platformio platforms sections
  1. Locate a platform called Espressif 32 and click on Update to <version>
Platformio platforms update view
  1. Wait until it is done and that's it!

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/firmware_guide/upload_and_update_firmware.html b/firmware_guide/upload_and_update_firmware.html index c66e4bd9..103b8c66 100644 --- a/firmware_guide/upload_and_update_firmware.html +++ b/firmware_guide/upload_and_update_firmware.html @@ -12,8 +12,8 @@ - - + + @@ -23,7 +23,7 @@ otaserverip = "openiristrackerL.local" # here we use a custom mDNS name otapassword = "12345678" otaserverport = 3232
  1. Change to OTA env

To do that, in visual studio code, locate the uplaod button, next to it will be listed a couple of buttons and your current environment.

For example, if you have a working esp32AIThinker environment, you would change your environment to esp32AIThinker_OTA.

Click on it.

'An example of how the popup list of envs looks like'

This will open a list of all available environments, select the one that matches your board and has a _OTA suffix

'An example of how the button for selecting env looks like'
  1. Restart the ESPs, they must be power cycled
  2. Press the upload button to upload the firmware.

    img
  3. Do not touch esps or move them during OTA upload
  4. Wait around 1 minute.
  5. Repeat for as many trackers as you need.

Finding the IP address of your tracker ​

Connect your tracker to your PC and then open a serial monitor in VSC by pressing the plug icon.

'platformio serial monitor button'

Now, press the restart button on the esp itself. watch the monitor for output like this:

'img of platformio serial monitor'

The text, highlighted in green for demonstration, is the stream address of the camera. Take note of this for input into the software.

Keep in mind while testing and getting set up, the ESP can only have one client, to use the camera in the app, make sure you close the browser tab you tested it in.

Updating the firmware to the newest version ​

To update the firmware you'll need to follow a couple of steps.

  1. Open a terminal and enter the directory you've cloned OpenIris into, for example cd C:/OpenIris/

  2. Save your current changes to the config using git stash

  3. Download the newest changes from the repo using git pull

  4. Apply your saved changes so that you don't have to retype your WI-FI credentials using git stash apply

CAUTION

Skip this step if the update message denotes that the config had changed. If it does so, retype your credentials in the updated files.

4.1. If anything went wrong, you can reset everything to the default state using git reset --hard and then retyping your credentials

  1. Upload your firmware following steps from the uploading section

Troubleshooting ​

If you encountered an issue while following these steps check the FAQ.

If you don't find an answer to your question there ask in #questions channel in the discord, we will be happy to help.

Adapted from the SlimeVR docs, Some Credit goes to the SlimeVR team here

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/getting_started/intro.html b/getting_started/intro.html index c7865954..701c74c6 100644 --- a/getting_started/intro.html +++ b/getting_started/intro.html @@ -12,14 +12,14 @@ - - + +
EyeTrackVR Docs

Appearance

EyeTrackVR ​

Open source and affordable VR eye tracker platform for Social VR Games via OSC and UDP protocol.

Want to get started? Check out the getting started page and then the full build guide.

CAUTION

This project is in active development. However, it is working for most users.

About IR Emitter Safety ​

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.

DANGER

It is important that you DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE. This can result in irreversible bodily harm.

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.

WARNING
Please pay attention

Make sure you are using non-focused emitters and no more than 5 mW/sr total power.

Want to see the safety data sheets?

Effect of infrared radiation on the lens

AN002_Details on photobiological safety of LED light sources

Training-library Nir Stds

ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)

Hardware ​

Please check out our parts list and hardware repo. for information regauring hardware.

Firmware ​

Our firmware called OpenIris is made by lorow found here.

Headset support ​

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 3d printable mounts 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.

Contact ​

Please join our discord for updates and any questions. We hope to see you there!

'discord banner'

Licenses ​

GitHub license

All software is under the MIT License. All documentation, including the Wiki, is under the Creative Commons CC-BY-SA-4.0 license.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/getting_started/led_safety.html b/getting_started/led_safety.html index da8a52b1..49a224d3 100644 --- a/getting_started/led_safety.html +++ b/getting_started/led_safety.html @@ -18,7 +18,7 @@
EyeTrackVR Docs

Appearance

About IR Emitter Safety ​

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.

DANGER

It is important that you DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE. This can result in irreversible bodily harm.

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, excessive eye-strain 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.

What we care about: ​

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.

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) 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.

It is known that when outside and not directly looking at the sun, your eyes get exposed to about 1 mW/cm2 or IR radiation. This is the target I set for hardware generally.

NOTE

This math is assuming the LED is directly in front of your pupil, and your pupil is not moving. In real world this is not the case. We have multiple LEDs around your eye, and your eye moves. When you look to the side, your pupil is not receiving all of the light from all LEDs and the distance grows as well. Properly calculating for this is hard and not worth the time. I chose to show that the "worst case scenario" is still well withing safety margins.

V3 Hardware Safety Outline and Exposure Numbers: ​

For all of this math we will assume the "worst" to ensure we are well within safety.

if powered with 5V, using 700 ohms of resistance, V3 Hardware will draw 0.00314... Amps. We will round up and convert this to 3.2mA.

(5V - 1.4V - 1.4V) / 700 ohm = 0.00314 ≈ 3.2mA

The LED datasheet lists the intensity at 20mA to be a minimum of 2 and max of 5. We will assume the worst and use 5mW/sr.

5 mW/sr * (3.2mA / 20mA) = 0.8 mW/sr

Now, we need to account for distance. My number is based on a worst case scenario of 1cm of distance. (typically is is higher on average.) We convert 1cm to 1cm2/sr

0.8 mW/sr / 1cm2/sr = 0.8 mW/cm2

Now, this is only for 1 LED, in the case of V3 we have 2 so we can:

0.8 mW/cm2 * 2 = 1.6 mW/cm2

This value is well below the limit, and close to normal sun exposure outside. If the LEDs were further than 1cm (which they typically are) the exposure would be even less.

V4 Hardware Safety Outline and Exposure Numbers: ​

For all of this math we will assume the "worst" to ensure we are well within safety.

V4 hardware is actively limited to ~2.4 mA

The LED datasheet lists the intensity at 20mA to be a minimum of 2 and max of 5. We will assume the worst and use 5mW/sr.

5 mW/sr * (2.4mA / 20mA) = 0.6 mW/sr

Now, we need to account for distance. My number is based on a worst case scenario of 1cm of distance. (typically is is higher on average.) We convert 1cm to 1cm2/sr

0.6 mW/sr / 1cm2/sr = 0.6 mW/cm2

Now, this is only for 1 LED, in the case of V4 we have 4 so we can:

0.6 mW/cm2 * 4 = 2.4 mW/cm2

This value is well below the limit, and not far from sun exposure. If the LEDs were further than 1cm (which they typically are) the exposure would be even less. And with typical eye movement they are less.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/getting_started/things_to_know.html b/getting_started/things_to_know.html index 236c6aaa..9f4a1a9c 100644 --- a/getting_started/things_to_know.html +++ b/getting_started/things_to_know.html @@ -17,7 +17,7 @@
EyeTrackVR Docs

Appearance

Things To Know Before You Start ​

This page will be 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. Do not expect 100% reliable and perfect function. Not all features are fully developed yet.

Firmware may have user difficulties ​

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.

Documentation may be incomplete ​

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

Once you have acknowledged the items above, move on to the Full Build Guide ​

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index b2080853..2ac78d0c 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"misc_faq.md":"314d6845","firmware_guide_update_platformio.md":"af6d4d76","contact.md":"c2e94634","dev_roadmap.md":"e0297856","development_docs_dev_docs.md":"c7de805c","development_docs_pages.md":"ec947cc8","development_docs_standards.md":"20a7ac2c","firmware_guide_configure_firmware.md":"7852fa9f","firmware_guide_environments.md":"5499e526","firmware_guide_firmware.md":"2745189a","firmware_guide_flashing_tool.md":"52fe420e","firmware_guide_mdns.md":"7fbdf94c","firmware_guide_rest_api.md":"4fe3ee89","firmware_guide_setup_vscode.md":"bc9620d8","misc_vrc_avatar_setup.md":"e817a3ae","how_to_build_full_build.md":"b9c84c14","getting_started_intro.md":"193e8e8d","software_guide_build_software.md":"067d21a0","software_guide_eyetrackvr_app_guide.md":"7beed7fa","software_guide_osc_setup.md":"5969c73c","firmware_guide_upload_and_update_firmware.md":"1076bd51","index.md":"0b651dfd","archive_fox_ir_v2_build_instructions.md":"b320b3b5","how_to_build_creating_your_own_mount.md":"3ddf5184","about.md":"e87a2ce6","how_to_build_parts_list.md":"aba29938","getting_started_things_to_know.md":"b44e9a98","getting_started_led_safety.md":"694b59dc"} +{"dev_roadmap.md":"e0297856","how_to_build_parts_list.md":"aba29938","index.md":"0b651dfd","misc_faq.md":"314d6845","misc_vrc_avatar_setup.md":"e817a3ae","software_guide_build_software.md":"067d21a0","software_guide_eyetrackvr_app_guide.md":"2f90c236","software_guide_osc_setup.md":"da0e63a0","development_docs_dev_docs.md":"c7de805c","how_to_build_full_build.md":"af5219a2","how_to_build_creating_your_own_mount.md":"3ddf5184","getting_started_led_safety.md":"694b59dc","firmware_guide_firmware.md":"2745189a","firmware_guide_configure_firmware.md":"04dc1dcd","archive_fox_ir_v2_build_instructions.md":"a1e531db","firmware_guide_flashing_tool.md":"6ad5e454","firmware_guide_environments.md":"d5d0818e","firmware_guide_rest_api.md":"4fe3ee89","firmware_guide_setup_vscode.md":"6234c70e","firmware_guide_mdns.md":"7fbdf94c","firmware_guide_upload_and_update_firmware.md":"faf8113d","development_docs_standards.md":"20a7ac2c","firmware_guide_update_platformio.md":"f1f0be3e","about.md":"e87a2ce6","getting_started_things_to_know.md":"b44e9a98","contact.md":"c2e94634","development_docs_pages.md":"ec947cc8","getting_started_intro.md":"4c4c39e8"} diff --git a/how_to_build/creating_your_own_mount.html b/how_to_build/creating_your_own_mount.html index 1dc441f7..3d695920 100644 --- a/how_to_build/creating_your_own_mount.html +++ b/how_to_build/creating_your_own_mount.html @@ -17,7 +17,7 @@
EyeTrackVR Docs

Appearance

Creating Your Own Mount ​

This page will include a basic rundown on how to create your own camera mount for a headset that may not have any existing community mounts ​

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 ​

The easiest way to get started is to find a lens protector for your headset. Either go to a website like Thingiverse or just 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

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

Alternatively, you can create your own mount if you have the skills.

Step 3: Place the camera mount where it will give a good camera angle ​

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. I recommend looking at other headset mounts for inspiration.

Step 4: Mount your LEDs ​

You can either add parts to your mount for holding the LED boards or just glue them on. It's up to you and what works best for you, experiment!

Step 5: Test everything ​

It is unlikely you will get a perfect mount on the first try. Print, test, adjust, and repeat until you have a satisfactory mount. Good luck!

Step 6: Get your mounts listed ​

Send me the mount to be added to the docs here! You can upload it to Thingiverse or similar services, or just send me the .STLs via discord (Prohurtz#0001)

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/how_to_build/full_build.html b/how_to_build/full_build.html index abcd49ef..2d993895 100644 --- a/how_to_build/full_build.html +++ b/how_to_build/full_build.html @@ -13,14 +13,14 @@ - - + +
EyeTrackVR Docs

Appearance

Build Guide ​

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 LED Solderless assemblly rough edit:

Sketch of V4 solderless wiring:

Sketch of V4 wiring

Credit: @seniorpringles, @g0ldjay via Discord

Sketch of solder assembbly of V4:

Sketch of V4 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 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 ​

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.

Step 3: Wait for things to arrive ​

Long shipping times from China are f u n. Please allow anywhere from 2 weeks to 2 months for everything to arrive.

Step 4: Gather up all of your hardware ​

Make sure you have at least the following:

'img of components'

'ESPs, cams, a programmer and a USB connector'

Step 5: Install external antennas or shield ESP antenna with an antistatic bag ​

Some ESP-CAM boards have issues with signal integrity, there are 2 things you can do to help/solve the issues.

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.

'img of external antenna'

Image from: https://randomnerdtutorials.com/esp32-cam-connect-external-antenna

Below is an example of bridging the connections and attaching an antenna.

'img of external antenna resistors'

The second option is to cover the ESP's antenna with an antistatic bag. This can help aid problems, and can completely solve them in some cases. Best of all, it is completely free! However, it should be noted that it performs worse than an external antenna and in certain cases will not solve the issue like if you have Vive trackers.

Step 6: Attach cameras to ESPs ​

Look at your ESP and locate the camera ribbon cable connector as circled below.

'img of camera socket'

Flip the gray part up to allow the cameras to be connected. Do not force it, or shove objects into it to open, fingernails are fine.

'img of camera clip'

Now slide in a camera, please note that the pins are facing down, you should only see the black part.

'img of camera cable'

Once the camera has been slid in, press the gray part of the connector back down. There will be a small amount of force but still be gentle. Note the ammount of black coming out of the connector.

'img of camera cable'

Step 7: Connect ESP to the programmer to flash ​

Why flash before you have it assembled? It's simple, to make sure they actually work before you spend time soldering to them.

Slide your ESP into the programmer, and note the USB port goes away from the ESP's camera.

Step 8: Configure Visual Studio Code and prepare to flash the firmware ​

Check out our guide on Setting up VS Code

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 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.

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. Here I used speaker wire where the copper denotes positive and silver negative. Then, strip the wires to about 3mm of exposed wire.

Step 11: Cut wires for IR LEDs ​

To find the optimal length, take a piece of wire and a marker and mock up your wire route, and mark the wire, cut it, then make another at the same size for the other eye. You will need 3 different cuts of wire. 2 short ones for connecting the 2 PCBs per eye together, 2 Longer ones for power, or ground and 2 slightly longer ones for power or ground for the LED near the camera at the bottom.

Once cut, strip them to around 4mm of exposed wire.

Step 12: Twist the positive USB wire and positive IR LED wires together and tin them ​

Once twisted together add solder to keep them together. This makes the connection much easier.

Step 13: Solder the positive wire to ESP ​

Lay the wire on the outside of the 5V pin and apply solder.

Step 14: Solder the negative wire to ESP ​

Repeat Step 12 but with the negative wires.

INFO

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.

Step 15: Wire up the 2nd ESP ​

Repeat steps 12-14 with the 2nd ESP.

Step 16: Prepare to solder IR LED PCBs ​

Get your magnifying glass out, it's time to solder very smol things.

Gather 4 PCBs, 4 IR LEDs, and either 4 ~350ohm.


357ohm resistors and V3 PCBs

Here are the PCB pin-out labels:


V3

LED labels:


The green markings and notched corners mark the positive sides of the LEDs pictured above.

If you have different LEDs, please consult their datasheet.

Some terminology related to them:

5V: 5-volt power in.

GND: Ground or power out.

AR: After-Resistor this is to be used as the power in on the 2nd PCB in series as resistors are not needed on the 2nd PCB since they are on the 1st one.

SNG: Single resistor, use this as 5V in if you are using only 1 ~700ohm resistor on V3 boards (not recommended).

Negative: This marks the negative side of the LED.

Positive: This marks the positive side of the LED.

Step 18: Solder resistors on PCB V3 ​

You only need 1 PCB to have resistors per eye.

Tin the resistor pads. Note: in this example, I use too much solder, it should only be enough to lightly cover the pad.

Next, grab a resistor and hold it on the pads.

While holding the resistor add solder to your soldering iron and apply it to the resistor.

I like to do this by having a piece of my solder stick up in the air and then put it on my iron that way.

Flip the PCB and solder the other end.

Now repeat for the other one.

Solder LEDs on PCB V3 ​

Tin the LED pads.

Orientate the LED and hold it in place.

Solder one end.

Flip around and solder the other end.

Wire up the PCBs V3 ​

WARNING

Pay attention to the direction of the LEDs on the PCBs.

If the green dot is facing inwards toward the text like in the picture below:

Use the following diagram:

If the green dot is facing away from the text like the picture below:

Use the following diagram:

Step 19: 3D print mounts ​

Head to the 3D printed parts section of the parts list here.

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. If none work, try making an edit yourself if you have the skills. If you have made a mount make sure to ping me, Prohurtz#0001, so I can add them to the list.

Having trouble getting them to fit? Try resizing the mounts up, or down a little to ensure a good fit.

There are 2 different types of mounts, how to secure the camera to each type will be documented below.

Type 1 ​

This uses a method of sliding in the camera. Generally, this is the recommended mounting method as it generally requires no glue.

Place the camera into the mount

Slowly apply pressure inwards until the camera snaps into place.

NOTE

There is a good chance of breaking the mount when putting in the camera. If this happens you may be able to save the mount depending on where the break was. A small dab of hot glue around the camera is likely all that is needed.

Type 2 ​

This uses the method of gluing the camera.

Apply a bit of glue to the bottom of the camera mount.

Place the camera on the mount.

IR LED mounting ​

This again differs from mount to mount.

In some cases, there are designated spots for the LEDs to go.

In others there are no specified spots, you will have to mess around to find what works best. This image shows the optimal/near-optimal position for the LEDs. Hot glue is your friend with this.

TIP

Use rubbing alcohol to easily remove hot glue.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/how_to_build/parts_list.html b/how_to_build/parts_list.html index 4912f42e..80065c4c 100644 --- a/how_to_build/parts_list.html +++ b/how_to_build/parts_list.html @@ -19,7 +19,7 @@
EyeTrackVR Docs

Appearance

Parts List ​

CAUTION

Please note that no hardware has been fully set in stone, all purchases are at your loss if hardware changes.

NOTE

It is good practice to buy more than needed in some cases, namely cameras,programmers and ESPs. This reduces the risk of a DOA (dead on arrival) causing a delay.

ESP setup options: ​

DANGER

There are two primary categories of trackers supported: wireless and wired. It's super important that you really look at all your options and consider your use case before making a decision.

Option 1: Wireless over WiFi 2.4 GHz ​

This offers a good starting point as the ESP boards are cheaper than wired capable trackers. However, they can be a bit more temperamental and if you are using a wired headset, they start to make less sense.

Pros:

  • Wider user adoption and greater support
  • Low weight, less cables, easier to manage

Cons:

  • Requires two external antennas for optimal streaming quality
  • Requires WiFi 2.4 GHz router or access point in reasonable proximity
  • Risk of radio interference with FBT and other WiFi 2.4 GHz devices
  • ESP32-CAM uses more power and heats up due to radio module power needs

Option 2: Wired over USB Serial (in beta) ​

This is our latest setup recommended for users with wired headsets such as the Valve Index.

Pros:

  • Much better performance and higher framerates up to 70 FPS with lower latency
  • No conflicts with advanced FBT setups such as Vive or Tundra Trackers
  • Can be wireless or wired
  • Less soldering required

Cons:

  • Requires USB port i.e. on Valve Index and USB hub mounted on your headset
  • Can be more costly

Required parts ​

With that in mind, here are the required parts for the setup.

Tracker boards: ​

    • 2x XIAO ESP32-S3 Sense Modules
      Very small size, wireless and wired support, does not require an additional programmer or separate antennas: SeedStudio

    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

  • A cheaper, wireless only alternative: ​

    • 2x ESPCAM32 Modules - They are cheaper, requires a separate programmer board, supports only wireless streaming and may require some soldering for attaching separate antennas: AliExpress
      This board also requires a special programmer board in order to flash the firmware. You'll need only one: AliExpress for just programmers or Amazon for 3 ESP32-Cams and programmers without the proper cameras

    • 2x External antennas for ESPs Required if you're running vive/tundra full body tracking or having issues with streaming. See the full build guide on how to configure the ESP board for antenna use.

Cameras ​

Camera modules: ​

The cameras that come with the boards will not work, they have an IR filter inside.

The filter can be removed, but doing so may break your cameras. Here's how to do it: https://www.youtube.com/watch?v=QYH-FWvDbDc

DANGER

If you decide to remove the filter, wear eye protection while doing so, the removal of the filter will shatter it.

  • 2x OV2640 160° FOV IR / Night vers 75mm (850nm) ​

AliExpress

Amazon alternative (note that you will have to manually remove the IR filter)

Things worth noting:

  • There is an experimental option to purchase OV2640 120° FOV cameras and manually remove the IR filters. This can result in a clearer view of the eye, but it's not a default recommendation.

  • 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.

  • Optional Ribbon extensions: ​

Certain mounts may require a cable extension (ex: MUTE's frunk mod) To use a mount like that you will need a cable and a connector for each camera. Headsets like the Quest 2 do not require extensions if the camera boards are mounted at the bottom of the headset, near the facial interface.

Extensions (select 0.5mm pitch type A) AliExpress (200mm for MUTE's)

Connectors (select 24P) Aliexpress

USB Hubs - for if you are building the wired version ​

  • 1x USB 3.0+ hub Ensure that it is of good quality, lightweight, compact in size, and I suggest including 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.

  • 2x USB C cables (as short as possible) to connect both ESPs As the ESP32-S3 has USB-C connectors, you may require some USB-C to USB-A cables depending on your USB hub. It's worth noting that the HTC Face Tracker requires a USB-C port, so you may need to consider this requirement as well.

Wires and adapters ​

IR emitters ​

We recommend getting the official kits:

Alternatively you can source the parts for V3 yourself: ​

DANGER

If they look like something you would find in a TV remote, do NOT use them. Even if you think you can alter them THEY WILL NOT WORK AND PUT YOU AT RISK. If you aren't exactly sure what you are doing, buy them from the LCSC or Digikey link.

DO NOT BUY FOCUSED ONES!

  • 4x Unfocused SMD IR emitters

    NOTE

    The smaller ones can not be soldered at temps above 245C or they will burn. Low temp solder is recommended.

  • 4x IR emitter PCBs (highly recommended) Gerber files and schematics located here.

  • 4x 350ohm 1206 SMD resistors for IR emitters (If you are not using PCBs for the emitters then buying regular through-hole resistors is acceptable)

  • 357 ohm Digikey here

  • 348 ohm LCSC here

This ensures you get the correct IR emitter parts. If you are a Patreon please check out discount codes available to you, and also check out unit pricing.

3D Printed Mounts ​

Mounts with a ★ next to them are the recommended mounts for the respected hmd. This is based on user feedback on what works best for most people.

NOTE

You'll need both - a mount for the IR emitters and a mount for the camera boards, some files include both, some don't.

Misc parts/tools ​

AliExpress (Generic)
Amazon (Generic)

  • 2x-4x Heatsinks (Optional) - for the ESP32-CAM AliExpress (14mm for ESP, 8mm for voltage regulator)

Other Headsets ​

If you own another headset not listed above, that means there are no mounts designed for them yet. If you have basic skills in modeling or think up a solution to mount cams and emitters, please try to make a mount and then let us in the discord know so it can be added here. Any headset that can fit the camera is potentially compatible. If you are willing, give it a shot to design a mount for the rest of the community.

Check out our basic guide on making your own mount here.

TIP

If you have a headset mount that is not listed above, please let us know in the discord so it can be added here.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/index.html b/index.html index 9405ef15..342e1a2b 100644 --- a/index.html +++ b/index.html @@ -18,7 +18,7 @@
EyeTrackVR Docs

Appearance

EyeTrackVR Docs

Open-source and affordable VR eye tracking.

For Social VR Games via OSC and UDP protocol.

Get Started
View on GitHub
ETVR logo
⚡️

Open Source

fully open source and free to use.

🎉

Community Driven

built by you for you.

💰

Affordable

affordable and easy to use.

🎮

Nearly All VR Headsets

EyeTrackVR works with nearly all VR headsets.

🔨

Completely DIY

completely DIY and easy to build.

🌐

Open Platform

open platform and works with any Social VR game.

🔏

Privacy Focused

privacy focused and does not collect any data, hosted on your own PC.

📡

Open Protocol

EyeTrackVR uses the Open Sound Control (OSC) protocol.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/misc/faq.html b/misc/faq.html index caba43be..df004627 100644 --- a/misc/faq.html +++ b/misc/faq.html @@ -18,7 +18,7 @@
EyeTrackVR Docs

Appearance

Frequently Asked Questions ​


Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/misc/vrc_avatar_setup.html b/misc/vrc_avatar_setup.html index ada48035..6de822e0 100644 --- a/misc/vrc_avatar_setup.html +++ b/misc/vrc_avatar_setup.html @@ -18,7 +18,7 @@
EyeTrackVR Docs

Appearance

How to set up your avatar for eye tracking: ​

Here is an avatar setup video created by a contributor:

Another good resource is the VRC Face Tracking Wiki and their Discord.

We currently use the following paramaters ​

LeftEyeX

RightEyeX

EyesY

LeftEyeLidExpandedSqueeze

RightEyeLidExpandedSqueeze

NOTE

We currently only support float parameters, please adjust your setup accordingly.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/software_guide/build_software.html b/software_guide/build_software.html index b3d01062..b4ffbe77 100644 --- a/software_guide/build_software.html +++ b/software_guide/build_software.html @@ -19,7 +19,7 @@
EyeTrackVR Docs

Appearance

Build the app from source ​

This guide will show how to build the app from source ​

NOTE

This is NOT a required step, you do not need to build the app from source.

Requirements ​

Install Python ​

EyeTrackVR is currently using Python 3.11.0 Before you continue, please install it.

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.

To install Poetry open Windows Powershell and run the following command (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Poetry Documentation

Install the required Python modules ​

After cloning the project and installing Poetry, open a command prompt in the EyeTrackApp folder. Then run the command: poetry install

This should install all of the required modules.

Build the app ​

Now, you should be ready to build the app. With a command prompt open in the EyeTrackApp folder, run the command poetry run pyinstaller eyetrackapp.spec

Give it time to build the app. Once done, the app should be under dist/eyetrackapp

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/software_guide/eyetrackvr_app_guide.html b/software_guide/eyetrackvr_app_guide.html index 24f3087c..e789ecaf 100644 --- a/software_guide/eyetrackvr_app_guide.html +++ b/software_guide/eyetrackvr_app_guide.html @@ -12,14 +12,14 @@ - - + +
EyeTrackVR Docs

Appearance

How to install, run and adjust the EyeTrackVR app. ​

Step 1: Download the EyeTrackVR Installer and install the EyeTrackVR app ​

Go to the latest GitHub release here and download the Setup.exe file.

Follow the prompts and the app should be installed.

Step 2: Run the EyeTrackVR app ​

If the Create Desktop Shortcut option was checked you should see an icon on your desktop, double click it to run.

You then should be greeted with a GUI that looks like this:

'img'

Step 3: Getting familiar with settings and terminology ​

Let's go over some basic terminology you will find in the app.

Starting from the top:

Right eye ​

Shows the right eye feed and settings only.

Left eye ​

Shows the left eye feed and settings only.

Both eyes ​

Shows both eyes' feed and settings.

Camera Address ​

This is where you enter the IP address of your camera. Alternatively, it can be used to put the cam number for wired cameras or pass in a video file.

Tracking Mode ​

This changes the GUI to the tracking mode where it outputs values.

Cropping Mode ​

This is where you will crop out your eye.

Threshold ​

This is used to cut out things that aren't dark like your pupil.

Rotation ​

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 ​

This will start a calibration mode for your eye where you look to all extremes.

Recenter Eye ​

This will recenter your eye to whatever point you are looking at.

Step 4: Adding your cameras to the software and configuring them ​

Wireless configuration ​

Power your ESPs and find what the IP address is for your right eye. This can be done by opening both Cameras in a browser and then holding your finger over your right eye camera.

Copy that IP address and then close the browser tab with it open.

Enter that IP address into the app's Camera Address field.

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.

Enter that COM port number into the app's Camera Address field.

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.

'img'

See the Awaiting Eye Cropping Settings text?

Now press the Cropping Mode button. You should see a feed of your camera.

Put your headset on and use an application to see your desktop. (Virtual desktop, SteamVR desktop, etc.)

You should see something like this:

'img'

:O It's my eye!

Now, Draw a rectangle that selects your eye.

A good example of an ROI

'img'

Head back over to the Tracking mode.

We will now adjust our rotation by moving the Rotation slider.

From this:

'img'

It's crooked!

To this:

'img'

Much better!

Now we will adjust our threshold.

Continuing with your headset on, move the slider all the way up. start slowly backing it off until mainly only your pupil is being visualized in the threshold viewer.

Example of a threshold being too low:

'img'

Much better!

Example of too high of a threshold:

'img'

Much better!

Example of a good threshold:

'img'

Much better!

Repeat everything in this step for your left eye.

Step 5: Calibrating your eyes ​

Once your eye is trackable by the software we need to calibrate it.

Press the Restart Calibration button and look around. The important part is that you look to all extremes, all the way up, left, etc. Once you have done so, wait for the Mode to say Tracking

The next step is to center your eye.

Look straight forward and press the Recenter Eye button.

Your eye is now fully calibrated.

Repeat for your other eye.

NOTE

To best center both eyes, look at one spot and hit the 'Recenter Eye' button for each eye without moving your eyes.

See anything outdated on this guide? Let me know! Prohurtz#0001 ​

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file diff --git a/software_guide/osc_setup.html b/software_guide/osc_setup.html index 13fb0fe0..8cdf19a1 100644 --- a/software_guide/osc_setup.html +++ b/software_guide/osc_setup.html @@ -12,14 +12,14 @@ - - + +
EyeTrackVR Docs

Appearance

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.

NOTE

Note, while this page explains how to do it from the point of view of vrchat, it can be done in Neos and CVR too, all the app listens to are two OSC messages.

Setting up your parameters ​

Adding parameters ​

You'll need to add two parameters to your Parameters config, those being:

  • etvr_recalibrate: Bool
  • etvr_recenter: Bool

Both of them do not have to be synced, meaning they won't increase your total memory count.

To do this, in Unity, select your avatar on the scene and find Avatar Descriptor in the inspector. In it, find the section named "expressions", expand it and click on the file assigned to the "parameters" field, that's your Parameters config.

Screenshot showing expressions section of vrc avatar descriptor

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.

Screenshot showing adding parameters to parameter menu
Screenshot showing the params that need to be added

That's it for the parameters.

Adding buttons to the menu ​

Now, you will need to add actual buttons for them in your gesture menu.

The expressions section mentioned above also contains the menu, you can use that to either add the buttons there directly or create a small submenu to make it less cluttered, here we will add them directly.

Screenshot showing expressions section of vrc avatar descriptor

Once you have the menu file opened in the inspector, click on the "add control" button. This will add an empty action slot, expand it.

Screenshot showing the the empty controls field

You'll see a bunch of fields, like name, icon, type and parameter. Firstly, let's give it a friendly name like "recalibrate eyes" or "recenter tracking" depending on the action you want to assign to them.

Leave the type as is - as a button, it's more convenient as it bounces back into the off state by itself.

Now, in the parameter section, click on the [None] and select one of the parameters you have created in the previous section.

Screenshot showing the the controls setup

Repeat the steps for the other one.

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 ​

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.

They are stored under

C:\Users\<user>\AppData\LocalLow\VRChat\VRChat\OSC\<your user uuid>\Avatars\

Deleting the contents of the Avatars directory will resolve the issue.

Other platforms ​

Like mentioned in the note, this functionality is not limited to VRC.

The app itself listens to OSC messages sent on port 9001 to two addresses:

  • /avatar/parameters/etvr_recenter
  • /avatar/parameters/etvr_recalibrate

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.

Released under the MIT License.

Copyright © 2022-present ETVR

- + \ No newline at end of file