Cette page a été traduite par l'API Cloud Translation.

Schéma DoorbellChime

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

sdm.devices.traits.DoorbellChime

Ce trait appartient à tout appareil compatible avec une sonnerie de porte 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 disponible

Quelqu'un a appuyé sur la sonnette.

Cet événement est compatible avec les notifications modifiables. 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" : "71951aae-7a21-49b1-8be2-8b6def2689f9",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "4QL7RRSpuLSxt6YbDVr8oUuVsV..."
      }
    }
  }
  "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 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 (ancienne version) 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 : "4QL7RRSpuLSxt6YbDVr8oUuVsV..."

Champs de charge utile des événements

Champ	Description	Type de données
`eventId`	Identifiant unique de l'événement.	`string` Exemple : "71951aae-7a21-49b1-8be2-8b6def2689f9"
`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 fil d'événement.	`string` Exemple : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
`eventThreadState`	Updateable État du thread d'événement.	`string` Valeurs : "STARTED", "UPDATED", "ENDED"
`resourceGroup`	Objet qui indique les ressources susceptibles d'avoir des mises à jour similaires à 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 Événements.

Erreurs

Les codes d'erreur suivants peuvent être renvoyés en lien 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é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.