Join us online for the "Hey Google" Smart Home Summit on July 8th! Register here to learn what's new, and what's coming up for Google Smart Home.

Smart Home Scene Guide

Device TYPE

action.devices.types.SCENE In the case of scenes, the type maps 1:1 to the trait, as scenes don't combine with other traits to form composite devices.

Scenes should always have user-provided names, not default 'BobCo Scene' naming. Each scene is its own virtual device, with its own name(s). User-provided names may come in from SYNC.

action.devices.traits.Scene

These traits are recommended, if applicable to your device. However, you are free to mix and match from all available traits to best match your existing product functionality.

Sample SYNC Request and Response

This is an example using the device type and traits above. It is intended to give an idea of how to build a SYNC response. If you add or remove traits, this will need to be modified to reflect those changes.

Request
{
    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "inputs": [{
      "intent": "action.devices.SYNC"
    }]
}
Node.js
'use strict';

const {smarthome} = require('actions-on-google');
const functions = require('firebase-functions');

const app = smarthome();

app.onSync((body, headers) => {
  return {
    requestId: body.requestId,
    payload: {
      agentUserId: '1836.15267389',
      devices: [{
        id: '123',
        type: 'action.devices.types.SCENE',
        traits: [
          'action.devices.traits.Scene'
        ],
        name: {
          defaultNames: [],
          name: 'Party Mode',
          nicknames: []
        },
        willReportState: true, // should be false, as there's no state
        attributes: {
          sceneReversible: true
        },
        // Note -- probably no device info for virtual devices.
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) {
  SyncResponse.Payload payload = new SyncResponse.Payload();
  payload.setAgentUserId("1836.15267389");
  payload.setDevices(
      new SyncResponse.Payload.Device[] {
        new SyncResponse.Payload.Device.Builder()
            .setId("123")
            .setType("action.devices.types.SCENE")
            .addTrait("action.devices.traits.Scene")
            .setName(DeviceProto.DeviceNames.newBuilder().setName("Party Mode").build())
            .setWillReportState(false)
            .setAttributes(new JSONObject().put("sceneReversible", true))
            .setCustomData(
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "lambtwirl")
                    .toString())
            .build()
      });
  return new SyncResponse(syncRequest.getRequestId(), payload);
}
JSON
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.SCENE",
        "traits": [
          "action.devices.traits.Scene"
        ],
        "name": {
          "defaultNames": [],
          "name": "Party Mode",
          "nicknames": []
        },
        "willReportState": true,
        "attributes": {
          "sceneReversible": true
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.