Skema CameraEventImage

Nest Cam (lama) Nest Hub Max Nest Doorbell (lama) 

sdm.devices.traits.CameraEventImage

Trait ini milik perangkat apa pun yang mendukung pembuatan gambar dari peristiwa.

Kolom

Tidak ada kolom yang tersedia untuk karakteristik ini.

Perintah

GenerateImage

Memberikan URL tempat mendownload gambar kamera.

Perintah ini mendukung peristiwa berikut:

Jenis Elemen Deskripsi
Event Peristiwa Motion dari karakteristik CameraMotion Gerakan telah terdeteksi oleh kamera.
Event Peristiwa Person dari karakteristik CameraPerson Seseorang telah terdeteksi oleh kamera.
Event Peristiwa Sound dari karakteristik CameraSound Suara telah terdeteksi oleh kamera.
Event Peristiwa Chime pada karakteristik DoorbellChime Bel pintu telah ditekan.
Gunakan eventId dari peristiwa yang didukung dalam permintaan perintah untuk menerima URL download untuk gambar kamera yang terkait dengan peristiwa tersebut.

Permintaan dan respons GenerateImage

Permintaan

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

Respons

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

Kolom permintaan GenerateImage

Kolom Deskripsi Jenis Data
eventId ID peristiwa untuk meminta gambar kamera terkait. string
Contoh: "8NYaH5PZ6kftObq1UK3k6qfOcC..."

Kolom respons GenerateImage

Kolom Deskripsi Jenis Data
url URL tempat mendownload gambar kamera. string
Contoh: "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token Token yang akan digunakan di header Otorisasi HTTP saat mendownload image. string
Contoh: "g.0.eventToken"

Download gambar kamera

Lakukan panggilan GET ke url dari respons perintah GenerateImage , menggunakan token di header Otorisasi HTTP dengan Otorisasi dasar, untuk mendownload gambar kamera:

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

Gunakan parameter kueri width atau height untuk menyesuaikan resolusi gambar yang didownload. Hanya salah satu dari parameter ini yang perlu ditentukan. Parameter lainnya diskalakan secara otomatis sesuai dengan rasio aspek kamera.

Misalnya, jika rasio aspek kamera adalah 4:3, untuk mendownload gambar kamera dengan resolusi 480 x 360, tentukan lebar atau tinggi:

Lebar

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

Tinggi badan

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

Batasan lain untuk URL download berlaku:

  • Jika kedua parameter diberikan di URL, width akan digunakan dan height diabaikan.
  • Jika tidak ada parameter yang diberikan dalam URL, nilai default 480 akan dipilih untuk width.

Lihat fitur CameraImage untuk mengetahui informasi tentang properti gambar.

Error

Kode error berikut mungkin ditampilkan sehubungan dengan karakteristik ini:

Pesan Error RPC Pemecahan masalah
Gambar kamera tidak lagi tersedia untuk didownload. DEADLINE_EXCEEDED Masa berlaku gambar acara akan berakhir 30 detik setelah acara dipublikasikan. Pastikan untuk mendownload image sebelum masa berlakunya habis.
ID peristiwa bukan milik kamera. FAILED_PRECONDITION Gunakan eventID yang benar yang ditampilkan oleh peristiwa terekam kamera.

Baca Referensi Kode Error API untuk mengetahui daftar lengkap kode error API.