Esquema de atributos de volumen de casa inteligente

action.devices.traits.Volume: Este atributo pertenece a los dispositivos que pueden cambiar el volumen (por ejemplo, establecer el volumen en un nivel determinado, silenciarlo o activarlo).

ATRIBUTOS del dispositivo

Los dispositivos con esta característica pueden informar los siguientes atributos como parte de la operación SYNC. Para obtener más información sobre cómo controlar intents SYNC, consulta Cómo entregar intents.

Atributos Tipo Descripción
volumeMaxLevel Número entero

Obligatorio.

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

Obligatorio.

Indica si el dispositivo puede silenciar y activar el volumen. Silenciar es otra opción, ya que el comportamiento de "silenciar" lleva el volumen a 0 mientras se recuerda el volumen anterior, de modo que la activación del sonido lo restablece. 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)

Es el volumen (en porcentaje) del volumen predeterminado definido por el usuario o el fabricante. La escala debe ser de 0 a 100.
levelStepSize Número entero

(Predeterminado: 1)

Es el tamaño de paso predeterminado para las consultas de volumen relativo, como "sube el volumen de <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á falso. Si no es posible confirmar si la solicitud se ejecutó correctamente o 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 atributo pueden informar los siguientes estados como parte de la operación QUERY. Para obtener más información sobre cómo controlar los intents 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.
isMuted Booleano

Obligatorio si el atributo volumeCanMuteAndUnmute se configura como verdadero. Es verdadero si el dispositivo está silenciado; de lo contrario, es falso. Si isMuted es verdadero, el dispositivo aún muestra 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 esta característica pueden responder a los siguientes comandos como parte de la operación EXECUTE. Para obtener más información sobre cómo controlar intents EXECUTE, consulta Cómo entregar intents.

action.devices.commands.mute

Silencia o activa el dispositivo.

Parámetros

Parámetros Tipo Descripción
mute Booleano

Obligatorio.

Si quieres silenciar o dejar de silenciar un dispositivo.

Ejemplos

Cómo 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.

Nuevo volumen, de 0 a volumeMaxLevel

Ejemplos

Cómo establecer el volumen absoluto del dispositivo de bocina

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

action.devices.commands.volumeRelative

Sube o baja el volumen en n pasos, según volumeMaxLevel. En el caso de los comandos que usan una escala relativa, el Asistente seleccionará n de forma adecuada para escalar a los pasos disponibles. Por ejemplo, Hacer que la TV sea mucho más alta establecerá una cantidad mayor de pasos que Hacer que la TV sea un poco más alta.

Parámetros

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

Obligatorio.

negativo para "disminuir".

Ejemplos

Cómo establecer el volumen relativo del dispositivo de bocina en modo de solo 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.