⌂ > 🛠 Конфигурационный REST API > ⇄ Путь

platescomplete : Изменение настроек модуля Распознавание автономеров (Complete)🔗

Примечание

Появилось в версии 3.4.

Примечание

Обновлено в версии 4.6.

Предупреждение

Доступно только в лицензиях Enterprise и ULTRA.

Данный запрос может выполняться только пользователем с максимальными правами, то есть входящим в группу Старшие администраторы.

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Параметры🔗

Параметр	Описание	Тип
Enabled	Включён ли модуль. Допустимые значения: true — включён, false — выключен	bool
ChannelSettings	Настройки модуля Распознавание автономеров (Complete) специфичные для конкретной камеры.	class
.PlateMinSize	Минимальная ширина номерной пластины, выражаемая в долях от ширины кадра (например, 0.5 — половина ширины кадра). Допустимые значения: [0; 1], строго меньше PlateMaxSize	double?
.PlateMaxSize	Максимальная ширина номерной пластины, выражаемая в долях от ширины кадра (например, 0.5 - половина ширины кадра). Допустимые значения: [0; 1], строго больше PlateMinSize	double?
.AutoVPRSCountries	Массив распознаваемых шаблонов автономеров. При передаче параметра с PUT-запросом весь массив изменяется как один объект (все старые значения заменяются новыми). Массив с одним элементом. Значения по умолчанию этого элемента описаны ниже	class[]
.DetectionQuality	Качество распознавания. Допустимые значения: "Minimum"; "Low"; "Medium";"High"; "Maximum"	enum
.UsePreciseAnalysis	Включен ли углублённый анализ, позволяющий повысить точность в неблагоприятных условиях. Допустимые значения: true — включено, false — выключено	bool?
.UseExtraAngleAnalysis	Включено ли распознавание автономеров с учётом перспективы. Допустимые значения: true — включено, false — выключено	bool?
.UseExtraRangesAnalysis	Включен ли более тщательный поиск в заданном диапазоне номеров. Включение позволяет повысить точность распознавания, когда разница между минимальным и максимальным размерами номера больше чем в 3 раза. Допустимые значения: true — включено, false — выключено	bool?
.UseNnDetector	Используется ли нейросеть для обнаружения номерной пластины. Допустимые значения: true — используется, false — не используется	bool?
.UnrecognizedSymbolsMaxCount	Максимально допустимое количество нераспознанных символов для генерации события распознавания автономера. Допустимые значения: [0; 10]	uint?
.PluginUseAutoSave	Включено ли автосохранение кадров на диск. Допустимые значения: true — включено, false — выключено	bool?
.AutoSaveFullPath	Абсолютный путь папки с сохранёнными кадрами на сервере. Если включена функция автосохранения кадров на диск. Если включена функция автосохранения кадров на диск PluginUseAutoSave, то значением должна быть непустая строка, соответствующая формату UNC (зависит от операционной системы, на которой работает сервер)	string
.AutoSaveMaxFolderSize	Максимальный размер папки с сохранёнными кадрами в МБ. Допустимые значения: [500; 1000000000]	int?
.PolygonZones	Массив зон поиска автономеров. При передаче параметра с PUT-запросом весь массив изменяется как один объект (все старые значения заменяются новыми). Массив с допустимым количеством значений [1; 6]	class[]
.DbId	Идентификатор используемой базы данных. Можно указать одинаковый идентификатор для нескольких камер, тогда они будут взаимодействовать с одной и той же базой. Для данного параметра игнорируется регистр. Пример: при значениях "myperfectdb" и "MyPeRfeCtDb" будет создана и использована одна и та же БД. Пустая строка - использование общей базы, непустая строка - использование уникальной базы. Идентификатор должен быть длиной не более 32-х символов, содержать латинские буквы, цифры и нижнее подчёркивание (_), в противном случае уникальная база не задастся	string
.TimeSecNotRecognizeSamePlate	Время блокировки повторного распознавания в секундах. Допустимые значения: [0; 300]	int?
.UseDirection	Нужно ли определять направление въезда. Допустимые значения: true — определять направление движения, false — не определять направление движения	bool?
.Direction	Направление перемещения номера при въезде. Используется только когда включена опция определения движения UseDirection. Допустимые значения: 3 — вверх; 4 — верхний правый угол; 5 — вправо; 6 — правый нижний угол; 7 — вниз; 8 — нижний левый угол; 9 — влево; 10 — левый верхний угол.	int?
.DirectionFilterTypes	Массив чисел, каждое из которых обозначает направление движения. При движении автономера в направлении, которое указано в массиве, автономер не учитывается. Используется только когда включена опция определения движения UseDirection. Допустимые значения: 0 или пустой массив — учитывать всегда; 1 — не распознавать при въезде; 2 — не распознавать при выезде; 4 — не распознавать при неопределённом направлении	int[]
.PluginBarrierControlEnabled	Включён ли режим управления шлагбаумом. Допустимые значения: true — включён, false — выключен	bool?
.PluginBarrierManualControlEnabled	Включён ли ручной способ управления шлагбаумом. Допустимые значения: true — включён, false — выключен	bool?
.PluginBarrierAutomaticControlEnabled	Включён ли автоматический (по распознаванию номера) способ управления шлагбаумом. Допустимые значения: true — включён, false — выключен	bool?
.IsBarrierSupportAutoClose	Нужно ли автоматически закрывать шлагбаум после автоматического открытия. Допустимые значения: true — закрывать, false — не закрывать	bool?
.PluginBarrierAutomaticCloseTimeDelay	Задержка перед автоматическим закрытием в секундах. Используется если включено автоматическое закрытие шлагбаума IsBarrierSupportAutoClose. Допустимые значения: [1; 1000000000]	int?
GeneralSettings	Общие для всех камер настройки модуля Распознавание автономеров (Complete), применяемые ко всем каналам с включённым модулем	class
.DatabaseSettings	Настройки доступа к базе автономеров PostgreSQL	class
.ParkingSettings	Настройки режима парковки	class

Примечание

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

Описание параметра ChannelSettings.AutoVPRSCountries[i]:

Параметр	Описание	Тип
FeatureId	Идентификатор сущности, описывающей страну в SDK модуля (подробнее см. api/platescomplete/allowedfeatures)	int?
DllName	Имя dll-файла в SDK модуля, который необходим для распознавания шаблонов страны с соответствующим FeatureId (подробнее см. api/platescomplete/allowedfeatures)	string
AutoTemplates	Массив идентификаторов шаблонов (изображений) автономеров (подробнее см. api/platescomplete/allowedfeatures)	int[]

Совет

Для корректного конфигурирования этого свойства следует выполнить несколько шагов:

1. Получить список доступных на сервере шаблонов при помощи запроса api/platescomplete/allowedfeatures.

Выбрать нужные объекты из массива, полученного в ответе.
Сформировать из выбранных объектов массив.
Вставить сформированный массив как значение этого свойства при отправке PUT-запроса.

Описание параметра ChannelSettings.PolygonZones[i]:

Параметр	Описание	Тип
Id	Идентификатор зоны. Строка, содержащая идентификатор в формате GUID	GUID
Name	Название зоны. Непустая строка	string
Points	Зона, заданная массивом последовательно указанных через запятую вершин полигона. Вершина - точка, описанная в формате "x,y". Полигон - многоугольник, образованный замкнутой ломаной линией, не пересекающей самой себя. Массив, содержащий минимум 3 точки в формате "x,y", где: x,y - double; 0 <= x <= 1; 0 <= y <= 1. Точки должны быть указаны в таком порядке, чтобы при последовательном их соединении отрезками, отрезки бы не пересекали друг друга. Значение по умолчанию: ["0,0", "1,0", "1,1", "0,1"]	Point[]

Описание параметра GeneralSettings.DatabaseSettings:

Параметр	Описание	Тип
IsDedicated	Локальная или удалённая база данных используется. Если выбрана удалённая база данных, для конфигурирования доступа к ней используются остальные настройки из раздела DatabaseSettings. Допустимые значения: true — включён, false — выключен.	bool?
IpAddress	IP-адрес удалённой БД. Непустая строка, содержащая IPv4 адрес. Значение по умолчанию: "127.0.0.1"	string
Port	Порт удалённой БД. Допустимые значения: [0; 65535]. Значение по умолчанию: 5432	int?
User	Имя пользователя удалённой БД. Непустая строка. Значения по умолчанию: для ОС Windows — "postgres", для ОС Linux — "macroscop".	string
Password	Пароль удалённой БД для пользователя. Непустая строка. Значение по умолчанию: "masterkey"	string
OsType	Операционная система хост-машины, на котором установлена удалённая БД. Допустимые значения: "Windows", "Linux".	enum

Описание параметра GeneralSettings.ParkingSettings:

Параметр	Описание	Тип
ParkingModeEnabled	Включён ли режим отслеживания парковок. Допустимые значения: true — включён, false — выключен	bool?
ParkingZones[]	Массив парковочных зон. При передаче параметра с PUT-запросом весь массив изменяется как один объект (все старые значения заменяются новыми). Непустой массив, если режим отслеживания парковок ParkingModeEnabled включён	class[]
.Id	Идентификатор парковочной зоны. При отправке PUT-запроса игнорируется, задаётся на сервере. Строка, содержащая идентификатор в формате GUID	GUID
.Name	Название парковочной зоны. Непустая строка	string
.EntryChannels	Массив GUID-ов камер, установленных на въезде в парковочную зону. Массив строк, каждая из которых содержит идентификатор канала в формате GUID. Необходимо задать хотя бы 1 канал, если режим отслеживания парковок включён	GUID[]
.ExitChannels	Массив GUID-ов камер, установленных на выезде с парковочной зоны. Массив строк, каждая из которых содержит идентификатор канала в формате GUID. Необходимо задать хотя бы 1 канал, если режим отслеживания парковок включён	GUID[]
.StartDateTimeUtc	Временная метка UTC, с которой начинается подсчёт транспортных средств на парковке. Время и дата в формате ISO 8601 "yyyy-mm-ddThh:MM:ssZ"	DateTime?
.ResetPeriod	Периодичность, с которой сбрасывается счётчик транспортных средств. Допустимые значения: "None" - никогда; "Hours12" - раз в 12 часов; "Days1" - раз в сутки; "Days7" - раз в 7 дней	enum?
.AllowedTimeMaxMinutes	Максимальное разрешённое время пребывания автомобиля на парковке. Допустимые значения: [1; 99999]	double?
.ParkingSpacesCount	Количество парковочных мест. Допустимые значения: [1; 99999]	int?

Пример тела PUT-запроса🔗

Пример запроса:

{
    "ChannelSettings": {
        "PlateMinSize": 0.050002,
        "PlateMaxSize": 0.49999,
        "AutoVPRSCountries": [
            {
                "FeatureId": 4002,
                "AutoTemplates": [ 1,2 ],
                "DllName": "vpwi-ru.dll"
            }
        ],
        "DetectionQuality": "Medium",
        "UsePreciseAnalysis": false,
        "UseExtraAngleAnalysis": false,
        "UseExtraRangesAnalysis": false,
        "UseNnDetector": false,
        "UseNnRecognizer": false,
        "UnrecognizedSymbolsMaxCount": 2,
        "PluginUseAutoSave": false,
        "AutoSaveFullPath": null,
        "AutoSaveMaxFolderSize": 2000,
        "PolygonZones": [
            {
                "Id": "49acbac9-97a5-4ada-9e5f-7b9051380bbd",
                "Name": "Зона 1",
                "Points": [
                    "0.5,0.5",
                    "1,0",
                    "1,1",
                    "0,1"
                ]
            }
        ],
        "DbId": "",
        "TimeSecNotRecognizeSamePlate": 0,
        "UseDirection": false,
        "Direction": 3,
        "DirectionFilterTypes": [],
        "PluginBarrierControlEnabled": false,
        "PluginBarrierManualControlEnabled": true,
        "PluginBarrierAutomaticControlEnabled": true,
        "IsBarrierSupportAutoClose": false,
        "PluginBarrierAutomaticCloseTimeDelay": 30
    },
    "GeneralSettings": {
        "DatabaseSettings": {
            "IsDedicated": true,
            "IpAddress": "127.0.0.1",
            "Port": 5432,
            "User": "postgres",
            "Password": "masterkey",
            "OsType": "Windows"
        },
        "ParkingSettings": {
            "ParkingModeEnabled": true,
            "ParkingZones": [
                {
                    "Id": "a87b06de-f52e-4809-a1e7-33dcd0bb4b8a",
                    "Name": "Зона",
                    "EntryChannels": [ "81060b4d-7f0c-47af-8ec1-124dc79fd750" ],
                    "ExitChannels": [ "81060b4d-7f0c-47af-8ec1-124dc79fd750" ],
                    "StartDateTimeUtc": "2024-10-28T07:05:04.6599272Z",
                    "ResetPeriod": "None",
                    "AllowedTimeMaxMinutes": 60.0,
                    "ParkingSpacesCount": 50
                }
            ]
        }
    },
    "Enabled": false
}