Schéma de trait de minuteur pour la maison connectée

action.devices.traits.Timer : le trait "Minuteur" représente un minuteur sur un appareil.

Par exemple, un programmateur d'arrosage ou un interrupteur d'éclairage connecté peuvent être équipés d'un minuteur intégré. Ce trait peut être utilisé pour contrôler un minuteur intégré sur les appareils, par exemple pour démarrer un nouveau minuteur, mettre en pause et annuler un minuteur en cours, et demander le temps restant.

ATTRIBUTS de l'appareil

Les appareils dotés de ce trait peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Fulfillment d'intent.

Attributs Type Description
maxTimerLimitSec Entier

Obligatoire.

Indique le paramètre de minuteur le plus long disponible sur l'appareil, en secondes.

Valeur minimale : 1.
commandOnlyTimer Valeur booléenne

(Par défaut : false)

Indique si l'appareil est compatible avec la communication unidirectionnelle (true) ou bidirectionnelle (false). Définissez cet attribut sur "true" si l'appareil ne peut pas répondre à une intention QUERY ni à un rapport d'état pour cette caractéristique.

Exemples

Appareil avec une limite de minuteur de deux heures.

{
  "maxTimerLimitSec": 7200
}

ÉTATS des appareils

Les entités dotées de ce trait peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez Fulfillment d'intent.

États Type Description
timerRemainingSec Entier

Obligatoire.

Temps restant actuel en secondes, -1 ou [0, maxTimerLimitSec]. Définissez la valeur sur -1 pour indiquer qu'aucun minuteur n'est en cours d'exécution.
timerPaused Valeur booléenne

"True" si un minuteur actif existe, mais qu'il est actuellement suspendu.

Exemples

Combien de temps reste-t-il sur le minuteur de l'appareil ? (non exécuté).

{
  "timerRemainingSec": -1
}

Combien de temps reste-t-il sur le minuteur de l'appareil ? (en cours d'exécution).

{
  "timerRemainingSec": 60
}

Combien de temps reste-t-il sur le minuteur de l'appareil ? (suspendu).

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

COMMANDES de l'appareil

Les appareils dotés de ce trait peuvent répondre aux commandes suivantes dans le cadre de l'opération EXECUTE. Pour en savoir plus sur la gestion des intents EXECUTE, consultez Fulfillment d'intent.

action.devices.commands.TimerStart

Démarre un nouveau minuteur.

Paramètres

Paramètres Type Description
timerTimeSec Entier

Obligatoire.

Durée du minuteur en secondes. Elle doit être comprise entre 1 et maxTimerLimitSec.

Valeur minimale : 1.

Exemples

Règle le minuteur de l'appareil sur cinq minutes.

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

Une erreur s'est produite lors du démarrage du minuteur.

Valeurs acceptées :

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerAdjust

Ajustez la durée du minuteur.

Paramètres

Paramètres Type Description
timerTimeSec Entier

Obligatoire.

Ajustement positif ou négatif du minuteur en secondes. Doit être compris entre [-maxTimerLimitSec, maxTimerLimitSec].

Exemples

Ajoute une minute au minuteur de l'appareil.

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

Soustrait 30 secondes au minuteur de l'appareil.

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

Une erreur s'est produite lors du réglage du minuteur.

Valeurs acceptées :

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerPause

Mets en pause le minuteur.

Paramètres

Paramètres Type Description

Aucune propriété

Exemples

Mettez en pause le minuteur de l'appareil.

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

Une erreur s'est produite lors de la mise en pause du minuteur.

Valeurs acceptées :

noTimerExists

action.devices.commands.TimerResume

Relance le minuteur.

Paramètres

Paramètres Type Description

Aucune propriété

Exemples

Relancez le minuteur de l'appareil.

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

Une erreur s'est produite lors de la reprise du minuteur.

Valeurs acceptées :

noTimerExists

action.devices.commands.TimerCancel

Annule le minuteur.

Paramètres

Paramètres Type Description

Aucune propriété

Exemples

Arrête le minuteur de l'appareil.

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

Une erreur s'est produite lors de l'arrêt du minuteur.

Valeurs acceptées :

noTimerExists

ERREURS liées à l'appareil

Consultez la liste complète des erreurs et exceptions.