Smart-Home-Attribut „Fill“ – Schema

action.devices.traits.Fill : Dieses Attribut gilt für Geräte, die gefüllt werden können, z. B. eine Badewanne.

Geräteattribute

Geräte mit diesem Attribut können die folgenden Attribute im Rahmen des SYNC Vorgangs melden. Weitere Informationen zur Verarbeitung von SYNC Intents finden Sie unter Intent-Ausführung.

Attribute Typ Beschreibung
availableFillLevels Objekt

Beschreibt verschiedene Füllstände des Geräts.

levels Array

Erforderlich.

Liste der Namen der Füllstände und sprachspezifischer Synonyme.

[item, ...] Objekt

Name des Füllstands und seine sprachspezifischen Synonyme.

level_name String

Erforderlich.

Interner Name des Füllstands. Dieser Name ist möglicherweise nicht nutzerfreundlich und wird für alle Sprachen verwendet.

level_values Array

Erforderlich.

Synonyme des Füllstands in jeder unterstützten Sprache.

[item, ...] Objekt

Synonyme des Füllstands in einer bestimmten Sprache. Es ist mindestens ein Element mit dem lang-Wert en erforderlich, um einen Sprach-Fallback zu ermöglichen.

level_synonym Array

Erforderlich.

Synonym des Füllstands. Der erste String in dieser Liste wird als kanonischer Name des Füllstands in dieser Sprache verwendet.

[item, ...] String

Synonym name. Es ist mindestens ein Element mit dem lang-Wert en erforderlich, um einen Sprach-Fallback zu ermöglichen.

lang String

Erforderlich.

Sprachcode (ISO 639-1). Siehe unterstützte Sprachen.

ordered Boolesch

Erforderlich.

Wenn „true“, verarbeitet das Gerät zusätzliche Grammatik für die Logik zum Erhöhen oder Verringern, wie durch das levels-Array dargestellt (z. B. halber Füllstand).

supportsFillPercent Boolesch

(Standard: false)

Wenn „true“, werden Befehle zum Anpassen des Füllstands auf einen Prozentsatz akzeptiert.

Beispiele

Gerät mit grundlegenden Füll- oder Entleerungsfunktionen, das keine diskreten Füllstände unterstützt.

{}

Gerät, das diskrete Füllstände unterstützt.

{
  "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
  }
}

Gerätestatus

Entitäten mit diesem Attribut können die folgenden Status im Rahmen des QUERY Vorgangs melden. Weitere Informationen zur Verarbeitung von QUERY-Intents finden Sie unter Intent-Ausführung.

Status Typ Beschreibung
isFilled Boolesch

Erforderlich.

„true“, wenn das Gerät bis zu einem bestimmten Füllstand gefüllt ist. „false“, wenn das Gerät vollständig entleert ist.

currentFillLevel String

Erforderlich, wenn das Attribut availableFillLevels festgelegt ist. Gibt den aktuellen level_name aus dem Attribut availableFillLevels an, bis zu dem das Gerät gefüllt ist.

currentFillPercent Number

Erforderlich, wenn das Attribut supportsFillPercent festgelegt ist. Gibt den aktuellen Füllstand in Prozent an.

Der Wert muss zwischen 0 und 100 liegen.

Beispiele

Ist die Badewanne gefüllt?

{
  "isFilled": true
}

Ist die Badewanne gefüllt? (mit Füllständen).

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

Gerätebefehle

Geräte mit diesem Attribut können im Rahmen des EXECUTE Vorgangs auf die folgenden Befehle reagieren. Weitere Informationen zur Verarbeitung von EXECUTE Intents finden Sie unter Intent-Ausführung.

action.devices.commands.Fill

Gerät füllen oder entleeren.

Parameter

Parameter Typ Beschreibung
fill Boolesch

Erforderlich.

„true“ zum Füllen, „false“ zum Entleeren.

fillLevel String

Gibt den level_name aus dem Attribut availableFillLevels an, der festgelegt werden soll. Wenn nicht angegeben, wird bis zum Standardfüllstand gefüllt.

fillPercent Number

Gibt den angeforderten Füllstand in Prozent an.

Der Wert muss zwischen 0 und 100 liegen.

Beispiele

Fülle die Badewanne.

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

Lass das Wasser aus der Badewanne ab.

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

Fülle die Badewanne halb.

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

Erhöhe den Füllstand der Badewanne um eins (das Attribut ordered muss true sein).

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

Gerätefehler

Vollständige Liste der Fehler und Ausnahmen