Smart Home Air Freshener Guide

Device TYPE

action.devices.types.AIRFRESHENER Air fresheners can be turned on and off and adjust various modes and toggles.

This type indicates that the device gets the air freshener 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.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.AIRFRESHENER',
        traits: [
          'action.devices.traits.OnOff',
          'action.devices.traits.Toggles'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation Air Freshener'],
          name: 'air freshener',
          nicknames: ['Mr. Fresh']
        },
        willReportState: true,
        attributes: {
          availableToggles: [{
            name: 'intermittent spray',
            name_values: [{
              name_synonym: ['intermittent spray'],
              lang: 'en'
            }, {
              name_synonym: ['intermittierender Spray'],
              lang: 'de'
            }]
          }]
        },
        deviceInfo: {
          manufacturer: 'sirius',
          model: '442',
          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.AIRFRESHENER")
          .addTrait("action.devices.traits.OnOff")
          .addTrait("action.devices.traits.Toggles")
          .setName(
              Collections.singletonList("Sirius Cybernetics Corporation Air Freshener"),
              "air freshener",
              Collections.singletonList("Mr. Fresh")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("availableToggles", new JSONObject[] {
                  new JSONObject()
                      .put("name", "intermittent spray")
                      .put("name_values", new JSONObject[] {
                          new JSONObject()
                              .put("name_synonym", new String[] {"intermittent spray"})
                              .put("lang", "en"),
                          new JSONObject()
                              .put("name_synonym", new String[] {"intermittierender Spray"})
                              .put("lang", "de")
                      }
                  )
              }))
          .setDeviceInfo("sirius", "442", "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.AIRFRESHENER",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Toggles"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation Air Freshener"
          ],
          "name": "air freshener",
          "nicknames": [
            "Mr. Fresh"
          ]
        },
        "willReportState": true,
        "attributes": {
          "availableToggles": [
            {
              "name": "intermittent spray",
              "name_values": [
                {
                  "name_synonym": [
                    "intermittent spray"
                  ],
                  "lang": "en"
                },
                {
                  "name_synonym": [
                    "intermittierender Spray"
                  ],
                  "lang": "de"
                }
              ]
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "sirius",
          "model": "442",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.