Schema für Smart-Home-Verzweigung

action.devices.traits.ArmDisarm: Diese Eigenschaft unterstützt das Scharf- und Unscharfschalten, z. B. in Sicherheitssystemen.

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

Hinweis:Für diese Eigenschaft solltest du die sekundäre Nutzerbestätigung verwenden.

Geräte-ATTRIBUTE

Geräte mit diesem Merkmal können im Rahmen des SYNC-Vorgangs die folgenden Attribute melden. Weitere Informationen zum Verarbeiten von SYNC-Intents finden Sie unter Intent-Auftragsausführung.

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	Sicherheitsstufe
level_name	String	Erforderlich. Der interne Name der Sicherheitsstufe, die in Befehlen und Status verwendet wird. Dieser Name kann nicht nutzerfreundlich und für alle Sprachen verwendet werden.
level_values	Array	Erforderlich. Enthält level_synonym und lang.
[item, ...]	Objekt	Synonym für eine bestimmte Sprache.
level_synonym	Array	Erforderlich. Nutzerfreundliche Namen für die Ebene in jeder unterstützten Sprache. Das erste Element wird als kanonischer Name behandelt.
[item, ...]	String	Synonym name.
lang	String	Erforderlich. Sprachcode für die Synonyme. Weitere Informationen finden Sie unter Unterstützte Sprachen.
ordered	Boolesch	Erforderlich. Wenn „true“ festgelegt ist, wird eine zusätzliche Grammatik für die Logik zur Erhöhung/Abnahme angewendet, und zwar in der Reihenfolge des Arrays „levels“. 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 zur Erhöhung/Abnahme unterstützt.

Beispiele

Sicherheitssystem mit zwei unterschiedlichen Scharfstufen

{
  "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 Merkmal können im Rahmen des QUERY-Vorgangs die folgenden Status melden: Weitere Informationen zum Verarbeiten von QUERY-Intents finden Sie unter Intent-Auftragsausführung.

Bundesstaaten	Typ	Beschreibung
isArmed	Boolesch	Erforderlich. Zeigt an, ob das Gerät derzeit scharf geschaltet ist.
currentArmLevel	String	Erforderlich. Erforderlich, wenn das Attribut availableArmLevels angegeben ist. Gibt es mehrere Sicherheitsebenen, wird der Name der aktuellen Sicherheitsebene angegeben.
exitAllowance	Ganzzahl	Gibt die Zeit in Sekunden an, die der Nutzer verlassen muss, bevor currentArmLevel wirksam wird.

Beispiele

Sicherheitssystem, das bestimmte Scharfstufen meldet

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

BEISPIELE für Geräte

Hinweis: Diese Eigenschaft unterstützt das Hinzufügen eines zusätzlichen Status mit einer sekundären Identitätsbestätigung für Nutzer. Weitere Informationen finden Sie unter Unterstützte Identitätstypen.

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

action.devices.commands.ArmDisarm

Stell den Wecker dieses Geräts.

Parameter

Die Nutzlast enthält eine der folgenden Optionen:

Scharf- oder Scharfschaltung abbrechen

Parameter	Typ	Beschreibung
followUpToken	String	Von Google bereitgestelltes Token für die Folgeantwort.
arm	Boolesch	Erforderlich. True, wenn der Befehl scharf geschaltet wird. Falsch, unscharf zu schalten.
cancel	Boolesch	Erforderlich. „True“, wenn der Befehl den Wert arm abbrechen soll.

Aktivieren oder deaktivieren Sie das Gerät mit einem optionalen Sicherheitsniveau.

Parameter	Typ	Beschreibung
followUpToken	String	Von Google bereitgestelltes Token für die Folgeantwort.
arm	Boolesch	Erforderlich. True, wenn der Befehl scharf geschaltet wird. Falsch, unscharf zu schalten.
armLevel	String	level_name zum Scharfschalten.

Beispiele

Schalte das System ein.

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

System auf Stufe 1 scharf schalten

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

Scharfschaltung abbrechen

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

Weitere Informationen

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

Unterstützte Werte:

alreadyInState

deviceTampered

passphraseIncorrect

pinIncorrect

securityRestriction

tooManyFailedAttempts

userCancelled

Gerät ERRORS

Hier finden Sie die vollständige Liste der Fehler und Ausnahmen.