CameraEventImage スキーマ
Google Nest Cam(従来版)
sdm.devices.traits.CameraEventImage
このトレイトは、イベントからの画像の生成をサポートするデバイスに使用します。
フィールド
このトレイトで使用できるフィールドはありません。
コマンド
GenerateImage
カメラ画像のダウンロード元 URL を指定します。
このコマンドは、次のイベントをサポートしています。
タイプ | 要素 | 説明 |
---|---|---|
イベント | CameraMotion トレイトのモーション イベント | カメラで動きが検知されました。 |
イベント | CameraPerson トレイトの Person イベント | カメラで人物が検出されました。 |
イベント | CameraSound トレイトのサウンド イベント | カメラで音が検知されました。 |
イベント | DoorbellChime トレイトのチャイム イベント | ドアホンが押されました。 |
eventId
を使用して、そのイベントに関連するカメラ画像のダウンロード URL を取得します。
GenerateImage リクエストとレスポンス
リクエスト
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.CameraEventImage.GenerateImage
",
"params" : {
"eventId" : "wdV6EpG0YlTKA0AXwvGCdocfMM..."
}
}
レスポンス
{ "results" : { "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...", "token" : "g.0.eventToken" } }
GenerateImage リクエスト フィールド
項目 | 説明 | データの種類 |
---|---|---|
eventId |
関連するカメラ画像をリクエストするイベントの ID。 | string 例: 「wdV6EpG0YlTKA0AXwvGCdocfMM...」 |
GenerateImage レスポンス フィールド
項目 | 説明 | データの種類 |
---|---|---|
url |
カメラ画像のダウンロード元 URL。 | string 例: 「https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...」 |
token |
イメージをダウンロードする際に HTTP Authorization ヘッダーで使用するトークン。 | string 例: 「g.0.eventToken」 |
カメラ画像をダウンロードする
GenerateImage
コマンド レスポンスから url
への GET 呼び出しを行い、HTTP 認証ヘッダーの token
で Basic 認証を使用して、カメラ画像をダウンロードします。
curl -H "Authorization: Basic g.0.eventToken" \
https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...
ダウンロードされる画像の解像度をカスタマイズするには、width
または height
クエリ パラメータを使用します。これらのパラメータのいずれか 1 つのみを指定する必要があります。もう 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 にどちらのパラメータも指定されていない場合、
width
にはデフォルト値の 480 が選択されます。
画像のプロパティについては、 CameraImage トレイトをご覧ください。
エラー
このトレイトに関して、次のエラーコードが返されることがあります。
エラー メッセージ | RPC | トラブルシューティング |
---|---|---|
カメラ画像はダウンロードできなくなりました。 | DEADLINE_EXCEEDED |
イベント画像は、イベントの公開から 30 秒後に期限切れになります。有効期限が切れる前に、画像をダウンロードしてください。 |
アクティビティ ID はカメラのものではありません。 | FAILED_PRECONDITION |
カメラ イベントから返された正しい eventID を使用します。 |
API エラーコードの完全なリストについては、API エラーコード リファレンスをご覧ください。