Esquema de características do timer de casa inteligente

action.devices.traits.Timer: a característica de timer representa um timer em um dispositivo.

Por exemplo, um controle de sprinkler inteligente ou um interruptor de luz inteligente pode ter um timer integrado. Essa característica pode ser usada 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.
commandOnlyTimer	Booleano	Padrão: false. Indica se o dispositivo suporta o uso de comunicação unidirecional (verdadeiro) ou bidirecional (falso). Defina esse atributo como verdadeiro se o dispositivo não puder responder a uma intent QUERY ou a um estado de relatório para essa característica.

Exemplos

Dispositivo com limite de tempo de duas horas.

{
  "maxTimerLimitSec": 7200
}

STATES do dispositivo

Entidades com essa característica podem relatar os estados a seguir como parte da operação QUERY. Para saber mais sobre como processar intents QUERY, consulte fulfillment de intent.

Estados	Tipo	Descrição
timerRemainingSec	Número inteiro	Obrigatório. Tempo atual restante em segundos, -1 ou [0, maxTimerLimitSec]. Defina como -1 para indicar que nenhum timer está em execução.
timerPaused	Booleano	Verdadeiro se já houver um timer ativo, mas ele estiver pausado no momento.

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 cronômetro.

Parâmetros

Parâmetros	Tipo	Descrição
timerTimeSec	Número inteiro	Obrigatório. Duração do timer em segundos. Precisa estar dentro de [1, maxTimerLimitSec].

Exemplos

Execute o timer de 5 minutos no dispositivo.

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

Erros relacionados

Ocorreu um erro ao iniciar o timer.

Os valores suportados são:

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

Erros relacionados

Ocorreu um erro ao ajustar o timer.

Os valores suportados são:

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

Erros relacionados

Ocorreu um erro ao pausar o timer.

Os valores suportados são:

noTimerExists

action.devices.commands.TimerResume

Retomar o timer.

Parâmetros

Parâmetros	Tipo	Descrição
Não há propriedades

Exemplos

Retomar o timer do dispositivo.

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

Erros relacionados

Ocorreu um erro ao retomar o timer.

Os valores suportados são:

noTimerExists

action.devices.commands.TimerCancel

Cancele o timer.

Parâmetros

Parâmetros	Tipo	Descrição
Não há propriedades

Exemplos

Interrompa o timer do dispositivo.

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

Erros relacionados

Ocorreu um erro ao parar o timer.

Os valores suportados são:

noTimerExists

Dispositivo ERRORS

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