feat(matter): adjusts boot button functionality for all examples

Author: SuGlider

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

@@ -35,12 +35,13 @@ const uint8_t ledPin = 2;  // Set your pin here if your board has not defined LE
 #endif
 
 // set your board USER BUTTON pin here
-#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
+
+// Button control
+uint32_t button_time_stamp = 0;                 // debouncing control
+bool button_state = false;                      // false = released | true = pressed
+const uint32_t debouceTime = 250;               // button debouncing time (ms)
+const uint32_t decommissioningTimeout = 5000;   // keep the button pressed for 5s, or longer, to decommission
 
 // WiFi is manually set and started
 const char *ssid = "your-ssid";          // Change this to your WiFi SSID
@@ -130,11 +131,6 @@ void setup() {
     ColorLight.updateAccessory();
   }
 }
-// Button control
-uint32_t button_time_stamp = 0;                 // debouncing control
-bool button_state = false;                      // false = released | true = pressed
-const uint32_t debouceTime = 250;               // button debouncing time (ms)
-const uint32_t decommissioningTimeout = 10000;  // keep the button pressed for 10s to decommission the light
 
 void loop() {
   // Check Matter Light Commissioning state, which may change during execution of loop()
@@ -172,17 +168,18 @@ void loop() {
 
   // Onboard User Button is used as a Light toggle switch or to decommission it
   uint32_t time_diff = millis() - button_time_stamp;
-  if (button_state && time_diff > debouceTime && digitalRead(buttonPin) == HIGH) {
-    button_state = false;  // released
+  if (digitalRead(buttonPin) == HIGH && button_state && time_diff > debouceTime) {
     // Toggle button is released - toggle the light
     Serial.println("User button released. Toggling Light!");
     ColorLight.toggle();  // Matter Controller also can see the change
+    button_state = false;  // released
+  }
 
-    // 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.");
-      ColorLight = false;  // turn the light off
-      Matter.decommission();
-    }
+  // Onboard User Button is kept pressed for longer than 5 seconds in order to decommission matter node
+  if (button_state && time_diff > decommissioningTimeout) {
+    Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
+    ColorLight = false;  // turn the light off
+    Matter.decommission();
+    button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so
   }
 }

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

@@ -27,12 +27,12 @@ const char *ssid = "your-ssid";          // Change this to your WiFi SSID
 const char *password = "your-password";  // Change this to your WiFi password
 
 // set your board USER BUTTON pin here -  USED to decommission the Matter Node
-#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
+
+// Button control
+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
 
 // Matter Protocol Endpoint Callback for each Light Accessory
 bool setLightOnOff1(bool state) {
@@ -89,12 +89,9 @@ void setup() {
   Matter.begin();
 }
 
-// Button control
-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 the light
-
 void loop() {
+  static uint32_t timeCounter = 0;
+
   // Check Matter Light Commissioning state
   if (!Matter.isDeviceCommissioned()) {
     Serial.println("");
@@ -115,10 +112,12 @@ void loop() {
   }
 
   //displays the Light state every 5 seconds
-  Serial.println("======================");
-  Serial.printf("Matter Light #1 is %s\r\n", Light1.getOnOff() ? "ON" : "OFF");
-  Serial.printf("Matter Light #2 is %s\r\n", Light2.getOnOff() ? "ON" : "OFF");
-  Serial.printf("Matter Light #3 is %s\r\n", Light3.getOnOff() ? "ON" : "OFF");
+  if (!(timeCounter++ % 10)) {  // delaying for 500ms x 10 = 5s
+    Serial.println("======================");
+    Serial.printf("Matter Light #1 is %s\r\n", Light1.getOnOff() ? "ON" : "OFF");
+    Serial.printf("Matter Light #2 is %s\r\n", Light2.getOnOff() ? "ON" : "OFF");
+    Serial.printf("Matter Light #3 is %s\r\n", Light3.getOnOff() ? "ON" : "OFF");
+  }
 
   // Check if the button has been pressed
   if (digitalRead(buttonPin) == LOW && !button_state) {
@@ -127,16 +126,17 @@ void loop() {
     button_state = true;           // pressed.
   }
 
-  // Onboard User Button is used to decommission matter fabric
-  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
-    // 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();
-    }
   }
 
-  delay(5000);
+  // 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) {
+    Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
+    Matter.decommission();
+    button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so
+  }
+
+  delay(500);
 }

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

@@ -35,12 +35,13 @@ const uint8_t ledPin = 2;  // Set your pin here if your board has not defined LE
 #endif
 
 // set your board USER BUTTON pin here
-#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
+
+// Button control
+uint32_t button_time_stamp = 0;                 // debouncing control
+bool button_state = false;                      // false = released | true = pressed
+const uint32_t debouceTime = 250;               // button debouncing time (ms)
+const uint32_t decommissioningTimeout = 5000;   // keep the button pressed for 5s, or longer, to decommission
 
 // WiFi is manually set and started
 const char *ssid = "your-ssid";          // Change this to your WiFi SSID
@@ -122,11 +123,6 @@ void setup() {
     DimmableLight.updateAccessory();
   }
 }
-// Button control
-uint32_t button_time_stamp = 0;                 // debouncing control
-bool button_state = false;                      // false = released | true = pressed
-const uint32_t debouceTime = 250;               // button debouncing time (ms)
-const uint32_t decommissioningTimeout = 10000;  // keep the button pressed for 10s to decommission the light
 
 void loop() {
   // Check Matter Light Commissioning state, which may change during execution of loop()
@@ -161,17 +157,18 @@ void loop() {
 
   // Onboard User Button is used as a Light toggle switch or to decommission it
   uint32_t time_diff = millis() - button_time_stamp;
-  if (button_state && time_diff > debouceTime && digitalRead(buttonPin) == HIGH) {
-    button_state = false;  // released
+  if (digitalRead(buttonPin) == HIGH && button_state && time_diff > debouceTime) {
     // Toggle button is released - toggle the light
     Serial.println("User button released. Toggling Light!");
     DimmableLight.toggle();  // Matter Controller also can see the change
+    button_state = false;  // released
+  }
 
-    // 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.");
-      DimmableLight = false;  // turn the light off
-      Matter.decommission();
-    }
+  // Onboard User Button is kept pressed for longer than 5 seconds in order to decommission matter node
+  if (button_state && time_diff > decommissioningTimeout) {
+    Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
+    DimmableLight = false;  // turn the light off
+    Matter.decommission();
+    button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so
   }
 }

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

@@ -38,12 +38,13 @@ const uint8_t ledPin = 2;  // Set your pin here if your board has not defined LE
 #endif
 
 // set your board USER BUTTON pin here
-#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
+
+// Button control
+uint32_t button_time_stamp = 0;                 // debouncing control
+bool button_state = false;                      // false = released | true = pressed
+const uint32_t debouceTime = 250;               // button debouncing time (ms)
+const uint32_t decommissioningTimeout = 5000;   // keep the button pressed for 5s, or longer, to decommission
 
 // WiFi is manually set and started
 const char *ssid = "your-ssid";          // Change this to your WiFi SSID
@@ -152,11 +153,6 @@ void setup() {
     EnhancedColorLight.updateAccessory();
   }
 }
-// Button control
-uint32_t button_time_stamp = 0;                 // debouncing control
-bool button_state = false;                      // false = released | true = pressed
-const uint32_t debouceTime = 250;               // button debouncing time (ms)
-const uint32_t decommissioningTimeout = 10000;  // keep the button pressed for 10s to decommission the light
 
 void loop() {
   // Check Matter Light Commissioning state, which may change during execution of loop()
@@ -199,12 +195,13 @@ void loop() {
     // Toggle button is released - toggle the light
     Serial.println("User button released. Toggling Light!");
     EnhancedColorLight.toggle();  // Matter Controller also can see the change
+  }
 
-    // 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.");
-      EnhancedColorLight = false;  // turn the light off
-      Matter.decommission();
-    }
+  // Onboard User Button is kept pressed for longer than 5 seconds in order to decommission matter node
+  if (button_state && time_diff > decommissioningTimeout) {
+    Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
+    EnhancedColorLight = false;  // turn the light off
+    Matter.decommission();
+    button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so
   }
 }

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

@@ -21,13 +21,13 @@
 MatterFan Fan;
 
 // set your board USER BUTTON pin here - used for toggling On/Off and decommission the Matter Node
-#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
 
+// Button control
+uint32_t button_time_stamp = 0;                 // debouncing control
+bool button_state = false;                      // false = released | true = pressed
+const uint32_t debouceTime = 250;               // button debouncing time (ms)
+const uint32_t decommissioningTimeout = 5000;   // keep the button pressed for 5s, or longer, to decommission
 
 // set your board Analog Pin here - used for changing the Fan speed
 const uint8_t analogPin = A0;  // Analog Pin depends on each board
@@ -146,12 +146,6 @@ void setup() {
   }
 }
 
-// Builtin Button control
-uint32_t button_time_stamp = 0;                 // debouncing control
-bool button_state = false;                      // false = released | true = pressed
-const uint32_t debouceTime = 250;               // button debouncing time (ms)
-const uint32_t decommissioningTimeout = 10000;  // keep the button pressed for 10s to decommission the Matter Fabric
-
 void loop() {
   // Check Matter Accessory Commissioning state, which may change during execution of loop()
   if (!Matter.isDeviceCommissioned()) {
@@ -187,14 +181,15 @@ void loop() {
     // button is released - toggle Fan On/Off
     Fan.toggle();
     Serial.printf("User button released. Setting the Fan %s.\r\n", Fan > 0 ? "ON" : "OFF");
-
-    // Factory reset is triggered if the button is pressed longer than 10 seconds
-    if (time_diff > decommissioningTimeout) {
-      Serial.println("Decommissioning the Generic Switch Matter Accessory. It shall be commissioned again.");
-      Matter.decommission();
-    }
   }
 
+  // Onboard User Button is kept pressed for longer than 5 seconds in order to decommission matter node
+  if (button_state && time_diff > decommissioningTimeout) {
+    Serial.println("Decommissioning the Generic Switch Matter Accessory. It shall be commissioned again.");
+    Matter.decommission();
+    button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so
+ }
+
   // checks Analog pin and adjust the speed only if it has changed
   static int lastRead = 0;
   // analog values (0..1023) / 103 => mapped into 10 steps (0..9)

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

@@ -35,13 +35,13 @@ const uint8_t ledPin = LED_BUILTIN;
 const uint8_t ledPin = 2;  // Set your pin here if your board has not defined LED_BUILTIN
 #endif
 
-// set your board USER BUTTON pin here
-#ifdef BOOT_PIN
+// set your board USER BUTTON pin here - decommissioning button
 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
+
+// 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
 
 // Matter Protocol Endpoint (On/OFF Light) Callback
 bool matterCB(bool state) {
@@ -86,11 +86,6 @@ 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() {
   // Check if the button has been pressed
   if (digitalRead(buttonPin) == LOW && !button_state) {
@@ -99,16 +94,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
-    // 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();
-    }
   }
 
-  delay(5000);
+  // 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) {
+    Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again.");
+    Matter.decommission();
+    button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so
+  }
+
+  delay(500);
 }