Skip to content
This repository was archived by the owner on Feb 4, 2023. It is now read-only.

Commit 6162986

Browse files
khoih-progkhoih-prog
authored
Update README.md 
1 parent e6be107 commit 6162986

File tree

2 files changed

+110
-54
lines changed

2 files changed

+110
-54
lines changed

‎README.md‎

Lines changed: 109 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
1010
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
1111

12-
1312
---
1413
---
1514

1615
## Table of Contents
1716

1817
* [Why do we need this WebServer_ESP32_ENC library](#why-do-we-need-this-WebServer_ESP32_ENC-library)
1918
* [Features](#features)
19+
* [Sibling libraries](#Sibling-libraries)
2020
* [Currently supported Boards](#currently-supported-boards)
2121
* [Changelog](changelog.md)
2222
* [Prerequisites](#prerequisites)
@@ -99,11 +99,74 @@ Library is just a wrapper for:
9999
2. [HTTPClient Library](https://github.com/espressif/arduino-esp32/tree/master/libraries/HTTPClient)
100100

101101

102+
---
103+
104+
#### Sibling libraries
105+
106+
Please also check these sibling libraries
107+
108+
1. [WebServer_WT32_ETH01](https://github.com/khoih-prog/WebServer_WT32_ETH01) for ESP32-based `WT32_ETH01` using `LwIP LAN8720`
109+
2. [WebServer_ESP32_ENC](https://github.com/khoih-prog/WebServer_ESP32_ENC) for ESP32-boards using `LwIP ENC28J60`
110+
3. [WebServer_ESP32_W5500](https://github.com/khoih-prog/WebServer_ESP32_W5500) for ESP32-boards using `LwIP W5500`
111+
4. [WebServer_ESP32_W6100](https://github.com/khoih-prog/WebServer_ESP32_W6100) for ESP32-boards using `LwIP W6100`
112+
5. [WebServer_ESP32_SC_ENC](https://github.com/khoih-prog/WebServer_ESP32_SC_ENC) for ESP32_S3-boards using `LwIP ENC28J60`
113+
6. [WebServer_ESP32_SC_W5500](https://github.com/khoih-prog/WebServer_ESP32_SC_W5500) for ESP32_S3-boards using `LwIP W5500`
114+
7. [WebServer_ESP32_SC_W6100](https://github.com/khoih-prog/WebServer_ESP32_SC_W6100) for ESP32_S3-boards using `LwIP W6100`
115+
116+
and more complex libraries for ESP32-based using `LwIP Ethernet`
117+
118+
#### General Libraries
119+
120+
1. [AsyncHTTPRequest_ESP32_Ethernet](https://github.com/khoih-prog/AsyncHTTPRequest_ESP32_Ethernet)
121+
2. [AsyncHTTPSRequest_ESP32_Ethernet](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet)
122+
3. [AsyncMQTT_ESP32](https://github.com/khoih-prog/AsyncMQTT_ESP32)
123+
4. [HTTPS_Server_Generic](https://github.com/khoih-prog/HTTPS_Server_Generic)
124+
125+
#### ESP32_Ethernet_Manager Libraries
126+
127+
1. [ESP32_ENC_Manager](https://github.com/khoih-prog/ESP32_ENC_Manager)
128+
2. [ESP32_W5500_Manager](https://github.com/khoih-prog/ESP32_W5500_Manager)
129+
3. [ESP32_Ethernet_Manager](https://github.com/khoih-prog/ESP32_Ethernet_Manager)
130+
4. [ESP32_SC_ENC_Manager](https://github.com/khoih-prog/ESP32_SC_ENC_Manager)
131+
5. [ESP32_SC_W5500_Manager](https://github.com/khoih-prog/ESP32_SC_W5500_Manager)
132+
6. [ESP32_SC_Ethernet_Manager](https://github.com/khoih-prog/ESP32_SC_Ethernet_Manager)
133+
134+
#### AsyncESP32_Ethernet_Manager Libraries
135+
136+
1. [AsyncESP32_ENC_Manager](https://github.com/khoih-prog/AsyncESP32_ENC_Manager)
137+
2. [AsyncESP32_W5500_Manager](https://github.com/khoih-prog/AsyncESP32_W5500_Manager)
138+
3. [AsyncESP32_Ethernet_Manager](https://github.com/khoih-prog/AsyncESP32_Ethernet_Manager)
139+
4. [AsyncESP32_SC_ENC_Manager](https://github.com/khoih-prog/AsyncESP32_SC_ENC_Manager)
140+
5. [AsyncESP32_SC_W5500_Manager](https://github.com/khoih-prog/AsyncESP32_SC_W5500_Manager)
141+
6. [AsyncESP32_SC_Ethernet_Manager](https://github.com/khoih-prog/AsyncESP32_SC_Ethernet_Manager)
142+
143+
#### AsyncUDP_ESP32 Libraries
144+
145+
1. [AsyncUDP_ESP32_ENC](https://github.com/khoih-prog/AsyncUDP_ESP32_ENC)
146+
2. [AsyncUDP_ESP32_W5500](https://github.com/khoih-prog/AsyncUDP_ESP32_W5500)
147+
3. [AsyncUDP_ESP32_W6100](https://github.com/khoih-prog/AsyncUDP_ESP32_W6100)
148+
4. [AsyncUDP_ESP32_Ethernet](https://github.com/khoih-prog/AsyncUDP_ESP32_Ethernet)
149+
5. [AsyncUDP_ESP32_SC_ENC](https://github.com/khoih-prog/AsyncUDP_ESP32_SC_ENC)
150+
6. [AsyncUDP_ESP32_SC_W5500](https://github.com/khoih-prog/AsyncUDP_ESP32_SC_W5500)
151+
7. [AsyncUDP_ESP32_SC_W6100](https://github.com/khoih-prog/AsyncUDP_ESP32_SC_W6100)
152+
8. [AsyncUDP_ESP32_SC_Ethernet](https://github.com/khoih-prog/AsyncUDP_ESP32_SC_Ethernet)
153+
154+
#### AsyncDNSServer_ESP32 Libraries
155+
156+
1. [AsyncDNSServer_ESP32_ENC](https://github.com/khoih-prog/AsyncDNSServer_ESP32_ENC)
157+
2. [AsyncDNSServer_ESP32_W5500](https://github.com/khoih-prog/AsyncDNSServer_ESP32_W5500)
158+
3. [AsyncDNSServer_ESP32_W6100](https://github.com/khoih-prog/AsyncDNSServer_ESP32_W6100)
159+
4. [AsyncDNSServer_ESP32_Ethernet](https://github.com/khoih-prog/AsyncDNSServer_ESP32_Ethernet)
160+
161+
162+
---
163+
164+
102165
#### Currently supported Boards
103166

104167
This [**WebServer_ESP32_ENC** library](https://github.com/khoih-prog/WebServer_ESP32_ENC) currently supports these following boards:
105168

106-
1. **ESP32_DEV with ENC28J60 boards** using ESP32-based boards and LwIP ENC28J60 Ethernet
169+
1. **ESP32_DEV boards** using `LwIP ENC28J60 Ethernet`
107170

108171

109172
---
@@ -204,7 +267,7 @@ Please have a look at [**ESP_WiFiManager Issue 39: Not able to read analog port
204267
- `ADC1` controls ADC function for pins **GPIO32-GPIO39**
205268
- `ADC2` controls ADC function for pins **GPIO0, 2, 4, 12-15, 25-27**
206269

207-
#### 3.. ESP32 WiFi uses ADC2 for WiFi functions
270+
#### 3. ESP32 WiFi uses ADC2 for WiFi functions
208271

209272
Look in file [**adc_common.c**](https://github.com/espressif/esp-idf/blob/master/components/driver/adc_common.c#L61)
210273

@@ -385,6 +448,8 @@ void serveStatic();
385448
size_t streamFile();
386449
```
387450

451+
452+
388453
---
389454
---
390455

@@ -399,27 +464,23 @@ You can change the `INT` pin to another one. Default is `GPIO4`
399464

400465
---
401466

467+
402468
#### ENC28J60
403469

404470
`FULL_DUPLEX, 10Mbps`
405471

406472
<p align="center">
407-
<img src="https://github.com/khoih-prog/WebServer_ESP32_W5500/raw/main/pics/ENC28J60.png">
473+
<img src="https://github.com/khoih-prog/WebServer_ESP32_ENC/raw/main/pics/ENC28J60.png">
408474
</p>
409-
410475

411476
---
412477

413-
414-
#### ESP32_DEV
415-
416-
417478
|ENC28J60|<--->|ESP32|
418479
|:-:|:-:|:-:|
419-
|MOSI|<--->|GPIO23|
420-
|MISO|<--->|GPIO19|
421-
|SCK|<--->|GPIO18|
422-
|SS/CS|<--->|GPIO5|
480+
|MOSI|<--->|GPIO11|
481+
|MISO|<--->|GPIO13|
482+
|SCK|<--->|GPIO12|
483+
|CS/SS|<--->|GPIO10|
423484
|INT|<--->|GPIO4|
424485
|RST|<--->|RST|
425486
|GND|<--->|GND|
@@ -458,7 +519,7 @@ You can change the `INT` pin to another one. Default is `GPIO4`
458519
#### File [AdvancedWebServer.ino](examples/AdvancedWebServer/AdvancedWebServer.ino)
459520

460521

461-
https://github.com/khoih-prog/WebServer_ESP32_ENC/blob/7b3055e675c859f066eae34fc58b7857f86c192d/examples/AdvancedWebServer/AdvancedWebServer.ino#L41-L273
522+
https://github.com/khoih-prog/WebServer_ESP32_ENC/blob/041ef525edf63eccb70c78d8f65999664c383866/examples/AdvancedWebServer/AdvancedWebServer.ino#L41-L275
462523

463524
---
464525
---
@@ -475,21 +536,21 @@ The following are debug terminal output and screen shot when running example [Ad
475536

476537
```cpp
477538
Start AdvancedWebServer on ESP32_DEV with ESP32_ENC28J60
478-
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
539+
WebServer_ESP32_ENC v1.5.1 for core v2.0.0+
479540
[EWS] Default SPI pinout:
480541
[EWS] MOSI: 23
481542
[EWS] MISO: 19
482543
[EWS] SCK: 18
483544
[EWS] CS: 5
484545
[EWS] INT: 4
485-
[EWS] SPI Clock (MHz): 20
546+
[EWS] SPI Clock (MHz): 8
486547
[EWS] =========================
487548

488549
ETH Started
489550
ETH Connected
490-
ETH MAC: 98:F4:AB:09:0A:DF, IPv4: 192.168.2.80
551+
ETH MAC: DE:AD:BE:EF:BE:14, IPv4: 192.168.2.232
491552
FULL_DUPLEX, 10Mbps
492-
HTTP EthernetWebServer is @ IP : 192.168.2.80
553+
HTTP EthernetWebServer is @ IP : 192.168.2.232
493554
..
494555
```
495556
@@ -502,19 +563,19 @@ The terminal output of **ESP32_DEV with ENC28J60** running [MQTT_ThingStream exa
502563
503564
```cpp
504565
Start MQTT_ThingStream on ESP32_DEV with ESP32_ENC28J60
505-
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
566+
WebServer_ESP32_ENC v1.5.1 for core v2.0.0+
506567
[EWS] Default SPI pinout:
507568
[EWS] MOSI: 23
508569
[EWS] MISO: 19
509570
[EWS] SCK: 18
510571
[EWS] CS: 5
511572
[EWS] INT: 4
512-
[EWS] SPI Clock (MHz): 20
573+
[EWS] SPI Clock (MHz): 8
513574
[EWS] =========================
514575
515576
ETH Started
516577
ETH Connected
517-
ETH MAC: 98:F4:AB:09:0A:DF, IPv4: 192.168.2.80
578+
ETH MAC: DE:AD:BE:EF:BE:08, IPv4: 192.168.2.232
518579
FULL_DUPLEX, 10Mbps
519580
***************************************
520581
ESP32_Pub
@@ -538,19 +599,19 @@ The terminal output of **ESP32_DEV with ENC28J60** running [MQTTClient_Auth exam
538599

539600
```cpp
540601
Start MQTTClient_Auth on ESP32_DEV with ESP32_ENC28J60
541-
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
602+
WebServer_ESP32_ENC v1.5.1 for core v2.0.0+
542603
[EWS] Default SPI pinout:
543604
[EWS] MOSI: 23
544605
[EWS] MISO: 19
545606
[EWS] SCK: 18
546607
[EWS] CS: 5
547608
[EWS] INT: 4
548-
[EWS] SPI Clock (MHz): 20
609+
[EWS] SPI Clock (MHz): 8
549610
[EWS] =========================
550611

551612
ETH Started
552613
ETH Connected
553-
ETH MAC: 98:F4:AB:09:0A:DF, IPv4: 192.168.2.80
614+
ETH MAC: DE:AD:BE:EF:BE:14, IPv4: 192.168.2.232
554615
FULL_DUPLEX, 10Mbps
555616
Attempting MQTT connection to broker.emqx.io...connected
556617
Message Send : MQTT_Pub => Hello from MQTTClient_Auth on ESP32_DEV with ESP32_ENC28J60
@@ -569,19 +630,19 @@ The terminal output of **ESP32_DEV with ENC28J60** running [MQTTClient_Basic exa
569630
570631
```cpp
571632
Start MQTTClient_Basic on ESP32_DEV with ESP32_ENC28J60
572-
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
633+
WebServer_ESP32_ENC v1.5.1 for core v2.0.0+
573634
[EWS] Default SPI pinout:
574635
[EWS] MOSI: 23
575636
[EWS] MISO: 19
576637
[EWS] SCK: 18
577638
[EWS] CS: 5
578639
[EWS] INT: 4
579-
[EWS] SPI Clock (MHz): 20
640+
[EWS] SPI Clock (MHz): 8
580641
[EWS] =========================
581642
582643
ETH Started
583644
ETH Connected
584-
ETH MAC: 98:F4:AB:09:0A:DF, IPv4: 192.168.2.80
645+
ETH MAC: DE:AD:BE:EF:BE:08, IPv4: 192.168.2.232
585646
FULL_DUPLEX, 10Mbps
586647
Attempting MQTT connection to broker.emqx.io...connected
587648
Message Send : MQTT_Pub => Hello from MQTTClient_Basic on ESP32_DEV with ESP32_ENC28J60
@@ -601,25 +662,25 @@ The terminal output of **ESP32_DEV with ENC28J60** running [WebClient example](e
601662

602663
```cpp
603664
Start WebClient on ESP32_DEV with ESP32_ENC28J60
604-
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
665+
WebServer_ESP32_ENC v1.5.1 for core v2.0.0+
605666
[EWS] Default SPI pinout:
606667
[EWS] MOSI: 23
607668
[EWS] MISO: 19
608669
[EWS] SCK: 18
609670
[EWS] CS: 5
610671
[EWS] INT: 4
611-
[EWS] SPI Clock (MHz): 20
672+
[EWS] SPI Clock (MHz): 8
612673
[EWS] =========================
613674

614675
ETH Started
615676
ETH Connected
616-
ETH MAC: 98:F4:AB:09:0A:DF, IPv4: 192.168.2.80
677+
ETH MAC: DE:AD:BE:EF:BE:12, IPv4: 192.168.2.232
617678
FULL_DUPLEX, 10Mbps
618679

619680
Starting connection to server...
620681
Connected to server
621682
HTTP/1.1 200 OK
622-
Date: Wed, 11 Jan 2023 07:19:54 GMT
683+
Date: Mon, 28 Nov 2022 07:45:46 GMT
623684
Content-Type: text/plain
624685
Content-Length: 2263
625686
Connection: close
@@ -686,33 +747,38 @@ The terminal output of **ESP32_DEV with ENC28J60** running [UDPSendReceive examp
686747
687748
```cpp
688749
Start UDPSendReceive on ESP32_DEV with ESP32_ENC28J60
689-
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
750+
WebServer_ESP32_ENC v1.5.1 for core v2.0.0+
690751
[EWS] Default SPI pinout:
691752
[EWS] MOSI: 23
692753
[EWS] MISO: 19
693754
[EWS] SCK: 18
694755
[EWS] CS: 5
695756
[EWS] INT: 4
696-
[EWS] SPI Clock (MHz): 20
757+
[EWS] SPI Clock (MHz): 8
697758
[EWS] =========================
698759
699760
ETH Started
700761
ETH Connected
701-
ETH MAC: 98:F4:AB:09:0A:DF, IPv4: 192.168.2.80
762+
ETH MAC: DE:AD:BE:EF:BE:08, IPv4: 192.168.2.232
702763
FULL_DUPLEX, 10Mbps
703764
704765
Starting connection to server...
705766
Listening on port 2390
706767
UDP Packet received, size 48
707-
From 132.163.97.6, port 123
708-
Seconds since Jan 1 1900 = 3882459421
709-
Unix time = 1673470621
710-
The UTC time is 20:57:01
768+
From 132.163.97.3, port 123
769+
Seconds since Jan 1 1900 = 3878610164
770+
Unix time = 1669621364
771+
The UTC time is 7:42:44
772+
UDP Packet received, size 48
773+
From 132.163.97.3, port 123
774+
Seconds since Jan 1 1900 = 3878610176
775+
Unix time = 1669621376
776+
The UTC time is 7:42:56
711777
UDP Packet received, size 48
712-
From 132.163.97.6, port 123
713-
Seconds since Jan 1 1900 = 3882459433
714-
Unix time = 1673470633
715-
The UTC time is 20:57:13
778+
From 132.163.97.3, port 123
779+
Seconds since Jan 1 1900 = 3878610188
780+
Unix time = 1669621388
781+
The UTC time is 7:43:08
716782
```
717783

718784
---
@@ -752,10 +818,7 @@ Submit issues to: [WebServer_ESP32_ENC issues](https://github.com/khoih-prog/Web
752818

753819
### DONE
754820

755-
1. Add support to ESP32-based **ESP32_DEV with ENC28J60** using LwIP ENC28J60 Ethernet
756-
2. Using `built-in ESP32 MAC Address`
757-
3. Increase default `SPI_CLOCK_MHZ` clock to 20MHz from 8MHz
758-
821+
1. Add support to ESP32-based **ESP32_DEV** using `LwIP ENC28J60 Ethernet`
759822

760823
---
761824
---

‎changelog.md‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,23 @@
88
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
99
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
1010

11-
1211
---
1312
---
1413

1514
## Table of Contents
1615

1716

1817
* [Changelog](#changelog)
19-
* [Releases v1.5.3](#releases-v153)
2018
* [Releases v1.5.1](#releases-v151)
2119

2220
---
2321
---
2422

2523
## Changelog
2624

27-
#### Releases v1.5.3
28-
29-
1. Using `built-in ESP32 MAC Address`
30-
2. Increase default `SPI_CLOCK_MHZ` clock to 20MHz from 8MHz
31-
3225
#### Releases v1.5.1
3326

34-
1. Initial coding to support ESP32 boards using ENC28J60 LwIP Ethernet. Sync with [WebServer_WT32_ETH01 v1.5.1](https://github.com/khoih-prog/WebServer_WT32_ETH01)
27+
1. Initial coding to support ESP32 boards using `LwIP ENC28J60 Ethernet`. Sync with [WebServer_WT32_ETH01 v1.5.1](https://github.com/khoih-prog/WebServer_WT32_ETH01)
3528

3629

3730

0 commit comments

Comments
 (0)