Ability to create out-of-tree MEI clusters

.github/workflows/examples-nrfconnect.yaml

@@ -193,6 +193,13 @@ jobs:
                     nrfconnect nrf7002dk_nrf5340_cpuapp all-clusters-app \
                     examples/all-clusters-app/nrfconnect/build/nrfconnect/zephyr/zephyr.elf \
                     /tmp/bloat_reports/
+            - name: Build example nRF Connect SDK Manufacturer Specific App on nRF52840 DK
+              run: |
+                  scripts/examples/nrfconnect_example.sh manufacturer-specific-app nrf52840dk/nrf52840
+                  .environment/pigweed-venv/bin/python3 scripts/tools/memory/gh_sizes.py \
+                    nrfconnect nrf52840dk_nrf52840 manufacturer-specific-app \
+                    examples/manufacturer-specific-app/nrfconnect/build/nrfconnect/zephyr/zephyr.elf \
+                    /tmp/bloat_reports/
             - name: Run unit tests for Zephyr native_posix_64 platform
               if: github.event_name == 'push' || steps.changed_paths.outputs.tests == 'true' || steps.changed_paths.outputs.nrfconnect == 'true'
               run: |

.github/workflows/lint.yml

@@ -277,7 +277,14 @@ jobs:
                   type-safe getters
               if: always()
               run: |
-                  git grep -I -n 'emberAfReadAttribute' -- './*' ':(exclude).github/workflows/lint.yml' ':(exclude)src/app/util/attribute-table.h' ':(exclude)zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' ':(exclude)src/app/zap-templates/templates/app/attributes/Accessors-src.zapt' ':(exclude)src/app/util/attribute-table.cpp'  && exit 1 || exit 0
+                  git grep -I -n 'emberAfReadAttribute' -- './*'                                             \
+                      ':(exclude).github/workflows/lint.yml'                                                 \
+                      ':(exclude)src/app/util/attribute-table.h'                                             \
+                      ':(exclude)zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' \
+                      ':(exclude)examples/manufacturer-specific-app/nrfconnect/manufacturer-specific/zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' \
+                      ':(exclude)src/app/zap-templates/templates/app/attributes/Accessors-src.zapt'          \
+                      ':(exclude)src/app/util/attribute-table.cpp'                                           \
+                      && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
@@ -292,15 +299,16 @@ jobs:
                   git grep -I -n 'emberAfWriteAttribute' -- './*'                                            \
                       ':(exclude).github/workflows/lint.yml'                                                 \
                       ':(exclude)examples/common/pigweed/rpc_services/Attributes.h'                          \
-                      ':(exclude)src/data-model-providers/codegen/CodegenDataModelProvider_Write.cpp'     \
-                      ':(exclude)src/data-model-providers/codegen/tests/EmberReadWriteOverride.cpp'       \
+                      ':(exclude)src/data-model-providers/codegen/CodegenDataModelProvider_Write.cpp'        \
+                      ':(exclude)src/data-model-providers/codegen/tests/EmberReadWriteOverride.cpp'          \
                       ':(exclude)src/app/dynamic_server/DynamicDispatcher.cpp'                               \
                       ':(exclude)src/app/util/attribute-table.cpp'                                           \
                       ':(exclude)src/app/util/attribute-table.h'                                             \
                       ':(exclude)src/app/util/mock/CodegenEmberMocks.cpp'                                    \
                       ':(exclude)src/app/zap-templates/templates/app/attributes/Accessors-src.zapt'          \
                       ':(exclude)src/darwin/Framework/CHIP/ServerEndpoint/MTRIMDispatch.mm'                  \
                       ':(exclude)zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' \
+                      ':(exclude)examples/manufacturer-specific-app/nrfconnect/manufacturer-specific/zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' \
                       && exit 1 || exit 0
 
             # Run ruff python linter

.github/workflows/tests.yaml

@@ -210,7 +210,7 @@ jobs:
                       src/app/zap-templates/zcl/data-model/chip/temperature-control-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/matter-devices.xml \
                       src/app/zap-templates/zcl/data-model/chip/resource-monitoring-cluster.xml \
-                      src/app/zap-templates/zcl/data-model/chip/sample-mei-cluster.xml \
+                      src/app/zap-templates/zcl/data-model/chip/sample-manufacturer-specific-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/electrical-energy-measurement-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/electrical-power-measurement-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/zone-management-cluster.xml \

config/common/cmake/chip_gn.cmake

@@ -164,7 +164,6 @@ macro(matter_build target)
         ${CHIP_ROOT}/third_party/nlassert/repo/include
         ${CHIP_ROOT}/third_party/nlio/repo/include
         ${CHIP_ROOT}/third_party/nlfaultinjection/include
-        ${CHIP_ROOT}/zzz_generated/app-common
         ${CMAKE_CURRENT_BINARY_DIR}/gen/include
     )
 

config/common/cmake/chip_gn_args.cmake

@@ -161,6 +161,7 @@ endmacro()
 #   DEVICE_INFO_EXAMPLE_PROVIDER Add example device info provider support
 #   PROJECT_CONFIG  Path to the project-specific configuration file
 #   PROJECT_CONFIG_INC_DIR  Extra include dirs for project configurations
+#   PROJECT_APP_COMMON_INC_DIR Extra include dir for custom app-common
 #
 macro(matter_common_gn_args)
     set(options)
@@ -171,6 +172,7 @@ macro(matter_common_gn_args)
         LIB_PW_RPC
         DEVICE_INFO_EXAMPLE_PROVIDER
         PROJECT_CONFIG
+        PROJECT_APP_COMMON_INC_DIR
     )
     set(multiValueArgs
         PROJECT_CONFIG_INC_DIR
@@ -215,6 +217,14 @@ macro(matter_common_gn_args)
     if (ARG_PROJECT_CONFIG_INC_DIR)
         matter_add_gn_arg_list("chip_project_config_include_dirs"             ${ARG_PROJECT_CONFIG_INC_DIR})
     endif()
+    if (ARG_PROJECT_APP_COMMON_INC_DIR)
+        get_filename_component(PROJECT_APP_COMMON_INC_DIR
+            ${ARG_PROJECT_APP_COMMON_INC_DIR}
+            REALPATH
+            BASE_DIR ${CMAKE_SOURCE_DIR}
+        )
+        matter_add_gn_arg_string("chip_project_app_common_include_dir"         "${PROJECT_APP_COMMON_INC_DIR}")
+    endif()
 endmacro()
 
 # Generate the temporary GN arguments file from the settings

config/nrfconnect/chip-module/CMakeLists.txt

@@ -115,6 +115,7 @@ matter_common_gn_args(
     LIB_SHELL       CONFIG_CHIP_LIB_SHELL
     LIB_TESTS       CONFIG_CHIP_BUILD_TESTS
     PROJECT_CONFIG  ${CONFIG_CHIP_PROJECT_CONFIG}
+    PROJECT_APP_COMMON_INC_DIR  ${CONFIG_CHIP_PROJECT_APP_COMMON_INCLUDE_DIRS}
     DEVICE_INFO_EXAMPLE_PROVIDER CONFIG_CHIP_EXAMPLE_DEVICE_INFO_PROVIDER
 )
 matter_add_gn_arg_string("zephyr_ar"                              ${CMAKE_AR})

config/telink/chip-module/CMakeLists.txt

@@ -86,6 +86,7 @@ matter_common_gn_args(
     LIB_SHELL       CONFIG_CHIP_LIB_SHELL
     LIB_TESTS       CONFIG_CHIP_BUILD_TESTS
     PROJECT_CONFIG  ${CONFIG_CHIP_PROJECT_CONFIG}
+    PROJECT_APP_COMMON_INC_DIR  ${CONFIG_CHIP_PROJECT_APP_COMMON_INCLUDE_DIRS}
     DEVICE_INFO_EXAMPLE_PROVIDER CONFIG_CHIP_EXAMPLE_DEVICE_INFO_PROVIDER
 )
 matter_add_gn_arg_string("zephyr_ar"                              ${CMAKE_AR})

config/zephyr/Kconfig

@@ -316,6 +316,11 @@ config CHIP_PROJECT_CONFIG
 	  configuration file that can be used to override any of Matter's default or
 	  platform-specific settings.
 
+config  CHIP_PROJECT_APP_COMMON_INCLUDE_DIRS
+	string "Project specific app-common directory for Manufacturer-specific clusters"
+	help
+	  Provides a directory to the app-common/ folder.
+
 # Thread network features
 
 config CHIP_ENABLE_DNSSD_SRP

docs/examples/manufacturer_specific.md

@@ -0,0 +1,8 @@
+## Manufacturer specific cluster
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+manufacturer-specific-app/**/README
+```

docs/ids_and_codes/zap_clusters.md

@@ -139,4 +139,4 @@ Generally regenerate using one of:
 |       1873 |      0x751 | CommissionerControl                                     |
 | 4294048773 | 0xFFF1FC05 | UnitTesting                                             |
 | 4294048774 | 0xFFF1FC06 | FaultInjection                                          |
-| 4294048800 | 0xFFF1FC20 | SampleMei                                               |
+| 4294048800 | 0xFFF1FC20 | SampleManufacturerSpecific                              |

examples/chef/README.md

@@ -235,9 +235,9 @@ To add new devices for chef:
 ## Manufacturer Extensions / Custom Clusters
 
 You may add vendor-defined features to chef. The
-`rootnode_onofflight_meisample*` device showcases its usage by using the Sample
-MEI cluster which is defined on
-`src/app/zap-templates/zcl/data-model/chip/sample-mei-cluster.xml`
+`rootnode_onofflight_manufacturer_specific_sample*` device showcases its usage
+by using the Sample Manufacturer-specific cluster which is defined in
+`src/app/zap-templates/zcl/data-model/chip/sample-manufacturer-specific-cluster.xml`
 
 This cluster has
 
@@ -246,15 +246,16 @@ This cluster has
 -   A command/response pair `add-arguments`. The command takes two uint8
     arguments and the response command returns their sum.
 
-You may test the `Sample MEI` via chip-tool using the following commands:
+You may test the `Sample Manufacturer Specific Cluster` via chip-tool using the
+following commands:
 
 ```
 # commissioning of on-network chef device
 chip-tool pairing onnetwork 1 20202021
 # tests command to sum arguments: returns 30
-chip-tool samplemei add-arguments 1 1 10 20
+chip-tool sample-manufacturer-specific add-arguments 1 1 10 20
 # sets Flip-Flop to false
-chip-tool samplemei write flip-flop 0 1 1
+chip-tool sample-manufacturer-specific write flip-flop 0 1 1
 # reads Flip-Flop
-chip-tool samplemei read flip-flop 1 1
+chip-tool sample-manufacturer-specific read flip-flop 1 1
 ```

examples/chef/devices/rootnode_onofflight_samplemei.matter → examples/chef/devices/rootnode_onofflight_manufacturer_specific_sample.matter

@@ -1755,8 +1755,8 @@ cluster FixedLabel = 64 {
   readonly attribute int16u clusterRevision = 65533;
 }
 
-/** The Sample MEI cluster showcases a cluster manufacturer extensions */
-cluster SampleMei = 4294048800 {
+/** A manufacturer-specific sample cluster */
+cluster SampleManufacturerSpecific = 4294048800 {
   revision 1; // NOTE: Default/not specifically set
 
   fabric_sensitive info event PingCountEvent = 0 {
@@ -2082,7 +2082,7 @@ endpoint 1 {
     callback attribute clusterRevision;
   }
 
-  server cluster SampleMei {
+  server cluster SampleManufacturerSpecific {
     emits event PingCountEvent;
     ram      attribute flipFlop default = false;
     callback attribute generatedCommandList;

examples/chef/devices/rootnode_onofflight_samplemei.zap → examples/chef/devices/rootnode_onofflight_manufacturer_specific_sample.zap

@@ -3258,10 +3258,10 @@
           "enabled": 1
         },
         {
-          "name": "Sample MEI",
+          "name": "Sample Manufacturer-Specific",
           "code": 4294048800,
           "mfgCode": null,
-          "define": "SAMPLE_MEI_CLUSTER",
+          "define": "SAMPLE_MANUFACTURER_SPECIFIC_CLUSTER",
           "side": "server",
           "enabled": 1,
           "commands": [

examples/manufacturer-specific-app/manufacturer-specific-common/BUILD.gn

@@ -0,0 +1,42 @@
+# Copyright (c) 2020 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/chip.gni")
+import("${chip_root}/src/app/chip_data_model.gni")
+
+config("config") {
+  include_dirs = [ "include" ]
+}
+
+chip_data_model("lighting-common") {
+  zap_file = "lighting-app.zap"
+  is_server = true
+}
+
+source_set("color-format") {
+  public_configs = [ ":config" ]
+  sources = [
+    "include/ColorFormat.h",
+    "src/ColorFormat.cpp",
+  ]
+}
+
+source_set("lighting-manager") {
+  deps = [ "${chip_root}/src/lib" ]
+  public_configs = [ ":config" ]
+  sources = [
+    "include/LightingManager.h",
+    "src/LightingManager.cpp",
+  ]
+}

examples/manufacturer-specific-app/manufacturer-specific-common/include/ColorFormat.h

@@ -0,0 +1,50 @@
+/*
+ *
+ *    Copyright (c) 2021 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 <stdint.h>
+
+struct RgbColor_t
+{
+    uint8_t r;
+    uint8_t g;
+    uint8_t b;
+};
+
+struct HsvColor_t
+{
+    uint8_t h;
+    uint8_t s;
+    uint8_t v;
+};
+
+struct XyColor_t
+{
+    uint16_t x;
+    uint16_t y;
+};
+
+struct CtColor_t
+{
+    uint16_t ctMireds;
+};
+
+RgbColor_t XYToRgb(uint8_t Level, uint16_t currentX, uint16_t currentY);
+RgbColor_t HsvToRgb(HsvColor_t hsv);
+RgbColor_t CTToRgb(CtColor_t ct);

examples/manufacturer-specific-app/manufacturer-specific-common/include/LightingManager.h

@@ -0,0 +1,67 @@
+/*
+ *
+ *    Copyright (c) 2020 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 <stdbool.h>
+#include <stdint.h>
+
+#include <functional>
+
+#include <lib/core/CHIPError.h>
+
+class LightingManager
+{
+public:
+    enum Action_t
+    {
+        ON_ACTION = 0,
+        OFF_ACTION,
+        INVALID_ACTION
+    } Action;
+
+    enum State_t
+    {
+        kState_On = 0,
+        kState_Off,
+    } State;
+
+    CHIP_ERROR Init();
+    bool IsTurnedOn();
+    bool InitiateAction(Action_t aAction);
+
+    using LightingCallback_fn = std::function<void(Action_t)>;
+
+    void SetCallbacks(LightingCallback_fn aActionInitiated_CB, LightingCallback_fn aActionCompleted_CB);
+
+private:
+    friend LightingManager & LightingMgr(void);
+    State_t mState;
+
+    LightingCallback_fn mActionInitiated_CB;
+    LightingCallback_fn mActionCompleted_CB;
+
+    void Set(bool aOn);
+
+    static LightingManager sLight;
+};
+
+inline LightingManager & LightingMgr(void)
+{
+    return LightingManager::sLight;
+}