update_units

Для добавления, удаления или очистки объектов, отслеживаемых в сессии, используйте метод events/update_units.

Для отслеживания ресурсов, а также объектов используйте events/update_items. Для новых интеграций используйте events/update_items.

Формат запроса зависит от режима работы.

Для добавления определённых объектов в сессию используйте следующий запрос:

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": <long>,
      "detect": {
        "<detector_name>": <long>
      }
    },
    ...
  ],
  "evt_flags": <uint>   /* необязательный */
}

Для удаления определённых объектов из сессии используйте следующий запрос:

svc=events/update_units&params={
  "mode": "remove",
  "units": [
    <long>
  ]
}

Для удаления всех объектов из сессии используйте следующий запрос:

svc=events/update_units&params={
  "mode": "clear"
}

В объекте detect можно настроить следующие детекторы событий. Для каждого детектора укажите значение фильтра, которое выбирает события для отслеживания: конкретный ID или тип, либо 0 для отслеживания всех событий этого детектора.

"detect":{"<detector_name>":<filter_value>}

В таблице перечислены детекторы, доступные для объектов. Для отслеживания назначений водителей, зарегистрированных для ресурса, используйте детектор resource_drivers с events/update_items и укажите ID ресурса.

Детекторы battery_level, charge и ev используют следующие настройки датчика уровня заряда: Рассчитывать данные по датчику, Тип фильтрации, Минимальный объём зарядки (кВт·ч), Искать зарядки только при остановке и Таймаут для разделения зарядок. Если настройка Рассчитывать данные по датчику отключена, для датчика не регистрируются события.

Детекторы регистрируют уровень заряда батареи и зарядку, но не разрядку батареи. Математическая модель расхода, датчики двигателя и датчики температурного коэффициента не учитываются.

Детектор eco_driving недоступен в Wialon Local.

Чтобы добавить все доступные детекторы событий, используйте:

"detect":{"*":0}

В режиме add добавляются только те объекты, на которые текущий пользователь имеет права доступа на просмотр. Если указанный объект уже отслеживается, его конфигурация детекторов заменяется. Недопустимые значения отдельных фильтров детекторов игнорируются.

Параметр evt_flags сохраняется в сессии и управляет способом доставки обновлений событий. Значение по умолчанию — 0.

Комбинируйте флаги детализации ниже с 0x200. Если флаги детализации не указаны, используется значение 0x7 (0x1 | 0x2 | 0x4).

Например, evt_flags = 0x207 включает режим units_update (0x200) с основными данными события, данными, зависящими от детектора, и видимыми параметрами сообщения (0x1 | 0x2 | 0x4 = 0x7).

В следующих примерах показано, как настроить объект detect при добавлении объектов в сессию.

Для отслеживания событий от всех датчиков зажигания и всех остальных датчиков объекта с ID 1001 используйте один из следующих запросов:

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": 1001,
      "detect": {
        "ignition": 0,
        "sensors": 0
      }
    }
  ]
}

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": 1001,
      "detect": {
        "ignition,sensors": 0
      }
    }
  ]
}

Для отслеживания событий от датчика уровня топлива с ID 2 и другого датчика с ID 6 используйте:

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": 1001,
      "detect": {
        "lls": 2,
        "sensors": 6
      }
    }
  ]
}

При успешном выполнении запроса возвращается следующий результат:

{
  "units": <uint>   /* общее количество объектов, отслеживаемых в сессии */
}

В противном случае возвращается код ошибки.