Skip to content

Commit 87827be

Browse files
SummerSighSummerSigh
committed
Fix formating
1 parent 4394f35 commit 87827be

12 files changed

+280
-70
lines changed

‎docs/hardware/components/cameras.mdx

+27-17
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,37 @@
1-
# Cameras
1+
## Cameras
22

33
Although any camera can be used with Project Babble, the tracking quality can vary greatly depending on a variety of factors such as lighting, camera angle, camera framing, and field of view. If you decide to build something with your own components, please keep the following example of a “good image” in mind.
44

5-
Below is an example of a good image.
5+
Below is an example of a good image:
6+
67
- Plenty of even lighting on the face that doesn’t change from the environment (Visible or Infrared)
78
- Balanced field of view with an acceptable amount of distortion (120/130 deg)
89
- Camera is horizontal with the mouth
910
- Little to no artifacts (noise, strobing, etc.)
1011

1112
We recommend esp32 based openiris trackers with 120-160 degree lenses.
1213

13-
The cameras that come with the boards can work, they however have an IR filter inside which will need to be removed if you use infrared lighting.
14-
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
15-
DANGER
16-
If you decide to remove the filter, wear eye protection while doing so, the removal of the filter will shatter it.
17-
1x OV2640 160° FOV IR / Night vers (850nm) (In firmware cropping recommended)
18-
AliExpress
19-
Alternatively:
20-
1x OV2640 120° FOV (Requires manual ir filter removal)
21-
AliEXpress
22-
Alternatively:
23-
1x OV2640 130° FOV (Requires manual ir filter removal)
24-
AliEXpress
25-
Amazon alternative (note that you will have to manually remove the IR filter)
26-
Things worth noting:
27-
Some mounts may use a camera with a longer connector than the standard short one. Keep that in mind when selecting a camera to order (Physics Dude's Index mount for example).
14+
The cameras that come with the boards can work, they however have an IR filter inside which will need to be removed if you use infrared lighting. The filter can be removed, but doing so may break your cameras. Here's how to do it: [IR filter removal tutorial](https://www.youtube.com/watch?v=QYH-FWvDbDc)
15+
16+
**DANGER:** If you decide to remove the filter, wear eye protection while doing so, the removal of the filter will shatter it.
17+
18+
### Recommended Cameras:
19+
20+
1. 1x OV2640 160° FOV IR / Night vers (850nm) (In firmware cropping recommended)
21+
- [AliExpress](https://www.aliexpress.com/)
22+
23+
**Alternatively:**
24+
25+
2. 1x OV2640 120° FOV (Requires manual IR filter removal)
26+
- [AliExpress](https://www.aliexpress.com/)
27+
28+
**Alternatively:**
29+
30+
3. 1x OV2640 130° FOV (Requires manual IR filter removal)
31+
- [AliExpress](https://www.aliexpress.com/)
32+
33+
**Amazon alternative (note that you will have to manually remove the IR filter)**
34+
35+
### Things worth noting:
36+
37+
- Some mounts may use a camera with a longer connector than the standard short one. Keep that in mind when selecting a camera to order (Physics Dude's Index mount for example).

‎docs/hardware/components/lights.mdx

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1-
#Lighting
1+
## Lighting
22

3-
For Babble you can use Infrared or visible light. Infrared is less distracting as you can’t see the light but it is susceptible to flicker from base stations if it’s not bright enough. Visible is immune to base station flicker but can potentially be distracting if your headset doesn’t block light too well.
3+
For Project Babble, you can use either Infrared or visible light. Each has its advantages and considerations:
4+
5+
- **Infrared Lighting:**
6+
- Less distracting as the light is not visible to the naked eye.
7+
- Susceptible to flicker from base stations if not sufficiently bright.
8+
9+
- **Visible Lighting:**
10+
- Immune to base station flicker.
11+
- Potential for distraction if the headset doesn't block light effectively.
12+
13+
Consider these factors when choosing the type of lighting for your setup.

‎docs/hardware/components/mounts/generalESPMounts.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# General ESP32 mounts
2+
3+
4+
5+

‎docs/hardware/components/trackerBoards.mdx

+31-14
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
1-
# Tracker Boards
1+
## Tracker Boards
22

3-
Recommended
4-
1x XIAO ESP32-S3 Sense Modules
5-
Very small size, wireless and wired support, does not require an additional programmer or separate antennas: SeedStudio
6-
Alternatively:
7-
1x Freenove ESP 32-S3 WROOM
8-
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
9-
A cheaper, wireless only alternative:
10-
1x ESPCAM32 Modules - They are cheaper, requires a separate programmer board, supports only wireless streaming and may require some soldering for attaching separate antennas: AliExpress
11-
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
12-
1x 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.
3+
### Recommended:
4+
- 1x XIAO ESP32-S3 Sense Modules
5+
- Very small size, wireless and wired support.
6+
- Does not require an additional programmer or separate antennas.
7+
- [SeedStudio](https://www.seeedstudio.com/)
138

14-
Small: AliExpress
15-
Large: AliExpress
16-
Amazon
9+
### Alternatively:
10+
- 1x Freenove ESP 32-S3 WROOM
11+
- Larger size, price may be higher than the XIAOs.
12+
- Supports wired and wireless connections.
13+
- Does not need a separate programmer.
14+
- Does not support a separate antenna.
15+
- [Amazon](https://www.amazon.com/)
16+
17+
### A Cheaper, Wireless-Only Alternative:
18+
- 1x ESPCAM32 Modules
19+
- Cheaper option.
20+
- Requires a separate programmer board.
21+
- Supports only wireless streaming.
22+
- May require soldering for attaching separate antennas.
23+
- [AliExpress](https://www.aliexpress.com/)
24+
25+
**Note:** This board requires a special programmer board to flash the firmware. You'll need only one:
26+
- [AliExpress](https://www.aliexpress.com/) for just programmers.
27+
- [Amazon](https://www.amazon.com/) for 3 ESP32-Cams and programmers without the proper cameras.
28+
29+
### External Antennas for ESPs:
30+
- Required if you're running Vive/Tundra full body tracking or having issues with streaming.
31+
- Small: [AliExpress](https://www.aliexpress.com/)
32+
- Large: [AliExpress](https://www.aliexpress.com/)
33+
- [Amazon](https://www.amazon.com/)

‎docs/hardware/components/usbHubs.mdx

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
# USB Hubs
1+
## USB Hubs
22

3-
1x USB 3.0+ hub The hub needs to support MTT if you wish to use other high bandwidth devices with the ESPs. STT hubs can work if they are only used with other ESPs (Babble + ETVR). Here is a hub that supports MTT and is not expensive Amazon
4-
Ensure that it is of good quality, lightweight, compact in size, and I suggest a minimum of three ports - one for the face tracker and two for ESP32-S3 boards. Ensure that you acquire appropriate USB-A to USB-C adapters wherever required. For example the Valve Index only has one USB-A port. Such adapter Amazon.
5-
1x 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.
3+
- 1x USB 3.0+ Hub
4+
- The hub needs to support MTT if you wish to use other high bandwidth devices with the ESPs. STT hubs can work if they are only used with other ESPs (Babble + ETVR).
5+
- Ensure it is of good quality, lightweight, compact in size, and has a minimum of three ports - one for the face tracker and two for ESP32-S3 boards.
6+
- [Amazon](https://www.amazon.com/)
7+
8+
- Ensure that you acquire appropriate USB-A to USB-C adapters wherever required. For example, the Valve Index only has one USB-A port.
9+
- [Amazon](https://www.amazon.com/)
10+
11+
- 1x USB-C cables (as short as possible) to connect both ESPs.
12+
- As the ESP32-S3 has USB-C connectors, you may require some USB-C to USB-A cables depending on your USB hub.

‎docs/hardware/components/wiresAdapters.mdx

+19-12
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
# Wires and Adapters
1+
## Wires and Adapters
22

33
If you are soldering and using custom cables:
4-
1x USB type-A male port to power both ESPs or LEDs
5-
Bare breakout on AliExpress
6-
Amazon
7-
8-
Or one with a cover on AliExpress
9-
Amazon
10-
1x Lower gauge wire to power ESPs
11-
28 AWG gauge wire from AliExpress
12-
28 AWG Amazon
13-
1x Higher gauge wire to power IR emitters (V3 or V4 some assembly required)
14-
34 AWG AliExpress
4+
5+
- 1x USB Type-A male port to power both ESPs or LEDs
6+
- Bare breakout:
7+
- [AliExpress](https://www.aliexpress.com/)
8+
- [Amazon](https://www.amazon.com/)
9+
10+
- One with a cover:
11+
- [AliExpress](https://www.aliexpress.com/)
12+
- [Amazon](https://www.amazon.com/)
13+
14+
- 1x Lower gauge wire to power ESPs
15+
- 28 AWG gauge wire:
16+
- [AliExpress](https://www.aliexpress.com/)
17+
- [Amazon](https://www.amazon.com/)
18+
19+
- 1x Higher gauge wire to power IR emitters (V3 or V4 some assembly required)
20+
- 34 AWG:
21+
- [AliExpress](https://www.aliexpress.com/)

‎docs/hardware/hardware.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Hardware
66

7-
Project Babble is hardware agnostic, having been designed to be used on a variety of devices without issue. The following table outlines tested components and links to their dedicated pages:
7+
Project Babble is hardware agnostic, having been designed to be used on a variety of devices without issue. The following table outlines tested components and links to their dedicated pages:
88

99
<details>
1010
<summary>Camera Compatibility Table</summary>
@@ -43,4 +43,4 @@ If you have used the HTC Vive Facial tracker, then the position should be somewh
4343

4444
![The Vive facial tracker worn on a Vive pro eye headset](\img\htc-vive-facial-tracker-being-worn.webp)
4545

46-
Now that you have set up hardware, we can move onto the [software side of things!](docs\software.mdx)
46+
Now that you have set up hardware, we can move onto the [software side of things!](docs\software.mdx)

‎docs/hardware/recommendedParts.mdx

+26-19
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
1-
# Recommended parts list:
1+
## Recommended Parts List:
22

3-
Sourcing ETVR V3 LED Parts:
4-
2x Unfocused SMD IR emitters
5-
NOTE
6-
The smaller ones can not be soldered at temps above 245C or they will burn. Low temp solder is recommended.
7-
(Recommended) from LCSC here.
8-
(Alternative) from Digikey here.
9-
The difference between them is the ones from LCSC are rated for lower power, which means in the event of a short or mishap they should be safer, as well as being smaller in footprint, hence why they are recommended.
10-
2x IR emitter PCBs (highly recommended) Gerber files and schematics located here.
11-
2x 80 ohm 1206 SMD resistors for IR emitters (If you are not using PCBs for the emitters then buying regular through-hole resistors is acceptable.)
12-
NOTE: The resistance is significantly less than what would be used for eyetracking so we can run the LEDs at a higher power.
13-
357 ohm Digikey here
14-
348 ohm LCSC here
15-
Visible Alternative:
16-
1x WS2812B RGB aRGB LED (Visible Light)
17-
AliExpress
18-
This ensures you get the correct IR emitter parts.
19-
1x Wire to power IR emitters
20-
34 AWG AliExpress
3+
### Sourcing ETVR V3 LED Parts:
4+
5+
- **IR Emitters:**
6+
- 2x Unfocused SMD IR emitters
7+
- **Note:** The smaller ones can not be soldered at temps above 245°C or they will burn. Low-temp solder is recommended.
8+
- *(Recommended)* [LCSC](https://lcsc.com/)
9+
- *(Alternative)* [Digikey](https://www.digikey.com/)
10+
11+
- 2x IR emitter PCBs (highly recommended)
12+
- Gerber files and schematics located [here](link).
13+
14+
- **Resistors for IR Emitters:**
15+
- 2x 80 ohm 1206 SMD resistors
16+
- *(If not using PCBs for the emitters, regular through-hole resistors are acceptable.)*
17+
- [Digikey - 357 ohm](https://www.digikey.com/)
18+
- [LCSC - 348 ohm](https://lcsc.com/)
19+
20+
### Visible Alternative:
21+
- 1x WS2812B RGB aRGB LED (Visible Light)
22+
- [AliExpress](https://www.aliexpress.com/)
23+
24+
### Additional Components:
25+
- 1x Wire to power IR emitters
26+
- 34 AWG
27+
- [AliExpress](https://www.aliexpress.com/)

‎package-lock.json

+77
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)