Merge branch 'defer_rmaker_start_mtr' into 'master'

examples/matter: defer rainmaker start until ble deinit

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

Author: dhrishi

examples/matter/matter_light/README.md

@@ -14,3 +14,12 @@
 > Please refer to the [README in the parent folder](../README.md) for instructions.
 
 > Please refer to the [THREAD_INSTRUCTIONS](./THREAD_INSTRUCTIONS.md) for instructions of Thread devices(ESP32-H2 or ESP32-C6).
+
+#### Optimization
+
+TO optimize the DRAM usage, this example uses the following optimizations:
+
+- Disables the chip shell, `CONFIG_ENABLE_CHIP_SHELL=n`, it adds approx 10KB or RAM.
+- As this example has two endpoints (Endpoint 0: Root endpoint, Endpoint 1: Extended Color Light), the default dynamic endpoint count is set to 2. This is done by setting `CONFIG_ESP_MATTER_MAX_ENDPOINT_COUNT=2` in the menuconfig.
+
+For more optimizations please refer [esp-matter’s RAM Flash optimization guide](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/optimizations.html)

examples/matter/matter_light/main/app_main.cpp

@@ -144,9 +144,11 @@ extern "C" void app_main()
 
     /* Pre start */
     ESP_ERROR_CHECK(app_matter_rmaker_start());
-    /* Start the ESP RainMaker Agent */
-    esp_rmaker_start();
+
     rmaker_init_done = true;
 
     app_matter_enable_matter_console();
+
+    // RainMaker start is deferred after Matter commissioning is complete
+    // and BLE memory is reclaimed, so that MQTT connect doesnt fail.
 }

examples/matter/matter_light/main/app_matter_light.cpp

@@ -212,6 +212,14 @@ void app_event_cb(const ChipDeviceEvent *event, intptr_t arg)
     case chip::DeviceLayer::DeviceEventType::kFabricCommitted:
         ESP_LOGI(TAG, "Fabric is committed");
         break;
+
+    case chip::DeviceLayer::DeviceEventType::kBLEDeinitialized:
+        ESP_LOGI(TAG, "BLE deinitialized and memory reclaimed");
+        // Starting RainMaker after Matter commissioning is complete
+        // and BLE memory is reclaimed, so that MQTT connect doesn't fail.
+        esp_rmaker_start();
+        break;
+
     default:
         break;
     }

examples/matter/matter_light/sdkconfig.defaults

@@ -81,3 +81,7 @@ CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
 CONFIG_COMPILER_OPTIMIZATION_SIZE=y
 CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y
 CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT=y
+
+# DRAM optimization
+CONFIG_ENABLE_CHIP_SHELL=n
+CONFIG_ESP_MATTER_MAX_DYNAMIC_ENDPOINT_COUNT=2

examples/matter/matter_switch/README.md

@@ -10,3 +10,12 @@
 - To test remote control, change the network connection of the mobile.
 
 > Please refer to the [README in the parent folder](../README.md) for instructions.
+
+#### Optimization
+
+TO optimize the DRAM usage, this example uses the following optimizations:
+
+- Disables the chip shell, `CONFIG_ENABLE_CHIP_SHELL=n`, it adds approx 10KB or RAM.
+- As this example has two endpoints (Endpoint 0: Root endpoint, Endpoint 1: Extended Color Light), the default dynamic endpoint count is set to 2. This is done by setting `CONFIG_ESP_MATTER_MAX_ENDPOINT_COUNT=2` in the menuconfig.
+
+For more optimizations please refer [esp-matter’s RAM Flash optimization guide](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/optimizations.html)

examples/matter/matter_switch/main/app_main.cpp

@@ -26,8 +26,6 @@ static const char *TAG = "app_main";
 
 static app_driver_handle_t switch_handle;
 
-bool rmaker_init_done = false; // used with extern in `app_matter.c`
-
 /* Callback to handle commands received from the RainMaker cloud */
 static esp_err_t write_cb(const esp_rmaker_device_t *device, const esp_rmaker_param_t *param,
                           const esp_rmaker_param_val_t val, void *priv_data, esp_rmaker_write_ctx_t *ctx)
@@ -86,7 +84,6 @@ extern "C" void app_main()
     esp_rmaker_device_t *switch_device = esp_rmaker_switch_device_create(SWITCH_DEVICE_NAME, NULL, DEFAULT_POWER);
     esp_rmaker_device_add_cb(switch_device, write_cb, NULL);
 
-
     esp_rmaker_node_add_device(node, switch_device);
 
     /* Enable OTA */
@@ -114,10 +111,9 @@ extern "C" void app_main()
     /* Pre start */
     ESP_ERROR_CHECK(app_matter_rmaker_start());
 
-    /* Start the ESP RainMaker Agent */
-    esp_rmaker_start();
-    rmaker_init_done = true;
-
     /* Enable Matter diagnostics console*/
     app_matter_enable_matter_console();
+
+    // RainMaker start is deferred after Matter commissioning is complete
+    // and BLE memory is reclaimed, so that MQTT connect doesnt fail.
 }

examples/matter/matter_switch/main/app_matter_switch.cpp

@@ -70,6 +70,13 @@ void app_event_cb(const ChipDeviceEvent *event, intptr_t arg)
         ESP_LOGI(TAG, "Commissioning complete");
         break;
 
+    case chip::DeviceLayer::DeviceEventType::PublicEventTypes::kBLEDeinitialized:
+        ESP_LOGI(TAG, "BLE deinitialized and memory reclaimed");
+        // Starting RainMaker after Matter commissioning is complete
+        // and BLE memory is reclaimed, so that MQTT connect doesn't fail.
+        esp_rmaker_start();
+        break;
+
     default:
         break;
     }

examples/matter/matter_switch/main/app_priv.h

@@ -54,4 +54,4 @@ esp_err_t app_attribute_update_cb(esp_matter::attribute::callback_type_t type, u
 esp_err_t app_identification_cb(esp_matter::identification::callback_type_t type, uint16_t endpoint_id, uint8_t effect_id,
                                        uint8_t effect_variant, void *priv_data);
 
-void app_event_cb(const ChipDeviceEvent *event, intptr_t arg);
+void app_event_cb(const ChipDeviceEvent *event, intptr_t arg);

examples/matter/matter_switch/sdkconfig.defaults

@@ -81,3 +81,7 @@ CONFIG_ESP_INSIGHTS_TRANSPORT_MQTT=y
 CONFIG_COMPILER_OPTIMIZATION_SIZE=y
 CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y
 CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT=y
+
+# DRAM optimization
+CONFIG_ENABLE_CHIP_SHELL=n
+CONFIG_ESP_MATTER_MAX_DYNAMIC_ENDPOINT_COUNT=2