Platform Lanjutan ZCL (ZAP)

ZCL Advanced Platform (ZAP) adalah mesin template node.js yang didasarkan pada Cluster Matter.

ZAP menyediakan fitur berikut untuk aplikasi dan SDK Matter:

  • Mengonfigurasi Endpoint Matter, Cluster, Atribut, dan fitur perangkat lainnya dari antarmuka GUI.
  • Buat template yang otomatis membuat definisi Model Data, callback, dan kode sumber Matter lainnya.
  • Membuat dan menggunakan file ZAP yang telah dikonfigurasi sebelumnya untuk disertakan dengan SDK Anda.
Alat ZAP

Menginstal

  1. Buka halaman Rilis ZAP.

  2. Cari rilis dengan tag "Terbaru" (sebagian besar akan diberi tag "Pra-rilis").

  3. Pada rilis ini, di bawah judul Assets, pilih paket yang ditetapkan untuk sistem operasi Anda, lalu download.

  4. Pada mesin yang menjalankan Debian atau Ubuntu, instal ZAP dengan menjalankan:

    sudo dpkg -i path/to/zap_installation_package
    

Di Debian atau Ubuntu Linux, biner zap diinstal di /usr/bin/. Di sistem operasi lain, biner mungkin diinstal di tempat lain. Apa pun kasusnya, periksa untuk memastikan lokasi file yang dapat dieksekusi berada di variabel lingkungan PATH Anda.

File ZAP

ZAP menggunakan file template yang disebut file ZAP. File ZAP adalah file JSON yang menentukan Endpoint, Perintah, Atribut, dan fitur perangkat lainnya. File ZAP memiliki nama yang berakhiran .zap. Misalnya, lighting-app.zap di connectedhomeip/examples/lighting-app/lighting-common.

File all-clusters-app.zap, yang ditemukan di connectedhomeip/examples/all-clusters-app/all-clusters-common, telah dikonfigurasi dengan Cluster Matter umum dan tiga Endpoint, termasuk Jenis Perangkat Komisi Jaringan Sekunder Matter. Ini adalah contoh yang bagus untuk mempelajari berbagai konfigurasi Cluster.

Menjalankan

  1. Pilih file ZAP dari salah satu contoh Matter.
  2. Dari direktori utama repositori Matter (connectedhomeip), jalankan skrip wrapper run_zaptool.sh, dengan meneruskan jalurnya ke file .zap.

Contoh:

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

Penyiapan

Di Setelan, Anda dapat mengonfigurasi antarmuka pengguna ZAP, termasuk pilihan tema terang atau gelap, dan mengaktifkan atau menonaktifkan alat developer.

Dengan mengklik Opsi , Anda dapat memilih Product Manufacturer, Kebijakan Respons Default, dan mengaktifkan atau menonaktifkan Command Discovery.

Opsi Global ZAP

Klik Ekstensi untuk menambahkan cluster atau perintah ZCL kustom ke Zigbee Clusters Configurator.

Gunakan

Endpoints

File lighting-app.zap telah dikonfigurasi sebelumnya dengan Node Root Matter (Endpoint - 0) dan Matter Cahaya yang Dapat Diredupkan (Endpoint - 1).

Endpoint - 0 mencakup Cluster umum yang relevan dengan keseluruhan node, misalnya Cluster, Networking, Commissioning, Deskripsi, Kredensial Operasional, dan Cluster OTA.

Endpoint ZAP 0

Pada langkah berikutnya, Anda akan meninjau dan mengonfigurasi Endpoint - 1 Matter Cahaya Dimmable dari contoh lighting-app.

  1. Dari repositori Matter connectedhomeip, jalankan ZAP.

    scripts/tools/zap/run_zaptool.sh \
    examples/lighting-app/lighting-common/lighting-app.zap
    
  2. Klik Endpoint - 1, lalu EDIT.

  3. Opsional: Matter mendukung berbagai jenis perangkat. Di menu dropdown Perangkat, mulai ketik matter untuk mengubah perangkat, lalu klik SIMPAN.

    ZAP Select Device

Untuk mempelajari lebih lanjut, lihat Perangkat dan Endpoint di Matter Primer.

Cluster

Opsi Cluster, Atribut, dan Pelaporan yang telah ditetapkan sebelumnya diaktifkan di Endpoint - 1 secara default.

Untuk menampilkan Cluster yang diaktifkan saja, klik Endpoint - 1 lalu pilih Enabled Clusters dari menu Show. Anda juga dapat menelusuri cluster berdasarkan nama, misalnya on.

Cluster yang Diaktifkan ZAP

Untuk mengaktifkan Cluster sebagai Klien, Server, atau Klien & Server, gunakan menu dropdown Enable. Anda juga dapat memilih Not Enabled untuk menonaktifkan Cluster yang telah dikonfigurasi sebelumnya yang tidak berlaku untuk jenis perangkat Anda.

Cluster Nonaktifkan ZAP

Untuk mempelajari lebih lanjut, lihat Cluster di Primer Matter.

Atribut dan Perintah

Untuk mengonfigurasi Atribut dan Perintah, selesaikan langkah-langkah berikut:

  1. Temukan Cluster On/Off.
  2. Pada baris yang sama, klik ikon Konfigurasi .

    Konfigurasi ZAP

Di sini Anda dapat mengaktifkan atau menonaktifkan Atribut, menetapkan berbagai opsi Atribut, dan Telusuri atribut berdasarkan nama.

Atribut ZAP

Klik Commands untuk mengonfigurasi tindakan untuk Cluster ini. Misalnya, Cluster On/off untuk lampu akan menyertakan perintah On, Off, dan Toggle. Beberapa Cluster, seperti Cluster Temperature Measurement, mungkin tidak memiliki Perintah terkait.

Perintah ZAP

Untuk mempelajari lebih lanjut, baca Atribut dan Perintah di Primer Matter.

Membuat file sumber ZAP

Contoh Matter menggunakan kode sumber yang dihasilkan ZAP, yang tersedia di direktori connectedhomeip/zzz_generated. Beberapa file bersifat khusus aplikasi, sedangkan file ZAP generik lainnya dikelompokkan ke dalam app-common.

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

Setelah Endpoint dikonfigurasi, Anda dapat membuat file sumber untuk diintegrasikan ke dalam project.

  1. Klik Buat.
  2. Pilih folder untuk menyimpan output ZAP. Misalnya, buka connectedhomeip/zzz_generated/lighting-app/zap-generated untuk lighting-app.
  3. Opsional. Buka file dalam IDE pilihan Anda.

ZAP menghasilkan definisi, fungsi, dan kode sumber lain yang disesuaikan dengan jenis perangkat dan konfigurasi ZAP Anda.

File yang Dihasilkan ZAP

Misalnya, callback-stub.cpp menyertakan metode callback Cluster yang hanya menyertakan Cluster yang telah Anda aktifkan:

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

Menggunakan file sumber ZAP

File sumber ZAP umum, misalnya Attributes.h di zzz_generated/app-common/app-common/zap-generated/ids/, dapat digunakan untuk mendapatkan dan menetapkan Atribut jenis perangkat:

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");
    }
}

Setelah Anda memahami cara menggunakan file ZAP dalam kode sumber Matter, ada beberapa cara untuk mengintegrasikan ZAP:

  • Gunakan file zzz_generated yang ada untuk membuat contoh baru yang unik bagi jenis perangkat Anda.
  • Buat file .zap kustom untuk project Anda.

Sesuaikan

File ZAP dihasilkan dari template ZAP. Saat Anda menggunakan run_zaptool.sh untuk meluncurkan ZAP, skrip ini akan meneruskan template berikut:

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 menentukan nama template Matter dan file output terkait yang digunakan dalam contoh Matter.

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

Untuk menyesuaikan solusi Matter, ada beberapa langkah berikutnya yang dapat Anda lakukan saat bekerja dengan ZAP:

Referensi

Untuk resource ZAP tambahan, lihat repo ZAP (zap) di GitHub.