Esquema de característica do timer de casa inteligente

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

Por exemplo, um controlador de aspersor inteligente ou uma iluminação inteligente pode ter um cronômetro integrado. Essa característica pode ser usada para controlar um timer integrado dispositivos, como ao iniciar um novo timer, além de pausar e cancelar um timer em execução e perguntando quanto tempo resta.

ATRIBUTOS DO dispositivo

Dispositivos com essa característica podem relatar o seguinte atributos como parte da operação SYNC. Para saber mais sobre como lidar com intents SYNC, consulte Fulfillment da intent.

Atributos Tipo Descrição
maxTimerLimitSec Número inteiro

Obrigatório.

Indica a configuração do timer mais longo 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 de CONSULTA ou ao estado do relatório para essa característica.

Exemplos

Dispositivo com limite de timer de duas horas.

{
  "maxTimerLimitSec": 7200
}

STATES do dispositivo

Entidades com essa característica podem relatar o seguinte como parte da operação QUERY. Para saber mais sobre como lidar com intents QUERY, consulte Fulfillment da 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 não há um timer 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 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 ao seguinte como parte da operação EXECUTE. Para saber mais sobre como lidar com intents EXECUTE, consulte Fulfillment da 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 cinco minutos do dispositivo.

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

Ocorreu um erro ao iniciar o timer.

Valores compatíveis:

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 dentro de [-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 compatíveis:

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 compatíveis:

noTimerExists

action.devices.commands.TimerResume

Retomar 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 compatíveis:

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 timer.

Valores compatíveis:

noTimerExists

ERROS no dispositivo

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