Schema CameraEventImage

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

sdm.devices.traits.CameraEventImage

Questa caratteristica appartiene a qualsiasi dispositivo che supporta la generazione di immagini da eventi.

Campi

Non sono disponibili campi per questa caratteristica.

Comandi

GenerateImage

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

Questo comando supporta i seguenti eventi:

Tipo Elemento Descrizione
Evento Evento di movimento della caratteristica CameraMotion La videocamera ha rilevato un movimento.
Evento Evento "Persona" della caratteristica CameraPerson La videocamera ha rilevato una persona.
Evento Evento "Suono" della caratteristica CameraSound La videocamera ha rilevato un suono.
Evento Evento Cicalino della caratteristica DoorbellChime È stato premuto il campanello.
Utilizza il eventId di un evento supportato nella richiesta del comando per ricevere un URL di download per l'immagine della videocamera correlata a quell'evento.

Richiesta e risposta di GenerateImage

Richiesta

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

Risposta

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

Campi della richiesta GenerateImage

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

Campi della risposta GenerateImage

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

Scaricare un'immagine della videocamera

Esegui una chiamata GET al url da una GenerateImage risposta del comando, utilizzando il token nell'intestazione HTTP Authorization con l'autorizzazione di base, per scaricare l' immagine della videocamera:

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 scalato automaticamente in base alle proporzioni della videocamera.

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 all'URL di download:

  • Se entrambi i parametri vengono forniti nell'URL, width viene utilizzata e height viene ignorata.
  • Se nessuno dei due parametri viene fornito nell'URL, viene scelto un valore predefinito di 480 per il width.

Per informazioni sulle proprietà delle immagini , consulta la caratteristica CameraImage .

Errori

Per questa caratteristica potrebbero essere restituiti i seguenti codici di errore:

Messaggio di errore RPC Risoluzione dei problemi
L'immagine della videocamera non è più disponibile per il download. DEADLINE_EXCEEDED Le immagini degli eventi 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 l'eventID corretto restituito dall'evento della videocamera.

Per l'elenco completo dei codici di errore dell'API, consulta il riferimento ai codici di errore dell'API.