Schéma du trait de remplissage de la maison connectée

action.devices.traits.Fill : ce trait s'applique aux appareils qui peuvent être remplis, comme une baignoire.

ATTRIBUTS de l'appareil

Les appareils dotés de ce trait peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Fulfillment d'intent.

Attributs Type Description
availableFillLevels Objet

Décrit les différents niveaux de remplissage de l'appareil.

levels Array

Obligatoire.

Liste des noms de niveaux et des synonymes spécifiques à une langue.

[item, ...] Objet

Nom du niveau et ses synonymes spécifiques à la langue.

level_name String

Obligatoire.

Nom interne du niveau. Cela peut être difficile à comprendre pour les utilisateurs et sera partagé dans toutes les langues.

level_values Array

Obligatoire.

Synonymes du niveau dans chaque langue disponible.

[item, ...] Objet

Synonymes du niveau dans une langue donnée. Au moins un élément avec une valeur lang de en est requis pour fournir une langue de remplacement.

level_synonym Array

Obligatoire.

Synonyme du niveau. La première chaîne de cette liste est utilisée comme nom canonique du niveau dans cette langue.

[item, ...] String

Nom du synonyme. Au moins un élément avec une valeur lang de en est requis pour fournir une langue de remplacement.

lang String

Obligatoire.

Code de langue (ISO 639-1). Consultez les langues disponibles.

ordered Valeur booléenne

Obligatoire.

Si la valeur est "true", l'appareil gère la grammaire supplémentaire pour la logique d'augmentation ou de diminution, comme représenté par le tableau levels (par exemple, le niveau intermédiaire).

supportsFillPercent Valeur booléenne

(Par défaut : false)

Si la valeur est "true", acceptez les commandes permettant d'ajuster le niveau à un pourcentage.

Exemples

Appareil doté de fonctionnalités de remplissage ou de vidange de base, mais qui n'est pas compatible avec les niveaux de remplissage discrets.

{}

Appareil compatible avec des niveaux de remplissage discrets.

{
  "availableFillLevels": {
    "levels": [
      {
        "level_name": "half_level",
        "level_values": [
          {
            "level_synonym": [
              "Half",
              "Half way",
              "One half"
            ],
            "lang": "en"
          }
        ]
      },
      {
        "level_name": "full_level",
        "level_values": [
          {
            "level_synonym": [
              "Full",
              "All the way",
              "Complete"
            ],
            "lang": "en"
          }
        ]
      }
    ],
    "ordered": true
  }
}

ÉTATS des appareils

Les entités dotées de ce trait peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez Fulfillment d'intent.

États Type Description
isFilled Valeur booléenne

Obligatoire.

"True" si l'appareil est rempli à un niveau quelconque. Faux si la batterie de l'appareil est complètement déchargée.

currentFillLevel String

Obligatoire si l'attribut availableFillLevels est défini. Indique la level_name actuelle de l'attribut availableFillLevels à laquelle l'appareil est rempli.

currentFillPercent Number

Obligatoire si l'attribut supportsFillPercent est défini. Indique le pourcentage de remplissage actuel.

La valeur doit être comprise entre 0 et 100.

Exemples

La baignoire est-elle remplie ?

{
  "isFilled": true
}

La baignoire est-elle remplie ? (avec des niveaux).

{
  "isFilled": true,
  "currentFillLevel": "half_level"
}

COMMANDES de l'appareil

Les appareils dotés de ce trait peuvent répondre aux commandes suivantes dans le cadre de l'opération EXECUTE. Pour en savoir plus sur la gestion des intents EXECUTE, consultez Fulfillment d'intent.

action.devices.commands.Fill

Remplissez ou videz l'appareil.

Paramètres

Paramètres Type Description
fill Valeur booléenne

Obligatoire.

True pour remplir, false pour vider.

fillLevel String

Indique le level_name de l'attribut availableFillLevels à définir. Si aucune valeur n'est spécifiée, le remplissage se fait au niveau par défaut.

fillPercent Number

Indique le pourcentage du niveau demandé.

La valeur doit être comprise entre 0 et 100.

Exemples

Remplis la baignoire.

{
  "command": "action.devices.commands.Fill",
  "params": {
    "fill": true
  }
}

Vider la baignoire.

{
  "command": "action.devices.commands.Fill",
  "params": {
    "fill": false
  }
}

Remplis la baignoire à moitié.

{
  "command": "action.devices.commands.Fill",
  "params": {
    "fill": true,
    "fillLevel": "half_level"
  }
}

Augmente le niveau de remplissage de la baignoire de un (l'attribut ordered doit être défini sur true).

{
  "command": "action.devices.commands.Fill",
  "params": {
    "fill": true,
    "fillLevel": "full_level"
  }
}

ERREURS liées à l'appareil

Consultez la liste complète des erreurs et exceptions.