Smart Home Mop Guide

Device TYPE

action.devices.types.MOP - Interactions with mops may include starting, stopping, pausing cleaning, docking, checking the current cleaning cycle, locating the mop, or adjusting various modes and toggles. Some mops may support cleaning specific zones in the home.

This type indicates that the device gets the mop 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.js
'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.MOP',
        traits: [
          'action.devices.traits.StartStop',
          'action.devices.traits.Toggles',
          'action.devices.traits.Dock'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corp Mop'],
          name: 'mop',
          nicknames: ['kitchen mop']
        },
        willReportState: true,
        attributes: {
          availableToggles: [{
            name: 'turbo',
            name_values: [{
              name_synonym: ['extra cleaning', 'turbo'],
              lang: 'en'
            }, {
              name_synonym: ['zusätzliche Reinigung', 'turbo'],
              lang: 'de'
            }]
          }],
          pausable: true
        },
        deviceInfo: {
          manufacturer: 'sirius',
          model: '442',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) {
  SyncResponse.Payload payload = new SyncResponse.Payload();
  payload.setAgentUserId("123456789");
  payload.setDevices(new SyncResponse.Payload.Device[] {
      new SyncResponse.Payload.Device.Builder()
          .setId("123")
          .setType("action.devices.types.MOP")
          .addTrait("action.devices.traits.StartStop")
          .addTrait("action.devices.traits.Toggles")
          .addTrait("action.devices.traits.Dock")
          .setName(
              Collections.singletonList("Sirius Cybernetics Corp Mop"),
              "mop",
              Collections.singletonList("kitchen mop")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("availableToggles", new JSONObject[] {
                  new JSONObject()
                      .put("name", "turbo")
                      .put("name_values", new JSONObject[] {
                          new JSONObject()
                              .put("name_synonym", new String[] {
                                  "extra cleaning",
                                  "turbo"
                              })
                              .put("lang", "en"),
                          new JSONObject()
                              .put("name_synonym", new String[] {
                                  "zusätzliche Reinigung",
                                  "turbo"
                              })
                              .put("lang", "de")
                      })
              })
              .put("pausable", true)
          )
          .setDeviceInfo("sirius", "442", "3.2", "11.4")
          .setCustomData(new JSONObject()
              .put("fooValue", 74)
              .put("barValue", true)
              .put("bazValue", "lambtwirl")
          )
          .build()
  });

  return new SyncResponse(syncRequest.getRequestId(), payload);
}
JSON
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.MOP",
        "traits": [
          "action.devices.traits.StartStop",
          "action.devices.traits.Toggles",
          "action.devices.traits.Dock"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corp Mop"
          ],
          "name": "mop",
          "nicknames": [
            "kitchen mop"
          ]
        },
        "willReportState": true,
        "attributes": {
          "availableToggles": [
            {
              "name": "turbo",
              "name_values": [
                {
                  "name_synonym": [
                    "extra cleaning",
                    "turbo"
                  ],
                  "lang": "en"
                },
                {
                  "name_synonym": [
                    "zusätzliche Reinigung",
                    "turbo"
                  ],
                  "lang": "de"
                }
              ]
            }
          ],
          "pausable": true
        },
        "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.