You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
121 lines
6.0 KiB
121 lines
6.0 KiB
# AutoConnect for ESP8266/ESP32
|
|
|
|
[](https://travis-ci.org/Hieromon/AutoConnect)
|
|
[](https://github.com/Hieromon/AutoConnect/releases)
|
|
|
|
An Arduino library for ESP8266/ESP32 WLAN configuration at run time with web interface.
|
|
|
|
## Overview
|
|
|
|
To the dynamic configuration for joining to WLAN with SSID and PSK accordingly. It an Arduino library united with *ESP8266WebServer* class of ESP8266 or *WebServer* class of ESP32.
|
|
Easily implementing the Web interface constituting the WLAN for ESP8266/ESP32 WiFi connection. With this library to make a sketch easily which connects from ESP8266/ESP32 to the access point at runtime by the web interface without hard-coded SSID and password.
|
|
|
|
<div align="center"><img alt="Overview" width="460" src="docs/images/ov.png" />   <img alt="Captiveportal" width="182" src="docs/images/ov.gif" /></div>
|
|
|
|
### No need pre-coded SSID & password
|
|
|
|
It is no needed hard-coding in advance the SSID and Password into the sketch to connect between ESP8266/ESP32 and WLAN. You can input SSID & Password from a smartphone via the web interface at runtime.
|
|
|
|
### Simple usage
|
|
|
|
AutoConnect control screen will be displayed automatically for establishing new connections. It aids by the <a href="https://en.wikipedia.org/wiki/Captive_portal">captive portal</a> when vested the connection cannot be detected.<br>By using the [AutoConnect menu](https://hieromon.github.io/AutoConnect/menu/index.html), to manage the connections convenient.
|
|
|
|
### Store the established connection
|
|
|
|
The connection authentication data as credentials are saved automatically in EEPROM of ESP8266/ESP32 and You can select the past SSID from the [AutoConnect menu](https://hieromon.github.io/AutoConnect/menu/index.html).
|
|
|
|
### Easy to embed in
|
|
|
|
AutoConnect can be embedded easily into your sketch, just "**begin**" and "**handleClient**".
|
|
|
|
### Lives with the your sketches
|
|
|
|
The sketches which provide the web page using ESP8266WebServer/WebServer there is, AutoConnect will not disturb it. AutoConnect can use an already instantiated ESP8266WebServer object(ESP8266) or WebServer object(ESP32), or itself can assign it.
|
|
|
|
### Adding the user-owned web screen can easily <sup><sub>ENHANCED w/ v0.9.7</sub></sup>
|
|
|
|
You can easily add your own web screen with sketch. It can be called from the AutoConnect menu and parameters can be passed.
|
|
|
|
### Adding the extended menu with a simple code can easily <sup><sub>ENHANCED w/ v0.9.7</sub></sup>
|
|
|
|
Just loading the elements of portal screen extension written with JSON allows you to incorporate your owned portal screen into the AutoConnect menu.
|
|
|
|
## Supported hardware
|
|
|
|
Apply the [Arduino core](https://github.com/esp8266/Arduino) of the ESP8266 Community.
|
|
|
|
- Generic ESP8266 modules
|
|
- Adafruit HUZZAH ESP8266 (ESP-12)
|
|
- ESP-WROOM-02
|
|
- Heltec WiFi Kit 8
|
|
- NodeMCU 0.9 (ESP-12) / NodeMCU 1.0 (ESP-12E)
|
|
- Olimex MOD-WIFI-ESP8266
|
|
- SparkFun Thing
|
|
- SweetPea ESP-210
|
|
|
|
Alter the platform applying the [arduino-esp32](https://github.com/espressif/arduino-esp32) for the ESP32 modules.
|
|
|
|
- ESP32Dev Board
|
|
- SparkFun ESP32 Thing
|
|
- WEMOS LOLIN D32
|
|
- Ai-Thinker NodeMCU-32S
|
|
- Heltec WiFi Kit 32
|
|
- M5Stack
|
|
- And other ESP32 modules supported by the Additional Board Manager URLs of the Arduino-IDE.
|
|
|
|
## Simple usage
|
|
|
|
### The AutoConnect menu
|
|
|
|
<img src="mkdocs/images/menu_r.png" width="200"> <img src="mkdocs/images/statistics.png" width="200"> <img src="mkdocs/images/confignew.png"
|
|
width="200"> <img src="mkdocs/images/openssid.png" width="200">
|
|
|
|
### How embed the AutoConnect to the sketches you have
|
|
|
|
Most simple approach to applying AutoConnect for the existing sketches, follow the below steps.
|
|
|
|
<img src="mkdocs/images/beforeafter.png">
|
|
|
|
## More usages and Documentation
|
|
|
|
Full documentation is available on https://Hieromon.github.io/AutoConnect, some quick links at the list:
|
|
|
|
- The [Installation](https://hieromon.github.io/AutoConnect/index.html#installation) is the installation procedure and requirements for the library.
|
|
- [Getting started](https://hieromon.github.io/AutoConnect/gettingstarted/index.html) with the most simple sketch for using AutoConnect.
|
|
- The [Basic usage](https://hieromon.github.io/AutoConnect/basicusage/index.html) guides to using the library correctly.
|
|
- Details are explained in the [Advanced usage](https://hieromon.github.io/AutoConnect/advancedusage/index.html).
|
|
- The [API reference](https://hieromon.github.io/AutoConnect/api/index.html) describes the AutoConnect functions specification.
|
|
- [FAQ](https://hieromon.github.io/AutoConnect/faq/index.html).
|
|
|
|
## Change log
|
|
|
|
### [0.9.7] Nov. 11, 2018
|
|
- Supports AutoConnect menu extention by user sketch with **AutoConnectAux** implementation that attached **AutoConnectElement**.
|
|
- Supports loading and saving of user-defined parameters with JSON format.
|
|
- Supports AutoConnectConfig::immediateStart option, to start the portal immediately without first trying WiFi.begin.
|
|
- Improved source code placement of predefined macros. Defined macros have been moved to ```AutoConnectDefs.h```.
|
|
|
|
### [0.9.6] Sept. 27, 2018
|
|
- Improvement of RSSI detection for saved SSIDs.
|
|
- Fixed disconnection SoftAP completely at the first connection phase of the AutoConnect::begin.
|
|
|
|
### [0.9.5] Aug. 27, 2018
|
|
- Supports the espressif arduino-esp32 core.
|
|
- Fixed that crash may occur if the number of stored credentials in the EEPROM is smaller than the number of found WiFi networks.
|
|
|
|
### [0.9.4] May 5, 2018.
|
|
- Automatically focus passphrase after selecting SSID with Configure New AP.
|
|
- Supports AutoConnectConfig::autoReconnect option, it will scan the WLAN when it can not connect to the default SSID, apply the applicable credentials if it is saved, and try reconnecting.
|
|
|
|
### [0.9.3] March 23, 2018.
|
|
- Supports a static IP address assignment.
|
|
|
|
### [0.9.2] March 19, 2018.
|
|
- Improvement of string literal declaration with the examples, no library change.
|
|
|
|
### [0.9.1] March 13, 2018.
|
|
- A release of the stable.
|
|
|
|
## License
|
|
|
|
License under the [MIT license](LICENSE). |