Sync EnergyEvseDelegateImpl.cpp from Example Energy Management

Author: jamesharrow

examples/all-clusters-app/all-clusters-common/src/EnergyEvseDelegateImpl.cpp

@@ -64,7 +64,7 @@ Status EnergyEvseDelegate::Disable()
         break;
 
     default:
-        ChipLogError(AppServer, "Unexpected EVSE hardware state\n");
+        ChipLogError(AppServer, "Unexpected EVSE hardware state");
         SetState(StateEnum::kFault);
         break;
     }
@@ -138,10 +138,13 @@ Status EnergyEvseDelegate::EnableCharging(const DataModel::Nullable<uint32_t> &
     switch (mHwState)
     {
     case StateEnum::kNotPluggedIn:
+        // TODO handle errors here
         SetState(StateEnum::kNotPluggedIn);
         break;
 
     case StateEnum::kPluggedInNoDemand:
+        // TODO handle errors here
+        //  TODO REFACTOR per Andrei's comment in PR30857 - can we collapse this switch statement?
         SetState(StateEnum::kPluggedInNoDemand);
         break;
 
@@ -151,12 +154,12 @@ Status EnergyEvseDelegate::EnableCharging(const DataModel::Nullable<uint32_t> &
         break;
 
     default:
-        ChipLogError(AppServer, "Unexpected EVSE hardware state\n");
+        ChipLogError(AppServer, "Unexpected EVSE hardware state");
         SetState(StateEnum::kFault);
         break;
     }
 
-    /* update SupplyState */
+    /* update SupplyState to say that charging is now enabled */
     SetSupplyState(SupplyStateEnum::kChargingEnabled);
 
     /* If it looks ok, store the min & max charging current */
@@ -208,7 +211,6 @@ Status EnergyEvseDelegate::StartDiagnostics()
  * FUNCTIONS BELOW:
  *    - EVSE Hardware interface
  *
- *  RegisterEvseHardwareCallback( callbackType, callbackFnc )
  *  SetMaxHardwareCurrentLimit( currentmA )
  *  SetCircuitCapacity( currentmA )
  *  SetCableAssemblyLimit( currentmA )
@@ -217,25 +219,13 @@ Status EnergyEvseDelegate::StartDiagnostics()
  *
  */
 
-/**
- * @brief    Called by EVSE Hardware to register a callback
- *
- * @param    Callback function
- */
-#if 0
-Status EnergyEvseDelegate::HwRegisterEvseHardwareCallback(int Callback) // TODO
-{
-    // TODO
-    return CHIP_NO_ERROR;
-}
-#endif
 /**
  * @brief    Called by EVSE Hardware to notify the delegate of the maximum
  *           current limit supported by the hardware.
  *
  *           This is normally called at start-up.
  *
- * @param    currentmA
+ * @param    currentmA - Maximum current limit supported by the hardware
  */
 Status EnergyEvseDelegate::HwSetMaxHardwareCurrentLimit(int64_t currentmA)
 {
@@ -257,7 +247,7 @@ Status EnergyEvseDelegate::HwSetMaxHardwareCurrentLimit(int64_t currentmA)
  *           This is normally called at start-up when reading from DIP-switch
  *           settings.
  *
- * @param    currentmA
+ * @param    currentmA - Maximum current limit specified by electrician
  */
 Status EnergyEvseDelegate::HwSetCircuitCapacity(int64_t currentmA)
 {
@@ -282,7 +272,7 @@ Status EnergyEvseDelegate::HwSetCircuitCapacity(int64_t currentmA)
  *           using different resistors, which results in different voltages
  *           measured by the EVSE.
  *
- * @param    currentmA
+ * @param    currentmA - Maximum current limit detected from Cable assembly
  */
 Status EnergyEvseDelegate::HwSetCableAssemblyLimit(int64_t currentmA)
 {
@@ -298,17 +288,17 @@ Status EnergyEvseDelegate::HwSetCableAssemblyLimit(int64_t currentmA)
 }
 
 /**
- * @brief    Called by EVSE Hardware to indicate a fault
+ * @brief    Called by EVSE Hardware to indicate if EV is detected
  *
- * @param    StateEnum
+ * The only allowed states that the EVSE hardware can set are:
+ *  kNotPluggedIn
+ *  kPluggedInNoDemand
+ *  kPluggedInDemand
+ *
+ * @param    StateEnum - the state of the EV being plugged in and asking for demand etc
  */
 Status EnergyEvseDelegate::HwSetState(StateEnum state)
 {
-    /* the only allowed states that the EVSE hardware can set are:
-     *  kNotPluggedIn
-     *  kPluggedInNoDemand
-     *  kPluggedInDemand
-     */
     switch (state)
     {
     case StateEnum::kNotPluggedIn:
@@ -336,7 +326,7 @@ Status EnergyEvseDelegate::HwSetState(StateEnum state)
 /**
  * @brief    Called by EVSE Hardware to indicate a fault
  *
- * @param    FaultStateEnum
+ * @param    FaultStateEnum - the fault condition detected
  */
 Status EnergyEvseDelegate::HwSetFault(FaultStateEnum fault)
 {
@@ -382,6 +372,7 @@ Status EnergyEvseDelegate::HwSetRFID(ByteSpan uid)
 
     return Status::Success;
 }
+
 /**
  * @brief    Called by EVSE Hardware to share the VehicleID
  *
@@ -393,31 +384,33 @@ Status EnergyEvseDelegate::HwSetRFID(ByteSpan uid)
 Status EnergyEvseDelegate::HwSetVehicleID(const CharSpan & newValue)
 {
     // TODO this code to be refactored - See Issue #30993
-    if (mVehicleID.IsNull() || !newValue.data_equal(mVehicleID.Value()))
+    if (!mVehicleID.IsNull() && newValue.data_equal(mVehicleID.Value()))
     {
-        /* create a copy of the string so the callee doesn't have to keep it */
-        char * destinationBuffer = new char[kMaxVehicleIDBufSize];
-
-        MutableCharSpan destinationString(destinationBuffer, kMaxVehicleIDBufSize);
-        CHIP_ERROR err = CopyCharSpanToMutableCharSpan(newValue, destinationString);
-        if (err != CHIP_NO_ERROR)
-        {
-            ChipLogError(AppServer, "HwSetVehicleID - could not copy vehicleID");
-            delete[] destinationBuffer;
-            return Status::Failure;
-        }
+        return Status::Success;
+    }
 
-        if (!mVehicleID.IsNull())
-        {
-            delete[] mVehicleID.Value().data();
-        }
+    /* create a copy of the string so the callee doesn't have to keep it */
+    char * destinationBuffer = new char[kMaxVehicleIDBufSize];
 
-        mVehicleID = MakeNullable(static_cast<CharSpan>(destinationString));
+    MutableCharSpan destinationString(destinationBuffer, kMaxVehicleIDBufSize);
+    CHIP_ERROR err = CopyCharSpanToMutableCharSpan(newValue, destinationString);
+    if (err != CHIP_NO_ERROR)
+    {
+        ChipLogError(AppServer, "HwSetVehicleID - could not copy vehicleID");
+        delete[] destinationBuffer;
+        return Status::Failure;
+    }
 
-        ChipLogDetail(AppServer, "VehicleID updated");
-        MatterReportingAttributeChangeCallback(mEndpointId, EnergyEvse::Id, VehicleID::Id);
+    if (!mVehicleID.IsNull())
+    {
+        delete[] mVehicleID.Value().data();
     }
 
+    mVehicleID = MakeNullable(static_cast<CharSpan>(destinationString));
+
+    ChipLogDetail(AppServer, "VehicleID updated %.*s", static_cast<int>(mVehicleID.Value().size()), mVehicleID.Value().data());
+    MatterReportingAttributeChangeCallback(mEndpointId, EnergyEvse::Id, VehicleID::Id);
+
     return Status::Success;
 }
 
@@ -468,6 +461,7 @@ StateEnum EnergyEvseDelegate::GetState()
 {
     return mState;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetState(StateEnum newValue)
 {
     StateEnum oldValue = mState;
@@ -479,7 +473,7 @@ CHIP_ERROR EnergyEvseDelegate::SetState(StateEnum newValue)
     mState = newValue;
     if (oldValue != mState)
     {
-        ChipLogDetail(AppServer, "State updated to %d", (int) mState);
+        ChipLogDetail(AppServer, "State updated to %d", static_cast<int>(mState));
         MatterReportingAttributeChangeCallback(mEndpointId, EnergyEvse::Id, State::Id);
     }
 
@@ -491,6 +485,7 @@ SupplyStateEnum EnergyEvseDelegate::GetSupplyState()
 {
     return mSupplyState;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetSupplyState(SupplyStateEnum newValue)
 {
     SupplyStateEnum oldValue = mSupplyState;
@@ -503,7 +498,7 @@ CHIP_ERROR EnergyEvseDelegate::SetSupplyState(SupplyStateEnum newValue)
     mSupplyState = newValue;
     if (oldValue != mSupplyState)
     {
-        ChipLogDetail(AppServer, "SupplyState updated to %d", (int) mSupplyState);
+        ChipLogDetail(AppServer, "SupplyState updated to %d", static_cast<int>(mSupplyState));
         MatterReportingAttributeChangeCallback(mEndpointId, EnergyEvse::Id, SupplyState::Id);
     }
     return CHIP_NO_ERROR;
@@ -514,6 +509,7 @@ FaultStateEnum EnergyEvseDelegate::GetFaultState()
 {
     return mFaultState;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetFaultState(FaultStateEnum newValue)
 {
     FaultStateEnum oldValue = mFaultState;
@@ -526,7 +522,7 @@ CHIP_ERROR EnergyEvseDelegate::SetFaultState(FaultStateEnum newValue)
     mFaultState = newValue;
     if (oldValue != mFaultState)
     {
-        ChipLogDetail(AppServer, "FaultState updated to %d", (int) mFaultState);
+        ChipLogDetail(AppServer, "FaultState updated to %d", static_cast<int>(mFaultState));
         MatterReportingAttributeChangeCallback(mEndpointId, EnergyEvse::Id, FaultState::Id);
     }
     return CHIP_NO_ERROR;
@@ -537,6 +533,7 @@ DataModel::Nullable<uint32_t> EnergyEvseDelegate::GetChargingEnabledUntil()
 {
     return mChargingEnabledUntil;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetChargingEnabledUntil(uint32_t newValue)
 {
     DataModel::Nullable<uint32_t> oldValue = mChargingEnabledUntil;
@@ -550,11 +547,13 @@ CHIP_ERROR EnergyEvseDelegate::SetChargingEnabledUntil(uint32_t newValue)
     }
     return CHIP_NO_ERROR;
 }
+
 /* DischargingEnabledUntil */
 DataModel::Nullable<uint32_t> EnergyEvseDelegate::GetDischargingEnabledUntil()
 {
     return mDischargingEnabledUntil;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetDischargingEnabledUntil(uint32_t newValue)
 {
     DataModel::Nullable<uint32_t> oldValue = mDischargingEnabledUntil;
@@ -568,11 +567,13 @@ CHIP_ERROR EnergyEvseDelegate::SetDischargingEnabledUntil(uint32_t newValue)
     }
     return CHIP_NO_ERROR;
 }
+
 /* CircuitCapacity */
 int64_t EnergyEvseDelegate::GetCircuitCapacity()
 {
     return mCircuitCapacity;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetCircuitCapacity(int64_t newValue)
 {
     int64_t oldValue = mCircuitCapacity;
@@ -590,11 +591,13 @@ CHIP_ERROR EnergyEvseDelegate::SetCircuitCapacity(int64_t newValue)
     }
     return CHIP_NO_ERROR;
 }
+
 /* MinimumChargeCurrent */
 int64_t EnergyEvseDelegate::GetMinimumChargeCurrent()
 {
     return mMinimumChargeCurrent;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetMinimumChargeCurrent(int64_t newValue)
 {
     int64_t oldValue = mMinimumChargeCurrent;
@@ -618,6 +621,7 @@ int64_t EnergyEvseDelegate::GetMaximumChargeCurrent()
 {
     return mMaximumChargeCurrent;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetMaximumChargeCurrent(int64_t newValue)
 {
     int64_t oldValue = mMaximumChargeCurrent;
@@ -635,11 +639,13 @@ CHIP_ERROR EnergyEvseDelegate::SetMaximumChargeCurrent(int64_t newValue)
     }
     return CHIP_NO_ERROR;
 }
+
 /* MaximumDischargeCurrent */
 int64_t EnergyEvseDelegate::GetMaximumDischargeCurrent()
 {
     return mMaximumDischargeCurrent;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetMaximumDischargeCurrent(int64_t newValue)
 {
     int64_t oldValue = mMaximumDischargeCurrent;
@@ -657,11 +663,13 @@ CHIP_ERROR EnergyEvseDelegate::SetMaximumDischargeCurrent(int64_t newValue)
     }
     return CHIP_NO_ERROR;
 }
+
 /* UserMaximumChargeCurrent */
 int64_t EnergyEvseDelegate::GetUserMaximumChargeCurrent()
 {
     return mUserMaximumChargeCurrent;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetUserMaximumChargeCurrent(int64_t newValue)
 {
     if ((newValue < 0) || (newValue > kMaximumChargeCurrent))
@@ -679,11 +687,13 @@ CHIP_ERROR EnergyEvseDelegate::SetUserMaximumChargeCurrent(int64_t newValue)
 
     return CHIP_NO_ERROR;
 }
+
 /* RandomizationDelayWindow */
 uint32_t EnergyEvseDelegate::GetRandomizationDelayWindow()
 {
     return mRandomizationDelayWindow;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetRandomizationDelayWindow(uint32_t newValue)
 {
     uint32_t oldValue = mRandomizationDelayWindow;
@@ -733,6 +743,7 @@ DataModel::Nullable<uint16_t> EnergyEvseDelegate::GetApproximateEVEfficiency()
 {
     return mApproximateEVEfficiency;
 }
+
 CHIP_ERROR EnergyEvseDelegate::SetApproximateEVEfficiency(uint16_t newValue)
 {
     DataModel::Nullable<uint16_t> oldValue = mApproximateEVEfficiency;