Join us online for the "Hey Google" Smart Home Summit on July 8th! Register here to learn what's new, and what's coming up for Google Smart Home.

Smart Home Refrigerator Guide

Device TYPE

action.devices.types.REFRIGERATOR This type indicates that the device gets the appropriate icon and some refrigerator synonyms/aliases. Refrigerators are temperature-managing devices which may have various modes/settings.

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.REFRIGERATOR',
        traits: [
          'action.devices.traits.Toggles'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Refrigerator 2331'],
          name: 'Refrigerator',
          nicknames: ['upstairs refrigerator']
        },
        willReportState: true,
        attributes: {
          availableToggles: [{
            name: 'cool',
            name_values: [{
              name_synonym: ['supercool', 'super cooling'],
              lang: 'en'
            }]
          }, {
            name: 'quiet',
            name_values: [{
              name_synonym: ['silent'],
              lang: 'en'
            }]
          }]
        },
        deviceInfo: {
          manufacturer: 'AAA',
          model: '2331B',
          hwVersion: '11.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.REFRIGERATOR")
            .addTrait("action.devices.traits.Toggles")
            .setName(
                Collections.singletonList("Sirius Cybernetics Refrigerator 2331"),
                "Refrigerator",
                Collections.singletonList("upstairs refrigerator"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put(
                        "availableToggles",
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "cool")
                              .put(
                                  "name_values",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put(
                                            "name_synonym",
                                            new String[] {"supercool", "super cooling"})
                                        .put("lang", "en")
                                  }),
                          new JSONObject()
                              .put("name", "quiet")
                              .put(
                                  "name_values",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("name_synonym", new String[] {"silent"})
                                        .put("lang", "en")
                                  })
                        }))
            .setDeviceInfo("AAA", "2331B", "11.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.REFRIGERATOR",
        "traits": [
          "action.devices.traits.Toggles"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Refrigerator 2331"
          ],
          "name": "Refrigerator",
          "nicknames": [
            "upstairs refrigerator"
          ]
        },
        "willReportState": true,
        "attributes": {
          "availableToggles": [
            {
              "name": "cool",
              "name_values": [
                {
                  "name_synonym": [
                    "supercool",
                    "super cooling"
                  ],
                  "lang": "en"
                }
              ]
            },
            {
              "name": "quiet",
              "name_values": [
                {
                  "name_synonym": [
                    "silent"
                  ],
                  "lang": "en"
                }
              ]
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "AAA",
          "model": "2331B",
          "hwVersion": "11.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.