Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hieromon/autoconnect

An Arduino library for ESP8266/ESP32 WLAN configuration at runtime with the Web interface
https://github.com/hieromon/autoconnect

arduino-library esp32 esp32-arduino esp8266 esp8266-arduino menu wifi-configuration

Last synced: 2 days ago
JSON representation

An Arduino library for ESP8266/ESP32 WLAN configuration at runtime with the Web interface

Host: GitHub
URL: https://github.com/hieromon/autoconnect
Owner: Hieromon
License: mit
Created: 2018-03-13T00:59:54.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-07-08T12:45:58.000Z (6 months ago)
Last Synced: 2024-12-19T23:07:03.094Z (2 days ago)
Topics: arduino-library, esp32, esp32-arduino, esp8266, esp8266-arduino, menu, wifi-configuration
Language: C++
Homepage: https://hieromon.github.io/AutoConnect/
Size: 26.9 MB
Stars: 916
Watchers: 41
Forks: 191
Open Issues: 31
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# AutoConnect for ESP8266/ESP32

[![GitHub release](https://img.shields.io/github/v/release/Hieromon/AutoConnect)](https://github.com/Hieromon/AutoConnect/releases)
[![Build Status](https://github.com/Hieromon/AutoConnect/actions/workflows/build.yml/badge.svg)](https://github.com/Hieromon/AutoConnect/actions/workflows/build.yml)
[![arduino-library-badge](https://www.ardu-badge.com/badge/AutoConnect.svg?)](https://www.ardu-badge.com/AutoConnect)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/hieromon/library/AutoConnect.svg?version=1.4.2)](https://registry.platformio.org/packages/libraries/hieromon/AutoConnect?version=1.4.2)
[![License](https://img.shields.io/github/license/Hieromon/AutoConnect)](https://github.com/Hieromon/AutoConnect/blob/master/LICENSE)

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.

### 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 captive portal when vested the connection cannot be detected.
By using the [AutoConnect menu](https://hieromon.github.io/AutoConnect/menu.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.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.

### Easily add user-owned web screen and parameters ^{_{ENHANCED w/ v0.9.7}}

You can easily add your own web screen that can consist of representative HTML elements as the styled TEXT, INPUT, BUTTON, CHECKBOX, RADIO, SELECT, SUBMIT into the menu. It can be invoked from the AutoConnect menu and parameters can be passed.

### Just loading the JSON description ^{_{ENHANCED w/ v0.9.7}}

These HTML elements that make up the user-owned screen can be easily loaded from the JSON description stored in PROGMEM, SPIFFS or SD.

### Quick and easy to equip the OTA update feature ^{_{ENHANCED w/ v1.0.0}}

You can quickly and easily equip the [OTA update feature](https://hieromon.github.io/AutoConnect/otaupdate.html) to your sketch and also you can operate the firmware update process via OTA from 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
- Unexpected Maker TinyPICO
- And other ESP32 modules supported by the Additional Board Manager URLs of the Arduino-IDE.

## Simple usage

### The AutoConnect menu

### How embed the AutoConnect to the sketches you have

Most simple approach to applying AutoConnect for the existing sketches, follow the below steps.

## 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.html) with the most simple sketch for using AutoConnect.
- The [Basic usage](https://hieromon.github.io/AutoConnect/basicusage.html) guides to using the library correctly.
- Details are explained in the [Advanced usage](https://hieromon.github.io/AutoConnect/advancedusage.html).
- Details and usage of custom Web pages are explained in the [Custom Web pages](https://hieromon.github.io/AutoConnect/acintro.html).
- The [API reference](https://hieromon.github.io/AutoConnect/api.html) describes the AutoConnect functions specification.
- There are hints in [Examples](https://hieromon.github.io/AutoConnect/howtoembed.html) for making sketches with AutoConnect.
- [FAQ](https://hieromon.github.io/AutoConnect/faq.html).

## Change log

### [1.4.2] Jan. 31, 2023
- Supports whileConnecting exit called while waiting for WiFi connection. (Discussions [#553](https://github.com/Hieromon/AutoConnect/issues/553))
- Added AutoConnect::portalStatus function.
- Fixed compilation error with ESP8266 Arduino Core 3.1.0 or later. (Issue #567)

### [1.4.1] Jan. 5, 2023
- Supports asynchronous communication of custom web pages using the Fetch API. This allows interaction with the user without page transitions. See the [AutoConnect documentation](https://hieromon.github.io/AutoConnect/acinteract.html) for details. (Discussions [#503](https://github.com/Hieromon/AutoConnect/discussions/503))
- Added the FetchLED example.
- Added an AutoConnect::locate function.
- Fixed AutoConnectConfigBase constructor missing to AutoConnectConfigExt. (Issue [#551](https://github.com/Hieromon/AutoConnect/issues/551))

### [1.4.0] Nov. 20, 2022
- Custom web page related features were decoupled to allow for two different configurations, AutoConnectCore and AutoConnect. AutoConnectCore reduces memory consumption by focusing only on WiFi connectivity utilities. See the chapter [Reducing Binary Size](https://hieromon.github.io/AutoConnect/basicusage.html#reducing-binary-size) in the documentation for more information.
- Supports credentials backup and restoration.
- Added an AutoConnect::getCurrentCredential function.
- Added an AutoConnectAux::referer function.
- Added an AutoConnectConfig::preserveIP setting.
- Added the WebSocketServer example.
- Allow navigate to a custom URL once a WiFi connection is established. (Discussions #523)
- Revised mqttRSSI examples program structure.
- Fixed updateserver.py script security vulnerability. (Issue #526)

### [1.3.7] Aug. 20, 2022
- Fixed an authentication failure in Captive Portal state. (Issue #518)
- Fixed loss of current SSID.

### [1.3.6] Jul. 26, 2022
- Fixed OTA being incomplete. (Issue #325)

### [1.3.5] Jun. 03, 2022
- Fixed Fixed OTA exit not being called. (Issue #325)
- Fixed an ambiguous type call with IPAddress. (Issue #480)
- Fixed loss of response due to OTA session reset occurrence.
- Made fit the mqttRSSI examples to ThingSpeak's updated channel authentication.

### [1.3.4] Mar. 02, 2022
- Supports [LittleFS_esp32](https://github.com/lorol/LITTLEFS) legacy library with ESP32 Arduino core 1.0.6 or less.
- Added enablement of credentials removal function with Open SSIDs menu. (Discussions #433)
- Fixed AutoConnectOTA crashing if there is no OTA partition.
- Fixed AutoConnectUpdate crashing if there is no OTA partition.
- Migrate the CI platform to GitHub actions.

##### Breaking changes:
- Authentication has been applied to **RESET** menu. This avoids resetting modules in an unauthenticated state by direct access to `/_ac/reset`.

### [1.3.3] Jan. 25, 2022
- Fixed the missing initialization of MQTT parameter settings of mqttRSSI.ino example sketch.
- Reverted the MQTT API endpoint of Thingspeak.com in the mqttRSSI example sketches.
- Changed ESP32Cam XCLK to be attenuated to avoid interference with WiFi signals.

### [1.3.2] Jan. 1, 2022

- Supports AutoConnectRange as a new AutoConnectElement.
- Added the `responsive` parameter with AutoConnectAux.
- Added an AutoConnectAux::redirect function.
- Added an example for using AutoConnect with the ESP32 camera driver as WebCamServer. This example includes examples of using the new AutoConnectRange and an AutoConnectAux::redirect function.
- Fixed an issue where password is lost when SoftAP is stopped. (issue #425)

### [1.3.1] Oct. 09, 2021
- Fixed an issue that was incompatible with ArduinoJson version 5. (issue #408)
- Fixed LittleFS mount check not working with ESP32.
- Fixed autoReconnect not being able to restore a static IP setting. (issue #400)
- Fixed that static IP settings were not cleared when loading credential.

### [1.3.0] Sep. 25, 2021
- Supports ESP8266 3.0.0 Arduino core.
- Supports ESP32 Arduino core 2.0.0.
- Supports LittleFS with ESP32.
- Supports a callback with OTA status change. (issue #325)
- Supports to save credentials always. (Discussions #385)
- Supports AutoConnectConfigAux.
- Added AutoConnect::getConfig function.
- Added AutoConnectOTA status notification.
- Added a style attribute for AutoConnectInput.
- Added the div tag generation with the AutoConnectElement.
- Fixed AUTOCONNECT_JSONDOCUMENT_SIZE was inoperative.
- Fixed garbage being mixed in a loaded credential.
- Fixed the layout on the page being corrupted with NUMBER type of AutoConnectInput.
- Fixed the output place of Posterior attribute for AutoConnectRadio.
- Fixed Incomplete deletion with AutoConnectCredential. (issue #388)
- Fixed credentials not erased correctly. (issue #388)
- Fixed AutoConnectText posterior being unavailable.

##### Important Notes:

1. Upgraded Arduino core 2.0.0 for ESP32 will increase the compiled sketch binary size. Your sketch may not fit in the flash and may occur an error during the linkage phase.
In ESP32 Arduino core 2.0.0, the default maximum sketch binary size is 1280 KB, an area of the same size is reserved for OTA. 1472 KB is added as a file system area to this. You can change this partition definition at will with Arduino IDE for each build. You can also reallocate the SPIFFS area to the sketch binary if the sketch does not require a large file. Select menu `Tool` > `Partition Scheme`, you will be able to find a partition scheme that fits your sketch. Also, in the PlatformIO environment, it can be changed by adding the `board_build.partitions` directive to the `platformio.ini` file. See [FAQ](https://hieromon.github.io/AutoConnect/faq.html#sketch-size) of Documentation for details.
2. When building a sketch in the PlatformIO environment, a compile error may appear that says: *File system header file not found*. This error can be avoided by setting the library search mode to the `deep` in with the `platformio.ini` file. See [FAQ](https://hieromon.github.io/AutoConnect/faq.html#compile-error-due-to-file-system-header-file-not-found) of Documentation for details.

### [1.2.3] Jan. 3, 2021

Since AutoConnect v1.2.3, [PageBuilder](https://github.com/Hieromon/PageBuilder) v1.5.0 or later is required. Please update PageBuilder latest.

- Improved memory management

### [1.2.2] Dec. 13, 2020

- Fixed an issue where OTA updates would crash on the ESP32 platform. (issue #284)

### [1.2.1] Dec. 5, 2020

- Fixed that not declared error with `AUTOCONNECT_NOUSE_JSON`. (issue #282)

### [1.2.0] Dec. 3, 2020
- Supports LittleFS file system with ESP8266 platform.
- Supports HTTP authentication. (issue #171)
- Supports AutoConnectConfig::preserveAPMode setting. (issue #210)
- Supports an **onConnect** exit.
- Supports a **whileCaptivePortal** exit. (issue #149, issue #244)
- Enhanced ticker to work even in handleClient loop.
- Enhanced the ability to upload a regular file with AutoConnectOTA. (issue #236)
- Enhanced AutoConnectInput to allow accepts password and number type. (issue #237, issue #255)
- Enhanced handleClient to launch the captive portal when losing WiFi connection.
- Added **getEEPROMUsedSize** that notifies the occupied size of the credential storage area. (issue #209)
- Added the **append** and the **detach** function that can be dynamically AutoConnectAux attaching and detaching. (issue #230)
- Added **AUTOCONNECT_APKEY_SSID** definition to seek access points by SSID. (issue #251)
- Added AutoConnectConfig::beginTimeout setting. (issue #247)
- Improved atuoReconnect to work even in handleClient loop. (issue #234, issue #251)
- Fixed incorrect connection wait time. (issue #216)
- Fixed an exception in the AutoConnect::end function.
- Avoids an empty-body warning when AC_DEBUG is disabled. (issue #218)
- Fixed not being able to specify channel ID with a mqttRSSI.ino example. (issue #262)
- Fixed an invalid SPIFFS compile error with ESP32.
- Fixed a core panic in the regex with ESP32.
- Fixed posterior being disabled in AutoConnectElement.
- Fixed deficiently forward references with HandleClient.ino example. (PR #275)

### [1.1.7] Apr. 19, 2020
- Fixed Apply button not work. (issue #206)

### [1.1.6] Apr. 17, 2020
- Fixed OTA page translation not work. (issue #204)

### [1.1.5] Apr. 15, 2020
- Changed the bootUri behavior to be an automatic pop-up at the captive portal. (PR #181)
- Supports AutoConnect menu configuration.
- Supports the built-in OTA feature.
- Supports an attempt order when available APs would be found multiple, and RSSI lower bound on AP signal strength. This option can specify the order of connection attempting according to the WiFi signal strength indicated with RSSI. (PR #187)

### [1.1.4] Feb. 14, 2020
- Supports for overriding text of the menu items with user-defined labels.
- Fixed the compiler warning with experimental WiFi mode of ESP8266.

### [1.1.3] Jan. 1, 2020
- Added AUTOCONNECT_NOUSE_JSON directive. (issue #167)
- Removed compiler warning of unused.
- Improved Config New button behavior. (issue #150)
- Fixed relocate Config New menu URI inability.

### [1.1.2] Oct. 22, 2019
- Fixed crash when no SSID found.
- Fixed memory leak on destruction. (PR #144)

### [1.1.1] Oct. 17, 2019
- Fixed crash with unique_ptr deleting reference content. (issue #138)
- Fixed disconnection request initialization missing. (issue #139)

### [1.1.0] Oct. 15, 2019
- Supports static IPs with the 'Configure new AP' menu. (issue #132)
- Fixed compilation error that no member named 'printTo' with ArduinoJson 5.

### [1.0.3] Sept. 30, 2019
- Fixed a return of AutoConnectCredential::entries(). (issue #133)

### [1.0.2] Sept. 19, 2019
- Fixed compilation error that no member named 'success' with ArduinoJson 5. (issue #130)
- Fixed SSID non termination. (issue #128)
- Fixed compilation error that getBytesLength missing with ESP32. (issue #125)
- Added #include directive restriction for EEPROM and ESP8266httpUpdate to FAQ. (issue #127)

### [1.0.1] Sept. 13, 2019
- Added a sketch for ESP32 boards that migrates credentials stored in EEPROM partition to the Preferences.

### [1.0.0] Sept. 7, 2019
- Supports Arduino core for ESP32 1.0.3.
- Supports AutoConnectUpdate for the OTA update.
- Supports Preferences for saving credentials with ESP32 core 1.0.3 and later. **In ESP32, the credentials stored past in EEPROM will lose**.
- Supports AutoConnectAux::isValid function.
- Supports the global attribute with all AutoConnectElements.

### [0.9.12] Aug. 18, 2019
- Fixed missing captive portal notifications on the newer mobile OS client. As a result of this fix, the SoftAP default IP address and gateway have been changed to **172.217.28.1**. (issue #85)

### [0.9.11] July 13, 2019
- Supports new element as AutoConnectSytle that can insert the custom CSS into AutoConnectAux page. (PR#96)
- Supports that `
` tags can now be added to each element. (PR #95)
- Supports that able to place the checkbox label forward or backward. (PR #99)
- Supports flicker signal output according to the status of WiFi_mode. (issue #98)
- Supports AutoConnectAux::fetchElement function to retrieve inputted element values via a custom Web page.
- Fixed bug in AutoConnectCredential when offset is >256. (PR #103)

### [0.9.10] June 12, 2019
- Fixed the unable to get AutoConnectElemets values in the sketch with ESP8266 arduino core 2.5.2. (issue #90)
- Fixed missing psram allocator. (issue #102)

### [0.9.9] May 25, 2019
- Supports ESP8266 Arduino core 2.5.2.
- Menu text/background color can be statically customized. refer to the [Custom colorized](https://hieromon.github.io/AutoConnect/colorized.html) for the detailed specification for the menu colorizing.
- Added ID attribute to HTML tag generated from AutoConnectText.
- Added the enable attribute to the AutoConnectElements.
- Fixed the input box layout collapsed.
- Fixed that the decoration of AutoConnectButton was disabled.
- Fixed that the value remains even after clearing the option with AutoConnectSelect.
- Fixed that an alignment violation exception occurred when loading AutoConnectAux described by JSON with PROGMEM attribute.

### [0.9.8] May 3, 2019
- Supports ArduinoJson 6.9.1 or later.
- Supports allocating JsonDocument buffer to PSRAM on ESP32 with ArduinoJson 6.10.0 or later.
- Supports **operator`[]`** as a shortcut for AutoConnectAux::getElement function.
- Supports **AutoConnectElement::as** function to easily coding for conversion from an AutoConnectElement to an actual type.
- Supports new element type **AutoConnectFile** and built-in file uploader.
- Supports a **format** attribute with the AutoConnectText element.
- Supports a **selected** attribute with the AutoConnectSelect element.
- Supports multiple element loading with AutoConnectAux::loadElement.
- Changed menu labels placement in source files structure.
- Changed API interface of AutoConnect::where function.
- Fixed blank page responds with Configure new.
- Fixed loading elements value missing.
- Fixed losing elements in saveElement with ArduinoJson V6.
- Fixed compile error with older than ESP8266 core 2.5.0.

### [0.9.7] Feb. 25, 2019
- Fixed crash in some environments. Thank you @ageurtse
- Supports AutoConnect menu extension by user sketch with **AutoConnectAux**.
- Supports loading and saving of user-defined parameters with JSON format.
- Improved the WiFi connection sequence at the first WiFi.begin. Even if **AutoConnectConfig::autoReconnect** is disabled when SSID and PSK are not specified, it will use the information of the last established access point. The autoReconnect option will achieve trying the connect after a previous connection failed.
- Supports the **AutoConnectConfig::immediateStart** option and immediately starts the portal without first trying WiFi.begin. You can start the captive portal at any time in combination with the **AutoConnectConfig::autoRise** option.
- Improved boot uri after reset. **AutoConnectConfig::bootUri** can be specified either /_ac or HOME path as the uri to be accessed after invoking Reset from AutoConnect menu.
- Improved source code placement of predefined macros. Defined common macros have been moved to ```AutoConnectDefs.h```.
- Supports **AutoConnectConfig::hostName**. It activates ```WiFi.hostname()```.
- Supports the captive portal time-out. It can be controlled by **AutoConnectConfig::portalTimeout** and **AutoConnectConfig::retainPortal**.

### [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).