Initial support for adding codegen for interaction model

build/config/BUILDCONFIG.gn

@@ -15,6 +15,9 @@
 declare_args() {
   # Debug build. Set this to false to remove development features.
   is_debug = true
+
+  # Temporary flag for new interaction model engine, set it to true to enable
+  chip_app_use_interation_model = false
 }
 
 if (target_os == "") {

examples/lighting-app/linux/BUILD.gn

@@ -30,6 +30,7 @@ config("includes") {
 executable("chip-tool-server") {
   sources = [
     "LightingManager.cpp",
+    "OnOffCluster.cpp",
     "Options.cpp",
     "include/LightingManager.h",
     "main.cpp",
@@ -41,6 +42,10 @@ executable("chip-tool-server") {
     defines = [ "BUILD_RELEASE=1" ]
   }
 
+  if (chip_app_use_interation_model) {
+    defines += [ "CHIP_APP_USE_INTERACTION_MODEL" ]
+  }
+
   public_configs = [ ":includes" ]
 
   deps = [

examples/lighting-app/linux/OnOffCluster.cpp

@@ -0,0 +1,38 @@
+
+#include <app/CommandHandler.h>
+#include <app/CommandSender.h>
+#include <app/MessageDef.h>
+#include <app/im-encoder.h>
+#include <app/util/basic-types.h>
+
+#include <support/logging/CHIPLogging.h>
+
+#include "LightingManager.h"
+
+namespace chip {
+namespace app {
+namespace cluster {
+namespace OnOff {
+
+void HandleOffCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj)
+{
+    LightingMgr().InitiateAction(LightingManager::OFF_ACTION);
+    EncodeOffCommand(apCommandObj, 1, 0);
+}
+
+void HandleOnCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj)
+{
+    LightingMgr().InitiateAction(LightingManager::ON_ACTION);
+    EncodeOnCommand(apCommandObj, 1, 0);
+}
+
+void HandleToggleCommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj)
+{
+    LightingMgr().InitiateAction(LightingMgr().IsTurnedOn() ? LightingManager::OFF_ACTION : LightingManager::ON_ACTION);
+    EncodeToggleCommand(apCommandObj, 1, 0);
+}
+
+} // namespace OnOff
+} // namespace cluster
+} // namespace app
+} // namespace chip

examples/lighting-app/linux/main.cpp

@@ -23,6 +23,7 @@
 #include "gen/attribute-id.h"
 #include "gen/cluster-id.h"
 #include <app/chip-zcl-zpro-codec.h>
+#include <app/im-encoder.h>
 #include <app/util/af-types.h>
 #include <app/util/attribute-storage.h>
 #include <app/util/util.h>
@@ -189,6 +190,10 @@ int main(int argc, char * argv[])
     // Init ZCL Data Model and CHIP App Server
     InitServer();
 
+#ifdef CHIP_APP_USE_INTERACTION_MODEL
+    chip::app::cluster::OnOff::InitCluster(chip::app::InteractionModelEngine::GetInstance());
+#endif
+
     chip::DeviceLayer::PlatformMgr().RunEventLoop();
 
 exit:

src/app/BUILD.gn

@@ -37,6 +37,8 @@ static_library("app") {
     "MessageDef.h",
     "decoder.cpp",
     "encoder.cpp",
+    "im-encoder.cpp",
+    "im-encoder.h",
   ]
 
   public_deps = [

src/app/Command.cpp

@@ -199,7 +199,8 @@ CHIP_ERROR Command::AddCommand(CommandParams & aCommandParams)
 
     if (apCommandLen > 0)
     {
-        VerifyOrExit(apCommandLen > 2, err = CHIP_ERROR_INVALID_ARGUMENT);
+        // Command argument list can be empty.
+        VerifyOrExit(apCommandLen >= 2, err = CHIP_ERROR_INVALID_ARGUMENT);
         VerifyOrExit(apCommandData[0] == chip::TLV::kTLVType_Structure, err = CHIP_ERROR_INVALID_ARGUMENT);
 
         apCommandData += 1;

src/app/server/BUILD.gn

@@ -27,9 +27,17 @@ static_library("server") {
   ]
 
   public_deps = [
+    "${chip_root}/src/app",
     "${chip_root}/src/lib/mdns",
+    "${chip_root}/src/messaging",
     "${chip_root}/src/platform",
     "${chip_root}/src/setup_payload",
     "${chip_root}/src/transport",
   ]
+
+  defines = []
+
+  if (chip_app_use_interation_model) {
+    defines += [ "CHIP_APP_USE_INTERACTION_MODEL" ]
+  }
 }

src/app/server/Server.cpp

@@ -17,6 +17,7 @@
 
 #include <app/server/Server.h>
 
+#include <app/InteractionModelEngine.h>
 #include <app/server/DataModelHandler.h>
 #include <app/server/RendezvousServer.h>
 #include <app/server/SessionManager.h>
@@ -27,6 +28,7 @@
 #include <inet/InetLayer.h>
 #include <lib/mdns/DiscoveryManager.h>
 #include <mdns/Advertiser.h>
+#include <messaging/ExchangeMgr.h>
 #include <platform/CHIPDeviceLayer.h>
 #include <setup_payload/SetupPayload.h>
 #include <support/CodeUtils.h>
@@ -40,6 +42,7 @@ using namespace ::chip;
 using namespace ::chip::Inet;
 using namespace ::chip::Transport;
 using namespace ::chip::DeviceLayer;
+using namespace ::chip::Messaging;
 
 namespace {
 
@@ -104,6 +107,7 @@ class ServerCallback : public SecureSessionMgrDelegate
 };
 
 DemoTransportMgr gTransports;
+Messaging::ExchangeManager gExchange;
 SecureSessionMgr gSessions;
 ServerCallback gCallbacks;
 SecurePairingUsingTestSecret gTestPairing;
@@ -184,7 +188,14 @@ void InitServer(AppDelegate * delegate)
     err = gSessions.NewPairing(peer, chip::kTestControllerNodeId, &gTestPairing);
     SuccessOrExit(err);
 
+#ifdef CHIP_APP_USE_INTERACTION_MODEL
+    err = gExchange.Init(&gSessions);
+    SuccessOrExit(err);
+    err = chip::app::InteractionModelEngine::GetInstance()->Init(&gExchange);
+    SuccessOrExit(err);
+#else
     gSessions.SetDelegate(&gCallbacks);
+#endif
 
 exit:
     if (err != CHIP_NO_ERROR)

src/app/zap-templates/chip-templates.json

@@ -31,6 +31,26 @@
             "path": "templates/chip/encoder-src.zapt",
             "name": "CHIP ZCL API",
             "output": "src/app/encoder.cpp"
+        },
+        {
+            "path": "templates/chip/im-encoder-src.zapt",
+            "name": "CHIP Interaction Model Encoder API",
+            "output": "src/app/im-encoder.cpp"
+        },
+        {
+            "path": "templates/chip/im-encoder-h.zapt",
+            "name": "CHIP Interaction Model Encoder API",
+            "output": "src/app/im-encoder.h"
+        },
+        {
+            "path": "templates/chip/python-ChipDeviceController-ClusterCommands.zapt",
+            "name": "CHIP ZCL API for CPython",
+            "output": "src/controller/python/ChipDeviceController-ClusterCommands.cpp"
+        },
+        {
+            "path": "templates/chip/python-chip-ChipCluster.zapt",
+            "name": "CHIP ZCL API for Python",
+            "output": "src/controller/python/chip/ChipCluster.py"
         }
     ]
 }

src/app/zap-templates/common/StringHelper.js

@@ -17,6 +17,7 @@
 
 const stringShortTypes = [ 'CHAR_STRING', 'OCTET_STRING' ];
 const stringLongTypes  = [ 'LONG_CHAR_STRING', 'LONG_OCTET_STRING' ];
+const bytesTypes       = [ 'OCTET_STRING', 'LONG_OCTET_STRING' ];
 
 function isShortString(type)
 {
@@ -28,6 +29,11 @@ function isLongString(type)
   return stringLongTypes.includes(type);
 }
 
+function isByteString(type)
+{
+  return bytesTypes.includes(type);
+}
+
 function isString(type)
 {
   return isShortString(type) || isLongString(type);
@@ -39,3 +45,4 @@ function isString(type)
 exports.isString      = isString;
 exports.isShortString = isShortString;
 exports.isLongString  = isLongString;
+exports.isByteString  = isByteString;

src/app/zap-templates/templates/chip/helper.js

@@ -345,6 +345,52 @@ function isManufacturerSpecificCommand()
   return !!this.mfgCode;
 }
 
+function asPythonType(type)
+{
+  switch (type) {
+  case 'int8_t':
+  case 'int16_t':
+  case 'int32_t':
+  case 'int64_t':
+  case 'uint8_t':
+  case 'uint16_t':
+  case 'uint32_t':
+  case 'uint64_t':
+  case 'chip::ClusterId':
+    return 'int';
+  case 'char *':
+    return 'str';
+  case 'uint8_t *':
+    return 'byte';
+  }
+}
+
+function asPythonCType(type)
+{
+  switch (type) {
+  case 'int8_t':
+    return 'c_int8';
+  case 'int16_t':
+    return 'c_int16';
+  case 'int32_t':
+    return 'c_int32';
+  case 'int64_t':
+    return 'c_int64';
+  case 'uint8_t':
+    return 'c_uint8';
+  case 'uint16_t':
+  case 'chip::ClusterId':
+    return 'c_uint16';
+  case 'uint32_t':
+    return 'c_uint32';
+  case 'uint64_t':
+    return 'c_uint64';
+  case 'char *':
+  case 'uint8_t *':
+    return 'c_char_p';
+  }
+}
+
 //
 // Module exports
 //
@@ -357,3 +403,5 @@ exports.chip_server_cluster_attributes        = chip_server_cluster_attributes;
 exports.isWritableAttribute                   = isWritableAttribute;
 exports.isReportableAttribute                 = isReportableAttribute;
 exports.isManufacturerSpecificCommand         = isManufacturerSpecificCommand;
+exports.asPythonType                          = asPythonType;
+exports.asPythonCType                         = asPythonCType;

src/app/zap-templates/templates/chip/im-encoder-h.zapt

@@ -0,0 +1,46 @@
+
+{{> header}}
+
+#pragma once
+
+#include <app/util/basic-types.h>
+#include <app/MessageDef.h>
+#include <app/CommandSender.h>
+#include <app/CommandHandler.h>
+#include <app/InteractionModelEngine.h>
+
+namespace chip {
+namespace app {
+namespace cluster {
+
+{{#chip_server_clusters}}
+
+namespace {{asCamelCased name false}} {
+{{> cluster_header}}
+constexpr uint16_t kClusterId = {{asHex code 4}};
+{{#chip_server_cluster_commands}}
+constexpr uint8_t k{{asCamelCased name false}}CommandId = {{asHex code 2}};
+{{/chip_server_cluster_commands}}
+
+{{#chip_server_cluster_commands}}
+void Handle{{asType name}}CommandReceived(chip::TLV::TLVReader & aReader, chip::app::Command * apCommandObj);
+{{/chip_server_cluster_commands}}
+
+{{#chip_server_cluster_commands}}
+// The "ZCL" prefix here is used for avoiding duplicate names.
+CHIP_ERROR Encode{{asType name}}Command(chip::app::Command * ZCLcommand, chip::EndpointId ZCLendpointId, chip::GroupId ZCLgroupId{{#chip_server_cluster_command_arguments}}, const {{chipType}} {{asCamelCased label}}{{#if (isByteString type)}}, uint32_t {{asCamelCased label}}_Len{{/if}}{{/chip_server_cluster_command_arguments}});
+{{/chip_server_cluster_commands}}
+
+void InitCluster(chip::app::InteractionModelEngine * ime);
+void ShutdownCluster(chip::app::InteractionModelEngine * ime);
+
+} // namespace {{asCamelCased name false}}
+
+{{/chip_server_clusters}}
+
+void InitClusters(chip::app::InteractionModelEngine * ime);
+void ShutdownClusters(chip::app::InteractionModelEngine * ime);
+
+} // namespace cluster
+} // namespace app
+} // namespace chip