Просмотр кода страницы Интеграция SmartPlayer с ivideon

<languages/>
<translate>
<!--T:1-->
== '''Описание ситуации''' ==
Данная инструкция предназначена для получения информации о правильной настройке сервиса ivideon, а также информации для его интеграции с платформой SmartPlayer.
== '''Сценарий использования при интеграции с ivideon''' ==
Для понимания как будет происходить интеграция между ivideon и SmartPlayer будет использоваться следующий сценарий взаимодействия в общем виде: 
* Зарегистрироваться/авторизоваться в личном кабинете ivideon
* Добавить камеру и настроить камеру в личном кабинете ivideon
* Получить API ключ для интеграции со SmartPlayer
* Авторизоваться в личном кабинете SmartPlayer
* Создать трансляцию в SmartPlayer с двумя страницами
* Страница №1 проигрывает фоновый контент (режим бездействия)
* Страница №2 проигрывает контент, который будет проигрываться для настроенной на движение камеры
* После проигрывания контента со страницы №2 происходит переход (возвращение) на страницу №1
== '''Настройка ivideon''' ==
{{Note|При возникновении проблем с настройкой личного кабинета и устройств в личном кабинете ivideon рекомендуется обращаться к специалисту технической поддержки компании ivideon. |warn}}
=== '''Регистрация/авторизация пользователя в сервисе ivideon''' ===
Первым шагом для пользователя будет регистрация в сервисе ivideon. Пройти регистрацию можно по [https://my.ivideon.com/service/login ссылке]. 
Для начала процесса регистрации пользователю необходимо перейти по ссылке и нажать на строку "Регистрация". 
[[File:Регистрация_ivideon.png|thumb|center| Пример отображения строки "Регистрации" на странице сервиса ivideon|800px]]
После нажатия пользователю откроется новое окно со списком данных, которые необходимо указать о себе. В этот список входит следующая информация: 
* Имя 
* Адрес электронной почты (E-Mail)
* Номер телефона 
* Пароль
* Чекбокс (галочка) о принятии условий обслуживания и политике конфиденциальности
[[File:Параметры_регистрации_ivideon.png|thumb|center| Пример отображения необходимых данных для регистрации в сервисе ivideon|800px]]
{{Note|Если пользователь уже имеет учетную запись в сервисе ivideon ему необходимо авторизоваться в нем.|warn}}
После авторизации на сервисе ivideon пользователю откроется главная страница личного кабинета пользователя. 
[[File:Стартовая_страница_ivideon.png|thumb|center| Пример отображения главной страницы личного кабинета пользователя сервиса ivideon|800px]]
</translate>
<translate>
<!--T:2-->
=== '''Добавление устройства в личный кабинет ivideon''' ===
На главной странице пользователю предложат добавить устройство по специальной кнопке в центре экрана - "Подключить устройство".
[[File:Подключить_устройство.png|thumb|center| Пример отображения кнопки "Подключить устройство" в личном кабинете пользователя сервиса ivideon|800px]]
Кликнув на кнопку "Подключить устройство" пользователю откроется список, в котором необходимо выбрать нужное устройство. В данном случае это IP-камера.
[[File:Ip_камера.png|thumb|center| Пример отображения списка доступных для подключения устройств в личном кабинете пользователя сервиса ivideon|800px]]
Далее пользователю рекомендуется выбрать способ подключения IP-камеры. Специалисты технической поддержки ivideon настоятельно рекомендуют использовать проводное подключение "Ethernet".
[[File:Подключение_через_кабель_.png|thumb|center| Пример отображения типа подключений камеры в личном кабинете пользователя сервиса ivideon|800px]]
На данном этапе пользователя попросят указать серийный номер устройство. Если данной информацией пользователь не располагает, то существует возможность зарегистрировать устройство с помощью MAC-адреса. Кликнув на специальную строку "Использовать MAC-адрес", пользователь сможет перейти в новое окно регистрации.
[[File:Серийный_номер_.png|thumb|center| Пример регистрации устройства через серийный номер и отображения строки на переход для регистрации через MAC-адрес|800px]]
В открывшемся окне регистрации пользователю необходимо ввести MAC-адрес устройства, который можно найти на самом устройстве (IP- камере) или на коробке, в которой устройство было упаковано при покупке.
[[File:Мак_адрес.png|thumb|center| Пример регистрации устройства через MAC-адрес|800px]]
После указания MAC-адреса и нажатия клавиши "Продолжить" камера пользователя будет зарегистрирована и отобразится в личном кабинете.
=== '''Использование web-интерфейса камеры для настройки''' ===
Производителями различных камер предусмотрен внутренний интерфейс с настройками камеры. Чтобы до него добраться необходимо проделать определенный порядок действий.<br>
Первым делом пользователю в личном кабинете ivideon необходимо перейти в раздел "Настройки" и переходим в категорию "Безопасность".
[[File:Настройки_безопасности_.png|thumb|center| Пример отображения раздела "Настройки" и категории "Безопасность" в личном кабинете ivideon|800px]]
В данной категории пользователь может изменить пароль к камере и указать нужный, если он его не знает.
[[File:Изменить_пароль.png|thumb|center| Пример отображения строки для изменения пароля от устройства|800px]]
Следующим шагом переходим в раздел информация о камере. Для этого пользователю необходимо в окне зарегистрированной камеры нажать на три вертикальных точки и открыть список возможностей по взаимодействию с камерой. В этом списке пользователь выбирает строку "Информация о камере".
[[File:Информация_о_камере.png|thumb|center| Пример отображения строки "Информации о камере" в личном кабинете ivideon|800px]]
В открывшемся окне будет описана информации о камере. Внизу окна будет нужный пользователю блок "IP-адрес" со строкой "eth 0". В этой строке и будет указан нужный IP-адрес.
[[File:Ip_адрес_камеры.png|thumb|center| Пример отображения IP-адреса камеры в личном кабинете ivideon|800px]]
Данный IP-адрес копируется и вставляется в браузере в адресную строку. Это нужно чтобы открыть тот самый интерфейс настроек камеры. Открывшаяся страница с авторизацией потребует ввести логин и пароль от камеры.
После этого в web-интерфейсе настроек камеры необходимо будет найти настройку "Configuration/конфигурации" и включить настройку или чекбокс (поставить галочку) у настройки "Enable motion detection" (включить обнаружение движения).<br>
{{Note|'''Ограничение:''' камера должна поддерживать настройку пересечения объектом зоны, иначе указанная ранее настройка "Enable motion detection" может быть недоступна в настройках web-интерфейса камеры. Пример камеры поддерживающей настройку зоны с реакцией на пересечние можно по [https://www.dssl.ru/products/ds-2cd2183g2-is-2-8-mm-ip-kamera/ ссылке]. В настройках камеры пользователю всегда сможет помочь специалист технической поддержки ivideon|warn}}
Также некоторым камерам доступно записи и хранения логов. Для этого в камере предусмотрена возможность вставить USB-flash накопитель. Просмотреть логи можно также в web-интерфейсе камеры (присутствует не у всех производителей).
</translate>
<translate>
<!--T:3-->
=== '''Отображение событий в личном кабинете ivideon''' ===
После настройки web-интерфейса камеры в личном кабинете ivideon пользователю начнут приходить события.
[[File:Список_событий ivideon.png|thumb|center| Пример отображения событий в личном кабинете ivideon|800px]]
В разделе личного кабинета "События" пользователю необходимо отсортировать события с помощью фильтров.
[[File:Строка_фильтров.png|thumb|center| Пример отображения фильтров событий в личном кабинете ivideon|800px]]
Из имеющихся фильтров пользователю необходимо использовать фильтр по типу события:
# Пересечении линии
# Вход в зону
После применения фильтра в личном кабинете будут отображаться только отсортированные события, описанные выше.
[[File:Типы_событий.png|thumb|center| Пример фильтрации событий в личном кабинете ivideon|800px]]
{{Note|'''Ограничение:''' если одно из событий указанных выше произошло ("Пересечение линии" и "Вход в зону") то приходит в личный кабинет. Промежуток регистрации события - одно событие в течение пяти минут. Если после запуска таймера отсчета в пять минут у камеры произойдет событие (изменения одного цвета пикселя в зоне камеры) то пятиминутный таймер сбросится и начнет отсчет по новой. При этом событие в личный кабинет ivideon не придет, так как изначальный таймер в пять минут не закончил свой отсчет. Следовательно, и событие, на которое должна среагировать трансляция в SmartPlayer не приходит. Ограничение на длительность таймера в пять минут отключить невозможно.<br>
Также нужно понимать, что хоть событие и не пришло в личный кабинет ivideon, но система его видела и засчитала. А это значит, что таймер в пять минут снова обновится и начнет отсчет.  |warn}}
== '''Интеграция со SmartPlayer''' ==
Для интеграции со SmartPlayer пользователю в личном кабинете SmartPlayer необходимо сделать три действия:
# Добавить на нужное устройство камеру
# Создать API ключ в личном кабинете ivideon и с его помощью подключиться к SmartPlayer
# Подготовить серверное приложение и трансляцию/-ии с правильно настроенными событиями
Все эти пункты подробнее будут изложены ниже.
</translate>
<translate>
<!--T:4-->
== '''Добавление камеры на устройство используемое в трансляции SmartPlayer ''' ==
Чтобы получать информацию об изменении состоянии камеры пользователю необходимо подключить ее к устройство, которое он будет использовать в трансляции. Данное действие можно сделать в личном кабинете SmartPlayer.
{{Note|Предварительно устройство, к которому будет привязана камера, должно быть добавлено в личный кабинет. Оно будет отображено в разделе "Устройства". |warn}}
Изначально пользователю необходимо перейти в раздел "Устройства" личного кабинета.
[[File:Устройства_доступные_в_лк.png|thumb|center| Пример отображения раздела "Устройства" в личном кабинете SmartPlayer |800px]]
Далее ему нужно найти нужное устройство, кликнуть по нему и в правом тулбаре перейти в раздел "Настройки".
[[File:Настрйоки_тулбара.png|thumb|center| Пример отображения раздела "Настройки" в списке настроек устройства|800px]]
В разделе настроек ему нужно найти категорию - "Камера" и открыть данную категорию.
[[File:Настройка_камера.png|thumb|center| Пример отображения категории "Камера" в настройках устройства|800px]]
Открыв категорию "Камера" пользователю необходимо будем нажать на кнопку "Добавить камеру" и заполнить следующие поля:
* Название камеры - ввести название камеры 
* Идентификатор камеры - получить его можно в личном кабинете ivideon, в разделе "Информация о камере" (ID камеры)
{{Note|С помощью кнопки "Добавить камер" пользователь может добавить несколько камер к одному устройству.|warn}}
[[File:Id_камеры.png|thumb|center| Пример отображения ID камеры в личном кабинете ivideon|800px]]
== '''Прием данных в SmartPlayer по API ключу от ivideon ''' ==
Чтобы подключиться к SmartPlayer и получать события от ivideon пользователю необходимо получить API - ключ внутри личного кабинета ivideon. После получения API-ключа пользователю нужно будет добавит его в настройках личного кабинета SmartPlayer.  
=== '''Создание API-ключа в личном кабинете ivideon''' ===
{{Note|Чтобы получить API-ключ пользователю ivideon необходимо иметь специальный тариф. |warn}}
Чтобы получить API-ключ пользователю нужно перейти в раздел "Настройки" личного кабинета ivideon и перейти в категорию "Доступ и безопасность".
[[File:Настройки_безопасности.png|thumb|center| Пример отображения раздела "Настройки" и категории "Доступ и безопасность" в личном кабинете ivideon |800px]]
В открывшейся странице пользователю необходимо найти блок "Для разработчиков" и напротив строки "Ключи доступа к API" нажать кнопку "Открыть".
[[File:Для_разработчиков.png|thumb|center| Пример отображения функционала для создания API-ключа в личном кабинете ivideon|800px]]
Открыв новую страницу, пользователь должен создать новый API ключ. Для этого ему необходимо в правом верхнем углу нажать на кнопку "Создать ключ". Также можно удалить все ключи на этой странице нажав на кнопку "Удалить все ключи".
[[File:Создать_ключ.png|thumb|center| Пример отображения кнопки "Создать ключ"|800px]]
В открывшемся окне обязательно нужно ввести имя ключа и нажать на кнопку "Продолжить". Кнопка "Продолжить" будет неактивна пока пользователь не введёт название ключа.
[[File:Тестовый_ключ_2.png|thumb|center| Пример отображения кнопки "Продолжить" и строки для ввода названия ключа|800px]]
Следующее окно отобразит пользователю новый ключ, значение которого необходимо скопировать, нажав на специальную иконку рядом со строкой, в которой указано значение. Также необходимо активировать чекбокс (галочку) "Я скопировал ключ". Иначе пользователь не сможет завершить создание API ключа, потому что кнопка "Готово" будет неактивна.
[[File:Созданный_ключ.png|thumb|center| Пример отображения окна с созданным API-ключом|800px]]
Нажав на кнопку "Готово" пользователя вернет на страницу со списком ключей, где будет отображен новый ключ, который будет использоваться для подключения в SmartPlayer.
[[File:Готовый_ключ.png|thumb|center| Пример отображения созданного API-ключа|800px]]
</translate>
<translate>
<!--T:5-->
=== '''Применение API-ключа для интеграции со SmartPlayer ''' ===
Полученный API-ключи в личном кабинете ivideon пользователь должен добавить в личный кабинет SmartPlayer. Для этого пользователю необходимо авторизоваться в личном кабинете SmartPlayer и перейти в раздел "Настройки". 
[[File:Настройки_для_api_ключа.png|thumb|center| Пример отображения раздела "Настройки" в личном кабинете SmartPlayer|800px]]
В разделе "Настройки" пользователю необходимо перейти в блок "Интеграции". 
[[File:Интеграции_.png|thumb|center| Пример отображения Блока "Интеграции" в настройках |800px]]
В данной блоке пользователю необходимо настроить следующие параметры:
* Активировать чекбокс (галочку) 
* Ввести значение API-ключа (должен быть скопирован из личного кабинете ivideon)
* Выбрать тип событий, которые будут использоваться в трансляции. В текущем кейсе будут использоваться только значения - "пересечения линии" и "вход в зону".
[[File:Параметры_интеграции.png|thumb|center| Пример отображения заполняемых параметров в блоке "Интеграции" |800px]]
== '''Создание трансляции для проигрывания в SmartPlayer с нужными настройками ''' ==
Чтобы принимать данные с сервиса ivideon и заставить правильно реагировать на эти событие SmartPlayer пользователю необходимо создать трансляцию со специально настроенными параметрами. 
{{Note|Данный функционал доступен на следующих версиях клиентских приложения SmartPlayer:
* Windows - ver. 2.41.7
* Linux - ver. 2.41.7
* Android - ver. 1.74.2 и выше.<br>
Также на данный момент не реализован на клиентских приложения Web OS и Tizen OS|warn}}
==='''Подготовка серверного приложения:'''===
* Создать личный кабинет на нужном серверном приложении. При создании личного кабинета необходимо выставить роль - "admin" с видеоаналитикой
* Вручную создать трансляцию в личном кабинете и настроить переходы для нужного контента и значениями событий (действиями для событий)
'''Программная часть:'''
* При реализации программной части необходимо использовать "''socket.io v.2''". Данное решение доступно по [https://socket.io/ ссылке]<br>
''Личный кабинет:''
*Взаимодействие с личным кабинетом происходит по протоколу: ''http(s)'' и ''webSocket''. Информация о "''socket.io v.2''" указана выше.<br>
''Информация по протоколам:''
* restApi - используется в большинстве случаев для авторизации и работы с файлами
* Socket.io - используется большинством методов для работы с личным кабинетом
''Авторизация:''
* Информация о получении необходимых токенов можно получить по [https://dev.smartplayer.org/api-page/pages/1 ссылке]
* Информация о корректной настройки для "join" можно получить по  [https://dev.smartplayer.org/api-page/events/28 ссылке]
'''Получение трансляции:'''
* С помощью определенного события можно  получить список трансляций. Информация о получении события доступна по [https://dev.smartplayer.org/api-page/events/367 ссылке]. <br>
После получения данных необходимо будет выбрать нужное событие. У этого объекта необходимо взять ID, который будет подставлен в событие, описанное ниже.<br>
'''Отправка ответного события:'''
* Следующим шагом отправляется другое событие, доступное по [https://dev.smartplayer.org/api-page/events/367 ссылке], с нужными параметрами.<br>
Событие с правильными параметрами должно переключать страницы в эфирной сетке.
</translate>
<translate>
<!--T:6-->
=== '''Создание трансляции в личном кабинете''' ===
После настройки серверной части пользователь сможет воспользоваться подготовкой событий для воспроизведения их в трансляции.<br>
Чтобы начать работу с событиями в трансляции пользователю необходимо сначала авторизоваться в личном кабинете.<br>
Следующим шагом пользователю найти в личном кабинете раздел "Трансляции" и выбрать категорию "Создать". 
[[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]]
После выделения зоны для контента пользователь может индивидуально настроить зону с контентом, в соответствии со своими нуждами.<br>
Проделав действия, описанные выше пользователю необходимо выбрать страницу с контентом и открыть настройки страницы по иконке в левой нижней части личного кабинета. Настройки страницы откроются также в тулбаре справа, как и настройки для зоны контента.
[[File:Иконка настройки_страницы.png|thumb|center| Пример отображения иконки для перехода в настройки страницы |800px]]
В настройках страницы пользователю необходимо найти строку с параметром "Событие" и нажать на иконку в виде "+". 
[[File:События_для_страницы.png|thumb|center| Пример отображения строки с параметром "Событие" |800px]]
Данное действие откроет новое окно со списком событий для данной страницы.
</translate>
<translate>
<!--T:7-->
=== '''Настройка события''' ===
Проделав действия, описанные ранее пользователю откроется окно с выбором событий. В данном окне будет три доступных варианта:
# Распознавание лица
# RFID метка
# Серверное приложение (нужный вариант)
[[File:Событие_серверное_приложение.png|thumb|center| Пример отображения вариантов событий при создании трансляций |800px]]
Пользователь выбирает событие "Серверное приложение" и ему добавится новая строка для заполнения "Ключ". В ней необходимо выбрать вариант "По полезной нагрузке".
[[File:Выбрать_ключ.png|thumb|center| Пример отображения поля "Ключ" и его значения|800px]]
Выбрав данный ключ пользователю станет доступна еще одна строка - "Значение". В этой строке пользователь и должен указать одно из специальных значений:
{| class="wikitable"
|+ Таблица значений
|-
! Название !! Значение
|-
| Пересечение линии || ivs.vca.line_detection.event/started
|-
| Вход в зону || ivs.vca.field_detection.event.enter/started
|}
[[File:Значение_ивента.png|thumb|center| Пример отображения поля с прописанным значением|800px]]
После завершения заполнения всех полей в окне пользователю необходимо нажать на кнопку "Сохранить" в центре экрана.
== '''Связанная информация''' ==
Для дальнейшего завершения настройки трансляции рекомендуется ознакомиться со следующими Wiki-страницами
* [[Раздел "Трансляции"]]
* [[Раздел "Расписание"]]
== '''Итог''' ==
После завершения настройки личного кабинет ivideon, интеграции с серверными приложением SmartPlayer и настройки трансляции с использованием событийной модели в личном кабинете SmartPlayer должно начать функционировать. Данное решение будет проигрывать и изменять контент при любом приближении человека в рамках выбранной и настроенной на камере зоны.
== '''Видеоинструкция''' ==
[https://www.youtube.com/watch?v=NpgP-P1Q6f4 Настройка интеграции ivideon и SmartPlayer]
== '''Дополнительная информация''' ==
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.
[[File:Обсуждение_интеграции_с_ivideon.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
</translate>