Skip to content

Commit de06ed3

Browse files
Merge branch 'deployment' of https://github.com/Project-Babble/BabbleDocs into deployment
2 parents 86ce089 + 8e03e08 commit de06ed3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+3733
-16830
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
cache: yarn
2222

2323
- name: Install dependencies
24-
run: yarn install --frozen-lockfile
24+
run: yarn install
2525
- name: Build website
2626
run: yarn build
2727

CNAME

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
www.babble.diy
1+
docs.babble.diy

blog/authors.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
dfgHiatus:
2-
name: Benjamin M. Evans
2+
name: dfgHiatus
33
title: Maintainer of the Project Babble docs
44
url: https://github.com/dfgHiatus
5-
image_url: https://avatars.githubusercontent.com/u/51272212?s=400&u=cff33bfb7d514d6b56bd99c08bd50402a7189c56&v=4
5+
image_url: https://avatars.githubusercontent.com/u/51272212?s=400&u=cff33bfb7d514d6b56bd99c08bd50402a7189c56&v=4

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

Lines changed: 396 additions & 0 deletions
Large diffs are not rendered by default.

docs/CNAME

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
www.babble.diy
1+
docs.babble.diy
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
sidebar_position: 2
3+
title: Official Babble Tracker
4+
---
5+
6+
# Official Babble Tracker
7+
8+
Hi there! If you're in this section, you've purchaced a Babble Mouth Tracker V1!
9+
10+
## Here's how to use the tracker:
11+
12+
### 1) Plug your tracker into your PC!
13+
- 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!
14+
- IMPORTANT: Make sure the switch is in the "ON" position! (see image below)
15+
- There should be two very bright green lights on the back of the trackers!
16+
17+
![switch](/img/setup_switch.jpg)
18+
19+
### 2) Look at device manager for the COM port of the tracker!
20+
- Press the windows key, then type "Device Manager" and press enter.
21+
- In the device manager, look for "Ports (COM & LPT)" and expand it.
22+
- 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.
23+
24+
![device manager](/img/setup_comm.png)
25+
26+
### 3) Download the lastest version of the Babble Tracker software on our github!
27+
- You can find the latest version of the software here: https://drive.google.com/file/d/1KmMBYSmAGlqDeTEjgnOOCX8YpWeeBgPb/view?usp=drive_link
28+
- Download the Project_Babble-Setup-vX.X.X.exe file and run it to install the software.
29+
30+
:::warning
31+
Warning, the software is still in beta and may have bugs!
32+
:::
33+
34+
35+
### Open the Project Babbble software and select the COM port of your tracker.
36+
- In the Project Babble software, click on the dropdown next to the "Camera Address" text.
37+
- Click the on the desired camera Address.
38+
39+
![camera address](/img/setup_dropdown_comm_select.png)
40+
41+
### 4) Getting a camera feed running!
42+
- Now click the "Save and Restart Tracking" button to connect.
43+
- 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.
44+
- For actual use make sure to make a box around your mouth!
45+
- After this go back to "Tracking Mode" and you should see a video feed from your camera!
46+
47+
![camera working](/img/setup_working_V.png)
48+
49+
### 5) Finished!
50+
- To click on one of the links down below to get started in game!
51+
- 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).
52+
53+
## But I want WiFi!
54+
55+
If you want WiFi, please look at our [Firmware Guide](docs\hardware\Firmware\firmware.mdx).
56+

docs/developers/developerHE/developersHE.mdx

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/developers/developerSE/developersSE.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/developers/developers.mdx

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/hardware/Firmware/firmware.mdx

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
title: Firmware
3+
sidebar_position: 2
4+
---
5+
6+
# Firmware
7+
8+
:::info
9+
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.
10+
11+
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.
12+
:::
13+
14+
## Setup
15+
16+
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.
17+
18+
:::info
19+
At present moment wireless and wired firmware can only be used mutually exclusively, IE you can't switch them out on the fly.
20+
:::
21+
22+
### Step 1
23+
In order to flash your firmware, you'll need a copy of [VSCode](https://code.visualstudio.com/).
24+
25+
### Step 2
26+
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.
27+
28+
:::warning
29+
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!
30+
:::
31+
32+
### Step 3
33+
Download/Clone the [OpenIrirs repo](https://github.com/RamesTheGeneric/OpenIris) from EyeTrackVR's Github.
34+
35+
### Step 4
36+
Open the OpenIris repo inside of VSCode. You may get a prompt to open to an ESP workspace, if you do click on it!
37+
You should now see something along the lines of this:
38+
39+
<img src={require("@site/static/img/firmware_Start.png").default}/>
40+
41+
### Step 5
42+
At this point, click on the platformio-ide extension on the left toolbar. It's the icon with a bug!
43+
44+
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.
45+
46+
For a `wroom` board:
47+
- `env:Babble_USB-wrooms-s3` for wired
48+
- `env:Babble-wrooms-s3` for wireless
49+
50+
For Xiao Sense S3:
51+
- `env:xiaosenses3_USB_release` for wired
52+
- `env:xiaosenses3_release` for wireless
53+
54+
Other supported boards will appear in the selector in wired/wireless variants. Make sure you select the appropriate env for your board.
55+
56+
<details>
57+
<summary>If flashing wireless firmware, you'll need to set your wifi's `ssid`, `password` and `mdnsname`.</summary>
58+
59+
You can change these under the `user_config.ini` file.
60+
61+
<div style={{
62+
width: '90%',
63+
height: 'auto',
64+
margin: 'auto',
65+
display: 'block'
66+
}}>
67+
</div>
68+
<img src={require("@site/static/img/firmware_WifiConfig.png").default}/>
69+
70+
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`.
71+
</details>
72+
73+
Platformio-ide will then download all the needed dependencies for your selected firmware. This might take a minute!
74+
75+
<img src={require("@site/static/img/firmware_Download.png").default}/>
76+
77+
### Step 6
78+
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:
79+
80+
Once you've plugged in the device, you can release this button.
81+
82+
<img src={require("@site/static/img/firmware_WROOM.jpg").default}/>
83+
84+
### Step 7
85+
86+
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.
87+
88+
<img src={require("@site/static/img/firmware_Upload.png").default}/>
89+
90+
### Step 8
91+
92+
To use your device, unplug it and plug it back in again to get it out of boot mode. It should work now!
93+
94+
## Troubleshooting
95+
96+
### Step 1
97+
To pull logs from your device, first download [EyeTrackVR's firmware flashing tool](https://github.com/EyeTrackVR/FirmwareFlashingTool/releases) from their Github.
98+
99+
Before moving onto the next steps, make sure your device is plugged in and/or connected (non-boot mode this time).
100+
101+
### Step 2
102+
103+
Open EyeTrackVR's firmware flashing tool. Select any firmware here, it doesn't matter. Just go to the next page.
104+
105+
<img src={require("@site/static/img/firmware_ETVR_1.png").default}/>
106+
107+
If prompted for wifi, just enter anything to move on. You don't need to deal with this either.
108+
109+
<img src={require("@site/static/img/firmware_ETVR_2.png").default}/>
110+
111+
### Step 3
112+
113+
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.
114+
115+
<img src={require("@site/static/img/firmware_ESP32.png").default}/>
116+
117+
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).

0 commit comments

Comments
 (0)