avl_evts

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

https://<host>/avl_evts?sid=<text>

Запрос должен содержать следующий параметр:

Если запрос выполнен успешно, ответ возвращается в следующем формате:

{
  "tm": <uint>,                        /* Время сервера. */
  "events": [                          /* События. */
    {
      "i": <long>,                     /* ID элемента. */
      "t": "<text>",                   /* Тип события: m — сообщение, u — обновление, d — удаление. */
      "d": {                           /* Описание события. Зависит от типа события. Не указывается для событий удаления (t: "d"). */
        ...
      }
    }
  ],
  "sensors": [
    {
      "i": <uint>,                     /* ID объекта. */
      "d": {                           /* Объект с данными датчиков. */
        "<sensor_id>": {
          "value": <double|text>,      /* Значение датчика (числовое или текстовое). */
          "format": {
            "value": <text>            /* Форматированное значение датчика. */
          }
        }
      }
    }
  ],
  "units_update": {                    /* Обновления событий от детекторов. Возвращается только в режиме 0x200. */
    "<item_id>": [                     /* ID элемента. */
      {
        "<detector_name>": {           /* Данные детектора. Зависят от детектора и флагов детализации. */
          ...
        }
      }
    ]
  }
}

Поле sensors содержит рассчитанные значения датчиков для объектов, по которым поступили новые сообщения с данными с момента последнего запроса avl_evts. Оно позволяет получать обновления значений в реальном времени без отправки отдельных запросов для расчета датчиков.

• Если ни у одного объекта нет новых значений датчиков, поле sensors возвращает пустой массив.
• Каждый элемент массива содержит данные по одному объекту (идентифицируется по i — ID объекта).
• Объект d содержит данные датчиков, где ключами являются ID датчиков.

Формат значения датчика в ответе зависит от типа датчика.

Следующие датчики возвращают текстовые значения:

• произвольные датчики с включенной опцией Текстовые параметры;
• датчики типов Назначение водителя, Назначение прицепа, Датчик пассажиров.

Все остальные датчики возвращают числовые значения.

Поле units_update содержит обновления событий от элементов, добавленных в сессию с помощью events/update_items или events/update_units. Элементами могут быть объекты или ресурсы. Поле возвращается только в том случае, если параметр evt_flags этих методов включает значение 0x200.

Чтобы получать обновления назначений водителей, используйте events/update_items: добавьте ресурс в сессию и установите детектор resource_drivers.

Данные идентичны тем, которые возвращает events/check_updates. Они сгруппированы по ID элемента, и для каждого элемента содержат массив объектов детекторов. Структуру объектов детекторов см. в описании метода events/check_updates.

Каждый ответ содержит только обновления, зарегистрированные с момента предыдущего запроса avl_evts. Если новых обновлений нет, поле не возвращается.

В этом режиме не вызывайте метод events/check_updates. Он возвращает пустой объект.

Уровень детализации задается флагами детализации (биты 0x1–0x100) параметра evt_flags. Его нельзя установить в запросе avl_evts.

Язык и система мер возвращаемых значений берутся из настроек локали сессии. Чтобы изменить их, используйте render/set_locale. В отличие от events/check_updates, метод avl_evts не поддерживает параметры lang и measure.

Пример ответа см. в описании метода events/update_items.

Если в момент запроса сессия переносится на другой сервер, метод возвращает ответ с "migrate": 1 и пустым массивом events. Это не является ошибкой. Продолжайте отправлять запросы с тем же ID сессии. Метод снова вернет данные о событиях после завершения миграции.

Если запрос не выполнен, возвращается код ошибки.