Smart Home Water Purifier Guide

Device TYPE

action.devices.types.WATERPURIFIER Water purifiers are devices that may be turned on and off, report water filter cleanliness and filter lifetime, and be adjusted to various mode settings.

This type indicates that the device gets the water purifier icon and some water purifier synonyms/aliases.

These traits are recommended, if applicable to your device. However, you are free to mix and match from all available traits to best match your existing product functionality.

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.WATERPURIFIER',
        traits: [
          'action.devices.traits.SensorState'
        ],
        name: {
          defaultNames: ['AAA Smart Water Purifier'],
          name: 'Water purifier',
          nicknames: ['Drinking water purifier']
        },
        willReportState: true,
        attributes: {
          sensorStatesSupported: [{
            name: 'FilterCleanliness',
            descriptiveCapabilities: {
              availableStates: [
                'clean',
                'dirty',
                'needs replacement'
              ]
            }
          }]
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: 'F600G',
          hwVersion: '3.2',
          swVersion: '11.4'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
@SmartHomeSnippetJson("smart-home-types-waterpurifier_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.WATERPURIFIER")
            .addTrait("action.devices.traits.SensorState")
            .setName(
                Collections.singletonList("AAA Smart Water Purifier"),
                "Water purifier",
                Collections.singletonList("Drinking water purifier"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .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", "F600G", "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.WATERPURIFIER",
        "traits": [
          "action.devices.traits.SensorState"
        ],
        "name": {
          "defaultNames": [
            "AAA Smart Water Purifier"
          ],
          "name": "Water purifier",
          "nicknames": [
            "Drinking water purifier"
          ]
        },
        "willReportState": true,
        "attributes": {
          "sensorStatesSupported": [
            {
              "name": "FilterCleanliness",
              "descriptiveCapabilities": {
                "availableStates": [
                  "clean",
                  "dirty",
                  "needs replacement"
                ]
              }
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "F600G",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.