Настройка Шлюз КРОС для Windows

Материал из ЭЛЕСТА
Перейти к: навигация, поиск

Настройки системы

Базовые настройки ПО содержатся в текстовом файле ...\Program Files\kros-gate\conf\kros.properties.
Для его редактирования можно использовать любой текстовый редактор, поддерживающий кодировку UTF-8, в крайнем случае можно использовать блокнот Windows.

Параметры базовой конфигурации (файл kros.properties)

db.name=jupiter.db
db.password=jupiter
db.path=C:\Program Files\kros-gate\conf
db.username=jupiter

Настройки размещения и параметров соединения с оперативной базой данных. Изменять не рекомендуется!
По умолчанию база данных находится в папке ...\Program Files\kros-gate\conf.
При необходимости (например при увеличении объема больше ожидаемого) файл базы данных может быть перенесен в том числе и на другой физический либо сетевой диск.
В этом случае здесь необходимо указать его новое местоположение.


include=devices,broadcast

Подключение внешних файлов конфигурации приборов и трансляторов. Изменять не рекомендуется!


killer.last.start=2018-10-03 16:36:32
killer.start.at=03:00
killer.storage.period=1440 

Настройки очистки базы данных. Поток данных, получаемых с прибора, для обеспечения гарантированной доставки записывается в оперативную базу данных.
Очистка устаревших записей происходит один раз в сутки в указанное в настройках время.За это отвечает параметр killer.start.at.
Данные хранятся в течение периода, указанного в параметре killer.storage.period (в минутах).
Период отсчитывается от момента сохранения записи в базу данных. Параметр killer.last.start является служебным, служит для расчета времени старта очистки и обновляется автоматически после каждого ее запуска.


receiver.TcpPK4Jupiter.active=true
receiver.TcpPK4Jupiter.ports=10000
receiver.UdpPK4Jupiter.active=true
receiver.UdpPK4Jupiter.ports=10000

Раздел настроек драйверов приемников для приборов ППКОП/УОО (ПК4/ПК5).
Для каждого драйвера можно определить его активность и список прослушиваемых системой портов.
Указанные выше настройки означают что ПО будет ожидать соединение от приборов на портах TCP 10000 и UDP 10000.


receiver.UdpRoot.active=true
receiver.UdpRoot.auto=true
receiver.UdpRoot.ports=10000
receiver.UdpRoot.ssl=false

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


server.log.count=3
server.log.path=C:\Program Files\kros-gate\logs
server.log.size=64000000

Параметры настройки протоколирования.
В процессе работы ПО записывает подробный протокол, который может оказаться незаменим при сбоях, восстановлении данных, поиске причин неисправностей.
При продолжительной работе размер файлов протоколов может возрасти до недопустимого значения. Для решения этой проблемы предназначены эти параметры.
Параметр server.log.size определяет максимальный размер одного файла протокола. Если размер превышает ограничение будет создана резервная копия текущего файла протокола, его размер будет обнулен.
Параметр server.log.count определяет количество одновременно хранимых резервных копий. При создании очередной копии при превышении ограничения количества самая старая копия будет удалена.
Параметр server.log.path определяет место хранения файлов протокола.


server.threads.max.udp=1000
server.udp.buffersize=8192

Служебные параметры оптимизации работы с UDP соединениями. Изменять не рекомендуется!


transmitter.TcpSurgard.active=true
transmitter.TcpSurgardV4.active=true

Базовые параметры драйверов передатчиков. Определяют активность драйверов в системе. Если запретить какой-то из драйверов, то трансляторы, настроенные на работу с ним, запускаться не будут. Подробнее см. раздел по настройке трансляции.

Параметры трансляции (файл broadcast.properties)

Если в системе не создано ни одного транслятора, то данные, поступающие от приборов, будут просто записываться в базу данных.
Для передачи данных во внешнюю систему необходимо настроить параметры транслятора.
Настройки трансляторов должны располагаться в файле ...conf/broadcast.properties который может быть открыт любым текстовым редактором.
Трансляторов может быть несколько. Различаются они своими условными именами. Принадлежность параметра тому или иному транслятору определяется префиксом заголовка.
Например параметры

broadcast.TestBroadcast.active=true
broadcast.TestBroadcast.active.transmitter=TcpSurgard

относятся к транслятору с именем TestBroadcast. Параметры

broadcast.CoolestThing.connect.port=30000
broadcast.CoolestThing.context.connect.address=192.168.1.88

относятся к транслятору с именем CoolestThing.


Параметры файла broadcast.properties:

broadcast.TestBroadcast.active=true
broadcast.TestBroadcast.active.transmitter=TcpSurgard

Активация транслятора и задание для него драйвера передатчика.
В случае изменения параметра active на false транслятор останется в системе, но для него не будут поступать данные в очередь на передачу.
Параметр active.transmitter задает используемый для трансляции драйвер передатчик. Количество и состав списка доступных драйверов зависит от конкретного комплекта поставки.
В базовый комплект входят два драйвера для трансляции данных в формате Surgard - TcpSurgard (стандартный базовый протокол) и TcpSurgardV4 (протокол 4-й версии с идентификацией по IMEI).


broadcast.TestBroadcast.context.connect.address=192.168.1.88
broadcast.TestBroadcast.context.connect.port=30000
broadcast.TestBroadcast.context.connect.ssl=false
broadcast.TestBroadcast.context.connect.timeout=120000
broadcast.TestBroadcast.context.connect.pingPeriod=10

Настройки соединения с внешней системой. Раздел, как видно, имеет префикс имени параметра connect. Для трансляторов Surgard предусмотрены следующие параметры:

  • address - IP адрес приемника для TCP соединения,
  • port - порт приемника для TCP соединения,
  • ssl - переключатель режима SSL шифрования,
  • timeout - таймаут соединения и ожидания данных для TCP протокола,
  • pingPeriod - периодичность отправки PING пакетов принимающей стороне.

broadcast.TestBroadcast.context.options.decimal=false
broadcast.TestBroadcast.context.options.ignoreErrors=false
broadcast.TestBroadcast.context.options.test=true

Параметры транслятора:

  • decimal - определяет формат представления идентификатора прибора при формировании пакета для передачи. true - идентификатор преобразуется к десятичному формату, false - к шестнадцатеричному.
  • ignoreErrors - способ реакции на ошибки. false - в случае возникновения ошибки передачи пакет будет возвращено в очередь и попытки будут повторяться до успешной отправки, true - после неудачной отправки пакет будет удален из очереди.
  • test - тестовый режим. Имитация полноценной работы транслятора без попыток реального подключения к внешнему приемнику.

broadcast.TestBroadcast.context.event.10121=false,E121,Тревога, принуждение
broadcast.TestBroadcast.context.event.10122=false,E122,Тихая тревога
broadcast.TestBroadcast.context.event.10123=false,E123,Тревога ШС
broadcast.TestBroadcast.context.event.10137=false,E137,Взлом

Для каждой трансляции может быть добавлена индивидуальная таблица преобразования сообщений.
Изначально этой таблицы нет в поставляемом базовом файле конфигурации, она формируется при первом запуске Шлюз КРОС в момент инициализации трансляции.
Таблица включает описание всех обрабатываемых ПО сообщений и имеет следующий формат:

BroadcastTable.png

Для модификации доступны поля Признак блокировки, Код сообщения Surgard и Текст сообщения.
Таким образом имеется возможность заблокировать ненужные сообщения, переназначить для сообщения результирующий Surgard код
либо скорректировать текст сообщения (в текущей версии Шлюз КРОС текст сообщения отображается только в тексте протоколов).

Параметры приборов (файл devices.properties)

Система принимает соединение от любых приборов, работающих по протоколу ПК4 или ПК5.
Если на момент соединения прибор не зарегистрирован в базе данных, то создается новая запись о приборе, его конфигурации и состоянии.
Кроме того идентификационная информация сохраняется в файле devices.properties.
Запись о приборе в этом файле имеет следующую структуру:

DeviceTable.png

Для модификации доступны Идентификатор для пакета Surgard и Ключ шифрования.

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

Ключ шифрования представляет собой 32-байтное значение, используемое для шифрования пакетов ПК4 и доступное для изменений в конфигураторе прибора.
Для вновь подключаемых приборов предполагается значение ключа шифрования устанавливаемое при производстве прибора по умолчанию - 01010101…
Необходимость изменения значения ключа в файле devices.properties может возникнуть в двух случаях:

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

ВНИМАНИЕ! Длина строки ключа шифрования должна быть ровно 64 символа и содержать только символы 16-го представления числа - 0..9,A,B,C,D,E,F.