Инструкция по работе с виджетом «Цены для АЗС»: различия между версиями

Материал из SmartPlayer
Нет описания правки
Строка 9: Строка 9:
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
[[File:Виджет_в_лк.png|thumb|center| Пример отображения переноса виджета в личном кабинете SmartPlayer|800px]]
[[File:Цены_на_топливо.png|thumb|center| Пример отображения переноса виджета в личном кабинете SmartPlayer|800px]]
== '''Настройка виджета''' ==
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.
[[File:Главная_страница_топливо.png|thumb|center| Пример отображения главной страницы виджета|800px]]
На главной странице виджета пользователю доступно две кнопки:
# Кнопка "API".
# Кнопка «Настройки»
[[File:Кнопки_настроек_топливо.png|thumb|center| Пример отображения иконки для перехода в настройки виджета|800px]]
== '''Кнопка "API"''' ==
== '''Кнопка "API"''' ==
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.
Строка 21: Строка 28:
* кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.
* кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.
Закрыть данное окно можно по стандартной иконке в правом верхнем углу.
Закрыть данное окно можно по стандартной иконке в правом верхнем углу.
== '''Настройка виджета''' ==
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.
== '''Кнопка «Настройки»''' ==
== '''Кнопка «Настройки»''' ==
После открытия страницы с настройками пользователю необходимо настроить следующие параметры виджета:
После открытия страницы с настройками пользователю откроется страница которую можно разделить на два блока параметров:
# Общие настройки виджета.
# Настройки анимации для виджета.
[[File:Настройки_виджета_топлива.png|thumb|center| Пример отображения двух блоков параметров для настройки виджета|800px]]
=== '''Общие настройки виджета''' ===
К общим настройкам виджета можно отнести следующие параметры:
* выбор языка
* поворот виджета  
* адрес прокси-сервера
* чекбокс «Использовать прокси»
* для каких позиций ДТ отображать 'экто - зима'
* размер шрифта типа топлива
* размер иконок
* размер шрифта цен
* отступы между строками
* цвет шрифта
* насыщенность шрифта
* чекбокс «Форматировать значения без нуля на конце»
* чекбокс «Дублировать цены»
* чекбокс «Фильтровать одинаковые значения»
* цвет отображаемых иконок
* полный путь в API получения цен
* частота обновления данных
* использовать хранилище клиентского приложения
* видео
* идентификатор видео
[[File:Общие_настройки_топлива.png|thumb|center| Пример отображения списка с общими настройками виджета|800px]]
=== '''Настройки анимации для виджета''' ===
Настройки анимации виджета идут отдельным блоком и расположены в правой части экрана. Все анимации разделены на шаги (максимальное количество - 6). Каждый шаг включает в себя следующие параметры:
* направление анимации
* скорость анимации
* время срабатывания анимации
[[File:Блок_настроек_анимации.png|thumb|center| Пример отображения списка с настройками для анимаций|800px]]
== '''Завершение настройки виджета''' ==
== '''Завершение настройки виджета''' ==
После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.
После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» внизу экрана и еще ниже кликнуть на кнопку «Сохранить».
[[File:Применение_настрок.png|thumb|center| Пример отображения кнопки «Применить настройки»|800px]]
[[File:Завершение_настройки_виджета_топлива.png|thumb|center| Пример отображения кнопок для завершения настройки виджета|800px]]
Далее виджет растянется на весь экран, и пользователь должен нажать на кнопку «Сохранить», внизу по центру экрана.
[[File:Сохран.png|thumb|center| Пример отображения кнопки «Сохранить»|800px]]
== '''Загрузка и скачивание настроек''' ==
== '''Загрузка и скачивание настроек''' ==
В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
[[File:Иконки_загрузки.png|thumb|center| Пример отображения иконок в настройках виджета |800px]]
[[File:Скачать_и_загрузить_настройки_топлива.png|thumb|center| Пример отображения кнопок для загрузки и выгрузки настроек|800px]]
== '''Добавление настроенного виджета в трансляцию''' ==
Чтобы создать трансляцию с виджетом необходимо перейти в раздел «Трансляция» личного кабинета и найти категорию «Создать».
[[File:Виджет_лукойл.png|thumb|center| Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.|800px]]
На открывшейся странице необходимо найти иконку «Добавить зону» и сделать нужную зону. По клику на этой зоне откроются настройки в которых необходимо указать требуемые размеры - ширину и высоту. Оба параметра необходимо указать в пикселях и нажать на кнопку «Сохранить».
{{Note|Если виджет используется для двухсторонне стелы АЗС необходимо указать общую ширину для двух экранов.|warn}}
[[File:Виджет_лукойл.png|thumb|center| Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.|800px]]
Выбрать нужны контент (например видео) и перенести в необходимую зону и также перенести в эту же зону виджет. В нижней части экрана отобразится плейлист для зоны.
[[File:Виджет_лукойл.png|thumb|center| Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.|800px]]
В это листе необходимо перетянуть контент/виджет так чтобы они стартовали одинаково.
[[File:Виджет_лукойл.png|thumb|center| Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.|800px]]
Далее с помощью клика по контенту копируем продолжительность и вставляем скопированное значение в параметр продолжительности в виджете, тем самым уравнивая длительность проигрывания его с контентом.
[[File:Виджет_лукойл.png|thumb|center| Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.|800px]]
== '''Добавление настроенного виджета в трансляцию''' ==
== '''Добавление настроенного виджета в трансляцию''' ==
Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:
Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:

Версия от 22:48, 11 ноября 2025

Описание ситуации

Данный виджет позволит пользователям выводить на устройства информацию о стоимости определенных типов топлива. Приведенная ниже инструкция объясняет как работает виджет и помогает настроить его работу внутри платформы SmartPlayer.

Серверная логика

(дописать)

Добавление виджета в личный кабинет

Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива.

Пример виджета в формате .zip-архива

После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».

Пример отображения раздела «Контент» в личном кабинете

В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.

Пример отображения переноса виджета в личном кабинете SmartPlayer

Настройка виджета

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

Пример отображения главной страницы виджета

На главной странице виджета пользователю доступно две кнопки:

  1. Кнопка "API".
  2. Кнопка «Настройки»
Пример отображения иконки для перехода в настройки виджета

Кнопка "API"

Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.

Пример отображения информации в модальном окне

Основными параметрами для ресурсов являются:

  • имя — указано имя ресурса;
  • метод — используемый тип метода (GET);
  • требует авторизации — информация об обязательности авторизации;
  • адрес сервера — URL-адрес сервера, с которого берутся данные;
  • адрес API — отображается название JSON-файла с данными о ценах;
  • кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.

Закрыть данное окно можно по стандартной иконке в правом верхнем углу.

Кнопка «Настройки»

После открытия страницы с настройками пользователю откроется страница которую можно разделить на два блока параметров:

  1. Общие настройки виджета.
  2. Настройки анимации для виджета.
Пример отображения двух блоков параметров для настройки виджета

Общие настройки виджета

К общим настройкам виджета можно отнести следующие параметры:

  • выбор языка
  • поворот виджета
  • адрес прокси-сервера
  • чекбокс «Использовать прокси»
  • для каких позиций ДТ отображать 'экто - зима'
  • размер шрифта типа топлива
  • размер иконок
  • размер шрифта цен
  • отступы между строками
  • цвет шрифта
  • насыщенность шрифта
  • чекбокс «Форматировать значения без нуля на конце»
  • чекбокс «Дублировать цены»
  • чекбокс «Фильтровать одинаковые значения»
  • цвет отображаемых иконок
  • полный путь в API получения цен
  • частота обновления данных
  • использовать хранилище клиентского приложения
  • видео
  • идентификатор видео
Пример отображения списка с общими настройками виджета

Настройки анимации для виджета

Настройки анимации виджета идут отдельным блоком и расположены в правой части экрана. Все анимации разделены на шаги (максимальное количество - 6). Каждый шаг включает в себя следующие параметры:

  • направление анимации
  • скорость анимации
  • время срабатывания анимации
Пример отображения списка с настройками для анимаций

Завершение настройки виджета

После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» внизу экрана и еще ниже кликнуть на кнопку «Сохранить».

Пример отображения кнопок для завершения настройки виджета

Загрузка и скачивание настроек

В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.

Пример отображения кнопок для загрузки и выгрузки настроек

Добавление настроенного виджета в трансляцию

Чтобы создать трансляцию с виджетом необходимо перейти в раздел «Трансляция» личного кабинета и найти категорию «Создать».

Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.

На открывшейся странице необходимо найти иконку «Добавить зону» и сделать нужную зону. По клику на этой зоне откроются настройки в которых необходимо указать требуемые размеры - ширину и высоту. Оба параметра необходимо указать в пикселях и нажать на кнопку «Сохранить».

Если виджет используется для двухсторонне стелы АЗС необходимо указать общую ширину для двух экранов.
Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.

Выбрать нужны контент (например видео) и перенести в необходимую зону и также перенести в эту же зону виджет. В нижней части экрана отобразится плейлист для зоны.

Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.

В это листе необходимо перетянуть контент/виджет так чтобы они стартовали одинаково.

Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.

Далее с помощью клика по контенту копируем продолжительность и вставляем скопированное значение в параметр продолжительности в виджете, тем самым уравнивая длительность проигрывания его с контентом.

Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.

Добавление настроенного виджета в трансляцию

Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:

Видеоинструкция

Инструкция по работе с виджетом «Курс валют»

Дополнительная информация

Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.

Пример отображения вкладки «Обсуждения» на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"