esp_rmaker_utils: Add helper functions for Wi-Fi and factory reset

Also added events for these.

Author: shahpiyushv

components/esp_rainmaker/include/esp_rmaker_core.h

@@ -39,6 +39,14 @@ typedef enum {
     RMAKER_EVENT_CLAIM_SUCCESSFUL,
     /** Self Claiming Failed */
     RMAKER_EVENT_CLAIM_FAILED,
+    /** Node reboot has been triggered. The associated event data is the time in seconds
+     * (type: uint8_t) after which the node will reboot. Note that this time may not be
+     * accurate as the events are received asynchronously.*/
+    RMAKER_EVENT_REBOOT,
+    /** Wi-Fi credentials reset. Triggered after calling esp_rmaker_wifi_reset() */
+    RMAKER_EVENT_WIFI_RESET,
+    /** Node reset to factory defaults. Triggered after calling esp_rmaker_factory_reset() */
+    RMAKER_EVENT_FACTORY_RESET
 } esp_rmaker_event_t;
 
 /** ESP RainMaker Node information */

components/esp_rainmaker/include/esp_rmaker_utils.h

@@ -27,17 +27,51 @@ typedef struct esp_rmaker_time_config {
 
 /** Reboot the chip after a delay
  *
- * This API just starts an esp_timer and executes a reboot from that.
- * Useful if you want to reboot after a delay, to allow other tasks to finish
- * their operations (Eg. MQTT publish to indicate OTA success)
+ * This API just starts a reboot timer and returns immediately.
+ * The actual reboot is trigerred asynchronously in the timer callback.
+ * This is useful if you want to reboot after a delay, to allow other tasks to finish
+ * their operations (Eg. MQTT publish to indicate OTA success). The \ref RMAKER_EVENT_REBOOT
+ * event is triggered when the reboot timer is started.
  *
- * @param[in] seconds Time in seconds after which the chip should reboot
+ * @param[in] seconds Time in seconds after which the chip should reboot.
  *
- * @return ESP_OK on success
- * @return error on failure
+ * @return ESP_OK on success.
+ * @return error on failure.
  */
 esp_err_t esp_rmaker_reboot(uint8_t seconds);
 
+/** Reset Wi-Fi credentials and reboot
+ *
+ * This will reset just the Wi-Fi credentials and trigger a reboot.
+ * This is useful when you want to keep all the entries in NVS memory
+ * intact, but just change the Wi-Fi credentials. The \ref RMAKER_EVENT_WIFI_RESET
+ * event is triggered after the reset.
+ *
+ * @note This function internally calls esp_rmaker_reboot() and returns
+ * immediately. The reboot happens asynchronously.
+ *
+ * @param[in] seconds Time in seconds after which the chip should reboot.
+ *
+ * @return ESP_OK on success.
+ * @return error on failure.
+ */
+esp_err_t esp_rmaker_wifi_reset(uint8_t seconds);
+
+/** Reset to factory defaults and reboot
+ *
+ * This will clear entire NVS partition and trigger a reboot.
+ * The \ref RMAKER_EVENT_FACTORY_RESET event is triggered after the reset.
+ *
+ * @note This function internally calls esp_rmaker_reboot() and returns.
+ * The reboot happens asynchronously.
+ *
+ * @param[in] seconds Time in seconds after which the chip should reboot.
+ *
+ * @return ESP_OK on success.
+ * @return error on failure.
+ */
+esp_err_t esp_rmaker_factory_reset(uint8_t seconds);
+
 /** Initialize time synchronization
  *
  * This API initializes SNTP for time synchronization.

components/esp_rainmaker/src/core/esp_rmaker_utils.c

@@ -14,7 +14,11 @@
 #include <stdint.h>
 #include <esp_timer.h>
 #include <esp_system.h>
+#include <esp_wifi.h>
+#include <nvs_flash.h>
+#include <esp_rmaker_core.h>
 
+#include <esp_rmaker_internal.h>
 
 static esp_timer_handle_t reboot_timer;
 
@@ -33,8 +37,27 @@ esp_err_t esp_rmaker_reboot(uint8_t seconds)
         .dispatch_method = ESP_TIMER_TASK,
         .name = "rmaker_reboot_tm"
     };
+    esp_err_t err = ESP_FAIL;
     if (esp_timer_create(&reboot_timer_conf, &reboot_timer) == ESP_OK) {
-        return esp_timer_start_once(reboot_timer, seconds * 1000000U);
+        err = esp_timer_start_once(reboot_timer, seconds * 1000000U);
     }
-    return ESP_FAIL;
+    if (err == ESP_OK) {
+        esp_rmaker_post_event(RMAKER_EVENT_REBOOT, &seconds, sizeof(seconds));
+    }
+    return err;
+}
+
+esp_err_t esp_rmaker_wifi_reset(uint8_t seconds)
+{
+    esp_wifi_restore();
+    esp_rmaker_post_event(RMAKER_EVENT_WIFI_RESET, NULL, 0);
+    return esp_rmaker_reboot(seconds);
+}
+
+esp_err_t esp_rmaker_factory_reset(uint8_t seconds)
+{
+    nvs_flash_deinit();
+    nvs_flash_erase();
+    esp_rmaker_post_event(RMAKER_EVENT_FACTORY_RESET, NULL, 0);
+    return esp_rmaker_reboot(seconds);
 }