Skip to content

Commit 143bd10

Browse files
authored
Merge pull request #79 from Project-Babble/main
Update firmware guide
2 parents 452438b + b413d73 commit 143bd10

File tree

6 files changed

+68
-8
lines changed

6 files changed

+68
-8
lines changed

docs/hardware/Firmware/firmware.mdx

+68-7
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,100 @@ If you purchased a Babble PCB (by itself, as part of the Base Kit, or the Suppor
1111
The following instructions are for users who have *assembled their own hardware* or people who wish to use the *wireless mode* with their *Babble Kit*.
1212
:::
1313

14+
:::warning
15+
Your wifi MUST have 2.4Ghz enabled for the Babble V1 Tracker or any ESP32 device to connect to it. 5Ghz doesn't work with the ESP32 series of processors, which is what the Babble V1 Tracker uses.
16+
:::
17+
18+
1419
## Setup
1520

1621
Now that you've assembled your Babble Tracker, you'll need to flash the firmware for it. This guide uses the wired/wireless `wroom` setup, although the setup process is similar for other boards.
1722

1823
### Step 1
1924
First, download [EyeTrackVR's firmware flashing tool](https://github.com/EyeTrackVR/FirmwareFlashingTool/releases) from their Github.
2025

21-
Before moving onto the next steps, you'll need to put your device 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:
26+
Before moving onto the next steps, you'll need to put your device 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 `Babble V1` board, the button is pictured here:
27+
28+
:::info
29+
If you purchased an Offical Babble Tracker from us then you do not need to hold down the boot button as we have already flashed a bootloader onto it for you.
30+
:::
2231

2332
After you've plugged in the device, you can release this button.
2433

2534
<img src={require("@site/static/img/firmware_WROOM.jpg").default}/>
2635

2736
### Step 2
2837

29-
Open EyeTrackVR's firmware flashing tool. You'll need to select the firmware that corresponds to your device:
38+
At this point your board should be pluged into your PC. Open EyeTrackVR's firmware flashing tool. You'll need to select the firmware that corresponds to your device. We've listed how to find the XAIO Seed Studio and Babble V1 Kit Fimware below.
3039

31-
<img src={require("@site/static/img/firmware_ETVR_1.png").default}/>
40+
#### XAIO SEED STUDIO
3241

33-
If flashing wireless firmware to your device, you'll be prompted to enter your wifi network's name and password:
42+
##### XAIO WIRELESS FIMWARE:
43+
![switch](/img/XAIOwireless.png)
3444

35-
<img src={require("@site/static/img/firmware_ETVR_2.png").default}/>
45+
##### XAIO WIRED FIMWARE:
46+
![switch](/img/XAIOwired.png)
47+
48+
#### Babble Offical Board
49+
50+
##### Babble Offical Board WIRELESS FIMWARE:
51+
![switch](/img/BabbleWireless.png)
52+
53+
##### Babble Offical Board WIRED FIMWARE:
54+
![switch](/img/BabbleWired.png)
55+
56+
#### Wireless fimrware selection
57+
58+
In the wireless firmware section of the ETVR firmware flasher you see 3 things:
59+
60+
##### Tracker name
61+
62+
This is the link that you can access your tracker at! By defualt it's ```http://openiristracker.local/``` but you can change this to whatever you'd like.
63+
64+
##### SSID
65+
66+
This is the name of your wifi network
67+
68+
##### Password
69+
70+
The password to your wifi network
3671

3772

3873
### Step 3
3974

40-
Select your device on the corresponding COM port. Then, click on the "Install Openiris" button to flash your firmware!
75+
Select your device on the corresponding COM port. Then, click on the "Install Openiris" button to flash your firmware! This will flash the new firmware onto your board!
4176

4277
<img src={require("@site/static/img/firmware_ESP32.png").default}/>
4378

79+
### Step 4
80+
81+
After flashing your board make sure to **Unplug and replug** your board into a power source. This way it will start using the new fimrware.
82+
83+
After that you're done!
4484

4585
## Troubleshooting
4686

47-
To pull logs from your device, follow the instructions [on this page](/docs/hardware/Firmware/firmware_legacy#troubleshooting).
87+
### Step 1
88+
To pull logs from your device, first download [EyeTrackVR's firmware flashing tool](https://github.com/EyeTrackVR/FirmwareFlashingTool/releases) from their Github.
89+
90+
Before moving onto the next steps, make sure your device is plugged in and/or connected (non-boot mode this time).
91+
92+
### Step 2
93+
94+
Open EyeTrackVR's firmware flashing tool. Select any firmware here, it doesn't matter. Just go to the next page.
95+
96+
<img src={require("@site/static/img/firmware_ETVR_1.png").default}/>
97+
98+
If prompted for wifi, just enter anything to move on. You don't need to deal with this either.
99+
100+
<img src={require("@site/static/img/firmware_ETVR_2.png").default}/>
101+
102+
### Step 3
103+
104+
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.
105+
106+
<img src={require("@site/static/img/firmware_ESP32.png").default}/>
107+
108+
##
48109

49110
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/software/software.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ Getting started with the Babble App is as easy as 1-2-3!
7575

7676
### 1. Download and install the Project Babble App
7777
Download the installer in the [releases](https://github.com/Project-Babble/ProjectBabble/releases) tab on Github.
78-
7978
:::info
8079
Fun fact: The project Babble App will update itself whenever you open it!
8180
:::

static/img/BabbleWired.png

83.2 KB
Loading

static/img/BabbleWireless.png

83 KB
Loading

static/img/XAIOwired.png

52.7 KB
Loading

static/img/XAIOwireless.png

53.1 KB
Loading

0 commit comments

Comments
 (0)