Instructions for setting up the navigation widget (ver. 2.0)
Description of the Situation
One of the most important and technically sophisticated products developed by SmartPlayer is the widget designed for indoor navigation. Taking customer feedback into account, the SmartPlayer team decided to redesign and improve this widget. The widget was completely reworked and became simpler, more intuitive, faster, and more stable. This page describes how to properly configure and use the new version of the navigation widget.
Widget Configuration Sequence
The new version of the widget provides a step-by-step configuration process consisting of the following stages:
- Open the general widget settings by clicking the gear icon. After completing the configuration, click the Apply Settings and Save buttons located at the bottom center of the widget.
- Click the Categories button to open the room category creation page. Existing categories can also be edited on this page.
- Add a floor using the corresponding icon and click the Select Map button located on the right. The map must be uploaded to a separate folder in the SmartPlayer personal account beforehand.
- Click the Configure Click Areas button and highlight the required rooms on the map.
- Add a terminal using the corresponding button on the right panel.
- Add the remaining building objects: elevators, staircases, and rooms.
- Configure the walls on the map and the room entry points.
- Repeat steps 2–7 until the required number of floors has been added.
- After configuring all floors, click the Apply Settings and Save buttons located at the bottom center of the widget.
- Reopen the widget and click the Go to Navigation button in the lower-left corner to verify that it is working correctly. If all parameters have been configured properly, it will be possible to build a route to the required room.
- To modify the widget settings, click the Return to Constructor button in the lower-left corner.
- If the route to a specific location is displayed as a zigzag instead of a straight path, it can be smoothed. To do this, open the settings page using the Smoothing Points button.
- Configure the route smoothing points and click the Apply Settings and Save buttons located at the bottom center of the widget.
Adding the Widget to the Personal Account
To add this widget to the personal account, the user must request it from a SmartPlayer technical support specialist. The widget will be provided as a ZIP archive.
After that, the user must log in to the personal account and navigate to the Content section.
In the Content section, drag and drop the widget from the local storage. After it is uploaded to the personal account, the widget will appear in the content list.
Widget Main Page
After adding the widget to the personal account, the user can open it by double-clicking its icon. The widget's main page will then be displayed.
The main page provides numerous configuration options. At the initial stage, the user should focus on the widget control area. This area includes:
- the Settings button, which allows the user to configure the general widget settings;
- an icon for expanding the widget to full-screen mode;
- a ? icon that opens the initial guide describing how to configure and use the widget.
Widget Element Configuration Order
This section sequentially describes the configuration procedure for all widget elements required for its proper operation.
Общие настройки виджета
Чтобы перейти к общим настройкам виджета, пользователю необходимо нажать на кнопку «Настройки» в левом верхнем углу.
После нажатия на кнопку откроется страница со списком настроек виджета.
Для настройки доступны следующие параметры:
- выбор языка — позволяет выбрать язык интерфейса виджета. Доступны пять языков: русский, английский, португальский, испанский и казахский;
- время сессии пользователя — позволяет указать время, по истечении которого виджет перейдёт в режим ожидания. Значение указывается в секундах;
- поле «Ключ тега для здания» — позволяет указать ключ тега устройства, в значении которого содержится наименование здания, где установлен терминал;
- поле «Ключ тега для этажа» — позволяет указать ключ тега устройства, в значении которого содержится номер этажа, где установлен терминал;
- поле «Ключ тега для терминала» — позволяет указать ключ тега устройства, используемый для идентификации терминала. Данный параметр необходимо настраивать только в том случае, если на одном этаже установлено несколько терминалов. Если на этаже установлен один терминал, поле можно оставить пустым;
- поле «Этаж, с которого начинается отсчёт в здании» — позволяет указать номер этажа, с которого начинается нумерация этажей в здании;
- элементы, отображаемые на панели навигации, — позволяют выбрать, что будет отображаться в области справа во время навигации: список категорий или список помещений. Также пользователь может отключить отображение списков;
- количество отображаемых элементов в ряду — позволяет выбрать количество элементов списка, отображаемых в одном ряду: два или три;
- флажок «Отображать стартовую страницу» — включает или отключает отображение стартовой страницы;
- цвет фона стартовой страницы — позволяет выбрать цвет фона стартовой страницы виджета;
- кнопка «Фоновое изображение стартовой страницы» — позволяет выбрать в личном кабинете SmartPlayer изображение для стартовой страницы;
- позиция кнопки начала навигации — позволяет указать числовое значение для смещения кнопки по оси Y;
- поле «Текст кнопки начала навигации» — позволяет указать текст, который будет отображаться на кнопке запуска навигации;
- цвет кнопки начала навигации — позволяет выбрать цвет кнопки запуска навигации;
- флажок «Отображать кнопку инструкции» — включает или отключает отображение кнопки для просмотра инструкции в виджете;
- кнопка «Файл инструкции» — позволяет выбрать в личном кабинете SmartPlayer документ, который будет использоваться в качестве инструкции;
- позиция кнопки инструкции — позволяет указать числовое значение для смещения кнопки по оси Y;
- цвет фона виджета — позволяет выбрать цвет фона виджета;
- цвет UI-панелей навигации — позволяет выбрать цвет панелей навигации;
- цвет отображаемого маршрута — позволяет выбрать цвет построенного маршрута;
- цвет фона названия помещения на карте — позволяет выбрать цвет фона области с названием помещения;
- цвет текста названия помещения на карте — позволяет выбрать цвет текста названия помещения;
- цвет фона активного помещения на карте — позволяет выбрать цвет фона выбранного помещения;
- цвет текста активного помещения на карте — позволяет выбрать цвет текста названия выбранного помещения;
- кнопка «Логотип» — позволяет выбрать в личном кабинете SmartPlayer изображение, которое будет использоваться в качестве логотипа и отображаться на карте. Изображение необходимо предварительно загрузить в личный кабинет SmartPlayer;
- позиция логотипа — позволяет выбрать расположение логотипа: по центру, слева или справа;
- расположение клавиатуры поиска — позволяет выбрать расположение экранной клавиатуры, используемой для ручного поиска. Доступны два варианта: сверху и снизу;
- карты этажей — позволяют выбрать в папке личного кабинета SmartPlayer карты этажей. Карты необходимо предварительно загрузить в личный кабинет SmartPlayer;
- иконки категорий — позволяют выбрать в папке личного кабинета SmartPlayer иконки категорий для отображения на картах виджета. Иконки необходимо предварительно загрузить в личный кабинет SmartPlayer;
- иконки помещений — позволяют выбрать в папке личного кабинета SmartPlayer иконки помещений для отображения на картах виджета. Иконки необходимо предварительно загрузить в личный кабинет SmartPlayer;
- изображения помещений — позволяют выбрать в папке личного кабинета SmartPlayer изображения помещений для отображения на картах виджета. Изображения необходимо предварительно загрузить в личный кабинет SmartPlayer;
- флажок «Показывать текстовое описание маршрута» — включает или отключает отображение текстового описания в дополнение к построенному маршруту.
Загрузка и скачивание настроек
При работе с настройками виджета пользователь может загрузить ранее сохранённые настройки или скачать текущие настройки. Для каждого действия предусмотрена отдельная иконка в интерфейсе виджета. Иконки расположены в правой нижней части виджета под картой.
После завершения настройки параметров виджета пользователю необходимо нажать на кнопку «Применить настройки», расположенную в правой нижней части экрана. Если указанные настройки не соответствуют требованиям пользователя, их можно сбросить до значений по умолчанию, нажав на расположенную рядом кнопку «Сбросить».
После нажатия на кнопку «Применить настройки» пользователю необходимо нажать на кнопку «Сохранить», расположенную в нижней части экрана по центру.
Настройка здания
На главной странице виджета в левой панели отображается блок настроек здания, в котором доступны следующие элементы:
- выбор здания — позволяет выбрать здание из списка доступных вариантов;
- название здания — позволяет указать наименование здания;
- кнопка «Добавить здание» — создаёт новое здание и открывает страницу для настройки навигации;
- кнопка «Удалить здание» — удаляет выбранное здание из виджета. Перед удалением откроется модальное окно для подтверждения действия;
Настройка этажей
На левой панели также отображается отдельный блок настроек этажей, расположенный под блоком настроек здания. В него входят следующие элементы:
- выбор этажа — позволяет выбрать один из ранее настроенных этажей;
- кнопка «Добавить этаж» — позволяет создать новый этаж и добавить для него карту из списка файлов, загруженных в личный кабинет SmartPlayer;
- кнопка «Категории» — позволяет создать категории для последующей привязки к ним помещений;
- кнопка «Точки сглаживания» — позволяет добавить точки сглаживания маршрута и сделать его отображение более аккуратным;
- кнопка «Параметры навигации» — открывает список параметров навигации.
Кнопка «Добавить этаж»
После нажатия на кнопку «Добавить этаж» в виджете будет создан новый этаж. Чтобы выбрать для него карту, необходимо нажать на кнопку «Выбрать карту» на правой панели.
Установка границ на карте этажа
После добавления этажа и его карты в виджет пользователю необходимо обозначить границы помещений. Виджет воспринимает данные границы как стены и учитывает их при построении маршрута.
Чтобы начать построение границы, пользователю необходимо зажать левую кнопку мыши (ЛКМ) и перемещать указатель в нужном направлении. Во время перемещения указателя на карте будет отображаться линия границы.
При построении границ рекомендуется проводить линии не только вдоль стен помещений, но и немного продлевать их внутрь помещений в местах расположения входов. Это позволит системе навигации корректно строить и отображать маршрут до входа в выбранное помещение.
Если после завершения настройки маршрут на каком-либо участке карты отображается неправильно, вероятнее всего, пользователь перекрыл проход линией границы. В таком случае необходимо вернуться к настройке границ на карте этажа и удалить неправильный участок.
Кнопка «Категории»
После нажатия на данную кнопку содержимое правой панели изменится: на ней отобразятся настройки категорий. При нажатии на кнопку «Добавить категорию» интерфейс виджета снова изменится.
Появится строка с новой категорией, которую необходимо настроить. Перейти к настройкам категории можно с помощью иконки в виде шестерёнки, расположенной справа от её названия. Также категорию можно удалить, нажав на иконку в виде крестика, расположенную рядом с иконкой настроек.
При переходе к настройкам категории пользователь может изменить следующие параметры:
- имя — позволяет указать название категории;
- кнопка «Добавить иконку» — позволяет выбрать иконку категории из файлов, загруженных в личный кабинет SmartPlayer.
Для завершения настройки категории необходимо нажать на кнопку «Применить» в нижней части панели. Если пользователь решил не сохранять изменения, необходимо нажать на расположенную рядом кнопку «Отменить».
Кнопка «Точки сглаживания»
При переходе к настройке точек сглаживания маршрута пользователю сразу отображается краткая инструкция по работе с данной функциональностью. После ознакомления с инструкцией необходимо нажать на кнопку «Добавить точки».
После нажатия на кнопку «Добавить точки» появится новая строка с набором точек сглаживания. Перейти к настройкам точек можно с помощью иконки в виде шестерёнки, расположенной справа от названия. Также набор точек сглаживания можно удалить, нажав на иконку в виде крестика, расположенную рядом с иконкой настроек.
После нажатия на иконку настроек пользователю откроется страница с картой и панелью слева, на которой можно настроить следующие параметры:
- наименование точек — позволяет указать название набора точек сглаживания;
- кнопка «Привязать помещения» — позволяет привязать помещения, выбрав их в открывшемся модальном окне. Одно или несколько помещений необходимо выделить с помощью флажков и нажать на кнопку «Выбрать».
Далее пользователю необходимо установить на карте две точки с помощью левой и правой кнопок мыши (ЛКМ и ПКМ соответственно): красную — с помощью ЛКМ, розовую — с помощью ПКМ. Точки рекомендуется располагать на одной прямой независимо от её направления. Условная линия между точками не должна пересекать стены, иначе данная функциональность не будет работать.
Для завершения настройки точек сглаживания необходимо нажать на кнопку «Применить» в нижней части панели. Если пользователь решил не сохранять изменения, необходимо нажать на расположенную рядом кнопку «Отменить».
Кнопка «Параметры навигации»
После нажатия на данную кнопку интерфейс изменится: вместо параметров этажей и здания отобразится список настроек навигации. В списке доступны следующие параметры:
- ширина клетки координат — позволяет указать ширину клетки координатной сетки в пикселях;
- высота клетки координат — позволяет указать высоту клетки координатной сетки в пикселях;
- качество отрисовки проложенного пути (DPI) — позволяет указать значение DPI для отрисовки проложенного пути;
- перемещение между этажами — позволяет выбрать способ перемещения между этажами, который будет учитываться при построении маршрута. Доступны два варианта: «По лестнице» и «На лифте»;
- отображать путь как — параметр, влияющий на отображение линии маршрута на карте. Доступны два варианта: точками или прерывистыми линиями;
- флажок «Разрешить прокладывать путь по диагонали» — разрешает или запрещает построение маршрута по диагонали;
- флажок «Автозум маршрута при построении» — включает или отключает автоматическое масштабирование карты при построении маршрута.
Для завершения настройки параметров навигации необходимо нажать на кнопку «Применить» в нижней части панели. Если пользователь решил не сохранять изменения, необходимо нажать на расположенную рядом кнопку «Отменить».
Настройка атрибутов этажа
После завершения настройки здания и этажей на левой панели виджета пользователю необходимо настроить параметры текущего этажа на правой панели. В список настроек этажа входят:
- кнопка «Заменить карту» — позволяет заменить выбранную карту этажа;
- кнопка «Настроить клики» — позволяет добавить зону помещения;
- кнопка «Добавить терминал» — позволяет добавить терминал на карту этажа;
- кнопка «Добавить лифт» — позволяет добавить обозначение лифта на карту этажа;
- кнопка «Добавить лестницу» — позволяет добавить обозначение лестницы на карту этажа;
- кнопка «Добавить помещение» — позволяет добавить помещение на карту этажа;
- кнопка «Удалить этаж» — позволяет удалить текущий этаж.
Кнопка «Выбрать/заменить карту»
После нажатия на кнопку «Выбрать/заменить карту» откроется модальное окно, в котором пользователь сможет выбрать карту из файлов, заранее загруженных в личный кабинет SmartPlayer. Чтобы выбрать новую карту, необходимо нажать на неё.
Кнопка «Настроить клики»
После нажатия на кнопку изменится отображение виджета, и пользователю откроется список доступных зон, размещённых на карте, если виджет уже был настроен ранее. Ранее созданные зоны будут отображаться на карте. В правом верхнем углу пользователю будет показана текстовая подсказка.
Если зоны не были настроены ранее, пользователю необходимо нажать на кнопку «Добавить зону». После нажатия в правом верхнем углу появится новая фигура для выделения зоны.
Чтобы переместить новую зону в нужное место на карте, необходимо зажать её левой кнопкой мыши и перетащить. Также размер зоны можно изменить, наведя указатель на её границу. При этом изменится отображение курсора.
После завершения настройки зон пользователю необходимо нажать на кнопку «Применить» на правой панели. Если внесённые изменения не устраивают пользователя, он может нажать на расположенную слева кнопку «Отменить».
Кнопка «Добавить терминал»
После нажатия на кнопку «Добавить терминал» пользователь перейдёт в раздел настроек терминала, который отобразится на панели после изменения интерфейса.
В список настроек терминала входят следующие параметры:
- имя — позволяет указать название нового терминала;
- положение по оси X — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить терминал;
- положение по оси Y — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить терминал.
После завершения настройки терминала пользователю необходимо нажать на кнопку «Применить» на правой панели. Если внесённые изменения не устраивают пользователя, он может нажать на расположенную слева кнопку «Отменить».
Кнопка «Добавить лифт»
После нажатия на кнопку «Добавить лифт» пользователь перейдёт в раздел настроек лифта на карте, который отобразится на панели после изменения интерфейса.
В список настроек лифта входят следующие параметры:
- имя — позволяет указать название нового лифта;
- положение по оси X — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить лифт;
- положение по оси Y — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить лифт;
- чекбокс (галочка) «Лифт включён» — включает или отключает использование лифта при построении маршрута. Если данный параметр активирован для лифтов на исходном и конечном этажах, маршрут будет строиться с учётом перемещения на лифте.
После завершения настройки лифта пользователю необходимо нажать на кнопку «Применить» на правой панели. Если внесённые изменения в расположение лифта не устраивают пользователя, он может нажать на расположенную слева кнопку «Отменить».
Кнопка «Добавить лестницу»
После нажатия на кнопку «Добавить лестницу» пользователь перейдёт в раздел настроек лестницы на карте, который отобразится на панели после изменения интерфейса.
В список настроек лестницы входят следующие параметры:
- имя — позволяет указать название новой лестницы;
- положение по оси X — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить лестницу;
- положение по оси Y — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить лестницу;
- чекбокс (галочка) «Лестница включена» — включает или отключает использование лестницы при построении маршрута. Если данный параметр активирован для лестниц на исходном и конечном этажах, маршрут будет строиться с учётом перемещения по лестнице.
После завершения настройки лестницы пользователю необходимо нажать на кнопку «Применить» на правой панели. Если внесённые изменения в расположение лестницы не устраивают пользователя, он может нажать на расположенную слева кнопку «Отменить».
Кнопка «Добавить помещение»
После нажатия на кнопку «Добавить помещение» пользователь перейдёт в раздел настроек помещения на карте, который отобразится на панели после изменения интерфейса.
В список настроек помещения входят следующие параметры:
- имя — позволяет указать наименование помещения;
- название в поиске — позволяет указать название, по которому помещение можно будет найти с помощью системы поиска;
- кнопка «Добавить изображение» — позволяет выбрать для помещения одно из изображений, доступных в личном кабинете;
- описание — позволяет указать дополнительную информацию о помещении;
- размер шрифта — позволяет выбрать доступный размер шрифта из списка;
- отступ от левого края карты — позволяет указать числовое значение отступа от левого края карты;
- отступ от верхнего края карты — позволяет указать числовое значение отступа от верхнего края карты;
- точка входа в помещение по оси X — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить точку входа в помещение;
- точка входа в помещение по оси Y — поле недоступно для ручного ввода. Значение определяется автоматически после нажатия левой кнопкой мыши на карту в месте, где пользователь хочет установить точку входа в помещение;
- категории — позволяет выбрать из списка категорию, к которой необходимо привязать помещение;
- отображать помещение как — позволяет выбрать вариант отображения помещения из списка. Доступны два варианта: отображать название помещения или не отображать его;
- кнопка «Добавить иконку» — позволяет выбрать для помещения одну из иконок, доступных в личном кабинете;
- кнопка «Привязать к карте» — позволяет привязать к помещению зону, добавленную на карте этажа;
- чекбокс (галочка) «Отображать в панели навигации» — включает или отключает отображение помещения на панели навигации.
После завершения настройки помещения пользователю необходимо нажать на кнопку «Применить» на правой панели. Если внесённые изменения не устраивают пользователя, он может нажать на расположенную слева кнопку «Отменить».
Переход в навигацию
После завершения предварительной настройки виджета, состоящей из описанных ранее этапов, пользователь может проверить работу настроенного виджета. Для этого ему необходимо нажать на кнопку «Перейти в навигацию» в левом нижнем углу виджета.
После нажатия на кнопку откроется страница предпросмотра виджета, на которой пользователь увидит:
- карту с помещениями и точкой расположения терминала;
- список категорий в правой части экрана;
- список этажей над списком категорий.
Также пользователь может воспользоваться экранной клавиатурой и кнопкой выбора языка для поиска нужного объекта на карте. Эти элементы расположены в правой нижней части экрана под списком категорий.
Построение маршрута на странице предпросмотра
Чтобы построить маршрут на странице предпросмотра виджета, пользователю необходимо нажатием выбрать нужный объект. После этого объект будет подсвечен, а в правой нижней части экрана рядом с системой поиска отобразится кнопка «Маршрут».
После нажатия на эту кнопку начнётся построение маршрута на карте. Также в правой части экрана вместо списка категорий и этажей отобразится текстовая подсказка о маршруте. При построении маршрута между разными этажами система проложит путь до конечной точки через лифты или лестницы в зависимости от выбранных настроек навигации.
Если пользователь захочет построить другой маршрут, он может нажать на кнопку «Завершить маршрут». После построения маршрута данная кнопка заменит кнопку «Маршрут» и будет отображаться до завершения текущей навигации. После завершения навигации кнопка снова изменится на «Маршрут».
Интеграция в трансляцию
Чтобы проверить работу данного виджета на устройстве, пользователю необходимо создать трансляцию, добавить в неё настроенный ранее виджет в качестве контента, настроить расписание и назначить трансляцию на устройство. Подробнее об этих действиях можно узнать в следующих статьях базы знаний SmartPlayer:
Дополнительная информация
Если данная статья не помогает использовать функциональность по назначению или после её прочтения остаются вопросы, их можно задать в разделе «Обсуждения» вверху страницы.
Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения".
