Esquema de volume de casa inteligente

action.devices.traits.Volume: esta característica pertence a dispositivos que podem alterar o volume (por exemplo, configurar o volume para um nível, desativar ou ativar o som).

ATRIBUTOS do dispositivo

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

Atributos	Tipo	Descrição
volumeMaxLevel	Número inteiro	Obrigatório. O nível de volume máximo, supondo um valor de referência de 0 (desativar som). O Assistente ajustará os comandos adverbiais (por exemplo, "deixe a TV um pouco mais alta") de acordo com isso.
volumeCanMuteAndUnmute	Booleano	Obrigatório. Indica se o dispositivo pode ativar ou desativar o volume. "Desativar som" é uma opção separada, já que o comportamento "Mudo" leva o volume a 0 enquanto o volume anterior é lembrado. Assim, a ativação do som é restaurada. Isso é refletido no estado de 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) para o volume padrão definido pelo usuário ou pelo fabricante. A escala precisa ser de 0 a 100.
levelStepSize	Número inteiro	Padrão: 1. O tamanho de etapa padrão para consultas de volume relativo, como "aumentar volume em <nome_do_dispositivo>".
commandOnlyVolume	Booleano	Padrão: false. Indica se o dispositivo opera usando comunicação unidirecional (verdadeira) ou bidirecional (falso). Por exemplo, se o controlador puder confirmar o novo estado do dispositivo depois de enviar a solicitação, esse campo será falso. Se não for possível confirmar se a solicitação foi executada corretamente ou se o estado do dispositivo (por exemplo, se o dispositivo é um controle remoto infravermelho tradicional), defina esse campo como "true".

Exemplos

Dispositivo com alto-falante que pode ser silenciado e que 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 estados a seguir como parte da operação QUERY. Para saber mais sobre como lidar com intents QUERY, consulte fulfillment de intent.

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 com o som desativado. Caso contrário, será falso. Se isMuted for verdadeiro, o dispositivo ainda vai retornar currentVolume para o ponto lembrado.

Exemplos

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

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

Dispositivo COMMANDS

Os dispositivos com essa característica podem responder aos comandos a seguir como parte da operação EXECUTE. Para saber mais sobre como lidar com intents EXECUTE, consulte fulfillment de intent.

action.devices.commands.mute

Ativa ou desativa o som do dispositivo.

Parâmetros

Parâmetros	Tipo	Descrição
mute	Booleano	Obrigatório. Ativar ou desativar o som de um dispositivo.

Exemplos

Desativar o som do alto-falante

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

action.devices.commands.setVolume

Definir 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 de n passos, com base em volumeMaxLevel. Para comandos que usam uma escala relativa, o Assistente selecionará n para se ajustar às etapas disponíveis. Por exemplo, Aumentar a TV define um número maior de etapas do que Aumentar o volume da TV.

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 somente comando

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

Dispositivo ERRORS

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

• volumeAlreadyMax: o dispositivo recebe o comando VolumeUp quando já está no volume máximo.
• volumeAlreadyMin: o dispositivo recebe o comando VolumeDown quando já está no volume mínimo.