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

Материал из SmartPlayer
Новая страница: «Instruction for Working with the “Fuel Prices” Widget»
 
Новая страница: «== '''Situation Description''' == This widget allows users to display information about the cost of specific fuel types on devices. The instructions below explain how the widget works and how to configure it within the SmartPlayer platform. == '''Server Logic''' == This widget receives all data directly from the customer's server. After receiving it, the data is processed and displayed in the broadcast through the SmartPlayer personal account. == '''Adding t...»
 
Строка 1: Строка 1:
<div lang="ru" dir="ltr" class="mw-content-ltr">
== '''Situation Description''' ==
== '''Описание ситуации''' ==
This widget allows users to display information about the cost of specific fuel types on devices. The instructions below explain how the widget works and how to configure it within the SmartPlayer platform.
Данный виджет позволяет пользователям выводить на устройства информацию о стоимости определенных типов топлива. Приведенная ниже инструкция объясняет как, работает виджет и помогает настроить его работу внутри платформы SmartPlayer.
== '''Server Logic''' ==
== '''Серверная логика''' ==
This widget receives all data directly from the customer's server. After receiving it, the data is processed and displayed in the broadcast through the SmartPlayer personal account.
Данный виджет, все данные получает напрямую от сервера заказчика. После получения обрабатывает данные и выводит их в трансляцию с помощью личного кабинета SmartPlayer.
== '''Adding the Widget to the Personal Account''' ==
== '''Добавление виджета в личный кабинет''' ==
To add this widget to the personal account, the user must request a zip archive with the content from a technical support specialist.
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива.
[[File:Виджет_лукойл.png|thumb|center| Example of the widget in .zip format|800px]]
[[File:Виджет_лукойл.png|thumb|center| Пример виджета в формате .zip-архива|800px]]
After that, the user must log into their personal account and go to the “Content” section.
После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Example of the “Content” section in the personal account |800px]]
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
In the “Content” section, drag the widget from local storage into the personal account. Once the user uploads the widget, it will appear in the content list.
В разделе «Контент» необходимо перенести данный виджет из локального хранилища в личный кабинет. После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
[[File:Цены_на_топливо.png|thumb|center| Example of the widget being added to the SmartPlayer personal account|800px]]
[[File:Цены_на_топливо.png|thumb|center| Пример отображения переноса виджета в личном кабинете SmartPlayer|800px]]
== '''Widget Configuration''' ==
== '''Настройка виджета''' ==
After transferring the widget, the user must double-click the widget icon to access the main page for initial configuration.
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.
[[File:Главная_страница_топливо.png|thumb|center| Example of the widget's main page|800px]]
[[File:Главная_страница_топливо.png|thumb|center| Пример отображения главной страницы виджета|800px]]
On the widget’s main page, two buttons are available:
На главной странице виджета пользователю доступно две кнопки:
# “API” button.
# Кнопка "API".
# “Settings” button.
# Кнопка «Настройки»
[[File:Кнопки_настроек_топливо.png|thumb|center| Example of the icon for accessing widget settings|800px]]
[[File:Кнопки_настроек_топливо.png|thumb|center| Пример отображения иконки для перехода в настройки виджета|800px]]
== '''“API” Button''' ==
== '''Кнопка "API"''' ==
Clicking the “API” button opens a modal window with information about the resources required for stable widget performance. The section also contains a general explanation of its purpose and principles of operation.
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют виджету стабильно работать. В разделе также есть общее описание о его необходимости и принципах работы.
[[File:Данные_в_модальном_окне.png|thumb|center| Example of the modal window content |800px]]
[[File:Данные_в_модальном_окне.png|thumb|center| Пример отображения информации в модальном окне |800px]]
The main parameters for the resources include:
Основными параметрами для ресурсов являются:
* name name of the resource;
* имя указано имя ресурса;
* method HTTP method used (GET);
* метод используемый тип метода (GET);
* requires authorization whether authorization is required;
* требует авторизации информация об обязательности авторизации;
* server address — URL of the server providing the data;
* адрес сервера — URL-адрес сервера, с которого берутся данные;
* API address displays the JSON file name containing API and price information;
* адрес API — отображается название JSON-файла в котором присутствует информация об API и ценах;
* “Check connection” button checks the connection and displays a numeric status.
* кнопка «Проверить соединение» при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.
This window can be closed using the standard icon in the upper-right corner.
Закрыть данное окно можно по стандартной иконке в правом верхнем углу.
== '''“Settings” Button''' ==
== '''Кнопка «Настройки»''' ==
After opening the settings page, the user will see two blocks of parameters:
После открытия страницы с настройками пользователю откроется страница, которую можно разделить на два блока параметров:
# General widget settings.
# Общие настройки виджета.
# Animation settings for the widget.
# Настройки анимации для виджета.
[[File:Настройки_виджета_топлива.png|thumb|center| Example showing both parameter blocks for widget setup|800px]]
[[File:Настройки_виджета_топлива.png|thumb|center| Пример отображения двух блоков параметров для настройки виджета|800px]]
=== '''General Widget Settings''' ===
=== '''Общие настройки виджета''' ===
The following parameters belong to general settings:
К общим настройкам виджета можно отнести следующие параметры:
* language selection choose from: Russian, English, Spanish, Portuguese;
* выбор языка выбрать доступный вариант из списка: русский, английский, испанский, португальский;
* widget rotation select rotation angle (90 or 270 degrees);
* поворот виджета выбрать из списка значение для поворота виджета при отображении (90 и 270 градусов);
* proxy server address enter the proxy server URL;
* адрес прокси-сервера указать URL-ссылку для прокси-сервера;
* “Use proxy” checkbox enables/disables use of a proxy;
* чекбокс «Использовать прокси» включает/отключает использование прокси сервера для виджета;
* for which diesel positions to show "ekto-winter" input values (starting from 0, separated by ",");
* для каких позиций ДТ отображать 'экто-зима' введите значения позиций (начинайте с 0 и ставьте разделителем ",");
* fuel type font size specify size in pixels or adjust via slider;
* размер шрифта типа топлива прописать значение для шрифта (в пикселях) или настроить с помощью ползунка;
* icon size specify size in pixels or use the slider;
* размер иконок прописать значение размера иконок (в пикселях) или настроить с помощью ползунка;
* price font size specify in pixels or adjust via slider;
* размер шрифта цен прописать значение для шрифта (в пикселях) или настроить с помощью ползунка;
* line spacing specify in pixels;
* отступы между строками прописать значение для отступа (считается в пикселях);
* font color select custom color;
* цвет шрифта палитра, позволяющая создать индивидуальный цвет для шрифта;
* font weight — choose from: thin, normal, semi-bold, bold;
* насыщенность шрифта — выберите один вариант начертания из списка: тонкое, нормальное, полужирное, жирное;
* “Format values without trailing zero” checkbox enable/disable zero removal;
* чекбокс «Форматировать значения без нуля на конце» включает/отключает форматирование нецелых значений с нулём на конце;
* “Duplicate prices” checkbox enable/disable price duplication;
* чекбокс «Дублировать цены» включает/отключает дублирование цен;
* “Filter identical values” checkbox enable/disable filtering;
* чекбокс «Фильтровать одинаковые значения» включает/отключает фильтрацию по идентичным значениям;
* icon color choose black or white;
* цвет отображаемых иконок выбрать один из доступных цветов для иконок: белый или чёрный;
* full API path for prices enter full URL with identifier (last numeric value);
* полный путь в API получения цен прописывается полноценная URL-ссылка со значением идентификатора (идентификатор последнее числовое значение);
{{Note|[[File:Правильный_идентификатор.png|thumb|center| Example of correct identifier display|800px]]|warn}}
{{Note|[[File:Правильный_идентификатор.png|thumb|center| Пример отображения правильного идентификатора|800px]]|warn}}
* data refresh interval specify interval in seconds;
* частота обновления данных указать значения для промежутка обновления данных (в секундах);
* use client app storage enable/disable usage (Windows/Linux/Raspberry only);
* использовать хранилище клиентского приложения включает/отключает использование клиентского приложения (применимо только к устройствам на ОС Windows, Linux, Raspberry);
* video select background video from personal account;
* видео позволяет выбрать видео из личного кабинета, которое будет проигрываться на фоне цен;  
* video identifier cannot be edited, is auto-fetched from the selected video.
* идентификатор видео поле, которое нельзя настроить. Автоматически определяет идентификатор выбранного видео из личного кабинета.
[[File:Общие_настройки_топлива.png|thumb|center| Example of the general widget settings list|800px]]
[[File:Общие_настройки_топлива.png|thumb|center| Пример отображения списка с общими настройками виджета|800px]]
=== '''Widget Animation Settings''' ===
=== '''Настройки анимации для виджета''' ===
Animation settings appear in a separate block on the right. Animations are split into steps (max 6). Each step includes:
Настройки анимации виджета идут отдельным блоком и расположены в правой части экрана. Все анимации разделены на шаги (максимальное количество - 6). Каждый шаг включает в себя следующие параметры:
* animation direction select from: left-to-right, right-to-left, bottom-up, top-down;
* направление анимации выбрать один из доступных вариантов из списка: слева направо, справа налево, снизу вверх, сверху вниз;
* animation speed set duration in seconds;
* скорость анимации прописать скорость анимации (в секундах);
* animation delay set delay time in seconds.
* время срабатывания анимации прописать интервал, через который должна сработать анимация (в секундах).
[[File:Блок_настроек_анимации.png|thumb|center| Example of animation settings block|800px]]
[[File:Блок_настроек_анимации.png|thumb|center| Пример отображения списка с настройками для анимаций|800px]]
== '''Finalizing Widget Setup''' ==
== '''Завершение настройки виджета''' ==
Once configuration is complete, the user must click “Apply Settings” at the bottom and then “Save” just below.
После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» внизу экрана и еще ниже кликнуть на кнопку «Сохранить».
[[File:Завершение_настройки_виджета_топлива.png|thumb|center| Example showing buttons to finalize widget settings|800px]]
[[File:Завершение_настройки_виджета_топлива.png|thumb|center| Пример отображения кнопок для завершения настройки виджета|800px]]
== '''Upload and Download Settings''' ==
== '''Загрузка и скачивание настроек''' ==
During configuration, the user can upload or download widget settings via dedicated icons located at the bottom center of the widget.
В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
[[File:Скачать_и_загрузить_настройки_топлива.png|thumb|center| Example of upload/download buttons|800px]]
[[File:Скачать_и_загрузить_настройки_топлива.png|thumb|center| Пример отображения кнопок для загрузки и выгрузки настроек|800px]]
== '''Adding the Configured Widget to a Broadcast''' ==
== '''Добавление настроенного виджета в трансляцию''' ==
To create a broadcast with this widget, go to the “Broadcast” section and find the “Create” category.
Чтобы создать трансляцию с виджетом, необходимо перейти в раздел «Трансляция» личного кабинета и найти категорию «Создать».
[[File:Создание_транлсяций.png|thumb|center| Example of the “Broadcast” section and “Create” category in the personal account|800px]]
[[File:Создание_транлсяций.png|thumb|center| Пример отображения раздела «Трансляция» и категории «Создать» в личном кабинете.|800px]]
Click “Add zone” and configure the zone dimensions — width and height in pixels then click “Save”.
На открывшейся странице необходимо найти иконку «Добавить зону» и определить подходящую зону. По клику на этой зоне откроются настройки в которых необходимо указать требуемые размеры ширину и высоту. Оба параметра необходимо указать в пикселях и нажать на кнопку «Сохранить».
{{Note|If the widget is used on a double-sided gas station screen, specify the total width for both screens.|warn}}
{{Note|Если виджет используется для двухсторонней стелы АЗС необходимо указать общую ширину для двух экранов.|warn}}
[[File:Параметры_для_настрйоки.png|thumb|center| Example of zone settings|800px]]
[[File:Параметры_для_настрйоки.png|thumb|center| Пример отображения настроек зоны|800px]]
Select the desired content (e.g. video) and add it to the zone, then also add the widget. A playlist for the zone will appear at the bottom.
Выбрать нужный контент (например видео) и перенести в необходимую зону и также перенести в эту же зону виджет. В нижней части экрана отобразится плейлист для зоны.
[[File:Контент_в_плейлисте.png|thumb|center| Example showing content in the playlist|800px]]
[[File:Контент_в_плейлисте.png|thumb|center| Пример отображения контента в плейлисте|800px]]
Align the widget and content to start at the same time.
В этом листе необходимо перетянуть контент/виджет так, чтобы они стартовали одинаково.
[[File:Выравнивание старта.png|thumb|center| Example showing start alignment|800px]]
[[File:Выравнивание старта.png|thumb|center| Пример отображения настройки контента для равного старта|800px]]
Then, click the content to copy its duration and paste it into the widget’s duration parameter to match playback.
Далее с помощью клика по контенту копируем продолжительность и вставляем скопированное значение в параметр продолжительности в виджете, тем самым уравнивая длительность проигрывания его с контентом.
[[File:Настройка_продолжительности.png|thumb|center| Example of duration parameter display|800px]]
[[File:Настройка_продолжительности.png|thumb|center| Пример отображения параметра продолжительностьв|800px]]
== '''Adding the Configured Widget to a Scheduled Broadcast''' ==
== '''Добавление настроенного виджета в трансляцию''' ==
To fully explore this functionality, launch a scheduled broadcast and add the widget as content. To review the earlier setup steps, refer to the following Wiki SmartPlayer articles:
Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:
* [[Раздел "Устройства"]]
* [[Раздел "Устройства"]]
* [[Раздел "Контент на устройства"]]
* [[Раздел "Контент на устройства"]]
* [[Раздел "Трансляции"]]
* [[Раздел "Трансляции"]]
* [[Раздел "Расписание"]]
* [[Раздел "Расписание"]]
== '''Видеоинструкция''' ==
== '''Video Tutorial''' ==
[https://vk.com/video-227547238_456239101 Инструкция по работе с виджетом «Цены для АЗС»]
[https://vk.com/video-227547238_456239101 Instruction for Working with the “Fuel Prices” Widget]
== '''Дополнительная информация''' ==
== '''Additional Information''' ==
Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.
If this article doesn’t help you use the feature as intended or if you still have questions after reading it, you can ask them in the “Discussions” tab at the top of the page.
[[File:Обсуждение_цены_топлива.png|thumb|center| Пример отображения вкладки «Обсуждения» на wiki-странице |800px]]
[[File:Обсуждение_цены_топлива.png|thumb|center| Example of the “Discussions” tab on the wiki page |800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
You can also learn more from the page [[How the User Can Interact with the “Discussions” Section]]
</div>

Текущая версия от 10:18, 13 ноября 2025

Situation Description

This widget allows users to display information about the cost of specific fuel types on devices. The instructions below explain how the widget works and how to configure it within the SmartPlayer platform.

Server Logic

This widget receives all data directly from the customer's server. After receiving it, the data is processed and displayed in the broadcast through the SmartPlayer personal account.

Adding the Widget to the Personal Account

To add this widget to the personal account, the user must request a zip archive with the content from a technical support specialist.

Example of the widget in .zip format

After that, the user must log into their personal account and go to the “Content” section.

Example of the “Content” section in the personal account

In the “Content” section, drag the widget from local storage into the personal account. Once the user uploads the widget, it will appear in the content list.

Example of the widget being added to the SmartPlayer personal account

Widget Configuration

After transferring the widget, the user must double-click the widget icon to access the main page for initial configuration.

Example of the widget's main page

On the widget’s main page, two buttons are available:

  1. “API” button.
  2. “Settings” button.
Example of the icon for accessing widget settings

“API” Button

Clicking the “API” button opens a modal window with information about the resources required for stable widget performance. The section also contains a general explanation of its purpose and principles of operation.

Example of the modal window content

The main parameters for the resources include:

  • name — name of the resource;
  • method — HTTP method used (GET);
  • requires authorization — whether authorization is required;
  • server address — URL of the server providing the data;
  • API address — displays the JSON file name containing API and price information;
  • “Check connection” button — checks the connection and displays a numeric status.

This window can be closed using the standard icon in the upper-right corner.

“Settings” Button

After opening the settings page, the user will see two blocks of parameters:

  1. General widget settings.
  2. Animation settings for the widget.
Example showing both parameter blocks for widget setup

General Widget Settings

The following parameters belong to general settings:

  • language selection — choose from: Russian, English, Spanish, Portuguese;
  • widget rotation — select rotation angle (90 or 270 degrees);
  • proxy server address — enter the proxy server URL;
  • “Use proxy” checkbox — enables/disables use of a proxy;
  • for which diesel positions to show "ekto-winter" — input values (starting from 0, separated by ",");
  • fuel type font size — specify size in pixels or adjust via slider;
  • icon size — specify size in pixels or use the slider;
  • price font size — specify in pixels or adjust via slider;
  • line spacing — specify in pixels;
  • font color — select custom color;
  • font weight — choose from: thin, normal, semi-bold, bold;
  • “Format values without trailing zero” checkbox — enable/disable zero removal;
  • “Duplicate prices” checkbox — enable/disable price duplication;
  • “Filter identical values” checkbox — enable/disable filtering;
  • icon color — choose black or white;
  • full API path for prices — enter full URL with identifier (last numeric value);
Example of correct identifier display
  • data refresh interval — specify interval in seconds;
  • use client app storage — enable/disable usage (Windows/Linux/Raspberry only);
  • video — select background video from personal account;
  • video identifier — cannot be edited, is auto-fetched from the selected video.
Example of the general widget settings list

Widget Animation Settings

Animation settings appear in a separate block on the right. Animations are split into steps (max 6). Each step includes:

  • animation direction — select from: left-to-right, right-to-left, bottom-up, top-down;
  • animation speed — set duration in seconds;
  • animation delay — set delay time in seconds.
Example of animation settings block

Finalizing Widget Setup

Once configuration is complete, the user must click “Apply Settings” at the bottom and then “Save” just below.

Example showing buttons to finalize widget settings

Upload and Download Settings

During configuration, the user can upload or download widget settings via dedicated icons located at the bottom center of the widget.

Example of upload/download buttons

Adding the Configured Widget to a Broadcast

To create a broadcast with this widget, go to the “Broadcast” section and find the “Create” category.

Example of the “Broadcast” section and “Create” category in the personal account

Click “Add zone” and configure the zone dimensions — width and height in pixels — then click “Save”.

If the widget is used on a double-sided gas station screen, specify the total width for both screens.
Example of zone settings

Select the desired content (e.g. video) and add it to the zone, then also add the widget. A playlist for the zone will appear at the bottom.

Example showing content in the playlist

Align the widget and content to start at the same time.

Example showing start alignment

Then, click the content to copy its duration and paste it into the widget’s duration parameter to match playback.

Example of duration parameter display

Adding the Configured Widget to a Scheduled Broadcast

To fully explore this functionality, launch a scheduled broadcast and add the widget as content. To review the earlier setup steps, refer to the following Wiki SmartPlayer articles:

Video Tutorial

Instruction for Working with the “Fuel Prices” Widget

Additional Information

If this article doesn’t help you use the feature as intended or if you still have questions after reading it, you can ask them in the “Discussions” tab at the top of the page.

Example of the “Discussions” tab on the wiki page

You can also learn more from the page How the User Can Interact with the “Discussions” Section