Merge branch 'cluster/whtr_mode' into 'main'

components/esp-matter: Add Water Heater Mode cluster

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

Author: dhrishi

components/esp_matter/esp_matter_cluster.cpp

@@ -3612,6 +3612,45 @@ cluster_t *create(endpoint_t *endpoint, config_t *config, uint8_t flags, uint32_
 
 } /* water_heater_management */
 
+namespace water_heater_mode {
+const function_generic_t *function_list = NULL;
+const int function_flags = CLUSTER_FLAG_NONE;
+
+cluster_t *create(endpoint_t *endpoint, config_t *config, uint8_t flags)
+{
+    cluster_t *cluster = cluster::create(endpoint, WaterHeaterMode::Id, flags);
+    if (!cluster) {
+        ESP_LOGE(TAG, "Could not create cluster");
+        return NULL;
+    }
+
+    if (flags & CLUSTER_FLAG_SERVER) {
+        if (config && config -> delegate != nullptr) {
+            static const auto delegate_init_cb = WaterHeaterModeDelegateInitCB;
+            set_delegate_and_init_callback(cluster, delegate_init_cb, config->delegate);
+        }
+        add_function_list(cluster, function_list, function_flags);
+
+        /* Attributes managed internally */
+        global::attribute::create_feature_map(cluster, 0);
+        mode_base::attribute::create_supported_modes(cluster, NULL, 0, 0);
+
+        /* Attributes not managed internally */
+        global::attribute::create_cluster_revision(cluster, cluster_revision);
+        if (config) {
+            mode_base::attribute::create_current_mode(cluster, config->current_mode);
+        } else {
+            ESP_LOGE(TAG, "Config is NULL. Cannot add some attributes.");
+        }
+    }
+
+    /* Commands */
+    mode_base::command::create_change_to_mode(cluster);
+
+    return cluster;
+}
+} /* water_heater_mode */
+
 // namespace binary_input_basic {
 //     // ToDo
 // } /* binary_input_basic */

components/esp_matter/esp_matter_cluster.h

@@ -920,5 +920,15 @@ typedef struct config {
 cluster_t *create(endpoint_t *endpoint, config_t *config, uint8_t flags, uint32_t features);
 } /* water_heater_management */
 
+namespace water_heater_mode {
+typedef struct config {
+    uint8_t current_mode;
+    void *delegate;
+    config() : current_mode(0), delegate(nullptr) {}
+} config_t;
+
+cluster_t *create(endpoint_t *endpoint, config_t *config, uint8_t flags);
+} /* water_heater_mode */
+
 } /* cluster */
 } /* esp_matter */

components/esp_matter/esp_matter_delegate_callbacks.cpp

@@ -97,6 +97,11 @@ void RvcCleanModeDelegateInitCB(void *delegate, uint16_t endpoint_id)
     InitModeDelegate(delegate, endpoint_id, RvcCleanMode::Id);
 }
 
+void WaterHeaterModeDelegateInitCB(void *delegate, uint16_t endpoint_id)
+{
+    InitModeDelegate(delegate, endpoint_id, WaterHeaterMode::Id);
+}
+
 void EnergyEvseModeDelegateInitCB(void *delegate, uint16_t endpoint_id)
 {
     InitModeDelegate(delegate, endpoint_id, EnergyEvseMode::Id);

components/esp_matter/esp_matter_delegate_callbacks.h

@@ -22,6 +22,7 @@ void DishWasherModeDelegateInitCB(void *delegate, uint16_t endpoint_id);
 void RefrigeratorAndTCCModeDelegateInitCB(void *delegate, uint16_t endpoint_id);
 void RvcRunModeDelegateInitCB(void *delegate, uint16_t endpoint_id);
 void RvcCleanModeDelegateInitCB(void *delegate, uint16_t endpoint_id);
+void WaterHeaterModeDelegateInitCB(void *delegate, uint16_t endpoint_id);
 void EnergyEvseModeDelegateInitCB(void *delegate, uint16_t endpoint_id);
 void EnergyEvseDelegateInitCB(void *delegate, uint16_t endpoint_id);
 void MicrowaveOvenModeDelegateInitCB(void *delegate, uint16_t endpoint_id);

components/esp_matter/private/esp_matter_cluster_revisions.h

@@ -315,6 +315,10 @@ namespace rvc_clean_mode {
 constexpr uint16_t cluster_revision = 1;
 } // namespace rvc_clean_mode
 
+namespace water_heater_mode {
+constexpr uint16_t cluster_revision = 1;
+} // namespace water_heater_mode
+
 namespace microwave_oven_mode {
 constexpr uint16_t cluster_revision = 1;
 } // namespace microwave_oven_mode

docs/en/app_guide.rst

@@ -63,6 +63,7 @@ ModeWaterHeater, ModeRefrigerator, ModeLaundryWasher and ModeMicrowaveOven.
               , `Energy Evse Mode`_
               , `Microwave Oven Mode`_
               , `Device Energy Management Mode`_
+              , `Water Heater Mode`_
 
 9.1.2 Energy Evse Cluster
 -------------------------
@@ -243,6 +244,7 @@ ModeWaterHeater, ModeRefrigerator, ModeLaundryWasher and ModeMicrowaveOven.
 .. _`Energy Evse Mode`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/examples/energy-management-app/energy-management-common/energy-evse/include/energy-evse-modes.h
 .. _`Microwave Oven Mode`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/examples/all-clusters-app/all-clusters-common/include/microwave-oven-mode.h
 .. _`Device Energy Management Mode`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/examples/energy-management-app/energy-management-common/device-energy-management/include/device-energy-management-modes.h
+.. _`Water Heater Mode`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/examples/energy-management-app/energy-management-common/water-heater/include/water-heater-mode.h
 .. _`Energy Evse`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/src/app/clusters/energy-evse-server/energy-evse-server.h
 .. _`Energy Evse Delegate`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/examples/energy-management-app/energy-management-common/energy-evse/include/EnergyEvseDelegateImpl.h
 .. _`Operational State`: https://github.com/espressif/connectedhomeip/blob/ea679d2dc674f576f4d391d1d71af1489010e580/src/app/clusters/operational-state-server/operational-state-server.h