Écran

Nest Hub Max

L'écran Google Nest Hub Max est compatible avec l'API Smart Device Management (SDM). Cet appareil renvoie un type d'appareil DISPLAY :

sdm.devices.types.DISPLAY

Le Google Nest Hub Max est équipé d'une caméra qui fonctionne de la même manière qu'un type d'appareil CAMERA.

Traits

Référence

Les caractéristiques, commandes ou événements suivants sont associés à cet appareil :

TraitDescriptionCommandesÉvénements
CameraEventImageCette caractéristique appartient à tout appareil qui permet de générer des images à partir d'événements.GenerateImage
CameraImageCe trait appartient à tout appareil permettant de prendre des photos.
CameraLiveStreamCe trait appartient à tout appareil compatible avec la diffusion en direct.GenerateRtspStream
ExtendRtspStream
StopRtspStream
CameraMotionCe trait appartient à tout appareil compatible avec les événements de détection de mouvement.Mouvement
CameraPersonCe trait appartient à tout appareil compatible avec les événements de détection de personnes.Personne
CameraSoundCe trait appartient à tout appareil compatible avec les événements de détection du son.Son
InfosCe trait appartient à tout appareil pour les informations le concernant.

JSON

L'absence d'un trait dans une réponse GET indique que le trait ou la fonctionnalité ne sont actuellement pas disponibles pour l'appareil. Pour en savoir plus, consultez Types d'appareils.

{
  "type" : "sdm.devices.types.DISPLAY",
  "traits" : {
    "sdm.devices.traits.CameraEventImage" : {},
    "sdm.devices.traits.CameraImage" : {
      "maxImageResolution" : {
        "width" : 1280,
        "height" : 960
      }
    },
    "sdm.devices.traits.CameraLiveStream" : {
      "maxVideoResolution" : {
        "width" : 640,
        "height" : 480
      },
      "videoCodecs" : ["H264"],
      "audioCodecs" : ["AAC"],
      "supportedProtocols" : ["WEB_RTC"]
    },
    "sdm.devices.traits.CameraMotion" : {},
    "sdm.devices.traits.CameraPerson" : {},
    "sdm.devices.traits.CameraSound" : {},
    "sdm.devices.traits.Info" : {
      "customName" : "My device"
    }
  }
}

Gérer les événements de caméra

Les événements suivants peuvent être déclenchés à partir d'un type d'appareil DISPLAY :

Type Élément Description
Événement Événement Motion du trait CameraMotion Un mouvement a été détecté par la caméra.
Événement Événement Person du trait CameraPerson Une personne a été détectée par la caméra.
Événement Événement Sound du trait CameraSound Un son a été détecté par la caméra.
Par exemple, la caméra a détecté un mouvement :

Charge utile

{
  "eventId" : "c83a425a-32c5-43e9-8aaf-ef4d23642fcd",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraMotion.Motion" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "LbIG5MKg_qLkZXrDifvzWKkJJk...",
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}
La charge utile de cet événement contient un eventId qui peut être utilisé avec la commande GenerateImage. Cette commande renvoie une URL de téléchargement pour l'image de la caméra associée à l'événement :

Requête

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

Réponse

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

Télécharger une image de caméra

Effectuez un appel GET à url à partir d'une réponse de commande GenerateImage, en utilisant token dans l'en-tête d'autorisation HTTP avec autorisation de base, pour télécharger l'image de la caméra :

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

Utilisez les paramètres de requête width ou height pour personnaliser la résolution de l'image téléchargée. Un seul de ces paramètres doit être spécifié. L'autre paramètre est mis à l'échelle automatiquement en fonction du format de la caméra.

Par exemple, si le format de la caméra est 4:3, pour télécharger l'image de la caméra avec une résolution de 480 x 360, spécifiez la largeur ou la hauteur :

Largeur

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

Hauteur

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

D'autres restrictions s'appliquent à l'URL de téléchargement :

  • Si les deux paramètres sont fournis dans l'URL, width est utilisé et height est ignoré.
  • Si aucun paramètre n'est fourni dans l'URL, la valeur par défaut de width est définie sur 480.

Consultez le trait CameraImage pour en savoir plus sur les propriétés des images.

Accéder à une diffusion en direct

Le flux en direct d'une caméra est accessible. Les formats de flux suivants sont compatibles avec cet appareil :

  • RTSP

Pour obtenir la liste complète des caméras et des formats de flux compatibles, consultez Appareils compatibles.

Pour accéder à un flux en direct, utilisez la commande GenerateFormatStream appropriée du traitCameraLiveStream.

RTSP

Pour un flux RTSP, la commande GenerateRtspStream du trait CameraLiveStream renvoie l'URL du flux et les streamToken associés :

Requête

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
  "params" : {}
}

Réponse

{
  "results" : {
    "streamUrls" : {
      "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken"
    },
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
    "streamToken" : "g.0.streamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

Utilisez ensuite l'URL du flux pour accéder au flux en direct de la caméra :

rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken

Les URL de flux en direct RTSP ne peuvent pas être partagées entre les clients. Une URL de flux ne peut être utilisée que par un seul client à la fois. Si plusieurs clients souhaitent diffuser des flux depuis la même caméra en même temps, des commandes RTSP doivent être envoyées pour chaque client individuel, et chaque client individuel doit utiliser sa propre URL de flux.

Prolonger une diffusion en direct

Les sessions de flux en direct de la caméra ne sont valides que pendant cinq minutes. Si vous devez prolonger la durée de vie d'un flux en direct, utilisez la commande ExtendFormatStream appropriée du trait CameraLiveStream pour le format de flux que vous avez généré.

RTSP

Pour étendre un flux RTSP, utilisez la commande ExtendRtspStream du trait CameraLiveStream pour obtenir de nouvelles valeurs streamExtensionToken et streamToken :

Requête

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.ExtendRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

Réponse

{
  "results" : {
    "streamExtensionToken" : "dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "streamToken" : "g.0.newStreamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

Mettez à jour l'URL de diffusion avec ces nouvelles valeurs pour continuer à regarder la diffusion en direct :

rtsps://someurl.com/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?auth=g.0.newStreamingToken

Arrêter une diffusion en direct

Chaque fois que vous n'utilisez plus le flux vidéo en direct d'une caméra, vous devez l'arrêter et l'invalider. Pour ce faire, utilisez la commande StopFormatStream appropriée du traitCameraLiveStreampour le format de flux que vous avez généré.

RTSP

Pour arrêter un flux RTSP, utilisez le jeton à invalider avec la commande StopRtspStream de la commande de trait CameraLiveStream :

Requête

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.StopRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

Réponse

{}

Erreurs

Le ou les codes d'erreur suivants peuvent être renvoyés en lien avec cet appareil :

Message d'erreur RPC Dépannage
L'image de la caméra n'est plus disponible au téléchargement. DEADLINE_EXCEEDED Les images d'événements expirent 30 secondes après la publication de l'événement. Veillez à télécharger l'image avant son expiration.
L'ID d'événement n'appartient pas à la caméra. FAILED_PRECONDITION Utilisez le eventID correct renvoyé par l'événement de l'appareil photo.

Consultez la documentation de référence sur les codes d'erreur de l'API pour obtenir la liste complète des codes d'erreur de l'API.