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

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

АТРИБУТЫ устройства

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

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

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

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

volumeCanMuteAndUnmute логическое значение

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

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

volumeDefaultPercentage Целое число

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

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

levelStepSize Целое число

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

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

commandOnlyVolume логическое значение

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

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

Примеры

Динамик, который можно отключить и сообщает о текущем состоянии

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

СОСТОЯНИЯ устройства

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

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

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

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

isMuted логическое значение

Требуется, если для атрибута volumeCanMuteAndUnmute установлено значение true. True, если на устройстве отключен звук; ложь в противном случае. Если 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 .

Примеры

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

{
  "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 , когда оно уже находится на минимальном уровне громкости.