feat(matter): applies a generic temperature unit to the implementation and example

Author: SuGlider

libraries/Matter/examples/MatterTemperatureSensor/MatterTemperatureSensor.ino

@@ -24,24 +24,26 @@
 #include <WiFi.h>
 
 // List of Matter Endpoints for this Node
-// Celcius Temperature Sensor Endpoint
-MatterTemperatureSensor CelciusTempSensor;
+// Matter Temperature Sensor Endpoint
+MatterTemperatureSensor SimulatedTemperatureSensor;
 
 // 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;
+float getSimulatedTemperature() {
+  // The Endpoint implementation keeps an int16_t as internal value information, 
+  // which stores data in 1/100th of any temperature unit
+  static float simulatedTempHWSensor = -10.0;
 
   // it will increase from -10C to 10C in 0.5C steps to simulate a temperature sensor
-  celciusTempHWSensor = celciusTempHWSensor + 0.5;
-  if (celciusTempHWSensor > 10) {
-    celciusTempHWSensor = -10;
+  simulatedTempHWSensor = simulatedTempHWSensor + 0.5;
+  if (simulatedTempHWSensor > 10) {
+    simulatedTempHWSensor = -10;
   }
 
-  return celciusTempHWSensor;
+  return simulatedTempHWSensor;
 }
 
 void setup() {
@@ -57,8 +59,8 @@ void setup() {
   Serial.println();
 
   // set initial temperature sensor measurement
-  // Simulated Sensor - it shall initially print -25C and then move to the -10C to 10C range
-  CelciusTempSensor.begin(-25.00);
+  // Simulated Sensor - it shall initially print -25 degrees and then move to the -10 to 10 range
+  SimulatedTemperatureSensor.begin(-25.00);
 
   // Matter beginning - Last step, after all EndPoints are initialized
   Matter.begin();
@@ -84,9 +86,9 @@ void setup() {
 }
 
 void loop() {
-  Serial.printf("Current Temperature is %.02fC\r\n", (float)CelciusTempSensor);
+  Serial.printf("Current Temperature is %.02f <Temperature Units>\r\n", SimulatedTemperatureSensor.getTemperature());
   // update the temperature sensor value every 5 seconds
   // Matter APP shall display the updated temperature
   delay(5000);
-  CelciusTempSensor = getTemperature();
+  SimulatedTemperatureSensor.setTemperature(getSimulatedTemperature());
 }

libraries/Matter/src/MatterEndpoints/MatterTemperatureSensor.h

@@ -23,43 +23,41 @@ class MatterTemperatureSensor : public MatterEndPoint {
 public:
   MatterTemperatureSensor();
   ~MatterTemperatureSensor();
-  // 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);
+  // begin Matter Temperature Sensor endpoint with initial float temperature
+  bool begin(double temperature) {
+    return setTemperature(temperature);
   }
   // this will stop processing Temperature Sensor Matter events
   void end();
 
   // set the reported raw temperature
-  bool setRawTemperature(int16_t _rawTemperature);
-  bool setTemperatureCelsius(double temperatureCelcius) {
-    int16_t rawValue = static_cast<int16_t>(temperatureCelcius * 100.0f);
+  bool setTemperature(double temperature) {
+    // stores up to 1/100th of a degree precision
+    int16_t rawValue = static_cast<int16_t>(temperature * 100.0f);
     return setRawTemperature(rawValue);
   }
-  // returns the reported raw temperature (in 1/100th of a degree)
-  int16_t getRawTemperature() {
-    return rawTemperature;
-  }
-  // returns the reported temperature in Celcius
-  double getTemperatureCelsius() {
+  // returns the reported float temperature with 1/100th of a degree precision
+  double getTemperature() {
     return (double)rawTemperature / 100.0;
   }
-  // sets the reported temperature in Celcius
-  void operator=(double temperatureCelcius) {
-    int16_t rawValue = static_cast<int16_t>(temperatureCelcius * 100.0f);
-    setRawTemperature(rawValue);
+  // double conversion operator
+  void operator=(double temperature) {
+    setTemperature(temperature);
   }
+  // double conversion operator
   operator double() {
-    return (double) getTemperatureCelsius();
+    return (double) getTemperature();
   }
 
   // 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);
 
 protected:
   bool started = false;
-  int16_t rawTemperature = 0;  // default initial reported temperature
+  // implementation keeps temperature in 1/100th of a degree, any temperature unit
+  int16_t rawTemperature = 0;
+  // internal function to set the raw temperature value (Matter Cluster)
+  bool setRawTemperature(int16_t _rawTemperature);
+  bool begin(int16_t _rawTemperature);
 };
 #endif /* CONFIG_ESP_MATTER_ENABLE_DATA_MODEL */