CameraEventImage – Schema

Nest Cam (alt) Nest Hub Max Nest Doorbell (alt) 

sdm.devices.traits.CameraEventImage

Dieser Trait gehört zu jedem Gerät, das das Generieren von Bildern aus Ereignissen unterstützt.

Felder

Für diese Eigenschaft sind keine Felder verfügbar.

Befehle

GenerateImage

Stellt eine URL zum Herunterladen eines Kamerabilds bereit.

Dieser Befehl unterstützt die folgenden Ereignisse:

Typ Element Beschreibung
Ereignis Ereignis Motion des Attributs „CameraMotion“ Die Kamera hat Bewegung erkannt.
Ereignis Person-Ereignis der Eigenschaft KameraPerson Die Kamera hat eine Person erkannt.
Ereignis Ereignis Geräusch des Kameraton-Tritts Die Kamera hat Geräusche erkannt.
Ereignis Glocken-Ereignis der Eigenschaft „Türklingel“ Die Türklingel wurde gedrückt.
Verwenden Sie die eventId aus einem unterstützten Ereignis in der Befehlsanfrage, um eine Download-URL für das Kamerabild zu erhalten, das mit diesem Ereignis verknüpft ist.

GenerateImage-Anfrage und ‑Antwort

Anfrage

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

Antwort

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

Felder für GenerateImage-Anfragen

Feld Beschreibung Datentyp
eventId ID des Ereignisses, für das ein zugehöriges Kamerabild angefordert werden soll. string
Beispiel: „4ydmwYgVf-F6f3bPO1dVBVnfKV...“

GenerateImage-Antwortfelder

Feld Beschreibung Datentyp
url Die URL, von der das Kamerabild heruntergeladen werden soll. string
Beispiel: „https://domain/sdm_event_Snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...“
token Token, das beim Herunterladen des Bilds im HTTP-Autorisierungsheader verwendet werden soll. string
Beispiel: „g.0.eventToken“

Kamerabild herunterladen

GET-Aufruf an url aus einem GenerateImage -Befehlsantwort mit der Methode token im HTTP-Autorisierungsheader mit Basic-Autorisierung, um den Kamerabild:

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

Verwenden Sie die Abfrageparameter width oder height, um die Auflösung des heruntergeladenen Bilds anzupassen. Nur einer dieser Parameter muss angegeben werden. Der andere Parameter wird skaliert. automatisch an das Seitenverhältnis der Kamera angepasst.

Wenn das Seitenverhältnis der Kamera beispielsweise 4:3 ist, geben Sie zum Herunterladen des Kamerabilds mit einer Auflösung von 480 x 360 entweder die Breite oder die Höhe an:

Breite

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

Höhe

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

Für die Download-URL gelten außerdem folgende Einschränkungen:

  • Wenn in der URL beide Parameter angegeben sind, wird width verwendet und height wird ignoriert.
  • Falls in der URL keiner der beiden Parameter angegeben ist, wird für den Parameter width

Weitere Informationen finden Sie in der Kamera-Bild für Informationen zum Bild Eigenschaften.

Fehler

Die folgenden Fehlercodes können in Bezug auf dieses Merkmal zurückgegeben werden:

Fehlermeldung RPC Fehlerbehebung
Kamerabild kann nicht mehr heruntergeladen werden. DEADLINE_EXCEEDED Ereignisbilder laufen 30 Sekunden nach der Veröffentlichung des Ereignisses ab. Laden Sie das Bild unbedingt vor dem Ablaufdatum herunter.
Ereignis-ID gehört nicht zur Kamera. FAILED_PRECONDITION Verwende die korrekte eventID, die vom Kameraereignis zurückgegeben wurde.

In der API-Fehlercode-Referenz können Sie nachlesen, die vollständige Liste der API-Fehlercodes.