แพลตฟอร์มขั้นสูง ZCL (ZAP)

ZCL Advanced Platform (ZAP) เป็นเครื่องมือเทมเพลต Node.js ที่อิงตาม Matter คลัสเตอร์

ZAP มีฟีเจอร์ต่อไปนี้สำหรับแอปและ SDK ของ Matter

  • กำหนดค่าปลายทาง Matter คลัสเตอร์ แอตทริบิวต์ และฟีเจอร์อื่นๆ ของอุปกรณ์จากอินเทอร์เฟซ GUI
  • สร้างเทมเพลตที่สร้างคำนิยามของโมเดลข้อมูล โค้ดเรียกกลับ และซอร์สโค้ด Matter อื่นๆ โดยอัตโนมัติ
  • สร้างและใช้ไฟล์ ZAP ที่กำหนดค่าไว้ล่วงหน้าเพื่อรวมไว้ใน SDK ของคุณ
เครื่องมือ 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 ตัวอย่างเช่น lighting-app.zap ใน connectedhomeip/examples/lighting-app/lighting-common

ไฟล์ all-clusters-app.zap ที่พบใน connectedhomeip/examples/all-clusters-app/all-clusters-common ได้รับการกำหนดค่าล่วงหน้าด้วยคลัสเตอร์ Matter ทั่วไปและปลายทาง 3 จุด ซึ่งรวมถึงเครือข่ายรอง Matter ประเภทอุปกรณ์ที่มีค่าคอมมิชชัน นี่เป็นตัวอย่างที่ดีสำหรับการสำรวจการกำหนดค่าคลัสเตอร์ต่างๆ

วิ่ง

  1. เลือกไฟล์ ZAP จากตัวอย่าง Matter รายการ
  2. จากไดเรกทอรีรูทของที่เก็บ Matter (connectedhomeip) ให้เรียกใช้สคริปต์ Wrapper run_zaptool.sh แล้วส่งผ่านเส้นทางไปยังไฟล์ .zap

เช่น

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

ตั้งค่า

ในการตั้งค่าของ คุณจะกำหนดค่าอินเทอร์เฟซผู้ใช้ ZAP รวมถึงธีมสว่างหรือมืดที่ต้องการ และเปิดหรือปิดใช้เครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ได้

เมื่อคลิก ตัวเลือก คุณจะเลือก Product Manufacturer, นโยบายการตอบกลับเริ่มต้น แล้วเปิดหรือปิดใช้ Command Discovery

ตัวเลือกทั่วโลกของ ZAP

คลิก ส่วนขยายเพื่อเพิ่มคลัสเตอร์หรือคำสั่ง ZCL ที่กำหนดเองไปยังเครื่องมือกำหนดค่าคลัสเตอร์ Zigbee

ใช้

ปลายทาง

ไฟล์ lighting-app.zap มีการกำหนดค่าล่วงหน้าด้วย Matter Root Node (ปลายทาง - 0) และ Matter ไฟที่หรี่ไฟได้ (ปลายทาง - 1)

ปลายทาง - 0 ประกอบด้วยคลัสเตอร์ทั่วไปที่เกี่ยวข้องกับทั้งโหนด เช่น Networking, การจัดเตรียม, Descriptor, ข้อมูลเข้าสู่ระบบการปฏิบัติงาน และคลัสเตอร์ OTA

ZAP Endpoint 0

ในขั้นตอนถัดไป คุณจะได้ตรวจสอบและกำหนดค่าปลายทาง - 1 Matter "แสงที่หรี่ไฟได้" จากตัวอย่าง lighting-app

  1. จากที่เก็บ Matter connectedhomeip ให้เรียกใช้ ZAP

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

  2. คลิกปลายทาง - 1 จากนั้นคลิก แก้ไข

  3. ไม่บังคับ: Matter รองรับอุปกรณ์หลายประเภท ในเมนูแบบเลื่อนลงของอุปกรณ์ ให้เริ่มพิมพ์ matter เพื่อเปลี่ยนอุปกรณ์ จากนั้นคลิกบันทึก

    อุปกรณ์ ZAP Select

ดูข้อมูลเพิ่มเติมได้ที่อุปกรณ์และปลายทางใน Matter Primer

คลัสเตอร์

ตัวเลือกคลัสเตอร์ แอตทริบิวต์ และการรายงานที่กำหนดไว้ล่วงหน้าจะเปิดใช้ในปลายทาง - 1 โดยค่าเริ่มต้น

หากต้องการแสดงเฉพาะคลัสเตอร์ที่เปิดใช้ ให้คลิกปลายทาง - 1 และเลือกคลัสเตอร์ที่เปิดใช้จากเมนูแสดง นอกจากนี้ คุณยังค้นหาคลัสเตอร์ ตามชื่อได้ เช่น on

คลัสเตอร์ที่เปิดใช้ ZAP

หากต้องการเปิดใช้คลัสเตอร์เป็นไคลเอ็นต์ เซิร์ฟเวอร์ หรือไคลเอ็นต์และเซิร์ฟเวอร์ ให้ใช้เมนูแบบเลื่อนลงเปิดใช้ นอกจากนี้ คุณยังเลือกไม่ได้เปิดใช้เพื่อปิดใช้คลัสเตอร์ที่กำหนดค่าไว้ล่วงหน้าซึ่งไม่เกี่ยวข้องกับประเภทอุปกรณ์ของคุณได้

คลัสเตอร์การปิดใช้ ZAP

ดูข้อมูลเพิ่มเติมได้ที่คลัสเตอร์ใน Primer ของ Matter

แอตทริบิวต์และคำสั่ง

หากต้องการกำหนดค่าแอตทริบิวต์และคำสั่ง ให้ทำตามขั้นตอนต่อไปนี้

  1. ค้นหาคลัสเตอร์ On/Off

  2. ในแถวเดียวกัน ให้คลิกไอคอนกำหนดค่า

    การกำหนดค่า ZAP

คุณจะเปิดหรือปิดใช้แอตทริบิวต์ ตั้งค่าตัวเลือกแอตทริบิวต์ต่างๆ และค้นหาแอตทริบิวต์ ตามชื่อได้ที่นี่

แอตทริบิวต์ ZAP

คลิกคำสั่งเพื่อกำหนดค่าการดำเนินการสำหรับคลัสเตอร์นี้ ตัวอย่างเช่น คลัสเตอร์เปิด/ปิดสำหรับหลอดไฟจะมีคำสั่งเปิด ปิด และสลับ คลัสเตอร์บางรายการ เช่น คลัสเตอร์ Temperature Measurement อาจไม่มีคำสั่งที่เชื่อมโยงอยู่

คำสั่ง ZAP

ดูข้อมูลเพิ่มเติมได้ที่แอตทริบิวต์และคำสั่งใน Primer Matter

สร้างไฟล์ต้นฉบับ 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>

เมื่อกำหนดค่าปลายทางแล้ว คุณจะสร้างไฟล์ต้นทางเพื่อผสานรวมเข้ากับโปรเจ็กต์ได้

  1. คลิก สร้าง
  2. เลือกโฟลเดอร์เพื่อบันทึกเอาต์พุต ZAP ตัวอย่างเช่น ไปที่ connectedhomeip/zzz_generated/lighting-app/zap-generated เพื่อดู lighting-app
  3. Optional เปิดไฟล์ใน 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

ไฟล์แหล่งที่มา 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");
    }
}

เมื่อเข้าใจวิธีใช้ไฟล์ ZAP ในซอร์สโค้ด Matter แล้ว คุณจะผสานรวม 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) บน GitHub