智能家居吸尘器指南

action.devices.types.VACUUM - 吸尘器可能具有多种功能，例如开始、停止和暂停清洁、插入基座、检查当前清洁周期、定位吸尘器或者调整各种模式。某些吸尘器可能支持清洁家中的特定区域。

此类型表示设备会获得吸尘器图标以及一些相关的同义词和别名。

设备功能

如需了解实现详情（例如您的服务应支持的属性和状态，以及如何构建 EXECUTE 和 QUERY 响应），请参阅相应的 trait 文档。

必需的特征

这些 trait 和命令是必需的（如果适用于您的设备）。如果您的设备不支持这些 trait，请在 QUERY 或 EXECUTE 响应中输入 functionNotSupported 错误代码。如需了解详情，请参阅错误和异常。

建议您使用以下 trait（如果适用于您的设备）。 不过，您可以自由组合使用所有可用的 trait，以便尽可能匹配现有的产品功能。

质量要求

  • 延迟时间：必须小于或等于 800 毫秒。
  • 可靠性：必须大于或等于 97%。

设备示例：简单吸尘器

本部分包含根据上述设备类型和特性表示常见“吸尘器”的 intent 载荷示例。如果您在实现中添加或移除 trait，请相应地修改响应以反映这些更改。

SYNC 响应示例

请求
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
响应
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.VACUUM",
        "traits": [
          "action.devices.traits.Dock",
          "action.devices.traits.EnergyStorage",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple vacuum"
        },
        "willReportState": true,
        "attributes": {
          "queryOnlyEnergyStorage": true,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

QUERY 响应示例

请求
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
响应
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "isRunning": false,
        "isPaused": false,
        "isDocked": true,
        "descriptiveCapacityRemaining": "HIGH",
        "capacityRemaining": [
          {
            "unit": "SECONDS",
            "rawValue": 36000
          },
          {
            "unit": "PERCENTAGE",
            "rawValue": 90
          }
        ]
      }
    }
  }
}

EXECUTE 命令示例

基座

如需详细了解命令参数，请参阅 action.devices.traits.Dock 参考文档。

请求
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Dock"
              }
            ]
          }
        ]
      }
    }
  ]
}
响应
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isDocked": true
        }
      }
    ]
  }
}

StartStop

如需详细了解命令参数，请参阅 action.devices.traits.StartStop 参考文档。

请求
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.StartStop",
                "params": {
                  "start": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
响应
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}

设备错误

查看错误和异常的完整列表。