Initial commit

pull/8/head
Hieromon Ikasamo 7 years ago
parent 6e88c7d1ab
commit a528ee9d72
  1. 28
      README.md

@ -7,7 +7,7 @@ An Arduino library for ESP8266 WLAN configuration at run time with web interface
To the dynamic configuration for joining to WLAN with SSID and PSK accordingly. It an Arduino library united with *ESP8266WebServer* class.
Easily implementing the Web interface constituting the WLAN for ESP8266 WiFi connection. With this library to make a sketch easily which connects from ESP8266 to the access point at runtime by the web interface without hard-coded SSID and password.
<img width="460" src="docs/images/ov.png" /><img width="182" src="docs/images/ov.gif" />
<div align="center"><img alt="Overview" width="460" src="docs/images/ov.png" />&emsp;&emsp;&emsp;<img alt="Captiveportal" width="182" src="docs/images/ov.gif" /></div>
### No need pre-coded SSID &amp; password
@ -15,19 +15,19 @@ It is no needed hard-coding in advance the SSID and Password into the sketch to
### 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**, to manage the connections convenient.
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.
### <i class="fa fa-arrow-circle-right" aria-hidden="true"></i> Store the established connection
### Store the established connection
<span class="lead">The connection authentication data as credentials are saved automatically in EEPROM of ESP8266 and You can select the past SSID from the [AutoConnect menu](menu.md).</span>
The connection authentication data as credentials are saved automatically in EEPROM of ESP8266 and You can select the past SSID from the [AutoConnect menu](https://hieromon.github.io/AutoConnect/menu/index.html).
### <i class="fa fa-arrow-circle-right" aria-hidden="true"></i> Easy to embed in
### Easy to embed in
<span class="lead">AutoConnect can be embedded easily into your sketch, just "**begin**" and "**handleClient**".</span>
AutoConnect can be embedded easily into your sketch, just "**begin**" and "**handleClient**".
### <i class="fa fa-arrow-circle-right" aria-hidden="true"></i> Lives with the your sketches
### Lives with the your sketches
<span class="lead">The sketches which provide the web page using ESP8266WebServer there is, AutoConnect will not disturb it. AutoConnect can use an already instantiated ESP8266WebServer object, or itself can assign it.</span>
The sketches which provide the web page using ESP8266WebServer there is, AutoConnect will not disturb it. AutoConnect can use an already instantiated ESP8266WebServer object, or itself can assign it.
## Supported hardware
@ -52,17 +52,17 @@ Apply the [Arduino core](https://github.com/esp8266/Arduino) of the ESP8266 Comm
Most simple approach to applying AutoConnect for the existing sketches, follow the below steps.
<img src="docs/images/BeforeAfter.svg">
<div align="center"><img src="docs/images/BeforeAfter.svg" width="800"></div>
## More usages and Documentation
The documentation is available on https://Hieromon.github.io/AutoConnect, here are some shortcuts:
- Installation.
- Getting started.
- Usage the Library.
- API reference.
- FAQ.
- [Installation](https://hieromon.github.io/AutoConnect/index.html#installation).
- [Getting started](https://hieromon.github.io/AutoConnect/gettingstarted/index.html).
- [Usage the Library](https://hieromon.github.io/AutoConnect/usage/index.html).
- [API reference](https://hieromon.github.io/AutoConnect/api/index.html).
- [FAQ](https://hieromon.github.io/AutoConnect/faq/index.html).
## License

Loading…
Cancel
Save