Merge branch 'support/insights_cmd_resp' into 'master'

Enable Insights command response module See merge request app-frameworks/esp-rainmaker!447
espressif · Aug 22, 2024 · e62c52a · e62c52a
2 parents 082f5e3 + 3e375f4
commit e62c52a
Show file tree

Hide file tree

Showing 17 changed files with 68 additions and 6 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,13 @@
 # Changes
 
+## 7-Aug-2024: Enabled ESP-Insights command response feature
+ - With ESP-Insights updated to the newer component, the command response feature from rainmaker can be used.
+ - To use the same, in addition to enabling esp-insights, please set below option from menuconfig:
+ ```bash
+CONFIG_ESP_INSIGHTS_CMD_RESP_ENABLED=y
+ ```
+ - More info on this can be found [here](https://github.com/espressif/esp-insights/blob/main/FEATURES.md#command-response).
+
 ## 18-Jul-2024: Use network_provsioning for ESP-IDF v5.1 or later to support RainMaker over Thread
 - The network_provisioning component can be used for provisioning both Wi-Fi or Thread devices. It also stays backward capabitable with wifi_provisioning component.
 

diff --git a/cli b/cli
diff --git a/components/esp-insights b/components/esp-insights
diff --git a/examples/common/app_insights/app_insights.c b/examples/common/app_insights/app_insights.c
@@ -22,8 +22,6 @@
 #define APP_INSIGHTS_LOG_TYPE               ESP_DIAG_LOG_TYPE_ERROR
 #endif /* CONFIG_APP_INSIGHTS_ENABLE_LOG_TYPE_ALL */
 
-esp_err_t esp_insights_enable(esp_insights_config_t *config);
-
 #define INSIGHTS_TOPIC_SUFFIX       "diagnostics/from-node"
 #define INSIGHTS_TOPIC_RULE         "insights_message_delivery"
 
@@ -80,6 +78,9 @@ static void rmaker_common_event_handler(void* arg, esp_event_base_t event_base,
 esp_err_t app_insights_enable(void)
 {
 #ifdef CONFIG_ESP_INSIGHTS_ENABLED
+#ifndef CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT
+    ESP_LOGE(TAG, "Please select the CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT option from menuconfig");
+#endif
     /* Initialize the event loop, if not done already. */
     esp_err_t err = esp_event_loop_create_default();
     /* If the default event loop is already initialized, we get ESP_ERR_INVALID_STATE */
@@ -108,7 +109,12 @@ esp_err_t app_insights_enable(void)
         .node_id  = node_id,
         .alloc_ext_ram = true,
     };
+
     esp_insights_enable(&config);
+
+    if (esp_insights_cmd_resp_enable()!= ESP_OK) {
+        ESP_LOGE(TAG, "Failed to enabled insights command response");
+    }
 #else
     ESP_LOGI(TAG, "Enable CONFIG_ESP_INSIGHTS_ENABLED to get Insights.");
 #endif /* ! CONFIG_ESP_INSIGHTS_ENABLED */

diff --git a/examples/common/app_insights/idf_component.yml b/examples/common/app_insights/idf_component.yml
@@ -1,8 +1,8 @@
 ## IDF Component Manager Manifest File
 dependencies:
   espressif/esp_rainmaker:
-    version: "~=1.0"
+    version: ">=1.0"
     override_path: '../../../components/esp_rainmaker/'
   espressif/esp_insights:
-    version: "~1.0.1"
+    version: "~1.2.0"
     override_path: '../../../components/esp-insights/components/esp_insights/'
diff --git a/examples/fan/sdkconfig.defaults b/examples/fan/sdkconfig.defaults
@@ -31,3 +31,7 @@ CONFIG_ESP_RMAKER_LOCAL_CTRL_SECURITY_1=y
 
 # Application Rollback
 CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/gpio/sdkconfig.defaults b/examples/gpio/sdkconfig.defaults
@@ -31,3 +31,7 @@ CONFIG_ESP_RMAKER_LOCAL_CTRL_SECURITY_1=y
 
 # Application Rollback
 CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/homekit_switch/sdkconfig.defaults b/examples/homekit_switch/sdkconfig.defaults
@@ -39,3 +39,7 @@ CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
 
 # Change default log level to reduce binary size
 CONFIG_LOG_DEFAULT_LEVEL_WARN=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/led_light/sdkconfig.defaults b/examples/led_light/sdkconfig.defaults
@@ -31,3 +31,7 @@ CONFIG_ESP_RMAKER_LOCAL_CTRL_SECURITY_1=y
 
 # Application Rollback
 CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/matter/matter_controller/sdkconfig.defaults b/examples/matter/matter_controller/sdkconfig.defaults
@@ -79,3 +79,7 @@ CONFIG_LWIP_IPV6_NUM_ADDRESSES=6
 CONFIG_ESP_MATTER_ATTRIBUTE_BUFFER_LARGEST=2050
 
 CONFIG_ESP_MATTER_CONTROLLER_CUSTOM_CLUSTER_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/matter/matter_controller_with_touchscreen/sdkconfig.defaults b/examples/matter/matter_controller_with_touchscreen/sdkconfig.defaults
@@ -145,3 +145,7 @@ CONFIG_BSP_BOARD_ESP32_S3_BOX_3=y
 
 # Enable custom commission data to use dynamic qrcode
 CONFIG_CUSTOM_COMMISSIONABLE_DATA_PROVIDER=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/matter/matter_light/sdkconfig.defaults b/examples/matter/matter_light/sdkconfig.defaults
@@ -72,3 +72,7 @@ CONFIG_ESP_MATTER_NVS_USE_COMPACT_ATTR_STORAGE=y
 # Increase LwIP IPv6 address number to 6 (MAX_FABRIC + 1)
 # unique local addresses for fabrics(MAX_FABRIC), a link local address(1)
 CONFIG_LWIP_IPV6_NUM_ADDRESSES=6
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/matter/matter_switch/sdkconfig.defaults b/examples/matter/matter_switch/sdkconfig.defaults
@@ -72,3 +72,7 @@ CONFIG_ESP_MATTER_NVS_USE_COMPACT_ATTR_STORAGE=y
 # Increase LwIP IPv6 address number to 6 (MAX_FABRIC + 1)
 # unique local addresses for fabrics(MAX_FABRIC), a link local address(1)
 CONFIG_LWIP_IPV6_NUM_ADDRESSES=6
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/multi_device/sdkconfig.defaults b/examples/multi_device/sdkconfig.defaults
@@ -31,3 +31,7 @@ CONFIG_ESP_RMAKER_LOCAL_CTRL_SECURITY_1=y
 
 # Application Rollback
 CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/switch/sdkconfig.defaults b/examples/switch/sdkconfig.defaults
@@ -31,3 +31,7 @@ CONFIG_ESP_RMAKER_LOCAL_CTRL_SECURITY_1=y
 
 # Application Rollback
 CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/temperature_sensor/sdkconfig.defaults b/examples/temperature_sensor/sdkconfig.defaults
@@ -31,3 +31,7 @@ CONFIG_ESP_RMAKER_LOCAL_CTRL_SECURITY_1=y
 
 # Application Rollback
 CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE=y
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
diff --git a/examples/zigbee_gateway/sdkconfig.defaults b/examples/zigbee_gateway/sdkconfig.defaults
@@ -99,3 +99,7 @@ CONFIG_PIN_TO_RCP_RX=18
 #
 CONFIG_IEEE802154_RECEIVE_DONE_HANDLER=y
 # end of IEEE802154
+
+# If ESP-Insights is enabled, we need MQTT transport selected
+# Takes out manual efforts to enable this option
+CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y