ZCL Advanced Platform(ZAP)

ZCL Advanced Platform(ZAP)は、 Matter クラスタに基づく node.js テンプレート エンジンです。

ZAP は、Matter アプリと SDK に次の機能を提供します。

  • GUI インターフェースから Matter エンドポイント、クラスタ、属性、その他のデバイス機能を構成します。
  • データモデルの定義、 コールバック、その他の Matter ソースコードを自動的に生成するテンプレートを作成します。
  • SDK に含めるように事前構成された ZAP ファイルを作成して使用します。
ZAP ツール

インストール

  1. ZAP リリース ページに移動します。

  2. [最新] のタグが付いたリリースを探します(ほとんどのリリースには [プレリリース] のタグが付いています)。

  3. このリリースの [アセット] 見出しの下で、オペレーティング システム用に指定されたパッケージを選択してダウンロードします。

  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-commonlighting-app.zap です。

all-clusters-app.zap ファイルは、 connectedhomeip/examples/all-clusters-app/all-clusters-common にあり、一般的な Matter クラスタと 3 つの エンドポイント(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 ユーザー インターフェースを構成できます。

[Options] をクリックすると、[Product Manufacturer]、[Default Response Policy] を選択し、Command Discovery を有効または無効にできます。

ZAP グローバル オプション

[Extensions] をクリックして、カスタム ZCL クラスタまたはコマンドを Zigbee クラスタ構成ツールに追加します。

使用

エンドポイント

lighting-app.zap ファイルは、Matter ルートノード(Endpoint - 0)と Matter 調光ライト (Endpoint - 1)で事前構成されています。

Endpoint - 0 には、ノード全体に関連する一般的なクラスタ(ネットワーク、プロビジョニング、記述子、オペレーション認証情報、OTA クラスタなど)が含まれています。

ZAP エンドポイント 0

次のステップでは、例 lighting-appEndpoint - 1 Matter 調光ライトを確認して構成します。

  1. Matter リポジトリ connectedhomeip から ZAP を実行します。

    scripts/tools/zap/run_zaptool.sh \
    examples/lighting-app/lighting-common/lighting-app.zap
  2. [Endpoint - 1]、 [EDIT] をクリックします。

  3. 省略可: Matter はさまざまなデバイスタイプをサポートしています。[デバイス] プルダウンで matter と入力してデバイスを変更し、[保存] をクリックします。

    ZAP Select Device

詳細については、 Primer の デバイスとエンドポイントをご覧ください。Matter

クラスタ

事前定義されたクラスタ、属性、レポート オプションは、デフォルトで [Endpoint - 1] で有効になっています。

有効なクラスタのみを表示するには、[Endpoint - 1] をクリックし、[表示] メニューから [有効なクラスタ] を選択します。名前(on など)でクラスタを検索することもできます。

ZAP が有効なクラスタ

任意のクラスタを [Client]、[Server]、または [Client & Server] として有効にするには、 [Enable] プルダウンを使用します。デバイスタイプに適用されない事前構成されたクラスタを無効にするには、[有効にしない] を選択します。

ZAP Disable Cluster

詳細については、 クラスタMatter Primer でご覧ください。

属性とコマンド

属性とコマンドを構成するには、次の手順を行います。

  1. On/Off クラスタを見つけます。
  2. 同じ行で、構成アイコン をクリックします。

    ZAP の構成

ここでは、属性を有効または無効にしたり、さまざまな属性オプションを設定したり、名前で 属性を検索 したりできます。

ZAP 属性

[コマンド] をクリックして、このクラスタのアクションを構成します。たとえば、ライトの [On/off] クラスタには、[On]、[Off]、 および [Toggle] コマンドが含まれます。Temperature Measurement クラスタなど、一部のクラスタには関連付けられたコマンドがない場合があります。

ZAP コマンド

詳細については、 属性とコマンドMatter Primer をご覧ください。

ZAP ソースファイルを生成する

Matter の例では、connectedhomeip/zzz_generated ディレクトリにある ZAP 生成のソースコードを使用します。一部のファイルはアプリ固有ですが、他の汎用 ZAP ファイルは app-common にグループ化されています。

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

エンドポイントを構成したら、プロジェクトに統合するソースファイルを生成できます。

  1. [ [Generate]] をクリックします。
  2. ZAP 出力を保存するフォルダを選択します。たとえば、 lighting-app の場合は connectedhomeip/zzz_generated/lighting-app/zap-generated に移動します。
  3. 省略可 。お好みの IDE でファイルを開きます。

ZAP は、デバイスタイプと ZAP 構成に固有の定義、関数、その他のソースコードを生成します。

ZAP で生成されたファイル

たとえば、callback-stub.cpp には、有効にしたクラスタのみを含むクラスタ コールバック メソッドが含まれています。

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

ZAP ソースファイルを使用する

zzz_generated/app-common/app-common/zap-generated/ids/Attributes.h などの一般的な ZAP ソースファイルを使用して、デバイスタイプの属性を取得して設定できます。

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 を統合する方法はいくつかあります。Matter

  • 既存の 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 リソースについては、 GitHub の ZAP リポジトリ (zap) をご覧ください。