Руководство по пылесосу для умного дома

action.devices.types.VACUUM — пылесосы могут иметь такие функции, как запуск, остановка и приостановка уборки, стыковка, проверка текущего цикла уборки, определение местоположения пылесоса или настройка различных режимов. Некоторые пылесосы могут поддерживать уборку определенных зон в доме.

Этот тип означает, что на устройстве отображается значок «Пылесос» и некоторые связанные с ним синонимы и псевдонимы.

Возможности устройства

Обратитесь к соответствующей документации по типажу для получения подробной информации о реализации, такой как атрибуты и состояния, которые ваша служба должна поддерживать, а также о том, как создавать ответы EXECUTE и QUERY.

Требуемые черты

Эти характеристики и команды обязательны, если они применимы к вашему устройству. Если ваше устройство не поддерживает эти функции, введите код ошибки functionNotSupported в ответе QUERY или EXECUTE. Дополнительную информацию см. в разделе «Ошибки и исключения» .

Эти характеристики рекомендуются, если они применимы к вашему устройству. Однако вы можете комбинировать все доступные характеристики, чтобы наилучшим образом соответствовать существующей функциональности вашего продукта.

Требования к качеству

  • Задержка: должна быть меньше или равна 800 мс .
  • Надежность: должна быть больше или равна 97% .

Пример устройства: простой вакуум

В этом разделе приведены примеры полезных данных намерений, представляющих общий «Вакуум» на основе типа устройства и характеристик, указанных выше. Если вы добавляете или удаляете черты в своей реализации, измените свои ответы соответствующим образом, чтобы отразить эти изменения.

Пример ответа 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
        }
      }
    ]
  }
}

СтартСтоп

Дополнительные сведения о параметрах команды см. в справочнике 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
        }
      }
    ]
  }
}

ОШИБКИ устройства

Полный список ошибок и исключений смотрите .