Merge branch 'controller_keep_suscription_flag' into 'main'

components/esp_matter_controller: support keep subscription flag

See merge request app-frameworks/esp-matter!1020

Author: chshu

components/esp_matter_controller/commands/esp_matter_controller_subscribe_command.cpp

@@ -42,8 +42,8 @@ void subscribe_command::on_device_connected_fcn(void *context, ExchangeManager &
     chip::OperationalDeviceProxy device_proxy(&exchangeMgr, sessionHandle);
     esp_err_t err = interaction::subscribe::send_request(
         &device_proxy, cmd->m_attr_paths.Get(), cmd->m_attr_paths.AllocatedSize(), cmd->m_event_paths.Get(),
-        cmd->m_event_paths.AllocatedSize(), cmd->m_min_interval, cmd->m_max_interval, true, cmd->m_auto_resubscribe,
-        cmd->m_buffered_read_cb);
+        cmd->m_event_paths.AllocatedSize(), cmd->m_min_interval, cmd->m_max_interval, cmd->m_keep_subscription,
+        cmd->m_auto_resubscribe, cmd->m_buffered_read_cb);
     if (err != ESP_OK) {
         chip::Platform::Delete(cmd);
     }
@@ -184,7 +184,7 @@ void subscribe_command::OnDone(ReadClient *apReadClient)
 esp_err_t send_subscribe_attr_command(uint64_t node_id, ScopedMemoryBufferWithSize<uint16_t> &endpoint_ids,
                                       ScopedMemoryBufferWithSize<uint32_t> &cluster_ids,
                                       ScopedMemoryBufferWithSize<uint32_t> &attribute_ids, uint16_t min_interval,
-                                      uint16_t max_interval, bool auto_resubscribe)
+                                      uint16_t max_interval, bool auto_resubscribe, bool keep_subscription)
 {
     if (endpoint_ids.AllocatedSize() != cluster_ids.AllocatedSize() ||
         endpoint_ids.AllocatedSize() != attribute_ids.AllocatedSize()) {
@@ -205,7 +205,8 @@ esp_err_t send_subscribe_attr_command(uint64_t node_id, ScopedMemoryBufferWithSi
     }
 
     subscribe_command *cmd = chip::Platform::New<subscribe_command>(
-        node_id, std::move(attr_paths), std::move(event_paths), min_interval, max_interval, auto_resubscribe);
+        node_id, std::move(attr_paths), std::move(event_paths), min_interval, max_interval, auto_resubscribe, nullptr,
+        nullptr, nullptr, nullptr, keep_subscription);
     if (!cmd) {
         ESP_LOGE(TAG, "Failed to alloc memory for subscribe_command");
         return ESP_ERR_NO_MEM;
@@ -216,7 +217,7 @@ esp_err_t send_subscribe_attr_command(uint64_t node_id, ScopedMemoryBufferWithSi
 esp_err_t send_subscribe_event_command(uint64_t node_id, ScopedMemoryBufferWithSize<uint16_t> &endpoint_ids,
                                        ScopedMemoryBufferWithSize<uint32_t> &cluster_ids,
                                        ScopedMemoryBufferWithSize<uint32_t> &event_ids, uint16_t min_interval,
-                                       uint16_t max_interval, bool auto_resubscribe)
+                                       uint16_t max_interval, bool auto_resubscribe, bool keep_subscription)
 {
     if (endpoint_ids.AllocatedSize() != cluster_ids.AllocatedSize() ||
         endpoint_ids.AllocatedSize() != event_ids.AllocatedSize()) {
@@ -237,7 +238,8 @@ esp_err_t send_subscribe_event_command(uint64_t node_id, ScopedMemoryBufferWithS
     }
 
     subscribe_command *cmd = chip::Platform::New<subscribe_command>(
-        node_id, std::move(attr_paths), std::move(event_paths), min_interval, max_interval, auto_resubscribe);
+        node_id, std::move(attr_paths), std::move(event_paths), min_interval, max_interval, auto_resubscribe, nullptr,
+        nullptr, nullptr, nullptr, keep_subscription);
     if (!cmd) {
         ESP_LOGE(TAG, "Failed to alloc memory for subscribe_command");
         return ESP_ERR_NO_MEM;
@@ -247,7 +249,7 @@ esp_err_t send_subscribe_event_command(uint64_t node_id, ScopedMemoryBufferWithS
 
 esp_err_t send_subscribe_attr_command(uint64_t node_id, uint16_t endpoint_id, uint32_t cluster_id,
                                       uint32_t attribute_id, uint16_t min_interval, uint16_t max_interval,
-                                      bool auto_resubscribe)
+                                      bool auto_resubscribe, bool keep_subscription)
 {
     ScopedMemoryBufferWithSize<uint16_t> endpoint_ids;
     ScopedMemoryBufferWithSize<uint32_t> cluster_ids;
@@ -259,11 +261,12 @@ esp_err_t send_subscribe_attr_command(uint64_t node_id, uint16_t endpoint_id, ui
         return ESP_ERR_NO_MEM;
     }
     return send_subscribe_attr_command(node_id, endpoint_ids, cluster_ids, attribute_ids, min_interval, max_interval,
-                                       auto_resubscribe);
+                                       auto_resubscribe, keep_subscription);
 }
 
 esp_err_t send_subscribe_event_command(uint64_t node_id, uint16_t endpoint_id, uint32_t cluster_id, uint32_t event_id,
-                                       uint16_t min_interval, uint16_t max_interval, bool auto_resubscribe)
+                                       uint16_t min_interval, uint16_t max_interval, bool auto_resubscribe,
+                                       bool keep_subscription)
 {
     ScopedMemoryBufferWithSize<uint16_t> endpoint_ids;
     ScopedMemoryBufferWithSize<uint32_t> cluster_ids;
@@ -275,7 +278,7 @@ esp_err_t send_subscribe_event_command(uint64_t node_id, uint16_t endpoint_id, u
         return ESP_ERR_NO_MEM;
     }
     return send_subscribe_event_command(node_id, endpoint_ids, cluster_ids, event_ids, min_interval, max_interval,
-                                        auto_resubscribe);
+                                        auto_resubscribe, keep_subscription);
 }
 
 esp_err_t send_shutdown_subscription(uint64_t node_id, uint32_t subscription_id)

components/esp_matter_controller/commands/esp_matter_controller_subscribe_command.h

@@ -46,11 +46,12 @@ class subscribe_command : public ReadClient::Callback {
                       ScopedMemoryBufferWithSize<EventPathParams> &&event_paths, uint16_t min_interval,
                       uint16_t max_interval, bool auto_resubscribe = true, attribute_report_cb_t attribute_cb = nullptr,
                       event_report_cb_t event_cb = nullptr, subscribe_done_cb_t done_cb = nullptr,
-                      subscribe_failure_cb_t connect_failure_cb = nullptr)
+                      subscribe_failure_cb_t connect_failure_cb = nullptr, bool keep_subscription = true)
         : m_node_id(node_id)
         , m_min_interval(min_interval)
         , m_max_interval(max_interval)
         , m_auto_resubscribe(auto_resubscribe)
+        , m_keep_subscription(keep_subscription)
         , m_buffered_read_cb(*this)
         , m_attr_paths(std::move(attr_paths))
         , m_event_paths(std::move(event_paths))
@@ -71,11 +72,12 @@ class subscribe_command : public ReadClient::Callback {
                       subscribe_command_type_t command_type, uint16_t min_interval, uint16_t max_interval,
                       bool auto_resubscribe = true, attribute_report_cb_t attribute_cb = nullptr,
                       event_report_cb_t event_cb = nullptr, subscribe_done_cb_t done_cb = nullptr,
-                      subscribe_failure_cb_t connect_failure_cb = nullptr)
+                      subscribe_failure_cb_t connect_failure_cb = nullptr, bool keep_subscription = true)
         : m_node_id(node_id)
         , m_min_interval(min_interval)
         , m_max_interval(max_interval)
         , m_auto_resubscribe(auto_resubscribe)
+        , m_keep_subscription(keep_subscription)
         , m_buffered_read_cb(*this)
         , on_device_connected_cb(on_device_connected_fcn, this)
         , on_device_connection_failure_cb(on_device_connection_failure_fcn, this)
@@ -125,6 +127,7 @@ class subscribe_command : public ReadClient::Callback {
     uint16_t m_min_interval;
     uint16_t m_max_interval;
     bool m_auto_resubscribe;
+    bool m_keep_subscription;
     BufferedReadCallback m_buffered_read_cb;
     uint32_t m_subscription_id = 0;
     uint8_t m_resubscribe_retries = 0;
@@ -155,14 +158,16 @@ class subscribe_command : public ReadClient::Callback {
  * @param[in] min_interval Minimum interval of the subscription
  * @param[in] max_interval Maximum interval of the subscription
  * @param[in] auto_resubscribe Auto re-subscribe flag
+ * @param[in] keep_subscription Keep subscription flag, terminate existing subscriptions if false
  *
  * @return ESP_OK on success.
  * @return error in case of failure.
  */
 esp_err_t send_subscribe_attr_command(uint64_t node_id, ScopedMemoryBufferWithSize<uint16_t> &endpoint_ids,
                                       ScopedMemoryBufferWithSize<uint32_t> &cluster_ids,
                                       ScopedMemoryBufferWithSize<uint32_t> &attribute_ids, uint16_t min_interval,
-                                      uint16_t max_interval, bool auto_resubscribe = true);
+                                      uint16_t max_interval, bool auto_resubscribe = true,
+                                      bool keep_subscription = true);
 
 /** Send subscribe command with multiple event paths
  *
@@ -176,14 +181,16 @@ esp_err_t send_subscribe_attr_command(uint64_t node_id, ScopedMemoryBufferWithSi
  * @param[in] min_interval Minimum interval of the subscription
  * @param[in] max_interval Maximum interval of the subscription
  * @param[in] auto_resubscribe Auto re-subscribe flag
+ * @param[in] keep_subscription Keep subscription flag, terminate existing subscriptions if false
  *
  * @return ESP_OK on success.
  * @return error in case of failure.
  */
 esp_err_t send_subscribe_event_command(uint64_t node_id, ScopedMemoryBufferWithSize<uint16_t> &endpoint_ids,
                                        ScopedMemoryBufferWithSize<uint32_t> &cluster_ids,
                                        ScopedMemoryBufferWithSize<uint32_t> &event_ids, uint16_t min_interval,
-                                       uint16_t max_interval, bool auto_resubscribe = true);
+                                       uint16_t max_interval, bool auto_resubscribe = true,
+                                       bool keep_subscription = true);
 
 /** Send subscribe command with single attribute path
  *
@@ -197,13 +204,14 @@ esp_err_t send_subscribe_event_command(uint64_t node_id, ScopedMemoryBufferWithS
  * @param[in] min_interval Minimum interval of the subscription
  * @param[in] max_interval Maximum interval of the subscription
  * @param[in] auto_resubscribe Auto re-subscribe flag
+ * @param[in] keep_subscription Keep subscription flag, terminate existing subscriptions if false
  *
  * @return ESP_OK on success.
  * @return error in case of failure.
  */
 esp_err_t send_subscribe_attr_command(uint64_t node_id, uint16_t endpoint_id, uint32_t cluster_id,
                                       uint32_t attribute_id, uint16_t min_interval, uint16_t max_interval,
-                                      bool auto_resubscribe = true);
+                                      bool auto_resubscribe = true, bool keep_subscription = true);
 
 /** Send subscribe command with single event path
  *
@@ -217,12 +225,14 @@ esp_err_t send_subscribe_attr_command(uint64_t node_id, uint16_t endpoint_id, ui
  * @param[in] min_interval Minimum interval of the subscription
  * @param[in] max_interval Maximum interval of the subscription
  * @param[in] auto_resubscribe Auto re-subscribe flag
+ * @param[in] keep_subscription Keep subscription flag, terminate existing subscriptions if false
  *
  * @return ESP_OK on success.
  * @return error in case of failure.
  */
 esp_err_t send_subscribe_event_command(uint64_t node_id, uint16_t endpoint_id, uint32_t cluster_id, uint32_t event_id,
-                                       uint16_t min_interval, uint16_t max_interval, bool auto_resubscribe = true);
+                                       uint16_t min_interval, uint16_t max_interval, bool auto_resubscribe = true,
+                                       bool keep_subscription = true);
 
 /** Shut down a subscription for given node id and subscription id
  *

components/esp_matter_controller/core/esp_matter_controller_console.cpp

@@ -503,7 +503,7 @@ static esp_err_t controller_read_event_handler(int argc, char **argv)
 
 static esp_err_t controller_subscribe_attr_handler(int argc, char **argv)
 {
-    if (argc != 6) {
+    if (argc < 6) {
         return ESP_ERR_INVALID_ARG;
     }
 
@@ -517,13 +517,23 @@ static esp_err_t controller_subscribe_attr_handler(int argc, char **argv)
     uint16_t min_interval = string_to_uint16(argv[4]);
     uint16_t max_interval = string_to_uint16(argv[5]);
 
+    bool keep_subscription = true;
+    if (argc >= 7) {
+        keep_subscription = string_to_bool(argv[6]);
+    }
+
+    bool auto_resubscribe = true;
+    if (argc >= 8) {
+        auto_resubscribe = string_to_bool(argv[7]);
+    }
+
     return controller::send_subscribe_attr_command(node_id, endpoint_ids, cluster_ids, attribute_ids, min_interval,
-                                                   max_interval);
+                                                   max_interval, keep_subscription, auto_resubscribe);
 }
 
 static esp_err_t controller_subscribe_event_handler(int argc, char **argv)
 {
-    if (argc != 6) {
+    if (argc < 6) {
         return ESP_ERR_INVALID_ARG;
     }
 
@@ -536,8 +546,18 @@ static esp_err_t controller_subscribe_event_handler(int argc, char **argv)
     ESP_RETURN_ON_ERROR(string_to_uint32_array(argv[3], event_ids), TAG, "Failed to parse event IDs");
     uint16_t min_interval = string_to_uint16(argv[4]);
     uint16_t max_interval = string_to_uint16(argv[5]);
+
+    bool keep_subscription = true;
+    if (argc >= 7) {
+        keep_subscription = string_to_bool(argv[6]);
+    }
+
+    bool auto_resubscribe = true;
+    if (argc >= 8) {
+        auto_resubscribe = string_to_bool(argv[7]);
+    }
     return controller::send_subscribe_event_command(node_id, endpoint_ids, cluster_ids, event_ids, min_interval,
-                                                    max_interval);
+                                                    max_interval, keep_subscription, auto_resubscribe);
 }
 
 static esp_err_t controller_shutdown_subscription_handler(int argc, char **argv)
@@ -674,14 +694,17 @@ esp_err_t controller_register_commands()
             .name = "subs-attr",
             .description = "Subscribe attributes of the nodes.\n"
                            "\tUsage: controller subs-attr <node-id> <endpoint-ids> <cluster-ids> <attr-ids> "
-                           "<min-interval> <max-interval>",
+                           "<min-interval> <max-interval> [keep-subscription] [auto-resubscribe]\n"
+                           "\tNotes: If 'keep-subscription' is 'false', existing subscriptions will be terminated for the node. "
+                           "If 'auto-resubscribe' is 'true', controller will auto resubscribe if subscriptions timeout",
             .handler = controller_subscribe_attr_handler,
         },
         {
             .name = "subs-event",
             .description = "Subscribe events of the nodes.\n"
                            "\tUsage: controller subs-event <node-id> <endpoint-ids> <cluster-ids> <event-ids> "
-                           "<min-interval> <max-interval>",
+                           "<min-interval> <max-interval> [keep-subscription] [auto-resubscribe]\n"
+                           "\tNotes: 'keep-subscription' and 'auto-resubscribe' are the same as 'subs-attr' command",
             .handler = controller_subscribe_event_handler,
         },
         {