Smart Home Dehumidifier Guide

Device TYPE

action.devices.types.DEHUMIDIFIER Dehumidifiers are devices that remove moisture from the air. They can be turned on and off, report and adjust target humidity, and may have various adjustables modes, toggles, or fan speed settings.

This type indicates that the device gets the dehumidifier 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.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.DEHUMIDIFIER',
        traits: [
          'action.devices.traits.HumiditySetting',
          'action.devices.traits.StartStop',
          'action.devices.traits.FanSpeed'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation Dehumidifier'],
          name: 'Dehumidifier',
          nicknames: ['Kitchen Dehumidifier']
        },
        willReportState: true,
        attributes: {
          pausable: true,
          humiditySetpointRange: {
            minPercent: 30,
            maxPercent: 100
          },
          availableFanSpeeds: {
            speeds: [{
              speed_name: 'Low',
              speed_values: [{
                lang: 'en',
                speed_synonym: ['low', 'slow']
              }, {
                lang: 'de',
                speed_synonym: ['niedrig', 'schleppend']
              }]
            }, {
              speed_name: 'High',
              speed_values: [{
                lang: 'en',
                speed_synonym: ['high']
              }, {
                lang: 'de',
                speed_synonym: ['hoch']
              }]
            }],
            ordered: true
          },
          reversible: true
        },
        deviceInfo: {
          manufacturer: 'ACME',
          model: '492134',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'goatjive'
        }
      }]
    }
  };
});

// ...

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("1836.15267389")
          .setType("action.devices.types.DEHUMIDIFIER")
          .addTrait("action.devices.traits.HumiditySetting")
          .addTrait("action.devices.traits.StartStop")
          .addTrait("action.devices.traits.FanSpeed")
          .setName(
              Collections.singletonList("Sirius Cybernetics Corporation Dehumidifier"),
              "Dehumidifier",
              Collections.singletonList("Kitchen Dehumidifier")
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("pausable", true)
              .put("humiditySetpointRange", new JSONObject()
                  .put("minPercent", 30)
                  .put("maxPercent", 100)
              )
              .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[] {"niedrig", "schleppend"})
                              .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[] {"hoch"})
                              .put("lang", "de")
                      })
                  })
                  .put("ordered", true)
              )
              .put("reversible", true)
          )
          .setDeviceInfo("ACME", "492134", "3.2", "11.4")
          .setCustomData(new JSONObject()
              .put("fooValue", 74)
              .put("barValue", true)
              .put("bazValue", "goatjive")
              .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.DEHUMIDIFIER",
        "traits": [
          "action.devices.traits.HumiditySetting",
          "action.devices.traits.StartStop",
          "action.devices.traits.FanSpeed"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation Dehumidifier"
          ],
          "name": "Dehumidifier",
          "nicknames": [
            "Kitchen Dehumidifier"
          ]
        },
        "willReportState": true,
        "attributes": {
          "pausable": true,
          "humiditySetpointRange": {
            "minPercent": 30,
            "maxPercent": 100
          },
          "availableFanSpeeds": {
            "speeds": [
              {
                "speed_name": "Low",
                "speed_values": [
                  {
                    "lang": "en",
                    "speed_synonym": [
                      "low",
                      "slow"
                    ]
                  },
                  {
                    "lang": "de",
                    "speed_synonym": [
                      "niedrig",
                      "schleppend"
                    ]
                  }
                ]
              },
              {
                "speed_name": "High",
                "speed_values": [
                  {
                    "lang": "en",
                    "speed_synonym": [
                      "high"
                    ]
                  },
                  {
                    "lang": "de",
                    "speed_synonym": [
                      "hoch"
                    ]
                  }
                ]
              }
            ],
            "ordered": true
          },
          "reversible": true
        },
        "deviceInfo": {
          "manufacturer": "ACME",
          "model": "492134",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "goatjive"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.