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 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.VACUUM',
        traits: [
          'action.devices.traits.StartStop',
          'action.devices.traits.Toggles',
          'action.devices.traits.Dock'
        ],
        name: {
          defaultNames: ['AAA Cybernetics Corp Vacuum'],
          name: 'vacuum',
          nicknames: []
        },
        willReportState: false,
        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);
JSONResponse
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.VACUUM",
        "traits": [
          "action.devices.traits.StartStop",
          "action.devices.traits.Toggles",
          "action.devices.traits.Dock"
        ],
        "name": {
          "defaultNames": [
            "AAA Cybernetics Corp Vacuum"
          ],
          "name": "vacuum",
          "nicknames": []
        },
        "willReportState": false,
        "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"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.