EspWifiManager

A simple credential manager that takes care of the boring part of writing Wifi-based sketches on ESP: the WiFi setup boilerplate.

Contents

• EspWifiManager
  • Contents
  • About
  • Installation
    • PlatformIO
    • Arduino IDE
  • How to
  • License

About

This library manages your WiFi connection by doing two things:

• It auto-connects to the last WiFi network saved in the ESP non-volatile memory;
• It lets you input your WiFi connecton credentials via a browser-based interface;

By doing this, you don't have to re-flash your firmware every time you change WiFi network and you don't have to include your credentials into your code as hardcoded variables.

When the ESP can't connect to the network, it will switch into Access Point mode, and you will be able to connect to it through a WiFi-enabled device. Its address will be in the ESPWiFi-xxx format, where xxx is a string of three random digits.

After you connect to the ESP access point, you can input your WiFi ssid and key through a web interface available at the http://192.168.4.1 address.

Installation

PlatformIO

Add the library dependency to your platformio.ini. This is the preferred way to use the library, it's that easy!

[env:esp01_1m]
platform = espressif8266
board = esp01_1m
framework = arduino

lib_deps = abathargh/EspWifiManager

# or

lib_deps = https://github.com/antima/EspWifiManager.git

Arduino IDE

EspWifiManager depends on the following libraries:

• ESPAsyncWebServer
  • ESPAsyncTcp (Dependency of ESPAsyncWebServer)

To install these dependencies, you can clone the repositories in your Arduino/libraries directory:

cd /path/to/Arduino/libraries

git clone https://github.com/me-no-dev/ESPAsyncWebServer
git clone https://github.com/me-no-dev/ESPAsyncTCP

Clone this repository into your Arduino libraries folder, or click download zip from the upper right corner of this github page if you want to have a release with the latest features.

If you want download the zip version, you can add it to your environment by clicking Sketch -> Include Library -> Add -> .ZIP Library... and selecting the zip file you just downloaded.

How to

#include <EspWifiManager.h>

void setup() {
    // your setup
}

void loop() {
    WiFiManager.loop(); // call this in the loop function
    if(WiFiManager.isConnected())
    {
        // this is executed if the ESP is connected
        // to the network
    }
}

License

This library is released under the LGPL 2.1 license. The ESP Async WebServer library used by this library is released under the LGPL 2.1 license.

For more information regarding the licensing of the Arduino API, ESP8266 Arduino core, Arduino IDE, ecc, you can check out this page.