⌂ > 🛠 Конфигурационный REST API > ⇄ Путь
PUT /configure/channels/{channel-id}/objectcounting : Изменение настроек модуля Подсчёт объектов🔗
Примечание
Доступно в версии Macroscop 4.6 и выше.
Предупреждение
Доступно только в лицензиях Enterprise и ULTRA.
Данный запрос может выполняться только пользователем с максимальными правами, то есть входящим в группу Старшие администраторы.
Важно
Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.
Параметры🔗
Параметр |
Описание |
Тип |
|---|---|---|
Enabled |
Включён ли модуль. Допустимые значения: true — включён, false — выключен |
bool |
ZoneInfos |
Массив зон, в которых ведется подсчёт объектов. При передаче параметра с PUT-запросом весь массив изменяется как один объект (все старые значения заменяются новыми). Непустой массив с одним элементом. Значения по умолчанию этого элемента описаны ниже |
class[] |
MonitoringZoneIds |
Вычислимое readonly поле. Массив всех идентификаторов зон. ZoneInfos[i].AlertZone.ZoneId. Строка, содержащая идентификатор в формате GUID. |
GUID |
Mode |
Режим работы модуля. Допустимые значения: "Slow", "Medium", "Fast" |
enum |
Примечание
Некоторые параметры необязательны для отправки PUT-запроса. Если для параметра не указано значение по умолчанию, он является обязательным. При отсутствии изменений система сохраняет текущее значение параметров.
Примечание
Настройки данного модуля находятся на одном уровне со свойством Enabled. Все описанные настройки являются специфичными для канала.
Описание параметра ZoneInfos[i]:
Параметр |
Описание |
Тип |
|---|---|---|
AlertZone |
Подобъект настроек зоны |
class |
DetectionClasses |
Массив категорий подсчитываемых объектов. Массив должен содержать хотя бы одно из значений, когда AdvancedSearch включено: "Person" — Люди, "Animal" — Животные, "Vehicle" — Транспортные средства |
enum[] |
DetectionSubClasses |
Массив категорий транспортных средств. Учитывается, когда DetectionClasses содержит "Vehicle". Массив должен содержать хотя бы одно из значений, если DetectionClasses содержит "Vehicle": "Car" — Легковые автомобили, "Bus" — Автобусы, "Truck" — Грузовые автомобили, "Motorbike" — Мотоциклы |
enum[] |
SmoothingMode |
Периодичность усреднения результатов. Используется только когда AlertZone.Type имеет значение "MovingInZone". Допустимые значения: "None" - выключено, "Interval5Sec" - 5 секунд, "Interval10Sec" - 10 секунд, "Interval15Sec" - 15 секунд, "Interval30Sec" - 30 секунд, "Interval1Min" - 1 минута |
enum |
CounterResetSettings |
Настройки сброса счётчика. Используется только когда AlertZone.Type имеет значение "LineIntersection" |
class |
Описание параметра AlertZone:
Параметр |
Описание |
Тип |
|---|---|---|
ZoneId |
Идентификатор зоны. Строка, содержащая идентификатор в формате GUID |
GUID |
Name |
Название зоны. Непустая строка |
string |
Type |
Тип зоны. "LineIntersection" — подсчёт объектов, пересекших линию, в указанном направлении AlertZone.Direction, "MovingInZone" — подсчёт объектов ведется внутри зоны. |
enum |
SmoothingMode |
Периодичность усреднения результатов. Используется только когда AlertZone.Type имеет значение "MovingInZone". Допустимые значения: "None" — выключено, "Interval5Sec" — 5 секунд, "Interval10Sec" — 10 секунд, "Interval15Sec" — 15 секунд, "Interval30Sec" — 30 секунд, "Interval1Min" — 1 минута |
enum |
Points |
Зона, заданная массивом последовательно указанных через запятую вершин полигона. Вершина — точка, описанная в формате "x,y". Полигон — многоугольник, образованный замкнутой ломаной линией, не пересекающей самой себя. Зависит от значения AlertZone.Type. "LineIntersection": Массив, содержащий ровно 2 точки в формате "x,y", образующие отрезок внутри кадра. "MovingInZone": Массив, содержащий минимум 3 точки в формате "x,y". Точки должны быть указаны в таком порядке, чтобы при последовательном их соединении отрезками, отрезки бы не пересекали друг друга. |
Point[] |
Direction |
Направление, в котором засчитывается пересечение линии, когда AlertZone.Type имеет значение "LineIntersection". "DirectionOne" - первое направление; "DirectionSecond" - второе направление; "Both" - оба направления. Примеры различных конфигураций направлений и соответствующих им представлений см. ниже. |
enum |
IsZoneAlert |
Вычислимое readonly поле. Зависит от значения AlertZone.Type: true - "MovingInZone", false - "LineIntersection" |
bool |
Описание параметра CounterResetSettings:
Параметр |
Описание |
Тип |
|---|---|---|
UseCounterReset |
Включен ли сброс счётчиков. Допустимые значения: true — включён, false — выключен |
bool |
ResetStartTimeLocal |
Временная метка UTC, с которой ведется отсчёт периода сброса счётчика. Время и дата в формате ISO 8601 "yyyy-mm-ddThh:MM:ssZ" |
DateTime |
ResetPeriod |
Период сброса счётчиков. Допустимые значения: "EveryTwelveHours" — 12 часов, "EveryDay" — 1 день, "EveryWeek" — 1 неделя |
enum |
Пример запроса🔗
PUT http://localhost:8080/configure/channels/81060b4d-7f0c-47af-8ec1-124dc79fd750/objectcounting
Примеры конфигураций различных направлений🔗
