事件為非同步資料,由 Google Cloud Pub/Sub 管理,每個 Project都有一個主題。事件會為所有裝置和結構提供更新,只要使用者未撤銷存取權杖,且事件訊息未過期,就能確保收到事件。
事件是 SDM API 的選用功能,可使用 Google Cloud 專案輕鬆實作及驗證。
啟用活動功能
您可以在 Device Access 控制台中啟用事件。如果尚未選取專案,請在控制台中選取。
如果您已啟用事件 (例如在建立專案時),「啟用事件的 Pub/Sub 主題」部分中的「Pub/Sub 主題」欄位應已包含值,也就是主題 ID,格式如下:
projects/sdm-prod/topics/enterprise-project-id
這個主題格式由 Google 代管,除非您停用 Google 代管的 Pub/Sub 主題,否則專案會持續使用這個格式。如果之後重新啟用,系統會切換至自行代管的 Pub/Sub 主題。
開發人員可以在自己的 Google Cloud 雲端專案中建立或變更自行代管的 Pub/Sub 主題。開發人員也須負責支付使用 Pub/Sub 的所有相關費用,詳情請參閱 Pub/Sub 定價。
建立 Pub/Sub 主題:
gcloud pubsub topics create {topic} --message-retention-duration=0s授予必要的 SDM API 權限,以存取及發布專案主題 ID 的事件資料:
gcloud pubsub topics add-iam-policy-binding projects/{project}/topics/{topic} \
--member="group:sdm-publisher@googlegroups.com" \
--role="roles/pubsub.publisher"新建立的主題 ID 格式如下:
projects/gcp-project-name/subscriptions/topic-id
請記下主題 ID,您需要這個 ID 才能完成啟用事件。詳情請參閱「建立主題」。
如要啟用事件,請按照下列步驟操作:
- 勾選「啟用活動」,然後按一下「建立專案」。
- 按一下「Pub/Sub 主題」的 圖示,然後選取「啟用具有 PubSub 主題的事件」。
- 輸入先前建立或提供的 Pub/Sub 主題 ID。
複製主題 ID,您需要這個 ID 才能建立主題訂閱項目,以便擷取事件訊息。
建立提取訂閱項目
提取訂閱項目是指訂閱者向 Pub/Sub 伺服器發出要求,索取已加入佇列的事件訊息。這是驗證授權裝置是否產生事件的快速簡單方法。
開啟 Google Cloud 雲端專案的 Cloud Shell:
在 Cloud Shell 提示中,執行下列指令,使用您喜歡的任何 subscription-id 和專屬主題 ID,為主題建立提取訂閱項目:
gcloud pubsub subscriptions create subscription-id --topic=projects/gcp-project-name/subscriptions/topic-id
Created subscription [projects/gcp-project-name/subscriptions/subscription-id].啟動事件
建立 Pub/Sub 訂閱項目後,如要首次啟動事件,請呼叫一次性觸發程序,列出您的裝置:
curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access-token'呼叫這個 API 後,系統會發布所有結構和裝置的事件。
產生事件
系統會針對所有特徵欄位變更產生事件,其中有些是自動變更,有些是手動變更。
舉例來說,如果 Nest 溫度控制器附近的室溫發生變化,系統會自動傳送Temperature 特徵的事件,並附上新的 ambientTemperatureCelsius 值。
如要手動產生,請採用下列其中一種做法:
- 實際變更裝置狀態,例如變更 Nest Thermostat 的模式。
- 在 Google Nest Cam Indoor 上觸發事件,例如動作、人物或聲音。
- 使用 SDM API 執行裝置指令。
查看訊息
您可以在 Google Cloud 雲端專案的 Pub/Sub 訂閱項目專區中,查看事件訊息:
- 按一下您先前建立的訂閱 ID。
- 在「訂閱詳細資料」畫面上,您應該會看到「未確認的訊息計數」圖表中的活動。這表示訂閱項目已收到事件訊息。如果沒有看到任何活動,請稍候片刻或產生更多事件。
- 按一下「查看訊息」,開啟「訊息」面板。
- 按一下「PULL」即可查看訊息。這些訊息應與您用來產生事件的動作相符。
您也可以使用基本 pull 指令在 Cloud Shell 中查看訊息:
gcloud pubsub subscriptions pull subscription-id如要進一步瞭解訂閱類型,以及 SDM API 傳送的事件類型和使用方式,請參閱「事件」。
管理訊息
應定期確認及清除訊息,以維持訂閱項目的整潔,並避免重複傳送訊息給其他訂閱者。您可以在 Pub/Sub 訂閱項目部分手動清除所有訂閱項目訊息:
- 按一下訂閱 ID。
- 確認並清除的方式如下:
- 按一下「 查看訊息」即可開啟「訊息」面板。勾選「啟用確認訊息」核取方塊,然後按一下「提取」,即可查看及確認所有訊息。
- 按一下「 清除訊息」,即可確認並清除所有現有訊息,不必查看這些訊息。按一下「清除」即可確認。
您也可以在 Cloud Shell 中,使用基本 pull 指令搭配 --auto-ack 標記清除訊息:
gcloud pubsub subscriptions pull subscription-id --auto-ack管理訂閱項目
訂閱項目的設定方式有很多種,詳情請參閱「使用訂閱項目屬性」。
您可以自行決定如何管理訂閱項目和訊息,但對於正式版應用程式,我們建議您使用服務帳戶進行驗證,而不是像本快速入門指南中使用的使用者帳戶。服務帳戶是由應用程式或虛擬機器使用,而非真人,且有專屬的帳戶金鑰。
如要進一步瞭解如何使用 Device Access進行服務帳戶驗證,請參閱「事件」。