Guia de comedouros automáticos para pets

action.devices.types.PETFEEDER - As interações com comedouros automáticos podem incluir a liberação de ração ou água em várias quantidades e configurações predefinidas.

Esse tipo indica que o dispositivo recebe o ícone do comedouro automático 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 necessá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.

Essas características são recomendadas, se aplicáveis ao seu dispositivo. No entanto, você pode combinar todos os traços disponíveis para corresponder melhor à funcionalidade do produto.

Exemplo de dispositivo: comedouro automático simples

Esta seção contém exemplos de payloads de intent que representam um "Alimentador de animais de estimação" 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 SYNC

Solicitação
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.PETFEEDER",
        "traits": [
          "action.devices.traits.Dispense",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple pet feeder"
        },
        "willReportState": true,
        "attributes": {
          "supportedDispenseItems": [
            {
              "item_name": "cat_food_key",
              "item_name_synonyms": [
                {
                  "lang": "en",
                  "synonyms": [
                    "Cat food",
                    "Kibble"
                  ]
                }
              ],
              "supported_units": [
                "OUNCES",
                "CUPS"
              ],
              "default_portion": {
                "amount": 1,
                "unit": "CUPS"
              }
            }
          ],
          "supportedDispensePresets": [
            {
              "preset_name": "cat_meal_key",
              "preset_name_synonyms": [
                {
                  "lang": "en",
                  "synonyms": [
                    "Normal meal",
                    "Dinner"
                  ]
                }
              ]
            }
          ]
        },
        "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,
        "dispenseItems": [
          {
            "itemName": "cat_food_key",
            "amountRemaining": {
              "amount": 6,
              "unit": "CUPS"
            },
            "amountLastDispensed": {
              "amount": 2.5,
              "unit": "CUPS"
            },
            "isCurrentlyDispensing": false
          }
        ],
        "isRunning": true,
        "isPaused": false
      }
    }
  }
}

Exemplos de comandos EXECUTE

Dispensar

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

Solicitação
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Dispense",
                "params": {
                  "amount": 1,
                  "unit": "CUPS",
                  "item": "cat_food_key"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "dispenseItems": [
            {
              "itemName": "cat_food_key",
              "amountRemaining": {
                "amount": 5,
                "unit": "CUPS"
              },
              "amountLastDispensed": {
                "amount": 1,
                "unit": "CUPS"
              },
              "isCurrentlyDispensing": 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": "PENDING",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}

PauseUnpause

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

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

ERROS do dispositivo

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