Code Driven All Devices Example App

.github/workflows/tests.yaml

@@ -665,6 +665,15 @@ jobs:
                   && rm -rf out/linux-x64-all-clusters-${BUILD_VARIANT}-tsan-clang-test
                   "
 
+            - name: Build linux-x64-all-devices-app
+              env:
+                  CCACHE_DIR: "${{ github.workspace }}/.ccache"
+              run: >-
+                  ./scripts/run_in_build_env.sh "./scripts/build/build_examples.py
+                  --target linux-x64-all-devices-app-tsan-clang-test
+                  --pw-command-launcher=ccache build --copy-artifacts-to objdir-clone
+                  && rm -rf out/linux-x64-all-devices-app-tsan-clang-test"
+
             - name: Build linux-x64-lit-icd
               env:
                   CCACHE_DIR: "${{ github.workspace }}/.ccache"
@@ -806,6 +815,7 @@ jobs:
               run: |
                   echo -n "" >/tmp/test_env.yaml
                   echo "ALL_CLUSTERS_APP: objdir-clone/linux-x64-all-clusters-${BUILD_VARIANT}-tsan-clang-test/chip-all-clusters-app" >> /tmp/test_env.yaml
+                  echo "ALL_DEVICES_APP: objdir-clone/linux-x64-all-devices-app-tsan-clang-test/all-devices-app" >> /tmp/test_env.yaml
                   echo "BRIDGE_APP: objdir-clone/linux-x64-bridge-${BUILD_VARIANT}-tsan-clang-test-unified/chip-bridge-app" >> /tmp/test_env.yaml
                   echo "CHIP_LOCK_APP: objdir-clone/linux-x64-lock-${BUILD_VARIANT}-tsan-clang-test-unified/chip-lock-app" >> /tmp/test_env.yaml
                   echo "CAMERA_APP: objdir-clone/linux-x64-camera/chip-camera-app" >> /tmp/test_env.yaml

examples/all-devices-app/all-devices-common/devices/BUILD.gn

@@ -0,0 +1,18 @@
+# Copyright (c) 2025 Project CHIP Authors
+#
+# 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.
+
+config("includes") {
+  # allows includes like "devices/..."
+  include_dirs = [ ".." ]
+}

examples/all-devices-app/all-devices-common/devices/boolean-state-sensor/BUILD.gn

@@ -0,0 +1,37 @@
+# Copyright (c) 2025 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/build.gni")
+import("//build_overrides/chip.gni")
+
+source_set("boolean-state-sensor") {
+  sources = [
+    "BooleanStateSensorDevice.cpp",
+    "BooleanStateSensorDevice.h",
+  ]
+
+  public_deps = [
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/interface:single-endpoint-device",
+    "${chip_root}/src/app/clusters/boolean-state-server",
+    "${chip_root}/src/app/clusters/identify-server",
+    "${chip_root}/src/data-model-providers/codedriven",
+    "${chip_root}/src/lib/core:error",
+    "${chip_root}/src/lib/support",
+  ]
+
+  public_configs = [
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/:includes",
+    "${chip_root}/src:includes",
+  ]
+}

examples/all-devices-app/all-devices-common/devices/boolean-state-sensor/BooleanStateSensorDevice.cpp

@@ -0,0 +1,52 @@
+/*
+ *
+ *    Copyright (c) 2025 Project CHIP Authors
+ *
+ *    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.
+ */
+#include <devices/boolean-state-sensor/BooleanStateSensorDevice.h>
+
+using namespace chip::app::Clusters;
+
+namespace chip::app {
+
+CHIP_ERROR BooleanStateSensorDevice::Register(chip::EndpointId endpoint, CodeDrivenDataModelProvider & provider,
+                                              EndpointId parentId)
+{
+    ReturnErrorOnFailure(SingleEndpointRegistration(endpoint, provider, parentId));
+
+    mIdentifyCluster.Create(IdentifyCluster::Config(endpoint, *mTimerDelegate));
+    ReturnErrorOnFailure(provider.AddCluster(mIdentifyCluster.Registration()));
+
+    mBooleanStateCluster.Create(endpoint);
+    ReturnErrorOnFailure(provider.AddCluster(mBooleanStateCluster.Registration()));
+
+    return provider.AddEndpoint(mEndpointRegistration);
+}
+
+void BooleanStateSensorDevice::UnRegister(CodeDrivenDataModelProvider & provider)
+{
+    SingleEndpointUnregistration(provider);
+    if (mBooleanStateCluster.IsConstructed())
+    {
+        provider.RemoveCluster(&mBooleanStateCluster.Cluster());
+        mBooleanStateCluster.Destroy();
+    }
+    if (mIdentifyCluster.IsConstructed())
+    {
+        provider.RemoveCluster(&mIdentifyCluster.Cluster());
+        mIdentifyCluster.Destroy();
+    }
+}
+
+} // namespace chip::app

examples/all-devices-app/all-devices-common/devices/boolean-state-sensor/BooleanStateSensorDevice.h

@@ -0,0 +1,56 @@
+/*
+ *
+ *    Copyright (c) 2025 Project CHIP Authors
+ *
+ *    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 <app/clusters/boolean-state-server/boolean-state-cluster.h>
+#include <app/clusters/identify-server/IdentifyCluster.h>
+#include <app/reporting/ReportScheduler.h>
+#include <devices/interface/SingleEndpointDevice.h>
+#include <memory>
+
+namespace chip {
+namespace app {
+
+class BooleanStateSensorDevice : public SingleEndpointDevice
+{
+public:
+    /// This is a general class for boolean state sensor devices. The device type passed here will
+    /// determine the type of sensor it is (contact, water leak, etc.) This is meant to be a reusable
+    /// class for the sensor types that share the same core functionality through the identify and
+    /// boolean state clusters. The caller creating a BooleanStateSensorDevice MUST ensure that the underlying
+    /// data for the Span of deviceTypes remains valid for the entire liefetime of the BooleanStateSensorDevice object instance.
+    BooleanStateSensorDevice(reporting::ReportScheduler::TimerDelegate * timerDelegate,
+                             Span<const DataModel::DeviceTypeEntry> deviceType) :
+        SingleEndpointDevice(deviceType),
+        mTimerDelegate(timerDelegate)
+    {}
+    ~BooleanStateSensorDevice() override = default;
+
+    CHIP_ERROR Register(chip::EndpointId endpoint, CodeDrivenDataModelProvider & provider,
+                        EndpointId parentId = kInvalidEndpointId) override;
+    void UnRegister(CodeDrivenDataModelProvider & provider) override;
+
+    Clusters::BooleanStateCluster & BooleanState() { return mBooleanStateCluster.Cluster(); }
+
+private:
+    reporting::ReportScheduler::TimerDelegate * mTimerDelegate;
+    LazyRegisteredServerCluster<Clusters::IdentifyCluster> mIdentifyCluster;
+    LazyRegisteredServerCluster<Clusters::BooleanStateCluster> mBooleanStateCluster;
+};
+
+} // namespace app
+} // namespace chip

examples/all-devices-app/all-devices-common/devices/device-factory/BUILD.gn

@@ -0,0 +1,31 @@
+# Copyright (c) 2025 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/build.gni")
+import("//build_overrides/chip.gni")
+
+source_set("device-factory") {
+  sources = [ "DeviceFactory.h" ]
+
+  public_deps = [
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/boolean-state-sensor",
+    "${chip_root}/src/lib/core:error",
+    "${chip_root}/zzz_generated/app-common/devices/",
+  ]
+
+  public_configs = [
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/:includes",
+    "${chip_root}/src:includes",
+  ]
+}

examples/all-devices-app/all-devices-common/devices/device-factory/DeviceFactory.h

@@ -0,0 +1,83 @@
+/*
+ *
+ *    Copyright (c) 2025 Project CHIP Authors
+ *
+ *    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 <app/TimerDelegates.h>
+#include <devices/Types.h>
+#include <devices/boolean-state-sensor/BooleanStateSensorDevice.h>
+#include <functional>
+#include <lib/core/CHIPError.h>
+#include <map>
+
+namespace chip::app {
+
+/**
+ * This is a factory class made to be used to create any valid device type as part of the
+ * all-devices-app. This class is meant to abstract away some details of device specific code,
+ * and to have more generic implementation code being used in main to create a device. The keys
+ * in the device registry map are the command line arguments used to start the respective device.
+ * Create devices by fetching the instance of this class and passing in the device type argument
+ * i.e. DeviceFactory::GetInstance().Create(deviceTypeName)
+ */
+class DeviceFactory
+{
+public:
+    using DeviceCreator = std::function<std::unique_ptr<DeviceInterface>()>;
+
+    static DeviceFactory & GetInstance()
+    {
+        static DeviceFactory instance;
+        return instance;
+    }
+
+    bool IsValidDevice(const std::string & deviceTypeArg) { return mRegistry.find(deviceTypeArg) != mRegistry.end(); }
+
+    std::unique_ptr<DeviceInterface> Create(const std::string & deviceTypeArg)
+    {
+        if (IsValidDevice(deviceTypeArg))
+        {
+            return mRegistry.find(deviceTypeArg)->second();
+        }
+        else
+        {
+            ChipLogError(
+                Support,
+                "INTERNAL ERROR: Invalid device type: %s. Run with the --help argument to view the list of valid device types.\n",
+                deviceTypeArg.c_str());
+        }
+        return nullptr;
+    }
+
+private:
+    std::map<std::string, DeviceCreator> mRegistry;
+    DefaultTimerDelegate timer;
+
+    DeviceFactory()
+    {
+        mRegistry["contact-sensor"] = [this]() {
+            return std::make_unique<BooleanStateSensorDevice>(
+                &timer, Span<const DataModel::DeviceTypeEntry>(&Device::Type::kContactSensor, 1));
+        };
+        mRegistry["water-leak-detector"] = [this]() {
+            return std::make_unique<BooleanStateSensorDevice>(
+                &timer, Span<const DataModel::DeviceTypeEntry>(&Device::Type::kWaterLeakDetector, 1));
+        };
+    }
+};
+
+} // namespace chip::app

examples/all-devices-app/all-devices-common/devices/interface/BUILD.gn

@@ -0,0 +1,55 @@
+# Copyright (c) 2025 Project CHIP Authors
+#
+# 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.
+
+import("//build_overrides/build.gni")
+import("//build_overrides/chip.gni")
+
+source_set("device-interface") {
+  sources = [
+    "DeviceInterface.cpp",
+    "DeviceInterface.h",
+  ]
+
+  public_deps = [
+    "${chip_root}/src/app/clusters/descriptor",
+    "${chip_root}/src/data-model-providers/codedriven",
+    "${chip_root}/src/lib/core:error",
+    "${chip_root}/src/lib/support",
+  ]
+
+  public_configs = [
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/:includes",
+    "${chip_root}/src:includes",
+  ]
+}
+
+source_set("single-endpoint-device") {
+  sources = [
+    "SingleEndpointDevice.cpp",
+    "SingleEndpointDevice.h",
+  ]
+
+  public_deps = [
+    ":device-interface",
+    "${chip_root}/src/app/clusters/descriptor",
+    "${chip_root}/src/data-model-providers/codedriven",
+    "${chip_root}/src/lib/core:error",
+    "${chip_root}/src/lib/support",
+  ]
+
+  public_configs = [
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/:includes",
+    "${chip_root}/src:includes",
+  ]
+}