Guide sur les distributeurs de nourriture pour animaux connectés

action.devices.types.PETFEEDER : les interactions avec les distributeurs de nourriture pour animaux de compagnie peuvent inclure la distribution de nourriture ou d'eau pour animaux de compagnie en différentes quantités et avec différents préréglages.

Ce type indique que l'appareil obtient l'icône du distributeur de nourriture pour animaux de compagnie, ainsi que certains synonymes et alias associés.

Fonctionnalités de l'appareil

Pour en savoir plus sur l'implémentation, comme les attributs et les états que votre service doit prendre en charge, et sur la façon de créer des réponses EXECUTE et QUERY, consultez la documentation sur le trait correspondant.

Traits requis

Ces traits et commandes sont obligatoires, le cas échéant, pour votre appareil. Si votre appareil n'est pas compatible avec ces caractéristiques, saisissez le code d'erreur functionNotSupported dans une réponse QUERY ou EXECUTE. Pour en savoir plus, consultez Erreurs et exceptions.

Ces caractéristiques sont recommandées, le cas échéant pour votre appareil. Toutefois, vous êtes libre de combiner les traits disponibles pour correspondre au mieux aux fonctionnalités de votre produit existant.

Exemple d'appareil : distributeur de nourriture simple pour animaux

Cette section contient des exemples de charges utiles d'intent représentant un "distributeur d'aliments pour animaux" courant, basés sur le type d'appareil et les caractéristiques ci-dessus. Si vous ajoutez ou supprimez des traits dans votre implémentation, modifiez vos réponses en conséquence pour refléter ces changements.

Exemple de réponse SYNC

Demande
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Réponse
{
  "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"
        }
      }
    ]
  }
}

Exemple de réponse QUERY

Demande
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Réponse
{
  "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
      }
    }
  }
}

Exemples de commandes EXECUTE

Distribution

Pour en savoir plus sur les paramètres de la commande, consultez la documentation de référence sur action.devices.traits.Dispense.

Demande
{
  "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"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Réponse
{
  "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

Pour en savoir plus sur les paramètres de la commande, consultez la documentation de référence sur action.devices.traits.StartStop.

Demande
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.StartStop",
                "params": {
                  "start": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}

PauseUnpause

Pour en savoir plus sur les paramètres de la commande, consultez la documentation de référence sur action.devices.traits.StartStop.

Demande
{
  "requestId": "6894439706274654520",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.PauseUnpause",
                "params": {
                  "pause": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654520",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "isRunning": false,
          "isPaused": true
        }
      }
    ]
  }
}

ERREURS liées à l'appareil

Consultez la liste complète des erreurs et exceptions.