Are you looking to create a versatile ESP32-based project that involves setting up an HTTP server while operating in Access Point (AP) mode? In this article, I’ll guide you through the process of setting up an ESP32 HTTP server using the ESP-IDF framework, allowing you to establish a dedicated network for your IoT applications.
**ESP32: A Powerhouse for IoT Projects**
The ESP32 microcontroller is renowned for its robust capabilities and is an ideal choice for IoT projects. One of its key features is the ability to operate in various modes, including Station (STA) and Access Point (AP). When working with an ESP32 in AP mode, the microcontroller acts as a wireless hotspot, enabling devices to connect directly to it.
**Setting Up an HTTP Server**
To create an HTTP server on an ESP32, we’ll be using the Espressif IoT Development Framework (ESP-IDF). This powerful framework provides the necessary tools and libraries for building complex IoT applications. Follow these steps to set up your HTTP server:
1. **Initialize Your Project:** Start by setting up a new ESP-IDF project and configuring the necessary components.
2. **Configure AP Mode:** Configure the ESP32 to operate in AP mode, providing a network name (SSID) and password for other devices to connect.
3. **Implement the HTTP Server:** Utilize ESP-IDF’s built-in HTTP server libraries to create routes, handle requests, and send responses.
4. **Handle Requests:** Define endpoints for various functionalities, such as retrieving data from sensors or controlling connected devices.
5. **Customize Responses:** Tailor the HTTP responses according to your application’s needs, whether it’s displaying sensor data or providing control feedback.
6. **Testing and Debugging:** Thoroughly test your setup by connecting devices to the ESP32’s AP network and accessing the server through web browsers e.g. google chrome.
**Benefits of AP Mode**
Utilizing AP mode offers numerous advantages for IoT projects:
**Dedicated Network:** Devices can connect directly to the ESP32, eliminating the need for external networks.
**Enhanced Security:** As the controller manages the network, you have more control over security measures.
**Offline Functionality:** AP mode ensures functionality even when external networks are unavailable.
**References**
We will developement our project by using two example codes one is the Wi-Fi SoftAP Example and the Simple HTTPD Server Example. Here Wi-Fi SoftAp Example helps us to build ESP32 as an Access Point(AP) where the Station(STA) e.g. Mobile, Laptop can connect through the Wi-Fi network. Simple HTTPD Server Example helps us to build HTTP Server on ESP32 and we can fetch the data from the by sending an HTTP request from a web browser e.g. chrome. When Station is connected to Access Point the DHCP assigns an IP address for the Station. When sending an HTTP request from a web browser then we are using Access Point (ESP32) IP address which is assigned by DHCP. Note: If the IP address of the Station is 192.168.1.7 then the Access Point IP address should be always 192.168.1.1 and if we are fetching the data from the HTTP Server we have to follow http://192.168.1.1/uri from the browser. We can use Simple Access Point with HTTP Server Example code for developing our project.
This project application is to be used with Espressif IoT Development Framework.
Please check ESP-IDF docs for getting started instructions.
Simple AP with HTTP Server Code
/* Simple Access Point with HTTP Server Example Wi-Fi SoftAP Example + Simple HTTPD Server Example This example code is in the Public Domain (or CC0 licensed, at your option.) Unless required by applicable law or agreed to in writing, this software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ #include <esp_wifi.h> #include <esp_event.h> #include <esp_log.h> #include <esp_system.h> #include <nvs_flash.h> #include <sys/param.h> #include "nvs_flash.h" #include "esp_netif.h" #include "esp_eth.h" #include "esp_mac.h" #include "esp_tls_crypto.h" #include <esp_http_server.h> #include <string.h> #include "freertos/FreeRTOS.h" #include "freertos/task.h" #include "esp_system.h" #include "lwip/err.h" #include "lwip/sys.h" #include "esp_wifi_types.h" /* The examples use WiFi configuration that you can set via project configuration menu. If you'd rather not, just change the below entries to strings with the config you want - ie #define EXAMPLE_WIFI_SSID "mywifissid" */ #define EXAMPLE_ESP_WIFI_SSID "ESP32-S2" //CONFIG_ESP_WIFI_SSID #define EXAMPLE_ESP_WIFI_PASS "mypassword" //CONFIG_ESP_WIFI_PASSWORD #define EXAMPLE_MAX_STA_CONN 5 //CONFIG_ESP_MAX_STA_CONN /* A simple example that demonstrates how to create GET and POST * handlers for the web server. */ static const char *TAG = "wifi_AP_WEBserver"; /* An HTTP GET handler */ static esp_err_t hello_get_handler(httpd_req_t *req) { char* buf; size_t buf_len; /* Get header value string length and allocate memory for length + 1, * extra byte for null termination */ buf_len = httpd_req_get_hdr_value_len(req, "Host") + 1; if (buf_len > 1) { buf = malloc(buf_len); /* Copy null terminated value string into buffer */ if (httpd_req_get_hdr_value_str(req, "Host", buf, buf_len) == ESP_OK) { ESP_LOGI(TAG, "Found header => Host: %s", buf); } free(buf); } buf_len = httpd_req_get_hdr_value_len(req, "Test-Header-2") + 1; if (buf_len > 1) { buf = malloc(buf_len); if (httpd_req_get_hdr_value_str(req, "Test-Header-2", buf, buf_len) == ESP_OK) { ESP_LOGI(TAG, "Found header => Test-Header-2: %s", buf); } free(buf); } buf_len = httpd_req_get_hdr_value_len(req, "Test-Header-1") + 1; if (buf_len > 1) { buf = malloc(buf_len); if (httpd_req_get_hdr_value_str(req, "Test-Header-1", buf, buf_len) == ESP_OK) { ESP_LOGI(TAG, "Found header => Test-Header-1: %s", buf); } free(buf); } /* Read URL query string length and allocate memory for length + 1, * extra byte for null termination */ buf_len = httpd_req_get_url_query_len(req) + 1; if (buf_len > 1) { buf = malloc(buf_len); if (httpd_req_get_url_query_str(req, buf, buf_len) == ESP_OK) { ESP_LOGI(TAG, "Found URL query => %s", buf); char param[32]; /* Get value of expected key from query string */ if (httpd_query_key_value(buf, "query1", param, sizeof(param)) == ESP_OK) { ESP_LOGI(TAG, "Found URL query parameter => query1=%s", param); } if (httpd_query_key_value(buf, "query3", param, sizeof(param)) == ESP_OK) { ESP_LOGI(TAG, "Found URL query parameter => query3=%s", param); } if (httpd_query_key_value(buf, "query2", param, sizeof(param)) == ESP_OK) { ESP_LOGI(TAG, "Found URL query parameter => query2=%s", param); } } free(buf); } /* Set some custom headers */ httpd_resp_set_hdr(req, "Custom-Header-1", "Custom-Value-1"); httpd_resp_set_hdr(req, "Custom-Header-2", "Custom-Value-2"); /* Send response with custom headers and body set as the * string passed in user context*/ const char* resp_str = (const char*) req->user_ctx; httpd_resp_send(req, resp_str, HTTPD_RESP_USE_STRLEN); /* After sending the HTTP response the old HTTP request * headers are lost. Check if HTTP request headers can be read now. */ if (httpd_req_get_hdr_value_len(req, "Host") == 0) { ESP_LOGI(TAG, "Request headers lost"); } return ESP_OK; } static const httpd_uri_t hello = { .uri = "/hello", .method = HTTP_GET, .handler = hello_get_handler, /* Let's pass response string in user * context to demonstrate it's usage */ .user_ctx = "Hello World" }; /* An HTTP POST handler */ static esp_err_t echo_post_handler(httpd_req_t *req) { char buf[100]; int ret, remaining = req->content_len; while (remaining > 0) { /* Read the data for the request */ if ((ret = httpd_req_recv(req, buf, MIN(remaining, sizeof(buf)))) <= 0) { if (ret == HTTPD_SOCK_ERR_TIMEOUT) { /* Retry receiving if timeout occurred */ continue; } return ESP_FAIL; } /* Send back the same data */ httpd_resp_send_chunk(req, buf, ret); remaining -= ret; /* Log data received */ ESP_LOGI(TAG, "=========== RECEIVED DATA =========="); ESP_LOGI(TAG, "%.*s", ret, buf); ESP_LOGI(TAG, "===================================="); } // End response httpd_resp_send_chunk(req, NULL, 0); return ESP_OK; } static const httpd_uri_t echo = { .uri = "/echo", .method = HTTP_POST, .handler = echo_post_handler, .user_ctx = NULL }; /* This handler allows the custom error handling functionality to be * tested from client side. For that, when a PUT request 0 is sent to * URI /ctrl, the /hello and /echo URIs are unregistered and following * custom error handler http_404_error_handler() is registered. * Afterwards, when /hello or /echo is requested, this custom error * handler is invoked which, after sending an error message to client, * either closes the underlying socket (when requested URI is /echo) * or keeps it open (when requested URI is /hello). This allows the * client to infer if the custom error handler is functioning as expected * by observing the socket state. */ esp_err_t http_404_error_handler(httpd_req_t *req, httpd_err_code_t err) { if (strcmp("/hello", req->uri) == 0) { httpd_resp_send_err(req, HTTPD_404_NOT_FOUND, "/hello URI is not available"); /* Return ESP_OK to keep underlying socket open */ return ESP_OK; } else if (strcmp("/echo", req->uri) == 0) { httpd_resp_send_err(req, HTTPD_404_NOT_FOUND, "/echo URI is not available"); /* Return ESP_FAIL to close underlying socket */ return ESP_FAIL; } /* For any other URI send 404 and close socket */ httpd_resp_send_err(req, HTTPD_404_NOT_FOUND, "Some 404 error message"); return ESP_FAIL; } /* An HTTP PUT handler. This demonstrates realtime * registration and deregistration of URI handlers */ static esp_err_t ctrl_put_handler(httpd_req_t *req) { char buf; int ret; if ((ret = httpd_req_recv(req, &buf, 1)) <= 0) { if (ret == HTTPD_SOCK_ERR_TIMEOUT) { httpd_resp_send_408(req); } return ESP_FAIL; } if (buf == '0') { /* URI handlers can be unregistered using the uri string */ ESP_LOGI(TAG, "Unregistering /hello and /echo URIs"); httpd_unregister_uri(req->handle, "/hello"); httpd_unregister_uri(req->handle, "/echo"); /* Register the custom error handler */ httpd_register_err_handler(req->handle, HTTPD_404_NOT_FOUND, http_404_error_handler); } else { ESP_LOGI(TAG, "Registering /hello and /echo URIs"); httpd_register_uri_handler(req->handle, &hello); httpd_register_uri_handler(req->handle, &echo); /* Unregister custom error handler */ httpd_register_err_handler(req->handle, HTTPD_404_NOT_FOUND, NULL); } /* Respond with empty body */ httpd_resp_send(req, NULL, 0); return ESP_OK; } static const httpd_uri_t ctrl = { .uri = "/ctrl", .method = HTTP_PUT, .handler = ctrl_put_handler, .user_ctx = NULL }; static httpd_handle_t start_webserver(void) { httpd_handle_t server = NULL; httpd_config_t config = HTTPD_DEFAULT_CONFIG(); config.lru_purge_enable = true; // Start the httpd server ESP_LOGI(TAG, "Starting server on port: '%d'", config.server_port); if (httpd_start(&server, &config) == ESP_OK) { // Set URI handlers ESP_LOGI(TAG, "Registering URI handlers"); httpd_register_uri_handler(server, &hello); httpd_register_uri_handler(server, &echo); httpd_register_uri_handler(server, &ctrl); #if CONFIG_EXAMPLE_BASIC_AUTH httpd_register_basic_auth(server); #endif return server; } ESP_LOGI(TAG, "Error starting server!"); return NULL; } static esp_err_t stop_webserver(httpd_handle_t server) { // Stop the httpd server return httpd_stop(server); } static void disconnect_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data) { httpd_handle_t* server = (httpd_handle_t*) arg; if (*server) { ESP_LOGI(TAG, "Stopping webserver"); if (stop_webserver(*server) == ESP_OK) { *server = NULL; } else { ESP_LOGE(TAG, "Failed to stop http server"); } } } static void connect_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data) { httpd_handle_t* server = (httpd_handle_t*) arg; if (*server == NULL) { ESP_LOGI(TAG, "Starting webserver"); *server = start_webserver(); } } //------------------------------------------------------------------------------ static void wifi_event_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data) { if (event_id == WIFI_EVENT_AP_STACONNECTED) { wifi_event_ap_staconnected_t* event = (wifi_event_ap_staconnected_t*) event_data; ESP_LOGI(TAG, "station "MACSTR" join, AID=%d", MAC2STR(event->mac), event->aid); } else if (event_id == WIFI_EVENT_AP_STADISCONNECTED) { wifi_event_ap_stadisconnected_t* event = (wifi_event_ap_stadisconnected_t*) event_data; ESP_LOGI(TAG, "station "MACSTR" leave, AID=%d", MAC2STR(event->mac), event->aid); } } esp_err_t wifi_init_softap(void) { esp_netif_create_default_wifi_ap(); wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); ESP_ERROR_CHECK(esp_wifi_init(&cfg)); ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, ESP_EVENT_ANY_ID, &wifi_event_handler, NULL)); wifi_config_t wifi_config = { .ap = { .ssid = EXAMPLE_ESP_WIFI_SSID, .ssid_len = strlen(EXAMPLE_ESP_WIFI_SSID), .password = EXAMPLE_ESP_WIFI_PASS, .max_connection = EXAMPLE_MAX_STA_CONN, .authmode = WIFI_AUTH_WPA_WPA2_PSK }, }; if (strlen(EXAMPLE_ESP_WIFI_PASS) == 0) { wifi_config.ap.authmode = WIFI_AUTH_OPEN; } ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_AP)); ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_AP, &wifi_config)); ESP_ERROR_CHECK(esp_wifi_start()); ESP_LOGI(TAG, "wifi_init_softap finished. SSID:%s password:%s", EXAMPLE_ESP_WIFI_SSID, EXAMPLE_ESP_WIFI_PASS); return ESP_OK; } //------------------------------------------------------------------------------ void app_main(void) { static httpd_handle_t server = NULL; ESP_LOGI(TAG, "NVS init"); ESP_ERROR_CHECK(nvs_flash_init()); ESP_ERROR_CHECK(esp_netif_init()); ESP_LOGI(TAG, "Eventloop create"); ESP_ERROR_CHECK(esp_event_loop_create_default()); /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig. * Read "Establishing Wi-Fi or Ethernet Connection" section in * examples/protocols/README.md for more information about this function. */ ESP_LOGI(TAG, "init softAP"); ESP_ERROR_CHECK(wifi_init_softap()); /* Register event handlers to stop the server when Wi-Fi or Ethernet is disconnected, * and re-start it upon connection. */ #ifdef CONFIG_EXAMPLE_CONNECT_WIFI ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &connect_handler, &server)); ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_DISCONNECTED, &disconnect_handler, &server)); #endif // CONFIG_EXAMPLE_CONNECT_WIFI #ifdef CONFIG_EXAMPLE_CONNECT_ETHERNET ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &connect_handler, &server)); ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server)); #endif // CONFIG_EXAMPLE_CONNECT_ETHERNET /* Start the server for the first time */ server = start_webserver(); }