Smart Device Management (SDM) API 支持所有旧版 Nest Doorbell。 此设备会返回设备类型 DOORBELL:
sdm.devices.types.DOORBELL
Google Nest Doorbell(旧版)配有摄像头,其功能与 设备类型。
特征
参考
以下特征、命令或事件与此设备相关:
特征 | 说明 | 命令 | 事件 |
---|---|---|---|
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" : "8cfbc540-68c8-42dd-9bb1-5b71c6ac7fa3",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime
" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "j1L8rc2B4PesaHP2zcdW6A-AwG..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }
eventId
,可与
GenerateImage
命令。此命令会返回与
事件:
请求
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.CameraEventImage.GenerateImage
",
"params" : {
"eventId" : "HMy5lGCGEPspcfxKvpmxoiqf2i..."
}
}
响应
{ "results" : { "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...", "token" : "g.0.eventToken" } }
下载相机图片
从url
GenerateImage 命令响应
使用具有基本授权的 HTTP Authorization 标头中的 token
,以
下载相机图片:
curl -H "Authorization: Basic g.0.eventToken" \
https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...
使用 width
或 height
查询参数自定义
下载的图片只需指定其中一个参数。另一个
参数会根据镜头的宽高比自动调整。
例如,如果相机的宽高比为 4:3,则下载相机图片。 指定宽度或高度:
宽度
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
。
请参阅 CameraImage 特征 有关图片属性的信息
访问直播
可以通过摄像头访问直播画面。以下视频流格式 支持此设备:
- RTSP
如需查看摄像头和支持的视频流格式的完整列表,请参阅 支持的设备。
如需访问直播视频,请使用相应的 GenerateFormatStream 功能 命令 CameraLiveStream trait。
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 特征的相应 ExtendFormatStream 命令。
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
停止直播
每当您不再使用摄像头直播时,应停止录制, 使数据流失效。为此,请使用相应的“停止Format直播” 命令 CameraLiveStream trait。
RTSP
要停止 RTSP 流,请使用令牌让 StopRtspStream 命令,用于安装 CameraLiveStream 特征命令:
请求
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 错误代码的完整列表。