feat: add docs for firmware flashing tool

This commit is contained in:
ZanzyTHEbar 2023-10-26 11:16:33 +01:00
parent 7dd59bf18f
commit fb4516e375
10 changed files with 604 additions and 558 deletions

View File

@ -10,6 +10,6 @@
}
],
"settings": {
"cSpell.words": ["flexbugs", "flexsearch", "vitepress"]
"cSpell.words": ["eyetrack", "flexbugs", "flexsearch", "vitepress"]
}
}

View File

@ -59,23 +59,7 @@ const theme = {
collapsible: true,
items: [
{ text: "Introduction", link: "/firmware_guide/firmware" },
{
text: "Setup Visual Studio Code environment",
link: "/firmware_guide/setup_vscode",
},
{
text: "Configuring Firmware",
link: "/firmware_guide/configure_firmware",
},
{
text: "Uploading and Updating the Firmware",
link: "/firmware_guide/upload_and_update_firmware",
},
{
text: "Updating PlatformIO",
link: "/firmware_guide/update_platformio",
},
{ text: "Firmware Environments", link: "/firmware_guide/environments" },
{ text: "Flashing Tool", link: "/firmware_guide/flashing_tool.md" },
{ text: "MDNS", link: "/firmware_guide/mdns" },
{ text: "REST API", link: "/firmware_guide/rest_api" },
],
@ -119,6 +103,23 @@ const theme = {
text: "Archive",
collapsible: true,
items: [
{
text: "Setup Visual Studio Code environment",
link: "/firmware_guide/setup_vscode",
},
{
text: "Configuring Firmware",
link: "/firmware_guide/configure_firmware",
},
{ text: "Firmware Environments", link: "/firmware_guide/environments" },
{
text: "Uploading and Updating the Firmware",
link: "/firmware_guide/upload_and_update_firmware",
},
{
text: "Updating PlatformIO",
link: "/firmware_guide/update_platformio",
},
{
text: "Prepare to solder IR LED PCB V2's",
link: "/archive/fox_ir_v2_build_instructions",
@ -127,7 +128,7 @@ const theme = {
},
],
socialLinks: [
{ icon: "github", link: "https://github.com/EyeTrackVR/EyeTrackVR" },
{ icon: "github", link: "https://github.com/EyeTrackVR" },
{ icon: "discord", link: "https://discord.gg/kkXYbVykZX" },
],
};

View File

@ -45,7 +45,7 @@ You can choose to leave the `ap_ssid` and `ap_password` as defaults, but you wil
Double check that you have correctly entered your WiFi credentials and that said wifi network has a 2.4GHz band.
### Additonal configuration
### Additional configuration
#### `mDNS`
@ -73,9 +73,4 @@ The firmware supports multiple environments. This means that we have full suppor
Please reference the [Firmware Enviroments Page](../firmware_guide/environments) for more information.
::: tip Coming Soon
We are working on a new app that will allow you to configure the firmware, flash the boards, and connect to Social VR Games using a GUI. This will make it easier to configure the firmware, and will allow you to configure the firmware without having to use/download `VSCode` or our `platformio` project. We are hard at work on this, but do not currently have a release date. Please check back frequently.
:::
## [Now, move on to uploading the firmware](/firmware_guide/upload_and_update_firmware.html)

View File

@ -29,10 +29,9 @@ We now have a couple of options letting us decide how we want to build the firmw
Examples:
`xiaosenses3` - This is the debug environment.
`xiaosenses3_release` - This is the release environment for daily use.
::: tip Tip
We recommend starting with a debug environment, and then switching to release once everything is working. A debug environnement should not be used permanently.
We recommend starting with a debug environment, and then switching to release once everything is working. A debug environnement should not be used permanently.
:::
## Board Types

View File

@ -1,11 +1,25 @@
# What is this? {.text-[var(--font-accent)]}
Firmware is the second part of the equation to get your trackers going. It lives on the ESP32 chip, and is responsible for streaming video data from the tracker.
Firmware is the second part of the equation to get your trackers going. It lives on the ESP32 chip, and is responsible for streaming video data from the tracker. We currently fully support wireless streaming over 2.4GHz, and are working on adding support for wired streaming to the main desktop App.
## What should I download and where?
Current testing has been on our own solution called OpenIris, [found here](https://github.com/lorow/OpenIris). To check the status of the project, please visit the [Development Road Map](/dev_roadmap)
You can access the firmware, as well as flash your boards, using our new [Firmware Flashing Tool](https://github.com/EyeTrackVR/FirmwareFlashingTool).
## How do download this?
::: warning Caution
This tool is currently in beta.
:::
We are working on adding support for OTA and configuring network settings. If you have any issues, please let us know by opening an issue on the repository.
This tool relies on our own solution called `OpenIris`, [found here](https://github.com/EyeTrackVR/OpenIris).
::: info Note
You **do not** need to download OpenIris separately. The flashing tool will download it for you.
:::
To check the status of the project, please visit the [Development Road Map](/dev_roadmap)
::: details I want to use VSCode - How would I do this?
[Follow the steps described here](./setup_vscode)
:::

View File

@ -0,0 +1,31 @@
<script setup>
import ImageCard from '../../vue/images/ImageComponent.vue'
import { image_settings } from '../../static/image_settings'
</script>
# Firmware Flashing Tool {.text-[var(--font-accent)]}
## `What is this?`
The Firmware Flashing Tool allows you to flash the firmware to your ESPs without requiring VScode. It is a GUI tool that is built using [Tauri](https://tauri.app/) and [SolidJS](https://www.solidjs.com/).
Features include:
- download pre-built firmware binaries
- configure firmware settings
- flash firmware to ESPs
- open a serial monitor to view the ESPs output for debugging
::: info Note
This tool is currently in beta, and we are working on adding support for OTA and configuring network settings. If you have any issues, please let us know by opening an issue on the repository.
:::
<ImageCard :options="image_settings.flashing_tool"/>
<ImageCard :options="image_settings.flashing_tool_1"/>
## `Environments`
The firmware supports multiple environments. This means that we have full support for multiple types of ESPs. Each ESP is configured to be in a different environment. If you are using a different ESP, you will need to change the environment to the correct one.
Please reference the [Firmware Environments Page](../firmware_guide/environments) for more information.

View File

@ -11,15 +11,8 @@ Open source and *affordable* VR eye tracker platform for Social VR Games via `OS
### Welcome to the EyetrackVR documentation website. Here you will find all avalable documentation regauding building, development, and other resources related to this project.
Want to get started? Check out the [getting started page](https://docs.eyetrackvr.dev/getting_started/things_to_know) and then the [full build guide.](https://docs.eyetrackvr.dev/how_to_build/full_build)
<Alerts :options="alerts.user_warning">
<template v-slot:content>
<p>
@ -29,7 +22,6 @@ Want to get started? Check out the [getting started page](https://docs.eyetrackv
</template>
</Alerts>
## About IR Emitter Safety
Please *exercise caution* when messing around with IR emitters.

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

File diff suppressed because it is too large Load Diff