Elecard ViCont — Начало работы

{
  "last_commit": {
    "date": "2024-11-02 08:53:36 UTC",
    "hash": "190cfde",
    "describe": ""
  },
  "build": {
    "date": "2024-11-02T08:53:51Z",
    "clean repo": true,
    "sphinx version": "sphinx-build 4.5.0",
    "machine": "runner-xwyr7sxp--project-334-concurrent-0"
  },
  "note": ""
}

1. Начало работы

Описание программы

Elecard ViCont — это решение для удаленного управления контентом на экранах в режиме реального времени. Программное обеспечение ViCont работает в клиент-серверном режиме. Клиентская часть представлена плеером, который получает настройки от сервера и проигрывает принимаемый поток, плейлист из медиафайлов или отдельные медиафайлы.

Системные требования

Плеер

Сервер

ОС Linux Ubuntu 22.04

ОС Linux + Docker

OC Android 7+

ОС Linux + Docker

Работа с сервером

Работа с системой ViCont осуществляется посредством браузера.

Поддерживаемые браузеры:

  • Chromium версия 54 и новее

  • Google Chrome версия 54 и новее

  • Mozilla Firefox версия 47 и новее

  • Microsoft Edge версия 100 и новее

Для корректной работы убедитесь, что ваш браузер обновлен до последней версии.

Минимальное разрешение экрана: 1680х1050
На меньших разрешениях корректность отображения интерфейса не гарантируется.

Технические характеристики

Плееры на ОС Ubuntu

Прием потоков

Протоколы: UDP, RTP, SRT
Контейнеры: MPEG2-TS
Форматы видео: MPEG-2, H.264, H.265
Форматы аудио: MPEG-1 Layer II, AAC-LC, HE-AAC v1 & v2
Разрешения: SD, HD, Full HD, 4K

Использование плейлистов из файлов

Контейнеры: MPEG2-TS, MP4
Форматы видео: MPEG-2, H.264, H.265
Форматы аудио: MPEG-1 Layer II, AAC-LC, HE-AAC v1 & v2
Разрешения: SD, HD, Full HD, 4K

Отправка статистики по протоколам: HTTP и SNMP

Плееры на ОС Android

Прием потоков

Протоколы: UDP, RTP, SRT, HLS, MPEG-DASH
Контейнеры: MP4, MPEG2-TS
Форматы видео: MPEG-2, H.264, H.265
Форматы аудио: MPEG-1 Layer II, AAC-LC, HE-AAC v1 & v2
Разрешения: SD, HD, Full HD, 4K

Использование плейлистов из файлов

Контейнеры: MP4
Форматы видео: MPEG-2, H.264, H.265
Форматы аудио: MPEG-1 Layer II, AAC-LC, HE-AAC v1 & v2
Разрешения: SD, HD, Full HD, 4K

Отправка статистики по протоколам: HTTP и SNMP

Установка ПО ViCont

Необходимые условия

Для установки серверной части необходимо наличие следующих компонентов:

  1. Docker. Выберите на данной странице актуальную инструкцию в соответствии с дистрибутивом.

  2. Python 3. Python предустановлен в большинстве дистрибутивов Linux, в том числе Ubuntu. Проверить его наличие и версию можно с помощью команды:

python3 --version

Если Python не установлен, установите его, выбрав подходящую инструкцию на этой странице (на английском языке).

Установка сервера ViCont

Загрузите пакет сервера с именем вида vicont-bundle-<версия>-<тег>.tar.gz и распакуйте его:

tar -xzvf vicont-bundle-<версия>-<тег>.tar.gz

Далее перейдите в папку vicont-bundle:

cd vicont-bundle

Разрешите запуск установочного файла:

chmod +x deploy.sh

Запустите установочный файл:

sudo ./deploy.sh

После установки веб-интерфейс будет доступен по адресу: http://<адрес_сервера>:8090. Вместо адреса сервера укажите любой из имеющихся сетевых интерфейсов.

Для входа в веб-интерфейс используйте следующие данные 1:

Пользователь - admin
Пароль - Adm!nV1-NT
1

Данная учетная запись не может быть удалена.

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

Изменение параметров сервера

Пакет сервера содержит файл .env, в котором прописаны настройки, например номер порта или адрес папки, в которой хранится журнал событий. При необходимости отредактируйте настройки и сохраните файл. Чтобы применить изменения, запустите скрипт deploy.sh, если вы редактировали настройки до установки сервера. В противном случае запустите rebuild.sh.

Обновление сервера

Чтобы обновить сервер, загрузите пакет обновления и распакуйте его в ту же папку, что и первоначальный пакет:

tar -xzvf vicont-bundle-<версия>-<тег>.tar.gz

Перейдите в папку с пакетом обновления vicont-bundle:

cd vicont-bundle

Разрешите запуск установочного файла:

chmod +x deploy.sh

Запустите обновление сервера:

sudo ./deploy.sh

Примечание

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

Установка плеера

Плеер можно установить несколькими способами.

Установка через веб-интерфейс

Рекомендуется использовать этот способ установки плеера. Вы также можете загрузить и установить пакет плеера непосредственно на устройство. Этот процесс описан в пункте Автономная установка.

Чтобы установить новый плеер или подключить уже существующий без установки, перейдите на страницу Плееры и нажмите на кнопку Добавить. В открывшемся окне вы можете указать параметры плеера или импортировать список плееров, используя CSV-файл.

Для добавления плеера через форму ввода укажите следующие параметры:

  • Имя (обязательный параметр) — имя для идентификации плеера.

  • Описание — дополнительная информация для добавляемого плеера.

  • MAC-адрес (обязательный параметр) — MAC-адрес сетевого интерфейса компьютера, на котором будет работать плеер.

  • Группа — выбор группы, в которую нужно добавить плеер при необходимости. Группы используются для массового управления плеерами. Если группа не указана, будут использоваться индивидуальные параметры плеера.

  • Пакет — выбор версии пакета плеера, если требуется установка нового плеера. В противном случае оставьте в поле значение Без установки.

Чтобы установить новый плеер на ОС Ubuntu, также укажите:

  • IP-адрес и Порт (обязательные параметры) — данные компьютера для подключения к нему по протоколу SSH. По умолчанию используется порт 22.

  • Имя пользователя и Пароль (обязательные параметры) — учетные данные для удаленного подключения к компьютеру. От имени выбранного пользователя будет выполняться вход в систему и загрузка плеера.

_images/adding_players_with_install_ubuntu_ru.png

Чтобы установить новый плеер на ОС Android, также укажите:

  • IP-адрес и Порт (обязательные параметры) — данные компьютера для подключения к нему через утилиту adb. По умолчанию используется порт 5555.

_images/adding_players_with_install_android_ru.png

После ввода всех параметров нажмите на кнопку Применить.

Вы можете одновременно добавить несколько плееров через специальный шаблон в CSV-формате. Чтобы скачать форму шаблона, нажмите на кнопку Шаблон CSV. Заполните форму и загрузите ее, нажав на кнопку Импорт из CSV. Проверьте импортированные параметры и примените изменения.

Автономная установка

Загрузите ZIP-архив на компьютер, на котором должен быть установлен плеер. Для этого кликните на значок шестерёнки в правом верхнем углу экрана и выберите раздел Пакеты плееров. На открывшейся странице выберите нужный пакет плеера на ОС Ubuntu или Android и в столбце Управление нажмите на появившуюся кнопку скачивания.

Установка плеера на ОС Ubuntu

Примечание

Для автономной установки плеера пользователь должен обладать правами sudo.

  1. Распакуйте скачанный ZIP-архив с плеером на OC Ubuntu в выбранную вами папку:

    unzip <имя архива>
    

    В архиве находятся следующие файлы:

    • Инструкции по установке плеера на русском и английском языках (readme)

    • Конфигурационный файл (config.json)

    • Архив с пакетом плеера (tar.gz)

    • Файл инсталляции (install)

  2. Перейдите к файлу config.json и убедитесь, что адрес сервера ViCont указан верно:

    "server": {
        "address": "127.0.0.1",
        "port": 8090
    }
    
  3. В строке address задайте актуальное значение IP-адреса, а в строке port — актуальное значение порта.

  4. Запустите установку плеера от пользователя с правами sudo:

    sudo ./install -p <путь к пакету плеера> -u <имя пользователя>
    

    Вместо <путь к пакету плеера> и <имя пользователя> укажите путь до пакета и имени пользователя, от имени которого будет запускаться плеер, например:

    sudo ./install -p ./Elecard.Player-1.2.9.tar.gz -u user
    
  5. Перезагрузите компьютер:

    sudo reboot
    

После перезагрузки плеер автоматически загрузится, подключится к серверу и начнет проигрывание потока или файлов в соответствии с плейлистом. При отсутствии потока или файлов будет показываться черный экран.

Установка плеера на ОС Android

Плеер на ОС Android поставляется в APK-формате. Его можно установить двумя способами.

Способ 1: c помощью утилиты adb

  1. Распакуйте скачанный ZIP-архив с плеером на ОС Android в выбранную вами папку.

    В архиве находятся следующие файлы:

    • Инструкции по установке плеера на русском и английском языках (readme)

    • Архив с apk-пакетом плеера (tar.gz)

  2. Распакуйте tar.gz-архив с пакетом плеера.

  3. Включите режим разработчика на Android-устройстве.

  4. Если на вашем компьютере нет утилиты adb, скачайте ее. Перейдите по ссылке и в разделе Загрузки выберите версию, подходящую для вашего компьютера. Кликните по названию выбранной версии, чтобы скачать ZIP-архив с утилитой.

  5. Распакуйте архив в папку на компьютере и перейдите к ней с помощью терминала.

  6. Подключитесь к Android-устройству:

    adb connect <IP-адрес Android-устройства>:5555
    
  7. Установите пакет плеера из архива:

    adb install <путь к пакету плеера>
    

    Вместо <путь к пакету плеера> укажите путь до устанавливаемого пакета, например:

    adb install C:\Android\Elecard.Player-0.1.26.apk
    
  8. Запустите плеер:

    adb shell am start -n com.elecard.vicont.player/com.elecard.vicont.player.MainActivity
    

Способ 2: установка непосредственно на устройство

  1. Скачайте, распакуйте и установите пакет плеера (APK) непосредственно на Android-устройство.

  2. Запустите плеер кликом по иконке Vicont Player.

Независимо от способа установки при первом запуске плеера на ОС Android будет показан экран, где необходимо ввести IP-адрес и порт сервера. Введите адрес и порт и нажмите CONNECT.

_images/android_start_screen.png

Примечание

Плееры, установленные в автономном режиме, можно добавить в веб-интерфейсе ViCont на вкладке ПлеерыНезарегистрированные плееры.

Добавление новых пользователей

Для добавления нового пользователя кликните на значок шестерёнки в правом верхнем углу экрана и выберите раздел Пользователи. На открывшейся странице нажмите на кнопку Добавить. Укажите имя пользователя, его роль, пароль для входа в систему. Описания ролей даны ниже:

  • Гость — ознакомительный доступ, позволяющий просматривать все страницы и данные, без возможности вносить какие-либо изменения. Эта роль также не позволяет изменять свои учетные данные.

  • Оператор — полный доступ к системе без возможности работы с пользователями.

  • Администратор — полный доступ к системе, включая возможность добавления и удаления пользователей.

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