diff --git a/vitepress/docs/src/custom/theme/index.ts b/vitepress/docs/src/custom/theme/index.ts index 2e37651..8bedb14 100644 --- a/vitepress/docs/src/custom/theme/index.ts +++ b/vitepress/docs/src/custom/theme/index.ts @@ -48,7 +48,9 @@ const theme = { { 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: "Getting Started", link: "/firmware_guide/upload_firmware" }, + { text: "Upload Firmare", link: "/firmware_guide/upload_firmware" }, + { text: "MDNS", link: "/firmware_guide/mdns" }, + { text: "REST API", link: "/firmware_guide/rest_api" }, ], }, { diff --git a/vitepress/docs/src/pages/firmware_guide/configure_firmware.md b/vitepress/docs/src/pages/firmware_guide/configure_firmware.md index a613009..77f87ba 100644 --- a/vitepress/docs/src/pages/firmware_guide/configure_firmware.md +++ b/vitepress/docs/src/pages/firmware_guide/configure_firmware.md @@ -15,7 +15,21 @@ import { alerts } from '../../static/alerts' -On lines 17 and 18 replace the placeholder text with your correct SSID (WiFi access point name), and password respectfully. +Replace the placeholder text with your correct SSID (WiFi access point name), and password respectfully. + +::: info +Special characters such as `!` and `@` are not supported. If you have a special character in your password or ssid, you will need to change it. + +Spaces are not supported either. If you have a space in either, you will need to change it. + +The firmware supports AP mode, but it is not recommended. If you are using AP mode, you will need to set the `enableadhoc` to `1`. + +Then, you will need to set the `ap_ssid` to the name of your AP, and `ap_password` to the password of your AP. + +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. +:::