DoorbellChime 架构
Nest Doorbell(旧版)
sdm.devices.traits.DoorbellChime
此 trait 适用于支持门铃铃声和相关按压事件的任何设备。
字段
此 trait 没有可用的字段。
命令
没有适用于此 trait 的命令。
事件
铃声
可更新有人按门铃了。
此事件支持可更新的通知。您可以使用具有相同 eventThreadId
的后续事件的内容更新通过此事件创建的现有应用通知。
电铃事件
载荷
{ "eventId" : "81d7357b-3d21-4531-91c9-1ca86ef8d394",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime
" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "ctHJ3fWhjnC8TV-wSgqtPMPBJG..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }
电铃事件字段
字段 | 说明 | 数据类型 |
---|---|---|
eventSessionId |
Nest Doorbell(电池版) 您可以使用它将此事件与 CameraClipPreview trait 的相关 ClipPreview 事件相关联。 |
string 示例:“CjY5Y3VKaTZwR3o4Y19YbTVfMF...” |
eventId |
Nest Doorbell(旧版) 将其与 GenerateImage 命令搭配使用,即可下载与此事件相关的相机图片。 |
string 示例:“ctHJ3fWhjnC8TV-wSgqtPMPBJG...” |
事件载荷字段
字段 | 说明 | 数据类型 |
---|---|---|
eventId |
事件的唯一标识符。 | string 示例:“81d7357b-3d21-4531-91c9-1ca86ef8d394” |
timestamp |
事件发生的时间。 | string 示例:“2019-01-01T00:00:01Z” |
resourceUpdate |
一个用于详细说明资源更新信息的对象。 | object |
userId |
代表用户的唯一经过混淆处理的标识符。 | string 示例:“AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi” |
eventThreadId |
可更新 |
string 示例:“d67cd3f7-86a7-425e-8bb3-462f92ec9f59” |
eventThreadState |
可更新 |
string 值:“STARTED”“UPDATED”“ENDED” |
resourceGroup |
一个对象,用于指明可能与此事件具有类似更新的资源。事件本身的资源(来自 resourceUpdate 对象)始终会在此对象中存在。 |
object |
如需详细了解不同类型的事件及其运作方式,请参阅事件。
错误
系统可能会针对此 trait 返回以下错误代码:
错误消息 | RPC | 问题排查 |
---|---|---|
相机图片无法再下载。 | DEADLINE_EXCEEDED |
事件图片会在事件发布 30 秒后过期。请务必在图片过期前下载。 |
事件 ID 不属于摄像头。 | FAILED_PRECONDITION |
使用相机事件返回的正确 eventID 。 |
如需查看 API 错误代码的完整列表,请参阅 API 错误代码参考文档。