Initial support for adding codegen for interaction model

examples/lighting-app/linux/main.cpp

@@ -182,6 +182,7 @@ int main(int argc, char * argv[])
     chip::app::cluster::OnOff::InitCluster(chip::app::InteractionModelEngine::GetInstance());
 #endif
 
+#if CHIP_DEVICE_CONFIG_ENABLE_WPA
     if (LinuxDeviceOptions::GetInstance().mWiFi)
     {
         chip::DeviceLayer::ConnectivityMgrImpl().StartWiFiManagement();

src/app/chip-zcl-zpro-codec-api.h

@@ -1,6 +1,6 @@
 /*
  *
- *    Copyright (c) 2020 Project CHIP Authors
+ *    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.
@@ -15,6 +15,8 @@
  *    limitations under the License.
  */
 
+// THIS FILE IS GENERATED BY ZAP
+
 // Prevent multiple inclusion
 #pragma once
 

src/app/clusters/on-off-server/on-off-im.cpp

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright (c) 2020 Project CHIP Authors
+ *    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.
@@ -36,17 +36,17 @@ namespace OnOff {
 // TODO: Call handler in on-off.cpp here.
 void HandleOffCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj)
 {
-    // Simplily does nothing, should be replaced by actual logic.
+    // Simply does nothing, should be replaced by actual logic.
 }
 
 void HandleOnCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj)
 {
-    // Simplily does nothing, should be replaced by actual logic.
+    // Simply does nothing, should be replaced by actual logic.
 }
 
 void HandleToggleCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj)
 {
-    // Simplily does nothing, should be replaced by actual logic.
+    // Simply does nothing, should be replaced by actual logic.
 }
 
 } // namespace OnOff

src/app/encoder.cpp

@@ -1,6 +1,6 @@
 /*
  *
- *    Copyright (c) 2020 Project CHIP Authors
+ *    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.
@@ -15,6 +15,8 @@
  *    limitations under the License.
  */
 
+// THIS FILE IS GENERATED BY ZAP
+
 #include "chip-zcl-zpro-codec.h"
 
 #include <support/BufBound.h>

src/app/im-handler.cpp

@@ -15,6 +15,8 @@
  *    limitations under the License.
  */
 
+// THIS FILE IS GENERATED BY ZAP
+
 #include "im-handler.h"
 
 #include <app/CommandHandler.h>
@@ -54,19 +56,43 @@ namespace Basic {
 void InitCluster(chip::app::InteractionModelEngine * ime)
 {
     VerifyOrReturn(ime != nullptr);
+    ime->RegisterClusterCommandHandler(Basic::kClusterId, Basic::kMfgSpecificPingCommandId,
+                                       Command::CommandRoleId::kCommandHandlerId, HandleMfgSpecificPingCommandReceived);
     ime->RegisterClusterCommandHandler(Basic::kClusterId, Basic::kResetToFactoryDefaultsCommandId,
                                        Command::CommandRoleId::kCommandHandlerId, HandleResetToFactoryDefaultsCommandReceived);
 }
 
 void ShutdownCluster(chip::app::InteractionModelEngine * ime)
 {
     VerifyOrReturn(ime != nullptr);
+    ime->DeregisterClusterCommandHandler(Basic::kClusterId, Basic::kMfgSpecificPingCommandId,
+                                         Command::CommandRoleId::kCommandHandlerId);
     ime->DeregisterClusterCommandHandler(Basic::kClusterId, Basic::kResetToFactoryDefaultsCommandId,
                                          Command::CommandRoleId::kCommandHandlerId);
 }
 
 } // namespace Basic
 
+namespace Binding {
+
+void InitCluster(chip::app::InteractionModelEngine * ime)
+{
+    VerifyOrReturn(ime != nullptr);
+    ime->RegisterClusterCommandHandler(Binding::kClusterId, Binding::kBindCommandId, Command::CommandRoleId::kCommandHandlerId,
+                                       HandleBindCommandReceived);
+    ime->RegisterClusterCommandHandler(Binding::kClusterId, Binding::kUnbindCommandId, Command::CommandRoleId::kCommandHandlerId,
+                                       HandleUnbindCommandReceived);
+}
+
+void ShutdownCluster(chip::app::InteractionModelEngine * ime)
+{
+    VerifyOrReturn(ime != nullptr);
+    ime->DeregisterClusterCommandHandler(Binding::kClusterId, Binding::kBindCommandId, Command::CommandRoleId::kCommandHandlerId);
+    ime->DeregisterClusterCommandHandler(Binding::kClusterId, Binding::kUnbindCommandId, Command::CommandRoleId::kCommandHandlerId);
+}
+
+} // namespace Binding
+
 namespace ColorControl {
 
 void InitCluster(chip::app::InteractionModelEngine * ime)
@@ -445,6 +471,7 @@ void InitClusters(chip::app::InteractionModelEngine * ime)
     VerifyOrReturn(ime != nullptr);
     BarrierControl::InitCluster(ime);
     Basic::InitCluster(ime);
+    Binding::InitCluster(ime);
     ColorControl::InitCluster(ime);
     DoorLock::InitCluster(ime);
     Groups::InitCluster(ime);
@@ -461,6 +488,7 @@ void ShutdownClusters(chip::app::InteractionModelEngine * ime)
     VerifyOrReturn(ime != nullptr);
     BarrierControl::ShutdownCluster(ime);
     Basic::ShutdownCluster(ime);
+    Binding::ShutdownCluster(ime);
     ColorControl::ShutdownCluster(ime);
     DoorLock::ShutdownCluster(ime);
     Groups::ShutdownCluster(ime);

src/app/im-handler.h

@@ -16,6 +16,8 @@
  *    limitations under the License.
  */
 
+// THIS FILE IS GENERATED BY ZAP
+
 #pragma once
 
 #include <app/CommandHandler.h>
@@ -60,6 +62,7 @@ namespace Basic {
 | Cluster Basic                                                       | 0x0000 |
 |------------------------------------------------------------------------------|
 | Commands:                                                           |        |
+| * MfgSpecificPing                                                   |   0x00 |
 | * ResetToFactoryDefaults                                            |   0x00 |
 |------------------------------------------------------------------------------|
 | Attributes:                                                         |        |
@@ -68,15 +71,40 @@ namespace Basic {
 | * ClusterRevision                                                   | 0xFFFD |
 \*----------------------------------------------------------------------------*/
 constexpr uint16_t kClusterId                      = 0x0000;
+constexpr uint8_t kMfgSpecificPingCommandId        = 0x00;
 constexpr uint8_t kResetToFactoryDefaultsCommandId = 0x00;
 
+void HandleMfgSpecificPingCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj);
 void HandleResetToFactoryDefaultsCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj);
 
 void InitCluster(chip::app::InteractionModelEngine * ime);
 void ShutdownCluster(chip::app::InteractionModelEngine * ime);
 
 } // namespace Basic
 
+namespace Binding {
+/*----------------------------------------------------------------------------*\
+| Cluster Binding                                                     | 0xF000 |
+|------------------------------------------------------------------------------|
+| Commands:                                                           |        |
+| * Bind                                                              |   0x00 |
+| * Unbind                                                            |   0x01 |
+|------------------------------------------------------------------------------|
+| Attributes:                                                         |        |
+| * ClusterRevision                                                   | 0xFFFD |
+\*----------------------------------------------------------------------------*/
+constexpr uint16_t kClusterId      = 0xF000;
+constexpr uint8_t kBindCommandId   = 0x00;
+constexpr uint8_t kUnbindCommandId = 0x01;
+
+void HandleBindCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj);
+void HandleUnbindCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj);
+
+void InitCluster(chip::app::InteractionModelEngine * ime);
+void ShutdownCluster(chip::app::InteractionModelEngine * ime);
+
+} // namespace Binding
+
 namespace ColorControl {
 /*----------------------------------------------------------------------------*\
 | Cluster ColorControl                                                | 0x0300 |

src/app/zap-templates/partials/header.zapt

@@ -14,3 +14,5 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
+
+// THIS FILE IS GENERATED BY ZAP

src/app/zap-templates/templates/chip/CHIPClusters-src.zapt

@@ -2,15 +2,14 @@
 #include "CHIPClusters.h"
 
 #include <app/chip-zcl-zpro-codec-api.h>
-#include <app/im-handler.h>
 #include <support/ReturnMacros.h>
 
 namespace chip {
 namespace Controller {
 
-// TODO(@vivien-apple): onCompletion is not used by IM for now.
-// TODO: length should be passed to commands when byte string is in argument list.
-// TODO: Commands should take group id as an argument.
+// TODO(#4502): onCompletion is not used by IM for now.
+// TODO(#4503): length should be passed to commands when byte string is in argument list.
+// TODO(#4503): Commands should take group id as an argument.
 
 {{#chip_server_clusters}}
 
@@ -22,13 +21,13 @@ CHIP_ERROR {{asCamelCased clusterName false}}Cluster::{{asCamelCased name false}
     VerifyOrReturnError(mDevice != nullptr, CHIP_ERROR_INCORRECT_STATE);
     (void) onCompletion;
 
-    Command::CommandParams cmdParams = { ZCLendpointId, ZCLgroupId, {{asCamelCased clusterName false}}::kClusterId, {{asCamelCased clusterName false}}::k{{asCamelCased name false}}CommandId,
+    app::Command::CommandParams cmdParams = { mEndpoint, /* group id */ 0, mClusterId, k{{asCamelCased name false}}CommandId,
                                          (chip::app::Command::kCommandPathFlag_EndpointIdValid) };
-    Command::Command * ZCLcommand = mDevice->GetCommandSender();
+    app::Command * ZCLcommand = mDevice->GetCommandSender();
+
     TLV::TLVWriter writer  = ZCLcommand->CreateCommandDataElementTLVWriter();
 
     TLV::TLVType dummyType = TLV::kTLVType_NotSpecified;
-
     ReturnErrorOnFailure(writer.StartContainer(TLV::AnonymousTag, TLV::kTLVType_Structure, dummyType));
 
 {{#chip_server_cluster_command_arguments}}

src/app/zap-templates/templates/chip/CHIPClusters.zapt

@@ -19,9 +19,9 @@ class DLL_EXPORT {{asCamelCased name false}}Cluster : public ClusterBase
 public:
     {{asCamelCased name false}}Cluster() : ClusterBase(k{{asCamelCased name false}}ClusterId) {}
     ~{{asCamelCased name false}}Cluster() {}
-
     {{#chip_server_cluster_commands}}
     {{#first}}
+
     // Cluster Commands
     {{/first}}
     CHIP_ERROR {{asCamelCased name false}}(Callback::Callback<> * onCompletion{{#chip_server_cluster_command_arguments}}, {{chipType}} {{asCamelCased label}}{{/chip_server_cluster_command_arguments}});
@@ -42,6 +42,13 @@ public:
     CHIP_ERROR ReportAttribute{{asCamelCased name false}}(Callback::Callback<> * onCompletion, Callback::Callback<> * onChange, uint16_t minInterval, uint16_t maxInterval{{#unless (isDiscreteType)}}, {{chipType}} change{{/unless}});
     {{/if}}
     {{/chip_server_cluster_attributes}}
+    {{#chip_server_cluster_commands}}
+    {{#first}}
+
+private:
+    {{/first}}
+    static constexpr CommandId k{{asCamelCased name false}}CommandId = {{asHex code 2}};
+    {{/chip_server_cluster_commands}}
 };
 
 {{/chip_server_clusters}}

src/app/zap-templates/templates/chip/python-ChipDeviceController-ClusterCommands.zapt

@@ -4,7 +4,6 @@
 
 #include <app/CommandSender.h>
 #include <app/InteractionModelEngine.h>
-#include <app/im-handler.h>
 #include <support/ReturnMacros.h>
 
 #include <controller/CHIPClusters.h>
@@ -13,23 +12,6 @@
 using namespace chip;
 using namespace chip::app;
 
-namespace chip {
-namespace app {
-namespace cluster {
-
-// Empty command handlers
-{{#chip_server_clusters}}
-namespace {{asCamelCased name false}} {
-{{#chip_server_cluster_commands}}
-void Handle{{asType name}}CommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj) {}
-{{/chip_server_cluster_commands}}
-} // namespace {{asCamelCased name false}}
-
-{{/chip_server_clusters}}
-} // namespace cluster
-} // namespace app
-} // namespace chip
-
 extern "C" {
 
 {{#chip_server_clusters}}

src/app/zap-templates/templates/chip/python-chip-ChipCluster.zapt

@@ -6,6 +6,10 @@ import ctypes
 from .ChipStack import *
 from .ChipExceptions import *
 
+'''
+TODO(#4511): This file only sends cluster commands, should add more functions.
+'''
+
 __all__ = ["ChipCluster"]
 
 class ChipCluster: