Esquema del rasgo de volumen de casa inteligente

action.devices.traits.Volume: Este rasgo pertenece a los dispositivos que pueden cambiar el volumen (por ejemplo, establecer el volumen en un nivel determinado, silenciar o reactivar el sonido).

Atributos del dispositivo

Los dispositivos con este rasgo pueden informar los siguientes atributos como parte de la operación SYNC. Para obtener más información sobre cómo controlar intents de SYNC, consulta Entrega de intents.

Atributos Tipo Descripción
volumeMaxLevel Número entero

Obligatorio.

Es el nivel de volumen máximo, suponiendo un valor de referencia de 0 (silencio). El Asistente ajustará los comandos adverbiales (p.ej., "sube un poco el volumen de la TV") según corresponda.
volumeCanMuteAndUnmute Booleano

Obligatorio.

Indica si el dispositivo puede silenciar y reactivar el volumen. Silenciar es una opción independiente, ya que el comportamiento de "silenciar" lleva el volumen a 0 y recuerda el volumen anterior para que la opción de reactivar el audio lo restablezca. Esto se refleja en el estado del volumen: si el volumen es 5 y el usuario lo silencia, el volumen permanece en 5 y isMuted es verdadero.
volumeDefaultPercentage Número entero

(predeterminado: 40)

Volumen (en porcentaje) del volumen predeterminado definido por el usuario o el fabricante. La escala debe ser de 0 a 100.

El valor debe estar entre 0 y 100.
levelStepSize Número entero

(predeterminado: 1)

Tamaño de paso predeterminado para las búsquedas de volumen relativo, como "subir volumen en <device_name>".
commandOnlyVolume Booleano

(predeterminado: false)

Indica si el dispositivo funciona con comunicación unidireccional (verdadero) o bidireccional (falso). Por ejemplo, si el controlador puede confirmar el nuevo estado del dispositivo después de enviar la solicitud, este campo sería falso. Si no es posible confirmar si la solicitud se ejecutó correctamente o si no se puede obtener el estado del dispositivo (por ejemplo, si el dispositivo es un control remoto infrarrojo tradicional), establece este campo como verdadero.

Ejemplos

Dispositivo de bocina que se puede silenciar y que informa el estado actual

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

ESTADOS del dispositivo

Las entidades con este rasgo pueden informar los siguientes estados como parte de la operación QUERY. Para obtener más información sobre cómo controlar intents de QUERY, consulta Entrega de intents.

Estados Tipo Descripción
currentVolume Número entero

Obligatorio.

Es el porcentaje de volumen actual. Debe estar entre >0 y volumeMaxLevel.

Valor mínimo: 0.
isMuted Booleano

Obligatorio si el atributo volumeCanMuteAndUnmute se establece como verdadero. Es verdadero si el dispositivo está silenciado; de lo contrario, es falso. Si isMuted es verdadero, el dispositivo aún devuelve currentVolume para el punto recordado.

Ejemplos

Dispositivo de bocina que se puede silenciar y que informa el estado actual

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

COMANDOS del dispositivo

Los dispositivos con este rasgo pueden responder a los siguientes comandos como parte de la operación EXECUTE. Para obtener más información sobre cómo controlar intents de EXECUTE, consulta Entrega de intents.

action.devices.commands.mute

Silencia o activa el sonido del dispositivo.

Parámetros

Parámetros Tipo Descripción
mute Booleano

Obligatorio.

Indica si se debe silenciar o activar el sonido de un dispositivo.

Ejemplos

Silenciar el dispositivo de bocina

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

action.devices.commands.setVolume

Establece el volumen en el nivel solicitado, según volumeMaxLevel.

Parámetros

Parámetros Tipo Descripción
volumeLevel Número entero

Obligatorio.

Volumen nuevo, de 0 a volumeMaxLevel.

Valor mínimo: 0.

Ejemplos

Establece el volumen absoluto del dispositivo de bocina

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

action.devices.commands.volumeRelative

Establece el volumen en n pasos hacia arriba o hacia abajo, según volumeMaxLevel. En el caso de los comandos que usan una escala relativa, Asistente seleccionará n de forma adecuada para ajustarse a los pasos disponibles. Por ejemplo, Sube mucho el volumen de la TV establecerá una mayor cantidad de pasos que Sube un poco el volumen de la TV.

Parámetros

Parámetros Tipo Descripción
relativeSteps Número entero

Obligatorio.

negativo para "disminuir".

Ejemplos

Establece el volumen relativo del dispositivo de bocina en el modo solo de comandos

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

ERRORES del dispositivo

Consulta la lista completa de errores y excepciones.
  • volumeAlreadyMax: El dispositivo recibe el comando VolumeUp cuando ya está en el volumen más alto.
  • volumeAlreadyMin: El dispositivo recibe el comando VolumeDown cuando ya está en el volumen más bajo.