uploaded 1 month ago
esp32-wifi-manager is a pure C esp-idf component for ESP32 that enables easy management of wifi networks through a web portal.


# What is esp32-wifi-manager?

### Build status [![Build Status](https://travis-ci.com/tonyp7/esp32-wifi-manager.svg?branch=master)](https://travis-ci.com/tonyp7/esp32-wifi-manager)

*esp32-wifi-manager* is a pure C esp-idf component for ESP32 that enables easy management of wifi networks through a web portal.

*esp32-wifi-manager* is is an all in one wifi scanner, http server & dns daemon living in the least amount of RAM possible.

*esp32-wifi-manager* will automatically attempt to re-connect to a previously saved network on boot, and if it cannot find a saved wifi it will start its own access point through which you can manage and connect to wifi networks. Upon a succesful connection, the software will shutdown the access point automatically after some time (1 minute by default).

*esp32-wifi-manager* compiles with esp-idf 4.2 and above. See [Getting Started](#getting-started) to guide you through your first setup.

# Content
- [What is esp32-wifi-manager?](#what-is-esp32-wifi-manager)
    - [Build status ](#build-status-)
- [Content](#content)
- [Look and Feel](#look-and-feel)
- [Getting Started](#getting-started)
  - [Requirements](#requirements)
  - [Hello World](#hello-world)
  - [Configuring the Wifi Manager](#configuring-the-wifi-manager)
- [Adding esp32-wifi-manager to your code](#adding-esp32-wifi-manager-to-your-code)
  - [Interacting with the manager](#interacting-with-the-manager)
    - [List of events](#list-of-events)
    - [Events parameters](#events-parameters)
  - [Interacting with the http server](#interacting-with-the-http-server)
  - [Thread safety and access to NVS](#thread-safety-and-access-to-nvs)
- [License](#license)

# Look and Feel

# Getting Started

## Requirements

To get you started, esp32-wifi-manager needs:

- esp-idf **4.2 and up**
- esp32 or esp32-s2

There are breaking changes and new features in esp-idf 4.1 and 4.2 which makes esp32-wifi-manager incompatible with anything lower than 4.2. This includes esp_netif (introduced in 4.1) and esp_event_handler_instance_t (introduced in 4.2). It is recommended to compile esp32-wifi-manager with the master tree to avoid any compatibility issue.

## Hello World

Clone the repository where you want it to be. If you are unfamiliar with Git, you can use Github Desktop on Windows:

git clone https://github.com/JackHuang021/esp32-wifi-manager.git

Navigate under the included example:

cd esp32-wifi-manager/examples/default_demo

Compile the code and load it on your esp32:

idf.py build flash monitor

_Note: while it is encouraged to use the newer build system with idf.py and cmake, esp32-wifi-manager still supports the legacy build system. If you are using make on Linux or make using MSYS2 on Windows, you can still use "make build flash monitor" if you prefer_

Now, using any wifi capable device, you will see a new wifi access point named *esp32*. Connect to it using the default password *esp32pwd*. If the captive portal does not pop up on your device, you can access the wifi manager at its default IP address:

## Configuring the Wifi Manager

esp32-wifi-manager can be configured without touching its code. At the project level use:

idf.py menuconfig

Navigate in "Component config" then pick "Wifi Manager Configuration". You will be greeted by the following screen:

![esp32-wifi-manager-menuconfig](https://raw.githubusercontent.com/JackHuang021/images/master/20240603230323.png "menuconfig screen")

You can change the ssid and password of the access point at your convenience, but it is highly recommended to keep default values. Your password should be between 8 and 63 characters long, to comply with the WPA2 standard. If the password is set to an empty value or is less than 8 characters long, esp32-wifi-manager will create its access point as an open wifi network.

You can also change the values for various timers, for instance how long it takes for the access point to shutdown once a connection is established (default: 60000). While it could be tempting to set this timer to 0, just be warned that in that case the user will never get the feedback that a connection is succesful. Shutting down the AP will instantly kill the current navigating session on the captive portal.

Finally, you can choose to relocate esp32-wifi-manager to a different URL by changing the default value of "/" to something else, for instance "/wifimanager/". Please note that the trailing slash does matter. This feature is particularly useful in case you want your own webapp to co-exist with esp32-wifi-manager's own web pages.

# Adding esp32-wifi-manager to your code

In order to use esp32-wifi-manager effectively in your esp-idf projects, copy the whole esp32-wifi-manager repository (or git clone) into a components subfolder.

Your project should look like this:

  - project_folder
    - build
    - components
      - esp32-wifi-manager
    - main
      - main.c

Once this is done, you need to edit the CMakeLists.txt file at the root of your project to register the components folder. This is done by adding the following line:

set(EXTRA_COMPONENTS_DIRS components/)

A typical CmakeLists.txt file should look like this:

cmake_minimum_required(VERSION 3.5)
set(EXTRA_COMPONENT_DIRS components/)

If you are using the old build system with make instead, you should edit the Makefile instead such as:

PROJECT_NAME := name_of_your_project
include $(IDF_PATH)/make/project.mk

Once this is done, you can now in your user code add the header:

#include "wifi_manager.h"

All you need to do now is to call wifi_manager_start(); in your code. See [examples/default_demo](examples/default_demo) if you are uncertain.

## Interacting with the manager

Ther are effectively three different ways you can embed esp32-wifi-manager with your code:
* Just forget about it and poll in your code for wifi connectivity status
* Use event callbacks
* Modify esp32-wifi-manager code directly to fit your needs

**Event callbacks** are the cleanest way to use the wifi manager and that's the recommended way to do it. A typical use-case would be to get notified when wifi manager finally gets a connection to an access point. In order to do this you can simply define a callback function:

void cb_connection_ok(void *pvParameter){
	ESP_LOGI(TAG, "I have a connection!");

Then just register it by calling:

wifi_manager_set_callback(WM_EVENT_STA_GOT_IP, &cb_connection_ok);

That's it! Now everytime the event is triggered it will call this function. The [examples/default_demo](examples/default_demo) contains sample code using callbacks.

### List of events

The list of possible events you can add a callback to are defined by message_code_t in wifi_manager.h. They are as following:


In practice, keeping track of WM_EVENT_STA_GOT_IP and WM_EVENT_STA_DISCONNECTED is key to know whether or not your esp32 has a connection. The other messages can mostly be ignored in a typical application using esp32-wifi-manager.

### Events parameters

Callback signature includes a void* pointer. For most events, this additional parameter is empty and sent as a NULL value. A few select events have additional data which can be leveraged by user code. They are listed below:

* WM_EVENT_SCAN_DONE is sent with a wifi_event_sta_scan_done_t* object.
* WM_EVENT_STA_DISCONNECTED is sent with a wifi_event_sta_disconnected_t* object.
* WM_EVENT_STA_GOT_IP is sent with a ip_event_got_ip_t* object.

These objects are standard esp-idf structures, and are documented as such in the [official pages](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/network/esp_wifi.html).

The [examples/default_demo](examples/default_demo) demonstrates how you can read a ip_event_got_ip_t object to access the IP address assigned to the esp32.

## Interacting with the http server

Because esp32-wifi-manager spawns its own http server, you might want to extend this server to serve your own pages in your application. It is possible to do so by registering your own URL handler using the standard esp_http_server signature:

esp_err_t my_custom_handler(httpd_req_t *req){

And then registering the handler by doing

http_app_set_handler_hook(HTTP_GET, &my_custom_handler);

The [examples/http_hook](examples/http_hook) contains an example where a web page is registered at /helloworld

## Thread safety and access to NVS

esp32-wifi-manager accesses the non-volatile storage to store and loads its configuration into a dedicated namespace "espwifimgr". If you want to make sure there will never be a conflict with concurrent access to the NVS, you can include nvs_sync.h and use calls to nvs_sync_lock and nvs_sync_unlock.

nvs_handle handle;

if(nvs_sync_lock( portMAX_DELAY )){  
    if(nvs_open(wifi_manager_nvs_namespace, NVS_READWRITE, &handle) == ESP_OK){
        /* do something with NVS */
nvs_sync_lock waits for the number of ticks sent to it as a parameter to acquire a mutex. It is recommended to use portMAX_DELAY. In practice, nvs_sync_lock will almost never wait.

# License
*esp32-wifi-manager* is MIT licensed. As such, it can be included in any project, commercial or not, as long as you retain original copyright. Please make sure to read the license file.


Supports all targets

License: MIT

To add this component to your project, run:

idf.py add-dependency "jackhuang021/esp32-wifi-manager^0.0.3"

or download archive


  • Archive size
    Archive size: 46.75 KB
  • Downloaded in total
    Downloaded in total 35 times
  • Downloaded this version
    This version: 26 times


jackhuang021/esp32-wifi-manager version: 0.0.3