samples: matter: Switch Identify Cluster to code-driven

Replaced ZAP-driven Identify Cluster usage by the code-driven
implementation. This change is done to be aligned with Matter 1.5.

Signed-off-by: Arkadiusz Balys <[email protected]>

Author: ArekBalysNordic

applications/matter_bridge/src/app_task.cpp

@@ -17,6 +17,7 @@
 #include "board/board.h"
 #include "bridge_manager.h"
 #include "bridge_storage_manager.h"
+#include "clusters/identify.h"
 
 #ifdef CONFIG_BRIDGED_DEVICE_BT
 #include "ble_connectivity_manager.h"
@@ -25,7 +26,6 @@
 #include <app-common/zap-generated/attributes/Accessors.h>
 #include <app-common/zap-generated/ids/Attributes.h>
 #include <app-common/zap-generated/ids/Clusters.h>
-#include <app/clusters/identify-server/identify-server.h>
 #include <setup_payload/OnboardingCodesUtil.h>
 
 #ifdef CONFIG_BRIDGED_DEVICE_BT
@@ -47,14 +47,13 @@ namespace
 {
 
 constexpr EndpointId kBridgeEndpointId = 1;
-constexpr uint16_t kTriggerEffectTimeout = 5000;
-constexpr uint16_t kTriggerEffectFinishTimeout = 1000;
 
-k_timer sTriggerEffectTimer;
-bool sIsTriggerEffectActive;
-
-Identify sIdentify = { kBridgeEndpointId, AppTask::IdentifyStartHandler, AppTask::IdentifyStopHandler,
-		       Clusters::Identify::IdentifyTypeEnum::kVisibleIndicator, AppTask::TriggerIdentifyEffectHandler };
+#ifndef CONFIG_BRIDGE_SMART_PLUG_SUPPORT
+/* Trigger effect is enabled for the bridge device */
+Nrf::Matter::IdentifyCluster sIdentifyCluster(kBridgeEndpointId, true);
+#else
+Nrf::Matter::IdentifyCluster sIdentifyCluster(kBridgeEndpointId);
+#endif
 
 #ifdef CONFIG_BRIDGED_DEVICE_BT
 const bt_uuid *sUuidLbs = BT_UUID_LBS;
@@ -115,67 +114,6 @@ void AppFactoryResetHandler(const ChipDeviceEvent *event, intptr_t /* unused */)
 
 } /* namespace */
 
-void AppTask::IdentifyStartHandler(Identify *)
-{
-	Nrf::PostTask(
-		[] { Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Blink(Nrf::LedConsts::kIdentifyBlinkRate_ms); });
-}
-
-void AppTask::IdentifyStopHandler(Identify *)
-{
-	Nrf::PostTask([] {
-		Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Set(false);
-	});
-}
-
-void AppTask::TriggerEffectTimerTimeoutCallback(k_timer *timer)
-{
-	LOG_INF("Identify effect completed");
-
-	sIsTriggerEffectActive = false;
-
-	Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Set(false);
-
-}
-
-void AppTask::TriggerIdentifyEffectHandler(Identify *identify)
-{
-	switch (identify->mCurrentEffectIdentifier) {
-	/* Just handle all effects in the same way. */
-	case Clusters::Identify::EffectIdentifierEnum::kBlink:
-	case Clusters::Identify::EffectIdentifierEnum::kBreathe:
-	case Clusters::Identify::EffectIdentifierEnum::kOkay:
-	case Clusters::Identify::EffectIdentifierEnum::kChannelChange:
-		LOG_INF("Identify effect identifier changed to %d",
-			static_cast<uint8_t>(identify->mCurrentEffectIdentifier));
-
-		sIsTriggerEffectActive = false;
-
-		k_timer_stop(&sTriggerEffectTimer);
-		k_timer_start(&sTriggerEffectTimer, K_MSEC(kTriggerEffectTimeout), K_NO_WAIT);
-
-		Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Blink(Nrf::LedConsts::kIdentifyBlinkRate_ms);
-		break;
-	case Clusters::Identify::EffectIdentifierEnum::kFinishEffect:
-		LOG_INF("Identify effect finish triggered");
-		k_timer_stop(&sTriggerEffectTimer);
-		k_timer_start(&sTriggerEffectTimer, K_MSEC(kTriggerEffectFinishTimeout), K_NO_WAIT);
-		break;
-	case Clusters::Identify::EffectIdentifierEnum::kStopEffect:
-		if (sIsTriggerEffectActive) {
-			sIsTriggerEffectActive = false;
-
-			k_timer_stop(&sTriggerEffectTimer);
-
-			Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Set(false);
-		}
-		break;
-	default:
-		LOG_ERR("Received invalid effect identifier.");
-		break;
-	}
-}
-
 CHIP_ERROR AppTask::RestoreBridgedDevices()
 {
 	uint8_t count;
@@ -289,8 +227,7 @@ CHIP_ERROR AppTask::Init()
 	ReturnErrorOnFailure(Nrf::Matter::RegisterEventHandler(AppFactoryResetHandler, 0));
 #endif
 
-	/* Initialize trigger effect timer */
-	k_timer_init(&sTriggerEffectTimer, &AppTask::TriggerEffectTimerTimeoutCallback, nullptr);
+	ReturnErrorOnFailure(sIdentifyCluster.Init());
 
 	return Nrf::Matter::StartServer();
 }

applications/matter_weather_station/src/app_task.cpp

@@ -13,13 +13,15 @@
 #include "app/task_executor.h"
 #include "board/board.h"
 #include "board/led_widget.h"
+#include "clusters/identify.h"
 
 #ifdef CONFIG_MCUMGR_TRANSPORT_BT
 #include "dfu/smp/dfu_over_smp.h"
 #endif
 
 #include <app-common/zap-generated/attributes/Accessors.h>
 #include <app-common/zap-generated/cluster-objects.h>
+#include <app/DefaultTimerDelegate.h>
 #include <app/server/Server.h>
 #include <setup_payload/OnboardingCodesUtil.h>
 
@@ -76,13 +78,45 @@ k_timer sIdentifyTimer;
 
 const device *sBme688SensorDev = DEVICE_DT_GET_ONE(bosch_bme680);
 
-/* Add identify for all endpoints */
-Identify sIdentifyTemperature = { chip::EndpointId{ kTemperatureMeasurementEndpointId }, AppTask::OnIdentifyStart,
-				  AppTask::OnIdentifyStop, Clusters::Identify::IdentifyTypeEnum::kAudibleBeep };
-Identify sIdentifyHumidity = { chip::EndpointId{ kHumidityMeasurementEndpointId }, AppTask::OnIdentifyStart,
-			       AppTask::OnIdentifyStop, Clusters::Identify::IdentifyTypeEnum::kAudibleBeep };
-Identify sIdentifyPressure = { chip::EndpointId{ kPressureMeasurementEndpointId }, AppTask::OnIdentifyStart,
-			       AppTask::OnIdentifyStop, Clusters::Identify::IdentifyTypeEnum::kAudibleBeep };
+class IdentifyDelegateImplWeatherStation : public chip::app::Clusters::IdentifyDelegate {
+public:
+	void OnIdentifyStart(chip::app::Clusters::IdentifyCluster &cluster) override
+	{
+		Nrf::PostTask([] {
+			Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Blink(Nrf::LedConsts::kIdentifyBlinkRate_ms);
+			k_timer_start(&sIdentifyTimer, K_MSEC(kIdentifyTimerIntervalMs),
+				      K_MSEC(kIdentifyTimerIntervalMs));
+			BuzzerSetState(true);
+		});
+	}
+
+	void OnIdentifyStop(chip::app::Clusters::IdentifyCluster &cluster) override
+	{
+		Nrf::PostTask([] {
+			Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Set(false);
+			k_timer_stop(&sIdentifyTimer);
+			BuzzerSetState(false);
+		});
+	}
+
+	void OnTriggerEffect(chip::app::Clusters::IdentifyCluster &cluster) override
+	{
+		Nrf::PostTask([] { BuzzerToggleState(); });
+	}
+
+	bool IsTriggerEffectEnabled() const override { return true; }
+};
+
+IdentifyDelegateImplWeatherStation sIdentifyDelegateImplWeatherStation;
+DefaultTimerDelegate sTimerDelegate;
+
+Nrf::Matter::IdentifyCluster sIdentifyTemperature(kTemperatureMeasurementEndpointId,
+						  sIdentifyDelegateImplWeatherStation, sTimerDelegate,
+						  Clusters::Identify::IdentifyTypeEnum::kAudibleBeep);
+Nrf::Matter::IdentifyCluster sIdentifyHumidity(kHumidityMeasurementEndpointId, sIdentifyDelegateImplWeatherStation,
+					       sTimerDelegate, Clusters::Identify::IdentifyTypeEnum::kAudibleBeep);
+Nrf::Matter::IdentifyCluster sIdentifyPressure(kPressureMeasurementEndpointId, sIdentifyDelegateImplWeatherStation,
+					       sTimerDelegate, Clusters::Identify::IdentifyTypeEnum::kAudibleBeep);
 
 } /* namespace */
 
@@ -91,19 +125,6 @@ void AppTask::MeasurementsTimerHandler()
 	Instance().UpdateClustersState();
 }
 
-void AppTask::OnIdentifyStart(Identify *)
-{
-	Nrf::PostTask(
-		[] { Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Blink(Nrf::LedConsts::kIdentifyBlinkRate_ms); });
-	k_timer_start(&sIdentifyTimer, K_MSEC(kIdentifyTimerIntervalMs), K_MSEC(kIdentifyTimerIntervalMs));
-}
-
-void AppTask::OnIdentifyStop(Identify *)
-{
-	k_timer_stop(&sIdentifyTimer);
-	BuzzerSetState(false);
-}
-
 void AppTask::IdentifyTimerHandler()
 {
 	BuzzerToggleState();
@@ -383,6 +404,10 @@ CHIP_ERROR AppTask::Init()
 		return chip::System::MapErrorZephyr(ret);
 	}
 
+	ReturnErrorOnFailure(sIdentifyTemperature.Init());
+	ReturnErrorOnFailure(sIdentifyHumidity.Init());
+	ReturnErrorOnFailure(sIdentifyPressure.Init());
+
 	/* Initialize timers */
 	k_timer_init(
 		&sMeasurementsTimer, [](k_timer *) { Nrf::PostTask([] { MeasurementsTimerHandler(); }); }, nullptr);

applications/matter_weather_station/src/app_task.h

@@ -8,7 +8,6 @@
 
 #include "board/led_widget.h"
 
-#include <app/clusters/identify-server/identify-server.h>
 #include <platform/CHIPDeviceLayer.h>
 
 class AppTask {
@@ -22,8 +21,6 @@ class AppTask {
 	CHIP_ERROR StartApp();
 
 	void UpdateClustersState();
-	static void OnIdentifyStart(Identify *);
-	static void OnIdentifyStop(Identify *);
 	static void UpdateLedState();
 
 private:

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -330,6 +330,7 @@ Matter bridge
     To fix this, you need to disable storing the Wi-Fi firmware patch in external memory.
     See the :ref:`migration guide <migration_3.2_required>` for more information.
   * By moving code from :file:`samples/matter/common/src/bridge` to :file:`applications/matter_bridge/src/core` and :file:`applications/matter_bridge/src/ble` directories.
+  * The Identify cluster implementation in the application to use the code-driven approach instead of the zap-driven approach.
 
 nRF5340 Audio
 -------------
@@ -423,7 +424,7 @@ nRF Machine Learning (Edge Impulse)
 Thingy:53: Matter weather station
 ---------------------------------
 
-|no_changes_yet_note|
+* Updated the application to use the code-driven approach for the Identify cluster implementation instead of the zap-driven approach.
 
 Samples
 =======
@@ -743,6 +744,7 @@ Matter samples
     See the :ref:`migration guide <migration_3.2_required>` for more information.
   * All Matter samples that support low-power mode to use the :ref:`lib_ram_pwrdn` feature with the nRF54LM20 DK.
     This change resulted in decreasing the sleep current consumption by more than two uA.
+  * All Matter samples to use the code-driven approach for the Identify cluster implementation instead of the zap-driven approach.
 
 * :ref:`matter_lock_sample` sample:
 

samples/matter/closure/src/app_task.cpp

@@ -11,9 +11,10 @@
 #include "board/board.h"
 #include "closure_control_endpoint.h"
 #include "closure_manager.h"
+#include "clusters/identify.h"
+
 #include "lib/core/CHIPError.h"
 #include "lib/support/CodeUtils.h"
-
 #include <app-common/zap-generated/ids/Attributes.h>
 #include <app-common/zap-generated/ids/Clusters.h>
 #include <app/data-model/Nullable.h>
@@ -29,7 +30,15 @@ using namespace ::chip::app;
 using namespace ::chip::DeviceLayer;
 using namespace chip::app::Clusters::Descriptor;
 
-static const struct pwm_dt_spec sPhysicalIndicatorPwmDevice = PWM_DT_SPEC_GET(DT_ALIAS(pwm_led1));
+namespace
+{
+const struct pwm_dt_spec sPhysicalIndicatorPwmDevice = PWM_DT_SPEC_GET(DT_ALIAS(pwm_led1));
+
+constexpr chip::EndpointId kClosureEndpoint = 1;
+
+/* TODO: Add a custom identify delegate to handle the custom identify stop behavior according to the closure state */
+Nrf::Matter::IdentifyCluster sIdentifyCluster(kClosureEndpoint);
+} // namespace
 
 AppTask::AppTask() : mPhysicalDevice(&sPhysicalIndicatorPwmDevice), mClosureManager(mPhysicalDevice, kClosureEndpoint)
 {
@@ -48,6 +57,8 @@ CHIP_ERROR AppTask::Init()
 
 	ReturnErrorOnFailure(Nrf::Matter::StartServer());
 
+	ReturnErrorOnFailure(sIdentifyCluster.Init());
+
 	ReturnErrorOnFailure(mClosureManager.Init());
 	return CHIP_NO_ERROR;
 }

samples/matter/closure/src/app_task.h

@@ -7,8 +7,6 @@
 #include "closure_manager.h"
 #include "garage_door_impl.h"
 
-static constexpr chip::EndpointId kClosureEndpoint = 1;
-
 class AppTask {
 public:
 	AppTask();

samples/matter/common/src/board/board.cpp

@@ -68,6 +68,8 @@ bool Board::Init(button_handler_t buttonHandler, LedStateHandler ledStateHandler
 			.cb = Nrf::Matter::Certification::ButtonHandler,
 		};
 		dk_button_handler_add(&handler);
+
+		Nrf::Matter::Certification::Init();
 	}
 #endif
 

samples/matter/common/src/board/board_consts.h

@@ -25,6 +25,8 @@ namespace Nrf
 
 	namespace LedConsts
 	{
+		constexpr uint32_t kTriggerEffectStart_ms = 5000;
+		constexpr uint32_t kTriggerEffectFinish_ms = 1000;
 		constexpr uint32_t kBlinkRate_ms{ 500 };
 		constexpr uint32_t kIdentifyBlinkRate_ms{ 500 };
 		namespace StatusLed