View Source

Сервис HtBvmsSdkApi - это приложение для работы с API системы BVMS. Так как API BVMS работает по технологии WCF, приложение HtBvmsSdkApi может работать только на ОС Windows.

Установка HtBvmsSdkApi

Рекомендуется устанавливать службу HtBvmsSdkApi на той же машине, где находится сервер BVMS

для установки службы запустите с правами администратора установочный файл "HtBvmsSdkApi.{версия}.install.exe";

СФЕРА-Мониторинг v1.0 > 3.3.4.4 Сервис SferaMonitoring.BvmsSdkApi > image-2024-6-20_17-48-12.png (Выбор пути установки HtBvmsSdkApi)

По умолчанию, интеграционное решение устанавливается в папку "C:\Integration\SferaMonitoring\HtBvmsSdkApi".

нажмите на кнопку "Далее". Откроется окно для подтверждения установки;
нажмите на кнопку "Установить", после чего начнётся копирование файлов интеграционного решения;

СФЕРА-Мониторинг v1.0 > 3.3.4.4 Сервис SferaMonitoring.BvmsSdkApi > image-2024-6-20_17-50-41.png (Процесс копирования файлов)

для завершения установки нажмите кнопку "Завершить".

СФЕРА-Мониторинг v1.0 > 3.3.4.4 Сервис SferaMonitoring.BvmsSdkApi > image-2024-6-20_17-51-29.png (Завершение установки)

Настройка экземпляра службы

Для работы службы HtBvmsSdkApi необходимо настроить экземпляр службы. Для этого:

скопируйте файл "C:\Integration\SferaMonitoring\HtBvmsSdkApi\Settings\_samples\BvmsSettingsSample.json" в папку "C:\Integration\SferaMonitoring\HtBvmsSdkApi\Settings\Instances" ;

В папке "Instances" уже присутствует файл "BVMS.json", если требуется только один экземпляр службы, то рекомендуется использовать его.

переименуйте скопированный файлBvmsSettingsSample.json в название инстанса;
перейдите в папку "C:\Integration\SferaMonitoring\HtBvmsSdkApi\Setup";
откройте на редактирование файл "_install.bat" и измените в команде параметр "-instance:BVMS" на -instance:{название инстанса};

Если используется только один экземпляр службы (по умолчанию "BVMS"), то изменять "_install.bat" не требуется.

запустите с правами администратора файл "_install.bat", после чего в системе появится новый экземпляр службы, с указанным инстансом;

СФЕРА-Мониторинг v1.0 > 3.3.4.4 Сервис SferaMonitoring.BvmsSdkApi > image-2024-6-21_9-41-43.png

Настройка HtBvmsSdkApi

Для настройки, откройте на редактирование файл инстанса. Например, для инстанса "BVMS" это будет "C:\Integration\SferaMonitoring\HtBvmsSdkApi\Settings\Instances\BVMS.json".

Описание настроек приведено в таблице.

ApiOptions	Настройки API	Значения по умолчанию, допустимые значения, примеры значений
Url	Точка доступа для подключения сервиса SferaMonitoring	"http://*:7001"
BvmsSdkOptions	Настройки BVMS SDK
ServerAddress	IP-адрес и порт BVMS SDK	Пример: "127.0.0.1:5390"
User	Имя пользователя	Пример: "username"
Password	Пароль	Пример: "password"
MonitoringOptions	Настройки системы мониторинга
MonitoringAddress	Адрес для подключения к системе мониторинга	Формат адреса: "{IP адрес или доменное имя}: 55851" Пример: "192.168.77.236:55851"
ProcessName	Имя процесса, которое будет отображаться в системе мониторинга. При использовании нескольких инстансов, в каждой настройке, в данное поле, необходимо ввести уникальное имя.	Пример: "BVMS"

Запуск HtBvmsSdkApi

откройте окно "Службы" (для этого нажмите Win+R и введите "services.msc")
для каждого экземпляра службы, найдите службу с названием HtBvmsSdkApi${название инстанса}, кликните по ней правой кнопкой мыши и выберите команду "Запустить"

СФЕРА-Мониторинг v1.0 > 3.3.4.4 Сервис SferaMonitoring.BvmsSdkApi > image-2024-6-21_10-20-31.png (Запуск экземпляра службы HtBisSdkApi с инстансом "BVMS")

после запуска, проверьте лог "BisSdkService.log" для каждого инстанса (например "C:\Integration\SferaMonitoring\HtBvmsSdkApi\Logs\BVMS\BvmsSdkService.log"). В файле лога не должно быть ошибок. При успешном подключении к SDK BVMS должна появится запись: "BVMS SDK service is Ok".

для отслеживания работы сервиса можно использовать систему мониторинга iMon (см. раздел 5.1 Описание работы системы мониторинга iMon )

СФЕРА-Мониторинг v1.0 > 3.3.4.4 Сервис SferaMonitoring.BvmsSdkApi > image-2024-6-21_10-24-28.png (Мониторинг с помощью iMon)