Smart Home Dehumidifier Guide

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 or fan speed settings.

This type indicates that the device gets the Dehumidifier icon and some related synonyms and aliases.

Device capabilities

Refer to the corresponding trait documentation for implementation details, such as attributes and states that your service should support, and how to build EXECUTE and QUERY responses.

Required traits

These traits and commands are required, if applicable to your device.

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.

Quality requirements

  • Latency: must be less than or equal to 1000ms.
  • Reliability: must be more than or equal to 97%.

Example device: Simple dehumidifier

This section contains example intent payloads representing a common "Dehumidifier" based on the device type and traits above. If you add or remove traits in your implementation, modify your responses accordingly to reflect those changes.

Sample SYNC response

Request
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Response
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.DEHUMIDIFIER",
        "traits": [
          "action.devices.traits.FanSpeed",
          "action.devices.traits.HumiditySetting",
          "action.devices.traits.OnOff"
        ],
        "name": {
          "name": "Simple dehumidifier"
        },
        "willReportState": true,
        "attributes": {
          "humiditySetpointRange": {
            "minPercent": 5,
            "maxPercent": 50
          },
          "availableFanSpeeds": {
            "speeds": [
              {
                "speed_name": "low_key",
                "speed_values": [
                  {
                    "lang": "en",
                    "speed_synonym": [
                      "low",
                      "slow"
                    ]
                  },
                  {
                    "lang": "de",
                    "speed_synonym": [
                      "niedrig",
                      "schleppend"
                    ]
                  }
                ]
              },
              {
                "speed_name": "high_key",
                "speed_values": [
                  {
                    "lang": "en",
                    "speed_synonym": [
                      "high"
                    ]
                  },
                  {
                    "lang": "de",
                    "speed_synonym": [
                      "hoch"
                    ]
                  }
                ]
              }
            ],
            "ordered": true
          }
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Sample QUERY response

Request
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "on": true,
        "currentFanSpeedSetting": "low_key",
        "humiditySetpointPercent": 10,
        "humidityAmbientPercent": 20
      }
    }
  }
}

Sample EXECUTE commands

SetFanSpeed

For additional details on the command parameters, see the action.devices.traits.FanSpeed reference.

Request
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetFanSpeed",
                "params": {
                  "fanSpeed": "high_key"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "currentFanSpeedSetting": "high_key"
        }
      }
    ]
  }
}

SetHumidity

For additional details on the command parameters, see the action.devices.traits.HumiditySetting reference.

Request
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetHumidity",
                "params": {
                  "humidity": 15
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "humiditySetpointPercent": 15,
          "humidityAmbientPercent": 20
        }
      }
    ]
  }
}

OnOff

For additional details on the command parameters, see the action.devices.traits.OnOff reference.

Request
{
  "requestId": "6894439706274654520",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OnOff",
                "params": {
                  "on": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654520",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "on": true
        }
      }
    ]
  }
}

Sample utterances

en-US

  • Turn on the dehumidifier

  • Turn off the dehumidifier

  • Start the dehumidifier

  • Stop the dehumidifier

  • Set fan speed to high on dehumidifier

de-DE

  • Schalte den Luftentfeuchter an

  • Schalte den Luftentfeuchter aus

  • Starte den Luftentfeuchter

  • Stopp den Luftentfeuchter

  • Stell den Ventilator des Luftentfeuchters auf hoch

fr-FR

  • Allume le déshumidificateur

  • Éteins le déshumidificateur

  • Démarre le déshumidificateur

  • Arrête le déshumidificateur

  • Règle la vitesse maximale sur le ventilateur du déshumidificateur

es-ES

  • Enciende el deshumidificador

  • Apaga el deshumificador

  • Pon el deshumidificador en marcha

  • Para el deshumidificador

  • Pon la ventilación del deshumidificador al máximo

Device ERRORS

See the full list of errors and exceptions.