Handle a dedicated 'rename' step in which the file used for downloading (UPDATE.BIN.TMP) is renamed to the one expected by the SFU (UPDATE.BIN). This step is only performed when the complete file with valid checksum has been received

Author: aentinger

src/utility/ota/OTALogic.cpp

@@ -76,6 +76,7 @@ OTAError OTALogic::update()
     case OTAState::WaitForBinary:  _ota_state = handle_WaitForBinary (); break;
     case OTAState::BinaryReceived: _ota_state = handle_BinaryReceived(); break;
     case OTAState::Verify:         _ota_state = handle_Verify        (); break;
+    case OTAState::Rename:         _ota_state = handle_Rename        (); break;
     case OTAState::Reset:          _ota_state = handle_Reset         (); break;
     case OTAState::Error:                                                break;
     }
@@ -123,7 +124,7 @@ OTAState OTALogic::handle_Idle()
 
 OTAState OTALogic::handle_StartDownload()
 {
-  if(_ota_storage->open()) {
+  if(_ota_storage->open("UPDATE.BIN.TMP")) {
     return OTAState::WaitForHeader;
   } else {
     _ota_error = OTAError::StorageOpenFailed;
@@ -212,15 +213,26 @@ OTAState OTALogic::handle_BinaryReceived()
 OTAState OTALogic::handle_Verify()
 {
   if(_ota_bin_data.crc32 == _ota_bin_data.hdr_crc32) {
-    _ota_storage->deinit();
-    return OTAState::Reset;
+    return OTAState::Rename;
   } else {
-    _ota_storage->remove();
+    _ota_storage->remove("UPDATE.BIN.TMP");
     _ota_error = OTAError::ChecksumMismatch;
     return OTAState::Error;
   }
 }
 
+OTAState OTALogic::handle_Rename()
+{
+  if(_ota_storage->rename("UPDATE.BIN.TMP", "UPDATE.BIN")) {
+    _ota_storage->deinit();
+    return OTAState::Reset;
+  }
+  else {
+    _ota_error = OTAError::RenameOfTempFileFailed;
+    return OTAState::Error;
+  }
+}
+
 OTAState OTALogic::handle_Reset()
 {
 #if !defined(HOST) && !defined(ESP8266)

src/utility/ota/OTALogic.h

@@ -45,17 +45,18 @@ static size_t const MQTT_OTA_BUF_SIZE = 256;
 
 enum class OTAState
 {
-  Init, Idle, StartDownload, WaitForHeader, HeaderReceived, WaitForBinary, BinaryReceived, Verify, Reset, Error
+  Init, Idle, StartDownload, WaitForHeader, HeaderReceived, WaitForBinary, BinaryReceived, Verify, Rename, Reset, Error
 };
 
 enum class OTAError : int
 {
-  None                = 0,
-  StorageInitFailed   = 1,
-  StorageOpenFailed   = 2,
-  StorageWriteFailed  = 3,
-  ChecksumMismatch    = 4,
-  ReceivedDataOverrun = 5
+  None                   = 0,
+  StorageInitFailed      = 1,
+  StorageOpenFailed      = 2,
+  StorageWriteFailed     = 3,
+  ChecksumMismatch       = 4,
+  ReceivedDataOverrun    = 5,
+  RenameOfTempFileFailed = 6
 };
 
 /******************************************************************************
@@ -114,6 +115,7 @@ class OTALogic
   OTAState handle_WaitForBinary();
   OTAState handle_BinaryReceived();
   OTAState handle_Verify();
+  OTAState handle_Rename();
   OTAState handle_Reset();
 
   void init_mqtt_ota_buffer();