DoorbellChime Schema
Nest Doorbell (legacy)
sdm.devices.traits.DoorbellChime
This trait belongs to any device that supports a doorbell chime and related press events.
Fields
There are no fields available for this trait.
Commands
There are no commands available for this trait.
Events
Chime
UpdateableThe doorbell has been pressed.
This event supports updateable notifications. Existing app notifications created from this event can be updated using the content of an subsequent event with the same eventThreadId
.
Chime event
Payload
{ "eventId" : "178d61bb-c6c3-478e-a995-47ba1abd5fa8",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime
" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "e4O4VQ5u2ZVToiXQXNZQFP1Twh..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }
Chime event fields
Field | Description | Data Type |
---|---|---|
eventSessionId |
Nest Doorbell (battery) Use it to associate this event with the related ClipPreview event of the CameraClipPreview trait. |
string Example: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..." |
eventId |
Nest Doorbell (legacy) Use it with the GenerateImage command to download the camera image related to this event. |
string Example: "e4O4VQ5u2ZVToiXQXNZQFP1Twh..." |
Event payload fields
Field | Description | Data Type |
---|---|---|
eventId |
The unique identifier for the event. | string Example: "178d61bb-c6c3-478e-a995-47ba1abd5fa8" |
timestamp |
The time when the event occurred. | string Example: "2019-01-01T00:00:01Z" |
resourceUpdate |
An object that details information about the resource update. | object |
userId |
A unique, obfuscated identifier that represents the user. | string Example: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi" |
eventThreadId |
Updateable |
string Example: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59" |
eventThreadState |
Updateable |
string Values: "STARTED", "UPDATED", "ENDED" |
resourceGroup |
An object that indicates resources that might have similar updates to this event. The resource of the event itself (from the resourceUpdate object) will always be present in this object. |
object |
See Events for more information on the different types of events and how they work.
Errors
The following error code(s) may be returned in relation to this trait:
Error Message | RPC | Troubleshooting |
---|---|---|
Camera image is no longer available for download. | DEADLINE_EXCEEDED |
Event images expire 30 seconds after the event is published. Make sure to download the image prior to expiration. |
Event id does not belong to the camera. | FAILED_PRECONDITION |
Use the correct eventID returned by the camera event. |
See the API Error Code Reference for the full list of API error codes.