ZCL 高级平台 (ZAP)

ZCL 高级平台 (ZAP) 是一个 node.js 模板引擎,基于 Matter 个集群

ZAP 为Matter应用提供以下功能,以及 SDK:

  • 配置 Matter 端点、集群、特性和 通过 GUI 接口访问其他设备功能。
  • 创建可自动生成数据模型定义的模板, 回调和其他 Matter 源代码。
  • 创建并使用要包含在 SDK 中的预配置 ZAP 文件。
ZAP 工具

安装

  1. 前往 ZAP 版本 页面。

  2. 查找标记为“最新”的版本(大多数视频会带有“预发布”标签)。

  3. 在此版本下,在 Assets 标题下,选择软件包 并下载该应用

  4. 在运行 Debian 或 Ubuntu 的机器上,运行以下命令安装 ZAP:

    sudo dpkg -i path/to/zap_installation_package

在 Debian 或 Ubuntu Linux 上,zap 二进制文件安装在 /usr/bin/ 中。已开启 则二进制文件可能安装在其他位置。无论如何 进行检查,确保该可执行文件的位置位于 PATH 环境中 变量。

ZAP 文件

ZAP 使用名为 ZAP 文件的模板文件。ZAP 文件是 JSON 文件 定义端点、命令、属性 功能。ZAP 文件的名称以 .zap 结尾。例如,connectedhomeip/examples/lighting-app/lighting-common 中的 lighting-app.zap

all-clusters-app.zap 文件位于 connectedhomeip/examples/all-clusters-app/all-clusters-common 中,已预配置常见的 Matter 集群和三个端点,包括一个 Matter 辅助网络配置设备类型。这是一个探索各种集群的绝佳示例 配置。

运行

  1. Matter 示例中选择一个 ZAP 文件。
  2. 在 Matter 代码库的根目录 (connectedhomeip) 中,运行 run_zaptool.sh 封装容器脚本,并将 .zap 文件的路径传递给它。

例如:

./scripts/tools/zap/run_zaptool.sh ./examples/lighting-app/lighting-common/lighting-app.zap

设置

设置中,您可以配置 ZAP 界面(包括您选择的浅色或深色主题),以及 启用或停用开发者工具。

点击 选项即可选择您的产品 制造商默认响应政策,以及启用或停用命令 发现。

ZAP 全局选项

点击 附加信息以添加自定义 将 ZCL 集群或命令添加到 Zigbee Clusters Configurator 中。

使用

端点

lighting-app.zap 文件预先配置了 Matter 根节点(端点 - 0)和 Matter 可调光灯 (端点 - 1)。

端点 - 0 包含 与整个节点相关,例如网络、调试、描述符, 操作凭据和 OTA 集群。

ZAP 端点 0

在接下来的步骤中,您将查看并配置端点 - 1 Matter 示例 lighting-app 中的 Dimmable Light。

  1. Matter 代码库 connectedhomeip 中,运行 ZAP。

    scripts/tools/zap/run_zaptool.sh \
    examples/lighting-app/lighting-common/lighting-app.zap
  2. 点击端点 - 1,然后 修改

  3. 可选Matter 支持各种设备类型。在 设备下拉菜单中,开始输入 matter 以更改设备,然后 点击保存

    ZAP 选择设备

如需了解详情,请参阅 设备和 Endpoints Matter Primer.

集群

在以下位置启用预定义的集群、属性和报告选项: 默认为端点 - 1

要仅显示已启用的集群,请点击端点 - 1,然后选择 显示中的已启用的集群 菜单。您还可以搜索 个集群 按名称,例如 on

已启用 ZAP 的集群

要将任何集群启用为客户端服务器客户端和服务器,请使用 启用下拉菜单中。您还可以选择未启用,以停用 预配置的集群,但不适用您的设备类型。

ZAP 停用集群

如需了解详情,请参阅 集群 Matter Primer 中的相关文档。

属性和命令

如需配置属性和命令,请完成以下步骤:

  1. 找到 On/Off 集群。
  2. 在同一行,点击“配置”图标

    ZAP 配置

在这里,您可以启用或停用属性、设置各种属性选项 按名称搜索属性

ZAP 属性

点击命令为此集群配置操作。例如,灯的开/关集群将包含切换命令。有些集群,例如 Temperature Measurement 集群可能没有任何关联的命令。

ZAP 命令

如需了解详情,请参阅 属性和命令 Matter Primer。

生成 ZAP 源文件

Matter 个示例使用 ZAP 生成的源代码(可用) 位于 connectedhomeip/zzz_generated 目录中。有些文件是特定于应用的 而其他常规 ZAP 文件则归入 app-common

#include <app-common/zap-generated/ids/Attributes.h>
#include <app-common/zap-generated/ids/Clusters.h>

配置好 Endpoints 后,您可以生成源文件,以便与 Google Cloud 集成 复制到您的项目中

  1. 点击 生成
  2. 选择一个文件夹来保存 ZAP 输出。例如,导航到 connectedhomeip/zzz_generated/lighting-app/zap-generatedlighting-app
  3. 可选。在您的首选 IDE 中打开相应文件。

ZAP 可生成根据您的需要自定义的定义、函数和其他源代码。 设备类型和 ZAP 配置

ZAP 生成的文件

例如,callback-stub.cpp 包含一个 Cluster 回调方法, 仅包含您已启用的集群:

void emberAfClusterInitCallback(EndpointId endpoint, ClusterId clusterId)
{
    switch (clusterId)
    {
     ...
     case ZCL_ON_OFF_CLUSTER_ID :
        emberAfOnOffClusterInitCallback(endpoint);
        break;
     ...
    }
}

使用 ZAP 源文件

常见的 ZAP 源文件,例如 Attributes.h zzz_generated/app-common/app-common/zap-generated/ids/,可用于 获取和设置设备类型属性:

Attributes.h

namespace DeviceTemperatureConfiguration {
  namespace Attributes {

  namespace CurrentTemperature {
    static constexpr AttributeId Id = 0x00000000;
    } // namespace CurrentTemperature

  ...

  } // namespace Attributes
} // namespace DeviceTemperatureConfiguration

main.cpp

#include <app-common/zap-generated/att-storage.h>
#include <app-common/zap-generated/attribute-id.h>
#include <app-common/zap-generated/attribute-type.h>
#include <app-common/zap-generated/attributes/Accessors.h>
#include <app-common/zap-generated/callback.h>
#include <app-common/zap-generated/cluster-id.h>
#include <app-common/zap-generated/cluster-objects.h>
#include <app-common/zap-generated/command-id.h>

using namespace ::chip;
using namespace ::chip::app::Clusters;

static void InitServer(intptr_t context)
{
    ...

    // Sets temperature to 20C
    int16_t temperature = 2000;
    auto status         = DeviceTemperatureConfiguration::Attributes::CurrentTemperature::Set(1, temperature);
    if (status != EMBER_ZCL_STATUS_SUCCESS)
    {
        ChipLogError(Shell, "Temp measurement set failed");
    }
}

了解如何在 Matter 中使用 ZAP 文件 那么您可以通过以下几种方式集成 ZAP:

  • 使用现有的 zzz_generated 文件创建适用于您设备类型的专属新示例。
  • 为您的项目创建自定义 .zap 文件。

自定义

ZAP 文件通过 ZAP 模板。 当您使用 run_zaptool.sh 启动 ZAP 时,此脚本会传入以下模板:

node src-script/zap-start.js --logToStdout \
    --gen "$CHIP_ROOT/src/app/zap-templates/app-templates.json" \
    --zcl "$CHIP_ROOT/src/app/zap-templates/zcl/zcl.json" \
    "${ZAP_ARGS[@]}"

templates.json 定义了 Matter 模板名称, Matter 示例中使用的相应输出文件。

{
    "path": "templates/app/callback-stub-src.zapt",
    "name": "ZCL callback-stub source",
    "output": "callback-stub.cpp"
}

如需自定义您的Matter解决方案,请执行下列几项操作: 使用 ZAP 时可采取的步骤:

资源

有关其他 ZAP 资源,请参阅 ZAP 代码库 (zap)