Smart Home Sous Vide Guide

Device TYPE

action.devices.types.SOUSVIDE Interactions with sous vides 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 sous vide icon and some synonyms and 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.SOUSVIDE',
        traits: [
          'action.devices.traits.Cook',
          'action.devices.traits.StartStop',
          'action.devices.traits.Timer'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corp Sous Vide'],
          name: 'Sous Vide',
          nicknames: ['Tabletop Sous Vide']
        },
        willReportState: true,
        attributes: {
          supportedCookingModes: [
            'SOUS_VIDE',
          ],
          foodPresets: [{
            food_preset_name: 'chicken',
            supported_units: ['POUNDS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['chicken', 'whole chicken'],
              lang: 'en'
            }]
          }, {
            food_preset_name: 'salmon',
            supported_units: ['POUNDS', 'OUNCES'],
            food_synonyms: [{
              synonym: ['salmon', 'king salmon'],
              lang: 'en'
            }]
          }],
          maxTimerLimitSec: 30,
          pausable: 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.SOUSVIDE")
          .addTrait("action.devices.traits.Cook")
          .addTrait("action.devices.traits.StartStop")
          .addTrait("action.devices.traits.Timer")
          .setName(
              Collections.singletonList("Sirius Cybernetics Corporation Sous Vide"),
              "Sous Vide",
              Collections.singletonList("Kitchen Sous Vide")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("supportedCookingModes", new String[] {
                  "SOUS_VIDE"
              })
              .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", "whole chicken"})
                              .put("lang", "en")
                      }),
                  new JSONObject()
                      .put("food_preset_name", "salmon")
                      .put("supported_units", new String[] {"POUNDS", "OUNCES"})
                      .put("food_synonyms", new JSONObject[] {
                          new JSONObject()
                              .put("synonyms", new String[] {"salmon", "king salmon"})
                              .put("lang", "en")
                      })
              })
              .put("maxTimerLimitSec", 30)
              .put("pausable", true)
          )
          .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.SOUSVIDE",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.StartStop",
          "action.devices.traits.Timer"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corp Sous Vide"
          ],
          "name": "Sous Vide",
          "nicknames": [
            "Tabletop Sous Vide"
          ]
        },
        "willReportState": true,
        "attributes": {
          "supportedCookingModes": [
            "SOUS_VIDE"
          ],
          "foodPresets": [
            {
              "food_preset_name": "chicken",
              "supported_units": [
                "POUNDS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "chicken",
                    "whole chicken"
                  ],
                  "lang": "en"
                }
              ]
            },
            {
              "food_preset_name": "salmon",
              "supported_units": [
                "POUNDS",
                "OUNCES"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "salmon",
                    "king salmon"
                  ],
                  "lang": "en"
                }
              ]
            }
          ],
          "maxTimerLimitSec": 30,
          "pausable": 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.