get_last

Чтобы получить текущее состояние активного события или последнее известное состояние завершённого события, используйте метод events/get_last.

В отличие от events/get, этот метод не требует загрузки событий в сессию и не возвращает историю событий. В отличие от events/check_updates, он не требует добавления элемента в сессию с помощью events/update_items.

Для использования метода необходимо право Просмотр объекта и его основных свойств на указанный объект или ресурс.

svc=events/get_last&params={
  "itemId": <long>,
  "type": <text>,
  "filter1": <long>,
  "filter2": <text>,
  "detalization": <uint>,
  "measure": <uint>,
  "lang": <text>
}

Запрос должен содержать параметр itemId. Все остальные параметры являются необязательными.

При успешном выполнении запроса возвращается объект, ключами которого являются типы детекторов. В противном случае возвращается код ошибки.

Структура данных внутри каждого ключа зависит от детектора и запрошенных флагов.

С флагом 0x1 детекторы trips и counters возвращают данные напрямую в следующей структуре. Другие детекторы группируют объекты событий по ID, зависящему от детектора, как показано в примерах.

{
  "<detector_type>": {
    "from": {
      "t": <uint>,
      "y": <double>,
      "x": <double>
    },
    "to": {
      "t": <uint>,
      "y": <double>,
      "x": <double>
    },
    "m": <uint>,
    "f": <uint>
  }
}

Для приватной позиции значения x и y возвращаются как 0.

Другие флаги возвращают те же данные, что и соответствующие флаги events/check_updates: данные, зависящие от типа детектора (0x2), параметры сообщения, связанного с событием (0x4), дополнительные подробные данные (0x8), подробные данные сообщений (0x10) и отформатированные значения (0x20). Для детектора resource_drivers возвращаемые поля описаны в примере ниже.

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

Чтобы получить состояние всех доступных детекторов для объекта, укажите только ID объекта:

svc=events/get_last&params={
  "itemId": <unit_id>
}

Ответ представляет собой объект с ключами в виде каждого доступного типа детектора:

{
  "<detector_type>": {
    "...": "..."
  }
}

Чтобы одновременно получить состояния нескольких детекторов, укажите их в параметре type через запятую. В следующем запросе запрашиваются состояния детекторов trips и sensors, а датчики фильтруются по имени с помощью filter2:

svc=events/get_last&params={
  "itemId": <unit_id>,
  "type": "trips,sensors",
  "filter2": "Temperature 1,Temperature 2",
  "detalization": 39
}

Ответ содержит по одному объекту для каждого запрошенного детектора. Детектор sensors группирует данные по ID датчика, а детектор trips возвращает данные напрямую:

{
  "trips": { "...": "..." },
  "sensors": {
    "<sensor_id>": { "...": "..." }
  }
}

Чтобы получить состояние уровня топлива для всех датчиков уровня топлива объекта, укажите ID объекта и детектор fuel_level. Используйте detalization 39 (0x27) для включения основных данных события, данных, зависящих от типа детектора, параметров сообщения и отформатированных значений:

svc=events/get_last&params={
  "itemId": <unit_id>,
  "type": "fuel_level",
  "filter1": 0,
  "filter2": "",
  "detalization": 39
}

Ответ сгруппирован по ID датчика. С detalization 39 (0x27) он может содержать следующие поля:

{
  "fuel_level": {
    "<sensor_id>": {
      "from": {
        "t": <uint>,
        "y": <double>,
        "x": <double>
      },
      "to": {
        "t": <uint>,
        "y": <double>,
        "x": <double>
      },
      "m": <uint>,
      "f": <uint>,
      "value": <double>,
      "raw_value": <double>,
      "filled": <double>,
      "timeDiff": <uint>,
      "latDiff": <double>,
      "lonDiff": <double>,
      "format": {
        "value": <text>,
        "raw_value": <text>,
        "filled": <text>,
        "theft": <text>,
        "custom_value": <text>
      }
    }
  }
}

Чтобы получить текущее состояние уровня заряда электромобиля, укажите ID объекта и детектор ev. В примере используется detalization 39 (0x27), чтобы включить основные данные события, данные, зависящие от типа детектора, параметры сообщения и отформатированные значения:

svc=events/get_last&params={
  "itemId": <unit_id>,
  "type": "ev",
  "filter1": 0,
  "filter2": "",
  "detalization": 39
}

Ответ сгруппирован по ID датчика. Для текущего состояния детектор ev возвращает уровень заряда батареи, и ответ может содержать следующие поля:

{
  "ev": {
    "<sensor_id>": {
      "from": {
        "t": <uint>,
        "y": <double>,
        "x": <double>
      },
      "to": {
        "t": <uint>,
        "y": <double>,
        "x": <double>
      },
      "m": <uint>,
      "f": <uint>,
      "value": <double>,
      "raw_value": <double>,
      "format": {
        "value": <text>,
        "raw_value": <text>,
        "custom_value": <text>
      }
    }
  }
}

Поля from, to, m и f описаны в разделе Общая структура. Поле value содержит рассчитанный уровень заряда батареи, а raw_value — необработанное значение датчика.

Если в настройках датчика ключу show_as_percentage присвоено значение 1 и battery_capacity больше 0, поля value и raw_value внутри объекта format возвращают уровень заряда батареи в процентах от battery_capacity. В противном случае в них возвращается значение уровня заряда в кВт⋅ч. В полях value и raw_value вне объекта format значение уровня заряда всегда возвращается в кВт⋅ч.

Детектор ev объединяет данные об уровне заряда батареи и зарядках электромобиля. В ответах с историей событий он возвращает события изменения уровня заряда и зарядки. В events/get_last в ответе с текущим состоянием используются приведённые выше поля уровня заряда батареи. Чтобы запросить только события изменения уровня заряда батареи, используйте battery_level. Чтобы получить события зарядки с историей, используйте charge вместе с методами events/load и events/get.

Чтобы получить текущее состояние назначений водителей, укажите ID ресурса и детектор resource_drivers. Установите значение filter1 в ID водителя для получения состояния одного водителя или 0 для всех водителей. Значение detalization 7 (0x7) возвращает основные данные события, данные, зависящие от типа детектора, и параметры сообщения, связанного с событием.

svc=events/get_last&params={
  "itemId": <resource_id>,
  "type": "resource_drivers",
  "filter1": 0,
  "filter2": "",
  "detalization": 7
}

Ответ сгруппирован по ID водителя. Каждый ID водителя имеет один объект, описывающий текущее состояние этого водителя.

{
  "resource_drivers": {
    "<driver_id>": {
      "from": {
        "t": <uint>,
        "y": <double>,
        "x": <double>
      },
      "to": {
        "t": <uint>,
        "y": <double>,
        "x": <double>
      },
      "m": <uint>,
      "f": <uint>,
      "state": <uint>,
      "aflags": <uint>,
      "unit_id": <long>,
      "propitem_cr_time": <uint>,
      "real_time_from": <uint>,
      "validate_sensor_id": <uint>,
      "switched_to": <long>
    }
  }
}

Поля from, to, m и f описаны в разделе Общая структура. Детектор также возвращает следующие поля:

Поле aflags может содержать следующие флаги. Те же флаги используются в завершённых событиях, возвращаемых events/get, поэтому текущее состояние обычно содержит только флаги, которые описывают, как началось назначение.

Для state 0 объект to не показывает время и место снятия. Он показывает последнее обработанное сообщение. Время снятия — это время окончания завершённого события в истории событий, которую можно получить с помощью events/get.

Чтобы изменить состояние назначения вручную, используйте resource/driver_actions_register. Чтобы просмотреть или удалить зарегистрированные ручные действия, используйте resource/driver_actions_list или resource/driver_actions_cleanup.