Smart Home ArmDisarm Trait Schema

action.devices.traits.ArmDisarm: Diese Eigenschaft unterstützt das Aktivieren und Deaktivieren, wie es beispielsweise bei Sicherheitssystemen verwendet wird.

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

Geräteattribute

Geräte mit dieser Eigenschaft können die folgenden Attribute im Rahmen des Vorgangs SYNC melden. Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Intent-Ausführung.

Attribute	Typ	Beschreibung
availableArmLevels	Objekt	Beschreibt die unterstützten Sicherheitsebenen des Geräts. Wenn dieses Attribut nicht gemeldet wird, unterstützt das Gerät nur eine Stufe.
levels	Array	Erforderlich. Liste der verfügbaren Sicherheitsebenen, die vom Gerät unterstützt werden.
[item, ...]	Objekt	Sicherheitsebene
level_name	String	Erforderlich. Der interne Name der Sicherheitsebene, der in Befehlen und Status verwendet wird. Dieser Name kann nicht nutzerfreundlich sein und wird für alle Sprachen verwendet.
level_values	Array	Erforderlich. Enthält level_synonym und lang.
[item, ...]	Objekt	Synonyme für Stufen für eine bestimmte Sprache.
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	Name des Synonymes.
lang	String	Erforderlich. Sprachcode für die Synonyme der Stufe. Weitere Informationen finden Sie unter Unterstützte Sprachen.
ordered	Boolesch	Erforderlich. Wenn diese Option auf „wahr“ gesetzt ist, gilt die zusätzliche Grammatik für die Logik „erhöhen/verringern“ in der Reihenfolge des Levels-Arrays. Wenn Sie beispielsweise „Hey Google, erhöhe mein Sicherheitsniveau um 1“ sagen, ermittelt Assistant das aktuelle Sicherheitsniveau und erhöht es dann um 1. Wenn dieser Wert auf „falsch“ gesetzt ist, wird keine zusätzliche Grammatik für die Logik „erhöhen/verringern“ unterstützt.

Beispiele

Sicherheitssystem mit zwei verschiedenen Einbruchsalarmstufen

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

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

Bundesstaaten	Typ	Beschreibung
isArmed	Boolesch	Erforderlich. Gibt an, ob das Gerät derzeit gesichert ist.
currentArmLevel	String	Erforderlich. Erforderlich, wenn das Attribut availableArmLevels angegeben ist. Wenn es mehrere Sicherheitsebenen gibt, wird der Name der aktuellen Sicherheitsebene angezeigt.
exitAllowance	Ganzzahl	Gibt an, wie lange der Nutzer warten muss, bevor currentArmLevel wirksam wird.

Beispiele

Sicherheitssystem, das eine eindeutige Scharfschaltungsebene meldet

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

BEFEHLE für Geräte

Geräte mit dieser Eigenschaft können im Rahmen des Vorgangs EXECUTE auf die folgenden Befehle reagieren. Weitere Informationen zum Umgang mit EXECUTE-Intents finden Sie unter Intent-Ausführung.

action.devices.commands.ArmDisarm

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

Parameter

Die Nutzlast enthält Folgendes:

Scharf- oder Unscharfstellen abbrechen

Parameter	Typ	Beschreibung
followUpToken	String	Von Google bereitgestelltes Token für die Antwort auf das Ersuchen.
arm	Boolesch	Erforderlich. „Wahr“, wenn der Befehl „Armieren“ lautet. „False“, um die Alarmanlage zu deaktivieren.
cancel	Boolesch	Erforderlich. „Wahr“, wenn der Befehl den Wert arm aufheben soll.

Sie können das Gerät mit einem optionalen Sicherheitsniveau scharf- oder unscharf schalten.

Parameter	Typ	Beschreibung
followUpToken	String	Von Google bereitgestelltes Token für die Antwort auf das Ersuchen.
arm	Boolesch	Erforderlich. „Wahr“, wenn der Befehl „Armieren“ lautet. „False“, um die Alarmanlage zu deaktivieren.
armLevel	String	Der level_name, auf den scharfgeschaltet werden soll.

Beispiele

System scharfstellen

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

System auf die Alarmstufe L1 stellen

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

Aktivieren abbrechen

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

Ähnliche Fehler

Beim Aktivieren oder Deaktivieren des Geräts ist ein Fehler aufgetreten.

Unterstützte Werte:

alreadyInState

deviceTampered

passphraseIncorrect

pinIncorrect

securityRestriction

tooManyFailedAttempts

userCancelled

GERÄTEFEHLER

Eine vollständige Liste der Fehler und Ausnahmen