Skema CameraEventImage

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

sdm.devices.traits.CameraEventImage

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

Kolom

Tidak ada kolom yang tersedia untuk karakteristik ini.

Perintah

GenerateImage

Menyediakan URL untuk mendownload gambar kamera.

Perintah ini mendukung peristiwa berikut:

Jenis Elemen Deskripsi
Acara Peristiwa Motion fitur CameraMotion Gerakan telah terdeteksi oleh kamera.
Acara Peristiwa Person dari karakteristik CameraPerson Seseorang telah terdeteksi oleh kamera.
Acara Peristiwa Suara dari karakteristik CameraSound Suara telah terdeteksi oleh kamera.
Acara Peristiwa Chime 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" : "4ydmwYgVf-F6f3bPO1dVBVnfKV..."
  }
}

Respons

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

Kolom permintaan GenerateImage

Kolom Deskripsi Jenis Data
eventId ID peristiwa yang akan meminta gambar kamera terkait. string
Contoh: "4ydmwYgVf-F6f3bPO1dVBVnfKV..."

Kolom respons GenerateImage

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

Mendownload gambar kamera

Lakukan panggilan GET ke url dari GenerateImage Respons perintah , 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 480x360, tentukan lebar atau tingginya:

Lebar

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

Tinggi

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

Batasan lain untuk URL download berlaku:

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

Lihat sifat CameraImage untuk mengetahui informasi tentang properti gambar.

Error

Kode error berikut mungkin ditampilkan terkait dengan fitur ini:

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

Lihat Referensi Kode Error API untuk daftar lengkap kode error API.