Merge branch 'mobizt:main' into fix-typos

Author: mWaleedh

README.md

@@ -68,7 +68,7 @@ In Library Manager Window, search **"firebase"** in the search form then select
 
 Click **"Install"** button.
 
-For `PlatformIO` IDE, using the following command.
+For `PlatformIO` IDE, use the following command.
 
 **pio lib install "FirebaseClient""**
 
@@ -115,15 +115,15 @@ See this Arduino-Pico SDK [documentation](https://arduino-pico.readthedocs.io/en
 
 For new `Firebase` users, please read the [Project Preparation and Setup](#project-preparation-and-setup) section for preparing the Firebase project.
 
-For new library user that the project was setup and prepared, see the [bare minimun examples](/examples/BareMinimum/) to start using this library with minimum code that requires by this library.
+For new library user that the project was setup and prepared, see the [bare minimun examples](/examples/BareMinimum/) to start using this library with minimum code that is required by this library.
 
 For more examples, please click [here](/examples/).
 
 ### Working Principle 
 
-This library can be used in two modes i.e. async mode and await or sinc mode.
+This library can be used in two modes i.e. async mode and await or sync mode.
 
-With async mode, the task will store in the FIFO queue. The result of the running task can be obtained via the callback function or the proxy object that assign when calling the functions.
+With async mode, the task will be stored in the FIFO queue. The result of the running task can be obtained via the callback function or the proxy object that assign when calling the functions.
 
 The `AsyncClientClass` is the proxy class that provides the queue for async tasks and also the information of task process when working in await or sync mode.
 
@@ -712,4 +712,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 `THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.`
 
-*Last updated 2025-05-29 UTC.*
+*Last updated 2025-08-01 UTC.*

examples/BareMinimum/AllServices/AllServices.ino

@@ -1,5 +1,5 @@
 /**
- * The beare minimum code example for using all Firebase services.
+ * The bare minimum code example for using all Firebase services.
  *
  * The steps which are generally required are explained below.
  *
@@ -37,7 +37,7 @@
  * ==============================
  * It handles server connection and data transfer works.
  *
- * In this beare minimum example we use only one SSL client for all processes.
+ * In this bare minimum example we use only one SSL client for all processes.
  * In some use cases e.g. Realtime Database Stream connection, you may have to define the SSL client for it separately.
  *
  * Step 6. Define the Async Client.
@@ -56,14 +56,14 @@
  *
  * Step 8. Start the authenticate process.
  * ========================================
- * At this step, the authentication credential will be used to generate the auth tokens for authentication by
+ * At this step, the authentication credentials will be used to generate the auth tokens for authentication by
  * calling initializeApp.
  *
  * This allows us to use different authentications for each Firebase/Google Cloud services with different
  * FirebaseApps (authentication handler)s.
  *
  * When calling initializeApp with timeout, the authenication process will begin immediately and wait at this process
- * until it finished or timed out. It works in sync mode.
+ * until it is finished or timed out. It works in sync mode.
  *
  * If no timeout was assigned, it will work in async mode. The authentication task will be added to async client queue
  * to process later e.g. in the loop by calling FirebaseApp::loop.
@@ -80,7 +80,7 @@
  * ========================================================================================================
  * This allows us to use different authentications for each Firebase/Google Cloud services.
  *
- * It is easy to bind/unbind/change the authentication method for different Firebase/Google Cloud services APIs.
+ * It is easy to bind, unbind or change the authentication method for different Firebase/Google Cloud services APIs.
  *
  * Step 10. Set the Realtime Database URL (for Realtime Database only)
  * ===================================================================
@@ -94,7 +94,7 @@
  * Before calling the Firebase/Google Cloud services functions, the FirebaseApp::ready() of authentication handler that bined to it
  * should return true.
  *
- * Step 13. Process the results of async tasks the end of the loop.
+ * Step 13. Process the results of async tasks at the end of the loop.
  * ============================================================================
  * This requires only when async result was assigned to the Firebase/Google Cloud services functions.
  */
@@ -110,6 +110,7 @@
 #define ENABLE_CLOUD_STORAGE
 #define ENABLE_FUNCTIONS
 
+// For ESP32
 #include <WiFi.h>
 #include <WiFiClientSecure.h>
 #include <FirebaseClient.h>
@@ -191,17 +192,18 @@ void setup()
 
     // The SSL client options depend on the SSL client used.
 
-    // Skip certificate verification
+    // Skip certificate verification (Optional)
     ssl_client1.setInsecure();
     ssl_client2.setInsecure();
 
     // Set timeout
+     // Set timeout for ESP32 core sdk v3.x (Optional)
     ssl_client1.setConnectionTimeout(1000);
     ssl_client1.setHandshakeTimeout(5);
     ssl_client2.setConnectionTimeout(1000);
     ssl_client2.setHandshakeTimeout(5);
 
-    // ESP8266 Set buffer size
+    // ESP8266 Set buffer size (Optional)
     // ssl_client1.setBufferSizes(4096, 1024);
     // ssl_client2.setBufferSizes(4096, 1024);
 
@@ -233,6 +235,19 @@ void loop()
     {
         onetimeTest = true;
 
+        // The following code shows how to call the Firebase functions in both async and await or sync mode
+        
+        // for demonstation only. You can choose async or await/sync mode or use both modes in the same application. 
+        // For await/sync mode, no callback and AsyncResult object are assigned to the function, the function will
+        // return the value or payload immediately.
+
+        // For async mode, the value or payload will be returned later to the AsyncResult object 
+        // or when the callback was called.
+        // If AsyncResult was assigned to the function, please don't forget to check it before 
+        // exiting the loop as in step 13.
+
+        // For elaborate usage, plese see other examples.
+
         // Realtime Database set value.
         // ============================
 

examples/BareMinimum/README.md

@@ -2,6 +2,6 @@
 
 The minimum code examples when using this library.
 
-* [BeareMinimum](/examples/BareMinimum/)
+* [BareMinimum](/examples/BareMinimum/)
     * [RealtimeDatabase](/examples/BareMinimum/RealtimeDatabase/)
-    * [AllServices](/examples/BareMinimum/AllServices/)
+    * [AllServices](/examples/BareMinimum/AllServices/)

examples/BareMinimum/RealtimeDatabase/RealtimeDatabase.ino

@@ -1,12 +1,12 @@
 /**
- * The beare minimum code example for using Realtime Database service.
+ * The bare minimum code example for using Realtime Database service.
  *
  * The steps which are generally required are explained below.
  *
  * Step 1. Include the network, SSL client and Firebase libraries.
  * ===============================================================
  *
- * Step 2. Define the user functions that requred for the library usage.
+ * Step 2. Define the user functions that are required for library usage.
  * =====================================================================
  *
  * Step 3. Define the authentication config (identifier) class.
@@ -94,7 +94,7 @@
  * Before calling the Firebase/Google Cloud services functions, the FirebaseApp::ready() of authentication handler that bined to it
  * should return true.
  *
- * Step 13. Process the results of async tasks the end of the loop.
+ * Step 13. Process the results of async tasks at the end of the loop.
  * ============================================================================
  * This requires only when async result was assigned to the Firebase/Google Cloud services functions.
  */
@@ -104,6 +104,7 @@
 #define ENABLE_USER_AUTH
 #define ENABLE_DATABASE
 
+// For ESP32
 #include <WiFi.h>
 #include <WiFiClientSecure.h>
 #include <FirebaseClient.h>
@@ -155,17 +156,17 @@ void setup()
 
     // The SSL client options depend on the SSL client used.
 
-    // Skip certificate verification
+    // Skip certificate verification (Optional)
     ssl_client1.setInsecure();
     ssl_client2.setInsecure();
 
-    // Set timeout
+    // Set timeout for ESP32 core sdk v3.x. (Optional)
     ssl_client1.setConnectionTimeout(1000);
     ssl_client1.setHandshakeTimeout(5);
     ssl_client2.setConnectionTimeout(1000);
     ssl_client2.setHandshakeTimeout(5);
 
-    // ESP8266 Set buffer size
+    // ESP8266 Set buffer size (Optional)
     // ssl_client1.setBufferSizes(4096, 1024);
     // ssl_client2.setBufferSizes(4096, 1024);
 
@@ -189,6 +190,19 @@ void loop()
     {
         onetimeTest = true;
 
+        // The following codes showed how to call the Firebase functions in both async and await modes
+        
+        // for demonstation only. You can choose async or await mode or use both modes in the same application. 
+        // For await mode, no callback and AsyncResult object are assigned to the function, the function will
+        // return the value or payload immediately.
+
+        // For async mode, the value or payload will be returned later to the AsyncResult object 
+        // or when the callback was called.
+        // If AsyncResult was assigned to the function, please don't forget to check it before 
+        // exiting the loop as in step 13.
+
+        // For elaborate usage, plese see other examples.
+
         // Realtime Database set value.
         // ============================
 
@@ -198,13 +212,6 @@ void loop()
         // Async call with AsyncResult for returning result.
         Database.set<bool>(async_client1, "/examples/BareMinimum/data/set2", true, dbResult);
 
-        // Sync call which waits until the result was received.
-        bool status = Database.set<double>(async_client2, "/examples/BareMinimum/data/set3", 199.538639);
-        if (status)
-            Serial.println("Value set complete.");
-        else
-            Firebase.printf("Error, msg: %s, code: %d\n", async_client2.lastError().message().c_str(), async_client2.lastError().code());
-
         // Realtime Database get value.
         // ============================
 
@@ -214,6 +221,7 @@ void loop()
         // Async call with AsyncResult for returning result.
         Database.get(async_client1, "/examples/BareMinimum/data/set2", dbResult, false);
 
+        // Await call which waits until the result was received.
         String value = Database.get<String>(async_client2, "/examples/BareMinimum/data/set3");
         if (async_client2.lastError().code() == 0)
         {
@@ -245,4 +253,4 @@ void processData(AsyncResult &aResult)
 
     if (aResult.available())
         Firebase.printf("task: %s, payload: %s\n", aResult.uid().c_str(), aResult.c_str());
-}
+}

examples/RealtimeDatabase/Stream/Stream.ino

@@ -135,22 +135,22 @@ void processData(AsyncResult &aResult)
 
     if (aResult.available())
     {
-        RealtimeDatabaseResult &RTDB = aResult.to<RealtimeDatabaseResult>();
-        if (RTDB.isStream())
+        RealtimeDatabaseResult &stream = aResult.to<RealtimeDatabaseResult>();
+        if (stream.isStream())
         {
             Serial.println("----------------------------");
             Firebase.printf("task: %s\n", aResult.uid().c_str());
-            Firebase.printf("event: %s\n", RTDB.event().c_str());
-            Firebase.printf("path: %s\n", RTDB.dataPath().c_str());
-            Firebase.printf("data: %s\n", RTDB.to<const char *>());
-            Firebase.printf("type: %d\n", RTDB.type());
+            Firebase.printf("event: %s\n", stream.event().c_str());
+            Firebase.printf("path: %s\n", stream.dataPath().c_str());
+            Firebase.printf("data: %s\n", stream.to<const char *>());
+            Firebase.printf("type: %d\n", stream.type());
 
             // The stream event from RealtimeDatabaseResult can be converted to the values as following.
-            bool v1 = RTDB.to<bool>();
-            int v2 = RTDB.to<int>();
-            float v3 = RTDB.to<float>();
-            double v4 = RTDB.to<double>();
-            String v5 = RTDB.to<String>();
+            bool v1 = stream.to<bool>();
+            int v2 = stream.to<int>();
+            float v3 = stream.to<float>();
+            double v4 = stream.to<double>();
+            String v5 = stream.to<String>();
         }
         else
         {

examples/RealtimeDatabase/StreamConcurentcy/StreamConcurentcy.ino

@@ -177,22 +177,22 @@ void processData(AsyncResult &aResult)
 
     if (aResult.available())
     {
-        RealtimeDatabaseResult &RTDB = aResult.to<RealtimeDatabaseResult>();
-        if (RTDB.isStream())
+        RealtimeDatabaseResult &stream = aResult.to<RealtimeDatabaseResult>();
+        if (stream.isStream())
         {
             Serial.println("----------------------------");
             Firebase.printf("task: %s\n", aResult.uid().c_str());
-            Firebase.printf("event: %s\n", RTDB.event().c_str());
-            Firebase.printf("path: %s\n", RTDB.dataPath().c_str());
-            Firebase.printf("data: %s\n", RTDB.to<const char *>());
-            Firebase.printf("type: %d\n", RTDB.type());
+            Firebase.printf("event: %s\n", stream.event().c_str());
+            Firebase.printf("path: %s\n", stream.dataPath().c_str());
+            Firebase.printf("data: %s\n", stream.to<const char *>());
+            Firebase.printf("type: %d\n", stream.type());
 
             // The stream event from RealtimeDatabaseResult can be converted to the values as following.
-            bool v1 = RTDB.to<bool>();
-            int v2 = RTDB.to<int>();
-            float v3 = RTDB.to<float>();
-            double v4 = RTDB.to<double>();
-            String v5 = RTDB.to<String>();
+            bool v1 = stream.to<bool>();
+            int v2 = stream.to<int>();
+            float v3 = stream.to<float>();
+            double v4 = stream.to<double>();
+            String v5 = stream.to<String>();
         }
         else
         {

examples/RealtimeDatabase/StreamEthernet/ESP32ETH/ESP32ETH.ino

@@ -285,22 +285,22 @@ void processData(AsyncResult &aResult)
 
     if (aResult.available())
     {
-        RealtimeDatabaseResult &RTDB = aResult.to<RealtimeDatabaseResult>();
-        if (RTDB.isStream())
+        RealtimeDatabaseResult &stream = aResult.to<RealtimeDatabaseResult>();
+        if (stream.isStream())
         {
             Serial.println("----------------------------");
             Firebase.printf("task: %s\n", aResult.uid().c_str());
-            Firebase.printf("event: %s\n", RTDB.event().c_str());
-            Firebase.printf("path: %s\n", RTDB.dataPath().c_str());
-            Firebase.printf("data: %s\n", RTDB.to<const char *>());
-            Firebase.printf("type: %d\n", RTDB.type());
+            Firebase.printf("event: %s\n", stream.event().c_str());
+            Firebase.printf("path: %s\n", stream.dataPath().c_str());
+            Firebase.printf("data: %s\n", stream.to<const char *>());
+            Firebase.printf("type: %d\n", stream.type());
 
             // The stream event from RealtimeDatabaseResult can be converted to the values as following.
-            bool v1 = RTDB.to<bool>();
-            int v2 = RTDB.to<int>();
-            float v3 = RTDB.to<float>();
-            double v4 = RTDB.to<double>();
-            String v5 = RTDB.to<String>();
+            bool v1 = stream.to<bool>();
+            int v2 = stream.to<int>();
+            float v3 = stream.to<float>();
+            double v4 = stream.to<double>();
+            String v5 = stream.to<String>();
         }
         else
         {

examples/RealtimeDatabase/StreamEthernet/ESP32Ethernet/ESP32Ethernet.ino

@@ -176,22 +176,22 @@ void processData(AsyncResult &aResult)
 
     if (aResult.available())
     {
-        RealtimeDatabaseResult &RTDB = aResult.to<RealtimeDatabaseResult>();
-        if (RTDB.isStream())
+        RealtimeDatabaseResult &stream = aResult.to<RealtimeDatabaseResult>();
+        if (stream.isStream())
         {
             Serial.println("----------------------------");
             Firebase.printf("task: %s\n", aResult.uid().c_str());
-            Firebase.printf("event: %s\n", RTDB.event().c_str());
-            Firebase.printf("path: %s\n", RTDB.dataPath().c_str());
-            Firebase.printf("data: %s\n", RTDB.to<const char *>());
-            Firebase.printf("type: %d\n", RTDB.type());
+            Firebase.printf("event: %s\n", stream.event().c_str());
+            Firebase.printf("path: %s\n", stream.dataPath().c_str());
+            Firebase.printf("data: %s\n", stream.to<const char *>());
+            Firebase.printf("type: %d\n", stream.type());
 
             // The stream event from RealtimeDatabaseResult can be converted to the values as following.
-            bool v1 = RTDB.to<bool>();
-            int v2 = RTDB.to<int>();
-            float v3 = RTDB.to<float>();
-            double v4 = RTDB.to<double>();
-            String v5 = RTDB.to<String>();
+            bool v1 = stream.to<bool>();
+            int v2 = stream.to<int>();
+            float v3 = stream.to<float>();
+            double v4 = stream.to<double>();
+            String v5 = stream.to<String>();
         }
         else
         {