Smart Home Shower Guide

Device TYPE

action.devices.types.SHOWER Showers can be turned on and off, start and stop, and may support adjusting temperature or various modes.

This type indicates that the device gets the shower icon and some shower synonyms and 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.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.SHOWER',
        traits: [
          'action.devices.traits.OnOff',
          'action.devices.traits.Modes',
          'action.devices.traits.TemperatureControl'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation Shower'],
          name: 'Shower',
          nicknames: ['Bathroom shower'],
        },
        willReportState: true,
        attributes: {
          commandOnlyOnOff: false,
          availableModes: [{
            name: 'massage',
            name_values: [{
              name_synonym: ['massage'],
              lang: 'en'
            }],
            settings: [{
              setting_name: 'low pressure',
              setting_values: [{
                setting_synonym: ['low pressure', 'gentle'],
                lang: 'en'
              }]
            }, {
              setting_name: 'high pressure',
              setting_values: [{
                setting_synonym: ['high pressure'],
                lang: 'en'
              }]
            }],
            ordered: true
          }],
          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.SHOWER")
          .addTrait("action.devices.traits.StartStop")
          .addTrait("action.devices.traits.OnOff")
          .addTrait("action.devices.traits.Modes")
          .setName(
              Collections.singletonList("Smart Shower"),
              "Smart Shower",
              Collections.singletonList("guest shower")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("availableModes", new JSONObject[] {
                  new JSONObject()
                      .put("name", "monsoon")
                      .put("name_values", new JSONObject[] {
                          new JSONObject()
                              .put("name_synonym", new String[] {
                                  "monsoon",
                                  "heavy rain",
                                  "waterfall"
                              })
                              .put("lang", "en")
                      })
                      .put("settings", new JSONObject[] {
                          new JSONObject()
                              .put("setting_name", "trickle")
                              .put("setting_values", new JSONObject[] {
                              new JSONObject()
                                  .put("setting_synonym", new String[] {"trickle", "gentle"})
                                  .put("lang", "en")
                          })
                      })
                      .put("ordered", true)
              })
          )
          .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.SHOWER",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Modes",
          "action.devices.traits.TemperatureControl"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation Shower"
          ],
          "name": "Shower",
          "nicknames": [
            "Bathroom shower"
          ]
        },
        "willReportState": true,
        "attributes": {
          "commandOnlyOnOff": false,
          "availableModes": [
            {
              "name": "massage",
              "name_values": [
                {
                  "name_synonym": [
                    "massage"
                  ],
                  "lang": "en"
                }
              ],
              "settings": [
                {
                  "setting_name": "low pressure",
                  "setting_values": [
                    {
                      "setting_synonym": [
                        "low pressure",
                        "gentle"
                      ],
                      "lang": "en"
                    }
                  ]
                },
                {
                  "setting_name": "high pressure",
                  "setting_values": [
                    {
                      "setting_synonym": [
                        "high pressure"
                      ],
                      "lang": "en"
                    }
                  ]
                }
              ],
              "ordered": true
            }
          ],
          "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.