fix: edit configure firmware docs

This commit is contained in:
ZanzyTHEbar 2023-02-12 12:52:15 +00:00
parent ed82853204
commit c09720a365

View File

@ -28,7 +28,7 @@ Then, you will need to set the `ap_ssid` to the name of your AP, and `ap_passwor
You can choose to leave the `ap_ssid` and `ap_password` as defaults, but you will need to set the `enableadhoc` to `1`.
Note, if you are enabling AP mode for both ESPs, you will need to set the `ap_ssid` and `ap_password` to different values for both ESPs. It is best to set AP mode only for one ESP, and leave the other ESP in STA mode. Connect the other ESP to the AP of the ESP in AP mode. Then connect your computer to the AP of the ESP in AP mode. This will allow you to connect to the ESP in AP mode, and the ESP in STA mode.
> **Note**: If you are enabling AP mode for both ESPs, you will need to set the `ap_ssid` and `ap_password` to different values for both ESPs. It is best to set AP mode only for one ESP, and leave the other ESP in STA mode. Connect the other ESP to the AP of the ESP in AP mode. Then connect your computer to the AP of the ESP in AP mode. This will allow you to connect to the ESP in AP mode, and the ESP in STA mode.
:::
<Alerts :options="alerts.parts_list_one">
@ -45,7 +45,7 @@ Double check that you have correctly entered your WiFi credentials and that said
#### `mDNS`
If you do not wish to manually keep track of the ESPs IP addresses and ports, you can enable the mDNS feature. This will allow you to connect to the ESPs using the following format: `http://<some_name>.local`. This will only work if you are connected to the same network as the ESPs,and if you have enabled mDNS on your computer. If you are using Windows, you can enable mDNS by following [this guide](/firmware_guide/mdns.html).
If you do not wish to manually keep track of the ESPs IP addresses and ports, you can enable the mDNS feature. This will allow you to connect to the ESPs using the following format: `http://<some_name>.local`. This will only work if you are connected to the same network as the ESPs, and if you have enabled mDNS on your computer. If you are using Windows, you can enable mDNS by following [this guide](/firmware_guide/mdns.html).
#### `OTA`
@ -59,28 +59,34 @@ The firmware also supports a fully featured REST API. This means that you can co
This feature is used more for advanced users, and is not required for basic operation.
The REST API was developed to be used by our new app (still in development). However, it can be used by any REST API client, you can not send POST requests to the ESPs using a browser though, so some REST API functionality can only be used by tools like [Thunder Client](https://www.thunderclient.com/) and [Postman](https://www.postman.com/).
The REST API was developed to be used by our new app (still in development). However, it can be used by any REST API client, you can not send POST requests to the ESPs using a browser though, so some REST API functionality can only be used by tools like [Thunder Client](https://www.thunderclient.com/) or [Postman](https://www.postman.com/).
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:
- `esp32AIThinker` - This is the default environment. This is for the ESP32-AI-THINKER.
- `esp32Cam` - This is for the ESP32-CAM.
- `esp32AIThinker` - This is the default environment. This is for the ESP32-AI-THINKER and generic alibaba/aliexpress/amazon esp cam boards.
- `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).
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. This will save memory, and will make the firmware faster.
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 GIFs below to change the environment.
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
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.
:::