Smart Home Outlet Guide

Device TYPE

action.devices.types.OUTLET Outlet, a basic device in Smart Home, has binary modes on/off only.

Recommended TRAITS

action.devices.traits.OnOff

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.

Initialize outlet setup.

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.OUTLET',
        traits: [
          'action.devices.traits.OnOff'
        ],
        name: {
          defaultNames: ['AAA Outlet C110'],
          name: 'Homer Simple Outlet',
          nicknames: ['wall plug']
        },
        willReportState: true,
        deviceInfo: {
          manufacturer: 'AAA',
          model: 'c110',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'sheepdip'
        }
      }]
    }
  };
});

// ...

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.OUTLET")
            .addTrait("action.devices.traits.OnOff")
            .setName(
                Collections.singletonList("AAA Outlet C110"),
                "Homer Simple Outlet",
                Collections.singletonList("wall plug"))
            .setWillReportState(false)
            .setDeviceInfo("AAA", "c110", "3.2", "11.4")
            .setCustomData(
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "sheepdip")
                    .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.OUTLET",
        "traits": [
          "action.devices.traits.OnOff"
        ],
        "name": {
          "defaultNames": [
            "AAA Outlet C110"
          ],
          "name": "Homer Simple Outlet",
          "nicknames": [
            "wall plug"
          ]
        },
        "willReportState": true,
        "deviceInfo": {
          "manufacturer": "AAA",
          "model": "c110",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "sheepdip"
        }
      }
    ]
  }
}

Validator

Device ERRORS

See the full list of errors and exceptions.