门铃(旧版)

Nest Hello

Smart Device Management (SDM) API 支持所有旧版 Nest Doorbell。 此设备会返回 DOORBELL 这一设备类型:

sdm.devices.types.DOORBELL

Google Nest Doorbell(旧版)配有摄像头,其功能与 CAMERA 的设备类型相同。

特征

参考

以下特征、命令或事件与此设备相关:

特征说明命令活动
CameraEventImage此特征属于支持从事件生成图片的所有设备。生成图片
相机图片此特征属于支持拍照的任何设备。
相机直播此特征属于支持直播的任何设备。GenerateRtspStream
ExtendRtspStream
StopRtspStream
相机移动此特征属于任何支持移动侦测事件的设备。运动
相机人物此特征属于任何支持人员检测事件的设备。人员
相机提示音此特征属于任何支持声音检测事件的设备。声音
门铃此特征属于任何支持门铃电铃和相关新闻事件的设备。铃声
信息此特征属于任何与设备相关的信息的设备。

JSON

GET 响应中缺少某个特征表示该特征或功能目前不适用于设备。如需了解详情,请参阅设备类型

{
  "type" : "sdm.devices.types.DOORBELL",
  "traits" : {
    "sdm.devices.traits.CameraEventImage" : {},
    "sdm.devices.traits.CameraImage" : {
      "maxImageResolution" : {
        "width" : 1280,
        "height" : 960
      }
    },
    "sdm.devices.traits.CameraLiveStream" : {
      "maxVideoResolution" : {
        "width" : 640,
        "height" : 480
      },
      "videoCodecs" : ["H264"],
      "audioCodecs" : ["AAC"],
      "supportedProtocols" : ["WEB_RTC"]
    },
    "sdm.devices.traits.CameraMotion" : {},
    "sdm.devices.traits.CameraPerson" : {},
    "sdm.devices.traits.CameraSound" : {},
    "sdm.devices.traits.DoorbellChime" : {},
    "sdm.devices.traits.Info" : {
      "customName" : "My device"
    }
  }
}

处理门铃和摄像头事件

DOORBELL 设备类型可能会触发以下事件:

类型 元素 说明
事件 CameraMotion 特征的 Motion 事件 摄像头检测到移动。
事件 CameraPerson 特征的 Person 事件 摄像头检测到有人。
事件 CameraSound 特征的 Sound 事件 摄像头检测到声音。
事件 DoorbellChime 特征的 Chime 事件 门铃已按下。
例如,以下按键已按门铃按钮:

载荷

{
  "eventId" : "74ed7ab5-6dde-4d32-8840-08478937e2ca",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "vPjUAsTWRCAAsM_-D4uEKF4Fd4..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }
此事件的载荷包含一个可与 GenerateImage 命令搭配使用的 eventId。此命令会返回与事件相关的相机图片的下载网址:

请求

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

响应

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

下载相机图片

使用具有基本授权的 HTTP 授权标头中的 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 特征。

访问直播

您可以访问摄像头直播。此设备支持以下流格式:

  • RTSP

如需查看相机和支持的数据流格式的完整列表,请参阅支持的设备

如需访问直播活动,请使用CameraLiveStream特征的相应“生成Format视频流”命令。

RTSP

对于 RTSP 流,CameraLiveStream 特征命令的 GenerateRtspStream 命令会返回流网址和相关的 streamToken

请求

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
  "params" : {}
}

响应

{
  "results" : {
    "streamUrls" : {
      "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken"
    },
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
    "streamToken" : "g.0.streamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

然后,使用直播网址访问摄像头直播:

rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken

RTSP 直播网址无法在客户端之间共享。一个视频流网址一次只能供一个客户端使用。如果多个客户端想要同时从同一摄像头进行流式传输,则必须为每个客户端发送 RTSP 命令,并且每个客户端都必须使用自己的视频流网址。

延长直播

摄像头直播会话的有效期只有 5 分钟。如果您需要延长直播的生命周期,请针对您生成的直播格式使用 CameraLiveStream 特征的相应扩展Format直播命令。

RTSP

如需扩展 RTSP 流,请使用 CameraLiveStream 特征命令的 ExtendRtspStream 命令获取新的 streamExtensionTokenstreamToken 值:

请求

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.ExtendRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

响应

{
  "results" : {
    "streamExtensionToken" : "dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "streamToken" : "g.0.newStreamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

请使用以下新值更新直播网址,以便继续观看直播:

rtsps://someurl.com/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?auth=g.0.newStreamingToken

停止直播

只要您不再使用摄像头实时画面,就应该停止视频流并使画面失效。为此,请对生成的视频流格式使用CameraLiveStream特征的相应停止Format数据流命令。

RTSP

如需停止 RTSP 流,请使用令牌通过 CameraLiveStream 特征命令的 StopRtspStream 命令失效:

请求

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.StopRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

响应

{}

错误数

相对于此设备,可能会返回以下错误代码:

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

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