Guide de l'obturateur de maison connectée

action.devices.types.SHUTTER : les obturateurs peuvent être ouverts et fermés dans plusieurs sens. Certains volets peuvent comporter des lattes qu'il est possible de faire pivoter.

Ce type indique que l'appareil obtient l'icône Obturateur et certains synonymes et alias associés.

Fonctionnalités de l'appareil

Consultez la documentation sur les caractéristiques correspondantes pour obtenir des détails sur l'implémentation, tels que les attributs et les états que votre service doit accepter, et pour découvrir comment créer des réponses EXECUTE et QUERY.

Caractéristiques obligatoires

Ces caractéristiques et commandes sont nécessaires, le cas échéant. 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. Cependant, vous êtes libre de combiner toutes les caractéristiques disponibles pour correspondre au mieux aux fonctionnalités existantes de votre produit.

Exigences de qualité

  • Latence:doit être inférieure ou égale à 2 500 ms.
  • Fiabilité:doit être supérieure ou égale à 97%.

Exemple d'appareil: obturateur simple

Cette section contient des exemples de charges utiles d'intent représentant un obturateur courant basé sur le type d'appareil et les caractéristiques ci-dessus. Si vous ajoutez ou supprimez des caractéristiques dans votre mise en œuvre, modifiez vos réponses en conséquence.

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.SHUTTER",
        "traits": [
          "action.devices.traits.OpenClose"
        ],
        "name": {
          "name": "Simple shutter"
        },
        "willReportState": true,
        "attributes": {
          "openDirection": [
            "UP",
            "DOWN"
          ]
        },
        "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,
        "openState": [
          {
            "openPercent": 30,
            "openDirection": "DOWN"
          },
          {
            "openPercent": 50,
            "openDirection": "UP"
          }
        ]
      }
    }
  }
}

Exemples de commandes EXECUTE

OpenClose

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

Demande
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OpenClose",
                "params": {
                  "openPercent": 10,
                  "openDirection": "DOWN"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "openState": [
            {
              "openPercent": 10,
              "openDirection": "DOWN"
            },
            {
              "openPercent": 50,
              "openDirection": "UP"
            }
          ]
        }
      }
    ]
  }
}

ERREURS sur l'appareil

Consultez la liste complète des erreurs et exceptions.