Smart Home Dehydrator Guide

Device TYPE

action.devices.types.DEHYDRATOR Interactions with dehydrators may include starting and stopping, setting a timer, adjusting cooking modes or food presets, or adjusting other various settings.

This type indicates that the device gets the dehydrator 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.DEHYDRATOR',
        traits: [
          'action.devices.traits.Cook',
          'action.devices.traits.StartStop',
          'action.devices.traits.Timer'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation Dehydrator'],
          name: 'Dehydrator',
          nicknames: ['Kitchen Dehydrator']
        },
        willReportState: true,
        attributes: {
          supportedCookingModes: [
            'DEHYDRATE'
          ],
          foodPresets: [{
            food_preset_name: 'beef jerky',
            supported_units: ['POUNDS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['beef jerky', 'jerky'],
              lang: 'en'
            }]
          }, {
            food_preset_name: 'beet chips',
            supported_units: ['POUNDS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['beet chips', 'beets'],
              lang: 'en'
            }]
          }],
          maxTimerLimitSec: 30,
          pausable: true
        },
        deviceInfo: {
          manufacturer: 'ACME',
          model: '492134',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'goatjive'
        }
      }]
    }
  };
});

// ...

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.DEHYDRATOR")
            .addTrait("action.devices.traits.Cook")
            .addTrait("action.devices.traits.StartStop")
            .addTrait("action.devices.traits.Timer")
            .setName(
                Collections.singletonList("Sirius Cybernetics Corporation Dehydrator"),
                "Dehydrator",
                Collections.singletonList("Kitchen dehydrator"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put("supportedCookingModes", new String[] {"DEHYDRATE"})
                    .put(
                        "foodPresets",
                        new JSONObject[] {
                          new JSONObject()
                              .put("food_preset_name", "beef jerky")
                              .put("supported_units", new String[] {"POUNDS", "OUNCES"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("synonyms", new String[] {"beef jerky", "jerky"})
                                        .put("lang", "en")
                                  }),
                          new JSONObject()
                              .put("food_preset_name", "beet chips")
                              .put("supported_units", new String[] {"POUNDS", "OUNCES"})
                              .put(
                                  "food_synonyms",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("synonyms", new String[] {"beet chips", "beets"})
                                        .put("lang", "en")
                                  })
                        })
                    .put("maxTimerLimitSec", 30)
                    .put("pausable", false))
            .setDeviceInfo("ACME", "492134", "3.2", "11.4")
            .setCustomData(
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "goatjive")
                    .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.DEHYDRATOR",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.StartStop",
          "action.devices.traits.Timer"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation Dehydrator"
          ],
          "name": "Dehydrator",
          "nicknames": [
            "Kitchen Dehydrator"
          ]
        },
        "willReportState": true,
        "attributes": {
          "supportedCookingModes": [
            "DEHYDRATE"
          ],
          "foodPresets": [
            {
              "food_preset_name": "beef jerky",
              "supported_units": [
                "POUNDS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "beef jerky",
                    "jerky"
                  ],
                  "lang": "en"
                }
              ]
            },
            {
              "food_preset_name": "beet chips",
              "supported_units": [
                "POUNDS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "beet chips",
                    "beets"
                  ],
                  "lang": "en"
                }
              ]
            }
          ],
          "maxTimerLimitSec": 30,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "ACME",
          "model": "492134",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "goatjive"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.