Smart Home Microwave Guide

Device TYPE

action.devices.types.MICROWAVE - Interactions with microwaves may include starting and stopping, setting a timer, or adjusting various modes (for example, power level) and toggles (for example, a light).

This type indicates that the device gets the microwave 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.MICROWAVE',
        traits: [
          'action.devices.traits.Timer',
          'action.devices.traits.StartStop'
        ],
        name: {
          defaultNames: ['AAA Smart Microwave'],
          name: 'Microwave',
          nicknames: ['Kitchen microwave']
        },
        willReportState: true,
        attributes: {
          maxTimerLimitSec: 6039,
          pausable: true
        },
        deviceInfo: {
          manufacturer: 'Smart Microwave 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) {
  Payload payload = new Payload();
  payload.setAgentUserId("1836.15267389");
  payload.setDevices(new Device[] {
      new Device.Builder()
          .setId("123")
          .setType("action.devices.types.MICROWAVE")
          .addTrait("action.devices.traits.StartStop")
          .addTrait("action.devices.traits.Timer")
          .setName(
              Collections.singletonList("AAA Smart Microwave"),
              "Microwave",
              Collections.singletonList("Kitchen microwave")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("pausable", true)
              .put("maxTimerLimitSec", 6039)
          )
          .setDeviceInfo("Smart Microwave 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.MICROWAVE",
        "traits": [
          "action.devices.traits.Timer",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "defaultNames": [
            "AAA Smart Microwave"
          ],
          "name": "Microwave",
          "nicknames": [
            "Kitchen microwave"
          ]
        },
        "willReportState": true,
        "attributes": {
          "maxTimerLimitSec": 6039,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "Smart Microwave 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.