Use the manufacturer object to determine heating sources and turn on/…

…off heating

examples/water-heater-management-app/water-heater-management-common/include/WhmDelegate.h

@@ -31,6 +31,8 @@ namespace WaterHeaterManagement {
 
 using ModeTagStructType = detail::Structs::ModeTagStruct::Type;
 
+class WhmManufacturer;
+
 // This is an application level delegate to handle operational state commands according to the specific business logic.
 class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate,
                                       public ModeBase::Delegate
@@ -42,6 +44,8 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate,
 
     void SetWaterHeaterManagementInstance(WaterHeaterManagement::Instance & instance);
 
+    void SetWhmManufacturer(WhmManufacturer & whmManufacturer);
+
     /*********************************************************************************
      *
      * Methods implementing the WaterHeaterManagement::Delegate interace
@@ -225,6 +229,9 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate,
     // Need the following so can determine which features are supported
     WaterHeaterManagement::Instance *mpWhmInstance;
 
+    // Pointer to the manufacturer specific object which understand the hardware
+    WhmManufacturer * mpWhmManufacturer;
+
     // Target water temperature in 100ths of a C
     uint16_t mTargetWaterTemperature;
 

examples/water-heater-management-app/water-heater-management-common/include/WhmManufacturer.h

@@ -62,6 +62,21 @@ class WhmManufacturer
      */
     CHIP_ERROR Shutdown();
 
+    /**
+     * @brief   Called to determine which heating sources to use,
+     */
+    BitMask<WaterHeaterDemandBitmap> DetermineHeatingSources();
+
+    /**
+     * @brief   Turn the heating of the water tank on.
+     */
+    void TurnHeatingOn();
+
+    /**
+     * @brief   Turn the heating of the water tank off.
+     */
+    void TurnHeatingOff();
+
 private:
     WaterHeaterManagementInstance * mWhmInstance;
 };

examples/water-heater-management-app/water-heater-management-common/src/WhmDelegateImpl.cpp

@@ -18,6 +18,7 @@
 #include <app/clusters/water-heater-management-server/water-heater-management-server.h>
 
 #include <WhmDelegate.h>
+#include <WhmManufacturer.h>
 
 using namespace chip;
 using namespace chip::app;
@@ -28,6 +29,7 @@ using Protocols::InteractionModel::Status;
 
 WaterHeaterManagementDelegate::WaterHeaterManagementDelegate(EndpointId clustersEndpoint):
     mpWhmInstance(nullptr),
+    mpWhmManufacturer(nullptr),
     mBoostTargetTemperatureReached(false),
     mWaterHeaterModeInstance(this, clustersEndpoint, WaterHeaterMode::Id, 0),
     mTankVolume(0),
@@ -49,6 +51,11 @@ void WaterHeaterManagementDelegate::SetWaterHeaterManagementInstance(WaterHeater
     }
 }
 
+void WaterHeaterManagementDelegate::SetWhmManufacturer(WhmManufacturer & whmManufacturer)
+{
+    mpWhmManufacturer = &whmManufacturer;
+}
+
 /*********************************************************************************
  *
  * Methods implementing the WaterHeaterManagement::Delegate interace
@@ -418,31 +425,19 @@ void WaterHeaterManagementDelegate::CheckIfHeatNeedsToBeTurnedOnOrOff()
             // If a boost command is in progress or in manual mode, find a heating source and "turn it on".
             if (mBoostState == BoostStateEnum::kActive || mode == ModeManual)
             {
-                // Look through the heaterTypes attribute for a valid source
-                bool found = false;
-                uint8_t rawBitmask = mHeaterTypes.Raw();
-                uint8_t bit = 0;
-                while (rawBitmask != 0 && !found)
+                if (mpWhmManufacturer != nullptr)
                 {
-                    if (rawBitmask & 1)
-                    {
-                        found = true;
-                    }
-                    else
-                    {
-                        bit++;
-                        rawBitmask >>= 1;
-                    }
-                }
+                    // Find out from the manufacturer object the heating sources to use.
+                    BitMask<WaterHeaterDemandBitmap> heaterDemand = mpWhmManufacturer->DetermineHeatingSources();
 
-                if (found)
-                {
-                    // Found a source - use it to turn the heating on
-                    SetHeatDemand(BitMask<WaterHeaterDemandBitmap>(1 << bit));
+                    SetHeatDemand(heaterDemand);
+
+                    // And turn the heating of the water tank on.
+                    mpWhmManufacturer->TurnHeatingOn();
                 }
                 else
                 {
-                    ChipLogError(Zcl, "WaterHeaterManagementDelegate::CheckIfHeatNeedsToBeTurnedOnOrOff Failed to find heaterType");
+                    ChipLogError(Zcl, "WaterHeaterManagementDelegate::CheckIfHeatNeedsToBeTurnedOnOrOff: Failed as mpWhmManufacturer == nullptr");
                 }
             }
         }
@@ -478,6 +473,16 @@ void WaterHeaterManagementDelegate::CheckIfHeatNeedsToBeTurnedOnOrOff()
 
             DeviceLayer::SystemLayer().CancelTimer(BoostTimerExpiry, this);
         }
+
+        // Turn the heating off
+        if (mpWhmManufacturer != nullptr)
+        {
+            mpWhmManufacturer->TurnHeatingOff();
+        }
+        else
+        {
+            ChipLogError(Zcl, "WaterHeaterManagementDelegate::CheckIfHeatNeedsToBeTurnedOnOrOff: Failed to turn the heating off as mpWhmManufacturer == nullptr");
+        }
     }
 }
 

examples/water-heater-management-app/water-heater-management-common/src/WhmMain.cpp

@@ -147,6 +147,9 @@ CHIP_ERROR WhmManufacturerInit()
         return err;
     }
 
+    // Let the WhmDelegate know about the WhmManufacturer object.
+    gWhmDelegate->SetWhmManufacturer(*gWhmManufacturer);
+
     return CHIP_NO_ERROR;
 }
 

examples/water-heater-management-app/water-heater-management-common/src/WhmManufacturer.cpp

@@ -44,6 +44,62 @@ CHIP_ERROR WhmManufacturer::Shutdown()
     return CHIP_NO_ERROR;
 }
 
+BitMask<WaterHeaterDemandBitmap> WhmManufacturer::DetermineHeatingSources()
+{
+    WaterHeaterManagementDelegate * dg = GetWhmManufacturer()->GetWhmDelegate();
+    if (dg == nullptr)
+    {
+        ChipLogError(AppServer, "WhmDelegate is not initialized");
+        return BitMask<WaterHeaterDemandBitmap>(0);
+    }
+
+    // A list of valid heaterTypes
+    uint8_t waterHeaterTypeValues[] =
+    {
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kImmersionElement1),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kImmersionElement2),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kHeatPump),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kBoiler),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kOther),
+    };
+
+    // The corresponding list of valid headerDemands
+    uint8_t waterHeaterDemandValues[] =
+    {
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kImmersionElement1),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kImmersionElement2),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kHeatPump),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kBoiler),
+        static_cast<uint8_t>(WaterHeaterTypeBitmap::kOther),
+    };
+
+    // Iterate across the valid waterHeaterTypes seeing which heating sources are available based on heaterTypes.
+    // Set the corresponding bit in the heaterDemand bitmap.
+    BitMask<WaterHeaterTypeBitmap> heaterTypes = dg->GetHeaterTypes();
+
+    uint8_t heaterDemandMask = 0;
+    for (uint8_t idx = 0; idx < sizeof(waterHeaterTypeValues) / sizeof(waterHeaterTypeValues[0]); idx++)
+    {
+        // Is this heating source being used?
+        if (heaterTypes.Raw() & waterHeaterTypeValues[idx])
+        {
+            heaterDemandMask |= waterHeaterDemandValues[idx];
+        }
+    }
+
+    return BitMask<WaterHeaterDemandBitmap>(heaterDemandMask);
+}
+
+void WhmManufacturer::TurnHeatingOn()
+{
+    ChipLogProgress(AppServer, "WhmManufacturer::TurnHeatingOn");
+}
+
+void WhmManufacturer::TurnHeatingOff()
+{
+    ChipLogProgress(AppServer, "WhmManufacturer::TurnHeatingOff");
+}
+
 WaterHeaterManagementDelegate * GetWhmDelegate()
 {
     WhmManufacturer * mn = GetWhmManufacturer();