[NXP] App button manager rework

examples/all-clusters-app/nxp/rt/rw61x/BUILD.gn

@@ -170,7 +170,7 @@ rt_executable("all_cluster_app") {
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
     "${common_example_dir}/device_manager/source/CHIPDeviceManager.cpp",
     "${common_example_dir}/icd/source/ICDUtil.cpp",
-    "${common_example_dir}/matter_button/source/AppMatterButtonEmpty.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationEmpty.cpp",
   ]
 
   deps = [

examples/contact-sensor-app/nxp/common/include/AppEvent.h

@@ -24,4 +24,5 @@ typedef void (*EventHandler)(const AppEvent &);
 struct AppEvent
 {
     EventHandler Handler;
+    void * extra;
 };

examples/contact-sensor-app/nxp/k32w1/BUILD.gn

@@ -149,6 +149,11 @@ mcxw71_k32w1_executable("contact_sensor_app") {
     "${common_example_dir}/clusters/source/ZclCallbacks.cpp",
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
     "${common_example_dir}/device_manager/source/CHIPDeviceManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonApp.cpp",
+    "${common_example_dir}/matter_button/source/ButtonBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationAppAndBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonWithTimer.cpp",
     "${common_example_dir}/operational_keystore/source/OperationalKeystoreS200.cpp",
     "${example_platform_dir}/factory_data/source/AppFactoryDataExample.cpp",
   ]
@@ -193,10 +198,7 @@ mcxw71_k32w1_executable("contact_sensor_app") {
     "${example_platform_dir}/button",
   ]
 
-  sources += [
-    "${example_platform_dir}/button/ButtonManager.cpp",
-    "${example_platform_dir}/clusters/Identify.cpp",
-  ]
+  sources += [ "${example_platform_dir}/clusters/Identify.cpp" ]
 
   if (chip_enable_ota_requestor) {
     sources += [ "${example_platform_dir}/ota/OtaUtils.cpp" ]

examples/contact-sensor-app/nxp/mcxw71/BUILD.gn

@@ -148,6 +148,11 @@ mcxw71_k32w1_executable("contact_sensor_app") {
     "${common_example_dir}/clusters/source/ZclCallbacks.cpp",
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
     "${common_example_dir}/device_manager/source/CHIPDeviceManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonApp.cpp",
+    "${common_example_dir}/matter_button/source/ButtonBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationAppAndBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonWithTimer.cpp",
     "${common_example_dir}/operational_keystore/source/OperationalKeystoreS200.cpp",
     "${example_platform_dir}/factory_data/source/AppFactoryDataExample.cpp",
   ]
@@ -192,10 +197,7 @@ mcxw71_k32w1_executable("contact_sensor_app") {
     "${example_platform_dir}/button",
   ]
 
-  sources += [
-    "${example_platform_dir}/button/ButtonManager.cpp",
-    "${example_platform_dir}/clusters/Identify.cpp",
-  ]
+  sources += [ "${example_platform_dir}/clusters/Identify.cpp" ]
 
   if (chip_enable_ota_requestor) {
     sources += [ "${example_platform_dir}/ota/OtaUtils.cpp" ]

examples/laundry-washer-app/nxp/rt/rw61x/BUILD.gn

@@ -171,7 +171,7 @@ rt_executable("laundry-washer") {
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
     "${common_example_dir}/device_manager/source/CHIPDeviceManager.cpp",
     "${common_example_dir}/icd/source/ICDUtil.cpp",
-    "${common_example_dir}/matter_button/source/AppMatterButtonEmpty.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationEmpty.cpp",
   ]
 
   deps = [

examples/lighting-app/nxp/common/include/AppEvent.h

@@ -24,4 +24,5 @@ typedef void (*EventHandler)(const AppEvent &);
 struct AppEvent
 {
     EventHandler Handler;
+    void * extra;
 };

examples/lighting-app/nxp/k32w1/BUILD.gn

@@ -156,6 +156,11 @@ mcxw71_k32w1_executable("light_app") {
     "${common_example_dir}/clusters/source/ZclCallbacks.cpp",
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
     "${common_example_dir}/device_manager/source/CHIPDeviceManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonApp.cpp",
+    "${common_example_dir}/matter_button/source/ButtonBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationAppAndBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonWithTimer.cpp",
     "${common_example_dir}/operational_keystore/source/OperationalKeystoreS200.cpp",
     "${example_platform_dir}/factory_data/source/AppFactoryDataExample.cpp",
   ]
@@ -180,10 +185,7 @@ mcxw71_k32w1_executable("light_app") {
     "${example_platform_dir}/button",
   ]
 
-  sources += [
-    "${example_platform_dir}/button/ButtonManager.cpp",
-    "${example_platform_dir}/clusters/Identify.cpp",
-  ]
+  sources += [ "${example_platform_dir}/clusters/Identify.cpp" ]
 
   if (chip_enable_ota_requestor) {
     sources += [ "${example_platform_dir}/ota/OtaUtils.cpp" ]

examples/lighting-app/nxp/k32w1/README.md

@@ -220,8 +220,8 @@ by running:
 The console should have already been installed in the virtual environment. From
 the `chip-console`, a user can send specific commands to the device.
 
-For button commands, please run `rpcs.chip.rpc.Button.Event(index)` based on the
-table below:
+For button commands, please run `rpcs.chip.rpc.Button.Event(idx=index)` based on
+the table below:
 
 | index | action                                        |
 | ----- | --------------------------------------------- |

examples/lighting-app/nxp/mcxw71/BUILD.gn

@@ -156,6 +156,11 @@ mcxw71_k32w1_executable("light_app") {
     "${common_example_dir}/clusters/source/ZclCallbacks.cpp",
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
     "${common_example_dir}/device_manager/source/CHIPDeviceManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonApp.cpp",
+    "${common_example_dir}/matter_button/source/ButtonBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationAppAndBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonWithTimer.cpp",
     "${common_example_dir}/operational_keystore/source/OperationalKeystoreS200.cpp",
     "${example_platform_dir}/factory_data/source/AppFactoryDataExample.cpp",
   ]
@@ -183,10 +188,7 @@ mcxw71_k32w1_executable("light_app") {
     "${example_platform_dir}/button",
   ]
 
-  sources += [
-    "${example_platform_dir}/button/ButtonManager.cpp",
-    "${example_platform_dir}/clusters/Identify.cpp",
-  ]
+  sources += [ "${example_platform_dir}/clusters/Identify.cpp" ]
 
   if (chip_enable_ota_requestor) {
     sources += [ "${example_platform_dir}/ota/OtaUtils.cpp" ]

examples/lock-app/nxp/common/main/include/AppEvent.h

@@ -48,4 +48,5 @@ struct AppEvent
     };
 
     EventHandler Handler;
+    void * extra;
 };

examples/lock-app/nxp/k32w1/BUILD.gn

@@ -154,6 +154,11 @@ mcxw71_k32w1_executable("lock_app") {
   sources += [
     "${common_example_dir}/app_task/source/AppTaskBase.cpp",
     "${common_example_dir}/app_task/source/AppTaskFreeRTOS.cpp",
+    "${common_example_dir}/matter_button/source/ButtonApp.cpp",
+    "${common_example_dir}/matter_button/source/ButtonBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationAppAndBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonWithTimer.cpp",
 
     #"${common_example_dir}/clusters/source/ZclCallbacks.cpp",
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
@@ -221,10 +226,7 @@ mcxw71_k32w1_executable("lock_app") {
     "${example_platform_dir}/button",
   ]
 
-  sources += [
-    "${example_platform_dir}/button/ButtonManager.cpp",
-    "${example_platform_dir}/clusters/Identify.cpp",
-  ]
+  sources += [ "${example_platform_dir}/clusters/Identify.cpp" ]
 
   if (chip_enable_ota_requestor) {
     sources += [ "${example_platform_dir}/ota/OtaUtils.cpp" ]

examples/lock-app/nxp/mcxw71/BUILD.gn

@@ -154,6 +154,11 @@ mcxw71_k32w1_executable("lock_app") {
   sources += [
     "${common_example_dir}/app_task/source/AppTaskBase.cpp",
     "${common_example_dir}/app_task/source/AppTaskFreeRTOS.cpp",
+    "${common_example_dir}/matter_button/source/ButtonApp.cpp",
+    "${common_example_dir}/matter_button/source/ButtonBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonManager.cpp",
+    "${common_example_dir}/matter_button/source/ButtonRegistrationAppAndBle.cpp",
+    "${common_example_dir}/matter_button/source/ButtonWithTimer.cpp",
 
     #"${common_example_dir}/clusters/source/ZclCallbacks.cpp",
     "${common_example_dir}/device_callbacks/source/CommonDeviceCallbacks.cpp",
@@ -221,10 +226,7 @@ mcxw71_k32w1_executable("lock_app") {
     "${example_platform_dir}/button",
   ]
 
-  sources += [
-    "${example_platform_dir}/button/ButtonManager.cpp",
-    "${example_platform_dir}/clusters/Identify.cpp",
-  ]
+  sources += [ "${example_platform_dir}/clusters/Identify.cpp" ]
 
   if (chip_enable_ota_requestor) {
     sources += [ "${example_platform_dir}/ota/OtaUtils.cpp" ]

examples/platform/nxp/common/app_task/source/AppTaskFreeRTOS.cpp

@@ -21,7 +21,7 @@
 #include <app/server/Dnssd.h>
 #include <lib/dnssd/Advertiser.h>
 
-#include "AppMatterButton.h"
+#include "ButtonRegistration.h"
 
 #include "CHIPDeviceManager.h"
 #include <app/server/Server.h>
@@ -98,10 +98,10 @@ CHIP_ERROR chip::NXP::App::AppTaskFreeRTOS::AppMatter_Register()
 #endif
 
     /* Register Matter buttons */
-    err = AppMatterButton_registerButtons();
+    err = chip::NXP::App::RegisterButtons();
     if (err != CHIP_NO_ERROR)
     {
-        ChipLogError(DeviceLayer, "Error during AppMatterButton_registerButtons");
+        ChipLogError(DeviceLayer, "Error during button registration");
         return err;
     }
     return err;

examples/platform/nxp/common/matter_button/include/Button.h

@@ -0,0 +1,52 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+#include "fsl_component_button.h"
+
+#include <lib/core/CHIPError.h>
+
+namespace chip::NXP::App {
+
+/**
+ * @brief This class is an abstraction over an SDK button.
+ *
+ */
+class Button
+{
+public:
+    using Callback = button_status_t (*)(void * handle, button_callback_message_t * message, void * param);
+
+    virtual ~Button() = default;
+
+    virtual CHIP_ERROR Init()        = 0;
+    virtual void HandleShortPress()  = 0;
+    virtual void HandleLongPress()   = 0;
+    virtual void HandleDoubleClick() = 0;
+
+    /**
+     * @brief This is an SDK handle for a button.
+     *
+     * It should be set in the Init method, based on a newly defined
+     * handle or an already defined handle owned by the SDK.
+     */
+    button_handle_t handle = nullptr;
+};
+
+} // namespace chip::NXP::App

examples/platform/nxp/common/matter_button/include/ButtonApp.h

@@ -0,0 +1,44 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+#include "Button.h"
+
+namespace chip::NXP::App {
+/**
+ * @brief This class implements a custom app button behavior.
+ *
+ * | Action       | Effect                            |
+ * | ------------ | --------------------------------- |
+ * | Short press  | Switch a cluster attribute state  |
+ * | Long press   | Schedule a soft reset taking into |
+ * |              | account Matter shutdown mechanism |
+ * | Double click | Do nothing                        |
+ *
+ */
+class ButtonApp : public Button
+{
+public:
+    virtual CHIP_ERROR Init() override;
+    virtual void HandleShortPress() override;
+    virtual void HandleLongPress() override;
+    virtual void HandleDoubleClick() override;
+};
+
+} // namespace chip::NXP::App

examples/platform/nxp/common/matter_button/include/ButtonBle.h

@@ -0,0 +1,48 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+#include "ButtonWithTimer.h"
+
+namespace chip::NXP::App {
+
+/**
+ * @brief This class implements a customized default button behavior.
+ *
+ * | Action       | Effect                                             |
+ * | ------------ | -------------------------------------------------- |
+ * | Short press  | If a factory reset is scheduled, cancel it.        |
+ * |              | Else if the device is commissioned and a factory   |
+ * |              | reset is not scheduled, switch to ICD active mode. |
+ * |              | Otherwise, switch commissioning state.             |
+ * | Long press   | Schedule a factory reset                           |
+ * | Double click | Toggle SIT mode request through DSLS mechanism     |
+ *
+ */
+class ButtonBle : public ButtonWithTimer
+{
+public:
+    virtual CHIP_ERROR Init() override;
+    virtual void HandleShortPress() override;
+    virtual void HandleLongPress() override;
+    virtual void HandleDoubleClick() override;
+    virtual void HandleTimerExpire() override;
+};
+
+} // namespace chip::NXP::App