Requested changes.

Author: mhightower83

cores/esp8266/Esp.cpp

@@ -519,7 +519,7 @@ struct rst_info * EspClass::getResetInfoPtr(void) {
     return &resetInfo;
 }
 
-bool EspClass::eraseConfig(bool reset) {
+bool EspClass::eraseConfig(void) {
     const size_t cfgSize = 0x4000;  // Sectors: RF_CAL + SYSTEMPARAM[3]
     size_t cfgAddr = ESP.getFlashChipSize() - cfgSize;
 
@@ -529,12 +529,16 @@ bool EspClass::eraseConfig(bool reset) {
         }
     }
 
+    return true;
+}
+
+bool EspClass::eraseConfigAndReset(void) {
+    bool reset = eraseConfig();
     if (reset) {
         // Must be called in WiFi.mode(WIFI_OFF) state.
         hardware_reset();
     }
-
-    return true;
+    return reset;
 }
 
 uint8_t *EspClass::random(uint8_t *resultArray, const size_t outputSizeBytes)

cores/esp8266/Esp.h

@@ -210,20 +210,22 @@ class EspClass {
         static String getResetInfo();
         static struct rst_info * getResetInfoPtr();
 
+        static bool eraseConfig();
+
         /*
-          Erases 4 sectors at the end of flash, 1 - RF_CAL and 3 - SYSTEMPARM.
-          These are the same additional sectors that are erase when you select
-          Erase Flash: "Sketch + WiFi Settings" from the Arduino IDE Tools menu.
+        Erases 4 sectors at the end of flash, 1 - RF_CAL and 3 - SYSTEMPARM.
+        These are the same additional sectors that are erase when you select
+        Erase Flash: "Sketch + WiFi Settings" from the Arduino IDE Tools menu.
 
-          As a precaution, since this operation erases the running SDKs flash
-          configuration space, use reset flag "true" with eraseConfig. Also, for
-          additional protection, call "WiFi.mode(WIFI_OFF)" before calling.
+        As a precaution, since this operation erases the running SDKs flash
+        configuration space, use reset flag "true" with eraseConfig. Also, for
+        additional protection, call "WiFi.mode(WIFI_OFF)" before calling.
 
-          If you need to erase "WiFi Settings" and reboot consider using
-          "ArduinoOTA.eraseConfigAndReset()" it handles shutting down WiFi
-          before the erase.
+        If you need to erase "WiFi Settings" and reboot consider using
+        "ArduinoOTA.eraseConfigAndReset()" it handles shutting down WiFi
+        before the erase.
         */
-        static bool eraseConfig(bool reset = false);
+        static bool eraseConfigAndReset();
 
         static uint8_t *random(uint8_t *resultArray, const size_t outputSizeBytes);
         static uint32_t random();

libraries/ArduinoOTA/ArduinoOTA.cpp

@@ -91,8 +91,11 @@ void ArduinoOTAClass::setPasswordHash(const char * password) {
   }
 }
 
-void ArduinoOTAClass::setRebootOnSuccess(bool reboot, ota_erase_cfg_t eraseConfig){
+void ArduinoOTAClass::setRebootOnSuccess(bool reboot){
   _rebootOnSuccess = reboot;
+}
+
+void ArduinoOTAClass::setEraseConfig(ota_erase_cfg_t eraseConfig){
   _eraseConfig = eraseConfig;
 }
 
@@ -371,8 +374,8 @@ void ArduinoOTAClass::end() {
 void ArduinoOTAClass::eraseConfigAndReset() {
   OTA_DEBUG_PRINTF("Erase Config and Hard Reset ...\n");
   if (WiFi.mode(WIFI_OFF)) {
-    ESP.eraseConfig(true);    // No return testing - Only returns on failure
-    OTA_DEBUG_PRINTF("  ESP.eraseConfig(true) failed!\n");
+    ESP.eraseConfigAndReset();  // No return testing - Only returns on failure
+    OTA_DEBUG_PRINTF("  ESP.eraseConfigAndReset() failed!\n");
   } else {
     OTA_DEBUG_PRINTF("  WiFi.mode(WIFI_OFF) Timeout!\n");
   }

libraries/ArduinoOTA/ArduinoOTA.h

@@ -52,12 +52,11 @@ class ArduinoOTAClass
     void setPasswordHash(const char *password);
 
     //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 OTA_ERASE_CFG_NO - Legacy behavior
-    void setRebootOnSuccess(bool reboot, ota_erase_cfg_t eraseConfig = OTA_ERASE_CFG_NO);
+    void setRebootOnSuccess(bool reboot);
 
-    //Sets flag to erase WiFi Settings at reboot/reset.
-    void setEraseConfig(bool eraseConfig = true);
+    //Sets flag to erase WiFi Settings at reboot/reset. "eraseConfig" selects to
+    //abort erase on failure or ignore error and erase.
+    void setEraseConfig(ota_erase_cfg_t eraseConfig = OTA_ERASE_CFG_ABORT_ON_ERROR);
 
     //This callback will be called when OTA connection has begun
     void onStart(THandlerFunction fn);

libraries/ArduinoOTA/examples/OTAEraseConfig/OTAEraseConfig.ino

@@ -57,25 +57,24 @@ void setup() {
   ArduinoOTA.onEnd([]() {
     Serial.println("\nEnd");
     /*
-      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.
+      By calling "ArduinoOTA.setEraseConfig(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.
+      Without the call to "ArduinoOTA.setEraseConfig" legacy behavior, the
+      system restarts without touching the WiFi Settings.
 
-      Options for "eraseConfig" and how to handle failures:
+      Options for "setEraseConfig" to handle eraseConfig 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.
+      To meet unique requirements, you can make the call below conditional.
+      Also, this call could be enabled before ArduinoOTA.onEnd() and canceled
+      here with "ArduinoOTA.setEraseConfig(OTA_ERASE_CFG_NO)."
     */
-    if (true) {
-      ArduinoOTA.setRebootOnSuccess(true, OTA_ERASE_CFG_ABORT_ON_ERROR);
-    }
+    ArduinoOTA.setEraseConfig(OTA_ERASE_CFG_ABORT_ON_ERROR);
   });
   ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) {
     Serial.printf("Progress: %u%%\r", (progress / (total / 100)));