Google is committed to advancing racial equity for Black communities. See how.

相機

巢式凸輪

鳥巢凸輪™是一個互聯網連接的設備是直觀和易於使用。它不斷了解家中的使用模式,以節省能源並優化安全性和舒適度。用戶可以從任何可以訪問 Internet 連接的地方控制 Nest Cam。

巢API提供訪問關於巢凸輪以下數據,依賴於權限級別授予:

  • 結構名稱和設備“where name”(在家中的位置)
  • 相機在線狀態或麥克風狀態
  • 流媒體狀態(打開/關閉視頻流)
  • 設備名稱和位置標識符
  • 上次在線狀態更改(上次在線/離線更改)
  • 巢意識到訂閱狀態(錄取/未註冊)
  • 深層鏈接在直播相機飼料Nest應用(iOS版,Android)或在網絡上home.nest.com
  • 與上次觸發通知的事件相關的內容,包括:
    • 檢測到聲音或動作事件
    • 事件開始/停止時間
    • 圖像和 gif 文件的深層鏈接
  • 按需圖像快照
  • 共享狀態和公共共享URL
  • 活動區名稱,當有一個運動事件,發生的運動,其中的ID(需要鳥巢感知

相機類型

Nest API 支持多種相機類型:

  • Nest Cam Indoor — 最初的室內 Nest 攝像頭
  • Nest Cam Outdoor — 原始的戶外 Nest 相機
  • Nest Cam IQ Indoor — 具有額外處理能力的室內 Nest 攝像頭,可實現複雜的識別、揚聲器和快照功能
  • Nest Cam IQ Outdoor — 具有額外處理能力的戶外 Nest 攝像頭,可實現複雜的識別、揚聲器和快照功能
  • Nest Hello — 用作可視門鈴的攝像頭

請注意,所有 Nest 相機都以相同的方式出現在 API 中。對於 Nest Hello,僅設備的相機部分出現在 Nest API 中。 API 中不提供攝像頭以外的門鈴功能。

相機權限

Nest Cam 可使用以下訪問權限級別:



使用權
權限
相機讀取

相機讀/寫

相機讀取 + 圖像

相機讀/寫+圖像
可以讀取所有的值,但不包括
activity_zones
is_public_share_enabled
public_share_url
snapshot_url
last_event/image_url
last_event/animated_image_url
last_event/activity_zone_ids
是的是的
可以讀取所有值是的是的
能寫is_streaming (相機開/關)
•此狀態變化需要明確的用戶協議
是的是的

欲了解更多信息,請參見權限概述

相機標識符

設備

Nest 設備按類型作為 ID 數組列出,可用於通過設備路徑唯一標識設備。所以攝像機ID "awJo6rH..."意味著你可以加載在相機設備型號devices/cameras/awJo6rH...通過API。

當一個設備連接到多個產品時,每個開發人員都會看到該設備的不同 ID。對於安裝了來自同一開發者的多個產品的設備,開發者將看到相同的 ID。

名稱

結構的名稱默認為“Home”,但可以是用戶選擇的任何字符串。

name

在這些例子中, name是“樓下”或“樓下(前門)”。

名稱用法名稱用法

name_long

設備的較長顯示名稱。在這個例子中, name_long是“辦公室(樓上)”。

留言中的name_long

在哪裡

where_id

  • 代表一個唯一的,巢生成的標識符name
  • where_id是只讀的,並在通話中自動創建創建自定義的地方name

了解更多關於哪裡的名字鳥巢恆溫器巢保護巢凸輪

where_name

當您選擇攝像頭讀取權限,您可以訪問設備where_name從設備對象( devices/cameras )。

相機功能

視頻流

現場直播

使用這些 URL 從網絡或應用程序訪問實時流頁面:

打開/關閉流式傳輸

使用is_streaming領域打開或關閉相機。

  • 根據用戶的家庭網絡和您的實施,響應時間可能會有延遲
  • 您必須徵得用戶的許可才能更改流媒體狀態(打開/關閉相機)

上次活動

last_event對象是用來獲取深層鏈接到最後檢測到的聲音,動作,或親自出席,並獲得相關圖像或GIF文件。

典型使用案例last_event/has_person場是觸發燈,或洗衣設置為一個安靜的週期。

安全

使用last_event對象和結構的away狀態,結構的wwn_security_state值可以從升級okdeter ,它可以引發其他設備。請參閱安全指南的威懾功能。

用於顯示上次記錄的事件,需要用戶登錄帳戶。

圖像或 GIF 文件

籃子裡的貓

為了使您的產品以獲得最後一個事件的網址,用戶必須有一個活躍的窩意識到訂閱,您必須選擇相機“+圖像”為您的客戶端權限之一。

當你為一個呼叫image_urlanimated_image_url ,你會得到以下格式的URL:

"STRING1/device_id/STRING2?auth=camera_token"

使用此 URL 查看圖像或 GIF。

請注意,STRING 值僅供內部 Nest 使用。不要更改 STRING 值,否則調用將失敗。

按需快照

使用此字段從實時視頻流中獲取快照。

  • snapshot_url -返回實況視頻流捕獲的圖像的URL
  • 要求相機已打開並正在流式傳輸

如果您符合以下條件,API 的快照質量僅為 1080p 吞吐量:

  • 在應用程序中積極地觀察攝像機流( web_url
  • 積極觀看公共流( app_url
  • 訂閱了 Nest Aware

如果您沒有積極查看流或沒有 Nest Aware 訂閱,則該 API 沒有 1080p 源可從中檢索該分辨率的快照並生成較低質量的圖像。此外,低本地網絡帶寬可能會導致 API 快照分辨率在 Nest Aware 存在的情況下低於 1080p。

詳細了解了鳥巢相機的帶寬需求

快照速率限制

當你撥打電話,以獲得snapshot_url ,我們將這些速率限制:

  • 對於未訂閱 Nest Aware 的攝像頭,每分鐘 2 次
  • 對於訂閱了 Nest Aware 的相機,每分鐘 10 次

活動區

為了使您的產品進入活動區信息,用戶必須有一個活躍的窩意識到訂閱(除非它是一個鳥巢凸輪IQ),你必須選擇相機為你的客戶“+圖像”權限之一。

當發生運動事件時,您可以讀取發生運動的活動區域 ID。

  • activity_zones -list所有區名稱,包括用戶定義和自動生成的名稱(S)
    • 示例響應: "activity_zones": [ {"name": "Porch", "id": 244083}, {"name": "Walkway", "id": 237084} ... ]
    • 在此示例中,用戶將默認的“Zone 1”更改為“Porch”,將“Zone 2”更改為“Walkway”
  • last_event/activity_zone_ids的最後一個事件期間檢測到的運動區域ID的-list
    • 示例響應: "activity_zone_ids" : [ "237084", "244083" ]

公開分享網址

結合使用這兩個字段來檢查用戶是否已公開視頻流,如果是,請訪問該 URL。

反向鏈接橫幅

如果您正在為 iOS 8 或更高版本構建應用程序,則需要在使用相機 API 時添加反向鏈接。

參數

名稱類型必需的描述
CUSTOM_SCHEME細繩是的• 為您的應用自定義 URL 方案
了解更多關於URI方案
APPNAME細繩是的• 您的應用程序名稱
• 顯示在返回橫幅中
• 可以本地化
BACKLINK_PATH細繩是的• 回到您的應用程序的路徑
了解更多關於反向鏈接

打電話

當您構建用戶查看實時視頻流或事件的流時,請包含反向鏈接路徑:

  1. 收到app_url從鳥巢API。它應該是這個樣子: "nestmobile://cameras/CjZHZ….7IYIm?auth=c.QbpCljxi5...Ny4gh&"
  2. 添加參數到app_url在此查詢字符串格式
    "nestmobile://cameras/CjZHZ….7IYIm?auth=c.QbpCljxi5...Ny4gh&appname=APPNAME&backlink=CUSTOM_SCHEME://BACKLINK_PATH"

錯誤信息

對於哪些API調用錯誤的含義及如何處理這些信息,請參閱錯誤信息