Smart Home Blinds Guide

action.devices.types.BLINDS - Blinds can be opened and closed, and various types of blinds are supported such as venetian (opens in one direction), panel or vertical (may open either left or right), and top-down bottom-up (may open either up or down). Some blinds may have slats that can be rotated.

This type indicates that the device gets the Blinds 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 2500ms.
  • Reliability: must be more than or equal to 97%.

Example device: Simple blinds

This section contains example intent payloads representing a common "Blinds" 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.

In a top-down bottom-up window blind, the UP direction raises the bottom portion of the blind and the DOWN direction lowers the top portion of the blind. Figure 1 shows an example of a top-down bottom-up blind where the UP direction raises the bottom portion of the blind by 50 percent and the DOWN direction lowers the top portion of the blind by 30 percent.

Figure 1. Top-down bottom-up blind

Sample SYNC response

Request
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Response
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.BLINDS",
        "traits": [
          "action.devices.traits.OpenClose"
        ],
        "name": {
          "name": "Simple blinds"
        },
        "willReportState": true,
        "attributes": {
          "openDirection": [
            "UP",
            "DOWN"
          ]
        },
        "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,
        "openState": [
          {
            "openPercent": 30,
            "openDirection": "DOWN"
          },
          {
            "openPercent": 50,
            "openDirection": "UP"
          }
        ]
      }
    }
  }
}

Sample EXECUTE commands

OpenClose

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

Request
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OpenClose",
                "params": {
                  "openPercent": 10,
                  "openDirection": "DOWN"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "openState": [
            {
              "openPercent": 10,
              "openDirection": "DOWN"
            },
            {
              "openPercent": 50,
              "openDirection": "UP"
            }
          ]
        }
      }
    ]
  }
}

Sample utterances

en-US

  • Close blinds

  • Close blinds to 50%

  • Close blinds down

  • Open blinds

  • Open blinds 50%

de-DE

  • Schliesse die Jalousien

  • Schliesse die Jalousien zu 50%
  • Schliess die Jalousien zur Hälfte

  • Lass die Jalousien runter

  • Öffne die Jalousien

  • Öffne die Jalousien 50%

fr-FR

  • Ferme les stores

  • Ferme les stores à 50 %

  • Ferme complètement les stores

  • Ouvre les stores

  • Ouvre les stores à 50 %

es-ES

  • Cierra las persianas

  • Baja las persianas al 50%

  • Baja las persianas

  • Abre las persianas

  • Sube las persianas un 50%

Device ERRORS

See the full list of errors and exceptions.