v1.8.0 to use Ethernet_Generic library

khoih-prog · web-flow · commit 0b2b3082facf · 2022-04-05T20:25:17.000-04:00
### Releases v1.8.0 1. Use new [Ethernet_Generic library](https://github.com/khoih-prog/Ethernet_Generic) as default for W5x00. 2. Rewrite to avoid `multiple-definitions` linker error for multiple-file project 3. Add example [multiFileProject](examples/multiFileProject) to demo how to avoid `multiple-definitions` linker error for multiple-file project 4. Update `Packages' Patches`
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
-* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, ESP8266 core v3.0.2, ArduinoCore-mbed v3.0.0, etc.)
+* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, ESP8266 core v3.0.2, ArduinoCore-mbed v3.0.1, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -28,9 +28,9 @@ Please ensure to specify the following:
 ```
 Arduino IDE version: 1.8.19
 RASPBERRY_PI_PICO board
-ArduinoCore-mbed v3.0.0
+ArduinoCore-mbed v3.0.1
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.13.0-37-generic #42~20.04.1-Ubuntu SMP Tue Mar 15 15:44:28 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.13.0-39-generic #44~20.04.1-Ubuntu SMP Thu Mar 24 16:43:35 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while trying to use the Timer Interrupt.
diff --git a/changelog.md b/changelog.md
@@ -12,6 +12,7 @@
 
 
 * [Changelog](#changelog)
+  * [Releases v1.8.0](#releases-v180)
   * [Releases v1.7.8](#releases-v178)
   * [Releases v1.7.7](#releases-v177)
   * [Releases v1.7.6](#releases-v176)
@@ -37,6 +38,13 @@
 
 ## Changelog
 
+### Releases v1.8.0
+
+1. Use new [Ethernet_Generic library](https://github.com/khoih-prog/Ethernet_Generic) as default for W5x00.
+2. Rewrite to avoid `multiple-definitions` linker error for multiple-file project
+3. Add example [multiFileProject](examples/multiFileProject) to demo how to avoid `multiple-definitions` linker error for multiple-file project
+4. Update `Packages' Patches`
+
 ### Releases v1.7.8
 
 1. Sync with [SSLClient v1.6.11](https://github.com/OPEnSLab-OSU/SSLClient/releases/tag/v1.6.11). Check [Pull in OPEnSLab-OSU's SSLClient v1.6.11 #17](https://github.com/khoih-prog/EthernetWebServer_SSL/issues/17)
diff --git a/library.json b/library.json
@@ -1,8 +1,8 @@
 {
   "name": "EthernetWebServer_SSL",
-  "version": "1.7.8",
+  "version": "1.8.0",
   "keywords": "WebServer, Ethernet, Ethernet2, Ethernet3, EthernetLarge, EtnernetENC, UIPEthernet, NativeEthernet, QNEthernet, Portenta-H7, Teensy, SAMD21, SAMD51, SAM DUE, nRF52, ESP32, ESP8266, rpi-pico, rp2040, W5x00, W5500, ENC28J60, Ethernet shield, SSL, TLS, HTTP-Client, WebSocket-Client, server, client, websocket",
-  "description": "Simple TLS/SSL Ethernet WebServer, HTTP Client and WebSocket Client library for Teensy, SAM DUE, SAMD21, SAMD51, nRF52, ESP32, ESP8266 and RASPBERRY_PI_PICO boards using Ethernet shields W5100, W5200, W5500, ENC28J60 or Teensy 4.1 NativeEthernet/QNEthernet. It supports Arduino boards (Atmel AVR-s, SAM DUE, Atmel SAM3X8E ARM Cortex-M3, SAMD21, SAMD51, ESP8266, ESP32, Adafruit nRF52, Teensy boards, Realtek Ameba(RTL8195A,RTL8710)) using Wiznet W5x00 or ENC28J60 network shields",
+  "description": "Simple TLS/SSL Ethernet WebServer, HTTP Client and WebSocket Client library for for AVR, Portenta_H7, Teensy, SAM DUE, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, nRF52 and RASPBERRY_PI_PICO boards using Ethernet shields W5100, W5200, W5500, ENC28J60 or Teensy 4.1 NativeEthernet/QNEthernet. It now supports Ethernet TLS/SSL Client. The WebServer supports HTTP/HTTPS GET and POST requests, provides argument parsing, handles one client at a time. It now provides HTTP Client and WebSocket Client. It supports Arduino boards (SAM DUE, Atmel SAM3X8E ARM Cortex-M3, SAMD21, SAMD51, ESP8266, ESP32, Adafruit nRF52, Teensy and RASPBERRY_PI_PICO boards) using Wiznet W5x00, ENC28J60 network shields or Teensy 4.1 built-in NativeEthernet/QNEthernet. Ethernet_Generic library is used as default for W5x00",
   "authors":
   {
     "name":  "Khoi Hoang",
@@ -29,6 +29,11 @@
       "name": "Functional-Vlpp",
       "version": "^1.0.2"
     },
+    {
+      "owner": "khoih-prog",
+      "name": "Ethernet_Generic",
+      "version": "^2.0.0"
+    },
     {
       "owner": "ssilverman",
       "name": "QNEthernet",
@@ -40,5 +45,5 @@
   "frameworks": "*",
   "platforms": "*",
   "examples": "examples/*/*/*.ino",
-  "headers": ["EthernetWebServer_SSL.h", "EthernetHttpClient_SSL.h"]
+  "headers": ["EthernetWebServer_SSL.h", "EthernetWebServer_SSL.hpp", "EthernetHttpClient_SSL.h"]
 }
diff --git a/library.properties b/library.properties
@@ -1,12 +1,12 @@
 name=EthernetWebServer_SSL
-version=1.7.8
+version=1.8.0
 author=Khoi Hoang
 license=GPLv3
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=Simple TLS/SSL Ethernet WebServer, HTTP Client and WebSocket Client library for for AVR, Portenta_H7, Teensy, SAM DUE, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, nRF52 and RASPBERRY_PI_PICO boards using Ethernet shields W5100, W5200, W5500, ENC28J60 or Teensy 4.1 NativeEthernet/QNEthernet. It now supports Ethernet TLS/SSL Client.
-paragraph=The WebServer supports HTTP/HTTPS GET and POST requests, provides argument parsing, handles one client at a time. It now provides HTTP Client and WebSocket Client. It supports Arduino boards (SAM DUE, Atmel SAM3X8E ARM Cortex-M3, SAMD21, SAMD51, ESP8266, ESP32, Adafruit nRF52, Teensy and RASPBERRY_PI_PICO boards) using Wiznet W5x00, ENC28J60 network shields or Teensy 4.1 built-in NativeEthernet/QNEthernet
+paragraph=The WebServer supports HTTP/HTTPS GET and POST requests, provides argument parsing, handles one client at a time. It now provides HTTP Client and WebSocket Client. It supports Arduino boards (SAM DUE, Atmel SAM3X8E ARM Cortex-M3, SAMD21, SAMD51, ESP8266, ESP32, Adafruit nRF52, Teensy and RASPBERRY_PI_PICO boards) using Wiznet W5x00, ENC28J60 network shields or Teensy 4.1 built-in NativeEthernet/QNEthernet. Ethernet_Generic library is used as default for W5x00
 category=Communication
 url=https://github.com/khoih-prog/EthernetWebServer_SSL
 architectures=*
-depends=Functional-Vlpp
-includes=EthernetWebServer_SSL.h,EthernetHttpClient_SSL.h
+depends=Functional-Vlpp, Ethernet_Generic
+includes=EthernetWebServer_SSL.h, EthernetWebServer_SSL.hpp, EthernetHttpClient_SSL.h
diff --git a/platformio/platformio.ini b/platformio/platformio.ini
@@ -41,23 +41,25 @@ lib_compat_mode = strict
 
 lib_deps = 
 ; PlatformIO 4.x 
-  Functional-Vlpp@~1.0.2
-  Ethernet@~2.0.0
-  EthernetLarge@~2.0.0
-  Ethernet2@~1.0.4
-  Ethernet3@~1.5.5
-  EthernetENC@~2.0.2
-  UIPEthernet@~2.0.9
-  QNEthernet@>=0.13.0
+;  Functional-Vlpp@~1.0.2
+;  Ethernet@~2.0.0
+;  EthernetLarge@~2.0.0
+;  Ethernet2@~1.0.4
+;  Ethernet3@~1.5.5
+;  EthernetENC@~2.0.2
+;  UIPEthernet@~2.0.9
+;  QNEthernet@>=0.13.0
+;  Ethernet_Generic>=2.0.0
 ; PlatformIO 5.x  
-;  khoih-prog/Functional-Vlpp@~1.0.2
+  khoih-prog/Functional-Vlpp@~1.0.2
+  khoih-prog/Ethernet_Generic@~2.0.0
 ;  PaulStoffregen/Ethernet@~2.0.0
 ;  PaulStoffregen/EthernetLarge@~2.0.0
 ;  adafruit/Ethernet2@~1.0.4
 ;  sstaub/Ethernet3@~1.5.5
 ;  jandrassy/EthernetENC@~2.0.2
 ;  UIPEthernet/UIPEthernet@~2.0.9
-;  ssilverman/QNEthernet@>=0.13.0
+  ssilverman/QNEthernet@>=0.13.0
 
 build_flags =
 ; set your debug output (default=Serial)
