v1.0.1 add support to W5x00 Ethernet shields

### New in Version v1.0.1 1. Add support to ***W5x00*** Ethernet shields to all STM32 boards having 64+K bytes Flash.
khoih-prog · Feb 28, 2020 · 092d5b4 · 092d5b4
1 parent 07ce1b1
commit 092d5b4
Show file tree

Hide file tree

Showing 19 changed files with 175 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,18 @@
 
 [![arduino-library-badge](https://www.ardu-badge.com/badge/EthernetWebServer_STM32.svg?)](https://www.ardu-badge.com/EthernetWebServer_STM32)
 
+### New in Version v1.0.1
+
+1. Add support to ***W5x00*** Ethernet shields to all STM32 boards having 64+K bytes Flash.
+
 This library currently supports
 1. STM32 boards with built-in Ethernet such as :
   - ***Nucleo-144 (F429ZI, F767ZI)***
   - ***Discovery (STM32F746G-DISCOVERY)***
   - ***All STM32 Boards with Built-in Ethernet***, See [How To Use Built-in Ethernet](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
-2. ***STM32 boards (with 64+K Flash) running EMC28J60 shields***
-3. See [EthernetWebServer Library Issue 1](https://github.com/khoih-prog/EthernetWebServer/issues/1) for reason to create this separate library from [EthernetWebServer library](https://github.com/khoih-prog/EthernetWebServer)
+2. ***STM32 boards (with 64+K Flash) running ENC28J60 shields***
+3. ***STM32 boards (with 64+K Flash) running W5x00 shields***
+4. See [EthernetWebServer Library Issue 1](https://github.com/khoih-prog/EthernetWebServer/issues/1) for reason to create this separate library from [EthernetWebServer library](https://github.com/khoih-prog/EthernetWebServer)
 
 This is simple yet complete WebServer library for `STM32` boards running built-in Ethernet (Nucleo-144, Discovery) or EMC28J60 Ethernet shields. The functions are similar and compatible to ESP8266/ESP32 WebServer libraries to make life much easier to port sketches from ESP8266/ESP32.
 
@@ -333,6 +338,9 @@ HTTP EthernetWebServer is @ IP : 192.168.2.100
 </g>
 </svg>
 ```
+### Version v1.0.1
+
+1. Add support to W5x00 Ethernet shields to all STM32 boards having 64+K bytes Flash.
 
 ### Version v1.0.0
 

diff --git a/examples/AdvancedWebServer/AdvancedWebServer.ino b/examples/AdvancedWebServer/AdvancedWebServer.ino
@@ -8,7 +8,7 @@
  *  Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  *  Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  *  Licensed under MIT license
- *  Version: 1.0.0
+ *  Version: 1.0.1
  *
  *  Copyright (c) 2015, Majenko Technologies
  *  All rights reserved.
@@ -44,18 +44,23 @@
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 /*
  * Currently support 
  * 1) STM32 boards with built-in Ethernet (to use USE_BUILTIN_ETHERNET = true) such as :
  *    - Nucleo-144 (F429ZI, F767ZI)
  *    - Discovery (STM32F746G-DISCOVERY)
+ *    - All STM32 Boards with Built-in Ethernet, See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
  * 2) STM32 boards (with 64+K Flash) running EMC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
+ * 3) STM32 boards (with 32+K Flash) running W5x00 Ethernet shields
  * 
  */
 
-#define USE_BUILTIN_ETHERNET   false    //true
+#define USE_BUILTIN_ETHERNET    false    //true
+//  If don't use USE_BUILTIN_ETHERNET, and USE_UIP_ETHERNET => use W5x00 with Ethernet library
+#define USE_UIP_ETHERNET        false 
 
 #include <EthernetWebServer_STM32.h>
 

diff --git a/examples/HelloServer/HelloServer.ino b/examples/HelloServer/HelloServer.ino
@@ -8,26 +8,31 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+  * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 /*
  * Currently support 
  * 1) STM32 boards with built-in Ethernet (to use USE_BUILTIN_ETHERNET = true) such as :
  *    - Nucleo-144 (F429ZI, F767ZI)
  *    - Discovery (STM32F746G-DISCOVERY)
+ *    - All STM32 Boards with Built-in Ethernet, See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
  * 2) STM32 boards (with 64+K Flash) running EMC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
+ * 3) STM32 boards (with 32+K Flash) running W5x00 Ethernet shields
  * 
  */
 
-#define USE_BUILTIN_ETHERNET   false    //true
+#define USE_BUILTIN_ETHERNET    false    //true
+//  If don't use USE_BUILTIN_ETHERNET, and USE_UIP_ETHERNET => use W5x00 with Ethernet library
+#define USE_UIP_ETHERNET        false 
 
 #include <EthernetWebServer_STM32.h>
 

diff --git a/examples/HelloServer2/HelloServer2.ino b/examples/HelloServer2/HelloServer2.ino
@@ -8,26 +8,31 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+  * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 /*
  * Currently support 
  * 1) STM32 boards with built-in Ethernet (to use USE_BUILTIN_ETHERNET = true) such as :
  *    - Nucleo-144 (F429ZI, F767ZI)
  *    - Discovery (STM32F746G-DISCOVERY)
+ *    - All STM32 Boards with Built-in Ethernet, See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
  * 2) STM32 boards (with 64+K Flash) running EMC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
+ * 3) STM32 boards (with 32+K Flash) running W5x00 Ethernet shields
  * 
  */
 
-#define USE_BUILTIN_ETHERNET   false    //true
+#define USE_BUILTIN_ETHERNET    false    //true
+//  If don't use USE_BUILTIN_ETHERNET, and USE_UIP_ETHERNET => use W5x00 with Ethernet library
+#define USE_UIP_ETHERNET        false 
 
 #include <EthernetWebServer_STM32.h>
 

diff --git a/examples/HttpBasicAuth/HttpBasicAuth.ino b/examples/HttpBasicAuth/HttpBasicAuth.ino
@@ -8,26 +8,31 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+  * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 /*
  * Currently support 
  * 1) STM32 boards with built-in Ethernet (to use USE_BUILTIN_ETHERNET = true) such as :
  *    - Nucleo-144 (F429ZI, F767ZI)
  *    - Discovery (STM32F746G-DISCOVERY)
+ *    - All STM32 Boards with Built-in Ethernet, See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
  * 2) STM32 boards (with 64+K Flash) running EMC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
+ * 3) STM32 boards (with 32+K Flash) running W5x00 Ethernet shields
  * 
  */
 
-#define USE_BUILTIN_ETHERNET   false    //true
+#define USE_BUILTIN_ETHERNET    false    //true
+//  If don't use USE_BUILTIN_ETHERNET, and USE_UIP_ETHERNET => use W5x00 with Ethernet library
+#define USE_UIP_ETHERNET        false 
 
 #include <EthernetWebServer_STM32.h>
 

diff --git a/examples/PostServer/PostServer.ino b/examples/PostServer/PostServer.ino
@@ -8,26 +8,31 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+ * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 /*
  * Currently support 
  * 1) STM32 boards with built-in Ethernet (to use USE_BUILTIN_ETHERNET = true) such as :
  *    - Nucleo-144 (F429ZI, F767ZI)
  *    - Discovery (STM32F746G-DISCOVERY)
+ *    - All STM32 Boards with Built-in Ethernet, See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
  * 2) STM32 boards (with 64+K Flash) running EMC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
+ * 3) STM32 boards (with 32+K Flash) running W5x00 Ethernet shields
  * 
  */
 
-#define USE_BUILTIN_ETHERNET   false    //true
+#define USE_BUILTIN_ETHERNET    false    //true
+//  If don't use USE_BUILTIN_ETHERNET, and USE_UIP_ETHERNET => use W5x00 with Ethernet library
+#define USE_UIP_ETHERNET        false 
 
 #include <EthernetWebServer_STM32.h>
 

diff --git a/examples/SimpleAuthentication/SimpleAuthentication.ino b/examples/SimpleAuthentication/SimpleAuthentication.ino
@@ -8,26 +8,31 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+  * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 /*
  * Currently support 
  * 1) STM32 boards with built-in Ethernet (to use USE_BUILTIN_ETHERNET = true) such as :
  *    - Nucleo-144 (F429ZI, F767ZI)
  *    - Discovery (STM32F746G-DISCOVERY)
+ *    - All STM32 Boards with Built-in Ethernet, See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
  * 2) STM32 boards (with 64+K Flash) running EMC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
+ * 3) STM32 boards (with 32+K Flash) running W5x00 Ethernet shields
  * 
  */
 
-#define USE_BUILTIN_ETHERNET   false    //true
+#define USE_BUILTIN_ETHERNET    false    //true
+//  If don't use USE_BUILTIN_ETHERNET, and USE_UIP_ETHERNET => use W5x00 with Ethernet library
+#define USE_UIP_ETHERNET        false 
 
 #include <EthernetWebServer_STM32.h>
 

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "EthernetWebServer_STM32",
-  "keywords": "WebServer, built-in Ethernet, Arduino, STM32, Ethernet shield, Nucleo-144",
+  "keywords": "WebServer, built-in Ethernet, Arduino, STM32, Ethernet shield, Nucleo-144, ENC28J60, W5x00",
   "description": "Simple EthernetWebServer library for STM32 boards running built-in Ethernet or Ethernet shields",
   "repository":
   {
@@ -9,5 +9,5 @@
   },
   "frameworks": "arduino",
   "platforms": "ststm32",
-  "version": "1.0.0"
+  "version": "1.0.1"
 }
diff --git a/library.properties b/library.properties
@@ -1,10 +1,10 @@
 name=EthernetWebServer_STM32
-version=1.0.0
+version=1.0.1
 author=Khoi Hoang
 license=MIT
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=EthernetWebServer is a library for STM32 boards running WebServer using built-in Ethernet or Ethernet shields
-paragraph=The library supports HTTP GET and POST requests, provides argument parsing, handles one client at a time. It supports Arduino boards (STM32F series with 64+Kbytes of Flash) using built-in Ethernet (Nucleo-144: F429ZI, F767ZI, Discovery: STM32F746G-DISCOVERY) or ENC28j60 network shields.
+paragraph=The library supports HTTP GET and POST requests, provides argument parsing, handles one client at a time. It supports Arduino boards (STM32F series with 64+Kbytes of Flash) using built-in Ethernet (Nucleo-144: F429ZI, F767ZI, Discovery: STM32F746G-DISCOVERY), ENC28J60 or W5x00 Ethernet shields.
 category=Communication
 url=https://github.com/khoih-prog/EthernetWebServer_STM32
 architectures=stm32

diff --git a/src/EthernetWebServer_STM32-impl.h b/src/EthernetWebServer_STM32-impl.h
@@ -7,15 +7,16 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+ * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 
 #ifndef EthernetWebServer_STM32_impl_h

diff --git a/src/EthernetWebServer_STM32.h b/src/EthernetWebServer_STM32.h
@@ -7,15 +7,16 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+ * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 
 #ifndef EthernetWebServer_STM32_h
@@ -32,9 +33,14 @@
 #if USE_BUILTIN_ETHERNET
   #include <LwIP.h>
   #include <STM32Ethernet.h>
-#else
+  #warning Use built-in STM32 Ethernet
+#elif USE_UIP_ETHERNET
   #include <UIPEthernet.h>
   #include <utility/logging.h>
+  #warning Use ENC28J60 Ethernet shield
+#else
+  #include <Ethernet.h>
+  #warning Use W5x00 Ethernet shield
 #endif
 
 enum HTTPMethod { HTTP_ANY, HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_PATCH, HTTP_DELETE, HTTP_OPTIONS };

diff --git a/src/Parsing_STM32-impl.h b/src/Parsing_STM32-impl.h
@@ -7,16 +7,18 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+ * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
+
 #ifndef Parsing_STM32_impl_h
 #define Parsing_STM32_impl_h
 

diff --git a/src/detail/Debug_STM32.h b/src/detail/Debug_STM32.h
@@ -7,15 +7,16 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+ * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 
 #ifndef EthernetWebServer_STM32_Debug_H

diff --git a/src/detail/RequestHandler_STM32.h b/src/detail/RequestHandler_STM32.h
@@ -7,15 +7,16 @@
  * Forked and modified from ESP8266 https://github.com/esp8266/Arduino/releases
  * Built by Khoi Hoang https://github.com/khoih-prog/ESP8266_AT_WebServer
  * Licensed under MIT license
- * Version: 1.0.0
+ * Version: 1.0.1
  *
  * Original author:
  * @file       Esp8266WebServer.h
  * @author     Ivan Grokhotkov
  *
  * Version Modified By   Date      Comments
  * ------- -----------  ---------- -----------
- *  1.0.0   K Hoang      13/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc)
+ *  1.0.0   K Hoang      26/02/2020 Initial coding for STM32 with built-in Ethernet (Nucleo-144, DISCOVERY, etc) and ENC28J60
+ *  1.0.1   K Hoang      28/02/2020 Add W5x00 Ethernet shields using Ethernet library
  *****************************************************************************************************************************/
 
 #ifndef RequestHandler_STM32_h