Esquema de traço de timer de casa inteligente

action.devices.traits.Timer: o traço "Timer" representa um timer em um dispositivo.

Por exemplo, um controlador de irrigação inteligente ou um interruptor de iluminação inteligente podem ter um timer integrado. Esse recurso pode ser usado para controlar um timer integrado em dispositivos, como iniciar um novo timer, pausar e cancelar um timer em execução e perguntar quanto tempo resta.

ATRIBUTOS do dispositivo

Dispositivos com essa característica podem informar os seguintes atributos como parte da operação SYNC. Para saber mais sobre como processar intents SYNC, consulte Fulfillment de intent.

Atributos Tipo Descrição
maxTimerLimitSec Número inteiro

Obrigatório.

Indica a configuração de timer mais longa disponível no dispositivo, medida em segundos.

Valor mínimo: 1.
commandOnlyTimer Booleano

Padrão: false.

Indica se o dispositivo é compatível com comunicação unidirecional (true) ou bidirecional (false). Defina esse atributo como "true" se o dispositivo não puder responder a uma intent QUERY ou Report State para essa característica.

Exemplos

Dispositivo com limite de timer de duas horas.

{
  "maxTimerLimitSec": 7200
}

ESTADOS DO DISPOSITIVO

Entidades com essa característica podem informar os seguintes estados como parte da operação QUERY. Para saber mais sobre como processar intents QUERY, consulte Execução de intents.

Estados Tipo Descrição
timerRemainingSec Número inteiro

Obrigatório.

Tempo restante atual em segundos, -1 ou [0, maxTimerLimitSec]. Defina como -1 para indicar que nenhum timer está em execução.
timerPaused Booleano

Verdadeiro se houver um timer ativo, mas ele estiver pausado.

Exemplos

Quanto tempo falta no timer do dispositivo? (não está em execução).

{
  "timerRemainingSec": -1
}

Quanto tempo falta no timer do dispositivo? (em execução).

{
  "timerRemainingSec": 60
}

Quanto tempo falta no timer do dispositivo? (pausado).

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

COMANDOS do dispositivo

Dispositivos com essa característica podem responder aos seguintes comandos como parte da operação EXECUTE. Para saber mais sobre como processar intents EXECUTE, consulte Fulfillment de intent.

action.devices.commands.TimerStart

Inicie um novo timer.

Parâmetros

Parâmetros Tipo Descrição
timerTimeSec Número inteiro

Obrigatório.

Duração do timer em segundos. Precisa estar entre [1, maxTimerLimitSec].

Valor mínimo: 1.

Exemplos

Execute o timer do dispositivo por cinco minutos.

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

Ocorreu um erro ao iniciar o timer.

Valores aceitos:

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerAdjust

Ajuste a duração do timer.

Parâmetros

Parâmetros Tipo Descrição
timerTimeSec Número inteiro

Obrigatório.

Ajuste positivo ou negativo do timer em segundos. Precisa estar entre [-maxTimerLimitSec, maxTimerLimitSec].

Exemplos

Adicione um minuto ao timer do dispositivo.

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

Subtrai 30 segundos do timer do dispositivo.

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

Ocorreu um erro ao ajustar o timer.

Valores aceitos:

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerPause

Pausar o timer.

Parâmetros

Parâmetros Tipo Descrição

Não há propriedades

Exemplos

Pause o timer do dispositivo.

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

Ocorreu um erro ao pausar o timer.

Valores aceitos:

noTimerExists

action.devices.commands.TimerResume

Retome o timer.

Parâmetros

Parâmetros Tipo Descrição

Não há propriedades

Exemplos

Retome o timer do dispositivo.

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

Ocorreu um erro ao retomar o timer.

Valores aceitos:

noTimerExists

action.devices.commands.TimerCancel

Cancele o timer.

Parâmetros

Parâmetros Tipo Descrição

Não há propriedades

Exemplos

Pare o timer do dispositivo.

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

Ocorreu um erro ao interromper o timer.

Valores aceitos:

noTimerExists

ERROS do dispositivo

Confira a lista completa de erros e exceções.