energy-management-app: refactor WH and EVSE into separate endpoints and fix conformance issues

examples/energy-management-app/energy-management-common/common/include/EnergyManagementAppCmdLineOptions.h

@@ -25,7 +25,10 @@ namespace chip {
 namespace app {
 namespace Clusters {
 namespace DeviceEnergyManagement {
+constexpr EndpointId kEvseEndpoint        = 1;
+constexpr EndpointId kWaterHeaterEndpoint = 2;
 
+EndpointId GetMainAppEndpointId();
 chip::BitMask<Feature> GetFeatureMapFromCmdLine();
 
 } // namespace DeviceEnergyManagement

examples/energy-management-app/energy-management-common/device-energy-management/include/DEMDelegate.h → examples/energy-management-app/energy-management-common/device-energy-management/include/DEMInit.h

@@ -19,5 +19,11 @@
 #pragma once
 
 #include <DeviceEnergyManagementDelegateImpl.h>
+#include <DeviceEnergyManagementManager.h>
+#include <lib/core/CHIPError.h>
+
+CHIP_ERROR DeviceEnergyManagementInit(chip::EndpointId endpointId);
+CHIP_ERROR DeviceEnergyManagementShutdown();
 
 chip::app::Clusters::DeviceEnergyManagement::DeviceEnergyManagementDelegate * GetDEMDelegate();
+chip::app::Clusters::DeviceEnergyManagementManager * GetDEMInstance();

examples/energy-management-app/energy-management-common/device-energy-management/src/DEMInit.cpp

@@ -0,0 +1,126 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "EnergyManagementAppCmdLineOptions.h"
+
+#include <DeviceEnergyManagementManager.h>
+#include <EVSEManufacturerImpl.h>
+#include <ElectricalPowerMeasurementDelegate.h>
+#include <ElectricalSensorInit.h>
+#include <EnergyEvseManager.h>
+#include <PowerTopologyDelegate.h>
+#include <device-energy-management-modes.h>
+#include <energy-evse-modes.h>
+
+#include <app-common/zap-generated/ids/Attributes.h>
+#include <app-common/zap-generated/ids/Clusters.h>
+#include <app/ConcreteAttributePath.h>
+#include <app/clusters/electrical-energy-measurement-server/electrical-energy-measurement-server.h>
+#include <app/clusters/network-commissioning/network-commissioning.h>
+#include <app/server/Server.h>
+#include <lib/support/logging/CHIPLogging.h>
+#include <platform/Linux/NetworkCommissioningDriver.h>
+
+using namespace chip;
+using namespace chip::app::Clusters;
+using namespace chip::app::Clusters::DeviceEnergyManagement;
+
+static std::unique_ptr<DeviceEnergyManagementDelegate> gDEMDelegate;
+static std::unique_ptr<DeviceEnergyManagementManager> gDEMInstance;
+
+DeviceEnergyManagement::DeviceEnergyManagementDelegate * GetDEMDelegate()
+{
+    VerifyOrDieWithMsg(gDEMDelegate.get() != nullptr, AppServer, "DEM Delegate is null");
+
+    return gDEMDelegate.get();
+}
+
+DeviceEnergyManagementManager * GetDEMInstance()
+{
+    VerifyOrDieWithMsg(gDEMInstance.get() != nullptr, AppServer, "DEM Instance is null");
+
+    return gDEMInstance.get();
+}
+
+/*
+ *  @brief  Creates a Delegate and Instance for DEM
+ *
+ * The Instance is a container around the Delegate, so
+ * create the Delegate first, then wrap it in the Instance
+ * Then call the Instance->Init() to register the attribute and command handlers
+ */
+CHIP_ERROR DeviceEnergyManagementInit(chip::EndpointId endpointId)
+{
+    // TODO: support both EVSE and WaterHeater endpoints
+    if (gDEMDelegate || gDEMInstance)
+    {
+        ChipLogError(AppServer, "DEM Instance or Delegate already exist.");
+        return CHIP_ERROR_INCORRECT_STATE;
+    }
+
+    gDEMDelegate = std::make_unique<DeviceEnergyManagementDelegate>();
+    if (!gDEMDelegate)
+    {
+        ChipLogError(AppServer, "Failed to allocate memory for DeviceEnergyManagementDelegate");
+        return CHIP_ERROR_NO_MEMORY;
+    }
+
+    chip::BitMask<DeviceEnergyManagement::Feature> featureMap = GetFeatureMapFromCmdLine();
+
+    /* Manufacturer may optionally not support all features, commands & attributes */
+    gDEMInstance = std::make_unique<DeviceEnergyManagementManager>(EndpointId(endpointId), *gDEMDelegate, featureMap);
+
+    if (!gDEMInstance)
+    {
+        ChipLogError(AppServer, "Failed to allocate memory for DeviceEnergyManagementManager");
+        gDEMDelegate.reset();
+        return CHIP_ERROR_NO_MEMORY;
+    }
+
+    gDEMDelegate->SetDeviceEnergyManagementInstance(*gDEMInstance);
+
+    CHIP_ERROR err = gDEMInstance->Init(); /* Register Attribute & Command handlers */
+    if (err != CHIP_NO_ERROR)
+    {
+        ChipLogError(AppServer, "Init failed on gDEMInstance");
+        gDEMInstance.reset();
+        gDEMDelegate.reset();
+        return err;
+    }
+
+    return CHIP_NO_ERROR;
+}
+
+CHIP_ERROR DeviceEnergyManagementShutdown()
+{
+    // TODO: support both EVSE and WaterHeater endpoints
+    /* Do this in the order Instance first, then delegate
+     * Ensure we call the Instance->Shutdown to free attribute & command handlers first
+     */
+    if (gDEMInstance)
+    {
+        /* deregister attribute & command handlers */
+        gDEMInstance->Shutdown();
+        gDEMInstance.reset();
+    }
+    if (gDEMDelegate)
+    {
+        gDEMDelegate.reset();
+    }
+    return CHIP_NO_ERROR;
+}

examples/energy-management-app/energy-management-common/device-energy-management/src/DEMTestEventTriggers.cpp

@@ -16,7 +16,7 @@
  *    limitations under the License.
  */
 
-#include <DEMDelegate.h>
+#include <DEMInit.h>
 #include <DeviceEnergyManagementDelegateImpl.h>
 #include <app/clusters/device-energy-management-server/DeviceEnergyManagementTestEventTriggerHandler.h>
 

examples/energy-management-app/energy-management-common/device-energy-management/src/device-energy-management-mode.cpp

@@ -16,11 +16,14 @@
  *    limitations under the License.
  */
 
+#include <EnergyManagementAppCmdLineOptions.h>
 #include <app-common/zap-generated/attributes/Accessors.h>
 #include <device-energy-management-modes.h>
 
 using namespace chip::app::Clusters;
 using namespace chip::app::Clusters::DeviceEnergyManagementMode;
+using namespace chip::app::Clusters::DeviceEnergyManagement;
+
 using chip::Protocols::InteractionModel::Status;
 template <typename T>
 using List              = chip::app::DataModel::List<T>;
@@ -77,11 +80,6 @@ CHIP_ERROR DeviceEnergyManagementModeDelegate::GetModeTagsByIndex(uint8_t modeIn
     return CHIP_NO_ERROR;
 }
 
-ModeBase::Instance * DeviceEnergyManagementMode::Instance()
-{
-    return gDeviceEnergyManagementModeInstance.get();
-}
-
 void DeviceEnergyManagementMode::Shutdown()
 {
     gDeviceEnergyManagementModeInstance.reset();
@@ -90,6 +88,18 @@ void DeviceEnergyManagementMode::Shutdown()
 
 void emberAfDeviceEnergyManagementModeClusterInitCallback(chip::EndpointId endpointId)
 {
+    VerifyOrDie(endpointId == kEvseEndpoint || endpointId == kWaterHeaterEndpoint);
+
+    /* emberAfDeviceEnergyManagementModeClusterInitCallback() is called for all endpoints
+       that include this endpoint (even the one we disable dynamically). So here, we only
+       proceed when it's called for the right endpoint determined by GetMainAppEndpointId()
+       (a cmd line argument or #define).
+    */
+    if (endpointId != GetMainAppEndpointId())
+    {
+        return;
+    }
+
     VerifyOrDie(!gDeviceEnergyManagementModeDelegate && !gDeviceEnergyManagementModeInstance);
     gDeviceEnergyManagementModeDelegate = std::make_unique<DeviceEnergyManagementMode::DeviceEnergyManagementModeDelegate>();
     gDeviceEnergyManagementModeInstance = std::make_unique<ModeBase::Instance>(gDeviceEnergyManagementModeDelegate.get(),

examples/energy-management-app/energy-management-common/energy-evse/include/EnergyEvseMain.h

@@ -20,14 +20,5 @@
 
 #include <lib/core/CHIPError.h>
 
-void EvseApplicationInit();
+void EvseApplicationInit(chip::EndpointId endpointId);
 void EvseApplicationShutdown();
-
-CHIP_ERROR DeviceEnergyManagementInit();
-CHIP_ERROR DeviceEnergyManagementShutdown();
-
-CHIP_ERROR EnergyMeterInit();
-CHIP_ERROR EnergyMeterShutdown();
-
-CHIP_ERROR PowerTopologyInit();
-CHIP_ERROR PowerTopologyShutdown();