Merge branch 'deployment' of https://github.com/Project-Babble/BabbleDocs into deployment

Author: RamesTheGeneric

.github/workflows/deploy.yml

@@ -21,7 +21,7 @@ jobs:
           cache: yarn
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: yarn install
       - name: Build website
         run: yarn build
 

CNAME

@@ -1 +1 @@
-www.babble.diy
+docs.babble.diy

blog/authors.yml

@@ -1,5 +1,5 @@
 dfgHiatus:
-  name: Benjamin M. Evans
+  name: dfgHiatus
   title: Maintainer of the Project Babble docs
   url: https://github.com/dfgHiatus
-  image_url: https://avatars.githubusercontent.com/u/51272212?s=400&u=cff33bfb7d514d6b56bd99c08bd50402a7189c56&v=4
+  image_url: https://avatars.githubusercontent.com/u/51272212?s=400&u=cff33bfb7d514d6b56bd99c08bd50402a7189c56&v=4

blog/reverse-engineering-the-vive-facial-tracker.mdx

@@ -1 +1 @@
-www.babble.diy
+docs.babble.diy

docs/CNAME

@@ -0,0 +1,56 @@
+---
+sidebar_position: 2
+title: Official Babble Tracker
+---
+
+# Official Babble Tracker
+
+Hi there! If you're in this section, you've purchaced a Babble Mouth Tracker V1! 
+
+## Here's how to use the tracker:
+
+### 1) Plug your tracker into your PC! 
+    - This is pretty simple! There is a USB C port on your tracker! Plug it in and you should hear a windows connection sound when plugged in!
+    - IMPORTANT: Make sure the switch is in the "ON" position! (see image below)
+    - There should be two very bright green lights on the back of the trackers!
+
+![switch](/img/setup_switch.jpg)
+
+### 2) Look at device manager for the COM port of the tracker!
+    -  Press the windows key, then type "Device Manager" and press enter.
+    - In the device manager, look for "Ports (COM & LPT)" and expand it.
+    - You should see a new COM port listed under "Ports (COM & LPT)" listed as "USB Serial Device". This is the COM port of your tracker. 
+
+![device manager](/img/setup_comm.png)
+
+### 3) Download the lastest version of the Babble Tracker software on our github! 
+    - You can find the latest version of the software here:  https://drive.google.com/file/d/1KmMBYSmAGlqDeTEjgnOOCX8YpWeeBgPb/view?usp=drive_link
+    - Download the Project_Babble-Setup-vX.X.X.exe file and run it to install the software.
+
+:::warning  
+Warning, the software is still in beta and may have bugs! 
+:::
+
+
+### Open the Project Babbble software and select the COM port of your tracker.
+    - In the Project Babble software, click on the dropdown next to the "Camera Address" text.
+    - Click the on the desired camera Address. 
+
+![camera address](/img/setup_dropdown_comm_select.png)
+
+### 4) Getting a camera feed running!
+    - Now click the "Save and Restart Tracking" button to connect. 
+    - IMPORTANT: You won't see a video until you set a crop area. So click on "cropping mode" and click and drag to set a crop area.
+    - For actual use make sure to make a box around your mouth!
+    - After this go back to "Tracking Mode" and you should see a video feed from your camera!
+    
+![camera working](/img/setup_working_V.png)
+
+### 5) Finished! 
+    - To click on one of the links down below to get started in game!
+    - For people who want to hop in game, click here for [VRChat](docs\software\integrations\vrc.mdx), [Resonite](docs\software\integrations\resonite.mdx), or here for [something else](docs\software\integrations\integrations.mdx).
+
+## But I want WiFi! 
+
+If you want WiFi, please look at our [Firmware Guide](docs\hardware\Firmware\firmware.mdx).
+

docs/babbleofficaltracker/babbleofficaltracker.mdx

@@ -0,0 +1,117 @@
+---
+title: Firmware
+sidebar_position: 2
+---
+
+# Firmware
+
+:::info
+If you purchased a Babble PCB (by itself, as part of the Base Kit, or the Supporter Kit) you do *NOT* need to follow the directions below IF YOU ARE USING IT IN WIRED MODE.
+
+The following instructions are for users who have assembled their own hardware or people who wish to use the wireless mode of their Babble Kit.
+:::
+
+## Setup
+
+Now that you've assembled your DIY Babble Tracker, you need to flash the firmware for it. This guide uses the wired/wireless `wroom` setup, although the setup process is similar for other boards.
+
+:::info
+At present moment wireless and wired firmware can only be used mutually exclusively, IE you can't switch them out on the fly.
+:::
+
+### Step 1
+In order to flash your firmware, you'll need a copy of [VSCode](https://code.visualstudio.com/).
+
+### Step 2
+Once VSCode has installed, you'll need to download the [platformio-ide extension](https://platformio.org/install/ide?install=vscode). You can get it from this link or by searching for it in VSCode's extension tab.
+
+:::warning
+In testing, sister projects like [VSCodium](https://vscodium.com/) do not support platformio-ide. If you can find a workaround for this let us know!
+:::
+
+### Step 3
+Download/Clone the [OpenIrirs repo](https://github.com/RamesTheGeneric/OpenIris) from EyeTrackVR's Github.
+
+### Step 4
+Open the OpenIris repo inside of VSCode. You may get a prompt to open to an ESP workspace, if you do click on it!
+You should now see something along the lines of this:
+
+<img src={require("@site/static/img/firmware_Start.png").default}/>
+
+### Step 5
+At this point, click on the platformio-ide extension on the left toolbar. It's the icon with a bug!
+
+At the bottom, you'll see an `env:` field followed by the firmware to build and upload. You must select the env appropriate to both your board type **and** wired/wireless type.
+
+For a `wroom` board:
+- `env:Babble_USB-wrooms-s3` for wired
+- `env:Babble-wrooms-s3` for wireless
+
+For Xiao Sense S3:
+- `env:xiaosenses3_USB_release` for wired
+- `env:xiaosenses3_release` for wireless
+
+Other supported boards will appear in the selector in wired/wireless variants. Make sure you select the appropriate env for your board. 
+
+<details>
+  <summary>If flashing wireless firmware, you'll need to set your wifi's `ssid`, `password` and `mdnsname`.</summary>
+
+  You can change these under the `user_config.ini` file.
+
+  <div style={{
+    width: '90%',
+    height: 'auto',
+    margin: 'auto',
+    display: 'block'
+  }}>
+  </div>
+    <img src={require("@site/static/img/firmware_WifiConfig.png").default}/>
+
+    Where the `mdnsname` corresponds to the name of the device on the network. IE, a value of `babbletracker` would show up as `http://babbletracker.local`.
+</details>
+
+Platformio-ide will then download all the needed dependencies for your selected firmware. This might take a minute!
+
+<img src={require("@site/static/img/firmware_Download.png").default}/>
+
+### Step 6
+Now, get ready to plug in your device. You'll need to put it in *Boot Mode* to write firmware to it. To do this, hold down the boot mode button on your board as you plug it in. You'll feel a *click* as the button presses in and out. On the `wroom` board, the button is pictured here:
+
+Once you've plugged in the device, you can release this button.
+
+<img src={require("@site/static/img/firmware_WROOM.jpg").default}/>
+
+### Step 7
+
+Once the above download has completed you're ready for upload! Click on the right-arrow button on the bottom ribbon, between the check mark and trash button. You'll see terminal output during the upload, if there are any errors or if the upload was successful.
+
+<img src={require("@site/static/img/firmware_Upload.png").default}/>
+
+### Step 8
+
+To use your device, unplug it and plug it back in again to get it out of boot mode. It should work now!
+
+## Troubleshooting
+
+### Step 1
+To pull logs from your device, first download [EyeTrackVR's firmware flashing tool](https://github.com/EyeTrackVR/FirmwareFlashingTool/releases) from their Github. 
+
+Before moving onto the next steps, make sure your device is plugged in and/or connected (non-boot mode this time).
+
+### Step 2
+
+Open EyeTrackVR's firmware flashing tool. Select any firmware here, it doesn't matter. Just go to the next page. 
+
+<img src={require("@site/static/img/firmware_ETVR_1.png").default}/>
+
+If prompted for wifi, just enter anything to move on. You don't need to deal with this either.
+
+<img src={require("@site/static/img/firmware_ETVR_2.png").default}/>
+
+### Step 3
+
+Select your device on the corresponding COM port. Then, click on the left arrow next to the "Downloading logs..." button. Or you can download the logs and look at them in the text editor of your choice.
+
+<img src={require("@site/static/img/firmware_ESP32.png").default}/>
+
+For more information on how to use EyeTrackVR's firmware flashing tool, please refer to their [documentation](https://docs.eyetrackvr.dev/firmware_guide/flashing_tool).

docs/developers/developerHE/developersHE.mdx

@@ -0,0 +1,39 @@
+---
+title: Tracker Boards
+---
+
+# Tracker Boards
+
+### Recommended:
+
+- **XIAO ESP32-S3 Sense Modules**
+  - Compact size with both wireless and wired support.
+  - No need for an additional programmer or separate antennas.
+  - [Buy on SeedStudio](https://seeedstudio.com/XIAO-ESP32S3-Sense-p-5639.html)
+
+### Alternative Option:
+
+- **Freenove ESP 32-S3 WROOM**
+  - Slightly larger and potentially more expensive than the XIAO.
+  - Supports both wired and wireless connections.
+  - Does not require a separate programmer.
+  - Lacks support for an external antenna.
+  - [Buy on AliExpress](https://www.aliexpress.us/item/3256807112147121.html?)
+
+### Budget-Friendly, Wireless-Only Option:
+
+- **ESPCAM32 Modules**
+  - A more affordable choice.
+  - Requires a separate programmer board for flashing firmware.
+  - Supports only wireless streaming.
+  - May need soldering to attach external antennas.
+  - [Buy on AliExpress](https://www.aliexpress.us/item/3256806346200289.html)
+
+  **Note:** The ESPCAM32 module often requires a special programmer board to flash the firmware. While our listing includes it, be sure to check if it's included when purchasing from other sources.
+
+### External Antennas for ESP Modules:
+
+- **External Antennas:** Recommended if you're using Vive/Tundra full body tracking or facing issues with wireless streaming.
+  - **Small Antenna:** [Buy on AliExpress](https://www.aliexpress.us/item/3256806201357624.html)
+  - **Large Antenna:** [Buy on AliExpress](https://www.aliexpress.us/item/3256804672416898.html)
+  - **PCB Antenna:** [Buy on Digi-Key](https://www.digikey.com/en/products/detail/taoglas-limited/FXP72.07.0053A/2332702)

docs/developers/developerSE/developersSE.mdx

@@ -0,0 +1,48 @@
+---
+title: Lighting
+---
+
+For Project Babble, you can use either Infrared or visible light. Each has its advantages and considerations:
+
+- **Infrared Lighting:**
+  - Less distracting as the light is not visible to the naked eye.
+  - Susceptible to flicker from base stations if not sufficiently bright.
+
+- **Visible Lighting:**
+  - Immune to base station flicker.
+  - Potential for distraction if the headset doesn't block light effectively.
+
+Consider these factors when choosing the type of lighting for your setup
+
+### Additional Note About Voltage
+Either 3.3V or 5V can be used to power the LEDs, however the resistors used will be different. 5V can only be used when powered over USB while 3.3V can be used with both USB and battery power.
+
+## Sourcing
+
+- **IR Emitters:**
+  - 2x 5mm 850nm IR Through Hole LEDS
+    - *(Choose "F5mm 850nm")* [AliExpress](https://www.aliexpress.us/item/3256803759925241.html?)
+    
+- **Resistors for IR Emitters:**
+  - 2x 160ohm 1/4w Resistors (If using 5V)
+    - *(Choose "160R")* [AliExpress](https://www.aliexpress.us/item/3256806544238902.html?)
+  - 2x 82ohm 1/4w Resistors (If using 3.3V)
+    - *(Choose "82R")* [AliExpress](https://www.aliexpress.us/item/3256806544238902.html?)
+
+
+### Visible Light Alternative:
+
+- **White LEDs**
+  - 2x 5mm White Through Hole LED (Visible Light)
+    - *(Choose "50pcs-white") [AliExpress](https://www.aliexpress.us/item/3256807891285585.html)
+
+- **Resistors for White LEDs:**
+  - 2x 150ohm 1/4w Resistors (If using 5V)
+    - *(Choose "150R")* [AliExpress](https://www.aliexpress.us/item/3256806544238902.html?)
+  - 2x 68ohm 1/4w Reistors (If using 3.3V)
+    - *(Choose "68R")* [AliExpress](https://www.aliexpress.us/item/3256806544238902.html?)
+
+
+### Additional Components:
+- 1x Wire to power IR emitters (28 AWG stranded wire is good general size)
+  - [AliExpress](https://www.aliexpress.us/item/3256807801296902.html?)

docs/developers/developers.mdx

@@ -0,0 +1,21 @@
+---
+title: USB Hubs
+---
+
+# USB Hubs
+
+- **1x USB 3.0+ Hub**
+  - The hub should support **Multi-TT (MTT)** if you plan to use other high-bandwidth devices along with the ESPs. **Single-TT (STT)** hubs may work if they are only used with ESP devices (e.g., Babble + ETVR).
+  - Ensure the hub is of good quality, lightweight, compact, and has at least three ports—one for the face tracker and two for the ESP32-S3 boards.
+  - [Buy on Amazon](https://www.amazon.com/)
+
+- **USB-A to USB-C Adapters**
+  - Make sure to have the necessary adapters if required. For instance, the Valve Index only has one USB-A port.
+  - [Buy on Amazon](https://www.amazon.com/)
+
+- **1x USB-C Cables** (as short as possible) to connect both ESPs.
+  - Since the ESP32-S3 uses USB-C connectors, you might need USB-C to USB-A cables, depending on your USB hub configuration.
+
+:::warning
+**Note:** USB hubs are not required if you only plan on using Projet Babble, you might need a USB hub if you also plan on using for example: [EyeTrackVR](https://docs.eyetrackvr.dev/).
+:::

docs/hardware/Firmware/firmware.mdx

@@ -0,0 +1,30 @@
+---
+title: Wiring Guide
+---
+
+# Wiring Guide
+
+Follow these steps to wire LEDs to the Seeed XIAO ESP32-S3 safely and effectively:
+
+- **Power Options for LEDs**:
+  - Either **3.3V** or **5V** can be used to power the LEDs.
+  - **3.3V** is compatible with both USB and battery power.
+  - **5V** can only be used when the ESP32 is powered via USB.
+
+- **Resistor Requirements**:
+  - For **3.3V** power: Use **82-ohm resistors** in series with the LEDs.
+  - For **5V** power: Use **160-ohm resistors** in series with the LEDs.
+
+- **Steps to Wire the LEDs**:
+  1. Connect the **GND pin** on the ESP32 to the cathode (short leg) of the LED.
+  2. Add an appropriate resistor (82 ohms for 3.3V, 160 ohms for 5V) in series with the anode (long leg) of the LED.
+  3. Connect the other end of the resistor to either:
+     - **3.3V pin** (if using 3.3V power), or
+     - **5V pin** (if using 5V power).
+  4. Repeat the process for additional LEDs, ensuring each has its own resistor.
+
+- **Important Notes**:
+  - Do not connect LEDs directly to the ESP32 pins without a resistor, as it may damage the LEDs or the microcontroller.
+  - Ensure the ESP32 is correctly powered based on your selected voltage (USB or battery).
+
+![Babble Wiring Guide](/img/babbleWiringGuide.png)