Smart Home Cooktop Guide

Device TYPE

action.devices.types.COOKTOP Interactions with cooktops may include turning them on and off, starting and stopping, setting a timer, adjusting cooking modes and food presets, and adjusting various non-cooking mode settings.

This type indicates that the device gets the cooktop 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.COOKTOP',
        traits: [
          'action.devices.traits.Cook',
          'action.devices.traits.OnOff',
          'action.devices.traits.Modes',
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corp Cooktop'],
          name: 'Cooktop',
          nicknames: ['Tabletop Cooktop']
        },
        willReportState: true,
        attributes: {
          supportedCookingModes: [
            'COOK',
            'BOIL',
            'SAUTE'
          ],
          foodPresets: [{
            food_preset_name: 'chicken',
            supported_units: ['POUNDS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['chicken', 'chicken breat', 'chicken thigh'],
              lang: 'en'
            }]
          }, {
            food_preset_name: 'bacon',
            supported_units: ['POUNDS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['bacon', 'bacon strips'],
              lang: 'en'
            }]
          }],
          maxTimerLimitSec: 1200,
          pausable: true,
          availableModes: [{
            name: 'heat',
            nameValues: [{
              nameSynonym: ['heat', 'flame', 'heat level'],
              lang: 'en'
            }],
            settings: [{
              settingName: 'low',
              settingValues: [{
                settingSynonym: ['low', 'lowest'],
                lang: 'en'
              }]
            }, {
              settingName: 'high',
              settingValues: [{
                settingSynonym: ['high', 'full', 'highest'],
                lang: 'en'
              }]
            }],
            ordered: 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.COOKTOP")
            .addTrait("action.devices.traits.Cook")
            .addTrait("action.devices.traits.OnOff")
            .addTrait("action.devices.traits.Modes")
            .setName(
                Collections.singletonList("Sirius Cybernetics Corporation Cooktop"),
                "Cooktop",
                Collections.singletonList("Kitchen Cooktop"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put("supportedCookingModes", new String[] {"COOK", "BOIL", "SAUTE"})
                    .put(
                        "foodPresets",
                        new JSONObject[] {
                          new JSONObject()
                              .put("food_preset_name", "chicken")
                              .put("supported_units", new String[] {"POUNDS", "OUNCES"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put(
                                            "synonyms",
                                            new String[] {
                                              "chicken", "chicken breast", "chicken thigh"
                                            })
                                        .put("lang", "en")
                                  }),
                          new JSONObject()
                              .put("food_preset_name", "bacon")
                              .put("supported_units", new String[] {"POUNDS", "OUNCES"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("synonyms", new String[] {"bacon", "bacon strips"})
                                        .put("lang", "en")
                                  })
                        })
                    .put("maxTimerLimitSec", 1200)
                    .put("pausable", true)
                    .put(
                        "availableModes",
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "heat")
                              .put(
                                  "nameValues",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put(
                                            "nameSynonym",
                                            new String[] {"heat", "flame", "heat level"})
                                        .put("lang", "en")
                                  })
                              .put(
                                  "settings",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("settingName", "low")
                                        .put(
                                            "settingValues",
                                            new JSONObject[] {
                                              new JSONObject()
                                                  .put(
                                                      "settingSynonym",
                                                      new String[] {"low", "lowest"})
                                                  .put("lang", "en")
                                            }),
                                    new JSONObject()
                                        .put("settingName", "high")
                                        .put(
                                            "settingValues",
                                            new JSONObject[] {
                                              new JSONObject()
                                                  .put(
                                                      "settingSynonym",
                                                      new String[] {"high", "full", "highest"})
                                                  .put("lang", "en")
                                            })
                                  })
                        }))
            .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.COOKTOP",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.OnOff",
          "action.devices.traits.Modes"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corp Cooktop"
          ],
          "name": "Cooktop",
          "nicknames": [
            "Tabletop Cooktop"
          ]
        },
        "willReportState": true,
        "attributes": {
          "supportedCookingModes": [
            "COOK",
            "BOIL",
            "SAUTE"
          ],
          "foodPresets": [
            {
              "food_preset_name": "chicken",
              "supported_units": [
                "POUNDS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "chicken",
                    "chicken breat",
                    "chicken thigh"
                  ],
                  "lang": "en"
                }
              ]
            },
            {
              "food_preset_name": "bacon",
              "supported_units": [
                "POUNDS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "bacon",
                    "bacon strips"
                  ],
                  "lang": "en"
                }
              ]
            }
          ],
          "maxTimerLimitSec": 1200,
          "pausable": true,
          "availableModes": [
            {
              "name": "heat",
              "nameValues": [
                {
                  "nameSynonym": [
                    "heat",
                    "flame",
                    "heat level"
                  ],
                  "lang": "en"
                }
              ],
              "settings": [
                {
                  "settingName": "low",
                  "settingValues": [
                    {
                      "settingSynonym": [
                        "low",
                        "lowest"
                      ],
                      "lang": "en"
                    }
                  ]
                },
                {
                  "settingName": "high",
                  "settingValues": [
                    {
                      "settingSynonym": [
                        "high",
                        "full",
                        "highest"
                      ],
                      "lang": "en"
                    }
                  ]
                }
              ],
              "ordered": 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.