CameraEventImage スキーマ

Google Nest Cam（旧型） Google Nest Hub Max Google Nest Doorbell（旧型） 

sdm.devices.traits.CameraEventImage

このトレイトは、イベントから画像を生成できるデバイスに使用します。

フィールド

このトレイトで使用できるフィールドはありません。

コマンド

GenerateImage

カメラの画像をダウンロードするための URL を提供します。

このコマンドは次のイベントをサポートしています。

タイプ 要素 説明
イベント Motion トレイトのモーション イベント カメラが動きを検出しました。
イベント CameraPerson トレイトの人物イベント カメラが人物を検出しました。
イベント サウンド イベント (CameraSound トレイト) カメラが音を検出しました。
イベント DoorbellChime トレイトのチャイム イベント ドアホンが押されました。
コマンド リクエストでサポートされているイベントの eventId を使用すると、そのイベントに関連するカメラ画像のダウンロード URL を受け取ることができます。

GenerateImage リクエストとレスポンス

リクエスト

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

レスポンス

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

GenerateImage リクエスト フィールド

フィールド 説明 データ型
eventId 関連するカメラ画像の取得をリクエストするイベントの ID。 string
例: 「-SN9UDcIBMGCQhoGXLhXU6lbpA...」

GenerateImage レスポンス フィールド

フィールド 説明 データ型
url カメラ画像をダウンロードする URL。 string
例: 「https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...」
token 画像をダウンロードするときに HTTP Authorization ヘッダーで使用するトークン。 string
例: 「g.0.eventToken」

カメラ画像をダウンロードする

GenerateImage 

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

width クエリ パラメータまたは height クエリ パラメータを使用して、 ダウンロードした画像の解像度をカスタマイズします。指定する必要があるのは、これらのパラメータのうち 1 つだけです。もう一方のパラメータは、カメラのアスペクト比に応じて自動的にスケーリングされます 。

たとえば、カメラのアスペクト比が 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

ダウンロード URL には、次の制限が適用されます。

  • URL に両方のパラメータが指定されている場合は、width が使用され、height は無視されます。
  • URL にどちらのパラメータも指定されていない場合は、デフォルト値として 480 が選択されます。 width

画像のプロパティについては、 CameraImage トレイトをご覧ください。

エラー

このトレイトに関連して、次のエラーコードが返されることがあります。

エラー メッセージ RPC トラブルシューティング
カメラ画像はダウンロードできなくなりました。 DEADLINE_EXCEEDED イベント画像は、イベントが公開されてから 30 秒後に期限切れになります。期限切れになる前に画像をダウンロードしてください。
イベント ID がカメラに属していません。 FAILED_PRECONDITION カメラ アクティビティから返された正しい eventID を使用してください。

API エラーコードの一覧については、API エラーコード リファレンスをご覧ください。