CameraEventImage 結構定義

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

sdm.devices.traits.CameraEventImage

這個特徵屬於任何支援從事件產生圖片的裝置。

欄位

沒有任何適用於這個特徵的欄位。

指令

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" : "Vxt3LGd0tiUWxe79U8WWDQ-i1Z..."
  }
}

回應

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

GenerateImage 要求欄位

欄位 說明 資料類型
eventId 要要求相關攝影機影像的事件 ID。 string
例如：「Vxt3LGd0tiUWxe79U8WWDQ-i1Z...」

GenerateImage 回應欄位

欄位 說明 資料類型
url 下載攝影機影像的網址。 string
示例：「https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...」
token 下載圖片時，在 HTTP 授權標頭中使用的符記。 string
例如：「g.0.eventToken」

下載相機圖像

使用 HTTP 授權標頭中的 token 和基本授權，從 GenerateImage 指令回應發出 GET 呼叫至 url，以便下載攝影機圖片：

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 特徵。

錯誤

系統可能會傳回下列與此特徵相關的錯誤代碼：

錯誤訊息 單次點擊收益 疑難排解
不再提供攝影機影像下載功能。 DEADLINE_EXCEEDED 事件圖片會在事件發布 30 秒後失效。請務必在到期前下載映像檔。
事件 ID 不屬於攝影機。 FAILED_PRECONDITION 使用相機事件傳回的正確 eventID。

如需 API 錯誤代碼的完整清單，請參閱 API 錯誤代碼參考資料。