Smart Home Blender Guide

Device TYPE

action.devices.types.BLENDER Interactions with blenders may include starting and stopping, setting a timer, setting cooking modes or food presets, or adjusting other various settings.

This type indicates that the device gets the blender icon and some synonyms and 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.

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.BLENDER',
        traits: [
          'action.devices.traits.Cook',
          'action.devices.traits.StartStop',
          'action.devices.traits.Timer'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corp Blender'],
          name: 'Blender',
          nicknames: ['Tabletop Blender']
        },
        willReportState: true,
        attributes: {
          supportedCookingModes: [
            'BLEND',
            'PUREE',
            'WHIP',
          ],
          foodPresets: [{
            food_preset_name: 'smoothie',
            supported_units: ['CUPS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['smoothie', 'shake'],
              lang: 'en'
            }]
          }, {
            food_preset_name: 'salad dressing',
            supported_units: ['CUPS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['salad dressing', 'dressing'],
              lang: 'en'
            }]
          }],
          maxTimerLimitSec: 30,
          pausable: true
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: '233451',
          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("1836.15267389");
  payload.setDevices(
      new SyncResponse.Payload.Device[] {
        new SyncResponse.Payload.Device.Builder()
            .setId("123")
            .setType("action.devices.types.BLENDER")
            .addTrait("action.devices.traits.Cook")
            .addTrait("action.devices.traits.StartStop")
            .addTrait("action.devices.traits.Timer")
            .setName(
                Collections.singletonList("Sirius Cybernetics Corporation Blender"),
                "Blender",
                Collections.singletonList("Kitchen blender"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put("supportedCookingModes", new String[] {"BLEND", "PUREE", "WHIP"})
                    .put(
                        "foodPresets",
                        new JSONObject[] {
                          new JSONObject()
                              .put("food_preset_name", "smoothie")
                              .put("supported_units", new String[] {"CUPS", "OUNCES"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("synonyms", new String[] {"smoothie", "shake"})
                                        .put("lang", "en")
                                  }),
                          new JSONObject()
                              .put("food_preset_name", "salad dressing")
                              .put("supported_units", new String[] {"CUPS", "OUNCES"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put(
                                            "synonyms",
                                            new String[] {"salad dressing", "dressing"})
                                        .put("lang", "en")
                                  })
                        })
                    .put("maxTimerLimitSec", 30)
                    .put("pausable", true))
            .setDeviceInfo("Sirius Cybernetics Corporation", "233451", "3.2", "11.4")
            .setCustomData(
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "lambtwirl")
                    .toString())
            .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.BLENDER",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.StartStop",
          "action.devices.traits.Timer"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corp Blender"
          ],
          "name": "Blender",
          "nicknames": [
            "Tabletop Blender"
          ]
        },
        "willReportState": true,
        "attributes": {
          "supportedCookingModes": [
            "BLEND",
            "PUREE",
            "WHIP"
          ],
          "foodPresets": [
            {
              "food_preset_name": "smoothie",
              "supported_units": [
                "CUPS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "smoothie",
                    "shake"
                  ],
                  "lang": "en"
                }
              ]
            },
            {
              "food_preset_name": "salad dressing",
              "supported_units": [
                "CUPS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "salad dressing",
                    "dressing"
                  ],
                  "lang": "en"
                }
              ]
            }
          ],
          "maxTimerLimitSec": 30,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "233451",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.