Smart Home Coffee Maker Guide

Device TYPE

action.devices.types.COFFEE_MAKER Interactions with coffee makers may include turning them on and off, adjusting cooking modes and food presets, adjusting the target temperature, and adjusting various non-cooking mode settings.

This type indicates that the device gets the coffee maker icon and some applicable synonyms/aliases.

Recommended TRAITS

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.COFFEE_MAKER',
        traits: [
          'action.devices.traits.Cook',
          'action.devices.traits.OnOff',
          'action.devices.traits.TemperatureControl'
        ],
        name: {
          defaultNames: ['AAA Smart Coffee Maker'],
          name: 'Coffee Maker',
          nicknames: ['my brewer']
        },
        willReportState: true,
        attributes: {
          temperatureRange: {
            minThresholdCelsius: 0.0,
            maxThresholdCelsius: 100.00
          },
          temperatureUnitForUX: 'F',
          supportedCookingModes: [
            'BREW'
          ],
          foodPresets: [{
            food_preset_name: 'coffee',
            supported_units: ['NO_UNITS', 'CUPS'],
            food_synonyms: [{
              synonyms: ['coffee'],
              lang: 'en'
            }]
          }]
        },
        deviceInfo: {
          manufacturer: 'Smart Coffee Maker Manufacturers',
          model: 'F600G',
          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.COFFEE_MAKER")
            .addTrait("action.devices.traits.Cook")
            .addTrait("action.devices.traits.OnOff")
            .addTrait("action.devices.traits.TemperatureControl")
            .setName(
                Collections.singletonList("AAA Smart Coffee Maker"),
                "Coffee Maker",
                Collections.singletonList("my brewer"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put(
                        "temperatureRange",
                        new JSONObject()
                            .put("minThresholdCelsius", 0)
                            .put("maxThresholdCelsius", 100))
                    .put("temperatureUnitForUX", "F")
                    .put("supportedCookingModes", new String[] {"BREW"})
                    .put(
                        "foodPresets",
                        new JSONObject[] {
                          new JSONObject()
                              .put("food_preset_name", "coffee")
                              .put("supported_units", new String[] {"NO_UNITS", "CUPS"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("synonyms", new String[] {"coffee"})
                                        .put("lang", "en")
                                  })
                        }))
            .setDeviceInfo("Smart Coffee Maker Manufacturers", "F600G", "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.COFFEE_MAKER",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.OnOff",
          "action.devices.traits.TemperatureControl"
        ],
        "name": {
          "defaultNames": [
            "AAA Smart Coffee Maker"
          ],
          "name": "Coffee Maker",
          "nicknames": [
            "my brewer"
          ]
        },
        "willReportState": true,
        "attributes": {
          "temperatureRange": {
            "minThresholdCelsius": 0,
            "maxThresholdCelsius": 100
          },
          "temperatureUnitForUX": "F",
          "supportedCookingModes": [
            "BREW"
          ],
          "foodPresets": [
            {
              "food_preset_name": "coffee",
              "supported_units": [
                "NO_UNITS",
                "CUPS"
              ],
              "food_synonyms": [
                {
                  "synonyms": [
                    "coffee"
                  ],
                  "lang": "en"
                }
              ]
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "Smart Coffee Maker Manufacturers",
          "model": "F600G",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}

Validator

Device ERRORS

See the full list of errors and exceptions.