Use Arduino OTAStorage to support other OTA Storage libraries

mobizt · Jul 2, 2024 · a42d570 · a42d570
1 parent 0cb852a
commit a42d570
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mobizt/FirebaseClient/.github%2Fworkflows%2Fcompile_library.yml?logo=github&label=compile) [![Github Stars](https://img.shields.io/github/stars/mobizt/FirebaseClient?logo=github)](https://github.com/mobizt/FirebaseClient/stargazers) ![Github Issues](https://img.shields.io/github/issues/mobizt/FirebaseClient?logo=github)
 
-![GitHub Release](https://img.shields.io/github/v/release/mobizt/FirebaseClient) ![Arduino](https://img.shields.io/badge/Arduino-v1.3.1-57C207?logo=arduino) ![PlatformIO](https://badges.registry.platformio.org/packages/mobizt/library/FirebaseClient.svg) ![GitHub Release Date](https://img.shields.io/github/release-date/mobizt/FirebaseClient)
+![GitHub Release](https://img.shields.io/github/v/release/mobizt/FirebaseClient) ![Arduino](https://img.shields.io/badge/Arduino-v1.3.2-57C207?logo=arduino) ![PlatformIO](https://badges.registry.platformio.org/packages/mobizt/library/FirebaseClient.svg) ![GitHub Release Date](https://img.shields.io/github/release-date/mobizt/FirebaseClient)
 
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/mobizt?logo=github)](https://github.com/sponsors/mobizt)
 
@@ -2498,17 +2498,17 @@ Since v1.3.1, the Arduino SAMD21 boards that use NINA firmware and WiFi101 firmw
 
 The [Internal_Storage_OTA](https://github.com/mobizt/Internal_Storage_OTA) is the modified version of [WiFi101OTA](http://www.arduino.cc/en/Reference/WiFi101OT) library which contains only foure files e.g. `Internal_Storage_OTA.h`, `InternalStorage.h`, `InternalStorage.cpp`and `OTAStorage.h`.
 
-The functions `OTAStorage::open` and `InternalStorageClass::open` are modified to accept an `int` parameter which will be compatible with other OTA libraries.
 
 To allow OTA update in SAMD21 Arduino boards, you have to include `Internal_Storage_OTA.h` in your sketch.
 
-Then assign the `InternalStorage` class object to be used for `Realtume Database` via `RealtumeDatabase::setOTAStorage(InternalStorage)`, for `Google Cloud Storage` via `CloudStorage::setOTAStorage(InternalStorage)` and for `Firebase Storage` via `Storage::setOTAStorage(InternalStorage)`
+Then assign the `InternalStorage` class object to be used for `Realtume Database` via `RealtumeDatabase::setOTAStorage`, for `Google Cloud Storage` via `CloudStorage::setOTAStorage` and for `Firebase Storage` via `Storage::setOTAStorage`
 
-If `InternalStorage` was not assigned before calling OTA function in case [Internal_Storage_OTA](https://github.com/mobizt/Internal_Storage_OTA), the error `OTA Storage was not set` will be occurred.
+
+In SAMD21 Arduino boards, if `OTA Storage` was not set before calling OTA function, the error `OTA Storage was not set` will be occurred.
 
 Finally, once the OTA update complete, in case [Internal_Storage_OTA](https://github.com/mobizt/Internal_Storage_OTA), you have to call `InternalStorage.apply()` to apply the update and then restart.
 
-Other OTA libraries that provide `InternalStorageClass` object (`InternalStorage`) that derived from the modified version of Arduino WiFi101OTA's `OTAStorage` class can also be used.
+Some OTA libraries that provide `Storage Class` object that derived from the modified version of Arduino WiFi101OTA's `OTAStorage` class can also be used.
 
 
 ## Project Preparation and Setup
@@ -3018,6 +3018,8 @@ You can assign the optional build options using one of the following methods.
 
 - By adding compiler build flags with `-D name`.
 
+- By defined the macros before including the library main header file `FirebaseClient.h`.
+
 In PlatformIO IDE, using `build_flags` in PlatformIO IDE's platformio.ini is more convenient 
 
 ```ini

diff --git a/examples/CloudStorage/Async/Callback/OTA/OTA.ino b/examples/CloudStorage/Async/Callback/OTA/OTA.ino
@@ -39,6 +39,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD) 
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -148,8 +149,8 @@ void loop()
 
  Serial.println("OTA update download...");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- cstorage.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ cstorage.setOTAStorage(OTA_STORAGE);
 #endif
 
  GoogleCloudStorage::GetOptions options;
@@ -228,9 +229,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/CloudStorage/Async/NoCallback/OTA/OTA.ino b/examples/CloudStorage/Async/NoCallback/OTA/OTA.ino
@@ -38,6 +38,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD) 
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -147,8 +148,8 @@ void loop()
 
  Serial.println("OTA update download...");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- cstorage.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ cstorage.setOTAStorage(OTA_STORAGE);
 #endif
 
  GoogleCloudStorage::GetOptions options;
@@ -221,9 +222,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/CloudStorage/Sync/OTA/OTA.ino b/examples/CloudStorage/Sync/OTA/OTA.ino
@@ -39,6 +39,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD) 
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -149,8 +150,8 @@ void loop()
 
  Serial.println("OTA update download...");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- cstorage.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ cstorage.setOTAStorage(OTA_STORAGE);
 #endif
 
  GoogleCloudStorage::GetOptions options;
@@ -227,9 +228,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/RealtimeDatabase/Async/Callback/OTA/OTA.ino b/examples/RealtimeDatabase/Async/Callback/OTA/OTA.ino
@@ -34,6 +34,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD) 
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -128,8 +129,8 @@ void loop()
 
  Serial.println("Asynchronous OTA update... ");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- Database.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ Database.setOTAStorage(OTA_STORAGE);
 #endif
 
  Database.ota(aClient, "/test/firmware/bin", asyncCB, "otaTask");
@@ -184,9 +185,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/RealtimeDatabase/Async/NoCallback/OTA/OTA.ino b/examples/RealtimeDatabase/Async/NoCallback/OTA/OTA.ino
@@ -33,6 +33,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD) 
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -127,8 +128,8 @@ void loop()
 
  Serial.println("Asynchronous OTA update... ");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- Database.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ Database.setOTAStorage(OTA_STORAGE);
 #endif
 
  Database.ota(aClient, "/test/firmware/bin", aResult_no_callback);
@@ -177,9 +178,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/Storage/Async/Callback/OTA/OTA.ino b/examples/Storage/Async/Callback/OTA/OTA.ino
@@ -36,6 +36,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD)
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -130,8 +131,8 @@ void loop()
 
  Serial.println("OTA update download...");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- storage.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ storage.setOTAStorage(OTA_STORAGE);
 #endif
 
  storage.ota(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "firmware.bin"), asyncCB, "otaTask");
@@ -190,9 +191,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/Storage/Async/NoCallback/OTA/OTA.ino b/examples/Storage/Async/NoCallback/OTA/OTA.ino
@@ -33,8 +33,9 @@
 
 // For Arduino SAMD21 OTA supports.
 // See https://github.com/mobizt/FirebaseClient#ota-update.
-#if defined(ARDUINO_ARCH_SAMD) 
+#if defined(ARDUINO_ARCH_SAMD)
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -129,8 +130,8 @@ void loop()
 
  Serial.println("OTA update download...");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- storage.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ storage.setOTAStorage(OTA_STORAGE);
 #endif
 
  storage.ota(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "firmware.bin"), aResult_no_callback);
@@ -183,9 +184,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/examples/Storage/Sync/OTA/OTA.ino b/examples/Storage/Sync/OTA/OTA.ino
@@ -36,6 +36,7 @@
 // See https://github.com/mobizt/FirebaseClient#ota-update.
 #if defined(ARDUINO_ARCH_SAMD) 
 #include <Internal_Storage_OTA.h>
+#define OTA_STORAGE InternalStorage
 #endif
 
 #define WIFI_SSID "WIFI_AP"
@@ -137,8 +138,8 @@ void loop()
 
  Serial.println("OTA update download...");
 
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
- storage.setOTAStorage(InternalStorage);
+#if defined(OTA_STORAGE)
+ storage.setOTAStorage(OTA_STORAGE);
 #endif
 
  // There is no OTA download progress available for sync OTA download.
@@ -195,9 +196,9 @@ void restart()
 {
  Serial.println("Update firmware completed.");
  Serial.println();
-#if defined(FIREBASE_OTA_UPDATER_STORAGE)
+#if defined(OTA_STORAGE)
  Serial.println("Applying update...");
- InternalStorage.apply();
+ OTA_STORAGE.apply();
 #elif defined(ESP32) || defined(ESP8266)
  Serial.println("Restarting...\n\n");
  ESP.restart();

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
  "name": "FirebaseClient",
- "version": "1.3.1",
+ "version": "1.3.2",
  "keywords": "communication, REST, esp32, esp8266, arduino",
  "description": "Async Firebase Client library for Arduino.",
  "repository": {

diff --git a/library.properties b/library.properties
@@ -1,6 +1,6 @@
 name=FirebaseClient
 
-version=1.3.1
+version=1.3.2
 
 author=Mobizt
 

diff --git a/resources/docs/cloud_storage.md b/resources/docs/cloud_storage.md
@@ -422,14 +422,14 @@ void deleteObject(AsyncClientClass &aClient, const GoogleCloudStorage::Parent &p
 - `uid` - The user specified UID of async result (optional).
 
 
-21. ## 🔹 void setOTAStorage(InternalStorageClass &storage)
+21. ## 🔹 void setOTAStorage(OTAStorage &storage)
 
 Set Arduino OTA Storage.
 
 ```cpp
-void setOTAStorage(InternalStorageClass &storage)
+void setOTAStorage(OTAStorage &storage)
 ```
 
 **Params:**
 
-- `storage` - The Arduino InternalStorageClass object.
+- `storage` - The Arduino `OTAStorage` class object.
diff --git a/resources/docs/realtime_database.md b/resources/docs/realtime_database.md
@@ -987,17 +987,17 @@ class RealtimeDatabase
  **Params:**
  - `filter` - The event keywords for filtering.
 
-31. ## 🔹 void setOTAStorage(InternalStorageClass &storage)
+31. ## 🔹 void setOTAStorage(OTAStorage &storage)
 
  Set Arduino OTA Storage.
 
  ```cpp
- void setOTAStorage(InternalStorageClass &storage)
+ void setOTAStorage(OTAStorage &storage)
  ```
 
  **Params:**
 
- - `storage` - The Arduino InternalStorageClass object.
+ - `storage` - The Arduino `OTAStorage` class object.
 
 32. ### 🔹 void loop()
 

diff --git a/resources/docs/storage.md b/resources/docs/storage.md
@@ -389,14 +389,14 @@ void deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &pare
 - `cb` - The async result callback (AsyncResultCallback).
 - `uid` - The user specified UID of async result (optional).
 
-21. ## 🔹 void setOTAStorage(InternalStorageClass &storage)
+21. ## 🔹 void setOTAStorage(OTAStorage &storage)
 
 Set Arduino OTA Storage.
 
 ```cpp
-void setOTAStorage(InternalStorageClass &storage)
+void setOTAStorage(OTAStorage &storage)
 ```
 
 **Params:**
 
-- `storage` - The Arduino InternalStorageClass object.
+- `storage` - The Arduino `OTAStorage` class object.