docs: update firmware environments

This commit is contained in:
Prohurtz 2023-06-26 12:12:29 -05:00
parent 3be78541a4
commit 9d9274528f
3 changed files with 39 additions and 46 deletions

View File

@ -69,33 +69,10 @@ The full REST API is documented [here](/firmware_guide/rest_api.html).
#### `Environments` #### `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. The environments are as follows: 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.
- `esp32AIThinker` - This is the default environment. This is for the ESP32-AI-THINKER and generic alibaba/aliexpress/amazon esp cam boards. Please reference the [Firmware Enviroments Page](../firmware_guide/environments) for more information.
- `esp32Cam` - This is for the special ESP32-CAM, it is unlikely that you will need to use this environment.
- `esp32M5Stack` - This is for ESP32M5Stack.
- `esp32WRover` - This is for the ESP32WRover.
- `esp-eye` - This is for the ESP-EYE (not the S3 variant).
- `wrooms3` - For FREENOVE-ESP32-S3 (*wireless mode*)
- `wrooms3QIO` - For FREENOVE-ESP32-S3 (*wireless mode*, for boards with octal flash)
- `wrooms3USB` - For FREENOVE-ESP32-S3 (*wired mode*)
- `wrooms3QIOUSB` - For FREENOVE-ESP32-S3 (*wired mode*, for boards with octal flash)
- `xiaosenses3_release` - For SeedStudio's XAIO ESP32-S3 Sense (*wireless mode*)
- `xiaosenses3_USB_release` - For SeedStudio's XAIO ESP32-S3 Sense (*wired mode*)
Each environment has a `debug` and `release` configuration. The `debug` configuration is for debugging, and the `release` configuration is for production. The `debug` configuration is not recommended for production, as it will use more memory, and will be slower. However we recommend using the `debug` configuration for initial configuration and testing, as it will be easier to debug, for you and for us. Once you are confident that the firmware is working correctly, you can switch to the `release` configuration.
The `debug` configuration will print out debug messages to the serial port. The `release` configuration will not print out debug messages to the serial port, and will only print errors. This will save memory, and will make the firmware faster.
The default configutration is `debug` for the `espAIThinker` environment. If you are using a different ESP, please follow the GIF(s) below to change the environment.
<!-- Place gif here -->
::: tip Coming Soon
GIF(s) for changing the environment will be added soon.
Want to help? [Submit a PR](https://github.com/RedHawk989/EyeTrackVR-Docs) to add the GIF(s).
:::
::: tip Coming Soon ::: 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. 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.

View File

@ -1,3 +1,10 @@
<script setup>
import Alerts from '../../vue/alerts/Alerts.vue'
import ImageCard from '../../vue/images/ImageComponent.vue'
import { image_settings } from '../../static/image_settings'
import { alerts } from '../../static/alerts'
</script>
# Firmware Environments {.text-[var(--font-accent)]} # Firmware Environments {.text-[var(--font-accent)]}
## What is it? ## What is it?
@ -13,22 +20,23 @@ Environments are broken up into two distinct parts:
## Build Types ## Build Types
We now have a couple of options letting us decide how we want to build the firmaware. We now have a couple of options letting us decide how we want to build the firmware.
- `Debug` - Has a lot of logging, useful for getting everything setup for the first time and to see what is going on. - `Debug` - The debug environment is the default environment and does not need to be specified. It has a lot of logging so it is useful for getting everything setup for the first time and to see what is going on.
The debug environment is the default environment, so you don't need to specify it when building. - `_release` - Has a lot less debugging, may also be missing some things available only in debug for debug purposes, this should be flashed when everything is working.
All debug environments are the default board environments, only `OTA` and `release` are specified in the name. - `_OTA` - Just like release, but it will upload your firmware to your esp wirelessly.
Examples:
`xiaosenses3` - This is the debug environment.
`xiaosenses3_release` - This is the release environment for daily use.
`xiaosenses3_OTA` - This is the the environment to upload release wirelessly via OTA.
::: tip Tip ::: tip Tip
We recommend starting with a debug environment, and then switching to release once everything is working. We recommend starting with a debug environment, and then switching to release once everything is working. A debug environnement should not be used permanently.
::: :::
- `Release` - Has a lot less debugging, may also be missing some things availible only in debug for debug purposes, this should be flashed when everything is working.
- `OTA` - Just like release, but it will upload your firmware to your esp wirelessly.
::: warning Warning ::: warning Warning
You need to change the IP to which board we should upload to, the setting is called the `otaserverip` and can be found in the `user_config.ini` file. You need to change the IP to which board we should upload to, the setting is called the `otaserverip` and can be found in the `user_config.ini` file.
@ -39,24 +47,27 @@ You can also change the port and password, but it's not recommended.
## Board Types ## Board Types
We currently support a few different boards, and we are working on adding more. We currently support for several different boards, and we are working on adding more.
::: warning Warning ::: warning Warning
It is important to note that the `esp32AIThinker` environment is the default environment, and will work for the vast majority of users. Do not switch your environment unless you know what you are doing, and have tested the default environment first, and verified that it does not work for you. It is important to note that the `esp32AIThinker` environment is the default environment. Only switch your environment if you have another board or that one is not working.
Most esp32Cams from Aliexpress will work with the `esp32AIThinker` environment, but some may require the `esp32cam` environment. Test the default environment first, and if it does not work, try the `esp32cam` environment. Most esp32Cams from Aliexpress will work with the `esp32AIThinker` environment, but some may require the `esp32cam` environment. Test the default environment first, and if it does not work, try the `esp32cam` environment.
::: :::
Currently supported boards: Currently supported boards:
- `esp32AIThinker` - The ESP32 Ai Thinker. - `esp32AIThinker` - This is the default environment. This is for the ESP32-AI-THINKER and generic alibaba/aliexpress/amazon esp cam boards.
- `esp32cam` - The ESP32 Camera. - `esp32Cam` - This is for the special ESP32-CAM, it is unlikely that you will need to use this environment.
- `esp_eye` - The Non-Esp32S3 version of the ESP-EYE camera. - `esp32M5Stack` - This is for ESP32M5Stack.
- `esp32M5Stack` - The ESP32 M5Stack camera. - `esp32WRover` - This is for the ESP32WRover.
- `wrover` - The ESP32 WRover (Non-ESP32-S3 variant). - `esp-eye` - This is for the ESP-EYE (not the S3 variant).
- `wrooms3` - For FREENOVE-ESP32-S3 (*wireless mode*)
- `wrooms3QIO` - For FREENOVE-ESP32-S3 (*wireless mode*, for boards with octal flash)
- `wrooms3USB` - For FREENOVE-ESP32-S3 (*wired mode*)
- `wrooms3QIOUSB` - For FREENOVE-ESP32-S3 (*wired mode*, for boards with octal flash)
- `xiaosenses3` - For SeedStudio's XAIO ESP32-S3 Sense (*wireless mode*)
- `xiaosenses3_USB` - For SeedStudio's XAIO ESP32-S3 Sense (*wired mode*)
::: tip Coming Soon You can change the board enviroment by changing the `default_envs` argument in `platformio.ini` to a supported board like shown:
<ImageCard :options="image_settings.esp_board_env"/>
- `esp32s3cam` - The ESP32-S3 Camera boards.
:::

View File

@ -502,6 +502,11 @@ const image_settings = {
url: "https://i.imgur.com/XgN2230.png", url: "https://i.imgur.com/XgN2230.png",
alt: "Screenshot showing the the controls setup", alt: "Screenshot showing the the controls setup",
max_width: "max-width: 600px;" max_width: "max-width: 600px;"
},
esp_board_env: {
url: "https://i.imgur.com/5BbQmCE.gif",
alt: "GIF showing a switch of board enviroments.",
max_width: "max-width: 600px;"
} }
}; };