improve wording

Author: mhightower83

libraries/ArduinoOTA/ArduinoOTA.h

@@ -46,7 +46,8 @@ class ArduinoOTAClass
     void setPasswordHash(const char *password);
 
     //Sets if the device should be rebooted after successful update. Default true
-    //Sets eraseConfig conditional on RebootOnSuccess. Default false
+    //"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);
 
     //Sets flag to erase WiFi Settings at reboot/reset.
@@ -70,8 +71,8 @@ class ArduinoOTAClass
     //Ends the ArduinoOTA service
     void end();
 
-    //Has the effect of Arduino IDE Tools "Erase Flash" with "+ WiFi Settings"
-    //selection. Only returns on failure to erase flash.
+    //Has the effect of the "+ WiFi Settings" in the Arduino IDE Tools "Erase
+    //Flash" selection. Only returns on erase flash failure.
     void eraseConfigAndReset();
 
     //Call this in loop() to run the service. Also calls MDNS.update() when begin() or begin(true) is used.

libraries/ArduinoOTA/examples/BasicOTA/BasicOTA.ino

@@ -65,7 +65,7 @@ void setup() {
     } else if (error == OTA_END_ERROR) {
       Serial.println("End Failed");
     } else if (error == OTA_ERASE_SETTINGS_ERROR) {
-      Serial.println("Failed to erase WiFi Settings");
+      Serial.println("Erase WiFi Settings Failed");
     }
   });
   ArduinoOTA.begin();

libraries/ArduinoOTA/examples/OTAEraseConfig/OTAEraseConfig.ino

@@ -1,7 +1,8 @@
 /*
   This example is a variation on BasicOTA.
 
-  After a successful update if will always erase WiFi Settings and reset.
+  As is, this example will "always" erase WiFi Settings and reset after a
+  successful update. You can make this conditional.
 */
 #include <ESP8266WiFi.h>
 #include <ESP8266mDNS.h>
@@ -55,11 +56,13 @@ void setup() {
   ArduinoOTA.onEnd([]() {
     Serial.println("\nEnd");
     /*
-      By calling "ArduinoOTA.setRebootOnSuccess(true, true);", this example
-      will always erases the "WiFi Settings" as part of an OTA update.
+      By calling "ArduinoOTA.setRebootOnSuccess(true, true);", this example will
+      always erase the "WiFi Settings" as part of an OTA update.
 
-      Modify the calling of "ArduinoOTA.setRebootOnSuccess(true, true);"
-      to meet your requirements.
+      Without the call to "ArduinoOTA.setRebootOnSuccess," the system restarts
+      without touching the WiFi Settings legacy behavior.
+
+      Update the conditional below to meet your requirements.
     */
     if (true) {
       ArduinoOTA.setRebootOnSuccess(true, true);  // reboot = true, eraseConfig = true
@@ -81,7 +84,7 @@ void setup() {
     } else if (error == OTA_END_ERROR) {
       Serial.println("End Failed");
     } else if (error == OTA_ERASE_SETTINGS_ERROR) {
-      Serial.println("Failed to erase WiFi Settings");
+      Serial.println("Erase WiFi Settings Failed");
     }
   });
   ArduinoOTA.begin();

libraries/ArduinoOTA/examples/OTASdkCheck/OTASdkCheck.ino

@@ -1,11 +1,11 @@
 /*
   This example is a variation on BasicOTA.
 
-  Some logic has been added to check if the running SDK Version has changed.
-  If so, erase WiFi Settings and reset.
+  Logic added to look for a change in SDK Version. If so, erase the WiFi
+  Settings and Reset the system.
 
-  I have added a lot of debug printing because, with all reboots, it can get
-  confusing when verifying that it works.
+  Added extra debug printing to aid in cutting through the confusion of the
+  multiple reboots.
 */
 
 #include <ESP8266WiFi.h>
@@ -38,18 +38,19 @@ struct YourEEPROMData {
   // list of parameters you need to keep
   // ...
 
-  // To efficiently save and compare SDK version strings, we use their CRC32
-  // value. They always take up the same amount of space, making them easy to
-  // compare and store in EEPROM.
+  // To efficiently save and compare SDK version strings, we use their computed
+  // CRC32 value.
   uint32_t sdkCrc;
 };
 
 bool checkSdkCrc() {
   auto reason = ESP.getResetInfoPtr()->reason;
-  // Boot guard
-  // Only runs at reset to avoid a crash loop trying to erase flash.
-  // With the line below, an OTA update that does a software restart, no SDK
-  // check will occur until after a hard reset. Remove at your discretion.
+  // In this example, the OTA update does a software restart. As coded, SDK
+  // version checks are only performed after a hard reset. Change the lines
+  // below at your discretion.
+  //
+  // Boot loop guard
+  // Limit crash loops erasing flash. Only run at Power On or Hardware Reset.
   if (REASON_DEFAULT_RST != reason && REASON_EXT_SYS_RST != reason) {
     DEBUG_PRINTF("  Boot loop guard - SDK version not checked. To perform check, do a hardware reset.\r\n");
     return true;
@@ -149,7 +150,7 @@ void setup() {
     } else if (error == OTA_END_ERROR) {
       Serial.println("End Failed");
     } else if (error == OTA_ERASE_SETTINGS_ERROR) {
-      Serial.println("Failed to erase WiFi Settings");
+      Serial.println("Erase WiFi Settings Failed");
     }
   });
   ArduinoOTA.begin();