Smart Home Water Heater Guide

Device TYPE

action.devices.types.WATERHEATER - Water heaters are devices used to heat water. They may turn on and off, adjust water temperature, or adjust various modes/toggles.

This type indicates that the device gets the water heater icon and some synonyms/aliases.

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

Request
{
    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "inputs": [{
      "intent": "action.devices.SYNC"
    }]
}
Node.jsResponse
'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.WATERHEATER',
        traits: [
          'action.devices.traits.OnOff',
          'action.devices.traits.TemperatureControl'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation Water Heater'],
          name: 'Water heater',
          nicknames: ['basement water heater']
        },
        willReportState: true,
        attributes: {
          temperatureRange: {
            minThresholdCelsius: 10,
            maxThresholdCelsius: 50
          },
          temperatureUnitForUX: 'F'
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: '233451',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
JavaResponse
@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.WATERHEATER")
          .addTrait("action.devices.traits.OnOff")
          .addTrait("action.devices.traits.TemperatureControl")
          .setName(
              Collections.singletonList("Smart Water Heater"),
              "Smart Water Heater",
              Collections.singletonList("basement water heater")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("temperatureRange", new JSONObject()
                  .put("minThresholdCelsius", 10)
                  .put("maxThresholdCelsius", 50)
              )
              .put("temperatureUnitForUX", "F")
          )
          .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);
}
JSONResponse
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.WATERHEATER",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.TemperatureControl"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation Water Heater"
          ],
          "name": "Water heater",
          "nicknames": [
            "basement water heater"
          ]
        },
        "willReportState": true,
        "attributes": {
          "temperatureRange": {
            "minThresholdCelsius": 10,
            "maxThresholdCelsius": 50
          },
          "temperatureUnitForUX": "F"
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "233451",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.