Guide sur les chaudières pour maison connectée

action.devices.types.BOILER : les chaudières peuvent être allumées et éteintes, et leur température peut être ajustée.

Ce type indique que l'appareil reçoit l'icône "Chaudière" ainsi que certains synonymes et alias associés.

Fonctionnalités de l'appareil

Consultez la documentation sur le trait correspondant pour obtenir des informations sur l'implémentation, telles que les attributs et les états que votre service doit prendre en charge, ainsi que sur la création de réponses EXECUTE et QUERY.

Traits obligatoires

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

Ces traits sont recommandés, le cas échéant pour votre appareil. Toutefois, vous pouvez combiner tous les traits disponibles pour qu'ils correspondent au mieux aux fonctionnalités de votre produit existant.

Exemple d'appareil : chaudière simple

Cette section contient des exemples de charges utiles d'intent représentant une "chaudière" courante en fonction du type d'appareil et des traits ci-dessus. Si vous ajoutez ou supprimez des traits dans votre implémentation, modifiez vos réponses en conséquence.

Exemple de réponse SYNC

Requête
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.BOILER",
        "traits": [
          "action.devices.traits.TemperatureControl",
          "action.devices.traits.OnOff"
        ],
        "name": {
          "name": "Simple boiler"
        },
        "willReportState": true,
        "attributes": {
          "temperatureRange": {
            "minThresholdCelsius": 10,
            "maxThresholdCelsius": 50
          },
          "temperatureUnitForUX": "F"
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Exemple de réponse QUERY

Requête
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "on": true,
        "temperatureSetpointCelsius": 35
      }
    }
  }
}

Exemples de commandes EXECUTE

SetTemperature

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

Requête
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetTemperature",
                "params": {
                  "temperature": 40
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "temperatureSetpointCelsius": 40
        }
      }
    ]
  }
}

OnOff

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

Requête
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OnOff",
                "params": {
                  "on": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Réponse
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "on": true
        }
      }
    ]
  }
}

ERREURS de l'appareil

Consultez la liste complète des erreurs et exceptions.