Smart Home ArmDisarm-Trait-Schema

action.devices.traits.ArmDisarm: Dieses Merkmal unterstützt das Scharf- und Unscharfschalten, wie es beispielsweise in Sicherheitssystemen verwendet wird.

Bei Geräten mit mehreren Sicherheitsstufen sollten diese Stufen mit dem Attribut availableArmLevels angegeben werden.

Geräteattribute

Geräte mit diesem Merkmal können die folgenden Attribute als Teil des Vorgangs SYNC melden. Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Intent-Fulfillment.

Attribute Typ Beschreibung
availableArmLevels Objekt

Beschreibt die unterstützten Sicherheitsstufen des Geräts. Wenn dieses Attribut nicht gemeldet wird, unterstützt das Gerät nur eine Ebene.
levels Array

Erforderlich.

Liste der verfügbaren Sicherheitsstufen, die vom Gerät unterstützt werden.
[item, ...] Objekt

Sicherheitsniveau.
level_name String

Erforderlich.

Der interne Name der Sicherheitsstufe, der in Befehlen und Status verwendet wird. Dieser Name ist möglicherweise nicht nutzerfreundlich und wird für alle Sprachen freigegeben.
level_values Array

Erforderlich.

Enthält level_synonym und lang.
[item, ...] Objekt

Synonym für eine bestimmte Sprache. Mindestens ein Artikel mit dem lang-Wert en ist erforderlich, um einen Sprach-Fallback zu ermöglichen.
level_synonym Array

Erforderlich.

Nutzerfreundliche Namen für die Stufe in jeder unterstützten Sprache. Das erste Element wird als kanonischer Name behandelt.
[item, ...] String

Synonym name. Mindestens ein Artikel mit dem lang-Wert en ist erforderlich, um einen Sprach-Fallback zu ermöglichen.
lang String

Erforderlich.

Sprachcode für die Stufensynonyme. Unterstützte Sprachen
ordered Boolesch

Erforderlich.

Wenn diese Option auf „true“ gesetzt ist, wird zusätzliche Grammatik für die Logik zum Erhöhen/Verringern in der Reihenfolge des „levels“-Arrays angewendet. Wenn Sie beispielsweise „Hey Google, erhöhe mein Sicherheitsniveau um 1“ sagen, ermittelt Assistant das aktuelle Sicherheitsniveau und erhöht es dann um eins. Wenn dieser Wert auf „false“ gesetzt ist, wird keine zusätzliche Grammatik für die Logik für Steigerung/Rückgang unterstützt.

Beispiele

Sicherheitssystem mit zwei verschiedenen Scharfschaltstufen

{
  "availableArmLevels": {
    "levels": [
      {
        "level_name": "L1",
        "level_values": [
          {
            "level_synonym": [
              "Home and Guarding",
              "SL1"
            ],
            "lang": "en"
          },
          {
            "level_synonym": [
              "Zuhause und Bewachen",
              "SL1"
            ],
            "lang": "de"
          }
        ]
      },
      {
        "level_name": "L2",
        "level_values": [
          {
            "level_synonym": [
              "Away and Guarding",
              "SL2"
            ],
            "lang": "en"
          },
          {
            "level_synonym": [
              "Weg und Bewachen",
              "SL2"
            ],
            "lang": "de"
          }
        ]
      }
    ],
    "ordered": true
  }
}

Gerätestatus

Für Entitäten mit diesem Merkmal können im Rahmen des Vorgangs QUERY die folgenden Status gemeldet werden. Weitere Informationen zum Umgang mit QUERY-Intents finden Sie unter Intent-Fulfillment.

Bundesstaaten Typ Beschreibung
isArmed Boolesch

Erforderlich.

Gibt an, ob das Gerät derzeit scharf geschaltet ist.
currentArmLevel String

Erforderlich.

Erforderlich, wenn das Attribut availableArmLevels angegeben ist. Wenn mehrere Sicherheitsstufen vorhanden sind, wird der Name der aktuellen Sicherheitsstufe angezeigt.
exitAllowance Ganzzahl

Gibt die Zeit in Sekunden an, die der Nutzer warten muss, bevor currentArmLevel wirksam wird.

Beispiele

Sicherheitssystem, das einen bestimmten Scharfschaltungsgrad meldet

{
  "isArmed": true,
  "currentArmLevel": "L1"
}

GERÄTEBEFEHLE

Geräte mit diesem Merkmal können im Rahmen des Vorgangs EXECUTE auf die folgenden Befehle reagieren. Weitere Informationen zum Umgang mit EXECUTE-Intents finden Sie unter Intent-Fulfillment.

action.devices.commands.ArmDisarm

Legen Sie die Alarmstufe für dieses Gerät fest.

Parameter

Die Nutzlast enthält eines der folgenden Elemente:

Scharf- oder Unscharfschalten abbrechen

Parameter Typ Beschreibung
followUpToken String

Von Google bereitgestelltes Token für die Follow-up-Antwort.
arm Boolesch

Erforderlich.

„True“, wenn der Befehl zum Scharfschalten verwendet wird. Falsch zum Deaktivieren.
cancel Boolesch

Erforderlich.

„True“, wenn der Befehl den Wert arm abbrechen soll.

Gerät scharf oder unscharf schalten, mit optionalem Sicherheitsniveau.

Parameter Typ Beschreibung
followUpToken String

Von Google bereitgestelltes Token für die Follow-up-Antwort.
arm Boolesch

Erforderlich.

„True“, wenn der Befehl zum Scharfschalten verwendet wird. Falsch zum Deaktivieren.
armLevel String

Die level_name, auf die scharfgeschaltet werden soll.

Beispiele

System scharf schalten

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "followUpToken": "123"
  }
}

System auf die Scharfschaltungsstufe L1 einstellen

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "armLevel": "L1",
    "followUpToken": "456"
  }
}

Scharfschalten abbrechen

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "cancel": true
  }
}

Beim Scharf- oder Unscharfschalten des Geräts ist ein Fehler aufgetreten.

Unterstützte Werte:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

GERÄTEFEHLER

Vollständige Liste der Fehler und Ausnahmen