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