Merge branch 'feat/add-destroy-methods' into 'main'

Add Destroy API Support for Commands, Attributes, and Events

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

Author: chshu

components/esp_matter/data_model/esp_matter_data_model.cpp

@@ -555,7 +555,7 @@ attribute_t *create(cluster_t *cluster, uint32_t attribute_id, uint16_t flags, e
     return (attribute_t *)attribute;
 }
 
-static esp_err_t destroy(attribute_t *attribute)
+static esp_err_t free_attribute(attribute_t *attribute)
 {
     VerifyOrReturnError(attribute, ESP_ERR_INVALID_ARG, ESP_LOGE(TAG, "Attribute cannot be NULL"));
     _attribute_t *current_attribute = (_attribute_t *)attribute;
@@ -587,6 +587,22 @@ static esp_err_t destroy(attribute_t *attribute)
     return ESP_OK;
 }
 
+esp_err_t destroy(cluster_t *cluster, attribute_t *attribute)
+{
+    VerifyOrReturnError(cluster && attribute, ESP_ERR_INVALID_ARG, ESP_LOGE(TAG, "Cluster or attribute cannot be NULL"));
+    _cluster_t *current_cluster = (_cluster_t *)cluster;
+    _attribute_base_t *target_attribute = (_attribute_base_t *)attribute;
+
+    _attribute_base_t **current_attribute = &current_cluster->attribute_list;
+    while (*current_attribute && *current_attribute != target_attribute) {
+        current_attribute = &(*current_attribute)->next;
+    }
+
+    VerifyOrReturnError(*current_attribute, ESP_ERR_NOT_FOUND, ESP_LOGE(TAG, "Attribute not found in the cluster"));
+    *current_attribute = target_attribute->next;
+    return free_attribute(attribute);
+}
+
 attribute_t *get(cluster_t *cluster, uint32_t attribute_id)
 {
     VerifyOrReturnValue(cluster, NULL, ESP_LOGE(TAG, "Cluster cannot be NULL."));
@@ -1179,6 +1195,15 @@ command_t *create(cluster_t *cluster, uint32_t command_id, uint8_t flags, callba
     return (command_t *)command;
 }
 
+esp_err_t destroy(cluster_t *cluster, command_t *command)
+{
+    VerifyOrReturnError(cluster && command, ESP_ERR_INVALID_ARG, ESP_LOGE(TAG, "Cluster or command cannot be NULL"));
+    _cluster_t *current_cluster = (_cluster_t *)cluster;
+    _command_t *current_command = (_command_t *)command;
+    SinglyLinkedList<_command_t>::remove(&current_cluster->command_list, current_command);
+    return ESP_OK;
+}
+
 command_t *get(uint16_t endpoint_id, uint32_t cluster_id, uint32_t command_id)
 {
     _cluster_t *current_cluster = (_cluster_t *)cluster::get(endpoint_id, cluster_id);
@@ -1287,6 +1312,15 @@ event_t *create(cluster_t *cluster, uint32_t event_id)
     return (event_t *)event;
 }
 
+esp_err_t destroy(cluster_t *cluster, event_t *event)
+{
+    VerifyOrReturnError(cluster && event, ESP_ERR_INVALID_ARG, ESP_LOGE(TAG, "Cluster or event cannot be NULL"));
+    _cluster_t *current_cluster = (_cluster_t *)cluster;
+    _event_t *current_event = (_event_t *)event;
+    SinglyLinkedList<_event_t>::remove(&current_cluster->event_list, current_event);
+    return ESP_OK;
+}
+
 event_t *get(cluster_t *cluster, uint32_t event_id)
 {
     VerifyOrReturnValue(cluster, NULL, ESP_LOGE(TAG, "Cluster cannot be NULL."));
@@ -1377,7 +1411,7 @@ esp_err_t destroy(cluster_t *cluster)
     _attribute_base_t *attribute = current_cluster->attribute_list;
     while (attribute) {
         _attribute_base_t *next_attribute = attribute->next;
-        attribute::destroy((attribute_t *)attribute);
+        attribute::free_attribute((attribute_t *)attribute);
         attribute = next_attribute;
     }
 

components/esp_matter/data_model/esp_matter_feature.cpp

@@ -517,6 +517,15 @@ esp_err_t add(cluster_t *cluster)
     VerifyOrReturnError(cluster, ESP_ERR_INVALID_ARG, ESP_LOGE(TAG, "Cluster cannot be NULL"));
     update_feature_map(cluster, get_id());
 
+    command_t *on_command = esp_matter::command::get(cluster, OnOff::Commands::On::Id, COMMAND_FLAG_ACCEPTED);
+    if (on_command) {
+        esp_matter::command::destroy(cluster, on_command);
+    }
+    command_t *toggle_command = esp_matter::command::get(cluster, OnOff::Commands::Toggle::Id, COMMAND_FLAG_ACCEPTED);
+    if (toggle_command) {
+        esp_matter::command::destroy(cluster, toggle_command);
+    }
+
     return ESP_OK;
 }
 
@@ -4259,6 +4268,14 @@ esp_err_t add(cluster_t *cluster)
 {
     VerifyOrReturnError(cluster, ESP_ERR_INVALID_ARG, ESP_LOGE(TAG, "Cluster cannot be NULL"));
     update_feature_map(cluster, get_id());
+    command_t *stop_command = esp_matter::command::get(cluster, ClosureControl::Commands::Stop::Id, COMMAND_FLAG_ACCEPTED);
+    if (stop_command) {
+        esp_matter::command::destroy(cluster, stop_command);
+    }
+    event_t *movement_completed = esp_matter::event::get(cluster, ClosureControl::Events::MovementCompleted::Id);
+    if (movement_completed) {
+        esp_matter::event::destroy(cluster, movement_completed);
+    }
     return ESP_OK;
 }
 

components/esp_matter/data_model/private/esp_matter_data_model_priv.h

@@ -72,6 +72,54 @@ esp_err_t get_val_internal(attribute_t *attribute, esp_matter_attr_val_t *val);
  */
 esp_err_t set_val_internal(attribute_t *attribute, esp_matter_attr_val_t *val, bool call_callbacks = true);
 
+/** Destroy attribute
+ *
+ * This function destroys an attribute that was created and added to a cluster.
+ * It removes the attribute from the cluster's attribute list, frees any
+ * allocated memory for the attribute value (e.g., string, array), and deletes
+ * the attribute from NVS if it was stored there.
+ *
+ * @param[in] cluster Cluster handle.
+ * @param[in] attribute Attribute handle.
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t destroy(cluster_t *cluster, attribute_t *attribute);
+
 } // namespace attribute
 
+namespace command {
+
+    /** Destroy command
+ *
+ * This function destroys a command that was created and added to a cluster.
+ * It removes the command from the cluster's command list.
+ *
+ * @param[in] cluster Cluster handle.
+ * @param[in] command Command handle.
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t destroy(cluster_t *cluster, command_t *command);
+
+} // namespace command
+
+namespace event {
+
+    /** Destroy event
+ *
+ * This function destroys an event that was created and added to a cluster.
+ * It removes the event from the cluster's event list.
+ *
+ * @param[in] cluster Cluster handle.
+ * @param[in] event Event handle.
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t destroy(cluster_t *cluster, event_t *event);
+
+} // namespace event
 } // namespace esp_matter