Описание метрик и команд
Метрики
Модуль реализует классическую концепцию MajorDoMo для взаимодействия с пользователем через метрики и привязанные к ним свойства и/или методы объекта. Объекты, свойства и методы создаются пользователем самостоятельно. Имеется возможность привязки Простых устройств на перспективу, если появится новый тип ПУ "Смарт ТВ".
| Метрика | Описание | Значения | Чтение/запись |
|---|---|---|---|
| online | Доступность ТВ (онлайн/оффлайн). | 1 и 0 | Чтение |
| command | Отправка команды на ТВ (см. раздел Команды). | Команда | Запись |
| command_raw | Отправка "сырой" API-команды на ТВ без обработки модулем. Например, ssap://system/getSystemInfo и т. п. | api-команда | Запись |
| notification | Вывод текстового уведомления на экран ТВ. | Текст уведомления | Запись |
| power | Текущий статус и управление питанием ТВ. | 1 и 0 | Чтение и запись |
| volume | Текущий уровень и управление громкостью ТВ. | От 1 до 100% | Чтение и запись |
| muted | Текущий статус и управление режимом "без звука" (включить, выключить) | 1 и 0 | Чтение и запись |
| state | Текущее состояние ТВ и его переключение. Базовая метрика, определяющая текущее запущенное приложение или выбранный источник (вход). Содержит идентификатор приложения или источника в соответствии с API webOS (см. вкладку "Приложения/источники"). Например, com.webos.app.hdmi1 и т. п. | ID | Чтение и запись |
| state_title | Название текущего приложения (источника). | Название приложения | Чтение |
| state_icon | Ссылка на иконку текущего приложения (источника). | URL | Чтение |
| channel_number | Номер текущего канала и переключение каналов по их номеру. | Номер канала | Чтение и запись |
| channel_name | Название текущего канала и переключение каналов по их названию. | Название канала | Чтение и запись |
| channel_id | Уникальный внутренний идентификатор текущего канала и переключение каналов по этому идентификатору. Например, 1_36_11_11_11_2010_8835 и т. п. | ID канала | Чтение и запись |
| channel_icon | Ссылка на иконку (логотип) текущего канала (доступно не для всех моделей ТВ). | URL | Чтение |
| channels_count | Общее количество каналов для всех режимов работы тюнера. | Количество каналов | Чтение |
| channel_type | Текущий режим работы тюнера ТВ (наземное аналоговое, наземное цифровое, кабельное аналоговое, кабельное цифровое и спутниковое ТВ-вещания, а также аналогичные для радиовещания при их наличии). | Terrestrial Analog TV, Terrestrial Digital TV, Cable Analog TV, Cable Digital TV, Satellite Digital TV, Terrestrial Analog Radio, Terrestrial Digital Radio |
Чтение и запись |
| program_title | Название текущей передачи на канале. | Название передачи | Чтение |
| program_description | Описание текущей передачи. | Описание передачи | Чтение |
| error | Сведения о последней возникшей ошибке. | Текст ошибки | Чтение |
Например, запуск приложений и выбор источника (входа) выполняется с помощью метрики state и привязанного к ней свойства объекта путем записи в это свойство идентификатора (ID) приложения (источника) через функцию setGlobal() или иным способом.
Пример:
|
1 2 3 4 5 |
setGlobal('TV1.state', 'com.webos.app.livetv'); // Или sg('TV1.state', 'youtube.leanback.v4'); // Запуск ролика на Youtube sg('TV1.state', 'youtube.leanback.v4|youtu.be/3TeU9K8z9XA'); |
При запуске через метрику state приложений Youtube и Browser можно указывать ссылку на видео или сайт, которые будут открыты после запуска приложения. URL указывается как дополнительный параметр через разделитель | (вертикальный слеш). Для Youtube допускается вместо URL указывать ID видео.
Команды
| Команда | Описание |
|---|---|
| ping | Проверка доступности ТВ с помощью tcp ping порта 3000. |
| powerOn | Включение ТВ с помощью WOL (только для подключения ТВ по ethernet). Поддерживается не всеми моделями ТВ. |
| powerOff | Выключение ТВ. |
| channelUp | Следующий канал. |
| channelDown | Предыдущий канал. |
| volume | Задать уровень громкости. Значение громкости указывается через разделитель | (вертикальный слеш). Например, volume|10 |
| volumeUp | Увеличить громкость. |
| volumeDown | Уменьшить громкость. |
| muteOn | Включить режим "без звука". |
| muteOff | Выключить режим "без звука". |
| play | Управление медиа. Воспроизвести. |
| pause | Управление медиа. Пауза. |
| stop | Управление медиа. Остановить. |
| rewind | Управление медиа. Перемотать назад. |
| forward | Управление медиа. Перемотать вперед. |
| browser | Запустить приложение Браузер. Опционально через разделитель | (вертикальный слеш) можно указать ссылку на сайт (URL). Например, browser|ya.ru или browser|https://connect.smartliving.ru |
| youtube | Запустить приложение Youtube. Опционально через разделитель | (вертикальный слеш) можно указать ссылку на видео (URL) или идентификатор видео (VIDID). Например, youtube|https://www.youtube.com/watch?v=UR2qXwR2vNE или youtube|3TeU9K8z9XA Также поддерживаются сокращенные форматы ссылок. |
Отправка команд на ТВ выполняется с помощью метрики command и привязанного к ней свойства объекта путем записи в это свойство команды через функцию setGlobal() или иным способом. Возможные команды приведены в таблице ниже.
Пример:
|
1 2 3 |
setGlobal('TV1.command', 'volumeUp'); // Или sg('TV1.command', 'powerOff'); |