Merge branch 'feature/wifi_reset' into 'master'

examples: Separate wifi-reset and factory-reset

See merge request app-frameworks/esp-rainmaker!142

Author: shahpiyushv

components/button/button/include/iot_button.h

@@ -31,6 +31,7 @@ extern "C" {
 #endif
 
 #include <driver/gpio.h>
+#include <freertos/FreeRTOS.h>
 #include <freertos/portmacro.h>
 typedef void (* button_cb)(void*);
 typedef void* button_handle_t;

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);
 }

examples/common/app_reset/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "app_reset.c"
+                    INCLUDE_DIRS "."
+                    REQUIRES button esp_rainmaker)

examples/common/app_reset/app_reset.c

@@ -0,0 +1,65 @@
+/*
+   This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+   Unless required by applicable law or agreed to in writing, this
+   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+   CONDITIONS OF ANY KIND, either express or implied.
+*/
+
+/* It is recommended to copy this code in your example so that you can modify as
+ * per your application's needs, especially for the indicator calbacks,
+ * wifi_reset_indicate() and factory_reset_indicate().
+ */
+#include <esp_log.h>
+#include <esp_err.h>
+#include <iot_button.h>
+#include <esp_rmaker_utils.h>
+
+static const char *TAG = "app_reset";
+
+#define REBOOT_DELAY        2
+
+static void wifi_reset_trigger(void *arg)
+{
+    esp_rmaker_wifi_reset(REBOOT_DELAY);
+}
+
+static void wifi_reset_indicate(void *arg)
+{
+    ESP_LOGI(TAG, "Release button now for Wi-Fi reset. Keep pressed for factory reset.");
+}
+
+static void factory_reset_trigger(void *arg)
+{
+    esp_rmaker_factory_reset(REBOOT_DELAY);
+}
+
+static void factory_reset_indicate(void *arg)
+{
+    ESP_LOGI(TAG, "Release button to trigger factory reset.");
+}
+
+esp_err_t app_reset_button_register(button_handle_t btn_handle, uint8_t wifi_reset_timeout,
+        uint8_t factory_reset_timeout)
+{
+    if (!btn_handle) {
+        return ESP_ERR_INVALID_ARG;
+    }
+    if (wifi_reset_timeout) {
+        iot_button_add_on_release_cb(btn_handle, wifi_reset_timeout, wifi_reset_trigger, NULL);
+        iot_button_add_on_press_cb(btn_handle, wifi_reset_timeout, wifi_reset_indicate, NULL);
+    }
+    if (factory_reset_timeout) {
+        if (factory_reset_timeout <= wifi_reset_timeout) {
+            ESP_LOGW(TAG, "It is recommended to have factory_reset_timeout > wifi_reset_timeout");
+        }
+        iot_button_add_on_release_cb(btn_handle, factory_reset_timeout, factory_reset_trigger, NULL);
+        iot_button_add_on_press_cb(btn_handle, factory_reset_timeout, factory_reset_indicate, NULL);
+    }
+    return ESP_OK;
+}
+
+button_handle_t app_reset_button_create(gpio_num_t gpio_num, button_active_t active_level)
+{
+    return iot_button_create(gpio_num, active_level);
+}

examples/common/app_reset/app_reset.h

@@ -0,0 +1,42 @@
+/*
+   This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+   Unless required by applicable law or agreed to in writing, this
+   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+   CONDITIONS OF ANY KIND, either express or implied.
+*/
+#pragma once
+#include <stdint.h>
+#include <esp_err.h>
+#include <iot_button.h>
+
+/** Create a button handle
+ *
+ * This is just a wrapper over iot_button_create(). This can be used to register
+ * Wi-Fi/Factory reset functionality for a button.
+ *
+ * @param[in] gpio_num GPIO index of the pin that the button uses.
+ * @param[in] active_level button hardware active level.
+ *        "BUTTON_ACTIVE_LOW" means that when the button is pressed, the GPIO will read low level.
+ *        For "BUTTON_ACTIVE_HIGH", it will be reverse.
+ *
+ * @return A button_handle_t handle to the created button object, or NULL in case of error.
+ */
+button_handle_t app_reset_button_create(gpio_num_t gpio_num, button_active_t active_level);
+
+/** Register callbacks for Wi-Fi/Factory reset
+ *
+ * Register Wi-Fi reset or factory reset functionality on a button.
+ * If you want to use different buttons for these two, call this API twice, with appropriate
+ * button handles.
+ *
+ * @param[in] btn_handle Button handle returned by iot_button_create() or app_button_create()
+ * @param[in] wifi_reset_timeout Timeout after which the Wi-Fi reset should be triggered. Set to 0,
+ *              if you do not want Wi-Fi reset.
+ * @param[in] factory_reset_timeout Timeout after which the factory reset should be triggered. Set to 0,
+ *              if you do not want factory reset.
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t app_reset_button_register(button_handle_t btn_handle, uint8_t wifi_reset_timeout, uint8_t factory_reset_timeout);

examples/common/app_reset/component.mk

@@ -0,0 +1,2 @@
+COMPONENT_ADD_INCLUDEDIRS := .
+COMPONENT_SRCDIRS := .

examples/fan/main/app_driver.c

@@ -8,10 +8,7 @@
 */
 
 #include <sdkconfig.h>
-#include <freertos/FreeRTOS.h>
-#include <esp_system.h>
 #include <esp_log.h>
-#include <nvs_flash.h>
 #include <driver/rmt.h>
 
 #include <iot_button.h>
@@ -20,6 +17,7 @@
 #include <esp_rmaker_standard_types.h> 
 #include <esp_rmaker_standard_params.h> 
 
+#include <app_reset.h>
 #include "app_priv.h"
 
 #define RMT_TX_CHANNEL RMT_CHANNEL_0
@@ -33,6 +31,9 @@
 #define DEFAULT_SATURATION  100
 #define DEFAULT_BRIGHTNESS  ( 20 * DEFAULT_SPEED)
 
+#define WIFI_RESET_BUTTON_TIMEOUT       3
+#define FACTORY_RESET_BUTTON_TIMEOUT    10
+
 static uint8_t g_speed = DEFAULT_SPEED;
 static uint16_t g_hue = DEFAULT_HUE;
 static uint16_t g_saturation = DEFAULT_SATURATION;
@@ -173,19 +174,14 @@ static void push_btn_cb(void *arg)
     }
 }
 
-static void button_press_3sec_cb(void *arg)
-{
-    nvs_flash_deinit();
-    nvs_flash_erase();
-    esp_restart();
-}
-
 void app_driver_init()
 {
     app_fan_init();
     button_handle_t btn_handle = iot_button_create(BUTTON_GPIO, BUTTON_ACTIVE_LEVEL);
     if (btn_handle) {
-        iot_button_set_evt_cb(btn_handle, BUTTON_CB_RELEASE, push_btn_cb, "RELEASE");
-        iot_button_add_on_press_cb(btn_handle, 3, button_press_3sec_cb, NULL);
+        /* Register a callback for a button tap (short press) event */
+        iot_button_set_evt_cb(btn_handle, BUTTON_CB_TAP, push_btn_cb, NULL);
+        /* Register Wi-Fi reset and factory reset functionality on same button */
+        app_reset_button_register(btn_handle, WIFI_RESET_BUTTON_TIMEOUT, FACTORY_RESET_BUTTON_TIMEOUT);
     }
 }

examples/gpio/main/app_driver.c

@@ -9,13 +9,9 @@
 
 #include <sdkconfig.h>
 #include <string.h>
-#include <freertos/FreeRTOS.h>
-#include <esp_system.h>
-#include <nvs_flash.h>
 #include <esp_log.h>
 
-#include <iot_button.h>
-
+#include <app_reset.h>
 #include "app_priv.h"
 
 #define RMT_TX_CHANNEL RMT_CHANNEL_0
@@ -28,6 +24,9 @@
 #define OUTPUT_GPIO_GREEN 14ULL
 #define OUTPUT_GPIO_BLUE  15ULL
 
+#define WIFI_RESET_BUTTON_TIMEOUT       3
+#define FACTORY_RESET_BUTTON_TIMEOUT    10
+
 esp_err_t app_driver_set_gpio(const char *name, bool state)
 {
     if (strcmp(name, "Red") == 0) {
@@ -41,19 +40,11 @@ esp_err_t app_driver_set_gpio(const char *name, bool state)
     }
     return ESP_OK;
 }
-static void button_press_3sec_cb(void *arg)
-{
-    nvs_flash_deinit();
-    nvs_flash_erase();
-    esp_restart();
-}
 
 void app_driver_init()
 {
-    button_handle_t btn_handle = iot_button_create(BUTTON_GPIO, BUTTON_ACTIVE_LEVEL);
-    if (btn_handle) {
-        iot_button_add_on_press_cb(btn_handle, 3, button_press_3sec_cb, NULL);
-    }
+    app_reset_button_register(app_reset_button_create(BUTTON_GPIO, BUTTON_ACTIVE_LEVEL),
+                WIFI_RESET_BUTTON_TIMEOUT, FACTORY_RESET_BUTTON_TIMEOUT);
 
     /* Configure power */
     gpio_config_t io_conf = {

examples/led_light/main/app_driver.c

@@ -8,10 +8,8 @@
 */
 
 #include <sdkconfig.h>
-#include <freertos/FreeRTOS.h>
-#include <esp_system.h>
 #include <esp_log.h>
-#include <nvs_flash.h>
+#include <esp_wifi.h>
 #include <driver/rmt.h>
 
 #include <iot_button.h>
@@ -20,6 +18,7 @@
 #include <esp_rmaker_standard_types.h> 
 #include <esp_rmaker_standard_params.h> 
 
+#include <app_reset.h>
 #include "app_priv.h"
 
 #define RMT_TX_CHANNEL RMT_CHANNEL_0
@@ -29,6 +28,8 @@
 /* This is the GPIO on which the power will be set */
 #define OUTPUT_GPIO    19
 
+#define WIFI_RESET_BUTTON_TIMEOUT       3
+#define FACTORY_RESET_BUTTON_TIMEOUT    10
 
 static uint16_t g_hue = DEFAULT_HUE;
 static uint16_t g_saturation = DEFAULT_SATURATION;
@@ -173,19 +174,14 @@ static void push_btn_cb(void *arg)
             esp_rmaker_bool(g_power));
 }
 
-static void button_press_3sec_cb(void *arg)
-{
-    nvs_flash_deinit();
-    nvs_flash_erase();
-    esp_restart();
-}
-
 void app_driver_init()
 {
     app_light_init();
     button_handle_t btn_handle = iot_button_create(BUTTON_GPIO, BUTTON_ACTIVE_LEVEL);
     if (btn_handle) {
-        iot_button_set_evt_cb(btn_handle, BUTTON_CB_RELEASE, push_btn_cb, "RELEASE");
-        iot_button_add_on_press_cb(btn_handle, 3, button_press_3sec_cb, NULL);
+        /* Register a callback for a button tap (short press) event */
+        iot_button_set_evt_cb(btn_handle, BUTTON_CB_TAP, push_btn_cb, NULL);
+        /* Register Wi-Fi reset and factory reset functionality on same button */
+        app_reset_button_register(btn_handle, WIFI_RESET_BUTTON_TIMEOUT, FACTORY_RESET_BUTTON_TIMEOUT);
     }
 }