Schéma de DoorbellCarme

Nest Doorbell (ancienne version) Nest Doorbell (batterie) Nest Doorbell (filaire) 

sdm.devices.traits.DoorbellChime

Cette caractéristique appartient à tout appareil compatible avec le carillon et les événements de presse associés.

Champs

Aucun champ n'est disponible pour cette caractéristique.

Commandes

Aucune commande n'est disponible pour cette caractéristique.

Événements

Carillon

Mise à jour 

Une pression sur la sonnette a été déclenchée.

Cet événement accepte les notifications pouvant être mises à jour. Les notifications d'applications existantes créées à partir de cet événement peuvent être modifiées à l'aide du contenu d'un événement ultérieur avec le même eventThreadId.

Événement de carillon

Charge utile

{
  "eventId" : "28a8edb9-34a0-4128-8872-82a8f78a3673",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "t98yRDcz1tdnBbo9DqMM0ZSpu4..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }

Champs d'événement de carillon

Champ Description Type de données
eventSessionId Nest Doorbell (batterie) Nest Doorbell (filaire) Identifiant attribué aux événements qui se produisent lors d'une même session d'événements associés. Peut être utilisé pour regrouper des événements.

Utilisez-le pour associer cet événement à l'événement ClipPreview associé à la caractéristique CameraClipPreview.

string
Exemple: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
eventId Nest Doorbell (ancienne sonnette) Identifiant associé à l'événement.

Utilisez-la avec la commande GenerateImage pour télécharger l'image de caméra associée à cet événement.

string
Exemple: "t98yRDcz1tdnBbo9DqMM0ZSpu4..."

Champs de charge utile de l'événement

Champ Description Type de données
eventId Identifiant unique de l'événement. string
Exemple: "28a8edb9-34a0-4128-8872-82a8f78a3673"
timestamp L'heure à laquelle l'événement s'est produit. string
Exemple: "2019-01-01T00:00:01Z"
resourceUpdate Objet qui détaille des informations sur la mise à jour de la ressource. object
userId Identifiant unique et obscurci qui représente l'utilisateur. string
Exemple: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
eventThreadId Updateable Identifiant unique du fil de discussion de l'événement. string
Exemple: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
eventThreadState Updateable État du thread de l'événement. string
Valeurs: "STARTED", "UPDATED", "ENDED"
resourceGroup Objet qui indique les ressources susceptibles d'avoir des mises à jour semblables à cet événement. La ressource de l'événement lui-même (à partir de l'objet resourceUpdate) sera toujours présente dans cet objet. object

Consultez la page Événements pour en savoir plus sur les différents types d'événements et leur fonctionnement.

Erreurs

Le ou les codes d'erreur suivants peuvent être renvoyés pour cette caractéristique:

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

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.