Schéma DoorbellChime

Nest Doorbell (legacy) Nest Doorbell (batterie) Nest Doorbell (filaire) 

sdm.devices.traits.DoorbellChime

Ce trait appartient à tout appareil compatible avec un carillon de sonnette et les événements de pression associés.

Champs

Aucun champ n'est disponible pour ce trait.

Commandes

Aucune commande n'est disponible pour ce trait.

Événements

Carillon

Mise à jour possible 

La sonnette a été pressée.

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

Événement de carillon

Charge utile

{
  "eventId" : "9abbe530-1d55-4b85-a7ac-52b13a843580",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "9Fxm8akF4SZZJjQv4ceO31P39J..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Champs de l'événement de carillon

Champ Description Type de données
eventSessionId Nest Doorbell (batterie) Nest Doorbell (filaire) ID attribué aux événements qui se produisent dans le cadre 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é du trait CameraClipPreview.

 string
Exemple : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
eventId Nest Doorbell (legacy) ID associé à l'événement.

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

 string
Exemple : "9Fxm8akF4SZZJjQv4ceO31P39J..."

Champs de la charge utile de l'événement

Champ Description Type de données
eventId Identifiant unique de l'événement. string
Exemple : "9abbe530-1d55-4b85-a7ac-52b13a843580"
timestamp Heure à laquelle l'événement s'est produit. string
Exemple : "2019-01-01T00:00:01Z"
resourceUpdate Objet contenant des informations détaillées sur la modification de la ressource. object
userId Identifiant unique et obscurci représentant l'utilisateur. string
Exemple : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
eventThreadId Mise à jour possible Identifiant unique du fil d'événement. string
Exemple : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
eventThreadState Mise à jour possible État du fil d'événement. string
Valeurs : "STARTED", "UPDATED", "ENDED"
resourceGroup Objet qui indique les ressources susceptibles d'avoir des modifications similaires de 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

Pour en savoir plus sur les différents types d'événements et leur fonctionnement, consultez la section Événements.

Erreurs

Le ou les codes d'erreur suivants peuvent être renvoyés en relation avec ce trait :

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énement 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 la caméra.

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