[app] add binding cluster support (#12981)

* [app] add binding cluster support The change adds `BindingManager` class for managing the connections to bound devices and forward events on bound clusters to the application. * fix review comments & add docs * decouple client from server attributes * Use interaction engine to send On/Off commands * add group to the callback signature * fix review comments * add docs for binding callback arguments * fix unbind * modify callback signature * make BindingManager instance optional * Modify struct layout to save RAM
project-chip · Nov 20, 2023 · 1062803 · 1062803
1 parent 1bfdd59
commit 1062803
Show file tree

Hide file tree

Showing 16 changed files with 671 additions and 45 deletions.
diff --git a/examples/all-clusters-app/all-clusters-common/include/binding-handler.h b/examples/all-clusters-app/all-clusters-common/include/binding-handler.h
@@ -0,0 +1,22 @@
+/*
+ *
+ *    Copyright (c) 2021 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 "lib/core/CHIPError.h"
+
+CHIP_ERROR InitBindingHandlers();
diff --git a/examples/all-clusters-app/all-clusters-common/src/binding-handler.cpp b/examples/all-clusters-app/all-clusters-common/src/binding-handler.cpp
@@ -0,0 +1,112 @@
+/*
+ *
+ *    Copyright (c) 2021 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 "binding-handler.h"
+
+#include "app-common/zap-generated/ids/Clusters.h"
+#include "app-common/zap-generated/ids/Commands.h"
+#include "app/CommandSender.h"
+#include "app/clusters/bindings/BindingManager.h"
+#include "app/server/Server.h"
+#include "controller/InvokeInteraction.h"
+#include "lib/core/CHIPError.h"
+
+#if defined(ENABLE_CHIP_SHELL)
+#include "lib/shell/Engine.h"
+
+using chip::Shell::Engine;
+using chip::Shell::shell_command_t;
+using chip::Shell::streamer_get;
+using chip::Shell::streamer_printf;
+#endif // defined(ENABLE_CHIP_SHELL)
+
+static bool sSwitchOnOffState = false;
+#if defined(ENABLE_CHIP_SHELL)
+static void ToggleSwitchOnOff(bool newState)
+{
+    sSwitchOnOffState = newState;
+    chip::BindingManager::GetInstance().NotifyBoundClusterChanged(1, chip::app::Clusters::OnOff::Id, nullptr);
+}
+
+static CHIP_ERROR SwitchCommandHandler(int argc, char ** argv)
+{
+    if (argc == 1 && strcmp(argv[0], "on") == 0)
+    {
+        ToggleSwitchOnOff(true);
+        return CHIP_NO_ERROR;
+    }
+    if (argc == 1 && strcmp(argv[0], "off") == 0)
+    {
+        ToggleSwitchOnOff(false);
+        return CHIP_NO_ERROR;
+    }
+    streamer_printf(streamer_get(), "Usage: switch [on|off]");
+    return CHIP_NO_ERROR;
+}
+
+static void RegisterSwitchCommands()
+{
+    static const shell_command_t sSwitchCommand = { SwitchCommandHandler, "switch", "Switch commands. Usage: switch [on|off]" };
+    Engine::Root().RegisterCommands(&sSwitchCommand, 1);
+    return;
+}
+#endif // defined(ENABLE_CHIP_SHELL)
+
+static void BoundDeviceChangedHandler(const EmberBindingTableEntry * binding, chip::DeviceProxy * peer_device, void * context)
+{
+    using namespace chip;
+    using namespace chip::app;
+
+    if (binding->type == EMBER_MULTICAST_BINDING)
+    {
+        ChipLogError(NotSpecified, "Group binding is not supported now");
+        return;
+    }
+
+    if (binding->type == EMBER_UNICAST_BINDING && binding->local == 1 && binding->clusterId == Clusters::OnOff::Id)
+    {
+        auto onSuccess = [](const ConcreteCommandPath & commandPath, const StatusIB & status, const auto & dataResponse) {
+            ChipLogProgress(NotSpecified, "OnOff command succeeds");
+        };
+        auto onFailure = [](const StatusIB & status, CHIP_ERROR error) {
+            ChipLogError(NotSpecified, "OnOff command failed: %" CHIP_ERROR_FORMAT, error.Format());
+        };
+
+        if (sSwitchOnOffState)
+        {
+            Clusters::OnOff::Commands::On::Type onCommand;
+            Controller::InvokeCommandRequest(peer_device->GetExchangeManager(), peer_device->GetSecureSession().Value(),
+                                             binding->remote, onCommand, onSuccess, onFailure);
+        }
+        else
+        {
+            Clusters::OnOff::Commands::Off::Type offCommand;
+            Controller::InvokeCommandRequest(peer_device->GetExchangeManager(), peer_device->GetSecureSession().Value(),
+                                             binding->remote, offCommand, onSuccess, onFailure);
+        }
+    }
+}
+
+CHIP_ERROR InitBindingHandlers()
+{
+    chip::BindingManager::GetInstance().SetAppServer(&chip::Server::GetInstance());
+    chip::BindingManager::GetInstance().RegisterBoundDeviceChangedHandler(BoundDeviceChangedHandler);
+#if defined(ENABLE_CHIP_SHELL)
+    RegisterSwitchCommands();
+#endif
+    return CHIP_NO_ERROR;
+}
diff --git a/examples/all-clusters-app/esp32/main/main.cpp b/examples/all-clusters-app/esp32/main/main.cpp
@@ -61,6 +61,7 @@
 #include <app/server/Server.h>
 #include <app/util/af-types.h>
 #include <app/util/af.h>
+#include <binding-handler.h>
 #include <credentials/DeviceAttestationCredsProvider.h>
 #include <credentials/examples/DeviceAttestationCredsExample.h>
 #include <lib/shell/Engine.h>
@@ -537,6 +538,7 @@ static void InitServer(intptr_t context)
     SetDeviceAttestationCredentialsProvider(Examples::GetExampleDACProvider());
     NetWorkCommissioningInstInit();
     SetupPretendDevices();
+    InitBindingHandlers();
 }
 
 static void InitOTARequestor(void)

diff --git a/examples/all-clusters-app/linux/BUILD.gn b/examples/all-clusters-app/linux/BUILD.gn
@@ -15,8 +15,11 @@
 import("//build_overrides/build.gni")
 import("//build_overrides/chip.gni")
 
+import("${chip_root}/src/lib/lib.gni")
+
 executable("chip-all-clusters-app") {
   sources = [
+    "${chip_root}/examples/all-clusters-app/all-clusters-common/src/binding-handler.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/bridged-actions-stub.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/static-supported-modes-manager.cpp",
     "include/tv-callbacks.cpp",
@@ -35,6 +38,10 @@ executable("chip-all-clusters-app") {
 
   cflags = [ "-Wconversion" ]
 
+  if (chip_build_libshell) {
+    defines = [ "ENABLE_CHIP_SHELL" ]
+  }
+
   output_dir = root_out_dir
 }
 

diff --git a/examples/all-clusters-app/linux/main.cpp b/examples/all-clusters-app/linux/main.cpp
@@ -24,6 +24,7 @@
 #include <platform/Linux/NetworkCommissioningDriver.h>
 
 #include "AppMain.h"
+#include "binding-handler.h"
 
 using namespace chip;
 using namespace chip::app;
@@ -110,6 +111,7 @@ void ApplicationInit()
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv) == 0);
+    VerifyOrDie(InitBindingHandlers() == CHIP_NO_ERROR);
     ChipLinuxAppMainLoop();
     return 0;
 }

diff --git a/examples/all-clusters-app/mbed/CMakeLists.txt b/examples/all-clusters-app/mbed/CMakeLists.txt
@@ -86,6 +86,7 @@ target_sources(${APP_TARGET} PRIVATE
 
                ${APP_CLUSTERS}/application-basic-server/application-basic-server.cpp
                ${APP_CLUSTERS}/basic/basic.cpp
+               ${APP_CLUSTERS}/bindings/BindingManager.cpp
                ${APP_CLUSTERS}/bindings/bindings.cpp
                ${APP_CLUSTERS}/on-off-server/on-off-server.cpp
                ${APP_CLUSTERS}/access-control-server/access-control-server.cpp

diff --git a/examples/lighting-app/mbed/CMakeLists.txt b/examples/lighting-app/mbed/CMakeLists.txt
@@ -74,6 +74,7 @@ target_sources(${APP_TARGET} PRIVATE
                ${CHIP_ROOT}/src/app/server/CommissioningWindowManager.cpp
                ${CHIP_ROOT}/src/app/clusters/administrator-commissioning-server/administrator-commissioning-server.cpp
                ${CHIP_ROOT}/src/app/clusters/basic/basic.cpp
+               ${CHIP_ROOT}/src/app/clusters/bindings/BindingManager.cpp
                ${CHIP_ROOT}/src/app/clusters/bindings/bindings.cpp
                ${CHIP_ROOT}/src/app/clusters/descriptor/descriptor.cpp
                ${CHIP_ROOT}/src/app/clusters/identify-server/identify-server.cpp

diff --git a/examples/lighting-app/telink/CMakeLists.txt b/examples/lighting-app/telink/CMakeLists.txt
@@ -73,6 +73,7 @@ target_sources(app PRIVATE
                ${CHIP_ROOT}/src/app/server/CommissioningWindowManager.cpp
                ${CHIP_ROOT}/src/app/clusters/administrator-commissioning-server/administrator-commissioning-server.cpp
                ${CHIP_ROOT}/src/app/clusters/basic/basic.cpp
+               ${CHIP_ROOT}/src/app/clusters/bindings/BindingManager.cpp
                ${CHIP_ROOT}/src/app/clusters/bindings/bindings.cpp
                ${CHIP_ROOT}/src/app/clusters/descriptor/descriptor.cpp
                ${CHIP_ROOT}/src/app/clusters/identify-server/identify-server.cpp

diff --git a/examples/lock-app/mbed/CMakeLists.txt b/examples/lock-app/mbed/CMakeLists.txt
@@ -72,6 +72,7 @@ target_sources(${APP_TARGET} PRIVATE
                ${CHIP_ROOT}/src/app/server/CommissioningWindowManager.cpp
                ${CHIP_ROOT}/src/app/clusters/administrator-commissioning-server/administrator-commissioning-server.cpp
                ${CHIP_ROOT}/src/app/clusters/basic/basic.cpp
+               ${CHIP_ROOT}/src/app/clusters/bindings/BindingManager.cpp
                ${CHIP_ROOT}/src/app/clusters/bindings/bindings.cpp
                ${CHIP_ROOT}/src/app/clusters/descriptor/descriptor.cpp
                ${CHIP_ROOT}/src/app/clusters/diagnostic-logs-server/diagnostic-logs-server.cpp

diff --git a/examples/platform/linux/AppMain.cpp b/examples/platform/linux/AppMain.cpp
@@ -397,6 +397,7 @@ DeviceCommissioner * GetDeviceCommissioner()
 void ChipLinuxAppMainLoop()
 {
 #if defined(ENABLE_CHIP_SHELL)
+    Engine::Root().Init();
     std::thread shellThread([]() { Engine::Root().RunMainLoop(); });
     chip::Shell::RegisterCommissioneeCommands();
 #endif

diff --git a/src/app/CASESessionManager.cpp b/src/app/CASESessionManager.cpp
@@ -55,7 +55,8 @@ CHIP_ERROR CASESessionManager::FindOrEstablishSession(PeerId peerId, Callback::C
     CHIP_ERROR err = session->Connect(onConnection, onFailure, mConfig.dnsResolver);
     if (err != CHIP_NO_ERROR)
     {
-        ReleaseSession(session);
+        // Release the peer rather than the pointer in case the failure handler has already released the session.
+        ReleaseSession(peerId);
     }
 
     return err;

diff --git a/src/app/chip_data_model.gni b/src/app/chip_data_model.gni
@@ -154,6 +154,12 @@ template("chip_data_model") {
           "${_app_root}/clusters/${cluster}/BDXDownloader.h",
           "${_app_root}/clusters/${cluster}/OTARequestor.cpp",
         ]
+      } else if (cluster == "bindings") {
+        sources += [
+          "${_app_root}/clusters/${cluster}/${cluster}.cpp",
+          "${_app_root}/clusters/${cluster}/BindingManager.cpp",
+          "${_app_root}/clusters/${cluster}/BindingManager.h",
+        ]
       } else {
         sources += [ "${_app_root}/clusters/${cluster}/${cluster}.cpp" ]
       }