Smart Home Vacuum Guide

Device TYPE

action.devices.types.VACUUM Vacuums can have binary modes and settings (for example, on/off and start/pause) as well as a mode to schedule cleaning sessions and a mode to charge themselves. Partners can construct their vacuum cleaner specifics using a combination of these standard modes, as well as the Dock trait to support returning for charge.

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",
  }]
}
Response
{
    "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": true,
            "attributes": {
                "pausable": true,
                "availableToggles": [{
                    "name": "quiet ",
                    "name_values": [{
                        "name_synonym": ["quiet ", "silent"],
                        "lang": "ENGLISH"
                    }, {
                        "name_synonym": ["ruhig ", "still"],
                        "lang": "GERMAN"
                    }]
                }]
            },
            "deviceInfo": {
                "manufacturer": "sirius",
                "model": "442",
                "hwVersion": "3.2",
                "swVersion": "11.4"
            },
            "customData": {
                "fooValue": 74,
                "barValue": true,
                "bazValue": "lambtwirl"
            }
        }]
    }
}
Validator

Device ERRORS

The error codes extend the primary list in the DevGuide. Additional errors will be added as needed.