Implemented Improv deinit when Ip is received. Fixed IP discovery for Improv (was returning 0.0.0.0 all the times)

Author: Andriy Malyshenko

components/improv_wifi/wifi_provisioning.c

@@ -4,20 +4,25 @@
  *  Created on: Apr 28, 2024
  *      Author: karl
  */
-
-#include "wifi_provisioning.h"
-
+#include <stdlib.h>
 #include <string.h>
 
+#include "driver/uart.h"
 #include "esp_err.h"
 #include "esp_log.h"
 #include "esp_wifi.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/event_groups.h"
+#include "freertos/projdefs.h"
 #include "freertos/task.h"
 #include "improv_wrapper.h"
+#include "network_interface.h"
 #include "wifi_interface.h"
 
+#include "wifi_provisioning.h"
+
+#define TAG "IMPROV"
+
 #ifdef CONFIG_ESP_CONSOLE_UART_DEFAULT
 #include "driver/uart.h"
 #endif
@@ -60,11 +65,8 @@ void uart_event_handler(void) {
       events than other types of events. If we take too much time on data event,
       the queue might be full. */
       case UART_DATA:
-        ESP_LOGD(TAG, "[UART DATA]: %d bytes", event.size);
-
+        //ESP_LOGD(TAG, "uart data: %d bytes", event.size);
         uart_read_bytes(uart_num, dtmp, event.size, portMAX_DELAY);
-        // ESP_LOGD(TAG, "[DATA EVT]:");
-
         improv_wifi_handle_serial(dtmp, event.size);
         break;
       // Event of HW FIFO overflow detected
@@ -87,6 +89,8 @@ void uart_event_handler(void) {
         uart_flush_input(uart_num);
         xQueueReset(uart_queue);
         break;
+      case UART_BREAK:
+        break;
       // Others
       default:
         ESP_LOGD(TAG, "uart event type: %d", event.type);
@@ -138,7 +142,7 @@ void improv_wifi_scan(unsigned char *scanResponse, int bufLen,
   wifi_ap_record_t ap_info[16];
 
   memset(ap_info, 0, sizeof(ap_info));
-
+  ESP_LOGD(TAG, "Starting WiFi scan for improv");
   if (esp_wifi_scan_start(NULL, true) == ESP_ERR_WIFI_STATE) {
     wifi_ap_record_t ap_info_tmp;
 
@@ -231,18 +235,31 @@ bool improv_wifi_is_connected(void) {
 void improv_wifi_get_local_ip(uint8_t *address) {
   esp_netif_ip_info_t ip_info;
 
-  // TODO: find a better way to do this
-  do {
-    esp_netif_get_ip_info(get_current_netif(), &ip_info);
-    vTaskDelay(pdMS_TO_TICKS(200));
-  } while (ip_info.ip.addr == 0);
+  /* Wait a short time for an IP to become available. Improv frequently asks
+     for the local IP during onboarding; when called too early we should
+     wait briefly rather than returning 0.0.0.0 immediately. */
+  const TickType_t timeout = pdMS_TO_TICKS(2000); /* 2s */
+  TickType_t start = xTaskGetTickCount();
+
+  while (network_if_get_ip(&ip_info) == false) {
+    if ((xTaskGetTickCount() - start) > timeout) {
+      ESP_LOGW(TAG, "%s: no valid IP available after timeout", __func__);
+      /* return all-zero address (caller should handle this) */
+      address[0] = 0;
+      address[1] = 0;
+      address[2] = 0;
+      address[3] = 0;
+      return;
+    }
+    vTaskDelay(pdMS_TO_TICKS(100));
+  }
 
-  address[0] = ip_info.ip.addr >> 0;
-  address[1] = ip_info.ip.addr >> 8;
-  address[2] = ip_info.ip.addr >> 16;
-  address[3] = ip_info.ip.addr >> 24;
+  address[0] = (uint8_t)(ip_info.ip.addr & 0xFF);
+  address[1] = (uint8_t)((ip_info.ip.addr >> 8) & 0xFF);
+  address[2] = (uint8_t)((ip_info.ip.addr >> 16) & 0xFF);
+  address[3] = (uint8_t)((ip_info.ip.addr >> 24) & 0xFF);
 
-  ESP_LOGD(TAG, "%d.%d.%d.%d", address[0], address[1], address[2], address[3]);
+  ESP_LOGI(TAG, "%d.%d.%d.%d", address[0], address[1], address[2], address[3]);
 }
 
 void improv_init(void) {
@@ -286,7 +303,7 @@ void improv_init(void) {
                                       uart_buffer_size, 10, &uart_queue, 0);
 
   if (ret != ESP_OK) {
-      ESP_LOGE(TAG, "Failed to install UART driver: %s", esp_err_to_name(ret));
+    ESP_LOGE(TAG, "Failed to install UART driver: %s", esp_err_to_name(ret));
   } else {
     BaseType_t task_ret = xTaskCreatePinnedToCore(&improv_uart_task, "improv_uart", 8 * 1024, NULL, 4,
                           &t_improv_uart_task, tskNO_AFFINITY);
@@ -306,7 +323,6 @@ void improv_init(void) {
   esp_err_t usb_ret = usb_serial_jtag_driver_install(&usb_serial_config);
   if (usb_ret == ESP_OK) {
     ESP_LOGD(TAG, "USB Serial JTAG driver installed successfully");
-    
     // Create USB Serial task
     BaseType_t usb_task_ret = xTaskCreatePinnedToCore(&usb_serial_improv_task, "usb_improv", 
                               8 * 1024, NULL, 4, &t_usb_serial_task, tskNO_AFFINITY);

components/network_interface/wifi_interface.c

@@ -22,6 +22,7 @@
 
 #if ENABLE_WIFI_PROVISIONING
 #include "wifi_provisioning.h"
+#include "freertos/task.h"
 #endif
 
 static const char *TAG = "WIFI_IF";
@@ -61,6 +62,20 @@ static void event_handler(void *arg, esp_event_base_t event_base, int event_id,
   }
 }
 
+#if ENABLE_WIFI_PROVISIONING
+/*
+ * Short-lived task to deinitialize Improv provisioning after a delay.
+ * Defined at file scope because C does not support nested functions.
+ */
+static void improv_deinit_task(void *pv) {
+  (void)pv;
+  vTaskDelay(pdMS_TO_TICKS(500));
+  ESP_LOGI(TAG, "Deinitiating improv provisioning");
+  improv_deinit();
+  vTaskDelete(NULL);
+}
+#endif
+
 /** Event handler for IP_EVENT_ETH_GOT_IP */
 static void got_ip_event_handler(void *arg, esp_event_base_t event_base,
                                  int32_t event_id, void *event_data) {
@@ -85,6 +100,14 @@ static void got_ip_event_handler(void *arg, esp_event_base_t event_base,
   ESP_LOGI(TAG, "~~~~~~~~~~~");
 
   s_retry_num = 0;
+
+#if ENABLE_WIFI_PROVISIONING
+  BaseType_t r = xTaskCreate(improv_deinit_task, "improv_deinit", 2048,
+                             NULL, tskIDLE_PRIORITY + 1, NULL);
+  if (r != pdPASS) {
+    ESP_LOGW(TAG, "failed to create improv_deinit task");
+  }
+#endif
 }
 
 static void lost_ip_event_handler(void *arg, esp_event_base_t event_base,