Schema CameraEventImage

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

sdm.devices.traits.CameraEventImage

Questo trait appartiene a qualsiasi dispositivo che supporta la generazione di immagini dagli eventi.

Campi

Non ci sono campi disponibili per questo trait.

Comandi

GenerateImage

Fornisce un URL da cui scaricare l'immagine di una fotocamera.

Questo comando supporta i seguenti eventi:

Tipo Elemento Descrizione
Evento Evento Movimento del trait CameraMotion La videocamera ha rilevato un movimento.
Evento Evento Persona del tratto CameraPerson La videocamera ha rilevato una persona.
Evento Evento Suono del trait CameraSound La videocamera ha rilevato un suono.
Evento Evento Segnale acustico del trait DoorbellChime Il campanello è stato premuto.
Usa il comando eventId da un evento supportato nella richiesta di comando per ricevere un URL di download per l'immagine della videocamera correlata all'evento.

Genera richiesta e risposta dell'immagine

Richiesta

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

Risposta

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

Campi di richiesta Genera Immagine

Campo Descrizione Tipo di dati
eventId ID dell'evento per cui richiedere un'immagine della videocamera correlata. string
Esempio: "8NYaH5PZ6kftObq1UK3k6qfOcC..."

Campi di risposta Genera Immagine

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 di 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 il token nell'intestazione Autorizzazione HTTP con l'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 videocamera.

Ad esempio, se le proporzioni della fotocamera sono 4:3, per scaricare l'immagine della fotocamera 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 il criterio width, mentre il valore height viene ignorato.
  • Se nell'URL non viene fornito nessuno dei due parametri, viene scelto un valore predefinito di 480 per width.

Vedi il vantaggio FotocameraImage per informazioni sulle proprietà delle immagini.

Errori

In relazione a questa caratteristica, potrebbero essere restituiti i seguenti codici di errore:

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

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