Smart Home Hood Guide

Device TYPE

action.devices.types.HOOD Oven and range hoods can be turned on and off, may have adjustable modes, and may have adjustable fan speeds.

This type indicates that the device gets the range hood 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.jsResponse
'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.HOOD',
        traits: [
          'action.devices.traits.OnOff',
          'action.devices.traits.Toggles',
          'action.devices.traits.FanSpeed'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation 33321'],
          name: 'Hood',
          nicknames: ['kitchen hood']
        },
        willReportState: true,
        attributes: {
          availableToggles: [{
            name: 'Light',
            name_values: [{
              name_synonym: ['light'],
              lang: 'en'
            }]
          }],
          availableFanSpeeds: {
            speeds: [{
              speed_name: 'Low',
              speed_values: [{
                speed_synonym: ['low', 'slow'],
                lang: 'en'
              }]
            }, {
              speed_name: 'High',
              speed_values: [{
                speed_synonym: ['high'],
                lang: 'en'
              }]
            }],
            ordered: true
          },
          reversible: true
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: '492134',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'
        }
      }]
    }
  };
});
// ...
exports.smarthome = functions.https.onRequest(app);
JavaResponse
@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.HOOD")
          .addTrait("action.devices.traits.OnOff")
          .addTrait("action.devices.traits.Toggles")
          .addTrait("action.devices.traits.FanSpeed")
          .setName(
              Collections.singletonList("AAA Smart Oven"),
              "Oven",
              Collections.singletonList("conventional oven")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("availableToggles", new JSONObject[] {
                  new JSONObject()
                      .put("name", "Light")
                      .put("name_values", new JSONObject[] {
                          new JSONObject()
                              .put("name_synonym", new String[] {"light"})
                              .put("lang", "en")
                      })
              })
              .put("availableFanSpeeds", new JSONObject()
                  .put("speeds", new JSONObject[] {
                      new JSONObject()
                          .put("speed_name", "Low")
                          .put("speed_values", new JSONObject[] {
                          new JSONObject()
                              .put("speed_synonym", new String[] {"low", "slow"})
                              .put("lang", "en")
                      }),
                      new JSONObject()
                          .put("speed_name", "High")
                          .put("speed_values", new JSONObject[] {
                          new JSONObject()
                              .put("speed_synonym", new String[] {"high"})
                              .put("lang", "en")
                      })
                  })
                  .put("ordered", true)
              )
              .put("reversible", true)
          )
          .setDeviceInfo("Smart Oven 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);
}
JSONResponse
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.HOOD",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Toggles",
          "action.devices.traits.FanSpeed"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation 33321"
          ],
          "name": "Hood",
          "nicknames": [
            "kitchen hood"
          ]
        },
        "willReportState": true,
        "attributes": {
          "availableToggles": [
            {
              "name": "Light",
              "name_values": [
                {
                  "name_synonym": [
                    "light"
                  ],
                  "lang": "en"
                }
              ]
            }
          ],
          "availableFanSpeeds": {
            "speeds": [
              {
                "speed_name": "Low",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "low",
                      "slow"
                    ],
                    "lang": "en"
                  }
                ]
              },
              {
                "speed_name": "High",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "high"
                    ],
                    "lang": "en"
                  }
                ]
              }
            ],
            "ordered": true
          },
          "reversible": true
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "492134",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.