Smart Home Bathtub Guide

Device TYPE

action.devices.types.BATHTUB - Bathtubs can be filled and drained, possibly to particular levels if the bathtub supports it.

This type indicates that the device gets the bathtub 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

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.BATHTUB',
        traits: [
          'action.devices.traits.OnOff',
          'action.devices.traits.Fill'
        ],
        name: {
          defaultNames: ['Smart Tub'],
          name: 'Bathtub',
          nicknames: ['Master Bathtub', 'Rubber Duck Pond']
        },
        willReportState: true,
        attributes: {
          availableFillLevels: {
            levels: [{
              level_name: 'half_key',
              level_values: [{
                level_synonym: ['half', 'halfway', 'one half'],
                lang: 'en'
              }]
            }],
            ordered: true
          }
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: '492134',
          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.BATHTUB")
          .addTrait("action.devices.traits.OnOff")
          .addTrait("action.devices.traits.Fill")
          .setName(
              Collections.singletonList("Smart Tub"),
              "Bathtub",
              Collections.singletonList("Master Bathtub")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("availableFillLevels", new JSONObject()
                  .put("levels", new JSONObject[]{
                      new JSONObject()
                          .put("level_name", "half_key")
                          .put("level_values", new JSONObject[]{
                              new JSONObject()
                                  .put("level_synonym",
                                      new String[] {"half", "halfway", "one half"})
                                  .put("lang", "en")
                          })
                  })
                  .put("ordered", true)
              )
          )
          .setDeviceInfo("Sirius Cybernetics Corporation", "492134", "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.BATHTUB",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Fill"
        ],
        "name": {
          "defaultNames": [
            "Smart Tub"
          ],
          "name": "Bathtub",
          "nicknames": [
            "Master Bathtub",
            "Rubber Duck Pond"
          ]
        },
        "willReportState": true,
        "attributes": {
          "availableFillLevels": {
            "levels": [
              {
                "level_name": "half_key",
                "level_values": [
                  {
                    "level_synonym": [
                      "half",
                      "halfway",
                      "one half"
                    ],
                    "lang": "en"
                  }
                ]
              }
            ],
            "ordered": true
          }
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "492134",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.