Схема характеристик громкости умного дома

action.devices.traits.Volume — Этот трейт относится к устройствам, способным изменять громкость (например, устанавливать громкость на определенный уровень, отключать или включать звук).

АТРИБУТЫ УСТРОЙСТВА

Устройства с этой особенностью могут сообщать следующие атрибуты в рамках операции SYNC . Для получения дополнительной информации об обработке намерений SYNC см. раздел «Выполнение намерений» .

Атрибуты Тип Описание
volumeMaxLevel Целое число

Необходимый.

Максимальный уровень громкости, при условии, что базовый уровень равен 0 (отключение звука). Ассистент будет соответствующим образом корректировать наречные команды (например, «сделайте телевизор немного громче»).

volumeCanMuteAndUnmute Логический

Необходимый.

Указывает, может ли устройство отключать и включать звук. Отключение звука — это отдельная опция, поскольку поведение «отключения звука» обнуляет громкость, запоминая при этом предыдущее значение, так что включение звука восстанавливает его. Это отражается на состоянии громкости — если громкость равна 5, и пользователь отключает звук, громкость остается равной 5, и isMuted имеет значение true.

volumeDefaultPercentage Целое число

(По умолчанию: 40 )

Объём (в процентах) для заданного пользователем или производителем объёма по умолчанию. Шкала должна быть от 0 до 100.

Значение должно быть в диапазоне от 0 до 100 .

levelStepSize Целое число

(По умолчанию: 1 )

Шаг по умолчанию для запросов относительной громкости, например, 'увеличение громкости на <имя_устройства>'.

commandOnlyVolume Логический

(По умолчанию: false )

Указывает, работает ли устройство в одностороннем (истина) или двустороннем (ложь) режиме связи. Например, если контроллер может подтвердить новое состояние устройства после отправки запроса, это поле будет иметь значение «ложь». Если невозможно подтвердить успешное выполнение запроса или получить состояние устройства (например, если устройство представляет собой традиционный инфракрасный пульт дистанционного управления), установите это поле в значение «истина».

Примеры

Устройство громкой связи, которое можно отключить и которое сообщает о текущем состоянии.

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

СОСТОЯНИЯ УСТРОЙСТВА

Сущности с этим свойством могут сообщать о следующих состояниях в рамках операции QUERY . Для получения дополнительной информации об обработке намерений QUERY см. раздел «Выполнение намерений» .

Штаты Тип Описание
currentVolume Целое число

Необходимый.

Текущий процент объема. Он должен находиться в диапазоне от >0 до volumeMaxLevel .

Минимальное значение: 0 .

isMuted Логический

Обязателен, если атрибут volumeCanMuteAndUnmute имеет значение true. True, если звук устройства отключен; false в противном случае. Если isMuted имеет значение true, устройство все равно возвращает currentVolume для запомненной точки.

Примеры

Устройство громкой связи, которое можно отключить и которое сообщает о текущем состоянии.

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

КОМАНДЫ УСТРОЙСТВА

Устройства с этой особенностью могут реагировать на следующие команды в рамках операции EXECUTE . Для получения дополнительной информации об обработке намерений EXECUTE см. раздел «Выполнение намерений» .

action.devices.commands.mute

Включает или выключает звук на устройстве.

Параметры

Параметры Тип Описание
mute Логический

Необходимый.

Выбрать, включить или выключить звук на устройстве.

Примеры

Отключение звука динамика

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

action.devices.commands.setVolume

Установите уровень громкости на требуемый, исходя из volumeMaxLevel .

Параметры

Параметры Тип Описание
volumeLevel Целое число

Необходимый.

Новый уровень громкости, от 0 до volumeMaxLevel .

Минимальное значение: 0 .

Примеры

Установите абсолютную громкость динамика.

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

action.devices.commands.volumeRelative

Установите уровень громкости на n шагов вверх или вниз в зависимости от volumeMaxLevel . Для команд, использующих относительную шкалу, Ассистент выберет n соответствующим образом, чтобы масштабировать значение в соответствии с доступными шагами. Например, команда «Сделать телевизор намного громче» установит большее количество шагов, чем команда «Сделать телевизор чуть громче» .

Параметры

Параметры Тип Описание
relativeSteps Целое число

Необходимый.

отрицательный знак для слова «снижение».

Примеры

Установите относительную громкость динамика в режиме управления.

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

ОШИБКИ устройства

См. полный список ошибок и исключений .
  • volumeAlreadyMax : Устройство получает команду VolumeUp когда оно уже находится на максимальной громкости.
  • volumeAlreadyMin : Устройство получает команду VolumeDown , когда уровень громкости уже установлен на минимум.