Smart Home Blinds Guide

Device TYPE

action.devices.types.BLINDS - Blinds can be opened and closed, and various types of blinds are supported such as venetian (opens in one direction), panel or vertical (may open either left or right), and top-down bottom-up (may open either up or down).

Recommended TRAITS

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: '123456789',
      devices: [{
        id: '123',
        type: 'action.devices.types.BLINDS',
        traits: [
          'action.devices.traits.OpenClose'
        ],
        name: {
          defaultNames: ['Blinds'],
          name: 'Kitchen window',
          nicknames: ['Sink window']
        },
        willReportState: true,
        attributes: {
          openDirection: ['UP', 'DOWN']
        },
        deviceInfo: {
          manufacturer: 'ACME Blinds',
          model: 'xyz',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        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("123456789");
  payload.setDevices(
      new SyncResponse.Payload.Device[] {
        new SyncResponse.Payload.Device.Builder()
            .setId("123")
            .setType("action.devices.types.BLINDS")
            .addTrait("action.devices.traits.OpenClose")
            .setName(
                Collections.singletonList("Blinds Partner window"),
                "Kitchen window",
                Collections.singletonList("sink window"))
            .setWillReportState(true)
            .setAttributes(new JSONObject().put("openDirection", new String[] {"UP", "DOWN"}))
            .setDeviceInfo("blinds manufacturer", "xyz", "3.2", "11.4")
            .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": "123456789",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.BLINDS",
        "traits": [
          "action.devices.traits.OpenClose"
        ],
        "name": {
          "defaultNames": [
            "Blinds"
          ],
          "name": "Kitchen window",
          "nicknames": [
            "Sink window"
          ]
        },
        "willReportState": true,
        "attributes": {
          "openDirection": [
            "UP",
            "DOWN"
          ]
        },
        "deviceInfo": {
          "manufacturer": "ACME Blinds",
          "model": "xyz",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}

Validator

Device ERRORS

See the full list of errors and exceptions.