Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.
/ WebServer_ESP32_SC_ENC Public archive

Simple Ethernet WebServer, HTTP/HTTPS Client wrapper library for ESP32_S2, S3 and C3 boards using ENC28J60 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

License

GPL-3.0 license
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

khoih-prog/WebServer_ESP32_SC_ENC

BranchesTags

Repository files navigation

WebServer_ESP32_SC_ENC Library

arduino-library-badge GitHub release contributions welcome GitHub issues

Donate to my libraries using BuyMeACoffee

Table of Contents

Why do we need this WebServer_ESP32_SC_ENC library

Features

This WebServer_ESP32_SC_ENC library is a simple yet complete WebServer wrapper library for ESP32_S2/S3/C3-based boards using LwIP ENC28J60 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_SC_ENC 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:

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

Library is providing similar functions to:

  1. Ivan Grokhotkov's ESP32 WebServer
  2. HTTPClient Library

Sibling libraries

Please also check these sibling libraries

  1. WebServer_WT32_ETH01 for ESP32-based WT32_ETH01 using LwIP LAN8720
  2. WebServer_ESP32_ENC for ESP32-boards using LwIP ENC28J60
  3. WebServer_ESP32_W5500 for ESP32-boards using LwIP W5500
  4. WebServer_ESP32_W6100 for ESP32-boards using LwIP W6100
  5. WebServer_ESP32_SC_ENC for ESP32_S3-boards using LwIP ENC28J60
  6. WebServer_ESP32_SC_W5500 for ESP32_S3-boards using LwIP W5500
  7. WebServer_ESP32_SC_W6100 for ESP32_S3-boards using LwIP W6100

and more complex libraries for ESP32-based using LwIP Ethernet

General Libraries

  1. AsyncHTTPRequest_ESP32_Ethernet
  2. AsyncHTTPSRequest_ESP32_Ethernet
  3. AsyncMQTT_ESP32
  4. HTTPS_Server_Generic

ESP32_Ethernet_Manager Libraries

  1. ESP32_ENC_Manager
  2. ESP32_W5500_Manager
  3. ESP32_Ethernet_Manager
  4. ESP32_SC_ENC_Manager
  5. ESP32_SC_W5500_Manager
  6. ESP32_SC_Ethernet_Manager

AsyncESP32_Ethernet_Manager Libraries

  1. AsyncESP32_ENC_Manager
  2. AsyncESP32_W5500_Manager
  3. AsyncESP32_Ethernet_Manager
  4. AsyncESP32_SC_ENC_Manager
  5. AsyncESP32_SC_W5500_Manager
  6. AsyncESP32_SC_Ethernet_Manager

AsyncUDP_ESP32 Libraries

  1. AsyncUDP_ESP32_ENC
  2. AsyncUDP_ESP32_W5500
  3. AsyncUDP_ESP32_W6100
  4. AsyncUDP_ESP32_Ethernet
  5. AsyncUDP_ESP32_SC_ENC
  6. AsyncUDP_ESP32_SC_W5500
  7. AsyncUDP_ESP32_SC_W6100
  8. AsyncUDP_ESP32_SC_Ethernet

AsyncDNSServer_ESP32 Libraries

  1. AsyncDNSServer_ESP32_ENC
  2. AsyncDNSServer_ESP32_W5500
  3. AsyncDNSServer_ESP32_W6100
  4. AsyncDNSServer_ESP32_Ethernet

Currently supported Boards

This WebServer_ESP32_SC_ENC library currently supports these following boards:

  1. ESP32_S3 boards using LwIP ENC28J60 Ethernet
  2. ESP32_S2 boards using LwIP ENC28J60 Ethernet
  3. ESP32_C3 boards using LwIP ENC28J60 Ethernet

ESP32S2_DEV

ESP32S3_DEV

ESP32C3_DEV

ENC28J60

FULL_DUPLEX, 10Mbps

Prerequisites

  1. Arduino IDE 1.8.19+ for Arduino. GitHub release
  2. ESP32 Core 2.0.6+ for ESP32-based ESP32S2/S3/C3_DEV with ENC28J60 boards. Latest release

Installation

Use Arduino Library Manager

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

Manual Install

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

VS Code & PlatformIO:

  1. Install VS Code
  2. Install PlatformIO
  3. Install WebServer_ESP32_SC_ENC library by using Library Manager. Search for WebServer_ESP32_SC_ENC in Platform.io Author's Libraries
  4. 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:

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_SC_ENC.hpp"     //https://github.com/khoih-prog/WebServer_ESP32_SC_ENC

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_SC_ENC.h"           //https://github.com/khoih-prog/WebServer_ESP32_SC_ENC

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:

  1. 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.

  2. 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_SC_ENC 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 ENC28J60 to ESP32_S2/S3/C3

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

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

ENC28J60

FULL_DUPLEX, 10Mbps

ESP32S3_DEV

ENC28J60 <---> ESP32_S3
MOSI <---> GPIO11
MISO <---> GPIO13
SCK <---> GPIO12
CS/SS <---> GPIO10
INT <---> GPIO4
GND <---> GND
3.3V <---> 3.3V

ESP32S2_DEV

ENC28J60 <---> ESP32_S2
MOSI <---> GPIO35
MISO <---> GPIO37
SCK <---> GPIO36
CS/SS <---> GPIO34
INT <---> GPIO4
RST <---> RST
GND <---> GND
3.3V <---> 3.3V

ESP32C3_DEV

ENC28J60 <---> ESP32_C3
MOSI <---> GPIO6
MISO <---> GPIO5
SCK <---> GPIO4
CS/SS <---> GPIO7
INT <---> GPIO10
RST <---> RST
GND <---> GND
3.3V <---> 3.3V

Examples:

Original Examples

  1. AdvancedWebServer
  2. HelloServer
  3. HelloServer2
  4. HttpBasicAuth
  5. MQTTClient_Auth
  6. MQTTClient_Basic
  7. MQTT_ThingStream
  8. PostServer
  9. SimpleAuthentication
  10. UdpNTPClient
  11. UdpSendReceive
  12. WebClient
  13. WebClientRepeating
  14. WebServer
  15. multiFileProject

Example AdvancedWebServer

File AdvancedWebServer.ino

WebServer_ESP32_SC_ENC/examples/AdvancedWebServer/AdvancedWebServer.ino

Lines 41 to 290 in 4e82f38

#if !( defined(ESP32) )
#error This code is designed for (ESP32 + ENC28J60) 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
//#define ETH_SPI_HOST SPI2_HOST
//#define SPI_CLOCK_MHZ 20
// Must connect INT to GPIOxx or not working
//#define INT_GPIO 4
//#define MISO_GPIO 13
//#define MOSI_GPIO 11
//#define SCK_GPIO 12
//#define CS_GPIO 10
// For ESP32_C3
// Optional values to override default settings
// Don't change unless you know what you're doing
//#define ETH_SPI_HOST SPI2_HOST
//#define SPI_CLOCK_MHZ 25
// Must connect INT to GPIOxx or not working
//#define INT_GPIO 10
//#define MISO_GPIO 5
//#define MOSI_GPIO 6
//#define SCK_GPIO 4
//#define CS_GPIO 7
//////////////////////////////////////////////////////////
#include <WebServer_ESP32_SC_ENC.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_SC_ENC!</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));
delay(500);
Serial.print(F("\nStart AdvancedWebServer on "));
Serial.print(ARDUINO_BOARD);
Serial.print(F(" with "));
Serial.println(SHIELD_TYPE);
Serial.println(WEBSERVER_ESP32_SC_ENC_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_ENC_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_ENC_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 ESP32S3_DEV with ESP32_S3_ENC28J60

The following are debug terminal output and screen shot when running example AdvancedWebServer on ESP32S3_DEV with ESP32_S3_ENC28J60. The user-defined MAC address is automatically used now because there is no built-in MAC address in ESP32_S3

Start AdvancedWebServer on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 11
[EWS] MISO: 13
[EWS] SCK: 12
[EWS] CS: 10
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:11, IPv4: 192.168.2.101
FULL_DUPLEX, 10Mbps
HTTP EthernetWebServer is @ IP : 192.168.2.101

2. MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60

The terminal output of ESP32S3_DEV with ENC28J60 running MQTT_ThingStream example. The user-defined MAC address is automatically used now because there is no built-in MAC address in ESP32_S3

Start MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 11
[EWS] MISO: 13
[EWS] SCK: 12
[EWS] CS: 10
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:11, IPv4: 192.168.2.101
FULL_DUPLEX, 10Mbps
***************************************
ESP32_Pub
***************************************
Attempting MQTT connection to broker.emqx.io
...connected
Published connection message successfully!
Subscribed to: ESP32_Sub
MQTT Message Send : ESP32_Pub => Hello from MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60
MQTT Message receive [ESP32_Pub] Hello from MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60
MQTT Message Send : ESP32_Pub => Hello from MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60
MQTT Message receive [ESP32_Pub] Hello from MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60
MQTT Message Send : ESP32_Pub => Hello from MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60
MQTT Message receive [ESP32_Pub] Hello from MQTT_ThingStream on ESP32S3_DEV with ESP32_S3_ENC28J60

3. MQTTClient_Auth on ESP32S3_DEV with ESP32_S3_ENC28J60

The terminal output of ESP32S3_DEV with ENC28J60 running MQTTClient_Auth example. The user-defined MAC address is automatically used now because there is no built-in MAC address in ESP32_S3

Start MQTTClient_Auth on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 11
[EWS] MISO: 13
[EWS] SCK: 12
[EWS] CS: 10
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:0E, IPv4: 192.168.2.106
FULL_DUPLEX, 10Mbps
Message Send : MQTT_Pub => Hello from MQTTClient_Auth on ESP32S3_DEV with ESP32_S3_ENC28J60
Message arrived [MQTT_Pub] Hello from MQTTClient_Auth on ESP32S3_DEV with ESP32_S3_ENC28J60
Message Send : MQTT_Pub => Hello from MQTTClient_Auth on ESP32S3_DEV with ESP32_S3_ENC28J60
Message arrived [MQTT_Pub] Hello from MQTTClient_Auth on ESP32S3_DEV with ESP32_S3_ENC28J60

4. MQTTClient_Basic on ESP32S3_DEV with ESP32_S3_ENC28J60

The terminal output of ESP32S3_DEV with ENC28J60 running MQTTClient_Basic example. The user-defined MAC address is automatically used now because there is no built-in MAC address in ESP32_S3

Start MQTTClient_Basic on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 11
[EWS] MISO: 13
[EWS] SCK: 12
[EWS] CS: 10
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:0E, IPv4: 192.168.2.106
FULL_DUPLEX, 10Mbps
Message Send : MQTT_Pub => Hello from MQTTClient_Basic on ESP32S3_DEV with ESP32_S3_ENC28J60
Message arrived [MQTT_Pub] Hello from MQTTClient_Basic on ESP32S3_DEV with ESP32_S3_ENC28J60
Message Send : MQTT_Pub => Hello from MQTTClient_Basic on ESP32S3_DEV with ESP32_S3_ENC28J60
Message arrived [MQTT_Pub] Hello from MQTTClient_Basic on ESP32S3_DEV with ESP32_S3_ENC28J60

5. WebClient on ESP32S3_DEV with ESP32_S3_ENC28J60

The terminal output of ESP32S3_DEV with ENC28J60 running WebClient example. The user-defined MAC address is automatically used now because there is no built-in MAC address in ESP32_S3

Start WebClient on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 11
[EWS] MISO: 13
[EWS] SCK: 12
[EWS] CS: 10
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:0A, IPv4: 192.168.2.98
FULL_DUPLEX, 10Mbps

Starting connection to server...
Connected to server
HTTP/1.1 200 OK
Date: Wed, 11 Jan 2023 23:19:00 GMT
Content-Type: text/plain
Content-Length: 2263
Connection: close
x-amz-id-2: I1XSxb8SrBbQvFZiDm6s+3yCJDQ/kr8viynhpV/gMhEc444Vesm23XUdidJIuVKxLKvyEevxZ40=
x-amz-request-id: 8TV8DXN77NW79TND
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=E5WKZrRe9b85co%2BkMLkh7ffnNJ3p4%2BWsN%2BwjN6GQFwshsImPjF1CUUDDDB7aDvMmWXpdWdPqNcz104aCGcSpcSgZIRkOwJuGE5hGN3ZLxa3JtJecrpo%2FUGwZPebWKB8%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 77947b6a7a8954a9-YYZ
alt-svc: h3=":443"; ma=86400, h3-29=":443"; ma=86400


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

Disconnecting from server...

6. UDPSendReceive on ESP32S3_DEV with ESP32_S3_ENC28J60

The terminal output of ESP32S3_DEV with ENC28J60 running UdpSendReceive example. The user-defined MAC address is automatically used now because there is no built-in MAC address in ESP32_S3

Start UDPSendReceive on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 11
[EWS] MISO: 13
[EWS] SCK: 12
[EWS] CS: 10
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:0C, IPv4: 192.168.2.112
FULL_DUPLEX, 10Mbps

Starting connection to server...
Listening on port 2390
UDP Packet received, size 48
From 132.163.97.6, port 123
Seconds since Jan 1 1900 = 3880554037
Unix time = 1671565237
The UTC time is 19:40:37
UDP Packet received, size 48
From 132.163.97.6, port 123
Seconds since Jan 1 1900 = 3880554062
Unix time = 1671565262
The UTC time is 19:41:02

7. UdpNTPClient on ESP32S2_DEV with ESP32_S2_ENC28J60

The terminal output of ESP32S2_DEV with ENC28J60 running UdpNTPClient example. The built-in MAC address is used now instead of user-defined one.

Start UdpNTPClient on ESP32S2_DEV with ESP32_S2_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 35
[EWS] MISO: 37
[EWS] SCK: 36
[EWS] CS: 34
[EWS] INT: 4
[EWS] SPI Clock (MHz): 20
[EWS] =========================
Using built-in mac_eth = 7E:DF:A1:08:64:27

ETH Started
ETH Connected
ETH MAC: 7E:DF:A1:08:64:27, IPv4: 192.168.2.85
FULL_DUPLEX, 10Mbps
UDP Packet received, size 48
From 132.163.97.2, port 123
Seconds since Jan 1 1900 = 3880554146
Unix time = 1671565346
The UTC time is 19:42:26
UDP Packet received, size 48
From 132.163.97.2, port 123
Seconds since Jan 1 1900 = 3880554170
Unix time = 1671565370
The UTC time is 19:42:50

8. UdpNTPClient on ESP32C3_DEV with ESP32_C3_ENC28J60

The terminal output of ESP32C3_DEV with ENC28J60 running UdpNTPClient example. The built-in MAC address is used now instead of user-defined one.

Start UdpNTPClient on ESP32C3_DEV with ESP32_C3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
[EWS] Default SPI pinout:
[EWS] SPI_HOST: 1
[EWS] MOSI: 6
[EWS] MISO: 5
[EWS] SCK: 4
[EWS] CS: 7
[EWS] INT: 10
[EWS] SPI Clock (MHz): 20
[EWS] =========================
Using built-in mac_eth = 7C:DF:A1:DA:68:BF

ETH Started
ETH Connected
ETH MAC: 7C:DF:A1:DA:68:BF, IPv4: 192.168.2.82
FULL_DUPLEX, 10Mbps
UDP Packet received, size 48
From 132.163.96.3, port 123
Seconds since Jan 1 1900 = 3882472048
Unix time = 1673483248
The UTC time is 0:27:28

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_SC_ENC issues

TO DO

  1. Bug Searching and Killing

DONE

  1. Add support to ESP32S3-based boards using LwIP ENC28J60 Ethernet
  2. Add support to ESP32S2-based boards using LwIP ENC28J60 Ethernet
  3. Add support to ESP32C3-based boards using LwIP ENC28J60 Ethernet
  4. Increase default SPI_CLOCK_MHZ clock to 20MHz from 8MHz
  5. Update examples to use DHCP with 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.

  1. Based on the Ivan Grokhotkov's ESP32 WebServer and HTTPClient Library libraries
  2. Thanks to avanderhoest for reporting Supporting ESP32_S3 using W5500 Ethernet #72 leading to the creation of this library
igrr
⭐️ Ivan Grokhotkov
 avanderhoest
avanderhoest

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

Copyright

  • Copyright (c) 2016- Ivan Grokhotkov

  • Copyright (c) 2022- Khoi Hoang

About

Simple Ethernet WebServer, HTTP/HTTPS Client wrapper library for ESP32_S2, S3 and C3 boards using ENC28J60 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

Topics

http mqtt ota async https esp32 http-client http-server lwip enc28j60 https-client mqtts ca-certificates https-certificate esp32-s2 esp32-c3 mqtts-client async-webserver esp32-s3 lwip-enc28j60

Resources

Readme

License

GPL-3.0 license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 4

v1.2.1 to increase default `SPI_CLOCK_MHZ` clock to 20MHz from 8MHz and to update examples to use `DHCP` with `built-in ESP32 Ethernet MAC Address` Latest
Jan 12, 2023
+ 3 releases

Packages

No packages published

Languages