Schemat cechy Smart Home ArmDisarm

action.devices.traits.ArmDisarm – ta cecha obsługuje uzbrajanie i rozbrajanie, które są używane np. w systemach zabezpieczeń.

W przypadku urządzeń o różnych poziomach zabezpieczeń należy je zgłaszać za pomocą atrybutu availableArmLevels.

Atrybuty urządzenia

Urządzenia z tą cechą mogą zgłaszać te atrybuty w ramach operacji SYNC. Więcej informacji o obsłudze SYNC intencji znajdziesz w artykule Realizacja intencji.

Atrybuty Typ Opis
availableArmLevels Obiekt

Opisuje obsługiwane poziomy zabezpieczeń urządzenia. Jeśli ten atrybut nie jest zgłaszany, urządzenie obsługuje tylko jeden poziom.

levels Tablica

Wymagany.

Lista dostępnych poziomów zabezpieczeń obsługiwanych przez urządzenie.

[item, ...] Obiekt

Poziom bezpieczeństwa.

level_name String

Wymagany.

Wewnętrzna nazwa poziomu bezpieczeństwa używana w poleceniach i stanach. Ta nazwa może być trudna do zrozumienia dla użytkowników i jest wspólna dla wszystkich języków.

level_values Tablica

Wymagany.

Zawiera level_synonymlang.

[item, ...] Obiekt

Synonim poziomu w danym języku. Aby zapewnić działanie awaryjne w przypadku języka, wymagany jest co najmniej 1 produkt z wartością lang równą en.

level_synonym Tablica

Wymagany.

Przyjazne dla użytkownika nazwy poziomu w każdym obsługiwanym języku. Pierwszy element jest traktowany jako nazwa kanoniczna.

[item, ...] String

Nazwa synonimu. Aby zapewnić działanie awaryjne w przypadku języka, wymagany jest co najmniej 1 produkt z wartością lang równą en.

lang String

Wymagany.

Kod języka dla synonimów poziomu. Zobacz obsługiwane języki.

ordered Wartość logiczna

Wymagany.

Jeśli ta wartość jest ustawiona na „true”, stosowana jest dodatkowa gramatyka dla logiki zwiększania/zmniejszania w kolejności tablicy poziomów. Na przykład „OK Google, zwiększ poziom bezpieczeństwa o 1” spowoduje, że Asystent określi bieżący poziom bezpieczeństwa, a następnie zwiększy go o 1. Jeśli ta wartość ma wartość „false”, dodatkowa gramatyka dla logiki wzrostu/spadku nie jest obsługiwana.

Przykłady

System alarmowy z 2 różnymi poziomami uzbrojenia

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

Stany urządzenia

Elementy z tym atrybutem mogą zgłaszać te stany w ramach operacji QUERY. Więcej informacji o obsłudze QUERY intencji znajdziesz w artykule Realizacja intencji.

Stany Typ Opis
isArmed Wartość logiczna

Wymagany.

Wskazuje, czy urządzenie jest obecnie uzbrojone.

currentArmLevel String

Wymagany.

Wymagany, jeśli określono atrybut availableArmLevels. Jeśli istnieje kilka poziomów zabezpieczeń, wskazuje nazwę bieżącego poziomu zabezpieczeń.

exitAllowance Liczba całkowita

Określa czas (w sekundach), jaki musi upłynąć, zanim użytkownik opuści urządzenie, aby funkcja currentArmLevel zaczęła działać.

Przykłady

System alarmowy, który zgłasza odrębny poziom uzbrojenia

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

Polecenia dotyczące urządzenia

Urządzenia z tą cechą mogą odpowiadać na te polecenia w ramach operacji EXECUTE. Więcej informacji o obsłudze EXECUTE intencji znajdziesz w artykule Realizacja intencji.

action.devices.commands.ArmDisarm

Ustaw poziom alarmu tego urządzenia.

Parametry

Ładunek zawiera jedną z tych wartości:

Anulowanie włączania lub wyłączania wykrywania

Parametry Typ Opis
followUpToken String

Token dostarczony przez Google do odpowiedzi uzupełniającej.

arm Wartość logiczna

Wymagany.

Wartość „true”, jeśli polecenie dotyczy uzbrojenia. Nie udało się wyłączyć alarmu.

cancel Wartość logiczna

Wymagany.

Wartość „true”, gdy polecenie ma anulować wartość arm.

Włączanie i wyłączanie urządzenia z opcjonalnym poziomem zabezpieczeń.

Parametry Typ Opis
followUpToken String

Token dostarczony przez Google do odpowiedzi uzupełniającej.

arm Wartość logiczna

Wymagany.

Wartość „true”, jeśli polecenie dotyczy uzbrojenia. Nie udało się wyłączyć alarmu.

armLevel String

level_name, w którym ma być włączony tryb.

Przykłady

Uzbrajanie systemu

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

Ustawianie systemu na poziom uzbrojenia L1

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

Anulowanie uzbrajania

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

Podczas uzbrajania lub rozbrajania urządzenia wystąpił błąd.

Obsługiwane wartości:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

BŁĘDY urządzenia

Zobacz pełną listę błędów i wyjątków.