feat(matter): better user button experience and api renaming

Author: SuGlider

Diff for: libraries/Matter/examples/MatterHumiditySensor/MatterHumiditySensor.ino

@@ -28,17 +28,17 @@
 MatterHumiditySensor SimulatedHumiditySensor;
 
 // set your board USER BUTTON pin here - decommissioning button
-#ifdef BOOT_PIN
 const uint8_t buttonPin = BOOT_PIN;  // Set your pin here. Using BOOT Button.
-#else
-const uint8_t buttonPin = 0;  // Set your button pin here.
-#warning "Do not forget to set the USER BUTTON pin"
-#endif
 
 // 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
 
+// Button control - decommision the Matter Node
+uint32_t button_time_stamp = 0;                 // debouncing control
+bool button_state = false;                      // false = released | true = pressed
+const uint32_t decommissioningTimeout = 5000;   // keep the button pressed for 5s, or longer, to decommission
+
 // Simulate a humidity sensor - add your preferred humidity sensor library code here
 float getSimulatedHumidity() {
   // The Endpoint implementation keeps an uint16_t as internal value information,
@@ -96,13 +96,17 @@ void setup() {
   }
 }
 
-// Button control - decommision the Matter Node
-uint32_t button_time_stamp = 0;                 // debouncing control
-bool button_state = false;                      // false = released | true = pressed
-const uint32_t decommissioningTimeout = 10000;  // keep the button pressed for 10s to decommission
-
 void loop() {
-  Serial.printf("Current Humidity is %.02f%%\r\n", SimulatedHumiditySensor.getHumidityPercent());
+  static uint32_t timeCounter = 0;
+ 
+  // Print the current humidity value every 5s
+  if (!(timeCounter++ % 10)) {  // delaying for 500ms x 10 = 5s
+    // Print the current humidity value
+    Serial.printf("Current Humidity is %.02f%%\r\n", SimulatedHumiditySensor.getHumidity());
+    // Update Humidity from the (Simulated) Hardware Sensor
+    // Matter APP shall display the updated humidity percent
+    SimulatedHumiditySensor.setHumidity(getSimulatedHumidity());
+  }
 
   // Check if the button has been pressed
   if (digitalRead(buttonPin) == LOW && !button_state) {
@@ -111,19 +115,17 @@ void loop() {
     button_state = true;           // pressed.
   }
 
-  // Onboard User Button is used to decommission matter node
-  uint32_t time_diff = millis() - button_time_stamp;
-  if (button_state && time_diff > decommissioningTimeout && digitalRead(buttonPin) == HIGH) {
+  if (digitalRead(buttonPin) == HIGH && button_state) {
     button_state = false;  // released
+  }
+
+  // Onboard User Button is kept pressed for longer than 5 seconds in order to decommission matter node
+  uint32_t time_diff = millis() - button_time_stamp;
+  if (button_state && time_diff > decommissioningTimeout) {
     // Factory reset is triggered if the button is pressed longer than 10 seconds
-    if (time_diff > decommissioningTimeout) {
-      Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
-      Matter.decommission();
-    }
+    Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
+    Matter.decommission();
   }
 
-  // update the humidity sensor value every 5 seconds
-  delay(5000);
-  // Matter APP shall display the updated humidity percent
-  SimulatedHumiditySensor.setHumidityPercent(getSimulatedHumidity());
+  delay(500);
 }

Diff for: libraries/Matter/keywords.txt

@@ -66,8 +66,8 @@ onChangeMode	KEYWORD2
 onChangeSpeedPercent	KEYWORD2
 setTemperature	KEYWORD2
 getTemperature	KEYWORD2
-setHumidityPercent	KEYWORD2
-getHumidityPercent	KEYWORD2
+setHumidity	KEYWORD2
+getHumidity	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

Diff for: libraries/Matter/src/MatterEndpoints/MatterHumiditySensor.h

@@ -35,24 +35,24 @@ class MatterHumiditySensor : public MatterEndPoint {
   void end();
 
   // set the humidity percent with 1/100th of a percent precision
-  bool setHumidityPercent(double humidityPercent) {
+  bool setHumidity(double humidityPercent) {
     if (humidityPercent < 0.0 || humidityPercent > 100.0) {
       log_e("Humidity Sensor Percentage value out of range [0..100].");
       return false;
     }
     return setRawHumidity(static_cast<uint16_t>(humidityPercent * 100.0f));
   }
   // returns the reported float humidity percent with 1/100th of precision
-  double getHumidityPercent() {
+  double getHumidity() {
     return (double)rawHumidity / 100.0;
   }
   // double conversion operator
   void operator=(double humidityPercent) {
-    setHumidityPercent(humidityPercent);
+    setHumidity(humidityPercent);
   }
   // double conversion operator
   operator double() {
-    return (double) getHumidityPercent();
+    return (double) getHumidity();
   }
 
   // this function is called by Matter internal event processor. It could be overwritten by the application, if necessary.