morgan/esp32-wifi-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

what this thing all about?

Browse source
This commit is contained in:
Morgan Allen 2018-09-21 22:03:07 -07:00
parent 3051420dde
commit de8f1a4e4f
1 changed files with 18 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -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. 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? # What ~~*does*~~*will* it do?
* Stores info for multiple APs * Stores info for **multiple** APs
* Connects to "best" AP available * Connects to "best"\* AP available
* Remembers which AP was connected to last * Remembers which AP was connected to last
* Support more than basic auth
* Tells you you're a pretty alrigh person * 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 # API
## `EventGroupHandle_t wifi_manager_start()` ## `EventGroupHandle_t wifi_manager_start()`