Add device-energy-management cluster example app code for 1.4

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

@@ -18,9 +18,11 @@
 
 #pragma once
 
+#include <app-common/zap-generated/cluster-enums.h>
 #include <app/util/config.h>
 #include <cstring>
 #include <lib/core/CHIPError.h>
+#include <lib/support/BitMask.h>
 #include <protocols/Protocols.h>
 #include <time.h>
 
@@ -45,19 +47,26 @@ CHIP_ERROR GetEpochTS(uint32_t & chipEpoch);
  *
  * @param   unixEpoch (as time_t)
  *
- * @return  bitmap value for day of week
- * Sunday = 0x00, Monday = 0x01 ... Saturday = 0x40 (1<<6)
+ * @return  bitmap value for day of week as defined by EnergyEvse::TargetDayOfWeekBitmap. Note
+ *          only one bit will be set for the day of the week.
  */
-uint8_t GetLocalDayOfWeekFromUnixEpoch(time_t unixEpoch);
+BitMask<EnergyEvse::TargetDayOfWeekBitmap> GetLocalDayOfWeekFromUnixEpoch(time_t unixEpoch);
 
 /**
  * @brief   Helper function to get current timestamp and work out the day of week based on localtime
  *
- * @param   reference to hold the day of week as a bitmap
+ * @param   reference to hold the day of week as a bitmap as defined by EnergyEvse::TargetDayOfWeekBitmap.
+ *          Note only one bit will be set for the current day.
+ */
+CHIP_ERROR GetLocalDayOfWeekNow(BitMask<EnergyEvse::TargetDayOfWeekBitmap> & dayOfWeekMap);
+
+/**
+ * @brief   Helper function to get current timestamp and work out the current number of minutes
+ *          past midnight based on localtime
  *
- * Sunday = 0x00, Monday = 0x01 ... Saturday = 0x40 (1<<6)
+ * @param   reference to hold the number of minutes past midnight
  */
-CHIP_ERROR GetLocalDayOfWeekNow(uint8_t & dayOfWeekMap);
+CHIP_ERROR GetMinutesPastMidnight(uint16_t & minutesPastMidnight);
 
 } // namespace DeviceEnergyManagement
 } // namespace Clusters

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

@@ -62,8 +62,9 @@ CHIP_ERROR ConfigureForecast(uint16_t numSlots)
         return err;
     }
 
-    // planned start time, in UTC, for the entire Forecast.
-    sForecastStruct.startTime = chipEpoch;
+    // planned start time, in UTC, for the entire Forecast. Allow to be a little
+    // time in the future as forecastStruct.startTime is used in some tests.
+    sForecastStruct.startTime = chipEpoch + 60;
 
     // earliest start time, in UTC, that the entire Forecast can be shifted to. null value indicates that it can be started
     // immediately.

examples/energy-management-app/energy-management-common/src/DeviceEnergyManagementDelegateImpl.cpp

@@ -115,6 +115,8 @@ Status DeviceEnergyManagementDelegate::PowerAdjustRequest(const int64_t powerMw,
 
     SetESAState(ESAStateEnum::kPowerAdjustActive);
 
+    // mPowerAdjustCapabilityStruct is guaranteed to have a value as validated in Instance::HandlePowerAdjustRequest.
+    // If it did not have a value, this method would not have been called.
     switch (cause)
     {
     case AdjustmentCauseEnum::kLocalOptimization:
@@ -927,7 +929,7 @@ CHIP_ERROR DeviceEnergyManagementDelegate::SetOptOutState(OptOutStateEnum newVal
 
     if (oldValue != newValue)
     {
-        ChipLogDetail(AppServer, "mOptOutState updated to %d mPowerAdjustmentInProgress %d", static_cast<int>(mOptOutState),
+        ChipLogDetail(AppServer, "mOptOutState updated to %d mPowerAdjustmentInProgress %d", to_underlying(mOptOutState),
                       mPowerAdjustmentInProgress);
         MatterReportingAttributeChangeCallback(mEndpointId, DeviceEnergyManagement::Id, OptOutState::Id);
     }

examples/energy-management-app/energy-management-common/src/EVSEManufacturerImpl.cpp

@@ -1,6 +1,6 @@
 /*
  *
- *    Copyright (c) 2024 Project CHIP Authors
+ *    Copyright (c) 2023-2024 Project CHIP Authors
  *    All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");

examples/energy-management-app/energy-management-common/src/EnergyEvseDelegateImpl.cpp

@@ -1,6 +1,6 @@
 /*
  *
- *    Copyright (c) 2024 Project CHIP Authors
+ *    Copyright (c) 2023-2024 Project CHIP Authors
  *    All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");

examples/energy-management-app/energy-management-common/src/EnergyEvseManager.cpp

@@ -1,6 +1,6 @@
 /*
  *
- *    Copyright (c) 2024 Project CHIP Authors
+ *    Copyright (c) 2023-2024 Project CHIP Authors
  *    All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");

examples/energy-management-app/energy-management-common/src/EnergyTimeUtils.cpp

@@ -65,7 +65,7 @@ CHIP_ERROR GetEpochTS(uint32_t & chipEpoch)
     if (!UnixEpochToChipEpochTime(unixEpoch, chipEpoch))
     {
         ChipLogError(Zcl, "Unable to convert Unix Epoch time to Matter Epoch Time");
-        return err;
+        return CHIP_ERROR_INCORRECT_STATE;
     }
 
     return CHIP_NO_ERROR;
@@ -80,10 +80,10 @@ CHIP_ERROR GetEpochTS(uint32_t & chipEpoch)
  *
  * @param   unixEpoch (as time_t)
  *
- * @return  bitmap value for day of week
- * Sunday = 0x01, Monday = 0x01 ... Saturday = 0x40 (1<<6)
+ * @return  bitmap value for day of week as defined by EnergyEvse::TargetDayOfWeekBitmap. Note
+ *          only one bit will be set for the day of the week.
  */
-uint8_t GetLocalDayOfWeekFromUnixEpoch(time_t unixEpoch)
+BitMask<EnergyEvse::TargetDayOfWeekBitmap> GetLocalDayOfWeekFromUnixEpoch(time_t unixEpoch)
 {
     // Define a timezone structure and initialize it to the local timezone
     // This will capture any daylight saving time changes
@@ -93,19 +93,19 @@ uint8_t GetLocalDayOfWeekFromUnixEpoch(time_t unixEpoch)
     // Get the day of the week (0 = Sunday, 1 = Monday, ..., 6 = Saturday)
     uint8_t dayOfWeek = static_cast<uint8_t>(local_time.tm_wday);
 
-    // Calculate the bitmap value based on the day of the week
+    // Calculate the bitmap value based on the day of the week. Note that the value in bitmap
+    // maps directly to the definition in EnergyEvse::TargetDayOfWeekBitmap.
     uint8_t bitmap = static_cast<uint8_t>(1 << dayOfWeek);
 
     return bitmap;
 }
 /**
  * @brief   Helper function to get current timestamp and work out the day of week based on localtime
  *
- * @param   reference to hold the day of week as a bitmap
- *
- * Sunday = 0x01, Monday = 0x01 ... Saturday = 0x40 (1<<6)
+ * @return  bitmap value for day of week as defined by EnergyEvse::TargetDayOfWeekBitmap. Note
+ *          only one bit will be set for the current day.
  */
-CHIP_ERROR GetLocalDayOfWeekNow(uint8_t & dayOfWeekMap)
+CHIP_ERROR GetLocalDayOfWeekNow(BitMask<EnergyEvse::TargetDayOfWeekBitmap> & dayOfWeekMap)
 {
     System::Clock::Milliseconds64 cTMs;
     CHIP_ERROR err = chip::System::SystemClock().GetClock_RealTimeMS(cTMs);
@@ -120,6 +120,33 @@ CHIP_ERROR GetLocalDayOfWeekNow(uint8_t & dayOfWeekMap)
     return CHIP_NO_ERROR;
 }
 
+/**
+ * @brief   Helper function to get current timestamp and work out the current number of minutes
+ *          past midnight based on localtime
+ *
+ * @param   reference to hold the number of minutes past midnight
+ */
+CHIP_ERROR GetMinutesPastMidnight(uint16_t & minutesPastMidnight)
+{
+    chip::System::Clock::Milliseconds64 cTMs;
+    CHIP_ERROR err = chip::System::SystemClock().GetClock_RealTimeMS(cTMs);
+    if (err != CHIP_NO_ERROR)
+    {
+        ChipLogError(Zcl, "EVSE: unable to get current time to check user schedules error=%" CHIP_ERROR_FORMAT, err.Format());
+        return err;
+    }
+    time_t unixEpoch = std::chrono::duration_cast<chip::System::Clock::Seconds32>(cTMs).count();
+
+    // Define a timezone structure and initialize it to the local timezone
+    // This will capture any daylight saving time changes
+    struct tm local_time;
+    localtime_r(&unixEpoch, &local_time);
+
+    minutesPastMidnight = static_cast<uint16_t>((local_time.tm_hour * 60) + local_time.tm_min);
+
+    return err;
+}
+
 } // namespace DeviceEnergyManagement
 } // namespace Clusters
 } // namespace app