Конфиг устройства

Обобщенный вид конфига

{
  	"network": NETWORK,
	"identification": IDENTIFICATION,
	"ntp": NTP,
	"sensors": SENSORS,
	"data_push": DATA_PUSH,
	"meta_info": META
}

NETWORK

Настройки сети на устройстве

{
	"ip": "IP",
	"gateway": "GATEWAY",
	"mask": "MASK",
	"dns": "DNS",
	"dns2": "DNS_2"
}

IP - IP устройства
GATEWAY - адрес шлюза
MASK - маска подсети
DNS - DNS сервер
DNS_2 - второй DNS сервер. доступно только у hikvision и vivotek

IDENTIFICATION

Параметры идентификации устройства

{
	"name": "NAME",
	"device_group": "DEVICE_GROUP",
	"model": "MODEL",
	"firmware": "FIRMWARE",
	"serial": "SERIAL",
	"mac": "MAC",
	"serial_as_name": SERIAL_AS_NAME
}

NAME - имя устройства. Можно изменять в конфигурационном файле
DEVICE_GROUP - группа устройства. Можно изменять в конфигурационном файле
MODEL - модель
FIRMWARE - прошивка
MAC - мак адрес
SERIAL_AS_NAME - флаг использования серийника (или сгенерированного uuid) в качестве имени устройтва. доступно только для brickstream и xovis. Можно изменять в конфигурационном файле
- 0 - не использовать
- 1 - использовать

NTP

Настройки синхронизации времени

{
	"host": "HOST",
	"set_gateway_as_ntp": GATEWAY_AS_NTP,
	"timezone": TIMEZONE,
	"sync_protocol": "SYNC_PROTOCOL",
	"sync_period": "SYNC_PERIOD"
}

HOST - адрес сервера синхронизации времени. Можно изменять в конфигурационном файле
GATEWAY_AS_NTP - использовать шлюз как сервер синхронизации времени. Можно изменять в конфигурационном файле
- true - использовать
- false - не использовать (по умолчанию)
TIMEZONE - сдвиг относительно UTC в часах. Можно изменять в конфигурационном файле
SYNC_PROTOCOL - протокол синхронизации времени (только для brickstream). Можно изменять в конфигурационном файле
- 0 - countmax
- 1 - countmax
- 2 - daytime
- 3 - sntp
SYNC_PERIOD - периодичность синхронизации (только для vivotek). Можно изменять в конфигурационном файле
- hour
- day
- week
- month

SENSORS

Настройки линий детектирования сенсора

[
	...,
    
    {
    	"id": "SENSOR_ID",
  		"height_filter_max": HEIGHT_FILTER_MAX,
  		"height_filter_min": HEIGHT_FILTER_MIN,
  		"human": HUMAN
    },
    
    ...,
]

SENSOR_ID - ID серсора
HEIGHT_FILTER_MAX - максимальное значение фильтра высоты.
- диапазон для hikvision - от 40 до 200
- диапазон для brickstream - от 0 для 255
- максимальное значение для vivotek - 250
- максимальное значение для xovis - 200. 0 - при выключенном фильтре
HEIGHT_FILTER_MIN - минимальное значение фильтра. только для xovis и vivotek
- минимальное значение для vivokek - 80
- минимальное значение для xovis - 80. 0 - при выключенном фильтре
HUMAN - цель. только для vivotek
- true - человек
- false - none

DATA_PUSH

Настройки выгрузок данных с устройства

[
  	...,

    {
        "type": "TYPE",
        "host": "HOST",
        "intervals": INTERVALS,
        "options": OPTIONS,
        "auth": AUTH,
        "path": PATH
    },
  
	...,
]

TYPE

Тип выгрузки

count - выгрузка метрик
record - выгрузка видео. только для xovis, vivotek, brickstream
log - выгрузка логов. только для xovis, vivotek, brickstream
passive_count - выгрузка метрик с датчика агентом (пассивный режим датчика)

HOST

URL для выгрузки данных в формате SCHEME://HOST[:PORT][/PATH]. . Можно изменять в конфигурационном файле

SCHEME - обязательный элемент. доступные значения. http, https, ftp, sftp
HOST - обязательный элемент. принимает ip адрес или доменное имя
PORT - необязательные элемент. при отсутствии будут браться порты по умолчанию
PATH - необязательный параметр

В выгрузках с TYPE==passive_count валидация поля не происходит.

INTERVALS

Интервалы сбора/выгрузки данных

{
	"push": INTERVALS_PUSH,
  	"aggregation": INTERVALS_AGGREGATION
}

INTERVALS_PUSH - интервал выгрузки данных в секундах. Можно изменять в конфигурационном файле
- brickstream
  - http выгрузки - 0, 60, 900, 1800, 3600
  - ftp выгрузки - 900, 3600, 86400
- hikvision - 60, 300, 600, 900, 1200, 1800, 3600
- vivotek - 60, 300, 900, 1800, 3600, 43200, 86400
- xovis
  - для выгрузок с типом record - 0, 300, 900
  - для выгрузок с типом count - 60, 300, 900, 3600, 86400
  - для выгрузок с типом log - 5, 30, 60, 300, 900, 3600, 86400
INTERVALS_AGGREGATION - интервал сбора данных в секундах. Можно изменять в конфигурационном файле
- brickstream
  - http выгрузки - 60, 300, 900, 1800, 3600
  - ftp выгрузки - 300, 900, 1800, 3600
- hikvision - не используется
- vivotek - 60, 300, 900, 1800, 3600, 43200, 86400
- xovis - 60, 300, 900, 1800, 3600, 21600, 43200, 86400

OPTIONS

Раздел с опциями отдельных устройств

{
	"format": "FORMAT",
	"upload_record": "UPLOAD_RECORD",
  	"device_localtime": "DEVICE_LOCALTIME",
  	"report_lite_mode": "REPORT_LITE_MODE"
}

FORMAT - формат http выгрузок. только для vivotek и xovis. Можно изменять в конфигурационном файле
- vivotek - 'xml', 'json', 'csv'. 'xml' - по умолчанию
- xovis - 'xml_v1', 'xml_v2', 'json'. 'xml_v1' - по умолчанию
UPLOAD_RECORD - используется только в hikvision. только для FTP выгрузок. Флаг выгрузки видео. Можно изменять в конфигурационном файле
- 0 - не выгружать
- 1 - выгружать
DEVICE_LOCALTIME - используется только в vivotek. Флаг установки времени устройства в выгрузке. Можно изменять в конфигурационном файле
- 0 - не устанавливать
- 1 - устанавливать
REPORT_LITE_MODE - используется только в vivotek. Флаг скрытия даты при нулевых счетчиках. Можно изменять в конфигурационном файле
- 0 - выключено
- 1 - включено

AUTH

Параметры для авторизации на сервере выгрузок. Пока только для FTP выгрузок

{
	"user": "USER",
	"password": "PASSWD"
}

USER - имя пользователя. Можно изменять в конфигурационном файле
PASSWD - пароль. Можно изменять в конфигурационном файле

PATH

Параметры сохранения на FTP сервере

{
	"location": "LOCATION",
	"filename": "FILENAME"
}

LOCATION - папка сохранения выгрузки/видео. Можно изменять в конфигурационном файле
- {{device_id}} - заменяется на id устройства
- {{device_host}} - заменяется на адрес устройства
- {{device_serial}} - заменяется на серийник устройтва
- {{device_mac}} - заменяется на мак адрес устройства
FILENAME - имя файла. только для brickscream. Можно изменять в конфигурационном файле