Schema CameraEventImage

Nest Cam (legacy) Nest Hub Max Nest Doorbell (legacy) 

sdm.devices.traits.CameraEventImage

Questo tratto appartiene a qualsiasi dispositivo che supporta la generazione di immagini da eventi.

Campi

Nessun campo disponibile per questo tratto.

Comandi

GenerateImage

Fornisce un URL da cui scaricare un'immagine della videocamera.

Questo comando supporta i seguenti eventi:

Tipo Elemento Descrizione
Evento Evento Movimento del tratto CameraMotion La videocamera ha rilevato un movimento.
Evento Evento Persona del tratto CameraPersona La videocamera ha rilevato una persona.
Evento Evento Sound del tratto CameraSound La videocamera ha rilevato un suono.
Evento Evento Cicalino del tratto Cicalino Campanello Il campanello è stato premuto.
Utilizza eventId di un evento supportato nella richiesta di comando per ricevere un URL di download dell'immagine della videocamera correlata all'evento.

Richiesta e risposta generateImage

Richiesta

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

Risposta

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

Campi di richiesta GeneraImage

Campo Descrizione Tipo di dati
eventId ID dell'evento per cui richiedere un'immagine della videocamera correlata. string
Esempio: "oxyAe4z3_5a-1L6BH5FmxDyMeG..."

Campi di risposta GeneraImage

Campo Descrizione Tipo di dati
url L'URL da cui scaricare l'immagine della fotocamera. string
Esempio: "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token Token da utilizzare nell'intestazione Autorizzazione HTTP durante il download dell'immagine. string
Esempio: "g.0.eventToken"

Scarica un'immagine della fotocamera

Effettua una chiamata GET a url da una risposta del comando GenerateImage , utilizzando token nell'intestazione di autorizzazione HTTP con autorizzazione di base, per scaricare l'immagine della fotocamera:

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

Utilizza i parametri di query width o height per personalizzare la risoluzione dell'immagine scaricata. È necessario specificare solo uno di questi parametri. L'altro parametro viene ridimensionato automaticamente in base alle proporzioni della fotocamera.

Ad esempio, se le proporzioni della videocamera sono 4:3, per scaricare l'immagine della videocamera con una risoluzione di 480 x 360 specifica la larghezza o l'altezza:

Larghezza

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

Altezza

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

Si applicano altre limitazioni agli URL di download:

  • Se nell'URL vengono forniti entrambi i parametri, viene utilizzato width, mentre height viene ignorato.
  • Se nell'URL non viene fornito nessuno dei due parametri, viene scelto un valore predefinito di 480 per width.

Consulta la sezione CameraImage per informazioni sulle proprietà delle immagini.

Errori

Potrebbero essere restituiti i seguenti codici di errore in relazione a questo tratto:

Messaggio di errore RPC Risoluzione dei problemi
L'immagine della fotocamera non è più disponibile per il download. DEADLINE_EXCEEDED Le immagini dell'evento scadono 30 secondi dopo la pubblicazione dell'evento. Assicurati di scaricare l'immagine prima della scadenza.
L'ID evento non appartiene alla videocamera. FAILED_PRECONDITION Utilizza il valore eventID corretto restituito dall'evento della videocamera.

Consulta la pagina Riferimento per i codici di errore API per l'elenco completo dei codici di errore delle API.