資料模型程式碼產生器 - 的受管整合 AWS IoT Device Management

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

資料模型程式碼產生器

了解如何將程式碼產生器用於資料模型。產生的程式碼可用來序列化和還原序列化雲端和裝置之間交換的資料模型。

專案儲存庫包含用於建立 C 程式碼資料模型處理常式的程式碼產生工具。下列主題說明程式碼產生器和工作流程。

程式碼產生程序

程式碼產生器會從三個主要輸入建立 C 來源檔案:Zigbee Cluster Library (ZCL) 進階平台的事項資料模型 (.matter 檔案) AWS實作、處理預先處理的 Python 外掛程式,以及定義程式碼結構的 Jinja2 範本。在產生期間,Python 外掛程式會透過新增全域類型定義、根據其相依性組織資料類型,以及格式化範本轉譯的資訊,來處理您的 .matter 檔案。

下圖說明建立 C 來源檔案的程式碼產生器。

終端裝置 SDK 程式碼產生器及其運作方式。

終端裝置 SDK 包含可在connectedhomeip專案codegen.py中使用 的 Python 外掛程式和 Jinja2 範本。此組合會根據您的 .matter 檔案輸入,為每個叢集產生多個 C 檔案。

Python 外掛程式

程式碼產生器 會codegen.py剖析 .matter 檔案,並將資訊做為 Python 物件傳送至外掛程式。外掛程式檔案會iotmi_data_model.py預先處理此資料,並使用提供的範本轉譯來源。預先處理包括:

  1. 新增無法從 取得的資訊codegen.py,例如全域類型

  2. 對資料類型執行拓撲排序,以建立正確的定義順序

    注意

    拓撲排序可確保相依類型在其相依性之後定義,無論其原始順序為何。

Jinja2 範本

終端裝置 SDK 提供專為資料模型處理常式和低階 C-Functions 量身打造的 Jinja2 範本。

Jinja2 範本
範本 產生的來源 備註
cluster.h.jinja iotmi_device_<cluster>.h 建立低階 C 函數標頭檔案。
cluster.c.jinja iotmi_device_<cluster>.c 使用資料模型處理常式實作和註冊回呼函數指標。
cluster_type_helpers.h.jinja iotmi_device_type_helpers_<cluster>.h 定義資料類型的函數原型。
cluster_type_helpers.c.jinja iotmi_device_type_helpers_<cluster>.c 產生叢集特定列舉、點陣圖、清單和結構的資料類型函數原型。
iot_device_dm_types.h.jinja iotmi_device_dm_types.h 定義全域資料類型的 C 資料類型。
iot_device_type_helpers_global.h.jinja iotmi_device_type_helpers_global.h 定義全域操作的 C 資料類型。
iot_device_type_helpers_global.c.jinja iotmi_device_type_helpers_global.c 宣告標準資料類型,包括布林值、整數、浮點數、字串、點陣圖、清單和結構。

(選用) 自訂結構描述

終端裝置 SDK 結合了標準化程式碼產生程序與自訂結構描述。這可讓您的裝置和裝置軟體延伸事項資料模型。自訂結構描述有助於描述裝置device-to-cloud功能。

如需受管整合資料模型的詳細資訊,包括格式、結構和需求,請參閱 受管整合資料模型

使用 codegen.py工具產生自訂結構描述的 C 來源檔案,如下所示:

注意

每個自訂叢集需要下列三個檔案的相同叢集 ID

  • 建立JSON格式為 的自訂結構描述,提供叢集的表示法,以供功能報告在雲端中建立新的自訂叢集。範例檔案位於 codegen/custom_schemas/custom.SimpleLighting@1.0

  • 以包含與自訂結構描述相同資訊的XML格式建立 ZCL (Zigbee 叢集程式庫) 定義檔案。使用 ZAP 工具從 ZCL XML 產生您的事項 IDL 檔案。範例檔案位於 codegen/zcl/custom.SimpleLighting.xml

  • ZAP 工具的輸出為 ,Matter IDL File (.matter)並定義與您的自訂結構描述對應的事項叢集。這是codegen.py工具為終端裝置 SDK 產生 C 來源檔案的輸入。範例檔案位於 codegen/matter_files/custom-light.matter

如需如何將自訂受管整合資料模型整合至程式碼產生工作流程的詳細說明,請參閱 產生裝置的程式碼