Smart Home Vacuum Guide

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. Some vacuums may support cleaning specific zones in the home.

This type indicates that the device gets the Vacuum icon and some related synonyms and aliases.

Device capabilities

Refer to the corresponding trait documentation for implementation details, such as attributes and states that your service should support, and how to build EXECUTE and QUERY responses.

Required traits

These traits and commands are required, if applicable to your device.

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.

Quality requirements

  • Latency: must be less than or equal to 800ms.
  • Reliability: must be more than or equal to 97%.

Example device: Simple vacuum

This section contains example intent payloads representing a common "Vacuum" based on the device type and traits above. If you add or remove traits in your implementation, modify your responses accordingly to reflect those changes.

Sample SYNC response

Request
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Response
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.VACUUM",
        "traits": [
          "action.devices.traits.Dock",
          "action.devices.traits.EnergyStorage",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple vacuum"
        },
        "willReportState": true,
        "attributes": {
          "queryOnlyEnergyStorage": true,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Sample QUERY response

Request
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "isRunning": false,
        "isPaused": false,
        "isDocked": true,
        "descriptiveCapacityRemaining": "HIGH",
        "capacityRemaining": [
          {
            "unit": "SECONDS",
            "rawValue": 36000
          },
          {
            "unit": "PERCENTAGE",
            "rawValue": 90
          }
        ]
      }
    }
  }
}

Sample EXECUTE commands

Dock

For additional details on the command parameters, see the action.devices.traits.Dock reference.

Request
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Dock"
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isDocked": true
        }
      }
    ]
  }
}

StartStop

For additional details on the command parameters, see the action.devices.traits.StartStop reference.

Request
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.StartStop",
                "params": {
                  "start": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}

Sample utterances

en-US

  • Turn on the vacuum
  • Turn on the {{devName}}

  • Turn off the vacuum
  • Turn off the {{devName}}

  • Start the vacuum
  • Start the {{devName}}

  • Stop the vacuum
  • Stop the {{devName}}

  • Pause the vacuum
  • Pause the {{devName}}

  • Dock the vacuum
  • Dock the {{devName}}

de-DE

  • Schalte den Staubsauger an
  • Schalte den {{devName}} an

  • Schalte den Staubsauger aus
  • Schalte den {{devName}} aus

  • Starte den Staubsauger
  • Starte den {{devName}}

  • Stop den Staubsaufer
  • Stop den {{devName}}

  • Pausiere den Staubsauger
  • Pausiere den {{devName}}

  • Bring den Staubsauger zurück zur docking station
  • Bring den {{devName}} zurück zur docking station

fr-FR

  • Allume l'aspirateur
  • Allume {{devName}}

  • Éteins l'aspirateur
  • Éteins {{devName}}

  • Démarre l'aspirateur
  • Démarre {{devName}}

  • Arrête l'aspirateur
  • Arrête {{devName}}

  • Mets l'aspirateur en pause
  • Mets {{devName}} en pause

  • Range l'aspirateur
  • Range {{devName}}

es-ES

  • Enciende la aspiradora
  • Enciende la {{devName}}

  • Apaga la aspiradora
  • Apaga la {{devName}}

  • Pon la aspiradora en marcha
  • Pon la {{devName}} en marcha

  • Para la aspiradora
  • Para la {{devName}}

  • Pausa la aspiradora
  • Pausa la {{devName}}

  • Devuelve la aspiradora a su sitio
  • Devuelve la {{devName}} a su sitio

Device ERRORS

See the full list of errors and exceptions.