Traits

A trait in the SDM API comprises fields , commands , and events .

Fields

Fields are values with common data types, such as a number or a string. For example, a field might contain a the current mode or the ambient humidity of a Google Nest Thermostat.

Traits and fields can be viewed with a GET call to the desired API endpoint:

GET /enterprises/ project-id 
/devices/ device-id 
{
  "name" : "enterprises/ project-id 
/devices/ device-id 
",
  "type" : "sdm.devices.types. device-type 
",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/ project-id 
/structures/ structure-id 
/rooms/ room-id 
",
      "displayName" : "Lobby"
    }
  ]
}

Device types

The sdm.devices.types. device-type returned by the SDM API should not be used to deduce or infer functionality of the actual device it is assigned to. There is no guarantee that a device type will remain stable for a specific device as more features are added to the SDM API. Instead, use the returned traits for the device.

parentRelations

Commands

Commands are requests associated with a trait. For example, changing the current mode or temperature setpoint on a Google Nest Thermostat.

A command is sent by an executeCommand API call:

POST /enterprises/ project-id 
/devices/ device-id 
:executeCommand
{
  "command" : " command-name 
",
  "params" : {
    " field 
" : " value 
"
  }
}

Most responses to a command are a simple success or failure. See the individual trait guides for specific command usage examples.

Events

Events are asynchronous and managed by Google Cloud Pub/Sub in a single topic per Project ID.

Events are sent by default for any change in the value of a trait field. They can also be sent in response to specific device actions or changes in resource assignments. See Events for more information.

Trait categories

Structure

Device

Thermostat

Camera

Doorbell