GitHub - khoih-prog/WebServer_ESP32_W5500: Simple Ethernet WebServer, HTTP/HTTPS Client wrapper library for ESP32 boards using W5500 with LwIP Ethernet library. The WebServer supports HTTP(S) GET and POST requests, provides argument parsing, handles one client at a time. It provides HTTP(S), MQTT(S) Client and supports WebServer serving from LittleFS/SPIFFS

WebServer_ESP32_W5500 Library

Why do we need this WebServer_ESP32_W5500 library
- Features
- Sibling libraries
- Currently supported Boards
Changelog
Prerequisites
Installation
- Use Arduino Library Manager
- Manual Install
- VS Code & PlatformIO
Libraries' Patches
- 1. For fixing ESP32 compile error
HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)
- 1. ESP32 has 2 ADCs, named ADC1 and ADC2
- 2. ESP32 ADCs functions
- 3. ESP32 WiFi uses ADC2 for WiFi functions
Usage
- Class Constructor
- Basic Operation
- Advanced Options
- Other Function Calls
How to connect W5500 to ESP32
Examples
- Original Examples
Example AdvancedWebServer
- File AdvancedWebServer.ino
Debug Terminal Output Samples
- 1. AdvancedWebServer on ESP32_DEV with ESP32_W5500
- 2. MQTT_ThingStream on ESP32_DEV with ESP32_W5500
- 3. MQTTClient_Auth on ESP32_DEV with ESP32_W5500
- 4. MQTTClient_Basic on ESP32_DEV with ESP32_W5500
- 6. WebClient on ESP32_DEV with ESP32_W5500
- 7. UDPSendReceive on ESP32_DEV with ESP32_W5500
Debug
Troubleshooting
Releases
Issues
TO DO
DONE
Contributions and Thanks
Contributing
License
Copyright

Why do we need this WebServer_ESP32_W5500 library

Features

This WebServer_ESP32_W5500 library is a simple yet complete WebServer wrapper library for ESP32-based boards using LwIP W5500 Ethernet. The functions are similar and compatible to those of ESP32 WebServer and ESP8266WebServer libraries to make life much easier to port sketches from ESP8266/ESP32.

This WebServer_ESP32_W5500 library also provides high-level HTTP(S), MQTT(S) and WebSockets Client by using the functions from ESP32's HTTPClient Library

The library provides these features:

TCP Server and Client
UDP Server and Client
HTTP(S) Server and Client
HTTP(S) GET and POST requests, provides argument parsing, handles one client at a time.
High-level HTTP(S) (GET, POST, PUT, PATCH, DELETE), MQTT(S) and WebSocket Client.

Library is providing similar functions to:

Sibling libraries

Please also check these sibling libraries

WebServer_WT32_ETH01 for ESP32-based WT32_ETH01 using LwIP LAN8720
WebServer_ESP32_ENC for ESP32-boards using LwIP ENC28J60
WebServer_ESP32_W5500 for ESP32-boards using LwIP W5500
WebServer_ESP32_W6100 for ESP32-boards using LwIP W6100
WebServer_ESP32_SC_ENC for ESP32_S3-boards using LwIP ENC28J60
WebServer_ESP32_SC_W5500 for ESP32_S3-boards using LwIP W5500
WebServer_ESP32_SC_W6100 for ESP32_S3-boards using LwIP W6100

and more complex libraries for ESP32-based using LwIP Ethernet

General Libraries

ESP32_Ethernet_Manager Libraries

AsyncESP32_Ethernet_Manager Libraries

AsyncUDP_ESP32 Libraries

AsyncDNSServer_ESP32 Libraries

Currently supported Boards

This WebServer_ESP32_W5500 library currently supports these following boards:

ESP32_DEV using LwIP W5500 Ethernet

W5500

FULL_DUPLEX, 100Mbps

Prerequisites

Arduino IDE 1.8.19+ for Arduino.
ESP32 Core 2.0.6+ for ESP32-based ESP32_DEV with W5500 boards.

Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for WebServer_ESP32_W5500, then select / install the latest version. You can also use this link for more detailed instructions.

Manual Install

Navigate to WebServer_ESP32_W5500 page.
Download the latest release WebServer_ESP32_W5500-main.zip.
Extract the zip file to WebServer_ESP32_W5500-main directory
Copy the whole WebServer_ESP32_W5500-main folder to Arduino libraries' directory such as ~/Arduino/libraries/.

VS Code & PlatformIO:

Install VS Code
Install PlatformIO
Install WebServer_ESP32_W5500 library by using Library Manager. Search for WebServer_ESP32_W5500 in Platform.io Author's Libraries
Use included platformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at Project Configuration File

Libraries' Patches

1. For fixing ESP32 compile error

To fix ESP32 compile error, just copy the following file into the ESP32 cores/esp32 directory (e.g. ./arduino-1.8.19/hardware/espressif/cores/esp32) to overwrite the old file:

Server.h

HOWTO Fix `Multiple Definitions` Linker Error

The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain Multiple Definitions Linker error in certain use cases.

You can include this .hpp file

// Can be included as many times as necessary, without `Multiple Definitions` Linker Error
#include "WebServer_ESP32_W5500.hpp"     //https://github.com/khoih-prog/WebServer_ESP32_W5500

in many files. But be sure to use the following .h file in just 1 .h, .cpp or .ino file, which must not be included in any other file, to avoid Multiple Definitions Linker Error

// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include "WebServer_ESP32_W5500.h"           //https://github.com/khoih-prog/WebServer_ESP32_W5500

Check the new multiFileProject example for a HOWTO demo.

HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

Please have a look at ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to have more detailed description and solution of the issue.

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

ADC1 controls ADC function for pins GPIO32-GPIO39
ADC2 controls ADC function for pins GPIO0, 2, 4, 12-15, 25-27

3.. ESP32 WiFi uses ADC2 for WiFi functions

Look in file adc_common.c

In ADC2, there're two locks used for different cases:

lock shared with app and Wi-Fi: ESP32: When Wi-Fi using the ADC2, we assume it will never stop, so app checks the lock and returns immediately if failed. ESP32S2: The controller's control over the ADC is determined by the arbiter. There is no need to control by lock.

lock shared between tasks: when several tasks sharing the ADC2, we want to guarantee all the requests will be handled. Since conversions are short (about 31us), app returns the lock very soon, we use a spinlock to stand there waiting to do conversions one by one.

adc2_spinlock should be acquired first, then adc2_wifi_lock or rtc_spinlock.

In order to use ADC2 for other functions, we have to acquire complicated firmware locks and very difficult to do
So, it's not advisable to use ADC2 with WiFi/BlueTooth (BT/BLE).
Use ADC1, and pins GPIO32-GPIO39
If somehow it's a must to use those pins serviced by ADC2 (GPIO0, 2, 4, 12, 13, 14, 15, 25, 26 and 27), use the fix mentioned at the end of ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to work with ESP32 WiFi/BlueTooth (BT/BLE).

Usage

Class Constructor

WebServer server(80);

Creates the WebServer_ESP32_W5500 class object.

Parameters:

host port number: int port (default is the standard HTTP port 80)

Basic Operations

Starting the server

void begin();

Handling incoming client requests

void handleClient();

Disabling the server

void close();
void stop();

Both methods function the same

Client request handlers

void on();
void addHandler();
void onNotFound();
void onFileUpload();

Example:

server.on("/", handlerFunction);
server.onNotFound(handlerFunction);   // called when handler is not assigned
server.onFileUpload(handlerFunction); // handle file uploads

Sending responses to the client

void send();
void send_P();

Parameters:

code - HTTP response code, can be 200 or 404, etc.

content_type - HTTP content type, like "text/plain" or "image/png", etc.

content - actual content body

Advanced Options

Getting information about request arguments

const String & arg();
const String & argName();
int args();
bool hasArg();

Function usage:

arg - get request argument value, use arg("plain") to get POST body

argName - get request argument name

args - get arguments count

hasArg - check if argument exist

Getting information about request headers

const String & header();
const String & headerName();
const String & hostHeader();
int headers();
bool hasHeader();

Function usage:

header - get request header value

headerName - get request header name

hostHeader - get request host header if available, else empty string

headers - get header count

hasHeader - check if header exist

Authentication

bool authenticate();
void requestAuthentication();

Function usage:

authenticate - server authentication, returns true if client is authenticated else false

requestAuthentication - sends authentication failure response to the client

Example Usage:

if(!server.authenticate(username, password))
{
  server.requestAuthentication();
}

Other Function Calls

const String & uri();     // get the current uri
HTTPMethod  method();     // get the current method 
WiFiClient client();      // get the current client
HTTPUpload & upload();    // get the current upload
void setContentLength();  // set content length
void sendHeader();        // send HTTP header
void sendContent();       // send content
void sendContent_P(); 
void collectHeaders();    // set the request headers to collect
void serveStatic();
size_t streamFile();

How to connect W5500 to ESP32

You can change the INT pin to another one. Default is GPIO4

// Must connect INT to GPIOxx or not working
#define INT_GPIO            4

W5500

FULL_DUPLEX, 100Mbps

ESP32_DEV

W5500	<--->	ESP32
MOSI	<--->	GPIO23
MISO	<--->	GPIO19
SCK	<--->	GPIO18
SS/CS	<--->	GPIO5
INT	<--->	GPIO4
RST	<--->	RST
GND	<--->	GND
3.3V	<--->	3.3V

Examples:

Original Examples

Example AdvancedWebServer

File AdvancedWebServer.ino

WebServer_ESP32_W5500/examples/AdvancedWebServer/AdvancedWebServer.ino

Lines 41 to 275 in c8bccad

    
           #if !( defined(ESP32) ) 
        
             #error This code is designed for (ESP32 + W5500) to run on ESP32 platform! Please check your Tools->Board setting. 
        
           #endif 
        
           #define DEBUG_ETHERNET_WEBSERVER_PORT       Serial 
        
           // Debug Level from 0 to 4 
        
           #define _ETHERNET_WEBSERVER_LOGLEVEL_       3 
        
           ////////////////////////////////////////////////////////// 
        
           // Optional values to override default settings 
        
           // Don't change unless you know what you're doing 
        
           //#define ETH_SPI_HOST        SPI3_HOST 
        
           //#define SPI_CLOCK_MHZ       25 
        
           // Must connect INT to GPIOxx or not working 
        
           //#define INT_GPIO            4 
        
           //#define MISO_GPIO           19 
        
           //#define MOSI_GPIO           23 
        
           //#define SCK_GPIO            18 
        
           //#define CS_GPIO             5 
        
           ////////////////////////////////////////////////////////// 
        
           #include <WebServer_ESP32_W5500.h> 
        
           WebServer server(80); 
        
           // Enter a MAC address and IP address for your controller below. 
        
           #define NUMBER_OF_MAC      20 
        
           byte mac[][NUMBER_OF_MAC] = 
        
           { 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x01 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x02 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x03 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x04 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x05 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x06 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x07 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x08 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x09 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0A }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0B }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0C }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0D }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0E }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0F }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x10 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x11 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x12 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x13 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x14 }, 
        
           }; 
        
           // Select the IP address according to your local network 
        
           IPAddress myIP(192, 168, 2, 232); 
        
           IPAddress myGW(192, 168, 2, 1); 
        
           IPAddress mySN(255, 255, 255, 0); 
        
           // Google DNS Server IP 
        
           IPAddress myDNS(8, 8, 8, 8); 
        
           int reqCount = 0;                // number of requests received 
        
           void handleRoot() 
        
           { 
        
           #define BUFFER_SIZE     400 
        
             char temp[BUFFER_SIZE]; 
        
             int sec = millis() / 1000; 
        
             int min = sec / 60; 
        
             int hr = min / 60; 
        
             int day = hr / 24; 
        
             hr = hr % 24; 
        
             snprintf(temp, BUFFER_SIZE - 1, 
        
                      "<html>\ 
        
           <head>\ 
        
           <meta http-equiv='refresh' content='5'/>\ 
        
           <title>AdvancedWebServer %s</title>\ 
        
           <style>\ 
        
           body { background-color: #cccccc; font-family: Arial, Helvetica, Sans-Serif; Color: #000088; }\ 
        
           </style>\ 
        
           </head>\ 
        
           <body>\ 
        
           <h2>Hi from WebServer_ESP32_W5500!</h2>\ 
        
           <h3>on %s</h3>\ 
        
           <p>Uptime: %d d %02d:%02d:%02d</p>\ 
        
           <img src=\"/test.svg\" />\ 
        
           </body>\ 
        
           </html>", BOARD_NAME, BOARD_NAME, day, hr % 24, min % 60, sec % 60); 
        
             server.send(200, F("text/html"), temp); 
        
           } 
        
           void handleNotFound() 
        
           { 
        
             String message = F("File Not Found\n\n"); 
        
             message += F("URI: "); 
        
             message += server.uri(); 
        
             message += F("\nMethod: "); 
        
             message += (server.method() == HTTP_GET) ? F("GET") : F("POST"); 
        
             message += F("\nArguments: "); 
        
             message += server.args(); 
        
             message += F("\n"); 
        
             for (uint8_t i = 0; i < server.args(); i++) 
        
             { 
        
               message += " " + server.argName(i) + ": " + server.arg(i) + "\n"; 
        
             } 
        
             server.send(404, F("text/plain"), message); 
        
           } 
        
           void drawGraph() 
        
           { 
        
             String out; 
        
             out.reserve(3000); 
        
             char temp[70]; 
        
             out += F("<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"310\" height=\"150\">\n"); 
        
             out += F("<rect width=\"310\" height=\"150\" fill=\"rgb(250, 230, 210)\" stroke-width=\"2\" stroke=\"rgb(0, 0, 0)\" />\n"); 
        
             out += F("<g stroke=\"blue\">\n"); 
        
             int y = rand() % 130; 
        
             for (int x = 10; x < 300; x += 10) 
        
             { 
        
               int y2 = rand() % 130; 
        
               sprintf(temp, "<line x1=\"%d\" y1=\"%d\" x2=\"%d\" y2=\"%d\" stroke-width=\"2\" />\n", x, 140 - y, x + 10, 140 - y2); 
        
               out += temp; 
        
               y = y2; 
        
             } 
        
             out += F("</g>\n</svg>\n"); 
        
             server.send(200, F("image/svg+xml"), out); 
        
           } 
        
           void setup() 
        
           { 
        
             Serial.begin(115200); 
        
             while (!Serial && (millis() < 5000)); 
        
             Serial.print(F("\nStart AdvancedWebServer on ")); 
        
             Serial.print(ARDUINO_BOARD); 
        
             Serial.print(F(" with ")); 
        
             Serial.println(SHIELD_TYPE); 
        
             Serial.println(WEBSERVER_ESP32_W5500_VERSION); 
        
             ET_LOGWARN(F("Default SPI pinout:")); 
        
             ET_LOGWARN1(F("SPI_HOST:"), ETH_SPI_HOST); 
        
             ET_LOGWARN1(F("MOSI:"), MOSI_GPIO); 
        
             ET_LOGWARN1(F("MISO:"), MISO_GPIO); 
        
             ET_LOGWARN1(F("SCK:"),  SCK_GPIO); 
        
             ET_LOGWARN1(F("CS:"),   CS_GPIO); 
        
             ET_LOGWARN1(F("INT:"),  INT_GPIO); 
        
             ET_LOGWARN1(F("SPI Clock (MHz):"), SPI_CLOCK_MHZ); 
        
             ET_LOGWARN(F("=========================")); 
        
             /////////////////////////////////// 
        
             // To be called before ETH.begin() 
        
             ESP32_W5500_onEvent(); 
        
             // start the ethernet connection and the server: 
        
             // Use DHCP dynamic IP and random mac 
        
             //bool begin(int MISO_GPIO, int MOSI_GPIO, int SCLK_GPIO, int CS_GPIO, int INT_GPIO, int SPI_CLOCK_MHZ, 
        
             //           int SPI_HOST, uint8_t *W6100_Mac = W6100_Default_Mac); 
        
             ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST ); 
        
             //ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST, mac[millis() % NUMBER_OF_MAC] ); 
        
             // Static IP, leave without this line to get IP via DHCP 
        
             //bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = 0, IPAddress dns2 = 0); 
        
             //ETH.config(myIP, myGW, mySN, myDNS); 
        
             ESP32_W5500_waitForConnect(); 
        
             /////////////////////////////////// 
        
             server.on(F("/"), handleRoot); 
        
             server.on(F("/test.svg"), drawGraph); 
        
             server.on(F("/inline"), []() 
        
             { 
        
               server.send(200, F("text/plain"), F("This works as well")); 
        
             }); 
        
             server.onNotFound(handleNotFound); 
        
             server.begin(); 
        
             Serial.print(F("HTTP EthernetWebServer is @ IP : ")); 
        
             Serial.println(ETH.localIP()); 
        
           } 
        
           void heartBeatPrint() 
        
           { 
        
             static int num = 1; 
        
             Serial.print(F(".")); 
        
             if (num == 80) 
        
             { 
        
               Serial.println(); 
        
               num = 1; 
        
             } 
        
             else if (num++ % 10 == 0) 
        
             { 
        
               Serial.print(F(" ")); 
        
             } 
        
           } 
        
           void check_status() 
        
           { 
        
             static unsigned long checkstatus_timeout = 0; 
        
           #define STATUS_CHECK_INTERVAL     10000L 
        
             // Send status report every STATUS_REPORT_INTERVAL (60) seconds: we don't need to send updates frequently if there is no status change. 
        
             if ((millis() > checkstatus_timeout) || (checkstatus_timeout == 0)) 
        
             { 
        
               heartBeatPrint(); 
        
               checkstatus_timeout = millis() + STATUS_CHECK_INTERVAL; 
        
             } 
        
           } 
        
           void loop() 
        
           { 
        
             server.handleClient(); 
        
             check_status(); 
        
           }

Debug Terminal Output Samples

1. AdvancedWebServer on ESP32_DEV with ESP32_W5500

The following are debug terminal output and screen shot when running example AdvancedWebServer on ESP32_DEV with ESP32_W5500

Start AdvancedWebServer on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 2
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] CS: 5
[EWS] INT: 4
[EWS] SPI Clock (MHz): 25
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: B4:E6:2D:E9:68:AC, IPv4: 192.168.2.78
FULL_DUPLEX, 100Mbps
HTTP EthernetWebServer is @ IP : 192.168.2.78
.......... .......... .......... .....

2. MQTT_ThingStream on ESP32_DEV with ESP32_W5500

The terminal output of ESP32_DEV with W5500 running MQTT_ThingStream example

Start MQTT_ThingStream on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 2
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] CS: 5
[EWS] INT: 4
[EWS] SPI Clock (MHz): 25
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: B4:E6:2D:E9:68:AC, IPv4: 192.168.2.78
FULL_DUPLEX, 100Mbps
***************************************
ESP32_Pub
***************************************
MQTT Message Send : ESP32_Pub => Hello from MQTT_ThingStream on ESP32_DEV with ESP32_W5500
MQTT Message receive [ESP32_Pub] Hello from MQTT_ThingStream on ESP32_DEV with ESP32_W5500
MQTT Message Send : ESP32_Pub => Hello from MQTT_ThingStream on ESP32_DEV with ESP32_W5500
MQTT Message receive [ESP32_Pub] Hello from MQTT_ThingStream on ESP32_DEV with ESP32_W5500

4. MQTTClient_Auth on ESP32_DEV with ESP32_W5500

The terminal output of ESP32_DEV with W5500 running MQTTClient_Auth example

Start MQTTClient_Auth on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 2
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] CS: 5
[EWS] INT: 4
[EWS] SPI Clock (MHz): 25
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: B4:E6:2D:E9:68:AC, IPv4: 192.168.2.78
FULL_DUPLEX, 100Mbps
Attempting MQTT connection to broker.emqx.io...connected
Message Send : MQTT_Pub => Hello from MQTTClient_Auth on ESP32_DEV with ESP32_W5500
Message arrived [MQTT_Pub] Hello from MQTTClient_Auth on ESP32_DEV with ESP32_W5500
Message Send : MQTT_Pub => Hello from MQTTClient_Auth on ESP32_DEV with ESP32_W5500
Message arrived [MQTT_Pub] Hello from MQTTClient_Auth on ESP32_DEV with ESP32_W5500

5. MQTTClient_Basic on ESP32_DEV with ESP32_W5500

The terminal output of ESP32_DEV with W5500 running MQTTClient_Basic example

Start MQTTClient_Basic on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 2
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] CS: 5
[EWS] INT: 4
[EWS] SPI Clock (MHz): 25
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: B4:E6:2D:E9:68:AC, IPv4: 192.168.2.78
FULL_DUPLEX, 100Mbps
Message Send : MQTT_Pub => Hello from MQTTClient_Basic on ESP32_DEV with ESP32_W5500
Message arrived [MQTT_Pub] Hello from MQTTClient_Basic on ESP32_DEV with ESP32_W5500
Message Send : MQTT_Pub => Hello from MQTTClient_Basic on ESP32_DEV with ESP32_W5500
Message Send : MQTT_Pub => Hello from MQTTClient_Basic on ESP32_DEV with ESP32_W5500
Message arrived [MQTT_Pub] Hello from MQTTClient_Basic on ESP32_DEV with ESP32_W5500

6. WebClient on ESP32_DEV with ESP32_W5500

The terminal output of ESP32_DEV with W5500 running WebClient example

Start WebClient on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 2
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] CS: 5
[EWS] INT: 4
[EWS] SPI Clock (MHz): 25
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: B4:E6:2D:E9:68:AC, IPv4: 192.168.2.78
FULL_DUPLEX, 100Mbps

Starting connection to server...
Connected to server
HTTP/1.1 200 OK
Date: Wed, 11 Jan 2023 19:19:39 GMT
Content-Type: text/plain
Content-Length: 2263
Connection: close
x-amz-id-2: Tibw9r4/epZQzFM/rmO3cvTdq1DH4jSKocwQ9aMHx4RlkSotUFEGantuPNlKQKGqoHtdqwpFKw0=
x-amz-request-id: SD2XWDHW10J2H90M
Last-Modified: Wed, 23 Feb 2022 14:56:42 GMT
ETag: "667cf48afcc12c38c8c1637947a04224"
CF-Cache-Status: DYNAMIC
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=HDCMzIyDC7oeBtywXTEb50R8fKz1H%2B7cB18KeeJVTdmf6NrFvvbxfSPcInISlUQCNqHTVbYQp4rVNVXnwo8qvTMn8bP92ozfI53aScTnOJvPaBYaK4vOt%2FZxKfHsj3o%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 78800158694b1839-EWR
alt-svc: h3=":443"; ma=86400, h3-29=":443"; ma=86400


           `:;;;,`                      .:;;:.           
        .;;;;;;;;;;;`                :;;;;;;;;;;:     TM 
      `;;;;;;;;;;;;;;;`            :;;;;;;;;;;;;;;;      
     :;;;;;;;;;;;;;;;;;;         `;;;;;;;;;;;;;;;;;;     
    ;;;;;;;;;;;;;;;;;;;;;       .;;;;;;;;;;;;;;;;;;;;    
   ;;;;;;;;:`   `;;;;;;;;;     ,;;;;;;;;.`   .;;;;;;;;   
  .;;;;;;,         :;;;;;;;   .;;;;;;;          ;;;;;;;  
  ;;;;;;             ;;;;;;;  ;;;;;;,            ;;;;;;. 
 ,;;;;;               ;;;;;;.;;;;;;`              ;;;;;; 
 ;;;;;.                ;;;;;;;;;;;`      ```       ;;;;;`
 ;;;;;                  ;;;;;;;;;,       ;;;       .;;;;;
`;;;;:                  `;;;;;;;;        ;;;        ;;;;;
,;;;;`    `,,,,,,,,      ;;;;;;;      .,,;;;,,,     ;;;;;
:;;;;`    .;;;;;;;;       ;;;;;,      :;;;;;;;;     ;;;;;
:;;;;`    .;;;;;;;;      `;;;;;;      :;;;;;;;;     ;;;;;
.;;;;.                   ;;;;;;;.        ;;;        ;;;;;
 ;;;;;                  ;;;;;;;;;        ;;;        ;;;;;
 ;;;;;                 .;;;;;;;;;;       ;;;       ;;;;;,
 ;;;;;;               `;;;;;;;;;;;;                ;;;;; 
 `;;;;;,             .;;;;;; ;;;;;;;              ;;;;;; 
  ;;;;;;:           :;;;;;;.  ;;;;;;;            ;;;;;;  
   ;;;;;;;`       .;;;;;;;,    ;;;;;;;;        ;;;;;;;:  
    ;;;;;;;;;:,:;;;;;;;;;:      ;;;;;;;;;;:,;;;;;;;;;;   
    `;;;;;;;;;;;;;;;;;;;.        ;;;;;;;;;;;;;;;;;;;;    
      ;;;;;;;;;;;;;;;;;           :;;;;;;;;;;;;;;;;:     
       ,;;;;;;;;;;;;;,              ;;;;;;;;;;;;;;       
         .;;;;;;;;;`                  ,;;;;;;;;:         
                                                         
                                                         
                                                         
                                                         
    ;;;   ;;;;;`  ;;;;:  .;;  ;; ,;;;;;, ;;. `;,  ;;;;   
    ;;;   ;;:;;;  ;;;;;; .;;  ;; ,;;;;;: ;;; `;, ;;;:;;  
   ,;:;   ;;  ;;  ;;  ;; .;;  ;;   ,;,   ;;;,`;, ;;  ;;  
   ;; ;:  ;;  ;;  ;;  ;; .;;  ;;   ,;,   ;;;;`;, ;;  ;;. 
   ;: ;;  ;;;;;:  ;;  ;; .;;  ;;   ,;,   ;;`;;;, ;;  ;;` 
  ,;;;;;  ;;`;;   ;;  ;; .;;  ;;   ,;,   ;; ;;;, ;;  ;;  
  ;;  ,;, ;; .;;  ;;;;;:  ;;;;;: ,;;;;;: ;;  ;;, ;;;;;;  
  ;;   ;; ;;  ;;` ;;;;.   `;;;:  ,;;;;;, ;;  ;;,  ;;;;   

Disconnecting from server...

7. UDPSendReceive on ESP32_DEV with ESP32_W5500

The terminal output of ESP32_DEV with W5500 running UDPSendReceive example

Start UDPSendReceive on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 2
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] CS: 5
[EWS] INT: 4
[EWS] SPI Clock (MHz): 25
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: B4:E6:2D:E9:68:AC, IPv4: 192.168.2.78
FULL_DUPLEX, 100Mbps

Starting connection to server...
Listening on port 2390
UDP Packet received, size 48
From 132.163.97.3, port 123
Seconds since Jan 1 1900 = 3882452857
Unix time = 1673464057
The UTC time is 19:07:37

Debug

Debug is enabled by default on Serial. Debug Level from 0 to 4. To disable, change the ETHERNET_WEBSERVER_LOGLEVEL to 0

// Use this to output debug msgs to Serial
#define DEBUG_ETHERNET_WEBSERVER_PORT       Serial
// Use this to disable all output debug msgs
// Debug Level from 0 to 4
#define _ETHERNET_WEBSERVER_LOGLEVEL_       0

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of the board's core, applying Libraries' Patches, Packages' Patches or this library latest version.

Issues

Submit issues to: WebServer_ESP32_W5500 issues

TO DO

Bug Searching and Killing

DONE

Add support to ESP32-based ESP32_DEV with W5500 using LwIP W5500 Ethernet
Using SPI_DMA_CH_AUTO
Using ESP32 built-in ESP32 Ethernet MAC Address

Contributions and Thanks

Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.

Based on the Ivan Grokhotkov's ESP32 WebServer and HTTPClient Library libraries.

_{⭐️ Ivan Grokhotkov}

Contributing

If you want to contribute to this project:

Report bugs and errors
Ask for enhancements
Create issues and pull requests
Tell other people about this library

License

The library is licensed under GPLv3

Name		Name	Last commit message	Last commit date
Latest commit History 18 Commits
.github		.github
LibraryPatches/esp32/cores/esp32		LibraryPatches/esp32/cores/esp32
examples		examples
pics		pics
platformio		platformio
src		src
utils		utils
.codespellrc		.codespellrc
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
changelog.md		changelog.md
library.json		library.json
library.properties		library.properties

	#if !( defined(ESP32) )
	#error This code is designed for (ESP32 + W5500) to run on ESP32 platform! Please check your Tools->Board setting.
	#endif

	#define DEBUG_ETHERNET_WEBSERVER_PORT Serial

	// Debug Level from 0 to 4
	#define _ETHERNET_WEBSERVER_LOGLEVEL_ 3

	//////////////////////////////////////////////////////////

	// Optional values to override default settings
	// Don't change unless you know what you're doing
	//#define ETH_SPI_HOST SPI3_HOST
	//#define SPI_CLOCK_MHZ 25

	// Must connect INT to GPIOxx or not working
	//#define INT_GPIO 4

	//#define MISO_GPIO 19
	//#define MOSI_GPIO 23
	//#define SCK_GPIO 18
	//#define CS_GPIO 5

	//////////////////////////////////////////////////////////

	#include <WebServer_ESP32_W5500.h>

	WebServer server(80);

	// Enter a MAC address and IP address for your controller below.
	#define NUMBER_OF_MAC 20

	byte mac[][NUMBER_OF_MAC] =
	{
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x01 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x02 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x03 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x04 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x05 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x06 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x07 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x08 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x09 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0A },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0B },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0C },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0D },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0E },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0F },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x10 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x11 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x12 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x13 },
	{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x14 },
	};

	// Select the IP address according to your local network
	IPAddress myIP(192, 168, 2, 232);
	IPAddress myGW(192, 168, 2, 1);
	IPAddress mySN(255, 255, 255, 0);

	// Google DNS Server IP
	IPAddress myDNS(8, 8, 8, 8);

	int reqCount = 0; // number of requests received

	void handleRoot()
	{
	#define BUFFER_SIZE 400

	char temp[BUFFER_SIZE];
	int sec = millis() / 1000;
	int min = sec / 60;
	int hr = min / 60;
	int day = hr / 24;

	hr = hr % 24;

	snprintf(temp, BUFFER_SIZE - 1,
	"<html>\
	<head>\
	<meta http-equiv='refresh' content='5'/>\
	<title>AdvancedWebServer %s</title>\
	<style>\
	body { background-color: #cccccc; font-family: Arial, Helvetica, Sans-Serif; Color: #000088; }\
	</style>\
	</head>\
	<body>\
	<h2>Hi from WebServer_ESP32_W5500!</h2>\
	<h3>on %s</h3>\
	<p>Uptime: %d d %02d:%02d:%02d</p>\
	<img src=\"/test.svg\" />\
	</body>\
	</html>", BOARD_NAME, BOARD_NAME, day, hr % 24, min % 60, sec % 60);

	server.send(200, F("text/html"), temp);
	}

	void handleNotFound()
	{
	String message = F("File Not Found\n\n");

	message += F("URI: ");
	message += server.uri();
	message += F("\nMethod: ");
	message += (server.method() == HTTP_GET) ? F("GET") : F("POST");
	message += F("\nArguments: ");
	message += server.args();
	message += F("\n");

	for (uint8_t i = 0; i < server.args(); i++)
	{
	message += " " + server.argName(i) + ": " + server.arg(i) + "\n";
	}

	server.send(404, F("text/plain"), message);
	}

	void drawGraph()
	{
	String out;
	out.reserve(3000);
	char temp[70];

	out += F("<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"310\" height=\"150\">\n");
	out += F("<rect width=\"310\" height=\"150\" fill=\"rgb(250, 230, 210)\" stroke-width=\"2\" stroke=\"rgb(0, 0, 0)\" />\n");
	out += F("<g stroke=\"blue\">\n");
	int y = rand() % 130;

	for (int x = 10; x < 300; x += 10)
	{
	int y2 = rand() % 130;
	sprintf(temp, "<line x1=\"%d\" y1=\"%d\" x2=\"%d\" y2=\"%d\" stroke-width=\"2\" />\n", x, 140 - y, x + 10, 140 - y2);
	out += temp;
	y = y2;
	}

	out += F("</g>\n</svg>\n");

	server.send(200, F("image/svg+xml"), out);
	}

	void setup()
	{
	Serial.begin(115200);

	while (!Serial && (millis() < 5000));

	Serial.print(F("\nStart AdvancedWebServer on "));
	Serial.print(ARDUINO_BOARD);
	Serial.print(F(" with "));
	Serial.println(SHIELD_TYPE);
	Serial.println(WEBSERVER_ESP32_W5500_VERSION);

	ET_LOGWARN(F("Default SPI pinout:"));
	ET_LOGWARN1(F("SPI_HOST:"), ETH_SPI_HOST);
	ET_LOGWARN1(F("MOSI:"), MOSI_GPIO);
	ET_LOGWARN1(F("MISO:"), MISO_GPIO);
	ET_LOGWARN1(F("SCK:"), SCK_GPIO);
	ET_LOGWARN1(F("CS:"), CS_GPIO);
	ET_LOGWARN1(F("INT:"), INT_GPIO);
	ET_LOGWARN1(F("SPI Clock (MHz):"), SPI_CLOCK_MHZ);
	ET_LOGWARN(F("========================="));

	///////////////////////////////////

	// To be called before ETH.begin()
	ESP32_W5500_onEvent();

	// start the ethernet connection and the server:
	// Use DHCP dynamic IP and random mac
	//bool begin(int MISO_GPIO, int MOSI_GPIO, int SCLK_GPIO, int CS_GPIO, int INT_GPIO, int SPI_CLOCK_MHZ,
	// int SPI_HOST, uint8_t *W6100_Mac = W6100_Default_Mac);
	ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST );
	//ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST, mac[millis() % NUMBER_OF_MAC] );

	// Static IP, leave without this line to get IP via DHCP
	//bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = 0, IPAddress dns2 = 0);
	//ETH.config(myIP, myGW, mySN, myDNS);

	ESP32_W5500_waitForConnect();

	///////////////////////////////////

	server.on(F("/"), handleRoot);
	server.on(F("/test.svg"), drawGraph);
	server.on(F("/inline"), []()
	{
	server.send(200, F("text/plain"), F("This works as well"));
	});

	server.onNotFound(handleNotFound);
	server.begin();

	Serial.print(F("HTTP EthernetWebServer is @ IP : "));
	Serial.println(ETH.localIP());
	}

	void heartBeatPrint()
	{
	static int num = 1;

	Serial.print(F("."));

	if (num == 80)
	{
	Serial.println();
	num = 1;
	}
	else if (num++ % 10 == 0)
	{
	Serial.print(F(" "));
	}
	}

	void check_status()
	{
	static unsigned long checkstatus_timeout = 0;

	#define STATUS_CHECK_INTERVAL 10000L

	// Send status report every STATUS_REPORT_INTERVAL (60) seconds: we don't need to send updates frequently if there is no status change.
	if ((millis() > checkstatus_timeout) \|\| (checkstatus_timeout == 0))
	{
	heartBeatPrint();
	checkstatus_timeout = millis() + STATUS_CHECK_INTERVAL;
	}
	}

	void loop()
	{
	server.handleClient();
	check_status();
	}

License

khoih-prog/WebServer_ESP32_W5500

Folders and files

Latest commit

History

Repository files navigation

WebServer_ESP32_W5500 Library

Table of Contents

Why do we need this WebServer_ESP32_W5500 library

Features

Sibling libraries

General Libraries

ESP32_Ethernet_Manager Libraries

AsyncESP32_Ethernet_Manager Libraries

AsyncUDP_ESP32 Libraries

AsyncDNSServer_ESP32 Libraries

Currently supported Boards

W5500

Prerequisites

Installation

Use Arduino Library Manager

Manual Install

VS Code & PlatformIO:

Libraries' Patches

1. For fixing ESP32 compile error

HOWTO Fix Multiple Definitions Linker Error

HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

3.. ESP32 WiFi uses ADC2 for WiFi functions

Usage

Class Constructor

Basic Operations

Advanced Options

Other Function Calls

How to connect W5500 to ESP32

W5500

ESP32_DEV

Examples:

Original Examples

Example AdvancedWebServer

File AdvancedWebServer.ino

Debug Terminal Output Samples

1. AdvancedWebServer on ESP32_DEV with ESP32_W5500

2. MQTT_ThingStream on ESP32_DEV with ESP32_W5500

4. MQTTClient_Auth on ESP32_DEV with ESP32_W5500

5. MQTTClient_Basic on ESP32_DEV with ESP32_W5500

6. WebClient on ESP32_DEV with ESP32_W5500

7. UDPSendReceive on ESP32_DEV with ESP32_W5500

Debug

Troubleshooting

Issues

TO DO

DONE

Contributions and Thanks

Contributing

License

Copyright

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 3

Packages 0

Languages

HOWTO Fix `Multiple Definitions` Linker Error

Packages