Smart Home Sprinkler Guide

Device TYPE

action.devices.types.SPRINKLER Sprinklers can start and stop (or turn on and off). In the future, they may support timers and/or schedules.

This type indicates that the device gets the appropriate icon and some sprinkler-type synonyms/aliases.

action.devices.traits.StartStop - This trait covers starting, stopping, and possibly pausing the sprinkler. Note that the language Turn on/off the sprinkler is covered by StartStop.

These are our recommendations for traits on this type of device, however you are free to mix and match from all available traits to best match your existing product functionality.

Please see each individual trait document for implementation details like required attributes, EXECUTE and QUERY.

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.SPRINKLER',
        traits: [
          'action.devices.traits.StartStop'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corp Sprinkler'],
          name: 'sprinkler',
          nicknames: []
        },
        willReportState: true,
        attributes: {
          pausable: false
        },
        deviceInfo: {
          manufacturer: 'sirius',
          model: '442',
          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("1836.15267389");
  payload.setDevices(new SyncResponse.Payload.Device[] {
      new SyncResponse.Payload.Device.Builder()
          .setId("123")
          .setType("action.devices.types.SPRINKLER")
          .addTrait("action.devices.traits.StartStop")
          .setName(
              Collections.singletonList("Sirius Cybernetics Corp Sprinkler"),
              "sprinkler",
              new ArrayList()
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("pausable", false)
          )
          .setDeviceInfo("sirius", "442", "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": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.SPRINKLER",
        "traits": [
          "action.devices.traits.StartStop"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corp Sprinkler"
          ],
          "name": "sprinkler",
          "nicknames": []
        },
        "willReportState": true,
        "attributes": {
          "pausable": false
        },
        "deviceInfo": {
          "manufacturer": "sirius",
          "model": "442",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.