feat(matter): general commentaries and code review

Author: SuGlider

libraries/Matter/examples/MatterTemperatureSensor/MatterTemperatureSensor.ino

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 /*
- * This example is the smallest code that will create a Matter Device which can be
+ * This example is an example code that will create a Matter Device which can be
  * commissioned and controlled from a Matter Environment APP.
  * Additionally the ESP32 will send debug messages indicating the Matter activity.
  * Turning DEBUG Level ON may be useful to following Matter Accessory and Controller messages.
@@ -25,16 +25,13 @@
 
 // List of Matter Endpoints for this Node
 // Celcius Temperature Sensor Endpoint
-
-
 MatterTemperatureSensor CelciusTempSensor;
 
 // WiFi is manually set and started
 const char *ssid = "your-ssid";          // Change this to your WiFi SSID
 const char *password = "your-password";  // Change this to your WiFi password
 
 // Simulate a temperature sensor - add your prefered temperature sensor library code here
-
 float getTemperature() {
   static float CelciusTempHWSensor = -10.0;
 
@@ -60,7 +57,7 @@ void setup() {
   Serial.println();
 
   // set initial temperature sensor measurement
-  // Simulated Sensor - it shall print -25C first and then move to the -10C to 10C range
+  // Simulated Sensor - it shall initially print -25C and then move to the -10C to 10C range
   CelciusTempSensor.begin(-25.00);
 
   // Matter beginning - Last step, after all EndPoints are initialized
@@ -89,8 +86,7 @@ void setup() {
 void loop() {
   Serial.printf("Current Temperature is %.02fC\r\n", (float)CelciusTempSensor);
   // update the temperature sensor value every 5 seconds
-  // Matter phone APP shall display the temperature change 
-
+  // Matter APP shall display the updated temperature
   delay(5000);
   CelciusTempSensor = getTemperature();
 }

libraries/Matter/src/MatterEndpoints/MatterTemperatureSensor.cpp

@@ -16,7 +16,6 @@
 #ifdef CONFIG_ESP_MATTER_ENABLE_DATA_MODEL
 
 #include <Matter.h>
-#include <app/server/Server.h>
 #include <MatterEndpoints/MatterTemperatureSensor.h>
 
 using namespace esp_matter;
@@ -48,7 +47,7 @@ bool MatterTemperatureSensor::begin(int16_t _rawTemperature) {
   temperature_sensor_config.temperature_measurement.min_measured_value = nullptr;
   temperature_sensor_config.temperature_measurement.max_measured_value = nullptr;
 
-  // endpoint handles can be used to add/modify clusters.
+  // endpoint handles can be used to add/modify clusters
   endpoint_t *endpoint = temperature_sensor::create(node::get(), &temperature_sensor_config, ENDPOINT_FLAG_NONE, (void *)this);
   if (endpoint == nullptr) {
     log_e("Failed to create Temperature Sensor endpoint");

libraries/Matter/src/MatterEndpoints/MatterTemperatureSensor.h

@@ -23,13 +23,13 @@ class MatterTemperatureSensor : public MatterEndPoint {
 public:
   MatterTemperatureSensor();
   ~MatterTemperatureSensor();
-  // default initial raw temperature
+  // begin Matter Temperature Sensor endpoint
   virtual bool begin(int16_t _rawTemperature = 0);
   bool begin(double temperatureCelcius) {
     int16_t rawValue = static_cast<int16_t>(temperatureCelcius * 100.0f);
     return begin(rawValue);
   }
-  // this will just stop processing Temperature Sensor Matter events
+  // this will stop processing Temperature Sensor Matter events
   void end();
 
   // set the reported raw temperature
@@ -38,23 +38,25 @@ class MatterTemperatureSensor : public MatterEndPoint {
     int16_t rawValue = static_cast<int16_t>(temperatureCelcius * 100.0f);
     return setRawTemperature(rawValue);
   }
-  int16_t getRawTemperature() {                             // returns the reported raw temperature
+  // returns the reported raw temperature (in 1/100th of a degree)
+  int16_t getRawTemperature() {
     return rawTemperature;
   }
-  double getTemperatureCelsius() {                           // returns the reported temperature in Celcius
+  // returns the reported temperature in Celcius
+  double getTemperatureCelsius() {
     return (double)rawTemperature / 100.0;
   }
-  void operator=(double temperatureCelcius) {               // sets the reported temperature in Celcius
+  // sets the reported temperature in Celcius
+  void operator=(double temperatureCelcius) {
     int16_t rawValue = static_cast<int16_t>(temperatureCelcius * 100.0f);
     setRawTemperature(rawValue);
   }
-  operator double() {                                       // returns the reported temperature in Celcius
+  operator double() {
     return (double) getTemperatureCelsius();
   }
 
   // this function is called by Matter internal event processor. It could be overwritten by the application, if necessary.
   bool attributeChangeCB(uint16_t endpoint_id, uint32_t cluster_id, uint32_t attribute_id, esp_matter_attr_val_t *val);
-  // User Callback for whenever the Light state is changed by the Matter Controller
 
 protected:
   bool started = false;