Skip to content

Commit

Permalink
add a build in UI
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinVerges committed Jan 6, 2025
1 parent 8ba253f commit dc2b194
Show file tree
Hide file tree
Showing 5 changed files with 422 additions and 5 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,18 @@ It is only made and tested it on my ESP32 Microcontroller.

### More detailed flow diagram

<img src="documentation/flow-diagram.png?raw=true" alt="Flow diagram" width="40%">
<img src="documentation/flow-diagram.png?raw=true" alt="Flow diagram" width="40%" style="background-color: white">

## What do I need to do?

If you want to use this wifi manager, you have to create your own Web UI for it!
It won't give you a premade styled UI to configure the SSID credentials.
If you want to use this wifi manager, you can create your own Web UI or use a prebuild one available at `/wifi`!

## Build in UI

The UI route is only loaded to `/wifi` if you execute `attachUI()` inside your script.

<img src="documentation/ui.png?raw=true" alt="Build in UI" width="40%">


## APIs

Expand Down
Binary file added documentation/ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion examples/src/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* @file basic-usage.cpp
* @brief Short minimal example to make use of the ESP32 Wifi Manager
* @author Martin Verges <[email protected]>
* @copyright 2022
* @copyright 2022-2025
*
* Licensed under CC BY-NC-SA 4.0
* (Attribution-NonCommercial-ShareAlike 4.0 International)
Expand All @@ -24,6 +24,7 @@ void setup() {
WifiManager.startBackgroundTask(); // Run the background task to take care of our Wifi
WifiManager.fallbackToSoftAp(true); // Run a SoftAP if no known AP can be reached
WifiManager.attachWebServer(&webServer); // Attach our API to the Webserver
WifiManager.attachUI(); // Attach the UI to the Webserver

// Run the Webserver and add your webpages to it
webServer.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
Expand Down
Loading

0 comments on commit dc2b194

Please sign in to comment.