Esquema de atributo de volume da casa inteligente

action.devices.traits.Volume: essa característica pertence a dispositivos que podem mudar o volume (por exemplo, definir o volume em um determinado nível, desativar ou ativar o som).

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
volumeMaxLevel Número inteiro

Obrigatório.

O nível máximo de volume, considerando um valor de referência de 0 (mudo). O Google Assistente vai ajustar os comandos adverbiais, por exemplo, "Aumentar o volume da TV".
volumeCanMuteAndUnmute Booleano

Obrigatório.

Indica se o dispositivo pode ativar e desativar o som. O comportamento "Desativar som" é uma opção separada, porque ele reduz o volume para 0, mas mantém o volume anterior, para que ele seja restaurado quando o som for ativado. Isso é refletido no estado do volume: se o volume for 5 e o usuário desativar o som, o volume permanecerá 5 e isMuted será verdadeiro.
volumeDefaultPercentage Número inteiro

Padrão: 40.

O volume (em porcentagem) do volume padrão definido pelo usuário ou pelo fabricante. A escala precisa estar entre 0 e 100.
levelStepSize Número inteiro

Padrão: 1.

O tamanho de etapa padrão para consultas de volume relativo, como "aumentar volume em <device_name>".
commandOnlyVolume Booleano

Padrão: false.

Indica se o dispositivo opera usando comunicação unidirecional (verdadeiro) ou bidirecional (falso). Por exemplo, se o controlador puder confirmar o novo estado do dispositivo após o envio da solicitação, esse campo será falso. Se não for possível confirmar se a solicitação foi executada ou para receber o estado do dispositivo (por exemplo, se o dispositivo for um controle remoto infravermelho tradicional), defina esse campo como "true".

Exemplos

Alto-falante que pode ser silenciado e informa o estado atual

{
  "volumeMaxLevel": 11,
  "volumeCanMuteAndUnmute": true,
  "levelStepSize": 2,
  "commandOnlyVolume": false,
  "volumeDefaultPercentage": 6
}

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
currentVolume Número inteiro

Obrigatório.

A porcentagem de volume atual. O valor precisa estar entre >0 e volumeMaxLevel.
isMuted Booleano

Obrigatório se o atributo volumeCanMuteAndUnmute estiver definido como verdadeiro. Verdadeiro se o dispositivo estiver silenciado. Caso contrário, é falso. Se isMuted for verdadeiro, o dispositivo ainda retornará currentVolume para o ponto lembrado.

Exemplos

Dispositivo de alto-falante que pode ser silenciado e informa o estado atual

{
  "currentVolume": 5,
  "isMuted": false
}

COMANDOS do dispositivo

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

action.devices.commands.mute

Desativa ou ativa o som do dispositivo.

Parâmetros

Parâmetros Tipo Descrição
mute Booleano

Obrigatório.

Se o dispositivo está com o som ativado ou desativado.

Exemplos

Desativar som do alto-falante

{
  "command": "action.devices.commands.mute",
  "params": {
    "mute": true
  }
}

action.devices.commands.setVolume

Define o volume para o nível solicitado com base em volumeMaxLevel.

Parâmetros

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

Obrigatório.

Novo volume, de 0 a volumeMaxLevel.

Exemplos

Definir o volume absoluto do alto-falante

{
  "command": "action.devices.commands.setVolume",
  "params": {
    "volumeLevel": 6
  }
}

action.devices.commands.volumeRelative

Aumentar ou diminuir o volume em n etapas, com base em volumeMaxLevel. No caso de comandos que usam uma escala relativa, o Google Assistente vai selecionar a opção n conforme as etapas disponíveis. Por exemplo, Aumentar muito o volume da TV definirá um número de etapas maior do que Aumentar o volume da TV um pouco mais.

Parâmetros

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

Obrigatório.

negativo para "diminuir".

Exemplos

Definir o volume relativo do alto-falante no modo de comando

{
  "command": "action.devices.commands.volumeRelative",
  "params": {
    "relativeSteps": -1
  }
}

ERROS no dispositivo

Confira a lista completa de erros e exceções.
  • volumeAlreadyMax: o dispositivo recebe o comando VolumeUp quando já está no volume mais alto.
  • volumeAlreadyMin: o dispositivo recebe o comando VolumeDown quando já está no volume mínimo.