Smart-Home-Timer-Trait-Schema

action.devices.traits.Timer : Das Timer-Trait stellt einen Timer auf einem Gerät dar.

Beispielsweise kann ein intelligenter Sprinklercontroller oder ein intelligenter Licht schalter einen integrierten Timer haben. Mit diesem Trait kann ein integrierter Timer auf Geräten gesteuert werden, z. B. ein neuer Timer gestartet, ein laufender Timer pausiert und abgebrochen werden. Außerdem kann gefragt werden, wie viel Zeit noch verbleibt.

Geräteattribute

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

Attribute Typ Beschreibung
maxTimerLimitSec Ganzzahl

Erforderlich.

Gibt die längste Timer-Einstellung an, die auf dem Gerät verfügbar ist, gemessen in Sekunden.

Mindestwert: 1.
commandOnlyTimer Boolesch

(Standardeinstellung: false)

Gibt an, ob das Gerät die unidirektionale (true) oder bidirektionale (false) Kommunikation unterstützt. Setzen Sie dieses Attribut auf „true“, wenn das Gerät nicht auf einen QUERY-Intent oder Report State für dieses Trait antworten kann.

Beispiele

Gerät mit einem Timer-Limit von zwei Stunden

{
  "maxTimerLimitSec": 7200
}

Gerätestatus

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

Status Typ Beschreibung
timerRemainingSec Ganzzahl

Erforderlich.

Aktuelle verbleibende Zeit in Sekunden, -1 oder [0, maxTimerLimitSec]. Auf -1 setzen, wenn kein Timer läuft.
timerPaused Boolesch

„True“, wenn ein aktiver Timer vorhanden ist, der aber gerade pausiert ist.

Beispiele

Wie viel Zeit ist noch auf dem Gerätetimer übrig? (läuft nicht).

{
  "timerRemainingSec": -1
}

Wie viel Zeit ist noch auf dem Gerätetimer übrig? (läuft).

{
  "timerRemainingSec": 60
}

Wie viel Zeit ist noch auf dem Gerätetimer übrig? (pausiert).

{
  "timerRemainingSec": 30,
  "timerPaused": true
}

Gerätebefehle

Geräte mit diesem Trait können im Rahmen des EXECUTE-Vorgangs auf die folgenden Befehle antworten. Weitere Informationen zur Verarbeitung von EXECUTE Intents finden Sie unter Intent-Erfüllung.

action.devices.commands.TimerStart

Neuen Timer starten.

Parameter

Parameter Typ Beschreibung
timerTimeSec Ganzzahl

Erforderlich.

Dauer des Timers in Sekunden; muss zwischen [1, maxTimerLimitSec] liegen.

Mindestwert: 1.

Beispiele

Gerätetimer fünf Minuten lang laufen lassen

{
  "command": "action.devices.commands.TimerStart",
  "params": {
    "timerTimeSec": 300
  }
}

Beim Starten des Timers ist ein Fehler aufgetreten.

Unterstützte Werte:

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerAdjust

Timer-Dauer anpassen.

Parameter

Parameter Typ Beschreibung
timerTimeSec Ganzzahl

Erforderlich.

Positive oder negative Anpassung des Timers in Sekunden; muss zwischen [-maxTimerLimitSec, maxTimerLimitSec] liegen.

Beispiele

Gerätetimer um eine Minute verlängern

{
  "command": "action.devices.commands.TimerAdjust",
  "params": {
    "timerTimeSec": 60
  }
}

30 Sekunden vom Gerätetimer abziehen

{
  "command": "action.devices.commands.TimerAdjust",
  "params": {
    "timerTimeSec": -30
  }
}

Beim Anpassen des Timers ist ein Fehler aufgetreten.

Unterstützte Werte:

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerPause

Timer pausieren.

Parameter

Parameter Typ Beschreibung

Keine Attribute

Beispiele

Gerätetimer pausieren

{
  "command": "action.devices.commands.TimerPause",
  "params": {}
}

Beim Pausieren des Timers ist ein Fehler aufgetreten.

Unterstützte Werte:

noTimerExists

action.devices.commands.TimerResume

Timer fortsetzen.

Parameter

Parameter Typ Beschreibung

Keine Attribute

Beispiele

Gerätetimer fortsetzen

{
  "command": "action.devices.commands.TimerResume",
  "params": {}
}

Beim Fortsetzen des Timers ist ein Fehler aufgetreten.

Unterstützte Werte:

noTimerExists

action.devices.commands.TimerCancel

Timer abbrechen.

Parameter

Parameter Typ Beschreibung

Keine Attribute

Beispiele

Gerätetimer anhalten

{
  "command": "action.devices.commands.TimerCancel",
  "params": {}
}

Beim Anhalten des Timers ist ein Fehler aufgetreten.

Unterstützte Werte:

noTimerExists

Gerätefehler

Vollständige Liste der Fehler und Ausnahmen ansehen