WaterHeater Management follow up - Adds Boost events, test script updates

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

@@ -104,8 +104,8 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
      * SHALL be rejected with appropriate error.
      */
     Protocols::InteractionModel::Status HandleBoost(uint32_t duration, Optional<bool> oneShot, Optional<bool> emergencyBoost,
-                                                    Optional<int16_t> temporarySetpoint, Optional<chip::Percent> targetPercentage,
-                                                    Optional<chip::Percent> targetReheat) override;
+                                                    Optional<int16_t> temporarySetpoint, Optional<Percent> targetPercentage,
+                                                    Optional<Percent> targetReheat) override;
 
     /**
      * @brief Delegate should implement a handler to cancel a boost command.
@@ -121,7 +121,7 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
     BitMask<WaterHeaterHeatSourceBitmap> GetHeaterTypes() override;
     BitMask<WaterHeaterHeatSourceBitmap> GetHeatDemand() override;
     uint16_t GetTankVolume() override;
-    int64_t GetEstimatedHeatRequired() override;
+    Energy_mWh GetEstimatedHeatRequired() override;
     Percent GetTankPercentage() override;
     BoostStateEnum GetBoostState() override;
 
@@ -130,7 +130,7 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
     void SetHeaterTypes(BitMask<WaterHeaterHeatSourceBitmap> heaterTypes);
     void SetHeatDemand(BitMask<WaterHeaterHeatSourceBitmap> heatDemand);
     void SetTankVolume(uint16_t tankVolume);
-    void SetEstimatedHeatRequired(int64_t estimatedHeatRequired);
+    void SetEstimatedHeatRequired(Energy_mWh estimatedHeatRequired);
     void SetTankPercentage(Percent tankPercentage);
     void SetBoostState(BoostStateEnum boostState);
 
@@ -152,19 +152,22 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
      *
      * @param waterTemperature  The water temperature in 100th's Celsius
      */
-    void SetWaterTemperature(uint16_t waterTemperature);
+    void SetWaterTemperature(int16_t waterTemperature);
 
     /**
      * @brief Set the target water temperature of the tank
      *
      * @param targetWaterTemperature  The water temperature in 100th's Celsius
      */
-    void SetTargetWaterTemperature(uint16_t targetWaterTemperature);
+    void SetTargetWaterTemperature(int16_t targetWaterTemperature);
 
     /**
-     * @brief Determine whether the heating sources need to be turned on or off
+     * @brief Determine whether the heating sources need to be turned on or off or left unchanged.
+     *
+     * @return Success if the heating was successfully turned on or off or left unchanged otherwise an error
+     *         code is returned if turning the heating on or off failed.
      */
-    Protocols::InteractionModel::Status CheckIfHeatNeedsToBeTurnedOnOrOff();
+    Protocols::InteractionModel::Status ChangeHeatingIfNecessary();
 
     /**
      * @brief Static timer callback for when Boost timer expires.
@@ -194,9 +197,34 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
      * @param replacedWaterTemperature  The temperature of the
      * percentageReplaced water.
      */
-    void DrawOffHotWater(chip::Percent percentageReplaced, uint16_t replacedWaterTemperature);
+    void DrawOffHotWater(Percent percentageReplaced, int16_t replacedWaterTemperature);
+
+    /**
+     * Set the temperature of the cold water that fills the tank as the hot water
+     * is drawn off.
+     *
+     * @param coldWaterTemperature  The cold water temperature in 100th of a C
+     */
+    void SetColdWaterTemperature(int16_t coldWaterTemperature);
 
 private:
+    /**
+     * Return the target temperature.
+     * If a boost command is in progress and has a mBoostTemporarySetpoint value use that as the
+     * target temperature otherwise use the temperature set via SetTargetWaterTemperature().
+     *
+     * @return the target temperature
+     */
+    int16_t GetActiveTargetWaterTemperature() const;
+
+    /**
+     * @brief Calculate the percentage of the water in the tank at the target
+     *        temperature.
+     *
+     * @return  Percentage of water at the target temperature
+     */
+    uint8_t CalculateTankPercentage() const;
+
     /**
      * @brief Determine whether heating needs to be turned on or off or left as
      * is.
@@ -223,13 +251,13 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
     WhmManufacturer * mpWhmManufacturer;
 
     // Target water temperature in 100ths of a C
-    uint16_t mTargetWaterTemperature;
+    int16_t mTargetWaterTemperature;
 
     // Actual water temperature in 100ths of a C
-    uint16_t mWaterTemperature;
+    int16_t mWaterTemperature;
 
-    // The % of water at temperature mReplacedWaterTemperature
-    uint16_t mReplacedWaterTemperature;
+    // The cold water temperature in 100ths of a C
+    int16_t mColdWaterTemperature;
 
     // Boost command parameters
 
@@ -253,7 +281,7 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
     // amount of water that SHALL be heated by this Boost command before the
     // heater is switched off. This field is optional, however it SHALL be
     // included if the TargetReheat field is included.
-    Optional<chip::Percent> mBoostTargetPercentage;
+    Optional<Percent> mBoostTargetPercentage;
 
     // If the tank supports the TankPercent feature, and the heating by this
     // Boost command has ceased because the TargetPercentage of the water in the
@@ -266,7 +294,7 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
     // heat back up to 80% of hot water. If this field and the OneShot field
     // were both omitted, heating would begin again after any water draw which
     // reduced the TankPercentage below 80%.
-    Optional<chip::Percent> mBoostTargetReheat;
+    Optional<Percent> mBoostTargetReheat;
 
     // Track whether the water temperature has reached the water temperature
     // specified in the boost command. Used in conjunction with the boost
@@ -299,7 +327,7 @@ class WaterHeaterManagementDelegate : public WaterHeaterManagement::Delegate
     // taking the specific heat capacity of water (4182 J/kg °C) and by knowing
     // the current temperature of the water, the tank volume and target
     // temperature.
-    int64_t mEstimatedHeatRequired;
+    Energy_mWh mEstimatedHeatRequired;
 
     // This attribute SHALL indicate an approximate level of hot water stored in
     // the tank, which may help consumers understand the amount of hot water