Schéma DoorbellChime

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

sdm.devices.traits.DoorbellChime

Cette caractéristique appartient à tout appareil compatible avec une sonnerie de sonnette et les événements de pression associés.

Champs

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

Commandes

Aucune commande n'est disponible pour ce trait.

Événements

Carillon

Mise à jour possible 

La sonnette a été déclenché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 "Carillon"

Charge utile

{
  "eventId" : "cbcfe550-7747-4258-98a9-8703306ed57e",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "oQy2FDX-yKBujCbebQbDpyb8pn..."
      }
    }
  }
  "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) ID attribué aux événements qui se produisent au cours d'une même session d'événements associés. Peut être utilisé pour consolider des événements.

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

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

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

 string
Exemple: "oQy2FDX-yKBujCbebQbDpyb8pn..."

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

Champ Description Type de données
eventId Identifiant unique de l'événement. string
Exemple: "cbcfe550-7747-4258-98a9-8703306ed57e"
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 mise à jour de la ressource. object
userId Identifiant unique et brouillé représentant l'utilisateur. string
Exemple: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
eventThreadId Modifiable Identifiant unique du thread d'événement. string
Exemple: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
eventThreadState Modifiable État du thread d'événement. string
Valeurs: "STARTED", "UPDATED", "ENDED"
resourceGroup Objet qui indique les ressources susceptibles de disposer de mises à jour similaires à celles de cet événement. La ressource de l'événement lui-même (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 lien avec cette caractéristique:

Message d'erreur RPC Dépannage
L'image de la caméra n'est plus disponible au téléchargement. DEADLINE_EXCEEDED Les images des é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 la eventID correcte renvoyée 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.