门铃（旧版）

Nest Hello

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

sdm.devices.types.DOORBELL

Google Nest Doorbell（旧版）配有一个摄像头，其功能与设备类型 CAMERA 相同。

特征

参考

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

特征说明命令事件
CameraEventImage此特征属于任何支持根据事件生成图片的设备。GenerateImage
CameraImage此特征属于任何支持拍照的设备。
CameraLiveStream此特征属于任何支持直播的设备。GenerateRtspStream
ExtendRtspStream
StopRtspStream
CameraMotion此特征属于支持移动侦测事件的任何设备。动作
CameraPerson此特征属于支持人员检测事件的任何设备。人员
CameraSound此特征属于支持声音检测事件的任何设备。声音
DoorbellChime此特征属于支持门铃和相关按下事件的任何设备。电铃
信息此特征属于设备相关信息的任何设备。

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" : "119bfb86-3c27-4e12-ba3c-b35177badda0",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "i_MVBkcoLJkn7d6J1GIhbq5M5m..."
      }
    }
  }
  "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" : "3T7wSCdxnQKNnna6Yxg4DXlLFW..."
  }
}

响应

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

下载相机图片

使用具有基本授权的 HTTP Authorization 标头中的 token，从 GenerateImage 命令响应对 url 进行 GET 调用，以下载相机图片：

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

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

例如，如果相机的宽高比为 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特征的相应 GenerateFormatStream 命令。

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 特征的适当“Extend Format Stream”命令。

RTSP

要扩展 RTSP 流，请使用 CameraLiveStream 特征命令的 ExtendRtspStream 命令获取新的 streamExtensionToken 和 streamToken 值：

请求

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特征的相应 StopFormatStream 命令。

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 错误代码参考。