Esquema de característica do timer de casa inteligente

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

Por exemplo, um controlador de aspersor inteligente ou um interruptor de iluminação inteligente pode ter um timer integrado. Essa característica pode ser usada para controlar um timer integrado em dispositivos, como ao iniciar um novo timer, bem como 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 o processamento de intents SYNC, consulte Fulfillment de intents.

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 oferece suporte a comunicação unidirecional (verdadeiro) ou bidirecional (falso). Defina esse atributo como verdadeiro se o dispositivo não puder responder a uma intent de QUERY ou ao estado de relatório dessa característica.

Exemplos

Dispositivo com limite de timer de duas horas.

{
  "maxTimerLimitSec": 7200
}

STATES do dispositivo

As entidades com essa característica podem informar os seguintes estados como parte da operação QUERY. Para saber mais sobre o processamento de intents QUERY, consulte Fulfillment 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 um timer ativo existir, mas estiver pausado no momento.

Exemplos

Quanto tempo falta no timer do dispositivo? (não 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 comandos a seguir como parte da operação EXECUTE. Para saber mais sobre o processamento de intents EXECUTE, consulte Fulfillment de intents.

action.devices.commands.TimerStart

Inicie um novo cronômetro.

Parâmetros

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

Obrigatório.

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

Exemplos

Execute o timer de cinco minutos do dispositivo.

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

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

Valores aceitos:

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

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

Valores aceitos:

noTimerExists

ERROS no dispositivo

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