feat(matter): fix commentaries related to feature changes and log messages

SuGlider · SuGlider · commit 7d465f323bfb · 2024-12-16T08:14:13.000-03:00
diff --git a/libraries/Matter/src/MatterEndpoints/MatterColorLight.cpp b/libraries/Matter/src/MatterEndpoints/MatterColorLight.cpp
@@ -206,7 +206,7 @@ bool MatterColorLight::setOnOff(bool newState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (onOffState == newState) {
     return true;
   }
@@ -256,7 +256,7 @@ bool MatterColorLight::setColorHSV(espHsvColor_t _hsvColor) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (colorHSV.h == _hsvColor.h && colorHSV.s == _hsvColor.s && colorHSV.v == _hsvColor.v) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterColorTemperatureLight.cpp b/libraries/Matter/src/MatterEndpoints/MatterColorTemperatureLight.cpp
@@ -138,7 +138,7 @@ bool MatterColorTemperatureLight::setOnOff(bool newState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (onOffState == newState) {
     return true;
   }
@@ -179,7 +179,7 @@ bool MatterColorTemperatureLight::setBrightness(uint8_t newBrightness) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (brightnessLevel == newBrightness) {
     return true;
   }
@@ -210,7 +210,7 @@ bool MatterColorTemperatureLight::setColorTemperature(uint16_t newTemperature) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (colorTemperatureLevel == newTemperature) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterContactSensor.cpp b/libraries/Matter/src/MatterEndpoints/MatterContactSensor.cpp
@@ -69,7 +69,7 @@ bool MatterContactSensor::setContact(bool _contactState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (contactState == _contactState) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterDimmableLight.cpp b/libraries/Matter/src/MatterEndpoints/MatterDimmableLight.cpp
@@ -114,7 +114,7 @@ bool MatterDimmableLight::setOnOff(bool newState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (onOffState == newState) {
     return true;
   }
@@ -155,7 +155,7 @@ bool MatterDimmableLight::setBrightness(uint8_t newBrightness) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (brightnessLevel == newBrightness) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterEnhancedColorLight.cpp b/libraries/Matter/src/MatterEndpoints/MatterEnhancedColorLight.cpp
@@ -226,7 +226,7 @@ bool MatterEnhancedColorLight::setOnOff(bool newState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (onOffState == newState) {
     return true;
   }
@@ -267,7 +267,7 @@ bool MatterEnhancedColorLight::setBrightness(uint8_t newBrightness) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (brightnessLevel == newBrightness) {
     return true;
   }
@@ -298,7 +298,7 @@ bool MatterEnhancedColorLight::setColorTemperature(uint16_t newTemperature) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (colorTemperatureLevel == newTemperature) {
     return true;
   }
@@ -338,7 +338,7 @@ bool MatterEnhancedColorLight::setColorHSV(espHsvColor_t _hsvColor) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (colorHSV.h == _hsvColor.h && colorHSV.s == _hsvColor.s && colorHSV.v == _hsvColor.v) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterFan.cpp b/libraries/Matter/src/MatterEndpoints/MatterFan.cpp
@@ -118,7 +118,7 @@ bool MatterFan::setMode(FanMode_t newMode, bool performUpdate) {
     log_w("Matter Fan device has not begun.");
     return false;
   }
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (currentFanMode == newMode) {
     return true;
   }
@@ -159,7 +159,7 @@ bool MatterFan::setSpeedPercent(uint8_t newPercent, bool performUpdate) {
     log_w("Matter Fan device has not begun.");
     return false;
   }
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (currentPercent == newPercent) {
     return true;
   }
@@ -193,7 +193,7 @@ bool MatterFan::setOnOff(bool newState, bool performUpdate) {
     log_w("Matter Fan device has not begun.");
     return false;
   }
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (getOnOff() == newState) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterHumiditySensor.cpp b/libraries/Matter/src/MatterEndpoints/MatterHumiditySensor.cpp
@@ -82,7 +82,7 @@ bool MatterHumiditySensor::setRawHumidity(uint16_t _rawHumidity) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (rawHumidity == _rawHumidity) {
     return true;
   }
@@ -98,7 +98,7 @@ bool MatterHumiditySensor::setRawHumidity(uint16_t _rawHumidity) {
     bool ret;
     ret = updateAttributeVal(RelativeHumidityMeasurement::Id, RelativeHumidityMeasurement::Attributes::MeasuredValue::Id, &humidityVal);
     if (!ret) {
-      log_e("Failed to update Fan Speed Percent Attribute.");
+      log_e("Failed to update Humidity Sensor Attribute.");
       return false;
     }
     rawHumidity = _rawHumidity;
diff --git a/libraries/Matter/src/MatterEndpoints/MatterOccupancySensor.cpp b/libraries/Matter/src/MatterEndpoints/MatterOccupancySensor.cpp
@@ -80,7 +80,7 @@ bool MatterOccupancySensor::setOccupancy(bool _occupancyState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (occupancyState == _occupancyState) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterOnOffLight.cpp b/libraries/Matter/src/MatterEndpoints/MatterOnOffLight.cpp
@@ -94,7 +94,7 @@ bool MatterOnOffLight::setOnOff(bool newState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (onOffState == newState) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterOnOffPlugin.cpp b/libraries/Matter/src/MatterEndpoints/MatterOnOffPlugin.cpp
@@ -93,7 +93,7 @@ bool MatterOnOffPlugin::setOnOff(bool newState) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (onOffState == newState) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterPressureSensor.cpp b/libraries/Matter/src/MatterEndpoints/MatterPressureSensor.cpp
@@ -70,7 +70,7 @@ bool MatterPressureSensor::setRawPressure(int16_t _rawPressure) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (rawPressure == _rawPressure) {
     return true;
   }
diff --git a/libraries/Matter/src/MatterEndpoints/MatterTemperatureSensor.cpp b/libraries/Matter/src/MatterEndpoints/MatterTemperatureSensor.cpp
@@ -70,7 +70,7 @@ bool MatterTemperatureSensor::setRawTemperature(int16_t _rawTemperature) {
     return false;
   }
 
-  // avoid processing the a "no-change"
+  // avoid processing if there was no change
   if (rawTemperature == _rawTemperature) {
     return true;
   }
@@ -86,7 +86,7 @@ bool MatterTemperatureSensor::setRawTemperature(int16_t _rawTemperature) {
     bool ret;
     ret = updateAttributeVal(TemperatureMeasurement::Id, TemperatureMeasurement::Attributes::MeasuredValue::Id, &temperatureVal);
     if (!ret) {
-      log_e("Failed to update Fan Speed Percent Attribute.");
+      log_e("Failed to update Temperature Sensor Attribute.");
       return false;
     }
     rawTemperature = _rawTemperature;

Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ bool MatterColorLight::setOnOff(bool newState) {`
`206`	`206`	`return false;`
`207`	`207`	`}`
`208`	`208`
`209`		`- // avoid processing the a "no-change"`
	`209`	`+ // avoid processing if there was no change`
`210`	`210`	`if (onOffState == newState) {`
`211`	`211`	`return true;`
`212`	`212`	`}`
`@@ -256,7 +256,7 @@ bool MatterColorLight::setColorHSV(espHsvColor_t _hsvColor) {`
`256`	`256`	`return false;`
`257`	`257`	`}`
`258`	`258`
`259`		`- // avoid processing the a "no-change"`
	`259`	`+ // avoid processing if there was no change`
`260`	`260`	`if (colorHSV.h == _hsvColor.h && colorHSV.s == _hsvColor.s && colorHSV.v == _hsvColor.v) {`
`261`	`261`	`return true;`
`262`	`262`	`}`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ bool MatterColorTemperatureLight::setOnOff(bool newState) {`
`138`	`138`	`return false;`
`139`	`139`	`}`
`140`	`140`
`141`		`- // avoid processing the a "no-change"`
	`141`	`+ // avoid processing if there was no change`
`142`	`142`	`if (onOffState == newState) {`
`143`	`143`	`return true;`
`144`	`144`	`}`
`@@ -179,7 +179,7 @@ bool MatterColorTemperatureLight::setBrightness(uint8_t newBrightness) {`
`179`	`179`	`return false;`
`180`	`180`	`}`
`181`	`181`
`182`		`- // avoid processing the a "no-change"`
	`182`	`+ // avoid processing if there was no change`
`183`	`183`	`if (brightnessLevel == newBrightness) {`
`184`	`184`	`return true;`
`185`	`185`	`}`
`@@ -210,7 +210,7 @@ bool MatterColorTemperatureLight::setColorTemperature(uint16_t newTemperature) {`
`210`	`210`	`return false;`
`211`	`211`	`}`
`212`	`212`
`213`		`- // avoid processing the a "no-change"`
	`213`	`+ // avoid processing if there was no change`
`214`	`214`	`if (colorTemperatureLevel == newTemperature) {`
`215`	`215`	`return true;`
`216`	`216`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ bool MatterContactSensor::setContact(bool _contactState) {`
`69`	`69`	`return false;`
`70`	`70`	`}`
`71`	`71`
`72`		`- // avoid processing the a "no-change"`
	`72`	`+ // avoid processing if there was no change`
`73`	`73`	`if (contactState == _contactState) {`
`74`	`74`	`return true;`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ bool MatterDimmableLight::setOnOff(bool newState) {`
`114`	`114`	`return false;`
`115`	`115`	`}`
`116`	`116`
`117`		`- // avoid processing the a "no-change"`
	`117`	`+ // avoid processing if there was no change`
`118`	`118`	`if (onOffState == newState) {`
`119`	`119`	`return true;`
`120`	`120`	`}`
`@@ -155,7 +155,7 @@ bool MatterDimmableLight::setBrightness(uint8_t newBrightness) {`
`155`	`155`	`return false;`
`156`	`156`	`}`
`157`	`157`
`158`		`- // avoid processing the a "no-change"`
	`158`	`+ // avoid processing if there was no change`
`159`	`159`	`if (brightnessLevel == newBrightness) {`
`160`	`160`	`return true;`
`161`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ bool MatterEnhancedColorLight::setOnOff(bool newState) {`
`226`	`226`	`return false;`
`227`	`227`	`}`
`228`	`228`
`229`		`- // avoid processing the a "no-change"`
	`229`	`+ // avoid processing if there was no change`
`230`	`230`	`if (onOffState == newState) {`
`231`	`231`	`return true;`
`232`	`232`	`}`
`@@ -267,7 +267,7 @@ bool MatterEnhancedColorLight::setBrightness(uint8_t newBrightness) {`
`267`	`267`	`return false;`
`268`	`268`	`}`
`269`	`269`
`270`		`- // avoid processing the a "no-change"`
	`270`	`+ // avoid processing if there was no change`
`271`	`271`	`if (brightnessLevel == newBrightness) {`
`272`	`272`	`return true;`
`273`	`273`	`}`
`@@ -298,7 +298,7 @@ bool MatterEnhancedColorLight::setColorTemperature(uint16_t newTemperature) {`
`298`	`298`	`return false;`
`299`	`299`	`}`
`300`	`300`
`301`		`- // avoid processing the a "no-change"`
	`301`	`+ // avoid processing if there was no change`
`302`	`302`	`if (colorTemperatureLevel == newTemperature) {`
`303`	`303`	`return true;`
`304`	`304`	`}`
`@@ -338,7 +338,7 @@ bool MatterEnhancedColorLight::setColorHSV(espHsvColor_t _hsvColor) {`
`338`	`338`	`return false;`
`339`	`339`	`}`
`340`	`340`
`341`		`- // avoid processing the a "no-change"`
	`341`	`+ // avoid processing if there was no change`
`342`	`342`	`if (colorHSV.h == _hsvColor.h && colorHSV.s == _hsvColor.s && colorHSV.v == _hsvColor.v) {`
`343`	`343`	`return true;`
`344`	`344`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ bool MatterFan::setMode(FanMode_t newMode, bool performUpdate) {`
`118`	`118`	`log_w("Matter Fan device has not begun.");`
`119`	`119`	`return false;`
`120`	`120`	`}`
`121`		`- // avoid processing the a "no-change"`
	`121`	`+ // avoid processing if there was no change`
`122`	`122`	`if (currentFanMode == newMode) {`
`123`	`123`	`return true;`
`124`	`124`	`}`
`@@ -159,7 +159,7 @@ bool MatterFan::setSpeedPercent(uint8_t newPercent, bool performUpdate) {`
`159`	`159`	`log_w("Matter Fan device has not begun.");`
`160`	`160`	`return false;`
`161`	`161`	`}`
`162`		`- // avoid processing the a "no-change"`
	`162`	`+ // avoid processing if there was no change`
`163`	`163`	`if (currentPercent == newPercent) {`
`164`	`164`	`return true;`
`165`	`165`	`}`
`@@ -193,7 +193,7 @@ bool MatterFan::setOnOff(bool newState, bool performUpdate) {`
`193`	`193`	`log_w("Matter Fan device has not begun.");`
`194`	`194`	`return false;`
`195`	`195`	`}`
`196`		`- // avoid processing the a "no-change"`
	`196`	`+ // avoid processing if there was no change`
`197`	`197`	`if (getOnOff() == newState) {`
`198`	`198`	`return true;`
`199`	`199`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ bool MatterHumiditySensor::setRawHumidity(uint16_t _rawHumidity) {`
`82`	`82`	`return false;`
`83`	`83`	`}`
`84`	`84`
`85`		`- // avoid processing the a "no-change"`
	`85`	`+ // avoid processing if there was no change`
`86`	`86`	`if (rawHumidity == _rawHumidity) {`
`87`	`87`	`return true;`
`88`	`88`	`}`
`@@ -98,7 +98,7 @@ bool MatterHumiditySensor::setRawHumidity(uint16_t _rawHumidity) {`
`98`	`98`	`bool ret;`
`99`	`99`	`ret = updateAttributeVal(RelativeHumidityMeasurement::Id, RelativeHumidityMeasurement::Attributes::MeasuredValue::Id, &humidityVal);`
`100`	`100`	`if (!ret) {`
`101`		`- log_e("Failed to update Fan Speed Percent Attribute.");`
	`101`	`+ log_e("Failed to update Humidity Sensor Attribute.");`
`102`	`102`	`return false;`
`103`	`103`	`}`
`104`	`104`	`rawHumidity = _rawHumidity;`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ bool MatterOccupancySensor::setOccupancy(bool _occupancyState) {`
`80`	`80`	`return false;`
`81`	`81`	`}`
`82`	`82`
`83`		`- // avoid processing the a "no-change"`
	`83`	`+ // avoid processing if there was no change`
`84`	`84`	`if (occupancyState == _occupancyState) {`
`85`	`85`	`return true;`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ bool MatterOnOffLight::setOnOff(bool newState) {`
`94`	`94`	`return false;`
`95`	`95`	`}`
`96`	`96`
`97`		`- // avoid processing the a "no-change"`
	`97`	`+ // avoid processing if there was no change`
`98`	`98`	`if (onOffState == newState) {`
`99`	`99`	`return true;`
`100`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ bool MatterOnOffPlugin::setOnOff(bool newState) {`
`93`	`93`	`return false;`
`94`	`94`	`}`
`95`	`95`
`96`		`- // avoid processing the a "no-change"`
	`96`	`+ // avoid processing if there was no change`
`97`	`97`	`if (onOffState == newState) {`
`98`	`98`	`return true;`
`99`	`99`	`}`