CameraEventImage-Schema

Nest Cam (ältere Version) Nest Hub Max Nest Doorbell (ältere Version) 

sdm.devices.traits.CameraEventImage

Dieses Attribut gehört zu allen Geräten, die die Erstellung von Bildern aus Ereignissen unterstützen.

Felder

Für dieses Attribut 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 Motion-Ereignis des Attributs CameraMotion Die Kamera hat eine Bewegung erkannt.
Ereignis Person-Ereignis des Attributs „CameraPerson“ Die Kamera hat eine Person erkannt.
Ereignis Sound-Ereignis des Attributs CameraSound Die Kamera hat ein Geräusch erkannt.
Ereignis Chime-Ereignis des Attributs DoorbellChime Die Türklingel wurde betätigt.
Verwende 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" : "LBK6lwPD6Nj0YoNGu6-BoPdcfq..."
  }
}

Antwort

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

GenerateImage-Anfragefelder

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

GenerateImage-Antwortfelder

Feld Beschreibung Datentyp
url Die URL, über die das Kamerabild heruntergeladen werden kann. string
Beispiel: „https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...“
token Token, das beim Herunterladen des Bildes im HTTP-Autorisierungsheader verwendet werden soll. string
Beispiel: „g.0.eventToken“

Kamerabild herunterladen

Führe einen GET-Aufruf an die url aus einer GenerateImage- -Befehlsantwort aus. Verwende dabei die token im HTTP-Autorisierungsheader mit einfacher Autorisierung, um das Kamerabild herunterzuladen:

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 Bildes anzupassen. Es muss nur einer dieser Parameter angegeben werden. Der andere Parameter wird automatisch entsprechend dem Seitenverhältnis der Kamera skaliert.

Wenn das Seitenverhältnis der Kamera beispielsweise 4:3 ist, geben Sie entweder die Breite oder die Höhe an, um das Kamerabild mit einer Auflösung von 480 × 360 herunterzuladen:

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 weitere Einschränkungen:

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

Informationen zu den Bildeigenschaften findest du im Merkmal CameraImage .

Fehler

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

Fehlermeldung RPC Fehlerbehebung
Das Kamerabild kann nicht mehr heruntergeladen werden. DEADLINE_EXCEEDED Ereignisbilder laufen 30 Sekunden nach der Veröffentlichung des Ereignisses ab. Laden Sie das Image vor Ablauf herunter.
Die Ereignis-ID gehört nicht zur Kamera. FAILED_PRECONDITION Verwende die richtige eventID, die vom Kamera-Ereignis zurückgegeben wird.

Eine vollständige Liste der API-Fehlercodes finden Sie in der API-Fehlercode-Referenz.