AWS IoT Greengrass Discovery 程式庫

注意

此頁面上的內容可能不是 up-to-date。如需最新的更新，請參閱 FreerTos.org 程式庫頁面。

概要

您的微控制器裝置會使用AWS IoT Greengrass探索程式庫來探索網路上的 Greengrass 核心。使用 AWS IoT Greengrass Discovery API，您的裝置可在找到核心的端點後將訊息傳送到 Greengrass 核心。

相依性和要求

若要使用 Greengrass Discovery 程式庫，您必須在 AWS IoT 中建立物件，包含憑證與政策。如需詳細資訊，請參閱 AWS IoT 入門。

您必須在 freertos/demos/include/aws_clientcredential.h 檔案中設定以下常數的值：

clientcredentialMQTT_BROKER_ENDPOINT

您的 AWS IoT 端點。

clientcredentialIOT_THING_NAME

您的 IoT 實物名稱。

clientcredentialWIFI_SSID

您的 Wi-Fi 網路 SSID。

clientcredentialWIFI_PASSWORD

您的 Wi-Fi 密碼。

clientcredentialWIFI_SECURITY

您 Wi-Fi 網路所使用的安全類型。

您必須同時在 freertos/demos/include/aws_clientcredential_keys.h 檔案中設定以下常數的值：

keyCLIENT_CERTIFICATE_PEM

與您物件相關聯的憑證 PEM。

keyCLIENT_PRIVATE_KEY_PEM

與您物件相關聯的私有金鑰 PEM。

您必須在主控台中設定一個 Greengrass 群組及核心裝置。如需詳細資訊，請參閱 AWS IoT Greengrass 入門。

雖然 CoremQtt 程式庫不需要 Greengrass 連線，但我們強烈建議您安裝它。在搜索到之後，程式庫便可用來和 Greengrass 核心通訊。

API 參考

如需完整的 API 參考，請參閱 Greengrass API 參考。

範例使用方式

Greengrass 工作流程

MCU 裝置會透過從 AWS IoT 請求包含 Greengrass 核心連線能力參數的 JSON 檔案來初始化搜索程序。有兩種從 JSON 檔案擷取 Greengrass 核心連線能力參數的方法：

• 自動選取會逐一查看 JSON 檔案中列出的所有 Greengrass 核心，並連線到第一個可用的核心。

• 手動選取會使用 aws_ggd_config.h 中的資訊來連線到指定的 Greengrass 核心。

如何使用 Greengrass API

所有 Greengrass API 的預設組態選項都定義在 aws_ggd_config_defaults.h 中。

若只有一個 Greengrass 核心，請呼叫 GGD_GetGGCIPandCertificate 來請求附帶 Greengrass 核心連線能力資訊的 JSON 檔案。當傳回 GGD_GetGGCIPandCertificate 時，pcBuffer 參數會包含 JSON 檔案的文字。pxHostAddressData 參數則包含您可以連線的 Greengrass 核心 IP 地址及連接埠。

如需更多自訂選項 (例如動態配置憑證)，您必須呼叫以下 API：

GGD_JSONRequestStart

向 AWS IoT 發送 HTTP GET 請求，初始化搜索 Greengrass 核心的搜索請求。GD_SecureConnect_Send 會用於向 AWS IoT 傳送請求。

GGD_JSONRequestGetSize

從 HTTP 回應取得 JSON 檔案的大小。

GGD_JSONRequestGetFile

取得 JSON 物件字串。GGD_JSONRequestGetSize 和 GGD_JSONRequestGetFile 會使用 GGD_SecureConnect_Read 從通訊端取得 JSON 資料。必須呼叫 GGD_JSONRequestStart、GGD_SecureConnect_Send、GGD_JSONRequestGetSize 來從 AWS IoT 接收 JSON 資料。

GGD_GetIPandCertificateFromJSON

從 JSON 資料擷取 IP 地址和 Greengrass 核心憑證。您可以透過將 xAutoSelectFlag 設為 True 來開啟自動選取。自動選取會尋找您 FreeRTOS 裝置能連線到的第一個核心裝置。若要連線到 Greengrass 核心，請呼叫 GGD_SecureConnect_Connect 函數、傳遞 IP 地址、連接埠及核心裝置的憑證。若要使用手動選取，請設定 HostParameters_t 參數的以下欄位：

pcGroupName

核心所屬的 Greengrass 群組 ID。您可以使用 aws greengrass list-groups CLI 命令來尋找您 Greengrass 群組的 ID。

pcCoreAddress

您正在連線的 Greengrass 核心 ARN。