Smart Home Kettle Guide

Device TYPE

action.devices.types.KETTLE Kettles are devices that boil water. Interactions with kettles may include turning them on and off, adjusting the target temperature, and perhaps adjusting various mode settings.

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

    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "inputs": [{
      "intent": "action.devices.SYNC"
'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.KETTLE',
        traits: [
        name: {
          defaultNames: ['AAA Smart Kettle'],
          name: 'Kettle',
          nicknames: ['tea kettle']
        willReportState: true,
        attributes: {
          temperatureRange: {
            minThresholdCelsius: 0.0,
            maxThresholdCelsius: 100.00
          temperatureUnitForUX: 'F'
        deviceInfo: {
          manufacturer: 'Smart Kettle Manufacturers',
          model: 'F600G',
          hwVersion: '3.2',
          swVersion: '11.4'
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'

// ...

exports.smarthome = functions.https.onRequest(app);
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) {
  SyncResponse.Payload payload = new SyncResponse.Payload();
      new SyncResponse.Payload.Device[] {
        new SyncResponse.Payload.Device.Builder()
                Collections.singletonList("AAA Smart Kettle"),
                Collections.singletonList("tea kettle"))
                new JSONObject()
                        new JSONObject()
                            .put("minThresholdCelsius", 0)
                            .put("maxThresholdCelsius", 100))
                    .put("temperatureUnitForUX", "F"))
            .setDeviceInfo("Smart Kettle Manufacturers", "F600G", "3.2", "11.4")
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "lambtwirl")
  return new SyncResponse(syncRequest.getRequestId(), payload);
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
        "id": "123",
        "type": "action.devices.types.KETTLE",
        "traits": [
        "name": {
          "defaultNames": [
            "AAA Smart Kettle"
          "name": "Kettle",
          "nicknames": [
            "tea kettle"
        "willReportState": true,
        "attributes": {
          "temperatureRange": {
            "minThresholdCelsius": 0,
            "maxThresholdCelsius": 100
          "temperatureUnitForUX": "F"
        "deviceInfo": {
          "manufacturer": "Smart Kettle Manufacturers",
          "model": "F600G",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"


See the full list of errors and exceptions.


Kettles have type-based grammar for action.devices.traits.OnOff. If the device supports OnOff, Boil some water will send an action.devices.commands.OnOff command.