Committing module OTAStorage_Nina which allows to store ota images on the storage space provided by the nina module

Author: aentinger

src/ArduinoIoTCloud_Config.h

@@ -26,6 +26,10 @@
   #define OTA_STORAGE_MKRMEM      (0)
 #endif
 
+#ifndef OTA_STORAGE_NINA
+  #define OTA_STORAGE_NINA        (0)
+#endif
+
 /******************************************************************************
  * AUTOMATIC CONFIGURED DEFINES
  ******************************************************************************/
@@ -34,7 +38,7 @@
   #define OTA_STORAGE_MKRMEM      (0)
 #endif
 
-#if OTA_STORAGE_MKRMEM
+#if OTA_STORAGE_MKRMEM || OTA_STORAGE_NINA
   #define OTA_ENABLED             (1)
 #else
   #define OTA_ENABLED             (0)

src/utility/ota/OTAStorage.h

@@ -40,7 +40,8 @@ class OTAStorage
   enum class Type : int
   {
     NotAvailable = -1,
-    MKRMEM       =  0
+    MKRMEM       =  0,
+    Nina         =  1,
   };
 
   virtual Type   type  () = 0;

src/utility/ota/OTAStorage_Nina.cpp

@@ -0,0 +1,89 @@
+/*
+   This file is part of ArduinoIoTCloud.
+
+   Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to [email protected].
+*/
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <ArduinoIoTCloud_Config.h>
+#if OTA_STORAGE_NINA
+
+#include "OTAStorage_Nina.h"
+
+/******************************************************************************
+ * CTOR/DTOR
+ ******************************************************************************/
+
+OTAStorage_Nina::OTAStorage_Nina()
+: _file{nullptr}
+{
+
+}
+
+/******************************************************************************
+ * PUBLIC MEMBER FUNCTIONS
+ ******************************************************************************/
+
+bool OTAStorage_Nina::init()
+{
+  /* Nothing to do */
+}
+
+bool OTAStorage_Nina::open(char const * file_name)
+{
+  /* It is necessary to prepend "/fs/" when opening a file on the nina
+   * for the rename operation "/fs/"" does not need to be prepended.
+   */
+  char nina_file_name[32] = {0};
+  strcpy(nina_file_name, "/fs/");
+  strcat(nina_file_name, file_name);
+  
+  WiFiStorageFile file = WiFiStorage.open(nina_file_name);
+  if(!file)
+    return false;
+  
+  _file = new WiFiStorageFile(file);
+  return true;
+}
+
+size_t OTAStorage_Nina::write(uint8_t const * const buf, size_t const num_bytes)
+{
+  return _file->write(buf, num_bytes);
+}
+
+void OTAStorage_Nina::close()
+{
+  /* There is no close API within WiFiNiNa */
+  delete _file;
+}
+
+void OTAStorage_Nina::remove(char const * file_name)
+{
+  WiFiStorage.remove(file_name);
+}
+
+bool OTAStorage_Nina::rename(char const * old_file_name, char const * new_file_name)
+{
+  return WiFiStorage.rename(old_file_name, new_file_name);
+}
+
+void OTAStorage_Nina::deinit()
+{
+  /* Nothing to do */
+}
+
+#endif /* OTA_STORAGE_NINA */

src/utility/ota/OTAStorage_Nina.h

@@ -0,0 +1,62 @@
+/*
+   This file is part of ArduinoIoTCloud.
+
+   Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to [email protected].
+*/
+
+#ifndef ARDUINO_OTA_STORAGE_NINA_H_
+#define ARDUINO_OTA_STORAGE_NINA_H_
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <ArduinoIoTCloud_Config.h>
+#if OTA_STORAGE_NINA
+
+#include "OTAStorage.h"
+
+#include <WiFiNINA.h>
+
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
+
+class OTAStorage_Nina : public OTAStorage
+{
+public:
+
+           OTAStorage_Nina();
+  virtual ~OTAStorage_Nina() { }
+
+
+  virtual Type   type  () override { return Type::Nina; }
+  virtual bool   init  () override;
+  virtual bool   open  (char const * file_name) override;
+  virtual size_t write (uint8_t const * const buf, size_t const num_bytes) override;
+  virtual void   close () override;
+  virtual void   remove(char const * file_name) override;
+  virtual bool   rename(char const * old_file_name, char const * new_file_name) override;
+  virtual void   deinit() override;
+
+
+private:
+
+  WiFiStorageFile * _file;
+
+};
+
+#endif /* OTA_STORAGE_NINA */
+
+#endif /* ARDUINO_OTA_STORAGE_NINA_H_ */