事件是异步的,由 Google Cloud Pub/Sub 管理,每个 Project对应一个主题。事件可为所有设备和结构提供更新,只要用户未撤消访问令牌且事件消息未过期,即可确保收到事件。
事件是 SDM API 的一项可选功能。您可以使用 Google Cloud 项目轻松实现和验证这些功能。
允许显示活动
您可以在 Device Access 控制台中启用事件。在控制台中选择您的项目(如果尚未选择)。
如果您已启用事件(例如,在创建项目期间),为事件启用 Pubsub 主题部分中的 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 权限,以访问和发布项目的 Topic 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,您需要它才能完成事件启用。如需了解详情,请参阅创建主题。
如需启用事件,请执行以下操作:
- 选中启用事件,然后点击创建项目。
- 点击 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 调用后,系统会发布所有结构和设备的事件。
生成事件
系统会针对所有 trait 字段更改生成事件,其中一些是自动更改,一些是手动更改。
例如,如果 Nest Thermostat 附近的环境温度发生变化,系统会自动发送一个包含新 ambientTemperatureCelsius
值的Temperature trait 事件。
如需手动生成一个,请执行以下任一操作:
- 手动更改设备状态,例如更改 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 中使用 --auto-ack
标志与基本 pull
命令搭配使用,以清除消息:
gcloud pubsub subscriptions pull subscription-id --auto-ack
管理订阅
订阅可以通过多种方式进行配置,如使用订阅属性中所述。
虽然您可以自行决定如何管理订阅和消息,但对于生产应用,我们建议您使用服务账号进行身份验证,而不是使用本快速入门指南中介绍的用户账号。服务账号是由应用或虚拟机(而非个人)使用的,并且具有自己的唯一账号密钥。
如需详细了解如何使用 Device Access进行服务账号身份验证,请参阅事件。