Smart Home Air Purifier Guide

Device TYPE

action.devices.types.AIRPURIFIER Air purifiers are devices that may be turned on and off, report air filter cleanliness and air filter lifetime, and be adjusted to various mode settings.

This type indicates that the device gets the air purifier icon and some air purifier 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.AIRPURIFIER',
        traits: [
          'action.devices.traits.OnOff',
          'action.devices.traits.Toggles',
          'action.devices.traits.FanSpeed',
          'action.devices.traits.SensorState'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation 33321'],
          name: 'Air Purifier',
          nicknames: ['bedroom purifier']
        },
        willReportState: true,
        attributes: {
          availableFanSpeeds: {
            speeds: [{
              speed_name: 'Low',
              speed_values: [{
                speed_synonym: ['low', 'slow'],
                lang: 'en'
              }, {
                speed_synonym: ['low', 'slow'],
                lang: 'de'
              }]
            }, {
              speed_name: 'High',
              speed_values: [{
                speed_synonym: ['high'],
                lang: 'en'
              }, {
                speed_synonym: ['high'],
                lang: 'de'
              }]
            }],
            ordered: true
          },
          reversible: true,
          availableToggles: [{
            name: 'uv',
            name_values: [{
              name_synonym: ['UV', 'UV mode'],
              lang: 'en'
            }]
          }],
          sensorStatesSupported: [{
            name: 'FilterCleanliness',
            descriptiveCapabilities: {
              availableStates: [
                'clean',
                'dirty',
                'needs replacement'
              ]
            }
          }]
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: '492134',
          hwVersion: '3.2',
          swVersion: '11.4'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
@SmartHomeSnippetJson("smart-home-types-airpurifier_sync.json")
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.AIRPURIFIER")
            .addTrait("action.devices.traits.OnOff")
            .addTrait("action.devices.traits.Toggles")
            .addTrait("action.devices.traits.FanSpeed")
            .addTrait("action.devices.traits.SensorState")
            .setName(
                Collections.singletonList("Sirius Cybernetics Corporation 33321"),
                "Air Purifier",
                Collections.singletonList("bedroom purifier"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .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_synonym", new String[] {"low", "slow"})
                                                .put("lang", "de")
                                          }),
                                  new JSONObject()
                                      .put("speed_name", "High")
                                      .put(
                                          "speed_values",
                                          new JSONObject[] {
                                            new JSONObject()
                                                .put("speed_synonym", new String[] {"high"})
                                                .put("lang", "en"),
                                            new JSONObject()
                                                .put("speed_synonym", new String[] {"high"})
                                                .put("lang", "de")
                                          })
                                })
                            .put("ordered", true))
                    .put("reversible", true)
                    .put(
                        "availableToggles",
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "uv")
                              .put(
                                  "name_values",
                                  new JSONObject[] {
                                    new JSONObject()
                                        .put("name_synonym", new String[] {"UV", "UV mode"})
                                        .put("lang", "en")
                                  })
                        })
                    .put(
                        "sensorStatesSupported",
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "FilterCleanliness")
                              .put(
                                  "descriptiveCapabilities",
                                  new JSONObject()
                                      .put(
                                          "availableStates",
                                          new String[] {"clean", "dirty", "needs replacement"}))
                        }))
            .setDeviceInfo("Sirius Cybernetics Corporation", "492134", "3.2", "11.4")
            .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.AIRPURIFIER",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Toggles",
          "action.devices.traits.FanSpeed",
          "action.devices.traits.SensorState"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation 33321"
          ],
          "name": "Air Purifier",
          "nicknames": [
            "bedroom purifier"
          ]
        },
        "willReportState": true,
        "attributes": {
          "availableFanSpeeds": {
            "speeds": [
              {
                "speed_name": "Low",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "low",
                      "slow"
                    ],
                    "lang": "en"
                  },
                  {
                    "speed_synonym": [
                      "low",
                      "slow"
                    ],
                    "lang": "de"
                  }
                ]
              },
              {
                "speed_name": "High",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "high"
                    ],
                    "lang": "en"
                  },
                  {
                    "speed_synonym": [
                      "high"
                    ],
                    "lang": "de"
                  }
                ]
              }
            ],
            "ordered": true
          },
          "reversible": true,
          "availableToggles": [
            {
              "name": "uv",
              "name_values": [
                {
                  "name_synonym": [
                    "UV",
                    "UV mode"
                  ],
                  "lang": "en"
                }
              ]
            }
          ],
          "sensorStatesSupported": [
            {
              "name": "FilterCleanliness",
              "descriptiveCapabilities": {
                "availableStates": [
                  "clean",
                  "dirty",
                  "needs replacement"
                ]
              }
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "492134",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.