CameraEventImage 架构

Nest Cam(旧版) Nest Hub Max Nest Doorbell(旧版) 

sdm.devices.traits.CameraEventImage

此 trait 适用于支持通过事件生成图片的任何设备。

字段

没有可用于此特征的字段。

命令

GenerateImage

提供用于下载相机图像的网址。

此命令支持以下事件:

类型 元素 说明
事件 CameraMotion 特征的 Motion 事件 摄像头检测到动作。
事件 CameraPerson 特征的 Person 事件 摄像头检测到有人。
事件 CameraSound 特征的 Sound 事件 摄像头检测到声音。
事件 DoorbellChime 特征的 Chime 事件 已按门铃。
在命令请求中使用受支持事件中的 eventId,以接收与该事件相关的相机图片的下载网址。

GenerateImage 请求和响应

请求

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraEventImage.GenerateImage",
  "params" : {
    "eventId" : "L8gyDZiPURy_omOoJTiiVlR1nf..."
  }
}

响应

{
  "results" : {
    "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "token" : "g.0.eventToken"
  }
}

GenerateImage 请求字段

字段 说明 数据类型
eventId 要请求其相关相机图像的事件的 ID。 string
示例:“L8gyDZiPURy_omOoJTiiVlR1nf...”

GenerateImage 响应字段

字段 说明 数据类型
url 用于下载相机图片的网址。 string
示例:“https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...”
token 下载图片时要在 HTTP 授权标头中使用的令牌。 string
示例:“g.0.eventToken”

下载相机图片

使用具有基本授权的 HTTP Authorization 标头中的 tokenGenerateImage 命令响应对 url 进行 GET 调用,以下载相机图片:

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...

使用 widthheight 查询参数自定义所下载图片的分辨率。您只需指定其中一个参数。另一个参数会根据相机的宽高比自动调整。

例如,如果相机的宽高比为 4:3,要下载分辨率为 480 x 360 的相机图像,请指定宽度和高度:

宽度

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?width=480

身高

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?height=360

下载网址还需遵守以下限制:

  • 如果网址中同时提供了这两个参数,则系统会使用 width 并忽略 height
  • 如果网址中未提供这两个参数,则系统会为 width 选择默认值 480。

如需了解图片属性,请参阅 CameraImage 特征。

错误数

系统可能会返回与此 trait 相关的以下错误代码:

错误消息 RPC 问题排查
相机图片已无法下载。 DEADLINE_EXCEEDED 活动图片会在活动发布 30 秒后过期。请务必在过期前下载映像。
事件 ID 不属于摄像头。 FAILED_PRECONDITION 使用摄像头事件返回的正确 eventID

如需查看 API 错误代码的完整列表,请参阅 API 错误代码参考