We want to hear your thoughts on the Google Smart Home platform. Join a user study and receive a gift for your input. Click here to sign up.

Smart Home Vacuum Guide

Device TYPE

action.devices.types.VACUUM Vacuums may have functions such as starting, stopping, and pausing cleaning, docking, checking the current cleaning cycle, locating the vacuum, or adjusting various modes such as turbo mode, and toggles such as quiet. Some vacuums may support cleaning specific zones in the home.

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

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.

    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "inputs": [{
      "intent": "action.devices.SYNC"
'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.VACUUM',
        traits: [
        name: {
          defaultNames: ['AAA Cybernetics Corp Vacuum'],
          name: 'vacuum',
          nicknames: []
        willReportState: true,
        attributes: {
          pausable: true,
          availableToggles: [{
            name: 'quiet',
            name_values: [{
              name_synonym: ['quiet', 'silent'],
              lang: 'en'
            }, {
              name_synonym: ['ruhig', 'still'],
              lang: 'de'
        deviceInfo: {
          manufacturer: 'sirius',
          model: '442',
          hwVersion: '3.2',
          swVersion: '11.4'
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'

// ...

exports.smarthome = functions.https.onRequest(app);
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) {
  SyncResponse.Payload payload = new SyncResponse.Payload();
      new SyncResponse.Payload.Device[] {
        new SyncResponse.Payload.Device.Builder()
                Collections.singletonList("AAA Cybernetics Corp Vacuum"),
                new ArrayList())
                new JSONObject()
                    .put("pausable", true)
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "quiet")
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("name_synonym", new String[] {"quiet", "silent"})
                                        .put("lang", "en"),
                                    new JSONObject()
                                        .put("name_synonym", new String[] {"ruhig", "still"})
                                        .put("lang", "de")
            .setDeviceInfo("sirius", "t-1000", "3.2", "11.4")
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "lambtwirl")
  return new SyncResponse(syncRequest.getRequestId(), payload);
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
        "id": "123",
        "type": "action.devices.types.VACUUM",
        "traits": [
        "name": {
          "defaultNames": [
            "AAA Cybernetics Corp Vacuum"
          "name": "vacuum",
          "nicknames": []
        "willReportState": true,
        "attributes": {
          "pausable": true,
          "availableToggles": [
              "name": "quiet",
              "name_values": [
                  "name_synonym": [
                  "lang": "en"
                  "name_synonym": [
                  "lang": "de"
        "deviceInfo": {
          "manufacturer": "sirius",
          "model": "442",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"


See the full list of errors and exceptions.