From de8f1a4e4fb013943fc2052084a69affca5e558a Mon Sep 17 00:00:00 2001 From: Morgan Allen Date: Fri, 21 Sep 2018 22:03:07 -0700 Subject: [PATCH] what this thing all about? --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 87c9ba7..0cb3f99 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,29 @@ esp32-wifi-manager WiFi Manager for ESP32. That's it. No captive portal, no fallback if AP is not available. Just WiFi Management. +# Why +Most ESP32 WiFI Manager solutions are just hotspot captive portals that are used to (maybe) scan for and then +connect to an Access Point in the area. This is cumbersome if you want your device to be portable, connecting +to know APs in the area. + +This is intended to do one job. Handle connecting to WiFi. Feeding in the AP config info is up to you. But I +trust you and have faith you can do it! + # What ~~*does*~~*will* it do? -* Stores info for multiple APs -* Connects to "best" AP available +* Stores info for **multiple** APs +* Connects to "best"\* AP available * Remembers which AP was connected to last +* Support more than basic auth * Tells you you're a pretty alrigh person +\* **best** to be determined + +# How do I feed this thing? +Only basic `ssid` and `password` authenication are supported at the moment but adding will be the same in the future. +The API method wifi_manager_add_ap is used to add an Access Point to the config. It is automatically saved and if it +is current not connected, it will attempt to make a connection. + # API ## `EventGroupHandle_t wifi_manager_start()`