Guia de esfregão para casa inteligente

action.devices.types.MOP - As interações com os esfregões podem incluir iniciar, parar, pausar a limpeza, encaixar, verificar o ciclo de limpeza atual, localizar o esfregão ou ajustar vários modos. Alguns esfregões podem limpar zonas específicas da casa.

Esse tipo indica que o dispositivo recebe o ícone de esfregão e alguns sinônimos e aliases relacionados.

Recursos do dispositivo

Consulte a documentação da característica correspondente para detalhes da implementação, como atributos e estados que seu serviço precisa oferecer suporte, e como criar respostas EXECUTE e QUERY.

Características obrigatórias

Essas características e comandos são obrigatórios, se aplicáveis ao seu dispositivo. Se o dispositivo não for compatível com esses recursos, insira o código de erro de functionNotSupported em uma resposta QUERY ou EXECUTE. Consulte Erros e exceções para mais informações.

Esses traços são recomendados, se aplicáveis ao seu dispositivo. No entanto, você pode misturar e combinar todos os traços disponíveis para corresponder melhor à funcionalidade do produto.

Dispositivo de exemplo: esfregão simples

Esta seção contém exemplos de payloads de intent que representam um "Mop" comum com base no tipo de dispositivo e nas características acima. Se você adicionar ou remover características na sua implementação, modifique as respostas de acordo para refletir essas mudanças.

Exemplo de resposta de sincronização

Solicitação
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.MOP",
        "traits": [
          "action.devices.traits.Dock",
          "action.devices.traits.EnergyStorage",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple mop"
        },
        "willReportState": true,
        "attributes": {
          "queryOnlyEnergyStorage": true,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Exemplo de resposta de QUERY

Solicitação
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Resposta
{
  "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
          }
        ]
      }
    }
  }
}

Exemplos de comandos EXECUTE

Base

Para mais detalhes sobre os parâmetros de comando, consulte a referência action.devices.traits.Dock.

Solicitação
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Dock"
              }
            ]
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isDocked": true
        }
      }
    ]
  }
}

StartStop

Para mais detalhes sobre os parâmetros de comando, consulte a referência action.devices.traits.StartStop.

Solicitação
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.StartStop",
                "params": {
                  "start": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}

ERROS do dispositivo

Confira a lista completa de erros e exceções.