Removed unreachable error test from examples.

Removed continuous retry of "eraseConfig" and allow the script to
assign an error handling option for "eraseConfig" failure.

Update example to use error handling option.

Author: mhightower83

libraries/ArduinoOTA/ArduinoOTA.cpp

@@ -3,6 +3,7 @@
 #endif
 #include <functional>
 #include <WiFiUdp.h>
+#include <eboot_command.h>
 #include "ArduinoOTA.h"
 #include "MD5Builder.h"
 #include "StreamString.h"
@@ -90,7 +91,7 @@ void ArduinoOTAClass::setPasswordHash(const char * password) {
   }
 }
 
-void ArduinoOTAClass::setRebootOnSuccess(bool reboot, bool eraseConfig){
+void ArduinoOTAClass::setRebootOnSuccess(bool reboot, ota_erase_cfg_t eraseConfig){
   _rebootOnSuccess = reboot;
   _eraseConfig = eraseConfig;
 }
@@ -322,18 +323,22 @@ void ArduinoOTAClass::_runUpdate() {
       OTA_DEBUG_PRINTF("Rebooting...\n");
       //let serial/network finish tasks that might be given in _end_callback
       delay(100);
-      if (_eraseConfig) {
+      if (OTA_ERASE_CFG_NO != _eraseConfig) {
         eraseConfigAndReset();  // returns on failure
-        //C What is the best action to take on failure?
-        //C  1) On failure, we could invalidate eboot_command buffer -
-        //C     aborting the flash update.
-        //C  2) Just ignore it and restart.
-        //C  3) Retry forever
         if (_error_callback) {
           _error_callback(OTA_ERASE_SETTINGS_ERROR);
         }
-        _state = OTA_ERASEWIFI;
-        return;
+        if (OTA_ERASE_CFG_ABORT_ON_ERROR == _eraseConfig) {
+          eboot_command_clear();
+          return;
+        }
+#ifdef OTA_DEBUG
+        else if (OTA_ERASE_CFG_IGNORE_ERROR == _eraseConfig) {
+          // Fallthrough and restart
+        } else {
+          panic();
+        }
+#endif
       }
       ESP.restart();
     }
@@ -371,8 +376,6 @@ void ArduinoOTAClass::eraseConfigAndReset() {
   } else {
     OTA_DEBUG_PRINTF("  WiFi.mode(WIFI_OFF) Timeout!\n");
   }
-
-  delay(2000);  // force a gap between retries
 }
 
 //this needs to be called in the loop()
@@ -382,11 +385,6 @@ void ArduinoOTAClass::handle() {
     _state = OTA_IDLE;
   }
 
-  if (_state == OTA_ERASEWIFI) {
-    eraseConfigAndReset();
-    return;
-  }
-
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_MDNS)
   if(_useMDNS)
     MDNS.update(); //handle MDNS update as well, given that ArduinoOTA relies on it anyways

libraries/ArduinoOTA/ArduinoOTA.h

@@ -10,8 +10,7 @@ class UdpContext;
 typedef enum {
   OTA_IDLE,
   OTA_WAITAUTH,
-  OTA_RUNUPDATE,
-  OTA_ERASEWIFI
+  OTA_RUNUPDATE
 } ota_state_t;
 
 typedef enum {
@@ -23,6 +22,12 @@ typedef enum {
   OTA_ERASE_SETTINGS_ERROR
 } ota_error_t;
 
+typedef enum {
+  OTA_ERASE_CFG_NO = 0,
+  OTA_ERASE_CFG_IGNORE_ERROR,
+  OTA_ERASE_CFG_ABORT_ON_ERROR
+} ota_erase_cfg_t;
+
 class ArduinoOTAClass
 {
   public:
@@ -48,8 +53,8 @@ class ArduinoOTAClass
 
     //Sets if the device should be rebooted after successful update. Default true
     //"eraseConfig" selects to erase WiFi Settings in conjunction with a reboot
-    //after a successful update. Default false - Legacy behavior
-    void setRebootOnSuccess(bool reboot, bool eraseConfig = false);
+    //after a successful update. Default OTA_ERASE_CFG_NO - Legacy behavior
+    void setRebootOnSuccess(bool reboot, ota_erase_cfg_t eraseConfig = OTA_ERASE_CFG_NO);
 
     //Sets flag to erase WiFi Settings at reboot/reset.
     void setEraseConfig(bool eraseConfig = true);
@@ -96,7 +101,7 @@ class ArduinoOTAClass
     bool _initialized = false;
     bool _rebootOnSuccess = true;
     bool _useMDNS = true;
-    bool _eraseConfig = false;
+    ota_erase_cfg_t _eraseConfig = OTA_ERASE_CFG_NO;
     ota_state_t _state = OTA_IDLE;
     int _size = 0;
     int _cmd = 0;

libraries/ArduinoOTA/examples/BasicOTA/BasicOTA.ino

@@ -64,8 +64,6 @@ void setup() {
       Serial.println("Receive Failed");
     } else if (error == OTA_END_ERROR) {
       Serial.println("End Failed");
-    } else if (error == OTA_ERASE_SETTINGS_ERROR) {
-      Serial.println("Erase WiFi Settings Failed");
     }
   });
   ArduinoOTA.begin();

libraries/ArduinoOTA/examples/OTAEraseConfig/OTAEraseConfig.ino

@@ -56,16 +56,24 @@ void setup() {
   ArduinoOTA.onEnd([]() {
     Serial.println("\nEnd");
     /*
-      By calling "ArduinoOTA.setRebootOnSuccess(true, true);", this example will
-      always erase the "WiFi Settings" as part of an OTA update.
+      By calling "ArduinoOTA.setRebootOnSuccess(true,
+      ArduinoOTA::OTA_ERASE_CFG_ABORT_ON_ERROR)," this example will erase the
+      "WiFi Settings" as part of an OTA update. When erasing WiFi Settings
+      fails, the OTA Update aborts, and eboot will not copy the new ".bin" in
+      place.
 
       Without the call to "ArduinoOTA.setRebootOnSuccess," the system restarts
       without touching the WiFi Settings legacy behavior.
 
+      Options for "eraseConfig" and how to handle failures:
+        OTA_ERASE_CFG_NO              - Do not erase WiFi Settings
+        OTA_ERASE_CFG_IGNORE_ERROR    - Ignore the error and continue with update ".bin" copy
+        OTA_ERASE_CFG_ABORT_ON_ERROR  - Cancel flash update copy at reboot
+
       Update the conditional below to meet your requirements.
     */
     if (true) {
-      ArduinoOTA.setRebootOnSuccess(true, true);  // reboot = true, eraseConfig = true
+      ArduinoOTA.setRebootOnSuccess(true, OTA_ERASE_CFG_ABORT_ON_ERROR);
     }
   });
   ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) {

libraries/ArduinoOTA/examples/OTASdkCheck/OTASdkCheck.ino

@@ -149,8 +149,6 @@ void setup() {
       Serial.println("Receive Failed");
     } else if (error == OTA_END_ERROR) {
       Serial.println("End Failed");
-    } else if (error == OTA_ERASE_SETTINGS_ERROR) {
-      Serial.println("Erase WiFi Settings Failed");
     }
   });
   ArduinoOTA.begin();