Restructuring NINA OTA storage code in order to be the most time-efficient

Author: aentinger

Diff for: src/utility/ota/OTAStorage_SNU.cpp

@@ -24,49 +24,43 @@
 
 #include "OTAStorage_SNU.h"
 
+#include <WiFiStorage.h>
+
 /******************************************************************************
- * CTOR/DTOR
+ * CONSTANTS
  ******************************************************************************/
 
-OTAStorage_SNU::OTAStorage_SNU()
-: _file{nullptr}
-{
-
-}
+static char const SNU_UPDATE_FILENAME[]      = "/fs/UPDATE.BIN";
+static char const SNU_TEMP_UPDATE_FILENAME[] = "/fs/UPDATE.BIN.TMP";
 
 /******************************************************************************
  * PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
 bool OTAStorage_SNU::init()
 {
-  /* Nothing to do */
+  /* Ensure that there are no remains of previous
+   * aborted downloads still existing in the memory
+   * of the nina module.
+   */
+  WiFiStorage.remove(SNU_TEMP_UPDATE_FILENAME);
   return true;
 }
 
-bool OTAStorage_SNU::open(char const * file_name)
+bool OTAStorage_SNU::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.
+  /* There's no need to explicitly open the file
+   * because when writing to it the file will always
+   * be opened with "ab+" mode and closed after each
+   * call to 'write'.
    */
-
-  char nina_file_name[32] = {0};
-  strcpy(nina_file_name, "/fs/");
-  strcat(nina_file_name, file_name);
-
-  WiFiStorage.remove(nina_file_name);
-  WiFiStorageFile f = WiFiStorage.open(nina_file_name);
-
-  if (!f)
-    return false;
-
-  _file = new WiFiStorageFile(f);
-
   return true;
 }
 
 size_t OTAStorage_SNU::write(uint8_t const * const buf, size_t const num_bytes)
 {
+  WiFiStorageFile file(SNU_TEMP_UPDATE_FILENAME);
+
   /* We have to write in chunks because otherwise we exceed the size of
    * the SPI buffer within the nina module.
    */
@@ -75,35 +69,28 @@ size_t OTAStorage_SNU::write(uint8_t const * const buf, size_t const num_bytes)
 
   for(; bytes_written < (num_bytes - WRITE_CHUNK_SIZE); bytes_written += WRITE_CHUNK_SIZE)
   {
-    if (_file->write(buf + bytes_written, WRITE_CHUNK_SIZE) != WRITE_CHUNK_SIZE)
+    if (file.write(buf + bytes_written, WRITE_CHUNK_SIZE) != WRITE_CHUNK_SIZE)
       return bytes_written;
   }
 
-  bytes_written += _file->write(buf + bytes_written, num_bytes - bytes_written);
+  bytes_written += file.write(buf + bytes_written, num_bytes - bytes_written);
 
   return bytes_written;
 }
 
 void OTAStorage_SNU::close()
 {
-  /* There is no close API within WiFiNiNa */
-  delete _file;
+  /* Files are closed after each file operation on the nina side. */
 }
 
-void OTAStorage_SNU::remove(char const * file_name)
+void OTAStorage_SNU::remove(char const * /* file_name */)
 {
-  /* Prepend "/fs/" */
-  char nina_file_name[32] = {0};
-  strcpy(nina_file_name, "/fs/");
-  strcat(nina_file_name, file_name);
-
-  /* Remove file */
-  WiFiStorage.remove(nina_file_name);
+  WiFiStorage.remove(SNU_TEMP_UPDATE_FILENAME);
 }
 
-bool OTAStorage_SNU::rename(char const * old_file_name, char const * new_file_name)
+bool OTAStorage_SNU::rename(char const * /* old_file_name */, char const * /* new_file_name */)
 {
-  return (WiFiStorage.rename(old_file_name, new_file_name) == 0);
+  return WiFiStorage.rename(SNU_TEMP_UPDATE_FILENAME, SNU_UPDATE_FILENAME);
 }
 
 void OTAStorage_SNU::deinit()

Diff for: src/utility/ota/OTAStorage_SNU.h

@@ -29,8 +29,6 @@
 
 #include "OTAStorage.h"
 
-#include <WiFiStorage.h>
-
 /******************************************************************************
  * CLASS DECLARATION
  ******************************************************************************/
@@ -39,7 +37,6 @@ class OTAStorage_SNU : public OTAStorage
 {
 public:
 
-           OTAStorage_SNU();
   virtual ~OTAStorage_SNU() { }
 
 
@@ -51,11 +48,6 @@ class OTAStorage_SNU : public OTAStorage
   virtual bool   rename(char const * old_file_name, char const * new_file_name) override;
   virtual void   deinit() override;
 
-
-private:
-
-  WiFiStorageFile * _file;
-
 };
 
 #endif /* OTA_STORAGE_SNU */