Fix native Ethernet and Ethernet integration issues.

mobizt · Sep 15, 2023 · 229b0e8 · 229b0e8
1 parent f49c467
commit 229b0e8
Show file tree

Hide file tree

Showing 31 changed files with 66 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -5,14 +5,16 @@
 ![arduino-library-badge](https://www.ardu-badge.com/badge/Firebase%20ESP32%20Client.svg) ![PlatformIO](https://badges.registry.platformio.org/packages/mobizt/library/Firebase%20ESP32%20Client.svg) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6462672.svg)](https://doi.org/10.5281/zenodo.6462672)
 
 
-This library supports ESP32 MCU from Espressif. The following are platforms in which libraries are also available.
+This library provides Firebase Realtime database and Firebase Cloud Messaging functions and supports only ESP32 MCU from Espressif with or without External network module. The ESP8266 version is available [here](https://github.com/mobizt/Firebase-ESP8266).
 
-* [ESP8266 Firebase Arduino library]( https://github.com/mobizt/Firebase-ESP8266)
+The features can be configurable to add and exclude some unused features, see [Library Build Options](#library-build-options).
 
-* [Arduino MKR WiFi 1010, Arduino MKR VIDOR 4000 and Arduino UNO WiFi Rev.2](https://github.com/mobizt/Firebase-Arduino-WiFiNINA)
+If you use other Arduino devices or you want to use more Firebase services included Cloud Firestore database, Firebase Storage, Google Cloud Storage and Cloud Functions for Firebase, please use [Firebase-ESP-Client](https://github.com/mobizt/Firebase-ESP-Client) library instead.
 
-* [Arduino WiFi Shield 101 and Arduino MKR1000 WIFI](https://github.com/mobizt/Firebase-Arduino-WiFi101)
 
+The RTDB (Realtime database), FCM (Cloud Messaing) and core code used in `Firebase-ESP-Client`, `FirebaseESP8266` and `FirebaseESP32` libraries are the same unless the syntaxes are different. Please see the library examples for usage guidlines.
+
+The `FirebaseESP8266` and `FirebaseESP32` libraries are the old and limited features Firebase client library while `Firebase-ESP-Client` is the newver version of Firebase client library that developed to support more Firebase services.
 
 ## Contents
 
@@ -460,6 +462,7 @@ The following options are not yet defined in [**FirebaseFS.h**](src/FirebaseFS.h
 ```cpp
 FIREBASE_ETHERNET_MODULE_LIB `"EthernetLibrary.h"` // For the Ethernet library to work with external Ethernet module
 FIREBASE_ETHERNET_MODULE_CLASS EthernetClass // For the Ethernet class object of Ethernet library to work with external Ethernet module
+FIREBASE_ETHERNET_MODULE_TIMEOUT 2000 // For the time out in milliseconds to wait external Ethernet module to connect to network
 FIREBASE_DISABLE_ONBOARD_WIFI // For disabling on-board WiFI functionality in case external Client usage
 FIREBASE_DISABLE_NATIVE_ETHERNET // For disabling native (sdk) Ethernet functionality in case external Client usage
 FIREBASE_DEFAULT_DEBUG_PORT // For debug port assignment
@@ -484,6 +487,7 @@ For external Ethernet module integation used with function `setEthernetClient`,
 
 `FIREBASE_ETHERNET_MODULE_CLASS` is the name of static object defined from class e.g. `Ethernet`.
 
+`FIREBASE_ETHERNET_MODULE_TIMEOUT` is the time out in milliseconds to wait network connection.
 
 For disabling predefined options instead of editing the [**FirebaseFS.h**](src/FirebaseFS.h) or using `#undef` in `CustomFirebaseFS.h`, you can define these build flags with these names or macros in `CustomFirebaseFS.h`.
 

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "Firebase ESP32 Client",
-  "version": "4.4.7",
+  "version": "4.4.8",
   "keywords": "communication, REST, esp32, arduino",
   "description": "The secure, fast and reliable Firebase Realtime database library to read, store, update, delete, listen, backup, and restore data. You can also read and modify the database security rules with this library.",
   "repository": {

diff --git a/library.properties b/library.properties
@@ -1,6 +1,6 @@
 name=Firebase ESP32 Client
 
-version=4.4.7
+version=4.4.8
 
 author=Mobizt
 

diff --git a/src/FB_Const.h b/src/FB_Const.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/FB_Error.h b/src/FB_Error.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/FB_Network.h b/src/FB_Network.h
@@ -1,10 +1,10 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 
 /**
- * Created September 5, 2023
+ * Created September 14, 2023
  */
 #ifndef FIREBASE_NETWORK_H
 #define FIREBASE_NETWORK_H
@@ -71,20 +71,23 @@
 
 #endif
 
-#if defined(INC_ENC28J60_LWIP) && defined(INC_W5100_LWIP) && defined(INC_W5500_LWIP)
+#if defined(INC_ENC28J60_LWIP) || defined(INC_W5100_LWIP) || defined(INC_W5500_LWIP)
 #define FIREBASE_ETH_IS_AVAILABLE
 #endif
 
 #endif
 
 #endif
 
+
 #if __has_include(<Ethernet.h>) ||  (defined(FIREBASE_ETHERNET_MODULE_LIB) && defined(FIREBASE_ETHERNET_MODULE_CLASS))
 
 #if defined(ESP8266)
 #undef MAX_SOCK_NUM
+#endif
+
+#if (defined(ESP8266)  && defined(FIREBASE_DISABLE_NATIVE_ETHERNET)) || (!defined(ESP8266) && !defined(ARDUINO_NANO_RP2040_CONNECT))
 
-#if defined(FIREBASE_DISABLE_NATIVE_ETHERNET)
 
 #if defined(FIREBASE_ETHERNET_MODULE_LIB) && defined(FIREBASE_ETHERNET_MODULE_CLASS)
 #if __has_include(FIREBASE_ETHERNET_MODULE_LIB)
@@ -100,33 +103,28 @@
 #endif
 
 #if defined(ETH_MODULE_CLASS)
+
 #define FIREBASE_ETHERNET_MODULE_IS_AVAILABLE
-#endif
 
+#if !defined(FIREBASE_ETHERNET_MODULE_TIMEOUT)
+#define FIREBASE_ETHERNET_MODULE_TIMEOUT 2000
+#elif FIREBASE_ETHERNET_MODULE_TIMEOUT <= 0 || FIREBASE_ETHERNET_MODULE_TIMEOUT > 120 * 1000
+#undef FIREBASE_ETHERNET_MODULE_TIMEOUT
+#define FIREBASE_ETHERNET_MODULE_TIMEOUT 2000
 #endif
 
-#undef MAX_SOCK_NUM
-#elif !defined(ARDUINO_NANO_RP2040_CONNECT)
 
-#if defined(FIREBASE_ETHERNET_MODULE_LIB) && defined(FIREBASE_ETHERNET_MODULE_CLASS)
-#if __has_include(FIREBASE_ETHERNET_MODULE_LIB)
-#include FIREBASE_ETHERNET_MODULE_LIB
-#define ETH_MODULE_CLASS FIREBASE_ETHERNET_MODULE_CLASS
-#elif __has_include(<Ethernet.h>)
-#include <Ethernet.h>
-#define ETH_MODULE_CLASS Ethernet
-#endif
-#else
-#include <Ethernet.h>
-#define ETH_MODULE_CLASS Ethernet
 #endif
 
-#if defined(ETH_MODULE_CLASS)
-#define FIREBASE_ETHERNET_MODULE_IS_AVAILABLE
+
 #endif
 
+
+#if defined(ESP8266)
+#undef MAX_SOCK_NUM
 #endif
 
+
 #endif
 
 #if defined(ESP32) || defined(ESP8266) || defined(ARDUINO_RASPBERRY_PI_PICO_W) || \

diff --git a/src/FB_Utils.h b/src/FB_Utils.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/Firebase.cpp b/src/Firebase.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/Firebase.h b/src/Firebase.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/FirebaseFS.h b/src/FirebaseFS.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 
@@ -182,9 +182,11 @@
  * - FIREBASE_ETHERNET_MODULE_LIB is the Ethernet library name with extension (.h) and
  *   should be inside "" or <> e.g. "Ethernet.h".
  * - FIREBASE_ETHERNET_MODULE_CLASS is the name of static object defined from class e.g. Ethernet.
+ * - FIREBASE_ETHERNET_MODULE_TIMEOUT is the time out in milliseconds to wait network connection.
  * 
  * #define FIREBASE_ETHERNET_MODULE_LIB "EthernetLib.h"
  * #define FIREBASE_ETHERNET_MODULE_CLASS EthernetClass
+ * #define FIREBASE_ETHERNET_MODULE_TIMEOUT 2000
  *
  * 🏷️ For disabling on-board WiFI functionality in case external Client usage
  * #define FIREBASE_DISABLE_ONBOARD_WIFI

diff --git a/src/client/FB_TCP_Client.h b/src/client/FB_TCP_Client.h
@@ -1,7 +1,7 @@
 /**
- * Firebase TCP Client v1.0.1
+ * Firebase TCP Client v1.0.2
  *
- * Created September 11, 2023
+ * Created September 14, 2023
  *
  * The MIT License (MIT)
  * Copyright (c) 2022 K. Suwatchai (Mobizt)
@@ -1055,7 +1055,7 @@ class Firebase_TCP_Client : public Client
 
     unsigned long to = millis();
 
-    while (ETH_MODULE_CLASS.linkStatus() == LinkOFF && millis() - to < 2000)
+    while (ETH_MODULE_CLASS.linkStatus() == LinkOFF && millis() - to < FIREBASE_ETHERNET_MODULE_TIMEOUT)
     {
       delay(100);
     }
@@ -1082,7 +1082,12 @@ class Firebase_TCP_Client : public Client
   bool ethernetConnected()
   {
 #if defined(FIREBASE_ETHERNET_MODULE_IS_AVAILABLE)
-    _network_status = ETH_MODULE_CLASS.linkStatus() == LinkON;
+    _network_status = ETH_MODULE_CLASS.linkStatus() == LinkON && validIP(ETH_MODULE_CLASS.localIP());
+    if (!_network_status)
+    {
+      delay(FIREBASE_ETHERNET_MODULE_TIMEOUT);
+      _network_status = ETH_MODULE_CLASS.linkStatus() == LinkON && validIP(ETH_MODULE_CLASS.localIP());
+    }
 #endif
     return _network_status;
   }

diff --git a/src/core/FirebaseCore.cpp b/src/core/FirebaseCore.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/core/FirebaseCore.h b/src/core/FirebaseCore.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/core/Firebase_Client_Version.h b/src/core/Firebase_Client_Version.h
@@ -1,6 +1,6 @@
 #ifndef FIREBASE_CLIENT_VERSION
-#define FIREBASE_CLIENT_VERSION "4.4.7"
-#define FIREBASE_CLIENT_VERSION_NUM 40407
+#define FIREBASE_CLIENT_VERSION "4.4.8"
+#define FIREBASE_CLIENT_VERSION_NUM 40408
 
 /* The inconsistent file version checking to prevent mixed versions compilation. */
 #define FIREBASE_CLIENT_VERSION_CHECK(ver) (ver == FIREBASE_CLIENT_VERSION_NUM)

diff --git a/src/message/FCM.cpp b/src/message/FCM.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/message/FCM.h b/src/message/FCM.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/message/LFCM.h b/src/message/LFCM.h
@@ -1,6 +1,6 @@
 
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/FB_RTDB.cpp b/src/rtdb/FB_RTDB.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/FB_RTDB.h b/src/rtdb/FB_RTDB.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/QueryFilter.cpp b/src/rtdb/QueryFilter.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/QueryFilter.h b/src/rtdb/QueryFilter.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/QueueInfo.cpp b/src/rtdb/QueueInfo.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/QueueInfo.h b/src/rtdb/QueueInfo.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/QueueManager.cpp b/src/rtdb/QueueManager.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/QueueManager.h b/src/rtdb/QueueManager.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/stream/FB_MP_Stream.cpp b/src/rtdb/stream/FB_MP_Stream.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/stream/FB_MP_Stream.h b/src/rtdb/stream/FB_MP_Stream.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/stream/FB_Stream.cpp b/src/rtdb/stream/FB_Stream.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/rtdb/stream/FB_Stream.h b/src/rtdb/stream/FB_Stream.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/session/FB_Session.cpp b/src/session/FB_Session.cpp
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif
 

diff --git a/src/session/FB_Session.h b/src/session/FB_Session.h
@@ -1,5 +1,5 @@
 #include "./core/Firebase_Client_Version.h"
-#if !FIREBASE_CLIENT_VERSION_CHECK(40407)
+#if !FIREBASE_CLIENT_VERSION_CHECK(40408)
 #error "Mixed versions compilation."
 #endif